2 /* $KAME: keydb.h,v 1.14 2000/08/02 17:58:26 sakane Exp $ */
5 * SPDX-License-Identifier: BSD-3-Clause
7 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the project nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 #ifndef _NETIPSEC_KEYDB_H_
36 #define _NETIPSEC_KEYDB_H_
39 #include <sys/counter.h>
41 #include <sys/mutex.h>
42 #include <sys/rmlock.h>
44 #include <netipsec/key_var.h>
45 #include <opencrypto/_cryptodev.h>
47 #ifndef _SOCKADDR_UNION_DEFINED
48 #define _SOCKADDR_UNION_DEFINED
50 * The union of all possible address formats we handle.
52 union sockaddr_union {
54 struct sockaddr_in sin;
55 struct sockaddr_in6 sin6;
57 #endif /* _SOCKADDR_UNION_DEFINED */
59 /* Security Association Index */
60 /* NOTE: Ensure to be same address family */
62 union sockaddr_union src; /* source address for SA */
63 union sockaddr_union dst; /* destination address for SA */
64 uint8_t proto; /* IPPROTO_ESP or IPPROTO_AH */
65 uint8_t mode; /* mode of protocol, see ipsec.h */
66 uint32_t reqid; /* reqid id who owned this SA */
67 /* see IPSEC_MANUAL_REQID_MAX. */
71 * In order to split out the keydb implementation from that of the
72 * PF_KEY sockets we need to define a few structures that while they
73 * may seem common are likely to diverge over time.
89 u_int32_t allocations;
96 union sockaddr_union oai; /* original addresses of initiator */
97 union sockaddr_union oar; /* original address of responder */
98 uint16_t sport; /* source port */
99 uint16_t dport; /* destination port */
100 uint16_t cksum; /* checksum delta */
102 #define IPSEC_NATT_F_OAI 0x0001
103 #define IPSEC_NATT_F_OAR 0x0002
106 /* Security Association Data Base */
107 TAILQ_HEAD(secasvar_queue, secasvar);
109 TAILQ_ENTRY(secashead) chain;
110 LIST_ENTRY(secashead) addrhash; /* hash by sproto+src+dst addresses */
111 LIST_ENTRY(secashead) drainq; /* used ONLY by flush callout */
113 struct secasindex saidx;
115 struct secident *idents; /* source identity */
116 struct secident *identd; /* destination identity */
117 /* XXX I don't know how to use them. */
119 volatile u_int refcnt; /* reference count */
120 uint8_t state; /* MATURE or DEAD. */
121 struct secasvar_queue savtree_alive; /* MATURE and DYING SA */
122 struct secasvar_queue savtree_larval; /* LARVAL SA */
131 * Security Association
133 * For INBOUND packets we do SA lookup using SPI, thus only SPIHASH is used.
134 * For OUTBOUND packets there may be several SA suitable for packet.
135 * We use key_preferred_oldsa variable to choose better SA. First of we do
136 * lookup for suitable SAH using packet's saidx. Then we use SAH's savtree
137 * to search better candidate. The newer SA (by created time) are placed
138 * in the beginning of the savtree list. There is no preference between
141 * NB: Fields with a tdb_ prefix are part of the "glue" used
142 * to interface to the OpenBSD crypto support. This was done
143 * to distinguish this code from the mainline KAME code.
144 * NB: Fields are sorted on the basis of the frequency of changes, i.e.
145 * constants and unchangeable fields are going first.
146 * NB: if you want to change this structure, check that this will not break
147 * key_updateaddresses().
150 uint32_t spi; /* SPI Value, network byte order */
151 uint32_t flags; /* holder for SADB_KEY_FLAGS */
152 uint32_t seq; /* sequence number */
153 pid_t pid; /* message's pid */
154 u_int ivlen; /* length of IV */
156 struct secashead *sah; /* back pointer to the secashead */
157 struct seckey *key_auth; /* Key for Authentication */
158 struct seckey *key_enc; /* Key for Encryption */
159 struct secreplay *replay; /* replay prevention */
160 struct secnatt *natt; /* NAT-T config */
161 struct rmlock *lock; /* update/access lock */
163 const struct xformsw *tdb_xform; /* transform */
164 const struct enc_xform *tdb_encalgxform;/* encoding algorithm */
165 const struct auth_hash *tdb_authalgxform;/* authentication algorithm */
166 const struct comp_algo *tdb_compalgxform;/* compression algorithm */
167 crypto_session_t tdb_cryptoid; /* crypto session */
169 uint8_t alg_auth; /* Authentication Algorithm Identifier*/
170 uint8_t alg_enc; /* Cipher Algorithm Identifier */
171 uint8_t alg_comp; /* Compression Algorithm Identifier */
172 uint8_t state; /* Status of this SA (pfkeyv2.h) */
174 counter_u64_t lft_c; /* CURRENT lifetime */
175 #define lft_c_allocations lft_c
176 #define lft_c_bytes lft_c + 1
177 struct seclifetime *lft_h; /* HARD lifetime */
178 struct seclifetime *lft_s; /* SOFT lifetime */
180 uint64_t created; /* time when SA was created */
181 uint64_t firstused; /* time when SA was first used */
183 TAILQ_ENTRY(secasvar) chain;
184 LIST_ENTRY(secasvar) spihash;
185 LIST_ENTRY(secasvar) drainq; /* used ONLY by flush callout */
187 uint64_t cntr; /* counter for GCM and CTR */
188 volatile u_int refcnt; /* reference count */
191 #define SECASVAR_RLOCK_TRACKER struct rm_priotracker _secas_tracker
192 #define SECASVAR_RLOCK(_sav) rm_rlock((_sav)->lock, &_secas_tracker)
193 #define SECASVAR_RUNLOCK(_sav) rm_runlock((_sav)->lock, &_secas_tracker)
194 #define SECASVAR_WLOCK(_sav) rm_wlock((_sav)->lock)
195 #define SECASVAR_WUNLOCK(_sav) rm_wunlock((_sav)->lock)
196 #define SECASVAR_LOCK_ASSERT(_sav) rm_assert((_sav)->lock, RA_LOCKED)
197 #define SECASVAR_LOCK_WASSERT(_sav) rm_assert((_sav)->lock, RA_WLOCKED)
198 #define SAV_ISGCM(_sav) \
199 ((_sav)->alg_enc == SADB_X_EALG_AESGCM8 || \
200 (_sav)->alg_enc == SADB_X_EALG_AESGCM12 || \
201 (_sav)->alg_enc == SADB_X_EALG_AESGCM16)
202 #define SAV_ISCTR(_sav) ((_sav)->alg_enc == SADB_X_EALG_AESCTR)
203 #define SAV_ISCHACHA(_sav) \
204 ((_sav)->alg_enc == SADB_X_EALG_CHACHA20POLY1305)
205 #define SAV_ISCTRORGCM(_sav) (SAV_ISCTR((_sav)) || SAV_ISGCM((_sav)))
207 #define IPSEC_SEQH_SHIFT 32
209 /* Replay prevention, protected by SECASVAR_LOCK:
211 * (c) read only except during creation / free
215 u_int64_t count; /* (m) */
216 u_int wsize; /* (c) window size, i.g. 4 bytes */
217 u_int64_t last; /* (m) used by receiver */
218 u_int32_t *bitmap; /* (m) used by receiver */
219 u_int bitmap_size; /* (c) size of the bitmap array */
220 int overflow; /* (m) overflow flag */
223 #define SECREPLAY_LOCK(_r) mtx_lock(&(_r)->lock)
224 #define SECREPLAY_UNLOCK(_r) mtx_unlock(&(_r)->lock)
225 #define SECREPLAY_ASSERT(_r) mtx_assert(&(_r)->lock, MA_OWNED)
227 /* socket table due to send PF_KEY messages. */
229 LIST_ENTRY(secreg) chain;
234 /* acquiring list table. */
236 LIST_ENTRY(secacq) chain;
237 LIST_ENTRY(secacq) addrhash;
238 LIST_ENTRY(secacq) seqhash;
240 struct secasindex saidx;
241 uint32_t seq; /* sequence number */
242 time_t created; /* for lifetime */
243 int count; /* for lifetime */
248 #endif /* _NETIPSEC_KEYDB_H_ */