ipsec.h revision 1.75
1 /* $NetBSD: ipsec.h,v 1.75 2018/04/28 14:01:50 maxv Exp $ */ 2 /* $FreeBSD: ipsec.h,v 1.2.4.2 2004/02/14 22:23:23 bms Exp $ */ 3 /* $KAME: ipsec.h,v 1.53 2001/11/20 08:32:38 itojun Exp $ */ 4 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 #ifndef _NETIPSEC_IPSEC_H_ 35 #define _NETIPSEC_IPSEC_H_ 36 37 #if defined(_KERNEL_OPT) 38 #include "opt_inet.h" 39 #include "opt_ipsec.h" 40 #endif 41 42 #include <net/pfkeyv2.h> 43 44 #ifdef _KERNEL 45 #include <sys/socketvar.h> 46 #include <sys/localcount.h> 47 48 #include <netinet/in_pcb_hdr.h> 49 #include <netipsec/keydb.h> 50 51 /* 52 * Security Policy Index 53 * Ensure that both address families in the "src" and "dst" are same. 54 * When the value of the ul_proto is ICMPv6, the port field in "src" 55 * specifies ICMPv6 type, and the port field in "dst" specifies ICMPv6 code. 56 */ 57 struct secpolicyindex { 58 u_int8_t dir; /* direction of packet flow, see blow */ 59 union sockaddr_union src; /* IP src address for SP */ 60 union sockaddr_union dst; /* IP dst address for SP */ 61 u_int8_t prefs; /* prefix length in bits for src */ 62 u_int8_t prefd; /* prefix length in bits for dst */ 63 u_int16_t ul_proto; /* upper layer Protocol */ 64 #ifdef notyet 65 uid_t uids; 66 uid_t uidd; 67 gid_t gids; 68 gid_t gidd; 69 #endif 70 }; 71 72 /* Security Policy Data Base */ 73 struct secpolicy { 74 struct pslist_entry pslist_entry; 75 76 struct localcount localcount; /* reference count */ 77 struct secpolicyindex spidx; /* selector */ 78 u_int32_t id; /* It's unique number on the system. */ 79 u_int state; /* 0: dead, others: alive */ 80 #define IPSEC_SPSTATE_DEAD 0 81 #define IPSEC_SPSTATE_ALIVE 1 82 83 u_int origin; /* who generate this SP. */ 84 #define IPSEC_SPORIGIN_USER 0 85 #define IPSEC_SPORIGIN_KERNEL 1 86 87 u_int policy; /* DISCARD, NONE or IPSEC, see keyv2.h */ 88 struct ipsecrequest *req; 89 /* pointer to the ipsec request tree, */ 90 /* if policy == IPSEC else this value == NULL.*/ 91 92 /* 93 * lifetime handler. 94 * the policy can be used without limitiation if both lifetime and 95 * validtime are zero. 96 * "lifetime" is passed by sadb_lifetime.sadb_lifetime_addtime. 97 * "validtime" is passed by sadb_lifetime.sadb_lifetime_usetime. 98 */ 99 time_t created; /* time created the policy */ 100 time_t lastused; /* updated every when kernel sends a packet */ 101 time_t lifetime; /* duration of the lifetime of this policy */ 102 time_t validtime; /* duration this policy is valid without use */ 103 }; 104 105 /* Request for IPsec */ 106 struct ipsecrequest { 107 struct ipsecrequest *next; 108 /* pointer to next structure */ 109 /* If NULL, it means the end of chain. */ 110 struct secasindex saidx;/* hint for search proper SA */ 111 /* if __ss_len == 0 then no address specified.*/ 112 u_int level; /* IPsec level defined below. */ 113 114 struct secpolicy *sp; /* back pointer to SP */ 115 }; 116 117 /* security policy in PCB */ 118 struct inpcbpolicy { 119 struct secpolicy *sp_in; 120 struct secpolicy *sp_out; 121 int priv; /* privileged socket ? */ 122 123 /* cached policy */ 124 struct { 125 struct secpolicy *cachesp; 126 struct secpolicyindex cacheidx; 127 int cachehint; /* processing requirement hint: */ 128 #define IPSEC_PCBHINT_UNKNOWN 0 /* Unknown */ 129 #define IPSEC_PCBHINT_YES 1 /* IPsec processing is required */ 130 #define IPSEC_PCBHINT_NO 2 /* IPsec processing not required */ 131 u_int cachegen; /* spdgen when cache filled */ 132 } sp_cache[3]; /* XXX 3 == IPSEC_DIR_MAX */ 133 int sp_cacheflags; 134 #define IPSEC_PCBSP_CONNECTED 1 135 struct inpcb_hdr *sp_inph; /* back pointer */ 136 }; 137 138 extern u_int ipsec_spdgen; 139 140 static __inline bool 141 ipsec_pcb_skip_ipsec(struct inpcbpolicy *pcbsp, int dir) 142 { 143 144 KASSERT(inph_locked(pcbsp->sp_inph)); 145 146 return pcbsp->sp_cache[(dir)].cachehint == IPSEC_PCBHINT_NO && 147 pcbsp->sp_cache[(dir)].cachegen == ipsec_spdgen; 148 } 149 150 /* SP acquiring list table. */ 151 struct secspacq { 152 LIST_ENTRY(secspacq) chain; 153 154 struct secpolicyindex spidx; 155 156 time_t created; /* for lifetime */ 157 int count; /* for lifetime */ 158 /* XXX: here is mbuf place holder to be sent ? */ 159 }; 160 #endif /* _KERNEL */ 161 162 /* buffer size for formatted output of ipsec address (addr + '%' + scope_id?) */ 163 #define IPSEC_ADDRSTRLEN (INET6_ADDRSTRLEN + 11) 164 /* buffer size for ipsec_logsastr() */ 165 #define IPSEC_LOGSASTRLEN 192 166 167 /* according to IANA assignment, port 0x0000 and proto 0xff are reserved. */ 168 #define IPSEC_PORT_ANY 0 169 #define IPSEC_ULPROTO_ANY 255 170 #define IPSEC_PROTO_ANY 255 171 172 /* mode of security protocol */ 173 /* NOTE: DON'T use IPSEC_MODE_ANY at SPD. It's only use in SAD */ 174 #define IPSEC_MODE_ANY 0 /* i.e. wildcard. */ 175 #define IPSEC_MODE_TRANSPORT 1 176 #define IPSEC_MODE_TUNNEL 2 177 #define IPSEC_MODE_TCPMD5 3 /* TCP MD5 mode */ 178 179 /* 180 * Direction of security policy. 181 * NOTE: Since INVALID is used just as flag. 182 * The other are used for loop counter too. 183 */ 184 #define IPSEC_DIR_ANY 0 185 #define IPSEC_DIR_INBOUND 1 186 #define IPSEC_DIR_OUTBOUND 2 187 #define IPSEC_DIR_MAX 3 188 #define IPSEC_DIR_INVALID 4 189 190 #define IPSEC_DIR_IS_VALID(dir) ((dir) >= 0 && (dir) <= IPSEC_DIR_MAX) 191 #define IPSEC_DIR_IS_INOROUT(dir) ((dir) == IPSEC_DIR_INBOUND || \ 192 (dir) == IPSEC_DIR_OUTBOUND) 193 194 /* Policy level */ 195 /* 196 * IPSEC, ENTRUST and BYPASS are allowed for setsockopt() in PCB, 197 * DISCARD, IPSEC and NONE are allowed for setkey() in SPD. 198 * DISCARD and NONE are allowed for system default. 199 */ 200 #define IPSEC_POLICY_DISCARD 0 /* discarding packet */ 201 #define IPSEC_POLICY_NONE 1 /* through IPsec engine */ 202 #define IPSEC_POLICY_IPSEC 2 /* do IPsec */ 203 #define IPSEC_POLICY_ENTRUST 3 /* consulting SPD if present. */ 204 #define IPSEC_POLICY_BYPASS 4 /* only for privileged socket. */ 205 206 /* Security protocol level */ 207 #define IPSEC_LEVEL_DEFAULT 0 /* reference to system default */ 208 #define IPSEC_LEVEL_USE 1 /* use SA if present. */ 209 #define IPSEC_LEVEL_REQUIRE 2 /* require SA. */ 210 #define IPSEC_LEVEL_UNIQUE 3 /* unique SA. */ 211 212 #define IPSEC_MANUAL_REQID_MAX 0x3fff 213 /* 214 * if security policy level == unique, this id 215 * indicate to a relative SA for use, else is 216 * zero. 217 * 1 - 0x3fff are reserved for manual keying. 218 * 0 are reserved for above reason. Others is 219 * for kernel use. 220 * Note that this id doesn't identify SA 221 * by only itself. 222 */ 223 #define IPSEC_REPLAYWSIZE 32 224 225 #ifdef _KERNEL 226 227 extern int ipsec_debug; 228 #ifdef IPSEC_DEBUG 229 extern int ipsec_replay; 230 extern int ipsec_integrity; 231 #endif 232 233 extern struct secpolicy ip4_def_policy; 234 extern int ip4_esp_trans_deflev; 235 extern int ip4_esp_net_deflev; 236 extern int ip4_ah_trans_deflev; 237 extern int ip4_ah_net_deflev; 238 extern int ip4_ah_cleartos; 239 extern int ip4_ah_offsetmask; 240 extern int ip4_ipsec_dfbit; 241 extern int ip4_ipsec_ecn; 242 extern int crypto_support; 243 244 #include <sys/syslog.h> 245 246 #define DPRINTF(x) do { if (ipsec_debug) printf x; } while (0) 247 248 #define IPSECLOG(level, fmt, args...) \ 249 do { \ 250 if (ipsec_debug) \ 251 log(level, "%s: " fmt, __func__, ##args); \ 252 } while (0) 253 254 #define ipsec_indone(m) \ 255 ((m->m_flags & M_AUTHIPHDR) || (m->m_flags & M_DECRYPTED)) 256 #define ipsec_outdone(m) \ 257 (m_tag_find((m), PACKET_TAG_IPSEC_OUT_DONE, NULL) != NULL) 258 259 void ipsec_pcbconn(struct inpcbpolicy *); 260 void ipsec_pcbdisconn(struct inpcbpolicy *); 261 void ipsec_invalpcbcacheall(void); 262 263 struct inpcb; 264 int ipsec4_output(struct mbuf *, struct inpcb *, int, u_long *, bool *, bool *); 265 int ipsec4_input(struct mbuf *, int); 266 int ipsec4_forward(struct mbuf *, int *); 267 #ifdef INET6 268 int ipsec6_input(struct mbuf *); 269 #endif 270 271 struct inpcb; 272 #define ipsec_init_pcbpolicy ipsec_init_policy 273 int ipsec_init_policy(struct socket *so, struct inpcbpolicy **); 274 int ipsec_copy_policy(const struct inpcbpolicy *, struct inpcbpolicy *); 275 u_int ipsec_get_reqlevel(const struct ipsecrequest *); 276 277 int ipsec_set_policy(void *, int, const void *, size_t, kauth_cred_t); 278 int ipsec_get_policy(void *, const void *, size_t, struct mbuf **); 279 int ipsec_delete_pcbpolicy(void *); 280 int ipsec_in_reject(struct mbuf *, void *); 281 282 struct secasvar *ipsec_lookup_sa(const struct ipsecrequest *, 283 const struct mbuf *); 284 285 struct secas; 286 struct tcpcb; 287 int ipsec_chkreplay(u_int32_t, const struct secasvar *); 288 int ipsec_updatereplay(u_int32_t, const struct secasvar *); 289 290 size_t ipsec_hdrsiz(struct mbuf *, u_int, void *); 291 size_t ipsec4_hdrsiz_tcp(struct tcpcb *); 292 293 union sockaddr_union; 294 const char *ipsec_address(const union sockaddr_union* sa, char *, size_t); 295 const char *ipsec_logsastr(const struct secasvar *, char *, size_t); 296 297 /* NetBSD protosw ctlin entrypoint */ 298 void *esp4_ctlinput(int, const struct sockaddr *, void *); 299 void *ah4_ctlinput(int, const struct sockaddr *, void *); 300 301 void ipsec_output_init(void); 302 struct m_tag; 303 void ipsec4_common_input(struct mbuf *m, ...); 304 int ipsec4_common_input_cb(struct mbuf *, struct secasvar *, int, int); 305 int ipsec4_process_packet(struct mbuf *, const struct ipsecrequest *, u_long *); 306 int ipsec_process_done(struct mbuf *, const struct ipsecrequest *, 307 struct secasvar *); 308 309 struct mbuf *m_clone(struct mbuf *); 310 struct mbuf *m_makespace(struct mbuf *, int, int, int *); 311 void *m_pad(struct mbuf *, int); 312 int m_striphdr(struct mbuf *, int, int); 313 314 void nat_t_ports_get(struct mbuf *, u_int16_t *, u_int16_t *); 315 316 extern int ipsec_used __read_mostly; 317 extern int ipsec_enabled __read_mostly; 318 319 #endif /* _KERNEL */ 320 321 #ifndef _KERNEL 322 char *ipsec_set_policy(const char *, int); 323 int ipsec_get_policylen(char *); 324 char *ipsec_dump_policy(char *, const char *); 325 const char *ipsec_strerror(void); 326 #endif /* !_KERNEL */ 327 328 #ifdef _KERNEL 329 /* External declarations of per-file init functions */ 330 void ah_attach(void); 331 void esp_attach(void); 332 void ipcomp_attach(void); 333 void ipe4_attach(void); 334 void ipe4_attach(void); 335 void tcpsignature_attach(void); 336 337 void ipsec_attach(void); 338 339 void sysctl_net_inet_ipsec_setup(struct sysctllog **); 340 #ifdef INET6 341 void sysctl_net_inet6_ipsec6_setup(struct sysctllog **); 342 #endif 343 344 #endif /* _KERNEL */ 345 #endif /* !_NETIPSEC_IPSEC_H_ */ 346
Indexes created Wed Sep 24 15:09:51 GMT 2025