1 /* $NetBSD: keydb.h,v 1.24 2021/11/10 16:55:20 msaitoh Exp $ */ 2 /* $FreeBSD: keydb.h,v 1.1.4.1 2003/01/24 05:11:36 sam Exp $ */ 3 /* $KAME: keydb.h,v 1.14 2000/08/02 17:58:26 sakane Exp $ */ 4 5 /* 6 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. 7 * All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 3. Neither the name of the project nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 */ 33 34 #ifndef _NETIPSEC_KEYDB_H_ 35 #define _NETIPSEC_KEYDB_H_ 36 37 #ifdef _KERNEL 38 39 #include <sys/localcount.h> 40 #include <sys/percpu.h> 41 42 #include <netipsec/key_var.h> 43 #include <net/route.h> 44 #include <netinet/in.h> 45 46 #ifndef _SOCKADDR_UNION_DEFINED 47 #define _SOCKADDR_UNION_DEFINED 48 /* 49 * The union of all possible address formats we handle. 50 */ 51 union sockaddr_union { 52 struct sockaddr sa; 53 struct sockaddr_in sin; 54 struct sockaddr_in6 sin6; 55 }; 56 #endif /* _SOCKADDR_UNION_DEFINED */ 57 58 /* Security Association Index */ 59 /* NOTE: Ensure to be same address family */ 60 struct secasindex { 61 union sockaddr_union src; /* source address for SA */ 62 union sockaddr_union dst; /* destination address for SA */ 63 u_int16_t proto; /* IPPROTO_ESP or IPPROTO_AH */ 64 u_int8_t mode; /* mode of protocol, see ipsec.h */ 65 u_int32_t reqid; /* reqid id who owned this SA */ 66 /* see IPSEC_MANUAL_REQID_MAX. */ 67 }; 68 69 /* Security Association Data Base */ 70 struct secashead { 71 struct pslist_entry pslist_entry; 72 struct localcount localcount; /* reference count */ 73 74 struct secasindex saidx; 75 76 struct sadb_ident *idents; /* source identity */ 77 struct sadb_ident *identd; /* destination identity */ 78 /* XXX I don't know how to use them. */ 79 size_t idents_len; /* length of idents */ 80 size_t identd_len; /* length of identd */ 81 82 u_int8_t state; /* MATURE or DEAD. */ 83 struct pslist_head savlist[SADB_SASTATE_MAX+1]; 84 /* SA chain */ 85 /* The first of this list is newer SA */ 86 87 struct route sa_route; /* route cache */ 88 }; 89 90 struct xformsw; 91 struct enc_xform; 92 struct auth_hash; 93 struct comp_algo; 94 95 /* Security Association */ 96 struct secasvar { 97 struct pslist_entry pslist_entry; 98 struct pslist_entry pslist_entry_savlut; 99 struct localcount localcount; /* reference count */ 100 bool savlut_added; /* Status of registration of the LUT */ 101 102 u_int8_t state; /* Status of this Association */ 103 104 u_int8_t alg_auth; /* Authentication Algorithm Identifier*/ 105 u_int8_t alg_enc; /* Cipher Algorithm Identifier */ 106 u_int8_t alg_comp; /* Compression Algorithm Identifier */ 107 u_int32_t spi; /* SPI Value, network byte order */ 108 u_int32_t flags; /* holder for SADB_KEY_FLAGS */ 109 110 struct sadb_key *key_auth; /* Key for Authentication */ 111 size_t key_auth_len; /* length of key_auth */ 112 struct sadb_key *key_enc; /* Key for Encryption */ 113 size_t key_enc_len; /* length of key_enc */ 114 u_int ivlen; /* length of IV */ 115 116 struct secreplay *replay; /* replay prevention */ 117 size_t replay_len; /* length of replay */ 118 time_t created; /* for lifetime */ 119 120 struct sadb_lifetime *lft_c; /* CURRENT lifetime, it's constant. */ 121 struct sadb_lifetime *lft_h; /* HARD lifetime */ 122 struct sadb_lifetime *lft_s; /* SOFT lifetime */ 123 124 /* percpu counters for lft_c->sadb_lifetime_{allocations,bytes} */ 125 percpu_t *lft_c_counters_percpu; 126 127 u_int32_t seq; /* sequence number */ 128 pid_t pid; /* message's pid */ 129 130 struct secashead *sah; /* back pointer to the secashead */ 131 132 /* 133 * NB: Fields with a tdb_ prefix are part of the "glue" used 134 * to interface to the OpenBSD crypto support. This was done 135 * to distinguish this code from the mainline KAME code. 136 */ 137 const struct xformsw *tdb_xform; /* transform */ 138 const struct enc_xform *tdb_encalgxform; /* encoding algorithm */ 139 const struct auth_hash *tdb_authalgxform; /* authentication algorithm */ 140 const struct comp_algo *tdb_compalgxform; /* compression algorithm */ 141 u_int64_t tdb_cryptoid; /* crypto session id */ 142 143 u_int16_t natt_type; 144 u_int16_t esp_frag; 145 }; 146 147 /* replay prevention */ 148 struct secreplay { 149 u_int32_t count; 150 u_int wsize; /* window size, i.g. 4 bytes */ 151 u_int32_t seq; /* used by sender */ 152 u_int32_t lastseq; /* used by receiver */ 153 char *bitmap; /* used by receiver */ 154 int overflow; /* overflow flag */ 155 }; 156 157 /* socket table due to send PF_KEY messages. */ 158 struct secreg { 159 LIST_ENTRY(secreg) chain; 160 161 struct socket *so; 162 }; 163 164 #ifndef IPSEC_NONBLOCK_ACQUIRE 165 /* acquiring list table. */ 166 struct secacq { 167 LIST_ENTRY(secacq) chain; 168 169 struct secasindex saidx; 170 171 u_int32_t seq; /* sequence number */ 172 time_t created; /* for lifetime */ 173 int count; /* for lifetime */ 174 }; 175 #endif 176 177 /* Sensitivity Level Specification */ 178 /* nothing */ 179 180 #define SADB_KILL_INTERVAL 600 /* six seconds */ 181 182 /* secpolicy */ 183 struct secpolicy *keydb_newsecpolicy (void); 184 void keydb_delsecpolicy (struct secpolicy *); 185 /* secashead */ 186 struct secashead *keydb_newsecashead (void); 187 void keydb_delsecashead (struct secashead *); 188 /* secasvar */ 189 struct secasvar *keydb_newsecasvar (void); 190 void keydb_refsecasvar (struct secasvar *); 191 void keydb_freesecasvar (struct secasvar *); 192 /* secreplay */ 193 struct secreplay *keydb_newsecreplay (size_t); 194 void keydb_delsecreplay (struct secreplay *); 195 /* secreg */ 196 struct secreg *keydb_newsecreg (void); 197 void keydb_delsecreg (struct secreg *); 198 199 #endif /* _KERNEL */ 200 201 #endif /* !_NETIPSEC_KEYDB_H_ */ 202