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 /*      $FreeBSD: stable/4/sys/netipsec/ipsec.h 125828 2004-02-14 22:24:09Z bms $       */
    2 /*      $KAME: ipsec.h,v 1.53 2001/11/20 08:32:38 itojun Exp $  */
    3 
    4 /*
    5  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
    6  * All rights reserved.
    7  *
    8  * Redistribution and use in source and binary forms, with or without
    9  * modification, are permitted provided that the following conditions
   10  * are met:
   11  * 1. Redistributions of source code must retain the above copyright
   12  *    notice, this list of conditions and the following disclaimer.
   13  * 2. Redistributions in binary form must reproduce the above copyright
   14  *    notice, this list of conditions and the following disclaimer in the
   15  *    documentation and/or other materials provided with the distribution.
   16  * 3. Neither the name of the project nor the names of its contributors
   17  *    may be used to endorse or promote products derived from this software
   18  *    without specific prior written permission.
   19  *
   20  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
   21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
   24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   30  * SUCH DAMAGE.
   31  */
   32 
   33 /*
   34  * IPsec controller part.
   35  */
   36 
   37 #ifndef _NETIPSEC_IPSEC_H_
   38 #define _NETIPSEC_IPSEC_H_
   39 
   40 #if defined(_KERNEL) && !defined(_LKM) && !defined(KLD_MODULE)
   41 #include "opt_inet.h"
   42 #include "opt_ipsec.h"
   43 #endif
   44 
   45 #include <net/pfkeyv2.h>
   46 #include <netipsec/keydb.h>
   47 
   48 #ifdef _KERNEL
   49 
   50 /*
   51  * Security Policy Index
   52  * Ensure that both address families in the "src" and "dst" are same.
   53  * When the value of the ul_proto is ICMPv6, the port field in "src"
   54  * specifies ICMPv6 type, and the port field in "dst" specifies ICMPv6 code.
   55  */
   56 struct secpolicyindex {
   57         u_int8_t dir;                   /* direction of packet flow, see blow */
   58         union sockaddr_union src;       /* IP src address for SP */
   59         union sockaddr_union dst;       /* IP dst address for SP */
   60         u_int8_t prefs;                 /* prefix length in bits for src */
   61         u_int8_t prefd;                 /* prefix length in bits for dst */
   62         u_int16_t ul_proto;             /* upper layer Protocol */
   63 #ifdef notyet
   64         uid_t uids;
   65         uid_t uidd;
   66         gid_t gids;
   67         gid_t gidd;
   68 #endif
   69 };
   70 
   71 /* Security Policy Data Base */
   72 struct secpolicy {
   73         LIST_ENTRY(secpolicy) chain;
   74 
   75         u_int refcnt;                   /* reference count */
   76         struct secpolicyindex spidx;    /* selector */
   77         u_int32_t id;                   /* It's unique number on the system. */
   78         u_int state;                    /* 0: dead, others: alive */
   79 #define IPSEC_SPSTATE_DEAD      0
   80 #define IPSEC_SPSTATE_ALIVE     1
   81 
   82         u_int policy;           /* DISCARD, NONE or IPSEC, see keyv2.h */
   83         struct ipsecrequest *req;
   84                                 /* pointer to the ipsec request tree, */
   85                                 /* if policy == IPSEC else this value == NULL.*/
   86 
   87         /*
   88          * lifetime handler.
   89          * the policy can be used without limitiation if both lifetime and
   90          * validtime are zero.
   91          * "lifetime" is passed by sadb_lifetime.sadb_lifetime_addtime.
   92          * "validtime" is passed by sadb_lifetime.sadb_lifetime_usetime.
   93          */
   94         long created;           /* time created the policy */
   95         long lastused;          /* updated every when kernel sends a packet */
   96         long lifetime;          /* duration of the lifetime of this policy */
   97         long validtime;         /* duration this policy is valid without use */
   98 };
   99 
  100 /* Request for IPsec */
  101 struct ipsecrequest {
  102         struct ipsecrequest *next;
  103                                 /* pointer to next structure */
  104                                 /* If NULL, it means the end of chain. */
  105         struct secasindex saidx;/* hint for search proper SA */
  106                                 /* if __ss_len == 0 then no address specified.*/
  107         u_int level;            /* IPsec level defined below. */
  108 
  109         struct secasvar *sav;   /* place holder of SA for use */
  110         struct secpolicy *sp;   /* back pointer to SP */
  111 };
  112 
  113 /* security policy in PCB */
  114 struct inpcbpolicy {
  115         struct secpolicy *sp_in;
  116         struct secpolicy *sp_out;
  117         int priv;                       /* privileged socket ? */
  118 };
  119 
  120 /* SP acquiring list table. */
  121 struct secspacq {
  122         LIST_ENTRY(secspacq) chain;
  123 
  124         struct secpolicyindex spidx;
  125 
  126         long created;           /* for lifetime */
  127         int count;              /* for lifetime */
  128         /* XXX: here is mbuf place holder to be sent ? */
  129 };
  130 #endif /* _KERNEL */
  131 
  132 /* according to IANA assignment, port 0x0000 and proto 0xff are reserved. */
  133 #define IPSEC_PORT_ANY          0
  134 #define IPSEC_ULPROTO_ANY       255
  135 #define IPSEC_PROTO_ANY         255
  136 
  137 /* mode of security protocol */
  138 /* NOTE: DON'T use IPSEC_MODE_ANY at SPD.  It's only use in SAD */
  139 #define IPSEC_MODE_ANY          0       /* i.e. wildcard. */
  140 #define IPSEC_MODE_TRANSPORT    1
  141 #define IPSEC_MODE_TUNNEL       2
  142 #define IPSEC_MODE_TCPMD5       3       /* TCP MD5 mode */
  143 
  144 /*
  145  * Direction of security policy.
  146  * NOTE: Since INVALID is used just as flag.
  147  * The other are used for loop counter too.
  148  */
  149 #define IPSEC_DIR_ANY           0
  150 #define IPSEC_DIR_INBOUND       1
  151 #define IPSEC_DIR_OUTBOUND      2
  152 #define IPSEC_DIR_MAX           3
  153 #define IPSEC_DIR_INVALID       4
  154 
  155 /* Policy level */
  156 /*
  157  * IPSEC, ENTRUST and BYPASS are allowed for setsockopt() in PCB,
  158  * DISCARD, IPSEC and NONE are allowed for setkey() in SPD.
  159  * DISCARD and NONE are allowed for system default.
  160  */
  161 #define IPSEC_POLICY_DISCARD    0       /* discarding packet */
  162 #define IPSEC_POLICY_NONE       1       /* through IPsec engine */
  163 #define IPSEC_POLICY_IPSEC      2       /* do IPsec */
  164 #define IPSEC_POLICY_ENTRUST    3       /* consulting SPD if present. */
  165 #define IPSEC_POLICY_BYPASS     4       /* only for privileged socket. */
  166 
  167 /* Security protocol level */
  168 #define IPSEC_LEVEL_DEFAULT     0       /* reference to system default */
  169 #define IPSEC_LEVEL_USE         1       /* use SA if present. */
  170 #define IPSEC_LEVEL_REQUIRE     2       /* require SA. */
  171 #define IPSEC_LEVEL_UNIQUE      3       /* unique SA. */
  172 
  173 #define IPSEC_MANUAL_REQID_MAX  0x3fff
  174                                 /*
  175                                  * if security policy level == unique, this id
  176                                  * indicate to a relative SA for use, else is
  177                                  * zero.
  178                                  * 1 - 0x3fff are reserved for manual keying.
  179                                  * 0 are reserved for above reason.  Others is
  180                                  * for kernel use.
  181                                  * Note that this id doesn't identify SA
  182                                  * by only itself.
  183                                  */
  184 #define IPSEC_REPLAYWSIZE  32
  185 
  186 /* old statistics for ipsec processing */
  187 struct ipsecstat {
  188         u_quad_t in_success;  /* succeeded inbound process */
  189         u_quad_t in_polvio;
  190                         /* security policy violation for inbound process */
  191         u_quad_t in_nosa;     /* inbound SA is unavailable */
  192         u_quad_t in_inval;    /* inbound processing failed due to EINVAL */
  193         u_quad_t in_nomem;    /* inbound processing failed due to ENOBUFS */
  194         u_quad_t in_badspi;   /* failed getting a SPI */
  195         u_quad_t in_ahreplay; /* AH replay check failed */
  196         u_quad_t in_espreplay; /* ESP replay check failed */
  197         u_quad_t in_ahauthsucc; /* AH authentication success */
  198         u_quad_t in_ahauthfail; /* AH authentication failure */
  199         u_quad_t in_espauthsucc; /* ESP authentication success */
  200         u_quad_t in_espauthfail; /* ESP authentication failure */
  201         u_quad_t in_esphist[256];
  202         u_quad_t in_ahhist[256];
  203         u_quad_t in_comphist[256];
  204         u_quad_t out_success; /* succeeded outbound process */
  205         u_quad_t out_polvio;
  206                         /* security policy violation for outbound process */
  207         u_quad_t out_nosa;    /* outbound SA is unavailable */
  208         u_quad_t out_inval;   /* outbound process failed due to EINVAL */
  209         u_quad_t out_nomem;    /* inbound processing failed due to ENOBUFS */
  210         u_quad_t out_noroute; /* there is no route */
  211         u_quad_t out_esphist[256];
  212         u_quad_t out_ahhist[256];
  213         u_quad_t out_comphist[256];
  214 };
  215 
  216 /* statistics for ipsec processing */
  217 struct newipsecstat {
  218         u_int32_t ips_in_polvio;        /* input: sec policy violation */
  219         u_int32_t ips_out_polvio;       /* output: sec policy violation */
  220         u_int32_t ips_out_nosa;         /* output: SA unavailable  */
  221         u_int32_t ips_out_nomem;        /* output: no memory available */
  222         u_int32_t ips_out_noroute;      /* output: no route available */
  223         u_int32_t ips_out_inval;        /* output: generic error */
  224         u_int32_t ips_out_bundlesa;     /* output: bundled SA processed */
  225         u_int32_t ips_mbcoalesced;      /* mbufs coalesced during clone */
  226         u_int32_t ips_clcoalesced;      /* clusters coalesced during clone */
  227         u_int32_t ips_clcopied;         /* clusters copied during clone */
  228         u_int32_t ips_mbinserted;       /* mbufs inserted during makespace */
  229         /* 
  230          * Temporary statistics for performance analysis.
  231          */
  232         /* See where ESP/AH/IPCOMP header land in mbuf on input */
  233         u_int32_t ips_input_front;
  234         u_int32_t ips_input_middle;
  235         u_int32_t ips_input_end;
  236 };
  237 
  238 /*
  239  * Definitions for IPsec & Key sysctl operations.
  240  */
  241 /*
  242  * Names for IPsec & Key sysctl objects
  243  */
  244 #define IPSECCTL_STATS                  1       /* stats */
  245 #define IPSECCTL_DEF_POLICY             2
  246 #define IPSECCTL_DEF_ESP_TRANSLEV       3       /* int; ESP transport mode */
  247 #define IPSECCTL_DEF_ESP_NETLEV         4       /* int; ESP tunnel mode */
  248 #define IPSECCTL_DEF_AH_TRANSLEV        5       /* int; AH transport mode */
  249 #define IPSECCTL_DEF_AH_NETLEV          6       /* int; AH tunnel mode */
  250 #if 0   /* obsolete, do not reuse */
  251 #define IPSECCTL_INBOUND_CALL_IKE       7
  252 #endif
  253 #define IPSECCTL_AH_CLEARTOS            8
  254 #define IPSECCTL_AH_OFFSETMASK          9
  255 #define IPSECCTL_DFBIT                  10
  256 #define IPSECCTL_ECN                    11
  257 #define IPSECCTL_DEBUG                  12
  258 #define IPSECCTL_ESP_RANDPAD            13
  259 #define IPSECCTL_MAXID                  14
  260 
  261 #define IPSECCTL_NAMES { \
  262         { 0, 0 }, \
  263         { 0, 0 }, \
  264         { "def_policy", CTLTYPE_INT }, \
  265         { "esp_trans_deflev", CTLTYPE_INT }, \
  266         { "esp_net_deflev", CTLTYPE_INT }, \
  267         { "ah_trans_deflev", CTLTYPE_INT }, \
  268         { "ah_net_deflev", CTLTYPE_INT }, \
  269         { 0, 0 }, \
  270         { "ah_cleartos", CTLTYPE_INT }, \
  271         { "ah_offsetmask", CTLTYPE_INT }, \
  272         { "dfbit", CTLTYPE_INT }, \
  273         { "ecn", CTLTYPE_INT }, \
  274         { "debug", CTLTYPE_INT }, \
  275         { "esp_randpad", CTLTYPE_INT }, \
  276 }
  277 
  278 #define IPSEC6CTL_NAMES { \
  279         { 0, 0 }, \
  280         { 0, 0 }, \
  281         { "def_policy", CTLTYPE_INT }, \
  282         { "esp_trans_deflev", CTLTYPE_INT }, \
  283         { "esp_net_deflev", CTLTYPE_INT }, \
  284         { "ah_trans_deflev", CTLTYPE_INT }, \
  285         { "ah_net_deflev", CTLTYPE_INT }, \
  286         { 0, 0 }, \
  287         { 0, 0 }, \
  288         { 0, 0 }, \
  289         { 0, 0 }, \
  290         { "ecn", CTLTYPE_INT }, \
  291         { "debug", CTLTYPE_INT }, \
  292         { "esp_randpad", CTLTYPE_INT }, \
  293 }
  294 
  295 #ifdef _KERNEL
  296 struct ipsec_output_state {
  297         struct mbuf *m;
  298         struct route *ro;
  299         struct sockaddr *dst;
  300 };
  301 
  302 struct ipsec_history {
  303         int ih_proto;
  304         u_int32_t ih_spi;
  305 };
  306 
  307 extern int ipsec_debug;
  308 
  309 extern struct newipsecstat newipsecstat;
  310 extern struct secpolicy ip4_def_policy;
  311 extern int ip4_esp_trans_deflev;
  312 extern int ip4_esp_net_deflev;
  313 extern int ip4_ah_trans_deflev;
  314 extern int ip4_ah_net_deflev;
  315 extern int ip4_ah_cleartos;
  316 extern int ip4_ah_offsetmask;
  317 extern int ip4_ipsec_dfbit;
  318 extern int ip4_ipsec_ecn;
  319 extern int ip4_esp_randpad;
  320 extern int crypto_support;
  321 
  322 #define ipseclog(x)     do { if (ipsec_debug) log x; } while (0)
  323 /* for openbsd compatibility */
  324 #define DPRINTF(x)      do { if (ipsec_debug) printf x; } while (0)
  325 
  326 struct tdb_ident;
  327 extern struct secpolicy *ipsec_getpolicy __P((struct tdb_ident*, u_int));
  328 struct inpcb;
  329 extern struct secpolicy *ipsec4_checkpolicy __P((struct mbuf *, u_int, u_int,
  330         int *, struct inpcb *));
  331 extern struct secpolicy *ipsec_getpolicybysock(struct mbuf *, u_int,
  332         struct inpcb *, int *);
  333 extern struct secpolicy * ipsec_getpolicybyaddr(struct mbuf *, u_int,
  334         int, int *);
  335 
  336 struct inpcb;
  337 extern int ipsec_init_policy __P((struct socket *so, struct inpcbpolicy **));
  338 extern int ipsec_copy_policy
  339         __P((struct inpcbpolicy *, struct inpcbpolicy *));
  340 extern u_int ipsec_get_reqlevel __P((struct ipsecrequest *));
  341 extern int ipsec_in_reject __P((struct secpolicy *, struct mbuf *));
  342 
  343 extern int ipsec4_set_policy __P((struct inpcb *inp, int optname,
  344         caddr_t request, size_t len, int priv));
  345 extern int ipsec4_get_policy __P((struct inpcb *inpcb, caddr_t request,
  346         size_t len, struct mbuf **mp));
  347 extern int ipsec4_delete_pcbpolicy __P((struct inpcb *));
  348 extern int ipsec4_in_reject __P((struct mbuf *, struct inpcb *));
  349 
  350 struct secas;
  351 struct tcpcb;
  352 extern int ipsec_chkreplay __P((u_int32_t, struct secasvar *));
  353 extern int ipsec_updatereplay __P((u_int32_t, struct secasvar *));
  354 
  355 extern size_t ipsec4_hdrsiz __P((struct mbuf *, u_int, struct inpcb *));
  356 extern size_t ipsec_hdrsiz_tcp __P((struct tcpcb *));
  357 
  358 union sockaddr_union;
  359 extern char * ipsec_address(union sockaddr_union* sa);
  360 extern const char *ipsec_logsastr __P((struct secasvar *));
  361 
  362 extern void ipsec_dumpmbuf __P((struct mbuf *));
  363 
  364 struct m_tag;
  365 extern int ipsec4_common_input(struct mbuf *m, ...);
  366 extern int ipsec4_common_input_cb(struct mbuf *m, struct secasvar *sav,
  367                         int skip, int protoff, struct m_tag *mt);
  368 extern int ipsec4_process_packet __P((struct mbuf *, struct ipsecrequest *,
  369                         int, int));
  370 extern int ipsec_process_done __P((struct mbuf *, struct ipsecrequest *));
  371 
  372 extern struct mbuf *ipsec_copypkt __P((struct mbuf *));
  373 
  374 extern  void m_checkalignment(const char* where, struct mbuf *m0,
  375                 int off, int len);
  376 extern  struct mbuf *m_clone(struct mbuf *m0);
  377 extern  struct mbuf *m_makespace(struct mbuf *m0, int skip, int hlen, int *off);
  378 extern  caddr_t m_pad(struct mbuf *m, int n);
  379 extern  int m_striphdr(struct mbuf *m, int skip, int hlen);
  380 #endif /* _KERNEL */
  381 
  382 #ifndef _KERNEL
  383 extern caddr_t ipsec_set_policy __P((char *, int));
  384 extern int ipsec_get_policylen __P((caddr_t));
  385 extern char *ipsec_dump_policy __P((caddr_t, char *));
  386 
  387 extern const char *ipsec_strerror __P((void));
  388 #endif /* !_KERNEL */
  389 
  390 #endif /* _NETIPSEC_IPSEC_H_ */

Cache object: d2f2193eee1320ff689499fb6325f49b


[ 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.