1 /* $OpenBSD: if_pfsync.h,v 1.37 2009/03/31 01:21:29 dlg Exp $ */ 2 3 /* 4 * Copyright (c) 2001 Michael Shalayeff 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19 * IN NO EVENT SHALL THE AUTHOR OR HIS RELATIVES BE LIABLE FOR ANY DIRECT, 20 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 22 * SERVICES; LOSS OF MIND, USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 24 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 25 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 26 * THE POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 /* 30 * Copyright (c) 2008 David Gwynne <dlg@openbsd.org> 31 * 32 * Permission to use, copy, modify, and distribute this software for any 33 * purpose with or without fee is hereby granted, provided that the above 34 * copyright notice and this permission notice appear in all copies. 35 * 36 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 37 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 38 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 39 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 40 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 41 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 42 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 43 */ 44 45 #ifndef _NET_IF_PFSYNC_H_ 46 #define _NET_IF_PFSYNC_H_ 47 48 #define PFSYNC_VERSION 5 49 #define PFSYNC_DFLTTL 255 50 51 #define PFSYNC_ACT_CLR 0 /* clear all states */ 52 #define PFSYNC_ACT_INS 1 /* insert state */ 53 #define PFSYNC_ACT_INS_ACK 2 /* ack of insterted state */ 54 #define PFSYNC_ACT_UPD 3 /* update state */ 55 #define PFSYNC_ACT_UPD_C 4 /* "compressed" update state */ 56 #define PFSYNC_ACT_UPD_REQ 5 /* request "uncompressed" state */ 57 #define PFSYNC_ACT_DEL 6 /* delete state */ 58 #define PFSYNC_ACT_DEL_C 7 /* "compressed" delete state */ 59 #define PFSYNC_ACT_INS_F 8 /* insert fragment */ 60 #define PFSYNC_ACT_DEL_F 9 /* delete fragments */ 61 #define PFSYNC_ACT_BUS 10 /* bulk update status */ 62 #define PFSYNC_ACT_TDB 11 /* TDB replay counter update */ 63 #define PFSYNC_ACT_EOF 12 /* end of frame */ 64 #define PFSYNC_ACT_MAX 13 65 66 #define PFSYNC_ACTIONS "CLR ST", \ 67 "INS ST", \ 68 "INS ST ACK", \ 69 "UPD ST", \ 70 "UPD ST COMP", \ 71 "UPD ST REQ", \ 72 "DEL ST", \ 73 "DEL ST COMP", \ 74 "INS FR", \ 75 "DEL FR", \ 76 "BULK UPD STAT", \ 77 "TDB UPD", \ 78 "EOF" 79 80 #define PFSYNC_HMAC_LEN 20 81 82 /* 83 * A pfsync frame is built from a header followed by several sections which 84 * are all prefixed with their own subheaders. Frames must be terminated with 85 * an EOF subheader. 86 * 87 * | ... | 88 * | IP header | 89 * +============================+ 90 * | pfsync_header | 91 * +----------------------------+ 92 * | pfsync_subheader | 93 * +----------------------------+ 94 * | first action fields | 95 * | ... | 96 * +----------------------------+ 97 * | pfsync_subheader | 98 * +----------------------------+ 99 * | second action fields | 100 * | ... | 101 * +----------------------------+ 102 * | EOF pfsync_subheader | 103 * +============================+ 104 */ 105 106 /* 107 * Frame header 108 */ 109 110 struct pfsync_header { 111 u_int8_t version; 112 u_int8_t _pad; 113 u_int16_t len; 114 u_int8_t pfcksum[PF_MD5_DIGEST_LENGTH]; 115 } __packed; 116 117 /* 118 * Frame region subheader 119 */ 120 121 struct pfsync_subheader { 122 u_int8_t action; 123 u_int8_t _pad; 124 u_int16_t count; 125 } __packed; 126 127 /* 128 * CLR 129 */ 130 131 struct pfsync_clr { 132 char ifname[IFNAMSIZ]; 133 u_int32_t creatorid; 134 } __packed; 135 136 /* 137 * INS, UPD, DEL 138 */ 139 140 /* these use struct pfsync_state in pfvar.h */ 141 142 /* 143 * INS_ACK 144 */ 145 146 struct pfsync_ins_ack { 147 u_int64_t id; 148 u_int32_t creatorid; 149 } __packed; 150 151 /* 152 * UPD_C 153 */ 154 155 struct pfsync_upd_c { 156 u_int64_t id; 157 struct pfsync_state_peer src; 158 struct pfsync_state_peer dst; 159 u_int32_t creatorid; 160 u_int32_t expire; 161 u_int8_t timeout; 162 u_int8_t _pad[3]; 163 } __packed; 164 165 /* 166 * UPD_REQ 167 */ 168 169 struct pfsync_upd_req { 170 u_int64_t id; 171 u_int32_t creatorid; 172 } __packed; 173 174 /* 175 * DEL_C 176 */ 177 178 struct pfsync_del_c { 179 u_int64_t id; 180 u_int32_t creatorid; 181 } __packed; 182 183 /* 184 * INS_F, DEL_F 185 */ 186 187 /* not implemented (yet) */ 188 189 /* 190 * BUS 191 */ 192 193 struct pfsync_bus { 194 u_int32_t creatorid; 195 u_int32_t endtime; 196 u_int8_t status; 197 #define PFSYNC_BUS_START 1 198 #define PFSYNC_BUS_END 2 199 u_int8_t _pad[3]; 200 } __packed; 201 202 /* 203 * TDB 204 */ 205 206 struct pfsync_tdb { 207 u_int32_t spi; 208 union sockaddr_union dst; 209 u_int32_t rpl; 210 u_int64_t cur_bytes; 211 u_int8_t sproto; 212 u_int8_t updates; 213 u_int8_t _pad[2]; 214 } __packed; 215 216 /* 217 * EOF 218 */ 219 220 struct pfsync_eof { 221 u_int8_t hmac[PFSYNC_HMAC_LEN]; 222 } __packed; 223 224 #define PFSYNC_HDRLEN sizeof(struct pfsync_header) 225 226 227 228 /* 229 * Names for PFSYNC sysctl objects 230 */ 231 #define PFSYNCCTL_STATS 1 /* PFSYNC stats */ 232 #define PFSYNCCTL_MAXID 2 233 234 #define PFSYNCCTL_NAMES { \ 235 { 0, 0 }, \ 236 { "stats", CTLTYPE_STRUCT }, \ 237 } 238 239 struct pfsyncstats { 240 u_int64_t pfsyncs_ipackets; /* total input packets, IPv4 */ 241 u_int64_t pfsyncs_ipackets6; /* total input packets, IPv6 */ 242 u_int64_t pfsyncs_badif; /* not the right interface */ 243 u_int64_t pfsyncs_badttl; /* TTL is not PFSYNC_DFLTTL */ 244 u_int64_t pfsyncs_hdrops; /* packets shorter than hdr */ 245 u_int64_t pfsyncs_badver; /* bad (incl unsupp) version */ 246 u_int64_t pfsyncs_badact; /* bad action */ 247 u_int64_t pfsyncs_badlen; /* data length does not match */ 248 u_int64_t pfsyncs_badauth; /* bad authentication */ 249 u_int64_t pfsyncs_stale; /* stale state */ 250 u_int64_t pfsyncs_badval; /* bad values */ 251 u_int64_t pfsyncs_badstate; /* insert/lookup failed */ 252 253 u_int64_t pfsyncs_opackets; /* total output packets, IPv4 */ 254 u_int64_t pfsyncs_opackets6; /* total output packets, IPv6 */ 255 u_int64_t pfsyncs_onomem; /* no memory for an mbuf */ 256 u_int64_t pfsyncs_oerrors; /* ip output error */ 257 }; 258 259 /* 260 * Configuration structure for SIOCSETPFSYNC SIOCGETPFSYNC 261 */ 262 struct pfsyncreq { 263 char pfsyncr_syncdev[IFNAMSIZ]; 264 struct in_addr pfsyncr_syncpeer; 265 int pfsyncr_maxupdates; 266 int pfsyncr_authlevel; 267 }; 268 269 #ifdef _KERNEL 270 271 /* 272 * this shows where a pf state is with respect to the syncing. 273 */ 274 #define PFSYNC_S_INS 0x00 275 #define PFSYNC_S_IACK 0x01 276 #define PFSYNC_S_UPD 0x02 277 #define PFSYNC_S_UPD_C 0x03 278 #define PFSYNC_S_DEL 0x04 279 #define PFSYNC_S_COUNT 0x05 280 281 #define PFSYNC_S_DEFER 0xfe 282 #define PFSYNC_S_NONE 0xff 283 284 void pfsync_input(struct mbuf *, ...); 285 int pfsync_sysctl(int *, u_int, void *, size_t *, 286 void *, size_t); 287 288 #define PFSYNC_SI_IOCTL 0x01 289 #define PFSYNC_SI_CKSUM 0x02 290 #define PFSYNC_SI_ACK 0x04 291 int pfsync_state_import(struct pfsync_state *, u_int8_t); 292 void pfsync_state_export(struct pfsync_state *, 293 struct pf_state *); 294 295 void pfsync_insert_state(struct pf_state *); 296 void pfsync_update_state(struct pf_state *); 297 void pfsync_delete_state(struct pf_state *); 298 void pfsync_clear_states(u_int32_t, const char *); 299 300 void pfsync_update_tdb(struct tdb *, int); 301 void pfsync_delete_tdb(struct tdb *); 302 303 int pfsync_defer(struct pf_state *, struct mbuf *); 304 305 int pfsync_up(void); 306 int pfsync_state_in_use(struct pf_state *); 307 #endif 308 309 #endif /* _NET_IF_PFSYNC_H_ */ 310