ipsec.h revision 1.48
1 /* $NetBSD: ipsec.h,v 1.48 2017/05/19 04:34:09 ozaki-r Exp $ */ 2 /* $FreeBSD: /usr/local/www/cvsroot/FreeBSD/src/sys/netipsec/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 /* 35 * IPsec controller part. 36 */ 37 38 #ifndef _NETIPSEC_IPSEC_H_ 39 #define _NETIPSEC_IPSEC_H_ 40 41 #if defined(_KERNEL_OPT) 42 #include "opt_inet.h" 43 #include "opt_ipsec.h" 44 #endif 45 46 #include <net/pfkeyv2.h> 47 48 #ifdef _KERNEL 49 50 #include <netipsec/keydb.h> 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 u_int8_t dir; /* direction of packet flow, see blow */ 60 union sockaddr_union src; /* IP src address for SP */ 61 union sockaddr_union dst; /* IP dst address for SP */ 62 u_int8_t prefs; /* prefix length in bits for src */ 63 u_int8_t prefd; /* prefix length in bits for dst */ 64 u_int16_t ul_proto; /* upper layer Protocol */ 65 #ifdef notyet 66 uid_t uids; 67 uid_t uidd; 68 gid_t gids; 69 gid_t gidd; 70 #endif 71 }; 72 73 /* Security Policy Data Base */ 74 struct secpolicy { 75 LIST_ENTRY(secpolicy) chain; 76 77 u_int refcnt; /* reference count */ 78 struct secpolicyindex spidx; /* selector */ 79 u_int32_t id; /* It's unique number on the system. */ 80 u_int state; /* 0: dead, others: alive */ 81 #define IPSEC_SPSTATE_DEAD 0 82 #define IPSEC_SPSTATE_ALIVE 1 83 84 u_int policy; /* DISCARD, NONE or IPSEC, see keyv2.h */ 85 struct ipsecrequest *req; 86 /* pointer to the ipsec request tree, */ 87 /* if policy == IPSEC else this value == NULL.*/ 88 89 /* 90 * lifetime handler. 91 * the policy can be used without limitiation if both lifetime and 92 * validtime are zero. 93 * "lifetime" is passed by sadb_lifetime.sadb_lifetime_addtime. 94 * "validtime" is passed by sadb_lifetime.sadb_lifetime_usetime. 95 */ 96 time_t created; /* time created the policy */ 97 time_t lastused; /* updated every when kernel sends a packet */ 98 time_t lifetime; /* duration of the lifetime of this policy */ 99 time_t validtime; /* duration this policy is valid without use */ 100 }; 101 102 /* Request for IPsec */ 103 struct ipsecrequest { 104 struct ipsecrequest *next; 105 /* pointer to next structure */ 106 /* If NULL, it means the end of chain. */ 107 struct secasindex saidx;/* hint for search proper SA */ 108 /* if __ss_len == 0 then no address specified.*/ 109 u_int level; /* IPsec level defined below. */ 110 111 struct secasvar *sav; /* place holder of SA for use */ 112 struct secpolicy *sp; /* back pointer to SP */ 113 }; 114 115 /* security policy in PCB */ 116 struct inpcbpolicy { 117 struct secpolicy *sp_in; 118 struct secpolicy *sp_out; 119 int priv; /* privileged socket ? */ 120 121 /* cached policy */ 122 struct { 123 struct secpolicy *cachesp; 124 struct secpolicyindex cacheidx; 125 int cachehint; /* processing requirement hint: */ 126 #define IPSEC_PCBHINT_MAYBE 0 /* IPsec processing maybe required */ 127 #define IPSEC_PCBHINT_YES 1 /* IPsec processing is required */ 128 #define IPSEC_PCBHINT_NO 2 /* IPsec processing not required */ 129 u_int cachegen; /* spdgen when cache filled */ 130 } sp_cache[3]; /* XXX 3 == IPSEC_DIR_MAX */ 131 int sp_cacheflags; 132 #define IPSEC_PCBSP_CONNECTED 1 133 struct inpcb_hdr *sp_inph; /* back pointer */ 134 }; 135 136 #define IPSEC_PCB_SKIP_IPSEC(inpp, dir) \ 137 ((inpp)->sp_cache[(dir)].cachehint == IPSEC_PCBHINT_NO && \ 138 (inpp)->sp_cache[(dir)].cachegen == ipsec_spdgen) 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 (addr + '%' + scope_id?) */ 153 #define IPSEC_ADDRSTRLEN (INET6_ADDRSTRLEN + 11) 154 /* buffer size for ipsec_logsastr() */ 155 #define IPSEC_LOGSASTRLEN 192 156 157 /* according to IANA assignment, port 0x0000 and proto 0xff are reserved. */ 158 #define IPSEC_PORT_ANY 0 159 #define IPSEC_ULPROTO_ANY 255 160 #define IPSEC_PROTO_ANY 255 161 162 /* mode of security protocol */ 163 /* NOTE: DON'T use IPSEC_MODE_ANY at SPD. It's only use in SAD */ 164 #define IPSEC_MODE_ANY 0 /* i.e. wildcard. */ 165 #define IPSEC_MODE_TRANSPORT 1 166 #define IPSEC_MODE_TUNNEL 2 167 #define IPSEC_MODE_TCPMD5 3 /* TCP MD5 mode */ 168 169 /* 170 * Direction of security policy. 171 * NOTE: Since INVALID is used just as flag. 172 * The other are used for loop counter too. 173 */ 174 #define IPSEC_DIR_ANY 0 175 #define IPSEC_DIR_INBOUND 1 176 #define IPSEC_DIR_OUTBOUND 2 177 #define IPSEC_DIR_MAX 3 178 #define IPSEC_DIR_INVALID 4 179 180 #define IPSEC_DIR_IS_VALID(dir) ((dir) >= 0 && (dir) <= IPSEC_DIR_MAX) 181 #define IPSEC_DIR_IS_INOROUT(dir) ((dir) == IPSEC_DIR_INBOUND || \ 182 (dir) == IPSEC_DIR_OUTBOUND) 183 184 /* Policy level */ 185 /* 186 * IPSEC, ENTRUST and BYPASS are allowed for setsockopt() in PCB, 187 * DISCARD, IPSEC and NONE are allowed for setkey() in SPD. 188 * DISCARD and NONE are allowed for system default. 189 */ 190 #define IPSEC_POLICY_DISCARD 0 /* discarding packet */ 191 #define IPSEC_POLICY_NONE 1 /* through IPsec engine */ 192 #define IPSEC_POLICY_IPSEC 2 /* do IPsec */ 193 #define IPSEC_POLICY_ENTRUST 3 /* consulting SPD if present. */ 194 #define IPSEC_POLICY_BYPASS 4 /* only for privileged socket. */ 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 #ifdef _KERNEL 216 struct ipsec_output_state { 217 struct mbuf *m; 218 struct route *ro; 219 struct sockaddr *dst; 220 }; 221 222 struct ipsec_history { 223 int ih_proto; 224 u_int32_t ih_spi; 225 }; 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 ip4_esp_randpad; 243 extern int crypto_support; 244 245 #include <sys/syslog.h> 246 #define ipseclog(x) do { if (ipsec_debug) log x; } while (0) 247 /* for openbsd compatibility */ 248 #define DPRINTF(x) do { if (ipsec_debug) printf x; } while (0) 249 250 #define IPSECLOG(level, fmt, args...) \ 251 do { \ 252 if (ipsec_debug) \ 253 log(level, "%s: " fmt, __func__, ##args); \ 254 } while (0) 255 256 void ipsec_pcbconn (struct inpcbpolicy *); 257 void ipsec_pcbdisconn (struct inpcbpolicy *); 258 void ipsec_invalpcbcacheall (void); 259 260 extern u_int ipsec_spdgen; 261 262 struct tdb_ident; 263 struct secpolicy *ipsec_getpolicy (const struct tdb_ident*, u_int); 264 struct inpcb; 265 struct secpolicy *ipsec4_checkpolicy (struct mbuf *, u_int, u_int, 266 int *, struct inpcb *); 267 struct secpolicy * ipsec_getpolicybyaddr(struct mbuf *, u_int, 268 int, int *); 269 int ipsec4_output(struct mbuf *, struct inpcb *, int, 270 u_long *, bool *, bool *); 271 int ipsec4_input(struct mbuf *, int); 272 int ipsec4_forward(struct mbuf *, int *); 273 #ifdef INET6 274 int ipsec6_input(struct mbuf *); 275 #endif 276 277 static __inline struct secpolicy* 278 ipsec4_getpolicybysock( 279 struct mbuf *m, 280 u_int dir, 281 const struct socket *so, 282 int *err 283 ) 284 { 285 panic("ipsec4_getpolicybysock"); 286 } 287 288 static __inline int 289 ipsec_copy_pcbpolicy( 290 struct inpcbpolicy *oldp, 291 struct inpcbpolicy *newp 292 ) 293 { 294 /*XXX do nothing */ 295 return (0); 296 } 297 298 struct inpcb; 299 #define ipsec_init_pcbpolicy ipsec_init_policy 300 int ipsec_init_policy (struct socket *so, struct inpcbpolicy **); 301 int ipsec_copy_policy 302 (const struct inpcbpolicy *, struct inpcbpolicy *); 303 u_int ipsec_get_reqlevel (const struct ipsecrequest *); 304 int ipsec_in_reject (const struct secpolicy *, const struct mbuf *); 305 306 int ipsec4_set_policy (struct inpcb *, int, const void *, size_t, kauth_cred_t); 307 int ipsec4_get_policy (struct inpcb *, const void *, size_t, struct mbuf **); 308 int ipsec4_delete_pcbpolicy (struct inpcb *); 309 int ipsec4_in_reject (struct mbuf *, struct inpcb *); 310 311 312 struct secas; 313 struct tcpcb; 314 int ipsec_chkreplay (u_int32_t, const struct secasvar *); 315 int ipsec_updatereplay (u_int32_t, const struct secasvar *); 316 317 size_t ipsec4_hdrsiz (struct mbuf *, u_int, struct inpcb *); 318 size_t ipsec4_hdrsiz_tcp (struct tcpcb *); 319 #define ipsec4_getpolicybyaddr ipsec_getpolicybyaddr 320 321 union sockaddr_union; 322 const char *ipsec_address(const union sockaddr_union* sa, char *, size_t); 323 const char *ipsec_logsastr(const struct secasvar *, char *, size_t); 324 325 void ipsec_dumpmbuf (struct mbuf *); 326 327 /* NetBSD protosw ctlin entrypoint */ 328 void *esp4_ctlinput(int, const struct sockaddr *, void *); 329 void *ah4_ctlinput(int, const struct sockaddr *, void *); 330 331 struct m_tag; 332 void ipsec4_common_input(struct mbuf *m, ...); 333 int ipsec4_common_input_cb(struct mbuf *, struct secasvar *, 334 int, int, struct m_tag *); 335 int ipsec4_process_packet(struct mbuf *, struct ipsecrequest *); 336 int ipsec_process_done (struct mbuf *, struct ipsecrequest *); 337 #define ipsec_indone(m) \ 338 (m_tag_find((m), PACKET_TAG_IPSEC_IN_DONE, NULL) != NULL) 339 340 #define ipsec_outdone(m) \ 341 (m_tag_find((m), PACKET_TAG_IPSEC_OUT_DONE, NULL) != NULL) 342 343 struct mbuf *ipsec_copypkt (struct mbuf *); 344 345 void m_checkalignment(const char* , struct mbuf *, int, int); 346 struct mbuf *m_clone(struct mbuf *); 347 struct mbuf *m_makespace(struct mbuf *, int, int, int *); 348 void *m_pad(struct mbuf *, int ); 349 int m_striphdr(struct mbuf *, int, int); 350 351 /* Per-socket caching of IPsec output policy */ 352 static __inline 353 int ipsec_clear_socket_cache(struct mbuf *m) 354 { 355 return 0; 356 } 357 358 void nat_t_ports_get(struct mbuf *, u_int16_t *, u_int16_t *); 359 360 extern int ipsec_used __read_mostly, ipsec_enabled __read_mostly; 361 362 #endif /* _KERNEL */ 363 364 #ifndef _KERNEL 365 char *ipsec_set_policy (const char *, int); 366 int ipsec_get_policylen (char *); 367 char *ipsec_dump_policy (char *, const char *); 368 369 const char *ipsec_strerror (void); 370 #endif /* !_KERNEL */ 371 372 #ifdef _KERNEL 373 /* External declarations of per-file init functions */ 374 void ah_attach(void); 375 void esp_attach(void); 376 void ipcomp_attach(void); 377 void ipe4_attach(void); 378 void ipe4_attach(void); 379 void tcpsignature_attach(void); 380 381 void ipsec_attach(void); 382 383 void sysctl_net_inet_ipsec_setup(struct sysctllog **); 384 #ifdef INET6 385 void sysctl_net_inet6_ipsec6_setup(struct sysctllog **); 386 #endif 387 388 #endif /* _KERNEL */ 389 #endif /* !_NETIPSEC_IPSEC_H_ */ 390
Indexes created Tue Sep 23 02:09:52 GMT 2025