bsd/netinet6/ipsec.h

   1 /*      $FreeBSD: src/sys/netinet6/ipsec.h,v 1.4.2.2 2001/07/03 11:01:54 ume Exp $      */
   2 /*      $KAME: ipsec.h,v 1.44 2001/03/23 08:08:47 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 _NETINET6_IPSEC_H_
  38 #define _NETINET6_IPSEC_H_
  39 #include <sys/cdefs.h>
  40 #include <sys/appleapiopts.h>
  41
  42 #include <net/pfkeyv2.h>
  43 #include <uuid/uuid.h>
  44 #ifdef BSD_KERNEL_PRIVATE
  45 #include <netkey/keydb.h>
  46 #include <netinet/ip_var.h>
  47
  48 /* lock for IPsec stats */
  49 extern lck_grp_t         *sadb_stat_mutex_grp;
  50 extern lck_grp_attr_t    *sadb_stat_mutex_grp_attr;
  51 extern lck_attr_t        *sadb_stat_mutex_attr;
  52 extern lck_mtx_t         *sadb_stat_mutex;
  53
  54
  55 #define IPSEC_STAT_INCREMENT(x) \
  56         OSIncrementAtomic64((SInt64 *)&x)
  57
  58 struct secpolicyaddrrange {
  59         struct sockaddr_storage start;  /* Start (low values) of address range */
  60         struct sockaddr_storage end;    /* End (high values) of address range */
  61 };
  62
  63 /*
  64  * Security Policy Index
  65  * Ensure that both address families in the "src" and "dst" are same.
  66  * When the value of the ul_proto is ICMPv6, the port field in "src"
  67  * specifies ICMPv6 type, and the port field in "dst" specifies ICMPv6 code.
  68  */
  69 struct secpolicyindex {
  70         u_int8_t dir;                   /* direction of packet flow, see below */
  71         struct sockaddr_storage src;    /* IP src address for SP */
  72         struct sockaddr_storage dst;    /* IP dst address for SP */
  73         u_int8_t prefs;                 /* prefix length in bits for src */
  74         u_int8_t prefd;                 /* prefix length in bits for dst */
  75         u_int16_t ul_proto;             /* upper layer Protocol */
  76         ifnet_t internal_if; /* Interface a matching packet is bound to */
  77         struct secpolicyaddrrange src_range;    /* IP src address range for SP */
  78         struct secpolicyaddrrange dst_range;    /* IP dst address range for SP */
  79 #ifdef notyet
  80         uid_t uids;
  81         uid_t uidd;
  82         gid_t gids;
  83         gid_t gidd;
  84 #endif
  85 };
  86
  87 /* Security Policy Data Base */
  88 struct secpolicy {
  89         LIST_ENTRY(secpolicy) chain;
  90
  91         int refcnt;                     /* reference count */
  92         struct secpolicyindex spidx;    /* selector */
  93         u_int32_t id;                   /* It's unique number on the system. */
  94         u_int state;                    /* 0: dead, others: alive */
  95 #define IPSEC_SPSTATE_DEAD      0
  96 #define IPSEC_SPSTATE_ALIVE     1
  97
  98         u_int policy;           /* DISCARD, NONE or IPSEC, see keyv2.h */
  99         struct ipsecrequest *req;
 100         /* pointer to the ipsec request tree, */
 101         /* if policy == IPSEC else this value == NULL.*/
 102
 103         ifnet_t ipsec_if; /* IPsec interface to use */
 104         ifnet_t outgoing_if; /* Outgoing interface for encrypted traffic */
 105
 106         char disabled; /* Set to ignore policy */
 107
 108         /*
 109          * lifetime handler.
 110          * the policy can be used without limitiation if both lifetime and
 111          * validtime are zero.
 112          * "lifetime" is passed by sadb_lifetime.sadb_lifetime_addtime.
 113          * "validtime" is passed by sadb_lifetime.sadb_lifetime_usetime.
 114          */
 115         long created;           /* time created the policy */
 116         long lastused;          /* updated every when kernel sends a packet */
 117         long lifetime;          /* duration of the lifetime of this policy */
 118         long validtime;         /* duration this policy is valid without use */
 119 };
 120
 121 /* Request for IPsec */
 122 struct ipsecrequest {
 123         struct ipsecrequest *next;
 124         /* pointer to next structure */
 125         /* If NULL, it means the end of chain. */
 126         struct secasindex saidx;/* hint for search proper SA */
 127                                 /* if __ss_len == 0 then no address specified.*/
 128         u_int level;            /* IPsec level defined below. */
 129
 130         struct secpolicy *sp;   /* back pointer to SP */
 131 };
 132
 133 /* security policy in PCB */
 134 struct inpcbpolicy {
 135         struct secpolicy *sp_in;
 136         struct secpolicy *sp_out;
 137         int priv;                       /* privileged socket ? */
 138 };
 139
 140 /* SP acquiring list table. */
 141 struct secspacq {
 142         LIST_ENTRY(secspacq) chain;
 143
 144         struct secpolicyindex spidx;
 145
 146         long created;           /* for lifetime */
 147         int count;              /* for lifetime */
 148         /* XXX: here is mbuf place holder to be sent ? */
 149 };
 150 #endif /* BSD_KERNEL_PRIVATE */
 151
 152 /* according to IANA assignment, port 0x0000 and proto 0xff are reserved. */
 153 #define IPSEC_PORT_ANY          0
 154 #define IPSEC_ULPROTO_ANY       255
 155 #define IPSEC_PROTO_ANY         255
 156
 157 /* mode of security protocol */
 158 /* NOTE: DON'T use IPSEC_MODE_ANY at SPD.  It's only use in SAD */
 159 #define IPSEC_MODE_ANY          0       /* i.e. wildcard. */
 160 #define IPSEC_MODE_TRANSPORT    1
 161 #define IPSEC_MODE_TUNNEL       2
 162
 163 /*
 164  * Direction of security policy.
 165  * NOTE: Since INVALID is used just as flag.
 166  * The other are used for loop counter too.
 167  */
 168 #define IPSEC_DIR_ANY           0
 169 #define IPSEC_DIR_INBOUND       1
 170 #define IPSEC_DIR_OUTBOUND      2
 171 #define IPSEC_DIR_MAX           3
 172 #define IPSEC_DIR_INVALID       4
 173
 174 /* Policy level */
 175 /*
 176  * IPSEC, ENTRUST and BYPASS are allowed for setsockopt() in PCB,
 177  * DISCARD, IPSEC and NONE are allowed for setkey() in SPD.
 178  * DISCARD and NONE are allowed for system default.
 179  */
 180 #define IPSEC_POLICY_DISCARD    0       /* discarding packet */
 181 #define IPSEC_POLICY_NONE       1       /* through IPsec engine */
 182 #define IPSEC_POLICY_IPSEC      2       /* do IPsec */
 183 #define IPSEC_POLICY_ENTRUST    3       /* consulting SPD if present. */
 184 #define IPSEC_POLICY_BYPASS     4       /* only for privileged socket. */
 185 #define IPSEC_POLICY_GENERATE   5       /* same as discard - IKE daemon can override with generated policy */
 186
 187 /* Security protocol level */
 188 #define IPSEC_LEVEL_DEFAULT     0       /* reference to system default */
 189 #define IPSEC_LEVEL_USE         1       /* use SA if present. */
 190 #define IPSEC_LEVEL_REQUIRE     2       /* require SA. */
 191 #define IPSEC_LEVEL_UNIQUE      3       /* unique SA. */
 192
 193 #define IPSEC_MANUAL_REQID_MAX  0x3fff
 194 /*
 195  * if security policy level == unique, this id
 196  * indicate to a relative SA for use, else is
 197  * zero.
 198  * 1 - 0x3fff are reserved for manual keying.
 199  * 0 are reserved for above reason.  Others is
 200  * for kernel use.
 201  * Note that this id doesn't identify SA
 202  * by only itself.
 203  */
 204 #define IPSEC_REPLAYWSIZE  32
 205
 206 /* statistics for ipsec processing */
 207 struct ipsecstat {
 208         u_quad_t in_success __attribute__ ((aligned(8)));  /* succeeded inbound process */
 209         u_quad_t in_polvio __attribute__ ((aligned(8)));
 210         /* security policy violation for inbound process */
 211         u_quad_t in_nosa __attribute__ ((aligned(8)));      /* inbound SA is unavailable */
 212         u_quad_t in_inval __attribute__ ((aligned(8)));     /* inbound processing failed due to EINVAL */
 213         u_quad_t in_nomem __attribute__ ((aligned(8)));     /* inbound processing failed due to ENOBUFS */
 214         u_quad_t in_badspi __attribute__ ((aligned(8)));    /* failed getting a SPI */
 215         u_quad_t in_ahreplay __attribute__ ((aligned(8)));  /* AH replay check failed */
 216         u_quad_t in_espreplay __attribute__ ((aligned(8)));  /* ESP replay check failed */
 217         u_quad_t in_ahauthsucc __attribute__ ((aligned(8)));  /* AH authentication success */
 218         u_quad_t in_ahauthfail __attribute__ ((aligned(8)));  /* AH authentication failure */
 219         u_quad_t in_espauthsucc __attribute__ ((aligned(8)));  /* ESP authentication success */
 220         u_quad_t in_espauthfail __attribute__ ((aligned(8)));  /* ESP authentication failure */
 221         u_quad_t in_esphist[256] __attribute__ ((aligned(8)));
 222         u_quad_t in_ahhist[256] __attribute__ ((aligned(8)));
 223         u_quad_t in_comphist[256] __attribute__ ((aligned(8)));
 224         u_quad_t out_success __attribute__ ((aligned(8)));  /* succeeded outbound process */
 225         u_quad_t out_polvio __attribute__ ((aligned(8)));
 226         /* security policy violation for outbound process */
 227         u_quad_t out_nosa __attribute__ ((aligned(8)));     /* outbound SA is unavailable */
 228         u_quad_t out_inval __attribute__ ((aligned(8)));    /* outbound process failed due to EINVAL */
 229         u_quad_t out_nomem __attribute__ ((aligned(8)));     /* inbound processing failed due to ENOBUFS */
 230         u_quad_t out_noroute __attribute__ ((aligned(8)));  /* there is no route */
 231         u_quad_t out_esphist[256] __attribute__ ((aligned(8)));
 232         u_quad_t out_ahhist[256] __attribute__ ((aligned(8)));
 233         u_quad_t out_comphist[256] __attribute__ ((aligned(8)));
 234 };
 235
 236 #define IPSEC_MAX_WAKE_PKT_LEN  100
 237 struct ipsec_wake_pkt_info {
 238         u_int8_t wake_pkt[IPSEC_MAX_WAKE_PKT_LEN];
 239         uuid_string_t wake_uuid;
 240         u_int32_t wake_pkt_spi;
 241         u_int32_t wake_pkt_seq;
 242         u_int16_t wake_pkt_len;
 243 };
 244
 245 #ifdef BSD_KERNEL_PRIVATE
 246 /*
 247  * Definitions for IPsec & Key sysctl operations.
 248  */
 249 /*
 250  * Names for IPsec & Key sysctl objects
 251  */
 252 #define IPSECCTL_STATS                  1       /* stats */
 253 #define IPSECCTL_DEF_POLICY             2
 254 #define IPSECCTL_DEF_ESP_TRANSLEV       3       /* int; ESP transport mode */
 255 #define IPSECCTL_DEF_ESP_NETLEV         4       /* int; ESP tunnel mode */
 256 #define IPSECCTL_DEF_AH_TRANSLEV        5       /* int; AH transport mode */
 257 #define IPSECCTL_DEF_AH_NETLEV          6       /* int; AH tunnel mode */
 258 #if 0   /* obsolete, do not reuse */
 259 #define IPSECCTL_INBOUND_CALL_IKE       7
 260 #endif
 261 #define IPSECCTL_AH_CLEARTOS            8
 262 #define IPSECCTL_AH_OFFSETMASK          9
 263 #define IPSECCTL_DFBIT                  10
 264 #define IPSECCTL_ECN                    11
 265 #define IPSECCTL_DEBUG                  12
 266 #define IPSECCTL_ESP_RANDPAD            13
 267 #define IPSECCTL_MAXID                  14
 268
 269 #define IPSECCTL_NAMES { \
 270         { 0, 0 }, \
 271         { 0, 0 }, \
 272         { "def_policy", CTLTYPE_INT }, \
 273         { "esp_trans_deflev", CTLTYPE_INT }, \
 274         { "esp_net_deflev", CTLTYPE_INT }, \
 275         { "ah_trans_deflev", CTLTYPE_INT }, \
 276         { "ah_net_deflev", CTLTYPE_INT }, \
 277         { 0, 0 }, \
 278         { "ah_cleartos", CTLTYPE_INT }, \
 279         { "ah_offsetmask", CTLTYPE_INT }, \
 280         { "dfbit", CTLTYPE_INT }, \
 281         { "ecn", CTLTYPE_INT }, \
 282         { "debug", CTLTYPE_INT }, \
 283         { "esp_randpad", CTLTYPE_INT }, \
 284 }
 285
 286 #define IPSEC6CTL_NAMES { \
 287         { 0, 0 }, \
 288         { 0, 0 }, \
 289         { "def_policy", CTLTYPE_INT }, \
 290         { "esp_trans_deflev", CTLTYPE_INT }, \
 291         { "esp_net_deflev", CTLTYPE_INT }, \
 292         { "ah_trans_deflev", CTLTYPE_INT }, \
 293         { "ah_net_deflev", CTLTYPE_INT }, \
 294         { 0, 0 }, \
 295         { 0, 0 }, \
 296         { 0, 0 }, \
 297         { 0, 0 }, \
 298         { "ecn", CTLTYPE_INT }, \
 299         { "debug", CTLTYPE_INT }, \
 300         { "esp_randpad", CTLTYPE_INT }, \
 301 }
 302
 303 #if defined(__ARM__)
 304 #define IPSEC_IS_P2ALIGNED(p)        IS_P2ALIGNED(p, sizeof (u_int32_t))
 305 #define IPSEC_GET_P2UNALIGNED_OFS(p) (sizeof(u_int32_t) - (((uintptr_t)(p)) & ((uintptr_t)(sizeof(u_int32_t)) - 1)))
 306 #else
 307 #define IPSEC_IS_P2ALIGNED(p)        1
 308 #define IPSEC_GET_P2UNALIGNED_OFS(p) 0
 309 #endif
 310
 311 struct ipsec_output_state {
 312         int tunneled;
 313         struct mbuf *m;
 314         struct route_in6 ro;
 315         struct sockaddr *dst;
 316         u_int outgoing_if;
 317 };
 318
 319 struct ipsec_history {
 320         int ih_proto;
 321         u_int32_t ih_spi;
 322 };
 323
 324 extern int ipsec_debug;
 325
 326 extern struct ipsecstat ipsecstat;
 327 extern struct secpolicy ip4_def_policy;
 328 extern int ip4_esp_trans_deflev;
 329 extern int ip4_esp_net_deflev;
 330 extern int ip4_ah_trans_deflev;
 331 extern int ip4_ah_net_deflev;
 332 extern int ip4_ah_cleartos;
 333 extern int ip4_ah_offsetmask;
 334 extern int ip4_ipsec_dfbit;
 335 extern int ip4_ipsec_ecn;
 336 extern int ip4_esp_randpad;
 337
 338 extern bool ipsec_save_wake_pkt;
 339
 340 #define ipseclog(x)     do { if (ipsec_debug) log x; } while (0)
 341
 342 extern struct secpolicy *ipsec4_getpolicybysock(struct mbuf *, u_int,
 343     struct socket *, int *);
 344 extern struct secpolicy *ipsec4_getpolicybyaddr(struct mbuf *, u_int, int,
 345     int *);
 346 extern int ipsec4_getpolicybyinterface(struct mbuf *, u_int, int *,
 347     struct ip_out_args *, struct secpolicy **);
 348
 349 extern u_int ipsec_get_reqlevel(struct ipsecrequest *);
 350
 351 struct inpcb;
 352 extern int ipsec_init_policy(struct socket *so, struct inpcbpolicy **);
 353 extern int ipsec_copy_policy(struct inpcbpolicy *, struct inpcbpolicy *);
 354 extern u_int ipsec_get_reqlevel(struct ipsecrequest *);
 355
 356 extern int ipsec4_set_policy(struct inpcb *inp, int optname,
 357     caddr_t request, size_t len, int priv);
 358 extern int ipsec4_delete_pcbpolicy(struct inpcb *);
 359 extern int ipsec4_in_reject_so(struct mbuf *, struct socket *);
 360 extern int ipsec4_in_reject(struct mbuf *, struct inpcb *);
 361
 362 struct secas;
 363 struct tcpcb;
 364 extern int ipsec_chkreplay(u_int32_t, struct secasvar *, u_int8_t);
 365 extern int ipsec_updatereplay(u_int32_t, struct secasvar *, u_int8_t);
 366
 367 extern size_t ipsec4_hdrsiz(struct mbuf *, u_int, struct inpcb *);
 368 extern size_t ipsec_hdrsiz_tcp(struct tcpcb *);
 369 extern size_t ipsec_hdrsiz(struct secpolicy *);
 370
 371 struct ip;
 372 extern const char *ipsec4_logpacketstr(struct ip *, u_int32_t);
 373 extern const char *ipsec_logsastr(struct secasvar *);
 374
 375 extern void ipsec_dumpmbuf(struct mbuf *);
 376
 377 extern int ipsec4_interface_output(struct ipsec_output_state *state, ifnet_t interface);
 378 extern int ipsec4_output(struct ipsec_output_state *, struct secpolicy *, int);
 379 #if INET
 380 extern struct mbuf * ipsec4_splithdr(struct mbuf *);
 381 extern int ipsec4_encapsulate(struct mbuf *, struct secasvar *);
 382 #endif
 383 #if INET6
 384 extern struct mbuf * ipsec6_splithdr(struct mbuf *);
 385 extern int ipsec6_encapsulate(struct mbuf *, struct secasvar *);
 386 #endif
 387 extern int ipsec4_tunnel_validate(struct mbuf *, int, u_int, struct secasvar *, sa_family_t *);
 388 extern struct mbuf *ipsec_copypkt(struct mbuf *);
 389 extern void ipsec_delaux(struct mbuf *);
 390 extern int ipsec_setsocket(struct mbuf *, struct socket *);
 391 extern struct socket *ipsec_getsocket(struct mbuf *);
 392 extern int ipsec_addhist(struct mbuf *, int, u_int32_t);
 393 extern struct ipsec_history *ipsec_gethist(struct mbuf *, int *);
 394 extern void ipsec_clearhist(struct mbuf *);
 395 extern void ipsec_monitor_sleep_wake(void);
 396 extern void ipsec_save_wake_packet(struct mbuf *, u_int32_t, u_int32_t);
 397 #endif /* BSD_KERNEL_PRIVATE */
 398
 399 #ifndef KERNEL
 400 __BEGIN_DECLS
 401 extern caddr_t ipsec_set_policy(char *, int);
 402 extern int ipsec_get_policylen(caddr_t);
 403 extern char *ipsec_dump_policy(caddr_t, char *);
 404
 405 extern const char *ipsec_strerror(void);
 406 __END_DECLS
 407 #endif /* KERNEL */
 408
 409 #endif /* _NETINET6_IPSEC_H_ */