The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/netipsec/ipsec.h

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    1 /*      $NetBSD: ipsec.h,v 1.10 2004/05/07 00:55:14 jonathan 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) && !defined(_LKM) && !defined(KLD_MODULE)
   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 
  223 extern struct newipsecstat newipsecstat;
  224 extern struct secpolicy ip4_def_policy;
  225 extern int ip4_esp_trans_deflev;
  226 extern int ip4_esp_net_deflev;
  227 extern int ip4_ah_trans_deflev;
  228 extern int ip4_ah_net_deflev;
  229 extern int ip4_ah_cleartos;
  230 extern int ip4_ah_offsetmask;
  231 extern int ip4_ipsec_dfbit;
  232 extern int ip4_ipsec_ecn;
  233 extern int ip4_esp_randpad;
  234 extern int crypto_support;
  235 
  236 #define ipseclog(x)     do { if (ipsec_debug) log x; } while (0)
  237 /* for openbsd compatibility */
  238 #define DPRINTF(x)      do { if (ipsec_debug) printf x; } while (0)
  239 
  240 #ifdef __NetBSD__
  241 extern void ipsec_pcbconn __P((struct inpcbpolicy *));
  242 extern void ipsec_pcbdisconn __P((struct inpcbpolicy *));
  243 extern void ipsec_invalpcbcacheall __P((void));
  244 
  245 extern u_int ipsec_spdgen;
  246 #endif /* __NetBSD__ */
  247 
  248 struct tdb_ident;
  249 extern struct secpolicy *ipsec_getpolicy __P((struct tdb_ident*, u_int));
  250 struct inpcb;
  251 extern struct secpolicy *ipsec4_checkpolicy __P((struct mbuf *, u_int, u_int,
  252         int *, struct inpcb *));
  253 extern struct secpolicy * ipsec_getpolicybyaddr(struct mbuf *, u_int,
  254         int, int *);
  255 
  256 
  257 static __inline struct secpolicy*
  258 ipsec4_getpolicybysock(struct mbuf *m, u_int dir, const struct socket *so, int *err)
  259 {
  260   panic("ipsec4_getpolicybysock");
  261 }
  262 
  263 static __inline int
  264 ipsec_copy_pcbpolicy(struct inpcbpolicy *old, struct inpcbpolicy *new)
  265 {
  266   /*XXX do nothing */
  267   return (0);
  268 }
  269 
  270 struct inpcb;
  271 #define ipsec_init_pcbpolicy ipsec_init_policy
  272 extern int ipsec_init_policy __P((struct socket *so, struct inpcbpolicy **));
  273 extern int ipsec_copy_policy
  274         __P((struct inpcbpolicy *, struct inpcbpolicy *));
  275 extern u_int ipsec_get_reqlevel __P((struct ipsecrequest *));
  276 extern int ipsec_in_reject __P((struct secpolicy *, struct mbuf *));
  277 
  278 extern int ipsec4_set_policy __P((struct inpcb *inp, int optname,
  279         caddr_t request, size_t len, int priv));
  280 extern int ipsec4_get_policy __P((struct inpcb *inpcb, caddr_t request,
  281         size_t len, struct mbuf **mp));
  282 extern int ipsec4_delete_pcbpolicy __P((struct inpcb *));
  283 extern int ipsec4_in_reject __P((struct mbuf *, struct inpcb *));
  284 /*
  285  * KAME ipsec4_in_reject_so(struct mbuf*, struct so)  compatibility shim
  286  */
  287 #define ipsec4_in_reject_so(m, _so) \
  288   ipsec4_in_reject(m, ((_so) == NULL? NULL : sotoinpcb(_so)))
  289 
  290 
  291 struct secas;
  292 struct tcpcb;
  293 extern int ipsec_chkreplay __P((u_int32_t, struct secasvar *));
  294 extern int ipsec_updatereplay __P((u_int32_t, struct secasvar *));
  295 
  296 extern size_t ipsec4_hdrsiz __P((struct mbuf *, u_int, struct inpcb *));
  297 #ifdef __FreeBSD__
  298 extern size_t ipsec_hdrsiz_tcp __P((struct tcpcb *));
  299 #else
  300 extern size_t ipsec4_hdrsiz_tcp __P((struct tcpcb *));
  301 #define ipsec4_getpolicybyaddr ipsec_getpolicybyaddr
  302 #endif
  303 
  304 union sockaddr_union;
  305 extern char * ipsec_address(union sockaddr_union* sa);
  306 extern const char *ipsec_logsastr __P((struct secasvar *));
  307 
  308 extern void ipsec_dumpmbuf __P((struct mbuf *));
  309 
  310 /* NetBSD protosw ctlin entrypoint */
  311 extern void *esp4_ctlinput __P((int, struct sockaddr *, void *));
  312 extern void *ah4_ctlinput __P((int, struct sockaddr *, void *));
  313 
  314 struct m_tag;
  315 extern void ipsec4_common_input(struct mbuf *m, ...);
  316 extern int ipsec4_common_input_cb(struct mbuf *m, struct secasvar *sav,
  317                         int skip, int protoff, struct m_tag *mt);
  318 extern int ipsec4_process_packet __P((struct mbuf *, struct ipsecrequest *,
  319                         int, int));
  320 extern int ipsec_process_done __P((struct mbuf *, struct ipsecrequest *));
  321 #define ipsec_indone(m) \
  322         (m_tag_find((m), PACKET_TAG_IPSEC_IN_DONE, NULL) != NULL)
  323 
  324 extern struct mbuf *ipsec_copypkt __P((struct mbuf *));
  325 
  326 extern  void m_checkalignment(const char* where, struct mbuf *m0,
  327                 int off, int len);
  328 extern  struct mbuf *m_clone(struct mbuf *m0);
  329 extern  struct mbuf *m_makespace(struct mbuf *m0, int skip, int hlen, int *off);
  330 extern  caddr_t m_pad(struct mbuf *m, int n);
  331 extern  int m_striphdr(struct mbuf *m, int skip, int hlen);
  332 
  333 /* Per-socket caching of IPsec output policy */
  334 static __inline int ipsec_clear_socket_cache(struct mbuf *m)
  335 {
  336   return 0;
  337 }
  338 
  339 
  340 #endif /* _KERNEL */
  341 
  342 #ifndef _KERNEL
  343 extern caddr_t ipsec_set_policy __P((char *, int));
  344 extern int ipsec_get_policylen __P((caddr_t));
  345 extern char *ipsec_dump_policy __P((caddr_t, char *));
  346 
  347 extern const char *ipsec_strerror __P((void));
  348 #endif /* !_KERNEL */
  349 
  350 #ifdef _KERNEL
  351 /* External declarations of per-file init functions */
  352 INITFN void ah_attach(void);
  353 INITFN void esp_attach(void);
  354 INITFN void ipcomp_attach(void);
  355 INITFN void ipe4_attach(void);
  356 INITFN void ipe4_attach(void);
  357 INITFN void tcpsignature_attach(void);
  358 
  359 INITFN void ipsec_attach(void);
  360 #endif /* _KERNEL */
  361 #endif /* _NETIPSEC_IPSEC_H_ */

Cache object: 95d8bd22169d934bf4757bbbff4c6853


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.