1 /* $FreeBSD$ */ 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 _NETIPSEC_KEYDB_H_ 34 #define _NETIPSEC_KEYDB_H_ 35 36 #ifdef _KERNEL 37 38 #include <netipsec/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 union sockaddr_union src; /* srouce address for SA */ 56 union sockaddr_union 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 struct route sa_route; /* route cache */ 79 }; 80 81 struct xformsw; 82 struct enc_xform; 83 struct auth_hash; 84 struct comp_algo; 85 86 /* Security Association */ 87 struct secasvar { 88 LIST_ENTRY(secasvar) chain; 89 struct mtx lock; /* update/access lock */ 90 91 u_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_int8_t alg_comp; /* Compression Algorithm Identifier */ 97 u_int32_t spi; /* SPI Value, network byte order */ 98 u_int32_t flags; /* holder for SADB_KEY_FLAGS */ 99 100 struct sadb_key *key_auth; /* Key for Authentication */ 101 struct sadb_key *key_enc; /* Key for Encryption */ 102 caddr_t iv; /* Initilization Vector */ 103 u_int ivlen; /* length of IV */ 104 void *sched; /* intermediate encryption key */ 105 size_t schedlen; 106 107 struct secreplay *replay; /* replay prevention */ 108 time_t created; /* for lifetime */ 109 110 struct sadb_lifetime *lft_c; /* CURRENT lifetime, it's constant. */ 111 struct sadb_lifetime *lft_h; /* HARD lifetime */ 112 struct sadb_lifetime *lft_s; /* SOFT lifetime */ 113 114 u_int32_t seq; /* sequence number */ 115 pid_t pid; /* message's pid */ 116 117 struct secashead *sah; /* back pointer to the secashead */ 118 119 /* 120 * NB: Fields with a tdb_ prefix are part of the "glue" used 121 * to interface to the OpenBSD crypto support. This was done 122 * to distinguish this code from the mainline KAME code. 123 */ 124 struct xformsw *tdb_xform; /* transform */ 125 struct enc_xform *tdb_encalgxform; /* encoding algorithm */ 126 struct auth_hash *tdb_authalgxform; /* authentication algorithm */ 127 struct comp_algo *tdb_compalgxform; /* compression algorithm */ 128 u_int64_t tdb_cryptoid; /* crypto session id */ 129 }; 130 131 #define SECASVAR_LOCK_INIT(_sav) \ 132 mtx_init(&(_sav)->lock, "ipsec association", NULL, MTX_DEF) 133 #define SECASVAR_LOCK(_sav) mtx_lock(&(_sav)->lock) 134 #define SECASVAR_UNLOCK(_sav) mtx_unlock(&(_sav)->lock) 135 #define SECASVAR_LOCK_DESTROY(_sav) mtx_destroy(&(_sav)->lock) 136 #define SECASVAR_LOCK_ASSERT(_sav) mtx_assert(&(_sav)->lock, MA_OWNED) 137 138 /* replay prevention */ 139 struct secreplay { 140 u_int32_t count; 141 u_int wsize; /* window size, i.g. 4 bytes */ 142 u_int32_t seq; /* used by sender */ 143 u_int32_t lastseq; /* used by receiver */ 144 caddr_t bitmap; /* used by receiver */ 145 int overflow; /* overflow flag */ 146 }; 147 148 /* socket table due to send PF_KEY messages. */ 149 struct secreg { 150 LIST_ENTRY(secreg) chain; 151 152 struct socket *so; 153 }; 154 155 /* acquiring list table. */ 156 struct secacq { 157 LIST_ENTRY(secacq) chain; 158 159 struct secasindex saidx; 160 161 u_int32_t seq; /* sequence number */ 162 time_t created; /* for lifetime */ 163 int count; /* for lifetime */ 164 }; 165 166 /* Sensitivity Level Specification */ 167 /* nothing */ 168 169 #define SADB_KILL_INTERVAL 600 /* six seconds */ 170 171 /* secpolicy */ 172 extern struct secpolicy *keydb_newsecpolicy __P((void)); 173 extern void keydb_delsecpolicy __P((struct secpolicy *)); 174 /* secashead */ 175 extern struct secashead *keydb_newsecashead __P((void)); 176 extern void keydb_delsecashead __P((struct secashead *)); 177 /* secasvar */ 178 extern struct secasvar *keydb_newsecasvar __P((void)); 179 extern void keydb_refsecasvar __P((struct secasvar *)); 180 extern void keydb_freesecasvar __P((struct secasvar *)); 181 /* secreplay */ 182 extern struct secreplay *keydb_newsecreplay __P((size_t)); 183 extern void keydb_delsecreplay __P((struct secreplay *)); 184 /* secreg */ 185 extern struct secreg *keydb_newsecreg __P((void)); 186 extern void keydb_delsecreg __P((struct secreg *)); 187 188 #endif /* _KERNEL */ 189 190 #endif /* _NETIPSEC_KEYDB_H_ */ 191