1 /* $FreeBSD: src/sys/netinet6/ipsec.h,v 1.4.2.2 2001/07/03 11:01:54 ume Exp $ */ 2 /* $KAME: ipsec.h,v 1.44 2001/03/23 08:08:47 itojun Exp $ */ 3 4 /* 5 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. Neither the name of the project nor the names of its contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 */ 32 33 /* 34 * IPsec controller part. 35 */ 36 37 #ifndef _NETINET6_IPSEC_H_ 38 #define _NETINET6_IPSEC_H_ 39 #include <sys/cdefs.h> 40 #include <sys/appleapiopts.h> 41 42 #include <net/pfkeyv2.h> 43 #include <uuid/uuid.h> 44 #ifdef BSD_KERNEL_PRIVATE 45 #include <netkey/keydb.h> 46 #include <netinet/ip_var.h> 47 48 #include <os/log.h> 49 50 #define IPSEC_STAT_INCREMENT(x) \ 51 OSIncrementAtomic64((SInt64 *)&x) 52 53 struct secpolicyaddrrange { 54 struct sockaddr_storage start; /* Start (low values) of address range */ 55 struct sockaddr_storage end; /* End (high values) of address range */ 56 }; 57 58 /* 59 * Security Policy Index 60 * Ensure that both address families in the "src" and "dst" are same. 61 * When the value of the ul_proto is ICMPv6, the port field in "src" 62 * specifies ICMPv6 type, and the port field in "dst" specifies ICMPv6 code. 63 */ 64 struct secpolicyindex { 65 u_int8_t dir; /* direction of packet flow, see below */ 66 struct sockaddr_storage src; /* IP src address for SP */ 67 struct sockaddr_storage dst; /* IP dst address for SP */ 68 u_int8_t prefs; /* prefix length in bits for src */ 69 u_int8_t prefd; /* prefix length in bits for dst */ 70 u_int8_t ul_proto; /* upper layer Protocol */ 71 ifnet_t internal_if; /* Interface a matching packet is bound to */ 72 struct secpolicyaddrrange src_range; /* IP src address range for SP */ 73 struct secpolicyaddrrange dst_range; /* IP dst address range for SP */ 74 #ifdef notyet 75 uid_t uids; 76 uid_t uidd; 77 gid_t gids; 78 gid_t gidd; 79 #endif 80 }; 81 82 /* Security Policy Data Base */ 83 struct secpolicy { 84 LIST_ENTRY(secpolicy) chain; 85 86 int refcnt; /* reference count */ 87 struct secpolicyindex spidx; /* selector */ 88 u_int32_t id; /* It's unique number on the system. */ 89 u_int state; /* 0: dead, others: alive */ 90 #define IPSEC_SPSTATE_DEAD 0 91 #define IPSEC_SPSTATE_ALIVE 1 92 93 u_int policy; /* DISCARD, NONE or IPSEC, see keyv2.h */ 94 struct ipsecrequest *req; 95 /* pointer to the ipsec request tree, */ 96 /* if policy == IPSEC else this value == NULL.*/ 97 98 ifnet_t ipsec_if; /* IPsec interface to use */ 99 ifnet_t outgoing_if; /* Outgoing interface for encrypted traffic */ 100 101 char disabled; /* Set to ignore policy */ 102 103 /* 104 * lifetime handler. 105 * the policy can be used without limitiation if both lifetime and 106 * validtime are zero. 107 * "lifetime" is passed by sadb_lifetime.sadb_lifetime_addtime. 108 * "validtime" is passed by sadb_lifetime.sadb_lifetime_usetime. 109 */ 110 long created; /* time created the policy */ 111 long lastused; /* updated every when kernel sends a packet */ 112 long lifetime; /* duration of the lifetime of this policy */ 113 long validtime; /* duration this policy is valid without use */ 114 }; 115 116 /* Request for IPsec */ 117 struct ipsecrequest { 118 struct ipsecrequest *next; 119 /* pointer to next structure */ 120 /* If NULL, it means the end of chain. */ 121 struct secasindex saidx;/* hint for search proper SA */ 122 /* if __ss_len == 0 then no address specified.*/ 123 u_int level; /* IPsec level defined below. */ 124 125 struct secpolicy *sp; /* back pointer to SP */ 126 }; 127 128 /* security policy in PCB */ 129 struct inpcbpolicy { 130 struct secpolicy *sp_in; 131 struct secpolicy *sp_out; 132 int priv; /* privileged socket ? */ 133 }; 134 135 /* SP acquiring list table. */ 136 struct secspacq { 137 LIST_ENTRY(secspacq) chain; 138 139 struct secpolicyindex spidx; 140 141 long created; /* for lifetime */ 142 int count; /* for lifetime */ 143 /* XXX: here is mbuf place holder to be sent ? */ 144 }; 145 #endif /* BSD_KERNEL_PRIVATE */ 146 147 /* according to IANA assignment, port 0x0000 and proto 0xff are reserved. */ 148 #define IPSEC_PORT_ANY 0 149 #define IPSEC_ULPROTO_ANY 255 150 #define IPSEC_PROTO_ANY 255 151 152 /* mode of security protocol */ 153 /* NOTE: DON'T use IPSEC_MODE_ANY at SPD. It's only use in SAD */ 154 #define IPSEC_MODE_ANY 0 /* i.e. wildcard. */ 155 #define IPSEC_MODE_TRANSPORT 1 156 #define IPSEC_MODE_TUNNEL 2 157 158 /* 159 * Direction of security policy. 160 * NOTE: Since INVALID is used just as flag. 161 * The other are used for loop counter too. 162 */ 163 #define IPSEC_DIR_ANY 0 164 #define IPSEC_DIR_INBOUND 1 165 #define IPSEC_DIR_OUTBOUND 2 166 #define IPSEC_DIR_MAX 3 167 #define IPSEC_DIR_INVALID 4 168 169 /* Policy level */ 170 /* 171 * IPSEC, ENTRUST and BYPASS are allowed for setsockopt() in PCB, 172 * DISCARD, IPSEC and NONE are allowed for setkey() in SPD. 173 * DISCARD and NONE are allowed for system default. 174 */ 175 #define IPSEC_POLICY_DISCARD 0 /* discarding packet */ 176 #define IPSEC_POLICY_NONE 1 /* through IPsec engine */ 177 #define IPSEC_POLICY_IPSEC 2 /* do IPsec */ 178 #define IPSEC_POLICY_ENTRUST 3 /* consulting SPD if present. */ 179 #define IPSEC_POLICY_BYPASS 4 /* only for privileged socket. */ 180 #define IPSEC_POLICY_GENERATE 5 /* same as discard - IKE daemon can override with generated policy */ 181 182 /* Security protocol level */ 183 #define IPSEC_LEVEL_DEFAULT 0 /* reference to system default */ 184 #define IPSEC_LEVEL_USE 1 /* use SA if present. */ 185 #define IPSEC_LEVEL_REQUIRE 2 /* require SA. */ 186 #define IPSEC_LEVEL_UNIQUE 3 /* unique SA. */ 187 188 #define IPSEC_MANUAL_REQID_MAX 0x3fff 189 /* 190 * if security policy level == unique, this id 191 * indicate to a relative SA for use, else is 192 * zero. 193 * 1 - 0x3fff are reserved for manual keying. 194 * 0 are reserved for above reason. Others is 195 * for kernel use. 196 * Note that this id doesn't identify SA 197 * by only itself. 198 */ 199 #define IPSEC_REPLAYWSIZE 32 200 201 /* statistics for ipsec processing */ 202 struct ipsecstat { 203 u_quad_t in_success __attribute__ ((aligned(8))); /* succeeded inbound process */ 204 u_quad_t in_polvio __attribute__ ((aligned(8))); 205 /* security policy violation for inbound process */ 206 u_quad_t in_nosa __attribute__ ((aligned(8))); /* inbound SA is unavailable */ 207 u_quad_t in_inval __attribute__ ((aligned(8))); /* inbound processing failed due to EINVAL */ 208 u_quad_t in_nomem __attribute__ ((aligned(8))); /* inbound processing failed due to ENOBUFS */ 209 u_quad_t in_badspi __attribute__ ((aligned(8))); /* failed getting a SPI */ 210 u_quad_t in_ahreplay __attribute__ ((aligned(8))); /* AH replay check failed */ 211 u_quad_t in_espreplay __attribute__ ((aligned(8))); /* ESP replay check failed */ 212 u_quad_t in_ahauthsucc __attribute__ ((aligned(8))); /* AH authentication success */ 213 u_quad_t in_ahauthfail __attribute__ ((aligned(8))); /* AH authentication failure */ 214 u_quad_t in_espauthsucc __attribute__ ((aligned(8))); /* ESP authentication success */ 215 u_quad_t in_espauthfail __attribute__ ((aligned(8))); /* ESP authentication failure */ 216 u_quad_t in_esphist[256] __attribute__ ((aligned(8))); 217 u_quad_t in_ahhist[256] __attribute__ ((aligned(8))); 218 u_quad_t in_comphist[256] __attribute__ ((aligned(8))); 219 u_quad_t out_success __attribute__ ((aligned(8))); /* succeeded outbound process */ 220 u_quad_t out_polvio __attribute__ ((aligned(8))); 221 /* security policy violation for outbound process */ 222 u_quad_t out_nosa __attribute__ ((aligned(8))); /* outbound SA is unavailable */ 223 u_quad_t out_inval __attribute__ ((aligned(8))); /* outbound process failed due to EINVAL */ 224 u_quad_t out_nomem __attribute__ ((aligned(8))); /* inbound processing failed due to ENOBUFS */ 225 u_quad_t out_noroute __attribute__ ((aligned(8))); /* there is no route */ 226 u_quad_t out_esphist[256] __attribute__ ((aligned(8))); 227 u_quad_t out_ahhist[256] __attribute__ ((aligned(8))); 228 u_quad_t out_comphist[256] __attribute__ ((aligned(8))); 229 }; 230 231 #define IPSEC_MAX_WAKE_PKT_LEN 100 232 struct ipsec_wake_pkt_info { 233 u_int8_t wake_pkt[IPSEC_MAX_WAKE_PKT_LEN]; 234 uuid_string_t wake_uuid; 235 u_int32_t wake_pkt_spi; 236 u_int32_t wake_pkt_seq; 237 u_int16_t wake_pkt_len; 238 }; 239 240 struct ipsec_wake_pkt_event_data { 241 uuid_string_t wake_uuid; 242 }; 243 244 #ifdef BSD_KERNEL_PRIVATE 245 /* 246 * Definitions for IPsec & Key sysctl operations. 247 */ 248 /* 249 * Names for IPsec & Key sysctl objects 250 */ 251 #define IPSECCTL_STATS 1 /* stats */ 252 #define IPSECCTL_DEF_POLICY 2 253 #define IPSECCTL_DEF_ESP_TRANSLEV 3 /* int; ESP transport mode */ 254 #define IPSECCTL_DEF_ESP_NETLEV 4 /* int; ESP tunnel mode */ 255 #define IPSECCTL_DEF_AH_TRANSLEV 5 /* int; AH transport mode */ 256 #define IPSECCTL_DEF_AH_NETLEV 6 /* int; AH tunnel mode */ 257 #if 0 /* obsolete, do not reuse */ 258 #define IPSECCTL_INBOUND_CALL_IKE 7 259 #endif 260 #define IPSECCTL_AH_CLEARTOS 8 261 #define IPSECCTL_AH_OFFSETMASK 9 262 #define IPSECCTL_DFBIT 10 263 #define IPSECCTL_ECN 11 264 #define IPSECCTL_DEBUG 12 265 #define IPSECCTL_ESP_RANDPAD 13 266 #define IPSECCTL_MAXID 14 267 268 #define IPSECCTL_NAMES { \ 269 { 0, 0 }, \ 270 { 0, 0 }, \ 271 { "def_policy", CTLTYPE_INT }, \ 272 { "esp_trans_deflev", CTLTYPE_INT }, \ 273 { "esp_net_deflev", CTLTYPE_INT }, \ 274 { "ah_trans_deflev", CTLTYPE_INT }, \ 275 { "ah_net_deflev", CTLTYPE_INT }, \ 276 { 0, 0 }, \ 277 { "ah_cleartos", CTLTYPE_INT }, \ 278 { "ah_offsetmask", CTLTYPE_INT }, \ 279 { "dfbit", CTLTYPE_INT }, \ 280 { "ecn", CTLTYPE_INT }, \ 281 { "debug", CTLTYPE_INT }, \ 282 { "esp_randpad", CTLTYPE_INT }, \ 283 } 284 285 #define IPSEC6CTL_NAMES { \ 286 { 0, 0 }, \ 287 { 0, 0 }, \ 288 { "def_policy", CTLTYPE_INT }, \ 289 { "esp_trans_deflev", CTLTYPE_INT }, \ 290 { "esp_net_deflev", CTLTYPE_INT }, \ 291 { "ah_trans_deflev", CTLTYPE_INT }, \ 292 { "ah_net_deflev", CTLTYPE_INT }, \ 293 { 0, 0 }, \ 294 { 0, 0 }, \ 295 { 0, 0 }, \ 296 { 0, 0 }, \ 297 { "ecn", CTLTYPE_INT }, \ 298 { "debug", CTLTYPE_INT }, \ 299 { "esp_randpad", CTLTYPE_INT }, \ 300 } 301 302 #if defined(__ARM__) 303 #define IPSEC_IS_P2ALIGNED(p) IS_P2ALIGNED(p, sizeof (u_int32_t)) 304 #define IPSEC_GET_P2UNALIGNED_OFS(p) (sizeof(u_int32_t) - (((uintptr_t)(p)) & ((uintptr_t)(sizeof(u_int32_t)) - 1))) 305 #else 306 #define IPSEC_IS_P2ALIGNED(p) 1 307 #define IPSEC_GET_P2UNALIGNED_OFS(p) 0 308 #endif 309 310 struct ipsec_output_state { 311 int tunneled; 312 struct mbuf *m; 313 struct route_in6 ro; 314 struct sockaddr *dst; 315 u_int outgoing_if; 316 u_int32_t dscp_mapping; 317 }; 318 319 struct ipsec_history { 320 int ih_proto; 321 u_int32_t ih_spi; 322 }; 323 324 extern int ipsec_debug; 325 326 extern struct ipsecstat ipsecstat; 327 extern struct secpolicy ip4_def_policy; 328 extern int ip4_esp_trans_deflev; 329 extern int ip4_esp_net_deflev; 330 extern int ip4_ah_trans_deflev; 331 extern int ip4_ah_net_deflev; 332 extern int ip4_ah_cleartos; 333 extern int ip4_ah_offsetmask; 334 extern int ip4_ipsec_dfbit; 335 extern int ip4_ipsec_ecn; 336 extern int ip4_esp_randpad; 337 338 extern bool ipsec_save_wake_pkt; 339 340 #define _ipsec_log(level, fmt, ...) do { \ 341 os_log_type_t type; \ 342 switch (level) { \ 343 default: \ 344 type = OS_LOG_TYPE_DEFAULT; \ 345 break; \ 346 case LOG_INFO: \ 347 type = OS_LOG_TYPE_INFO; \ 348 break; \ 349 case LOG_DEBUG: \ 350 type = OS_LOG_TYPE_DEBUG; \ 351 break; \ 352 case LOG_ERR: \ 353 type = OS_LOG_TYPE_ERROR; \ 354 break; \ 355 } \ 356 os_log_with_type(OS_LOG_DEFAULT, type, fmt, ##__VA_ARGS__); \ 357 } while (0) 358 359 #define ipseclog(x) do { if (ipsec_debug != 0) _ipsec_log x; } while (0) 360 361 extern struct secpolicy *ipsec4_getpolicybysock(struct mbuf *, u_int8_t, 362 struct socket *, int *); 363 extern struct secpolicy *ipsec4_getpolicybyaddr(struct mbuf *, u_int8_t, int, 364 int *); 365 extern int ipsec4_getpolicybyinterface(struct mbuf *, u_int8_t, int *, 366 struct ip_out_args *, struct secpolicy **); 367 368 extern u_int ipsec_get_reqlevel(struct ipsecrequest *); 369 370 struct inpcb; 371 extern int ipsec_init_policy(struct socket *so, struct inpcbpolicy **); 372 extern int ipsec_copy_policy(struct inpcbpolicy *, struct inpcbpolicy *); 373 extern u_int ipsec_get_reqlevel(struct ipsecrequest *); 374 375 extern int ipsec4_set_policy(struct inpcb *inp, int optname, 376 caddr_t request, size_t len, int priv); 377 extern int ipsec4_delete_pcbpolicy(struct inpcb *); 378 extern int ipsec4_in_reject_so(struct mbuf *, struct socket *); 379 extern int ipsec4_in_reject(struct mbuf *, struct inpcb *); 380 381 struct secas; 382 struct tcpcb; 383 extern int ipsec_chkreplay(u_int32_t, struct secasvar *, u_int8_t); 384 extern int ipsec_updatereplay(u_int32_t, struct secasvar *, u_int8_t); 385 386 extern size_t ipsec4_hdrsiz(struct mbuf *, u_int8_t, struct inpcb *); 387 extern size_t ipsec_hdrsiz_tcp(struct tcpcb *); 388 extern size_t ipsec_hdrsiz(struct secpolicy *); 389 390 struct ip; 391 extern const char *ipsec4_logpacketstr(struct ip *, u_int32_t); 392 extern const char *ipsec_logsastr(struct secasvar *); 393 394 extern void ipsec_dumpmbuf(struct mbuf *); 395 396 extern int ipsec4_interface_output(struct ipsec_output_state *state, ifnet_t interface); 397 extern int ipsec4_output(struct ipsec_output_state *, struct secpolicy *, int); 398 #if INET 399 extern struct mbuf * ipsec4_splithdr(struct mbuf *); 400 extern int ipsec4_encapsulate(struct mbuf *, struct secasvar *); 401 #endif 402 extern struct mbuf * ipsec6_splithdr(struct mbuf *); 403 extern int ipsec6_encapsulate(struct mbuf *, struct secasvar *); 404 extern int ipsec4_tunnel_validate(struct mbuf *, int, u_int, struct secasvar *, sa_family_t *); 405 extern struct mbuf *ipsec_copypkt(struct mbuf *); 406 extern void ipsec_delaux(struct mbuf *); 407 extern int ipsec_setsocket(struct mbuf *, struct socket *); 408 extern struct socket *ipsec_getsocket(struct mbuf *); 409 extern int ipsec_addhist(struct mbuf *, int, u_int32_t); 410 extern struct ipsec_history *ipsec_gethist(struct mbuf *, int *); 411 extern void ipsec_clearhist(struct mbuf *); 412 extern void ipsec_monitor_sleep_wake(void); 413 extern void ipsec_save_wake_packet(struct mbuf *, u_int32_t, u_int32_t); 414 #endif /* BSD_KERNEL_PRIVATE */ 415 416 #ifndef KERNEL 417 __BEGIN_DECLS 418 extern caddr_t ipsec_set_policy(char *, int); 419 extern int ipsec_get_policylen(caddr_t); 420 extern char *ipsec_dump_policy(caddr_t, char *); 421 422 extern const char *ipsec_strerror(void); 423 __END_DECLS 424 #endif /* KERNEL */ 425 426 #endif /* _NETINET6_IPSEC_H_ */ 427