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