1 /* $NetBSD: ipsec.h,v 1.24 2009/05/10 02:13:07 elad 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 #include <netipsec/ipsec_osdep.h> 48 #include <netipsec/keydb.h> 49 50 #ifdef _KERNEL 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 long created; /* time created the policy */ 97 long lastused; /* updated every when kernel sends a packet */ 98 long lifetime; /* duration of the lifetime of this policy */ 99 long 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 #ifdef __NetBSD__ 122 /* cached policy */ 123 struct { 124 struct secpolicy *cachesp; 125 struct secpolicyindex cacheidx; 126 int cachehint; /* processing requirement hint: */ 127 #define IPSEC_PCBHINT_MAYBE 0 /* IPsec processing maybe required */ 128 #define IPSEC_PCBHINT_YES 1 /* IPsec processing is required */ 129 #define IPSEC_PCBHINT_NO 2 /* IPsec processing not required */ 130 u_int cachegen; /* spdgen when cache filled */ 131 } sp_cache[3]; /* XXX 3 == IPSEC_DIR_MAX */ 132 int sp_cacheflags; 133 #define IPSEC_PCBSP_CONNECTED 1 134 #endif /* __NetBSD__ */ 135 }; 136 137 #ifdef __NetBSD__ 138 #define IPSEC_PCB_SKIP_IPSEC(inpp, dir) \ 139 ((inpp)->sp_cache[(dir)].cachehint == IPSEC_PCBHINT_NO && \ 140 (inpp)->sp_cache[(dir)].cachegen == ipsec_spdgen) 141 #endif /* __NetBSD__ */ 142 143 /* SP acquiring list table. */ 144 struct secspacq { 145 LIST_ENTRY(secspacq) chain; 146 147 struct secpolicyindex spidx; 148 149 long created; /* for lifetime */ 150 int count; /* for lifetime */ 151 /* XXX: here is mbuf place holder to be sent ? */ 152 }; 153 #endif /* _KERNEL */ 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 /* Security protocol level */ 191 #define IPSEC_LEVEL_DEFAULT 0 /* reference to system default */ 192 #define IPSEC_LEVEL_USE 1 /* use SA if present. */ 193 #define IPSEC_LEVEL_REQUIRE 2 /* require SA. */ 194 #define IPSEC_LEVEL_UNIQUE 3 /* unique SA. */ 195 196 #define IPSEC_MANUAL_REQID_MAX 0x3fff 197 /* 198 * if security policy level == unique, this id 199 * indicate to a relative SA for use, else is 200 * zero. 201 * 1 - 0x3fff are reserved for manual keying. 202 * 0 are reserved for above reason. Others is 203 * for kernel use. 204 * Note that this id doesn't identify SA 205 * by only itself. 206 */ 207 #define IPSEC_REPLAYWSIZE 32 208 209 #ifdef _KERNEL 210 struct ipsec_output_state { 211 struct mbuf *m; 212 struct route *ro; 213 struct sockaddr *dst; 214 }; 215 216 struct ipsec_history { 217 int ih_proto; 218 u_int32_t ih_spi; 219 }; 220 221 extern int ipsec_debug; 222 #ifdef IPSEC_DEBUG 223 extern int ipsec_replay; 224 extern int ipsec_integrity; 225 #endif 226 227 extern struct secpolicy ip4_def_policy; 228 extern int ip4_esp_trans_deflev; 229 extern int ip4_esp_net_deflev; 230 extern int ip4_ah_trans_deflev; 231 extern int ip4_ah_net_deflev; 232 extern int ip4_ah_cleartos; 233 extern int ip4_ah_offsetmask; 234 extern int ip4_ipsec_dfbit; 235 extern int ip4_ipsec_ecn; 236 extern int ip4_esp_randpad; 237 extern int crypto_support; 238 239 #define ipseclog(x) do { if (ipsec_debug) log x; } while (0) 240 /* for openbsd compatibility */ 241 #define DPRINTF(x) do { if (ipsec_debug) printf x; } while (0) 242 243 #ifdef __NetBSD__ 244 void ipsec_pcbconn (struct inpcbpolicy *); 245 void ipsec_pcbdisconn (struct inpcbpolicy *); 246 void ipsec_invalpcbcacheall (void); 247 248 extern u_int ipsec_spdgen; 249 #endif /* __NetBSD__ */ 250 251 struct tdb_ident; 252 struct secpolicy *ipsec_getpolicy (struct tdb_ident*, u_int); 253 struct inpcb; 254 struct secpolicy *ipsec4_checkpolicy (struct mbuf *, u_int, u_int, 255 int *, struct inpcb *); 256 struct secpolicy * ipsec_getpolicybyaddr(struct mbuf *, u_int, 257 int, int *); 258 259 260 static __inline struct secpolicy* 261 ipsec4_getpolicybysock( 262 struct mbuf *m, 263 u_int dir, 264 const struct socket *so, 265 int *err 266 ) 267 { 268 panic("ipsec4_getpolicybysock"); 269 } 270 271 static __inline int 272 ipsec_copy_pcbpolicy( 273 struct inpcbpolicy *old, 274 struct inpcbpolicy *new 275 ) 276 { 277 /*XXX do nothing */ 278 return (0); 279 } 280 281 struct inpcb; 282 #define ipsec_init_pcbpolicy ipsec_init_policy 283 int ipsec_init_policy (struct socket *so, struct inpcbpolicy **); 284 int ipsec_copy_policy 285 (struct inpcbpolicy *, struct inpcbpolicy *); 286 u_int ipsec_get_reqlevel (struct ipsecrequest *); 287 int ipsec_in_reject (struct secpolicy *, struct mbuf *); 288 289 int ipsec4_set_policy (struct inpcb *, int, void *, size_t, kauth_cred_t); 290 int ipsec4_get_policy (struct inpcb *, void *, size_t, struct mbuf **); 291 int ipsec4_delete_pcbpolicy (struct inpcb *); 292 int ipsec4_in_reject (struct mbuf *, struct inpcb *); 293 /* 294 * KAME ipsec4_in_reject_so(struct mbuf*, struct so) compatibility shim 295 */ 296 #define ipsec4_in_reject_so(m, _so) \ 297 ipsec4_in_reject(m, ((_so) == NULL? NULL : sotoinpcb(_so))) 298 299 300 struct secas; 301 struct tcpcb; 302 int ipsec_chkreplay (u_int32_t, struct secasvar *); 303 int ipsec_updatereplay (u_int32_t, struct secasvar *); 304 305 size_t ipsec4_hdrsiz (struct mbuf *, u_int, struct inpcb *); 306 #ifdef __FreeBSD__ 307 size_t ipsec_hdrsiz_tcp (struct tcpcb *); 308 #else 309 size_t ipsec4_hdrsiz_tcp (struct tcpcb *); 310 #define ipsec4_getpolicybyaddr ipsec_getpolicybyaddr 311 #endif 312 313 union sockaddr_union; 314 const char *ipsec_address(union sockaddr_union* sa); 315 const char *ipsec_logsastr (struct secasvar *); 316 317 void ipsec_dumpmbuf (struct mbuf *); 318 319 /* NetBSD protosw ctlin entrypoint */ 320 void *esp4_ctlinput(int, const struct sockaddr *, void *); 321 void *ah4_ctlinput(int, const struct sockaddr *, void *); 322 323 struct m_tag; 324 void ipsec4_common_input(struct mbuf *m, ...); 325 int ipsec4_common_input_cb(struct mbuf *, struct secasvar *, 326 int, int, struct m_tag *); 327 int ipsec4_process_packet (struct mbuf *, struct ipsecrequest *, 328 int, int); 329 int ipsec_process_done (struct mbuf *, struct ipsecrequest *); 330 #define ipsec_indone(m) \ 331 (m_tag_find((m), PACKET_TAG_IPSEC_IN_DONE, NULL) != NULL) 332 333 #define ipsec_outdone(m) \ 334 (m_tag_find((m), PACKET_TAG_IPSEC_OUT_DONE, NULL) != NULL) 335 336 struct mbuf *ipsec_copypkt (struct mbuf *); 337 338 void m_checkalignment(const char* , struct mbuf *, int, int); 339 struct mbuf *m_clone(struct mbuf *); 340 struct mbuf *m_makespace(struct mbuf *, int, int, int *); 341 void *m_pad(struct mbuf *, int ); 342 int m_striphdr(struct mbuf *, int, int); 343 344 /* Per-socket caching of IPsec output policy */ 345 static __inline 346 int ipsec_clear_socket_cache(struct mbuf *m) 347 { 348 return 0; 349 } 350 351 352 #endif /* _KERNEL */ 353 354 #ifndef _KERNEL 355 void *ipsec_set_policy (char *, int); 356 int ipsec_get_policylen (void *); 357 char *ipsec_dump_policy (void *, char *); 358 359 const char *ipsec_strerror (void); 360 #endif /* !_KERNEL */ 361 362 #ifdef _KERNEL 363 /* External declarations of per-file init functions */ 364 INITFN void ah_attach(void); 365 INITFN void esp_attach(void); 366 INITFN void ipcomp_attach(void); 367 INITFN void ipe4_attach(void); 368 INITFN void ipe4_attach(void); 369 INITFN void tcpsignature_attach(void); 370 371 INITFN void ipsec_attach(void); 372 #endif /* _KERNEL */ 373 #endif /* !_NETIPSEC_IPSEC_H_ */ 374