keydb.h revision 1.19 
1/*	$NetBSD: keydb.h,v 1.19 2017/08/08 04:17:34 ozaki-r Exp $	*/
2/*	$FreeBSD: src/sys/netipsec/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
41#include <netipsec/key_var.h>
42#include <net/route.h>
43#include <netinet/in.h>
44
45#ifndef _SOCKADDR_UNION_DEFINED
46#define _SOCKADDR_UNION_DEFINED
47/*
48 * The union of all possible address formats we handle.
49 */
50union sockaddr_union {
51	struct sockaddr		sa;
52	struct sockaddr_in	sin;
53	struct sockaddr_in6	sin6;
54};
55#endif /* _SOCKADDR_UNION_DEFINED */
56
57/* Security Assocciation Index */
58/* NOTE: Ensure to be same address family */
59struct secasindex {
60	union sockaddr_union src;	/* source address for SA */
61	union sockaddr_union dst;	/* destination address for SA */
62	u_int16_t proto;		/* IPPROTO_ESP or IPPROTO_AH */
63	u_int8_t mode;			/* mode of protocol, see ipsec.h */
64	u_int32_t reqid;		/* reqid id who owned this SA */
65					/* see IPSEC_MANUAL_REQID_MAX. */
66};
67
68/* Security Association Data Base */
69struct secashead {
70	struct pslist_entry pslist_entry;
71	struct localcount localcount;	/* reference count */
72
73	struct secasindex saidx;
74
75	struct sadb_ident *idents;	/* source identity */
76	struct sadb_ident *identd;	/* destination identity */
77					/* XXX I don't know how to use them. */
78	size_t idents_len;		/* length of idents */
79	size_t identd_len;		/* length of identd */
80
81	u_int8_t state;			/* MATURE or DEAD. */
82	struct pslist_head savlist[SADB_SASTATE_MAX+1];
83					/* SA chain */
84					/* The first of this list is newer SA */
85
86	struct route sa_route;		/* route cache */
87};
88
89struct xformsw;
90struct enc_xform;
91struct auth_hash;
92struct comp_algo;
93
94/* Security Association */
95struct secasvar {
96	struct pslist_entry pslist_entry;
97
98	u_int refcnt;			/* reference count */
99	u_int8_t state;			/* Status of this Association */
100
101	u_int8_t alg_auth;		/* Authentication Algorithm Identifier*/
102	u_int8_t alg_enc;		/* Cipher Algorithm Identifier */
103	u_int8_t alg_comp;		/* Compression Algorithm Identifier */
104	u_int32_t spi;			/* SPI Value, network byte order */
105	u_int32_t flags;		/* holder for SADB_KEY_FLAGS */
106
107	struct sadb_key *key_auth;	/* Key for Authentication */
108	size_t key_auth_len;		/* length of key_auth */
109	struct sadb_key *key_enc;	/* Key for Encryption */
110	size_t key_enc_len;		/* length of key_enc */
111	u_int ivlen;			/* length of IV */
112
113	struct secreplay *replay;	/* replay prevention */
114	size_t replay_len;		/* length of replay */
115	time_t created;			/* for lifetime */
116
117	struct sadb_lifetime *lft_c;	/* CURRENT lifetime, it's constant. */
118	struct sadb_lifetime *lft_h;	/* HARD lifetime */
119	struct sadb_lifetime *lft_s;	/* SOFT lifetime */
120
121	u_int32_t seq;			/* sequence number */
122	pid_t pid;			/* message's pid */
123
124	struct secashead *sah;		/* back pointer to the secashead */
125
126	/*
127	 * NB: Fields with a tdb_ prefix are part of the "glue" used
128	 *     to interface to the OpenBSD crypto support.  This was done
129	 *     to distinguish this code from the mainline KAME code.
130	 */
131	const struct xformsw *tdb_xform;	/* transform */
132	const struct enc_xform *tdb_encalgxform; /* encoding algorithm */
133	const struct auth_hash *tdb_authalgxform; /* authentication algorithm */
134	const struct comp_algo *tdb_compalgxform; /* compression algorithm */
135	u_int64_t tdb_cryptoid;		/* crypto session id */
136
137	u_int16_t natt_type;
138	u_int16_t esp_frag;
139};
140
141/* replay prevention */
142struct secreplay {
143	u_int32_t count;
144	u_int wsize;		/* window size, i.g. 4 bytes */
145	u_int32_t seq;		/* used by sender */
146	u_int32_t lastseq;	/* used by receiver */
147	char *bitmap;		/* used by receiver */
148	int overflow;		/* overflow flag */
149};
150
151/* socket table due to send PF_KEY messages. */
152struct secreg {
153	LIST_ENTRY(secreg) chain;
154
155	struct socket *so;
156};
157
158#ifndef IPSEC_NONBLOCK_ACQUIRE
159/* acquiring list table. */
160struct secacq {
161	LIST_ENTRY(secacq) chain;
162
163	struct secasindex saidx;
164
165	u_int32_t seq;		/* sequence number */
166	time_t created;		/* for lifetime */
167	int count;		/* for lifetime */
168};
169#endif
170
171/* Sensitivity Level Specification */
172/* nothing */
173
174#define SADB_KILL_INTERVAL	600	/* six seconds */
175
176/* secpolicy */
177struct secpolicy *keydb_newsecpolicy (void);
178void keydb_delsecpolicy (struct secpolicy *);
179/* secashead */
180struct secashead *keydb_newsecashead (void);
181void keydb_delsecashead (struct secashead *);
182/* secasvar */
183struct secasvar *keydb_newsecasvar (void);
184void keydb_refsecasvar (struct secasvar *);
185void keydb_freesecasvar (struct secasvar *);
186/* secreplay */
187struct secreplay *keydb_newsecreplay (size_t);
188void keydb_delsecreplay (struct secreplay *);
189/* secreg */
190struct secreg *keydb_newsecreg (void);
191void keydb_delsecreg (struct secreg *);
192
193#endif /* _KERNEL */
194
195#endif /* !_NETIPSEC_KEYDB_H_ */
196