sys/netproto/key/keydb.h

   1 /*      $FreeBSD: src/sys/netkey/keydb.h,v 1.2.2.3 2003/01/11 19:10:59 ume Exp $        */
   2 /*      $KAME: keydb.h,v 1.14 2000/08/02 17:58:26 sakane 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 /* Security Assocciation 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 };
  50
  51 /* Security Association Data Base */
  52 struct secashead {
  53         LIST_ENTRY(secashead) chain;
  54
  55         struct secasindex saidx;
  56
  57         struct sadb_ident *idents;      /* source identity */
  58         struct sadb_ident *identd;      /* destination identity */
  59                                         /* XXX I don't know how to use them. */
  60
  61         u_int8_t state;                 /* MATURE or DEAD. */
  62         LIST_HEAD(_satree, secasvar) savtree[SADB_SASTATE_MAX+1];
  63                                         /* SA chain */
  64                                         /* The first of this list is newer SA */
  65
  66         union {
  67                 struct route sau_route;
  68                 struct route_in6 sau_route6;
  69         } sa_u;
  70 #define sa_route sa_u.sau_route
  71 };
  72
  73 /* Security Association */
  74 struct secasvar {
  75         LIST_ENTRY(secasvar) chain;
  76
  77         int refcnt;                     /* reference count */
  78         u_int8_t state;                 /* Status of this Association */
  79
  80         u_int8_t alg_auth;              /* Authentication Algorithm Identifier*/
  81         u_int8_t alg_enc;               /* Cipher Algorithm Identifier */
  82         u_int32_t spi;                  /* SPI Value, network byte order */
  83         u_int32_t flags;                /* holder for SADB_KEY_FLAGS */
  84
  85         struct sadb_key *key_auth;      /* Key for Authentication */
  86         struct sadb_key *key_enc;       /* Key for Encryption */
  87         caddr_t iv;                     /* Initilization Vector */
  88         u_int ivlen;                    /* length of IV */
  89         void *sched;                    /* intermediate encryption key */
  90         size_t schedlen;
  91
  92         struct secreplay *replay;       /* replay prevention */
  93         long created;                   /* for lifetime */
  94
  95         struct sadb_lifetime *lft_c;    /* CURRENT lifetime, it's constant. */
  96         struct sadb_lifetime *lft_h;    /* HARD lifetime */
  97         struct sadb_lifetime *lft_s;    /* SOFT lifetime */
  98
  99         u_int32_t seq;                  /* sequence number */
 100         pid_t pid;                      /* message's pid */
 101
 102         struct secashead *sah;          /* back pointer to the secashead */
 103 };
 104
 105 /* replay prevention */
 106 struct secreplay {
 107         u_int32_t count;
 108         u_int wsize;            /* window size, i.g. 4 bytes */
 109         u_int32_t seq;          /* used by sender */
 110         u_int32_t lastseq;      /* used by receiver */
 111         caddr_t bitmap;         /* used by receiver */
 112         int overflow;           /* overflow flag */
 113 };
 114
 115 /* socket table due to send PF_KEY messages. */
 116 struct secreg {
 117         LIST_ENTRY(secreg) chain;
 118
 119         struct socket *so;
 120 };
 121
 122 #ifndef IPSEC_NONBLOCK_ACQUIRE
 123 /* acquiring list table. */
 124 struct secacq {
 125         LIST_ENTRY(secacq) chain;
 126
 127         struct secasindex saidx;
 128
 129         u_int32_t seq;          /* sequence number */
 130         long created;           /* for lifetime */
 131         int count;              /* for lifetime */
 132 };
 133 #endif
 134
 135 /* Sensitivity Level Specification */
 136 /* nothing */
 137
 138 #define SADB_KILL_INTERVAL      600     /* six seconds */
 139
 140 struct key_cb {
 141         int key_count;
 142         int any_count;
 143 };
 144
 145 /* secpolicy */
 146 extern struct secpolicy *keydb_newsecpolicy __P((void));
 147 extern void keydb_delsecpolicy __P((struct secpolicy *));
 148 /* secashead */
 149 extern struct secashead *keydb_newsecashead __P((void));
 150 extern void keydb_delsecashead __P((struct secashead *));
 151 /* secasvar */
 152 extern struct secasvar *keydb_newsecasvar __P((void));
 153 extern void keydb_refsecasvar __P((struct secasvar *));
 154 extern void keydb_freesecasvar __P((struct secasvar *));
 155 /* secreplay */
 156 extern struct secreplay *keydb_newsecreplay __P((size_t));
 157 extern void keydb_delsecreplay __P((struct secreplay *));
 158 /* secreg */
 159 extern struct secreg *keydb_newsecreg __P((void));
 160 extern void keydb_delsecreg __P((struct secreg *));
 161
 162 #endif /* _KERNEL */
 163
 164 #endif /* _NETKEY_KEYDB_H_ */