sys/netipsec/ipsec.h

   1 /*      $FreeBSD$       */
   2 /*      $KAME: ipsec.h,v 1.53 2001/11/20 08:32:38 itojun Exp $  */
   3
   4 /*-
   5  * SPDX-License-Identifier: BSD-3-Clause
   6  *
   7  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. Neither the name of the project nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  */
  34
  35 /*
  36  * IPsec controller part.
  37  */
  38
  39 #ifndef _NETIPSEC_IPSEC_H_
  40 #define _NETIPSEC_IPSEC_H_
  41
  42 #include <net/pfkeyv2.h>
  43 #include <netipsec/keydb.h>
  44
  45 #ifdef _KERNEL
  46
  47 #include <sys/_lock.h>
  48 #include <sys/_mutex.h>
  49 #include <sys/_rwlock.h>
  50
  51 #define IPSEC_ASSERT(_c,_m) KASSERT(_c, _m)
  52
  53 /*
  54  * Security Policy Index
  55  * Ensure that both address families in the "src" and "dst" are same.
  56  * When the value of the ul_proto is ICMPv6, the port field in "src"
  57  * specifies ICMPv6 type, and the port field in "dst" specifies ICMPv6 code.
  58  */
  59 struct secpolicyindex {
  60         union sockaddr_union src;       /* IP src address for SP */
  61         union sockaddr_union dst;       /* IP dst address for SP */
  62         uint8_t ul_proto;               /* upper layer Protocol */
  63         uint8_t dir;                    /* direction of packet flow */
  64         uint8_t prefs;                  /* prefix length in bits for src */
  65         uint8_t prefd;                  /* prefix length in bits for dst */
  66 };
  67
  68 /* Request for IPsec */
  69 struct ipsecrequest {
  70         struct secasindex saidx;/* hint for search proper SA */
  71                                 /* if __ss_len == 0 then no address specified.*/
  72         u_int level;            /* IPsec level defined below. */
  73 };
  74
  75 /* Security Policy Data Base */
  76 struct secpolicy {
  77         TAILQ_ENTRY(secpolicy) chain;
  78         LIST_ENTRY(secpolicy) idhash;
  79         LIST_ENTRY(secpolicy) drainq;
  80
  81         struct secpolicyindex spidx;    /* selector */
  82 #define IPSEC_MAXREQ            4
  83         struct ipsecrequest *req[IPSEC_MAXREQ];
  84         u_int tcount;                   /* IPsec transforms count */
  85         volatile u_int refcnt;          /* reference count */
  86         u_int policy;                   /* policy_type per pfkeyv2.h */
  87         u_int state;
  88 #define IPSEC_SPSTATE_DEAD      0
  89 #define IPSEC_SPSTATE_LARVAL    1
  90 #define IPSEC_SPSTATE_ALIVE     2
  91 #define IPSEC_SPSTATE_PCB       3
  92 #define IPSEC_SPSTATE_IFNET     4
  93         uint32_t priority;              /* priority of this policy */
  94         uint32_t id;                    /* It's unique number on the system. */
  95         /*
  96          * lifetime handler.
  97          * the policy can be used without limitiation if both lifetime and
  98          * validtime are zero.
  99          * "lifetime" is passed by sadb_lifetime.sadb_lifetime_addtime.
 100          * "validtime" is passed by sadb_lifetime.sadb_lifetime_usetime.
 101          */
 102         time_t created;         /* time created the policy */
 103         time_t lastused;        /* updated every when kernel sends a packet */
 104         long lifetime;          /* duration of the lifetime of this policy */
 105         long validtime;         /* duration this policy is valid without use */
 106 };
 107
 108 /*
 109  * PCB security policies.
 110  * Application can setup private security policies for socket.
 111  * Such policies can have IPSEC, BYPASS and ENTRUST type.
 112  * By default, policies are set to NULL. This means that they have ENTRUST type.
 113  * When application sets BYPASS or IPSEC type policy, the flags field
 114  * is also updated. When flags is not set, the system could store
 115  * used security policy into the sp_in/sp_out pointer to speed up further
 116  * lookups.
 117  */
 118 struct inpcbpolicy {
 119         struct secpolicy        *sp_in;
 120         struct secpolicy        *sp_out;
 121
 122         uint32_t                genid;
 123         uint16_t                flags;
 124 #define INP_INBOUND_POLICY      0x0001
 125 #define INP_OUTBOUND_POLICY     0x0002
 126         uint16_t                hdrsz;
 127 };
 128
 129 /* SP acquiring list table. */
 130 struct secspacq {
 131         LIST_ENTRY(secspacq) chain;
 132
 133         struct secpolicyindex spidx;
 134
 135         time_t created;         /* for lifetime */
 136         int count;              /* for lifetime */
 137         /* XXX: here is mbuf place holder to be sent ? */
 138 };
 139 #endif /* _KERNEL */
 140
 141 /* buffer size for formatted output of ipsec address */
 142 #define IPSEC_ADDRSTRLEN        (INET6_ADDRSTRLEN + 11)
 143
 144 /* according to IANA assignment, port 0x0000 and proto 0xff are reserved. */
 145 #define IPSEC_PORT_ANY          0
 146 #define IPSEC_ULPROTO_ANY       255
 147 #define IPSEC_PROTO_ANY         255
 148
 149 /* mode of security protocol */
 150 /* NOTE: DON'T use IPSEC_MODE_ANY at SPD.  It's only use in SAD */
 151 #define IPSEC_MODE_ANY          0       /* i.e. wildcard. */
 152 #define IPSEC_MODE_TRANSPORT    1
 153 #define IPSEC_MODE_TUNNEL       2
 154 #define IPSEC_MODE_TCPMD5       3       /* TCP MD5 mode */
 155
 156 /*
 157  * Direction of security policy.
 158  * NOTE: Since INVALID is used just as flag.
 159  * The other are used for loop counter too.
 160  */
 161 #define IPSEC_DIR_ANY           0
 162 #define IPSEC_DIR_INBOUND       1
 163 #define IPSEC_DIR_OUTBOUND      2
 164 #define IPSEC_DIR_MAX           3
 165 #define IPSEC_DIR_INVALID       4
 166
 167 /* Policy level */
 168 /*
 169  * IPSEC, ENTRUST and BYPASS are allowed for setsockopt() in PCB,
 170  * DISCARD, IPSEC and NONE are allowed for setkey() in SPD.
 171  * DISCARD and NONE are allowed for system default.
 172  */
 173 #define IPSEC_POLICY_DISCARD    0       /* discarding packet */
 174 #define IPSEC_POLICY_NONE       1       /* through IPsec engine */
 175 #define IPSEC_POLICY_IPSEC      2       /* do IPsec */
 176 #define IPSEC_POLICY_ENTRUST    3       /* consulting SPD if present. */
 177 #define IPSEC_POLICY_BYPASS     4       /* only for privileged socket. */
 178
 179 /* Policy scope */
 180 #define IPSEC_POLICYSCOPE_ANY           0x00    /* unspecified */
 181 #define IPSEC_POLICYSCOPE_GLOBAL        0x01    /* global scope */
 182 #define IPSEC_POLICYSCOPE_IFNET         0x02    /* if_ipsec(4) scope */
 183 #define IPSEC_POLICYSCOPE_PCB           0x04    /* PCB scope */
 184
 185 /* Security protocol level */
 186 #define IPSEC_LEVEL_DEFAULT     0       /* reference to system default */
 187 #define IPSEC_LEVEL_USE         1       /* use SA if present. */
 188 #define IPSEC_LEVEL_REQUIRE     2       /* require SA. */
 189 #define IPSEC_LEVEL_UNIQUE      3       /* unique SA. */
 190
 191 #define IPSEC_MANUAL_REQID_MAX  0x3fff
 192                                 /*
 193                                  * if security policy level == unique, this id
 194                                  * indicate to a relative SA for use, else is
 195                                  * zero.
 196                                  * 1 - 0x3fff are reserved for manual keying.
 197                                  * 0 are reserved for above reason.  Others is
 198                                  * for kernel use.
 199                                  * Note that this id doesn't identify SA
 200                                  * by only itself.
 201                                  */
 202 #define IPSEC_REPLAYWSIZE  32
 203
 204 /* statistics for ipsec processing */
 205 struct ipsecstat {
 206         uint64_t ips_in_polvio;         /* input: sec policy violation */
 207         uint64_t ips_in_nomem;          /* input: no memory available */
 208         uint64_t ips_in_inval;          /* input: generic error */
 209
 210         uint64_t ips_out_polvio;        /* output: sec policy violation */
 211         uint64_t ips_out_nosa;          /* output: SA unavailable  */
 212         uint64_t ips_out_nomem;         /* output: no memory available */
 213         uint64_t ips_out_noroute;       /* output: no route available */
 214         uint64_t ips_out_inval;         /* output: generic error */
 215         uint64_t ips_out_bundlesa;      /* output: bundled SA processed */
 216
 217         uint64_t ips_spdcache_hits;     /* SPD cache hits */
 218         uint64_t ips_spdcache_misses;   /* SPD cache misses */
 219
 220         uint64_t ips_clcopied;          /* clusters copied during clone */
 221         uint64_t ips_mbinserted;        /* mbufs inserted during makespace */
 222         /*
 223          * Temporary statistics for performance analysis.
 224          */
 225         /* See where ESP/AH/IPCOMP header land in mbuf on input */
 226         uint64_t ips_input_front;
 227         uint64_t ips_input_middle;
 228         uint64_t ips_input_end;
 229 };
 230
 231 /*
 232  * Definitions for IPsec & Key sysctl operations.
 233  */
 234 #define IPSECCTL_STATS                  1       /* stats */
 235 #define IPSECCTL_DEF_POLICY             2
 236 #define IPSECCTL_DEF_ESP_TRANSLEV       3       /* int; ESP transport mode */
 237 #define IPSECCTL_DEF_ESP_NETLEV         4       /* int; ESP tunnel mode */
 238 #define IPSECCTL_DEF_AH_TRANSLEV        5       /* int; AH transport mode */
 239 #define IPSECCTL_DEF_AH_NETLEV          6       /* int; AH tunnel mode */
 240 #if 0   /* obsolete, do not reuse */
 241 #define IPSECCTL_INBOUND_CALL_IKE       7
 242 #endif
 243 #define IPSECCTL_AH_CLEARTOS            8
 244 #define IPSECCTL_AH_OFFSETMASK          9
 245 #define IPSECCTL_DFBIT                  10
 246 #define IPSECCTL_ECN                    11
 247 #define IPSECCTL_DEBUG                  12
 248 #define IPSECCTL_ESP_RANDPAD            13
 249
 250 #ifdef _KERNEL
 251 #include <sys/counter.h>
 252
 253 struct ipsec_ctx_data;
 254 #define IPSEC_INIT_CTX(_ctx, _mp, _inp, _sav, _af, _enc) do {   \
 255         (_ctx)->mp = (_mp);                             \
 256         (_ctx)->inp = (_inp);                           \
 257         (_ctx)->sav = (_sav);                           \
 258         (_ctx)->af = (_af);                             \
 259         (_ctx)->enc = (_enc);                           \
 260 } while(0)
 261 int     ipsec_run_hhooks(struct ipsec_ctx_data *ctx, int direction);
 262
 263 VNET_DECLARE(int, ipsec_debug);
 264 #define V_ipsec_debug           VNET(ipsec_debug)
 265
 266 #ifdef REGRESSION
 267 VNET_DECLARE(int, ipsec_replay);
 268 VNET_DECLARE(int, ipsec_integrity);
 269
 270 #define V_ipsec_replay          VNET(ipsec_replay)
 271 #define V_ipsec_integrity       VNET(ipsec_integrity)
 272 #endif
 273
 274 VNET_PCPUSTAT_DECLARE(struct ipsecstat, ipsec4stat);
 275 VNET_DECLARE(int, ip4_esp_trans_deflev);
 276 VNET_DECLARE(int, ip4_esp_net_deflev);
 277 VNET_DECLARE(int, ip4_ah_trans_deflev);
 278 VNET_DECLARE(int, ip4_ah_net_deflev);
 279 VNET_DECLARE(int, ip4_ipsec_dfbit);
 280 VNET_DECLARE(int, ip4_ipsec_ecn);
 281 VNET_DECLARE(int, crypto_support);
 282 VNET_DECLARE(int, async_crypto);
 283 VNET_DECLARE(int, natt_cksum_policy);
 284
 285 #define IPSECSTAT_INC(name)     \
 286     VNET_PCPUSTAT_ADD(struct ipsecstat, ipsec4stat, name, 1)
 287 #define V_ip4_esp_trans_deflev  VNET(ip4_esp_trans_deflev)
 288 #define V_ip4_esp_net_deflev    VNET(ip4_esp_net_deflev)
 289 #define V_ip4_ah_trans_deflev   VNET(ip4_ah_trans_deflev)
 290 #define V_ip4_ah_net_deflev     VNET(ip4_ah_net_deflev)
 291 #define V_ip4_ipsec_dfbit       VNET(ip4_ipsec_dfbit)
 292 #define V_ip4_ipsec_ecn         VNET(ip4_ipsec_ecn)
 293 #define V_crypto_support        VNET(crypto_support)
 294 #define V_async_crypto          VNET(async_crypto)
 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, uint32_t *, struct secasvar *);
 329 int ipsec_updatereplay(uint32_t, struct secasvar *);
 330 int ipsec_updateid(struct secasvar *, crypto_session_t *, crypto_session_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_ */