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: releng/11.2/sys/netipsec/ipsec.h 331722 2018-03-29 02:50:57Z eadler $ */
    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 #include <sys/_lock.h>
   51 #include <sys/_mutex.h>
   52 #include <sys/_rwlock.h>
   53 
   54 #define IPSEC_ASSERT(_c,_m) KASSERT(_c, _m)
   55 
   56 /*
   57  * Security Policy Index
   58  * Ensure that both address families in the "src" and "dst" are same.
   59  * When the value of the ul_proto is ICMPv6, the port field in "src"
   60  * specifies ICMPv6 type, and the port field in "dst" specifies ICMPv6 code.
   61  */
   62 struct secpolicyindex {
   63         union sockaddr_union src;       /* IP src address for SP */
   64         union sockaddr_union dst;       /* IP dst address for SP */
   65         uint8_t ul_proto;               /* upper layer Protocol */
   66         uint8_t dir;                    /* direction of packet flow */
   67         uint8_t prefs;                  /* prefix length in bits for src */
   68         uint8_t prefd;                  /* prefix length in bits for dst */
   69 };
   70 
   71 /* Request for IPsec */
   72 struct ipsecrequest {
   73         struct secasindex saidx;/* hint for search proper SA */
   74                                 /* if __ss_len == 0 then no address specified.*/
   75         u_int level;            /* IPsec level defined below. */
   76 };
   77 
   78 /* Security Policy Data Base */
   79 struct secpolicy {
   80         TAILQ_ENTRY(secpolicy) chain;
   81         LIST_ENTRY(secpolicy) idhash;
   82         LIST_ENTRY(secpolicy) drainq;
   83 
   84         struct secpolicyindex spidx;    /* selector */
   85 #define IPSEC_MAXREQ            4
   86         struct ipsecrequest *req[IPSEC_MAXREQ];
   87         u_int tcount;                   /* IPsec transforms count */
   88         volatile u_int refcnt;          /* reference count */
   89         u_int policy;                   /* policy_type per pfkeyv2.h */
   90         u_int state;
   91 #define IPSEC_SPSTATE_DEAD      0
   92 #define IPSEC_SPSTATE_LARVAL    1
   93 #define IPSEC_SPSTATE_ALIVE     2
   94 #define IPSEC_SPSTATE_PCB       3
   95 #define IPSEC_SPSTATE_IFNET     4
   96         uint32_t priority;              /* priority of this policy */
   97         uint32_t id;                    /* It's unique number on the system. */
   98         /*
   99          * lifetime handler.
  100          * the policy can be used without limitiation if both lifetime and
  101          * validtime are zero.
  102          * "lifetime" is passed by sadb_lifetime.sadb_lifetime_addtime.
  103          * "validtime" is passed by sadb_lifetime.sadb_lifetime_usetime.
  104          */
  105         time_t created;         /* time created the policy */
  106         time_t lastused;        /* updated every when kernel sends a packet */
  107         long lifetime;          /* duration of the lifetime of this policy */
  108         long validtime;         /* duration this policy is valid without use */
  109 };
  110 
  111 /*
  112  * PCB security policies.
  113  * Application can setup private security policies for socket.
  114  * Such policies can have IPSEC, BYPASS and ENTRUST type.
  115  * By default, policies are set to NULL. This means that they have ENTRUST type.
  116  * When application sets BYPASS or IPSEC type policy, the flags field
  117  * is also updated. When flags is not set, the system could store
  118  * used security policy into the sp_in/sp_out pointer to speed up further
  119  * lookups.
  120  */
  121 struct inpcbpolicy {
  122         struct secpolicy        *sp_in;
  123         struct secpolicy        *sp_out;
  124 
  125         uint32_t                genid;
  126         uint16_t                flags;
  127 #define INP_INBOUND_POLICY      0x0001
  128 #define INP_OUTBOUND_POLICY     0x0002
  129         uint16_t                hdrsz;
  130 };
  131 
  132 /* SP acquiring list table. */
  133 struct secspacq {
  134         LIST_ENTRY(secspacq) chain;
  135 
  136         struct secpolicyindex spidx;
  137 
  138         time_t created;         /* for lifetime */
  139         int count;              /* for lifetime */
  140         /* XXX: here is mbuf place holder to be sent ? */
  141 };
  142 #endif /* _KERNEL */
  143 
  144 /* buffer size for formatted output of ipsec address */
  145 #define IPSEC_ADDRSTRLEN        (INET6_ADDRSTRLEN + 11)
  146 
  147 /* according to IANA assignment, port 0x0000 and proto 0xff are reserved. */
  148 #define IPSEC_PORT_ANY          0
  149 #define IPSEC_ULPROTO_ANY       255
  150 #define IPSEC_PROTO_ANY         255
  151 
  152 /* mode of security protocol */
  153 /* NOTE: DON'T use IPSEC_MODE_ANY at SPD.  It's only use in SAD */
  154 #define IPSEC_MODE_ANY          0       /* i.e. wildcard. */
  155 #define IPSEC_MODE_TRANSPORT    1
  156 #define IPSEC_MODE_TUNNEL       2
  157 #define IPSEC_MODE_TCPMD5       3       /* TCP MD5 mode */
  158 
  159 /*
  160  * Direction of security policy.
  161  * NOTE: Since INVALID is used just as flag.
  162  * The other are used for loop counter too.
  163  */
  164 #define IPSEC_DIR_ANY           0
  165 #define IPSEC_DIR_INBOUND       1
  166 #define IPSEC_DIR_OUTBOUND      2
  167 #define IPSEC_DIR_MAX           3
  168 #define IPSEC_DIR_INVALID       4
  169 
  170 /* Policy level */
  171 /*
  172  * IPSEC, ENTRUST and BYPASS are allowed for setsockopt() in PCB,
  173  * DISCARD, IPSEC and NONE are allowed for setkey() in SPD.
  174  * DISCARD and NONE are allowed for system default.
  175  */
  176 #define IPSEC_POLICY_DISCARD    0       /* discarding packet */
  177 #define IPSEC_POLICY_NONE       1       /* through IPsec engine */
  178 #define IPSEC_POLICY_IPSEC      2       /* do IPsec */
  179 #define IPSEC_POLICY_ENTRUST    3       /* consulting SPD if present. */
  180 #define IPSEC_POLICY_BYPASS     4       /* only for privileged socket. */
  181 
  182 /* Policy scope */
  183 #define IPSEC_POLICYSCOPE_ANY           0x00    /* unspecified */
  184 #define IPSEC_POLICYSCOPE_GLOBAL        0x01    /* global scope */
  185 #define IPSEC_POLICYSCOPE_IFNET         0x02    /* if_ipsec(4) scope */
  186 #define IPSEC_POLICYSCOPE_PCB           0x04    /* PCB scope */
  187 
  188 /* Security protocol level */
  189 #define IPSEC_LEVEL_DEFAULT     0       /* reference to system default */
  190 #define IPSEC_LEVEL_USE         1       /* use SA if present. */
  191 #define IPSEC_LEVEL_REQUIRE     2       /* require SA. */
  192 #define IPSEC_LEVEL_UNIQUE      3       /* unique SA. */
  193 
  194 #define IPSEC_MANUAL_REQID_MAX  0x3fff
  195                                 /*
  196                                  * if security policy level == unique, this id
  197                                  * indicate to a relative SA for use, else is
  198                                  * zero.
  199                                  * 1 - 0x3fff are reserved for manual keying.
  200                                  * 0 are reserved for above reason.  Others is
  201                                  * for kernel use.
  202                                  * Note that this id doesn't identify SA
  203                                  * by only itself.
  204                                  */
  205 #define IPSEC_REPLAYWSIZE  32
  206 
  207 /* statistics for ipsec processing */
  208 struct ipsecstat {
  209         uint64_t ips_in_polvio;         /* input: sec policy violation */
  210         uint64_t ips_in_nomem;          /* input: no memory available */
  211         uint64_t ips_in_inval;          /* input: generic error */
  212 
  213         uint64_t ips_out_polvio;        /* output: sec policy violation */
  214         uint64_t ips_out_nosa;          /* output: SA unavailable  */
  215         uint64_t ips_out_nomem;         /* output: no memory available */
  216         uint64_t ips_out_noroute;       /* output: no route available */
  217         uint64_t ips_out_inval;         /* output: generic error */
  218         uint64_t ips_out_bundlesa;      /* output: bundled SA processed */
  219 
  220         uint64_t ips_mbcoalesced;       /* mbufs coalesced during clone */
  221         uint64_t ips_clcoalesced;       /* clusters coalesced during clone */
  222         uint64_t ips_clcopied;          /* clusters copied during clone */
  223         uint64_t ips_mbinserted;        /* mbufs inserted during makespace */
  224         /* 
  225          * Temporary statistics for performance analysis.
  226          */
  227         /* See where ESP/AH/IPCOMP header land in mbuf on input */
  228         uint64_t ips_input_front;
  229         uint64_t ips_input_middle;
  230         uint64_t ips_input_end;
  231 };
  232 
  233 /*
  234  * Definitions for IPsec & Key sysctl operations.
  235  */
  236 #define IPSECCTL_STATS                  1       /* stats */
  237 #define IPSECCTL_DEF_POLICY             2
  238 #define IPSECCTL_DEF_ESP_TRANSLEV       3       /* int; ESP transport mode */
  239 #define IPSECCTL_DEF_ESP_NETLEV         4       /* int; ESP tunnel mode */
  240 #define IPSECCTL_DEF_AH_TRANSLEV        5       /* int; AH transport mode */
  241 #define IPSECCTL_DEF_AH_NETLEV          6       /* int; AH tunnel mode */
  242 #if 0   /* obsolete, do not reuse */
  243 #define IPSECCTL_INBOUND_CALL_IKE       7
  244 #endif
  245 #define IPSECCTL_AH_CLEARTOS            8
  246 #define IPSECCTL_AH_OFFSETMASK          9
  247 #define IPSECCTL_DFBIT                  10
  248 #define IPSECCTL_ECN                    11
  249 #define IPSECCTL_DEBUG                  12
  250 #define IPSECCTL_ESP_RANDPAD            13
  251 
  252 #ifdef _KERNEL
  253 #include <sys/counter.h>
  254 
  255 struct ipsec_ctx_data;
  256 #define IPSEC_INIT_CTX(_ctx, _mp, _inp, _sav, _af, _enc) do {   \
  257         (_ctx)->mp = (_mp);                             \
  258         (_ctx)->inp = (_inp);                           \
  259         (_ctx)->sav = (_sav);                           \
  260         (_ctx)->af = (_af);                             \
  261         (_ctx)->enc = (_enc);                           \
  262 } while(0)
  263 int     ipsec_run_hhooks(struct ipsec_ctx_data *ctx, int direction);
  264 
  265 VNET_DECLARE(int, ipsec_debug);
  266 #define V_ipsec_debug           VNET(ipsec_debug)
  267 
  268 #ifdef REGRESSION
  269 VNET_DECLARE(int, ipsec_replay);
  270 VNET_DECLARE(int, ipsec_integrity);
  271 
  272 #define V_ipsec_replay          VNET(ipsec_replay)
  273 #define V_ipsec_integrity       VNET(ipsec_integrity)
  274 #endif
  275 
  276 VNET_PCPUSTAT_DECLARE(struct ipsecstat, ipsec4stat);
  277 VNET_DECLARE(int, ip4_esp_trans_deflev);
  278 VNET_DECLARE(int, ip4_esp_net_deflev);
  279 VNET_DECLARE(int, ip4_ah_trans_deflev);
  280 VNET_DECLARE(int, ip4_ah_net_deflev);
  281 VNET_DECLARE(int, ip4_ipsec_dfbit);
  282 VNET_DECLARE(int, ip4_ipsec_ecn);
  283 VNET_DECLARE(int, crypto_support);
  284 VNET_DECLARE(int, natt_cksum_policy);
  285 
  286 #define IPSECSTAT_INC(name)     \
  287     VNET_PCPUSTAT_ADD(struct ipsecstat, ipsec4stat, name, 1)
  288 #define V_ip4_esp_trans_deflev  VNET(ip4_esp_trans_deflev)
  289 #define V_ip4_esp_net_deflev    VNET(ip4_esp_net_deflev)
  290 #define V_ip4_ah_trans_deflev   VNET(ip4_ah_trans_deflev)
  291 #define V_ip4_ah_net_deflev     VNET(ip4_ah_net_deflev)
  292 #define V_ip4_ipsec_dfbit       VNET(ip4_ipsec_dfbit)
  293 #define V_ip4_ipsec_ecn         VNET(ip4_ipsec_ecn)
  294 #define V_crypto_support        VNET(crypto_support)
  295 #define V_natt_cksum_policy     VNET(natt_cksum_policy)
  296 
  297 #define ipseclog(x)     do { if (V_ipsec_debug) log x; } while (0)
  298 /* for openbsd compatibility */
  299 #ifdef IPSEC_DEBUG
  300 #define IPSEC_DEBUG_DECLARE(x)  x
  301 #define DPRINTF(x)      do { if (V_ipsec_debug) printf x; } while (0)
  302 #else
  303 #define IPSEC_DEBUG_DECLARE(x)
  304 #define DPRINTF(x)
  305 #endif
  306 
  307 struct inpcb;
  308 struct m_tag;
  309 struct secasvar;
  310 struct sockopt;
  311 struct tcphdr;
  312 union sockaddr_union;
  313 
  314 int ipsec_if_input(struct mbuf *, struct secasvar *, uint32_t);
  315 
  316 struct ipsecrequest *ipsec_newisr(void);
  317 void ipsec_delisr(struct ipsecrequest *);
  318 struct secpolicy *ipsec4_checkpolicy(const struct mbuf *, struct inpcb *,
  319     int *, int);
  320 
  321 u_int ipsec_get_reqlevel(struct secpolicy *, u_int);
  322 
  323 void udp_ipsec_adjust_cksum(struct mbuf *, struct secasvar *, int, int);
  324 int udp_ipsec_output(struct mbuf *, struct secasvar *);
  325 int udp_ipsec_input(struct mbuf *, int, int);
  326 int udp_ipsec_pcbctl(struct inpcb *, struct sockopt *);
  327 
  328 int ipsec_chkreplay(uint32_t, struct secasvar *);
  329 int ipsec_updatereplay(uint32_t, struct secasvar *);
  330 int ipsec_updateid(struct secasvar *, uint64_t *, uint64_t *);
  331 int ipsec_initialized(void);
  332 
  333 void ipsec_setspidx_inpcb(struct inpcb *, struct secpolicyindex *, u_int);
  334 
  335 void ipsec4_setsockaddrs(const struct mbuf *, union sockaddr_union *,
  336     union sockaddr_union *);
  337 int ipsec4_in_reject(const struct mbuf *, struct inpcb *);
  338 int ipsec4_input(struct mbuf *, int, int);
  339 int ipsec4_forward(struct mbuf *);
  340 int ipsec4_pcbctl(struct inpcb *, struct sockopt *);
  341 int ipsec4_output(struct mbuf *, struct inpcb *);
  342 int ipsec4_capability(struct mbuf *, u_int);
  343 int ipsec4_common_input_cb(struct mbuf *, struct secasvar *, int, int);
  344 int ipsec4_process_packet(struct mbuf *, struct secpolicy *, struct inpcb *);
  345 int ipsec_process_done(struct mbuf *, struct secpolicy *, struct secasvar *,
  346     u_int);
  347 
  348 extern  void m_checkalignment(const char* where, struct mbuf *m0,
  349                 int off, int len);
  350 extern  struct mbuf *m_makespace(struct mbuf *m0, int skip, int hlen, int *off);
  351 extern  caddr_t m_pad(struct mbuf *m, int n);
  352 extern  int m_striphdr(struct mbuf *m, int skip, int hlen);
  353 
  354 #endif /* _KERNEL */
  355 
  356 #ifndef _KERNEL
  357 extern caddr_t ipsec_set_policy(char *, int);
  358 extern int ipsec_get_policylen(caddr_t);
  359 extern char *ipsec_dump_policy(caddr_t, char *);
  360 extern const char *ipsec_strerror(void);
  361 
  362 #endif /* ! KERNEL */
  363 
  364 #endif /* _NETIPSEC_IPSEC_H_ */

Cache object: 4b6881279d52b5d6c8c84b32bf9e88f2


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