sys/netkey/keydb.h

   1 /*      $FreeBSD$       */
   2 /*      $KAME: keydb.h,v 1.24 2003/09/07 15:12:10 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 #ifndef _NETKEY_KEYDB_H_
  34 #define _NETKEY_KEYDB_H_
  35
  36 #ifdef _KERNEL
  37
  38 #include <netkey/key_var.h>
  39
  40 #ifndef _SOCKADDR_UNION_DEFINED
  41 #define _SOCKADDR_UNION_DEFINED
  42 /*
  43  * The union of all possible address formats we handle.
  44  */
  45 union sockaddr_union {
  46         struct sockaddr         sa;
  47         struct sockaddr_in      sin;
  48         struct sockaddr_in6     sin6;
  49 };
  50 #endif /* _SOCKADDR_UNION_DEFINED */
  51
  52 /* Security Assocciation Index */
  53 /* NOTE: Ensure to be same address family */
  54 struct secasindex {
  55         struct sockaddr_storage src;    /* srouce address for SA */
  56         struct sockaddr_storage dst;    /* destination address for SA */
  57         u_int16_t proto;                /* IPPROTO_ESP or IPPROTO_AH */
  58         u_int8_t mode;                  /* mode of protocol, see ipsec.h */
  59         u_int32_t reqid;                /* reqid id who owned this SA */
  60                                         /* see IPSEC_MANUAL_REQID_MAX. */
  61 };
  62
  63 /* Security Association Data Base */
  64 struct secashead {
  65         LIST_ENTRY(secashead) chain;
  66
  67         struct secasindex saidx;
  68
  69         struct sadb_ident *idents;      /* source identity */
  70         struct sadb_ident *identd;      /* destination identity */
  71                                         /* XXX I don't know how to use them. */
  72
  73         u_int8_t state;                 /* MATURE or DEAD. */
  74         LIST_HEAD(_satree, secasvar) savtree[SADB_SASTATE_MAX+1];
  75                                         /* SA chain */
  76                                         /* The first of this list is newer SA */
  77
  78         union {
  79                 struct route sau_route;
  80                 struct route_in6 sau_route6;
  81         } sa_u;
  82 #define sa_route sa_u.sau_route
  83 };
  84
  85 /* Security Association */
  86 struct secasvar {
  87         TAILQ_ENTRY(secasvar) tailq;
  88         LIST_ENTRY(secasvar) chain;
  89         LIST_ENTRY(secasvar) spihash;
  90
  91         int refcnt;                     /* reference count */
  92         u_int8_t state;                 /* Status of this Association */
  93
  94         u_int8_t alg_auth;              /* Authentication Algorithm Identifier*/
  95         u_int8_t alg_enc;               /* Cipher Algorithm Identifier */
  96         u_int32_t spi;                  /* SPI Value, network byte order */
  97         u_int32_t flags;                /* holder for SADB_KEY_FLAGS */
  98
  99         struct sadb_key *key_auth;      /* Key for Authentication */
 100         struct sadb_key *key_enc;       /* Key for Encryption */
 101         caddr_t iv;                     /* Initilization Vector */
 102         u_int ivlen;                    /* length of IV */
 103         void *sched;                    /* intermediate encryption key */
 104         size_t schedlen;
 105
 106         struct secreplay *replay;       /* replay prevention */
 107         long created;                   /* for lifetime */
 108
 109         struct sadb_lifetime *lft_c;    /* CURRENT lifetime, it's constant. */
 110         struct sadb_lifetime *lft_h;    /* HARD lifetime */
 111         struct sadb_lifetime *lft_s;    /* SOFT lifetime */
 112
 113         u_int64_t seq;                  /* sequence number */
 114         pid_t pid;                      /* message's pid */
 115
 116         struct secashead *sah;          /* back pointer to the secashead */
 117
 118         u_int32_t id;                   /* SA id */
 119 };
 120
 121 /* replay prevention */
 122 struct secreplay {
 123         u_int64_t count;
 124         u_int wsize;            /* window size, i.g. 4 bytes */
 125         u_int64_t seq;          /* used by sender */
 126         u_int64_t lastseq;      /* used by receiver */
 127         u_int8_t *bitmap;       /* used by receiver */
 128         int overflow;           /* what round does the counter take. */
 129 };
 130
 131 /* socket table due to send PF_KEY messages. */
 132 struct secreg {
 133         LIST_ENTRY(secreg) chain;
 134
 135         struct socket *so;
 136 };
 137
 138 #ifndef IPSEC_NONBLOCK_ACQUIRE
 139 /* acquiring list table. */
 140 struct secacq {
 141         LIST_ENTRY(secacq) chain;
 142
 143         struct secasindex saidx;
 144
 145         u_int32_t seq;          /* sequence number */
 146         long created;           /* for lifetime */
 147         int count;              /* for lifetime */
 148 };
 149 #endif
 150
 151 /* Sensitivity Level Specification */
 152 /* nothing */
 153
 154 #define SADB_KILL_INTERVAL      600     /* six seconds */
 155
 156 struct key_cb {
 157         int key_count;
 158         int any_count;
 159 };
 160
 161 /* secpolicy */
 162 struct secpolicy;
 163 struct secpolicyindex;
 164 extern struct secpolicy *keydb_newsecpolicy(void);
 165 extern u_int32_t keydb_newspid(void);
 166 extern void keydb_delsecpolicy(struct secpolicy *);
 167 extern int keydb_setsecpolicyindex
 168         (struct secpolicy *, struct secpolicyindex *);
 169 /* secashead */
 170 extern struct secashead *keydb_newsecashead(void);
 171 extern void keydb_delsecashead(struct secashead *);
 172 /* secasvar */
 173 extern struct secasvar *keydb_newsecasvar(void);
 174 extern void keydb_delsecasvar(struct secasvar *);
 175 /* secreplay */
 176 extern struct secreplay *keydb_newsecreplay(size_t);
 177 extern void keydb_delsecreplay(struct secreplay *);
 178 /* secreg */
 179 extern struct secreg *keydb_newsecreg(void);
 180 extern void keydb_delsecreg(struct secreg *);
 181
 182 #endif /* _KERNEL */
 183
 184 #endif /* _NETKEY_KEYDB_H_ */