bsd/netkey/keydb.h

   1 /*      $KAME: keydb.h,v 1.9 2000/02/22 14:06:41 itojun Exp $   */
   2
   3 /*
   4  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the project nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  */
  31
  32 #ifndef _NETKEY_KEYDB_H_
  33 #define _NETKEY_KEYDB_H_
  34 #include <sys/appleapiopts.h>
  35
  36 #ifdef BSD_KERNEL_PRIVATE
  37
  38 #include <netkey/key_var.h>
  39
  40 /* Security Association Index */
  41 /* NOTE: Ensure to be same address family */
  42 struct secasindex {
  43         struct sockaddr_storage src;    /* srouce address for SA */
  44         struct sockaddr_storage dst;    /* destination address for SA */
  45         u_int16_t proto;                /* IPPROTO_ESP or IPPROTO_AH */
  46         u_int8_t mode;                  /* mode of protocol, see ipsec.h */
  47         u_int32_t reqid;                /* reqid id who owned this SA */
  48                                         /* see IPSEC_MANUAL_REQID_MAX. */
  49         u_int ipsec_ifindex;
  50 };
  51
  52 #define SECURITY_ASSOCIATION_ANY          0x0000
  53 #define SECURITY_ASSOCIATION_PFKEY        0x0001
  54 #define SECURITY_ASSOCIATION_CUSTOM_IPSEC 0x0010
  55
  56 /* Security Association Data Base */
  57 struct secashead {
  58         LIST_ENTRY(secashead) chain;
  59
  60         struct secasindex saidx;
  61
  62         struct sadb_ident *idents;      /* source identity */
  63         struct sadb_ident *identd;      /* destination identity */
  64                                         /* XXX I don't know how to use them. */
  65
  66         ifnet_t ipsec_if;
  67         u_int outgoing_if;
  68         u_int8_t dir;                   /* IPSEC_DIR_INBOUND or IPSEC_DIR_OUTBOUND */
  69         u_int8_t state;                 /* MATURE or DEAD. */
  70         LIST_HEAD(_satree, secasvar) savtree[SADB_SASTATE_MAX + 1];
  71         /* SA chain */
  72         /* The first of this list is newer SA */
  73
  74         struct route_in6 sa_route;              /* route cache */
  75
  76         uint16_t flags;
  77 };
  78
  79 #define MAX_REPLAY_WINDOWS 4
  80
  81 /* Security Association */
  82 struct secasvar {
  83         LIST_ENTRY(secasvar) chain;
  84         LIST_ENTRY(secasvar) spihash;
  85         int refcnt;                     /* reference count */
  86         u_int8_t state;                 /* Status of this Association */
  87
  88         u_int8_t alg_auth;              /* Authentication Algorithm Identifier*/
  89         u_int8_t alg_enc;               /* Cipher Algorithm Identifier */
  90         u_int32_t spi;                  /* SPI Value, network byte order */
  91         u_int32_t flags;                /* holder for SADB_KEY_FLAGS */
  92         u_int16_t flags2;               /* holder for SADB_SA2_KEY_FLAGS */
  93
  94         struct sadb_key *key_auth;      /* Key for Authentication */
  95         struct sadb_key *key_enc;       /* Key for Encryption */
  96         caddr_t iv;                     /* Initilization Vector */
  97         u_int ivlen;                    /* length of IV */
  98         void *sched;                    /* intermediate encryption key */
  99         size_t schedlen;
 100
 101         struct secreplay *replay[MAX_REPLAY_WINDOWS]; /* replay prevention */
 102
 103         long created;                   /* for lifetime */
 104
 105         struct sadb_lifetime *lft_c;    /* CURRENT lifetime, it's constant. */
 106         struct sadb_lifetime *lft_h;    /* HARD lifetime */
 107         struct sadb_lifetime *lft_s;    /* SOFT lifetime */
 108
 109         struct socket *so; /* Associated socket */
 110
 111         u_int32_t seq;                  /* sequence number */
 112         pid_t pid;                      /* message's pid */
 113
 114         struct secashead *sah;          /* back pointer to the secashead */
 115
 116         /* Nat Traversal related bits */
 117         u_int64_t       natt_last_activity;
 118         u_int16_t       remote_ike_port;
 119         u_int16_t       natt_encapsulated_src_port;     /* network byte order */
 120         u_int16_t       natt_interval; /* Interval in seconds */
 121         u_int16_t       natt_offload_interval; /* Hardware Offload Interval in seconds */
 122
 123         u_int8_t        always_expire; /* Send expire/delete messages even if unused */
 124 };
 125
 126 /* replay prevention */
 127 struct secreplay {
 128         u_int32_t count;
 129         u_int wsize;            /* window size, i.g. 4 bytes */
 130         u_int32_t seq;          /* used by sender */
 131         u_int32_t lastseq;      /* used by sender/receiver */
 132         caddr_t bitmap;         /* used by receiver */
 133         int overflow;           /* overflow flag */
 134 };
 135
 136 /* socket table due to send PF_KEY messages. */
 137 struct secreg {
 138         LIST_ENTRY(secreg) chain;
 139
 140         struct socket *so;
 141 };
 142
 143 #ifndef IPSEC_NONBLOCK_ACQUIRE
 144 /* acquiring list table. */
 145 struct secacq {
 146         LIST_ENTRY(secacq) chain;
 147
 148         struct secasindex saidx;
 149
 150         u_int32_t seq;          /* sequence number */
 151         long created;           /* for lifetime */
 152         int count;              /* for lifetime */
 153 };
 154 #endif
 155
 156 /* Sensitivity Level Specification */
 157 /* nothing */
 158
 159 #define SADB_KILL_INTERVAL      600     /* six seconds */
 160
 161 struct key_cb {
 162         int key_count;
 163         int any_count;
 164 };
 165
 166 /* secpolicy */
 167 extern struct secpolicy *keydb_newsecpolicy(void);
 168 extern void keydb_delsecpolicy(struct secpolicy *);
 169 /* secashead */
 170 extern struct secashead *keydb_newsecashead(void);
 171 // extern void keydb_delsecashead(struct secashead *);  // not used
 172 /* secasvar */
 173 // extern struct secasvar *keydb_newsecasvar(void);             // not used
 174 // extern void keydb_refsecasvar(struct secasvar *);    // not used
 175 // extern void keydb_freesecasvar(struct secasvar *);   // not used
 176 /* secreplay */
 177 extern struct secreplay *keydb_newsecreplay(size_t);
 178 extern void keydb_delsecreplay(struct secreplay *);
 179 /* secreg */
 180 // extern struct secreg *keydb_newsecreg(void);                 // not used
 181 // extern void keydb_delsecreg(struct secreg *);                // not used
 182
 183 #endif /* BSD_KERNEL_PRIVATE */
 184
 185 #endif /* _NETKEY_KEYDB_H_ */