1 /* $KAME: ipsec.h,v 1.53 2001/11/20 08:32:38 itojun Exp $ */ 2 3 /*- 4 * SPDX-License-Identifier: BSD-3-Clause 5 * 6 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. 7 * All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 3. Neither the name of the project nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 */ 33 34 /* 35 * IPsec controller part. 36 */ 37 38 #ifndef _NETIPSEC_IPSEC_H_ 39 #define _NETIPSEC_IPSEC_H_ 40 41 #include <net/pfkeyv2.h> 42 #include <netipsec/keydb.h> 43 44 #ifdef _KERNEL 45 46 #include <sys/_lock.h> 47 #include <sys/_mutex.h> 48 #include <sys/_rwlock.h> 49 50 #define IPSEC_ASSERT(_c,_m) KASSERT(_c, _m) 51 52 /* 53 * Security Policy Index 54 * Ensure that both address families in the "src" and "dst" are same. 55 * When the value of the ul_proto is ICMPv6, the port field in "src" 56 * specifies ICMPv6 type, and the port field in "dst" specifies ICMPv6 code. 57 */ 58 struct secpolicyindex { 59 union sockaddr_union src; /* IP src address for SP */ 60 union sockaddr_union dst; /* IP dst address for SP */ 61 uint8_t ul_proto; /* upper layer Protocol */ 62 uint8_t dir; /* direction of packet flow */ 63 uint8_t prefs; /* prefix length in bits for src */ 64 uint8_t prefd; /* prefix length in bits for dst */ 65 }; 66 67 /* Request for IPsec */ 68 struct ipsecrequest { 69 struct secasindex saidx;/* hint for search proper SA */ 70 /* if __ss_len == 0 then no address specified.*/ 71 u_int level; /* IPsec level defined below. */ 72 }; 73 74 struct ipsec_accel_adddel_sp_tq { 75 struct vnet *adddel_vnet; 76 struct task adddel_task; 77 int adddel_scheduled; 78 }; 79 80 /* Security Policy Data Base */ 81 struct secpolicy { 82 TAILQ_ENTRY(secpolicy) chain; 83 LIST_ENTRY(secpolicy) idhash; 84 LIST_ENTRY(secpolicy) drainq; 85 86 struct secpolicyindex spidx; /* selector */ 87 #define IPSEC_MAXREQ 4 88 struct ipsecrequest *req[IPSEC_MAXREQ]; 89 u_int tcount; /* IPsec transforms count */ 90 volatile u_int refcnt; /* reference count */ 91 u_int policy; /* policy_type per pfkeyv2.h */ 92 u_int state; 93 #define IPSEC_SPSTATE_DEAD 0 94 #define IPSEC_SPSTATE_LARVAL 1 95 #define IPSEC_SPSTATE_ALIVE 2 96 #define IPSEC_SPSTATE_PCB 3 97 #define IPSEC_SPSTATE_IFNET 4 98 uint32_t priority; /* priority of this policy */ 99 uint32_t id; /* It's unique number on the system. */ 100 /* 101 * lifetime handler. 102 * the policy can be used without limitiation if both lifetime and 103 * validtime are zero. 104 * "lifetime" is passed by sadb_lifetime.sadb_lifetime_addtime. 105 * "validtime" is passed by sadb_lifetime.sadb_lifetime_usetime. 106 */ 107 time_t created; /* time created the policy */ 108 time_t lastused; /* updated every when kernel sends a packet */ 109 long lifetime; /* duration of the lifetime of this policy */ 110 long validtime; /* duration this policy is valid without use */ 111 CK_LIST_HEAD(, ifp_handle_sp) accel_ifps; 112 struct ipsec_accel_adddel_sp_tq accel_add_tq; 113 struct ipsec_accel_adddel_sp_tq accel_del_tq; 114 struct inpcb *ipsec_accel_add_sp_inp; 115 const char *accel_ifname; 116 }; 117 118 /* 119 * PCB security policies. 120 * Application can setup private security policies for socket. 121 * Such policies can have IPSEC, BYPASS and ENTRUST type. 122 * By default, policies are set to NULL. This means that they have ENTRUST type. 123 * When application sets BYPASS or IPSEC type policy, the flags field 124 * is also updated. When flags is not set, the system could store 125 * used security policy into the sp_in/sp_out pointer to speed up further 126 * lookups. 127 */ 128 struct inpcbpolicy { 129 struct secpolicy *sp_in; 130 struct secpolicy *sp_out; 131 132 uint32_t genid; 133 uint16_t flags; 134 #define INP_INBOUND_POLICY 0x0001 135 #define INP_OUTBOUND_POLICY 0x0002 136 uint16_t hdrsz; 137 }; 138 139 /* SP acquiring list table. */ 140 struct secspacq { 141 LIST_ENTRY(secspacq) chain; 142 143 struct secpolicyindex spidx; 144 145 time_t created; /* for lifetime */ 146 int count; /* for lifetime */ 147 /* XXX: here is mbuf place holder to be sent ? */ 148 }; 149 #endif /* _KERNEL */ 150 151 /* buffer size for formatted output of ipsec address */ 152 #define IPSEC_ADDRSTRLEN (INET6_ADDRSTRLEN + 11) 153 154 /* according to IANA assignment, port 0x0000 and proto 0xff are reserved. */ 155 #define IPSEC_PORT_ANY 0 156 #define IPSEC_ULPROTO_ANY 255 157 #define IPSEC_PROTO_ANY 255 158 159 /* mode of security protocol */ 160 /* NOTE: DON'T use IPSEC_MODE_ANY at SPD. It's only use in SAD */ 161 #define IPSEC_MODE_ANY 0 /* i.e. wildcard. */ 162 #define IPSEC_MODE_TRANSPORT 1 163 #define IPSEC_MODE_TUNNEL 2 164 #define IPSEC_MODE_TCPMD5 3 /* TCP MD5 mode */ 165 166 /* 167 * Direction of security policy. 168 * NOTE: Since INVALID is used just as flag. 169 * The other are used for loop counter too. 170 */ 171 #define IPSEC_DIR_ANY 0 172 #define IPSEC_DIR_INBOUND 1 173 #define IPSEC_DIR_OUTBOUND 2 174 #define IPSEC_DIR_MAX 3 175 #define IPSEC_DIR_INVALID 4 176 177 /* Policy level */ 178 /* 179 * IPSEC, ENTRUST and BYPASS are allowed for setsockopt() in PCB, 180 * DISCARD, IPSEC and NONE are allowed for setkey() in SPD. 181 * DISCARD and NONE are allowed for system default. 182 */ 183 #define IPSEC_POLICY_DISCARD 0 /* discarding packet */ 184 #define IPSEC_POLICY_NONE 1 /* through IPsec engine */ 185 #define IPSEC_POLICY_IPSEC 2 /* do IPsec */ 186 #define IPSEC_POLICY_ENTRUST 3 /* consulting SPD if present. */ 187 #define IPSEC_POLICY_BYPASS 4 /* only for privileged socket. */ 188 189 /* Policy scope */ 190 #define IPSEC_POLICYSCOPE_ANY 0x00 /* unspecified */ 191 #define IPSEC_POLICYSCOPE_GLOBAL 0x01 /* global scope */ 192 #define IPSEC_POLICYSCOPE_IFNET 0x02 /* if_ipsec(4) scope */ 193 #define IPSEC_POLICYSCOPE_PCB 0x04 /* PCB scope */ 194 195 /* Security protocol level */ 196 #define IPSEC_LEVEL_DEFAULT 0 /* reference to system default */ 197 #define IPSEC_LEVEL_USE 1 /* use SA if present. */ 198 #define IPSEC_LEVEL_REQUIRE 2 /* require SA. */ 199 #define IPSEC_LEVEL_UNIQUE 3 /* unique SA. */ 200 201 #define IPSEC_MANUAL_REQID_MAX 0x3fff 202 /* 203 * if security policy level == unique, this id 204 * indicate to a relative SA for use, else is 205 * zero. 206 * 1 - 0x3fff are reserved for manual keying. 207 * 0 are reserved for above reason. Others is 208 * for kernel use. 209 * Note that this id doesn't identify SA 210 * by only itself. 211 */ 212 #define IPSEC_REPLAYWSIZE 32 213 214 /* statistics for ipsec processing */ 215 struct ipsecstat { 216 uint64_t ips_in_polvio; /* input: sec policy violation */ 217 uint64_t ips_in_nomem; /* input: no memory available */ 218 uint64_t ips_in_inval; /* input: generic error */ 219 220 uint64_t ips_out_polvio; /* output: sec policy violation */ 221 uint64_t ips_out_nosa; /* output: SA unavailable */ 222 uint64_t ips_out_nomem; /* output: no memory available */ 223 uint64_t ips_out_noroute; /* output: no route available */ 224 uint64_t ips_out_inval; /* output: generic error */ 225 uint64_t ips_out_bundlesa; /* output: bundled SA processed */ 226 227 uint64_t ips_spdcache_hits; /* SPD cache hits */ 228 uint64_t ips_spdcache_misses; /* SPD cache misses */ 229 230 uint64_t ips_clcopied; /* clusters copied during clone */ 231 uint64_t ips_mbinserted; /* mbufs inserted during makespace */ 232 /* 233 * Temporary statistics for performance analysis. 234 */ 235 /* See where ESP/AH/IPCOMP header land in mbuf on input */ 236 uint64_t ips_input_front; 237 uint64_t ips_input_middle; 238 uint64_t ips_input_end; 239 }; 240 241 /* 242 * Definitions for IPsec & Key sysctl operations. 243 */ 244 #define IPSECCTL_STATS 1 /* stats */ 245 #define IPSECCTL_DEF_POLICY 2 246 #define IPSECCTL_DEF_ESP_TRANSLEV 3 /* int; ESP transport mode */ 247 #define IPSECCTL_DEF_ESP_NETLEV 4 /* int; ESP tunnel mode */ 248 #define IPSECCTL_DEF_AH_TRANSLEV 5 /* int; AH transport mode */ 249 #define IPSECCTL_DEF_AH_NETLEV 6 /* int; AH tunnel mode */ 250 #if 0 /* obsolete, do not reuse */ 251 #define IPSECCTL_INBOUND_CALL_IKE 7 252 #endif 253 #define IPSECCTL_AH_CLEARTOS 8 254 #define IPSECCTL_AH_OFFSETMASK 9 255 #define IPSECCTL_DFBIT 10 256 #define IPSECCTL_ECN 11 257 #define IPSECCTL_DEBUG 12 258 #define IPSECCTL_ESP_RANDPAD 13 259 #define IPSECCTL_MIN_PMTU 14 260 261 #ifdef _KERNEL 262 #include <sys/counter.h> 263 264 struct ipsec_ctx_data; 265 #define IPSEC_INIT_CTX(_ctx, _mp, _inp, _sav, _af, _enc) do { \ 266 (_ctx)->mp = (_mp); \ 267 (_ctx)->inp = (_inp); \ 268 (_ctx)->sav = (_sav); \ 269 (_ctx)->af = (_af); \ 270 (_ctx)->enc = (_enc); \ 271 } while(0) 272 int ipsec_run_hhooks(struct ipsec_ctx_data *ctx, int direction); 273 274 VNET_DECLARE(int, ipsec_debug); 275 #define V_ipsec_debug VNET(ipsec_debug) 276 277 #ifdef REGRESSION 278 VNET_DECLARE(int, ipsec_replay); 279 VNET_DECLARE(int, ipsec_integrity); 280 281 #define V_ipsec_replay VNET(ipsec_replay) 282 #define V_ipsec_integrity VNET(ipsec_integrity) 283 #endif 284 285 VNET_PCPUSTAT_DECLARE(struct ipsecstat, ipsec4stat); 286 VNET_DECLARE(int, ip4_esp_trans_deflev); 287 VNET_DECLARE(int, ip4_esp_net_deflev); 288 VNET_DECLARE(int, ip4_ah_trans_deflev); 289 VNET_DECLARE(int, ip4_ah_net_deflev); 290 VNET_DECLARE(int, ip4_ipsec_dfbit); 291 VNET_DECLARE(int, ip4_ipsec_min_pmtu); 292 VNET_DECLARE(int, ip4_ipsec_ecn); 293 VNET_DECLARE(int, crypto_support); 294 VNET_DECLARE(int, async_crypto); 295 VNET_DECLARE(int, natt_cksum_policy); 296 297 #define IPSECSTAT_INC(name) \ 298 VNET_PCPUSTAT_ADD(struct ipsecstat, ipsec4stat, name, 1) 299 #define V_ip4_esp_trans_deflev VNET(ip4_esp_trans_deflev) 300 #define V_ip4_esp_net_deflev VNET(ip4_esp_net_deflev) 301 #define V_ip4_ah_trans_deflev VNET(ip4_ah_trans_deflev) 302 #define V_ip4_ah_net_deflev VNET(ip4_ah_net_deflev) 303 #define V_ip4_ipsec_dfbit VNET(ip4_ipsec_dfbit) 304 #define V_ip4_ipsec_min_pmtu VNET(ip4_ipsec_min_pmtu) 305 #define V_ip4_ipsec_ecn VNET(ip4_ipsec_ecn) 306 #define V_crypto_support VNET(crypto_support) 307 #define V_async_crypto VNET(async_crypto) 308 #define V_natt_cksum_policy VNET(natt_cksum_policy) 309 310 #define ipseclog(x) do { if (V_ipsec_debug) log x; } while (0) 311 /* for openbsd compatibility */ 312 #ifdef IPSEC_DEBUG 313 #define IPSEC_DEBUG_DECLARE(x) x 314 #define DPRINTF(x) do { if (V_ipsec_debug) printf x; } while (0) 315 #else 316 #define IPSEC_DEBUG_DECLARE(x) 317 #define DPRINTF(x) 318 #endif 319 320 struct inpcb; 321 struct m_tag; 322 struct secasvar; 323 struct sockopt; 324 struct tcphdr; 325 union sockaddr_union; 326 327 int ipsec_if_input(struct mbuf *, struct secasvar *, uint32_t); 328 329 struct ipsecrequest *ipsec_newisr(void); 330 void ipsec_delisr(struct ipsecrequest *); 331 struct secpolicy *ipsec4_checkpolicy(const struct mbuf *, struct inpcb *, 332 int *, int); 333 334 u_int ipsec_get_reqlevel(struct secpolicy *, u_int); 335 336 void udp_ipsec_adjust_cksum(struct mbuf *, struct secasvar *, int, int); 337 int udp_ipsec_output(struct mbuf *, struct secasvar *); 338 339 int ipsec_chkreplay(uint32_t, uint32_t *, struct secasvar *); 340 int ipsec_updatereplay(uint32_t, struct secasvar *); 341 int ipsec_updateid(struct secasvar *, crypto_session_t *, crypto_session_t *); 342 int ipsec_initialized(void); 343 size_t ipsec_hdrsiz_internal(struct secpolicy *); 344 345 void ipsec_setspidx_inpcb(struct inpcb *, struct secpolicyindex *, u_int); 346 347 void ipsec4_setsockaddrs(const struct mbuf *, union sockaddr_union *, 348 union sockaddr_union *); 349 int ipsec4_common_input_cb(struct mbuf *, struct secasvar *, int, int); 350 int ipsec4_check_pmtu(struct ifnet *, struct mbuf *, struct secpolicy *, int); 351 int ipsec4_process_packet(struct ifnet *, struct mbuf *, struct secpolicy *, 352 struct inpcb *, u_long); 353 int ipsec_process_done(struct mbuf *, struct secpolicy *, struct secasvar *, 354 u_int); 355 356 extern void m_checkalignment(const char* where, struct mbuf *m0, 357 int off, int len); 358 extern struct mbuf *m_makespace(struct mbuf *m0, int skip, int hlen, int *off); 359 extern caddr_t m_pad(struct mbuf *m, int n); 360 extern int m_striphdr(struct mbuf *m, int skip, int hlen); 361 362 #endif /* _KERNEL */ 363 364 #ifndef _KERNEL 365 extern caddr_t ipsec_set_policy(const char *, int); 366 extern int ipsec_get_policylen(c_caddr_t); 367 extern char *ipsec_dump_policy(c_caddr_t, const char *); 368 extern const char *ipsec_strerror(void); 369 370 #endif /* ! KERNEL */ 371 372 #endif /* _NETIPSEC_IPSEC_H_ */ 373