1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2023 Alexander V. Chernikov <melifaro@FreeBSD.org> 5 * Copyright (c) 2023 Rubicon Communications, LLC (Netgate) 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 AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 */ 29 30 #ifndef _NETPFIL_PF_PF_NL_H_ 31 #define _NETPFIL_PF_PF_NL_H_ 32 33 /* Genetlink family */ 34 #define PFNL_FAMILY_NAME "pfctl" 35 36 /* available commands */ 37 enum { 38 PFNL_CMD_UNSPEC = 0, 39 PFNL_CMD_GETSTATES = 1, 40 PFNL_CMD_GETCREATORS = 2, 41 PFNL_CMD_START = 3, 42 PFNL_CMD_STOP = 4, 43 PFNL_CMD_ADDRULE = 5, 44 PFNL_CMD_GETRULES = 6, 45 PFNL_CMD_GETRULE = 7, 46 PFNL_CMD_CLRSTATES = 8, 47 PFNL_CMD_KILLSTATES = 9, 48 PFNL_CMD_SET_STATUSIF = 10, 49 PFNL_CMD_GET_STATUS = 11, 50 __PFNL_CMD_MAX, 51 }; 52 #define PFNL_CMD_MAX (__PFNL_CMD_MAX -1) 53 54 enum pfstate_key_type_t { 55 PF_STK_UNSPEC, 56 PF_STK_ADDR0 = 1, /* ip */ 57 PF_STK_ADDR1 = 2, /* ip */ 58 PF_STK_PORT0 = 3, /* u16 */ 59 PF_STK_PORT1 = 4, /* u16 */ 60 }; 61 62 enum pfstate_peer_type_t { 63 PF_STP_UNSPEC, 64 PF_STP_PFSS_FLAGS = 1, /* u16 */ 65 PF_STP_PFSS_TTL = 2, /* u8 */ 66 PF_STP_SCRUB_FLAG = 3, /* u8 */ 67 PF_STP_PFSS_TS_MOD = 4, /* u32 */ 68 PF_STP_SEQLO = 5, /* u32 */ 69 PF_STP_SEQHI = 6, /* u32 */ 70 PF_STP_SEQDIFF = 7, /* u32 */ 71 PF_STP_MAX_WIN = 8, /* u16 */ 72 PF_STP_MSS = 9, /* u16 */ 73 PF_STP_STATE = 10, /* u8 */ 74 PF_STP_WSCALE = 11, /* u8 */ 75 }; 76 77 enum pfstate_type_t { 78 PF_ST_UNSPEC, 79 PF_ST_ID = 1, /* u32, state id */ 80 PF_ST_CREATORID = 2, /* u32, */ 81 PF_ST_IFNAME = 3, /* string */ 82 PF_ST_ORIG_IFNAME = 4, /* string */ 83 PF_ST_KEY_WIRE = 5, /* nested, pfstate_key_type_t */ 84 PF_ST_KEY_STACK = 6, /* nested, pfstate_key_type_t */ 85 PF_ST_PEER_SRC = 7, /* nested, pfstate_peer_type_t*/ 86 PF_ST_PEER_DST = 8, /* nested, pfstate_peer_type_t */ 87 PF_ST_RT_ADDR = 9, /* ip */ 88 PF_ST_RULE = 10, /* u32 */ 89 PF_ST_ANCHOR = 11, /* u32 */ 90 PF_ST_NAT_RULE = 12, /* u32 */ 91 PF_ST_CREATION = 13, /* u32 */ 92 PF_ST_EXPIRE = 14, /* u32 */ 93 PF_ST_PACKETS0 = 15, /* u64 */ 94 PF_ST_PACKETS1 = 16, /* u64 */ 95 PF_ST_BYTES0 = 17, /* u64 */ 96 PF_ST_BYTES1 = 18, /* u64 */ 97 PF_ST_AF = 19, /* u8 */ 98 PF_ST_PROTO = 21, /* u8 */ 99 PF_ST_DIRECTION = 22, /* u8 */ 100 PF_ST_LOG = 23, /* u8 */ 101 PF_ST_TIMEOUT = 24, /* u8 */ 102 PF_ST_STATE_FLAGS = 25, /* u8 */ 103 PF_ST_SYNC_FLAGS = 26, /* u8 */ 104 PF_ST_UPDATES = 27, /* u8 */ 105 PF_ST_VERSION = 28, /* u64 */ 106 PF_ST_FILTER_ADDR = 29, /* in6_addr */ 107 PF_ST_FILTER_MASK = 30, /* in6_addr */ 108 PF_ST_RTABLEID = 31, /* i32 */ 109 PF_ST_MIN_TTL = 32, /* u8 */ 110 PF_ST_MAX_MSS = 33, /* u16 */ 111 PF_ST_DNPIPE = 34, /* u16 */ 112 PF_ST_DNRPIPE = 35, /* u16 */ 113 PF_ST_RT = 36, /* u8 */ 114 PF_ST_RT_IFNAME = 37, /* string */ 115 }; 116 117 enum pf_addr_type_t { 118 PF_AT_UNSPEC, 119 PF_AT_ADDR = 1, /* in6_addr */ 120 PF_AT_MASK = 2, /* in6_addr */ 121 PF_AT_IFNAME = 3, /* string */ 122 PF_AT_TABLENAME = 4, /* string */ 123 PF_AT_TYPE = 5, /* u8 */ 124 PF_AT_IFLAGS = 6, /* u8 */ 125 PF_AT_TBLCNT = 7, /* u32 */ 126 PF_AT_DYNCNT = 8, /* u32 */ 127 }; 128 129 enum pfrule_addr_type_t { 130 PF_RAT_UNSPEC, 131 PF_RAT_ADDR = 1, /* nested, pf_addr_type_t */ 132 PF_RAT_SRC_PORT = 2, /* u16 */ 133 PF_RAT_DST_PORT = 3, /* u16 */ 134 PF_RAT_NEG = 4, /* u8 */ 135 PF_RAT_OP = 5, /* u8 */ 136 }; 137 138 enum pf_labels_type_t { 139 PF_LT_UNSPEC, 140 PF_LT_LABEL = 1, /* string */ 141 }; 142 143 enum pf_mape_portset_type_t 144 { 145 PF_MET_UNSPEC, 146 PF_MET_OFFSET = 1, /* u8 */ 147 PF_MET_PSID_LEN = 2, /* u8 */ 148 PF_MET_PSID = 3, /* u16 */ 149 }; 150 151 enum pf_rpool_type_t 152 { 153 PF_PT_UNSPEC, 154 PF_PT_KEY = 1, /* bytes, sizeof(struct pf_poolhashkey) */ 155 PF_PT_COUNTER = 2, /* in6_addr */ 156 PF_PT_TBLIDX = 3, /* u32 */ 157 PF_PT_PROXY_SRC_PORT = 4, /* u16 */ 158 PF_PT_PROXY_DST_PORT = 5, /* u16 */ 159 PF_PT_OPTS = 6, /* u8 */ 160 PF_PT_MAPE = 7, /* nested, pf_mape_portset_type_t */ 161 }; 162 163 enum pf_timeout_type_t { 164 PF_TT_UNSPEC, 165 PF_TT_TIMEOUT = 1, /* u32 */ 166 }; 167 168 enum pf_rule_uid_type_t { 169 PF_RUT_UNSPEC, 170 PF_RUT_UID_LOW = 1, /* u32 */ 171 PF_RUT_UID_HIGH = 2, /* u32 */ 172 PF_RUT_OP = 3, /* u8 */ 173 }; 174 175 enum pf_rule_type_t { 176 PF_RT_UNSPEC, 177 PF_RT_SRC = 1, /* nested, pf_rule_addr_type_t */ 178 PF_RT_DST = 2, /* nested, pf_rule_addr_type_t */ 179 PF_RT_RIDENTIFIER = 3, /* u32 */ 180 PF_RT_LABELS = 4, /* nested, pf_labels_type_t */ 181 PF_RT_IFNAME = 5, /* string */ 182 PF_RT_QNAME = 6, /* string */ 183 PF_RT_PQNAME = 7, /* string */ 184 PF_RT_TAGNAME = 8, /* string */ 185 PF_RT_MATCH_TAGNAME = 9, /* string */ 186 PF_RT_OVERLOAD_TBLNAME = 10, /* string */ 187 PF_RT_RPOOL = 11, /* nested, pf_rpool_type_t */ 188 PF_RT_OS_FINGERPRINT = 12, /* u32 */ 189 PF_RT_RTABLEID = 13, /* u32 */ 190 PF_RT_TIMEOUT = 14, /* nested, pf_timeout_type_t */ 191 PF_RT_MAX_STATES = 15, /* u32 */ 192 PF_RT_MAX_SRC_NODES = 16, /* u32 */ 193 PF_RT_MAX_SRC_STATES = 17, /* u32 */ 194 PF_RT_MAX_SRC_CONN_RATE_LIMIT = 18, /* u32 */ 195 PF_RT_MAX_SRC_CONN_RATE_SECS = 19, /* u32 */ 196 PF_RT_DNPIPE = 20, /* u16 */ 197 PF_RT_DNRPIPE = 21, /* u16 */ 198 PF_RT_DNFLAGS = 22, /* u32 */ 199 PF_RT_NR = 23, /* u32 */ 200 PF_RT_PROB = 24, /* u32 */ 201 PF_RT_CUID = 25, /* u32 */ 202 PF_RT_CPID = 26, /* u32 */ 203 PF_RT_RETURN_ICMP = 27, /* u16 */ 204 PF_RT_RETURN_ICMP6 = 28, /* u16 */ 205 PF_RT_MAX_MSS = 29, /* u16 */ 206 PF_RT_SCRUB_FLAGS = 30, /* u16 */ 207 PF_RT_UID = 31, /* nested, pf_rule_uid_type_t */ 208 PF_RT_GID = 32, /* nested, pf_rule_uid_type_t */ 209 PF_RT_RULE_FLAG = 33, /* u32 */ 210 PF_RT_ACTION = 34, /* u8 */ 211 PF_RT_DIRECTION = 35, /* u8 */ 212 PF_RT_LOG = 36, /* u8 */ 213 PF_RT_LOGIF = 37, /* u8 */ 214 PF_RT_QUICK = 38, /* u8 */ 215 PF_RT_IF_NOT = 39, /* u8 */ 216 PF_RT_MATCH_TAG_NOT = 40, /* u8 */ 217 PF_RT_NATPASS = 41, /* u8 */ 218 PF_RT_KEEP_STATE = 42, /* u8 */ 219 PF_RT_AF = 43, /* u8 */ 220 PF_RT_PROTO = 44, /* u8 */ 221 PF_RT_TYPE = 45, /* u8 */ 222 PF_RT_CODE = 46, /* u8 */ 223 PF_RT_FLAGS = 47, /* u8 */ 224 PF_RT_FLAGSET = 48, /* u8 */ 225 PF_RT_MIN_TTL = 49, /* u8 */ 226 PF_RT_ALLOW_OPTS = 50, /* u8 */ 227 PF_RT_RT = 51, /* u8 */ 228 PF_RT_RETURN_TTL = 52, /* u8 */ 229 PF_RT_TOS = 53, /* u8 */ 230 PF_RT_SET_TOS = 54, /* u8 */ 231 PF_RT_ANCHOR_RELATIVE = 55, /* u8 */ 232 PF_RT_ANCHOR_WILDCARD = 56, /* u8 */ 233 PF_RT_FLUSH = 57, /* u8 */ 234 PF_RT_PRIO = 58, /* u8 */ 235 PF_RT_SET_PRIO = 59, /* u8 */ 236 PF_RT_SET_PRIO_REPLY = 60, /* u8 */ 237 PF_RT_DIVERT_ADDRESS = 61, /* in6_addr */ 238 PF_RT_DIVERT_PORT = 62, /* u16 */ 239 PF_RT_PACKETS_IN = 63, /* u64 */ 240 PF_RT_PACKETS_OUT = 64, /* u64 */ 241 PF_RT_BYTES_IN = 65, /* u64 */ 242 PF_RT_BYTES_OUT = 66, /* u64 */ 243 PF_RT_EVALUATIONS = 67, /* u64 */ 244 PF_RT_TIMESTAMP = 68, /* u64 */ 245 PF_RT_STATES_CUR = 69, /* u64 */ 246 PF_RT_STATES_TOTAL = 70, /* u64 */ 247 PF_RT_SRC_NODES = 71, /* u64 */ 248 PF_RT_ANCHOR_CALL = 72, /* string */ 249 }; 250 251 enum pf_addrule_type_t { 252 PF_ART_UNSPEC, 253 PF_ART_TICKET = 1, /* u32 */ 254 PF_ART_POOL_TICKET = 2, /* u32 */ 255 PF_ART_ANCHOR = 3, /* string */ 256 PF_ART_ANCHOR_CALL = 4, /* string */ 257 PF_ART_RULE = 5, /* nested, pfrule_type_t */ 258 }; 259 260 enum pf_getrules_type_t { 261 PF_GR_UNSPEC, 262 PF_GR_ANCHOR = 1, /* string */ 263 PF_GR_ACTION = 2, /* u8 */ 264 PF_GR_NR = 3, /* u32 */ 265 PF_GR_TICKET = 4, /* u32 */ 266 PF_GR_CLEAR = 5, /* u8 */ 267 }; 268 269 enum pf_clear_states_type_t { 270 PF_CS_UNSPEC, 271 PF_CS_CMP_ID = 1, /* u64 */ 272 PF_CS_CMP_CREATORID = 2, /* u32 */ 273 PF_CS_CMP_DIR = 3, /* u8 */ 274 PF_CS_AF = 4, /* u8 */ 275 PF_CS_PROTO = 5, /* u8 */ 276 PF_CS_SRC = 6, /* nested, pf_addr_wrap */ 277 PF_CS_DST = 7, /* nested, pf_addr_wrap */ 278 PF_CS_RT_ADDR = 8, /* nested, pf_addr_wrap */ 279 PF_CS_IFNAME = 9, /* string */ 280 PF_CS_LABEL = 10, /* string */ 281 PF_CS_KILL_MATCH = 11, /* bool */ 282 PF_CS_NAT = 12, /* bool */ 283 PF_CS_KILLED = 13, /* u32 */ 284 }; 285 286 enum pf_set_statusif_types_t { 287 PF_SS_UNSPEC, 288 PF_SS_IFNAME = 1, /* string */ 289 }; 290 291 enum pf_counter_types_t { 292 PF_C_UNSPEC, 293 PF_C_COUNTER = 1, /* u64 */ 294 PF_C_NAME = 2, /* string */ 295 PF_C_ID = 3, /* u32 */ 296 }; 297 298 enum pf_get_status_types_t { 299 PF_GS_UNSPEC, 300 PF_GS_IFNAME = 1, /* string */ 301 PF_GS_RUNNING = 2, /* bool */ 302 PF_GS_SINCE = 3, /* u32 */ 303 PF_GS_DEBUG = 4, /* u32 */ 304 PF_GS_HOSTID = 5, /* u32 */ 305 PF_GS_STATES = 6, /* u32 */ 306 PF_GS_SRC_NODES = 7, /* u32 */ 307 PF_GS_REASSEMBLE = 8, /* u32 */ 308 PF_GS_SYNCOOKIES_ACTIVE = 9, /* bool */ 309 PF_GS_COUNTERS = 10, /* nested, */ 310 PF_GS_LCOUNTERS = 11, /* nested, */ 311 PF_GS_FCOUNTERS = 12, /* nested, */ 312 PF_GS_SCOUNTERS = 13, /* nested, */ 313 PF_GS_CHKSUM = 14, /* byte array */ 314 PF_GS_PCOUNTERS = 15, /* u64 array */ 315 PF_GS_BCOUNTERS = 16, /* u64 array */ 316 }; 317 318 #ifdef _KERNEL 319 320 void pf_nl_register(void); 321 void pf_nl_unregister(void); 322 323 #endif 324 325 #endif 326