xref: /openbsd/sys/net/pfkeyv2.h (revision db3296cf)
1 /* $OpenBSD: pfkeyv2.h,v 1.48 2003/07/24 09:59:02 itojun Exp $ */
2 /*
3  *	@(#)COPYRIGHT	1.1 (NRL) January 1998
4  *
5  * NRL grants permission for redistribution and use in source and binary
6  * forms, with or without modification, of the software and documentation
7  * created at NRL provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. All advertising materials mentioning features or use of this software
15  *    must display the following acknowledgements:
16  * 	This product includes software developed by the University of
17  * 	California, Berkeley and its contributors.
18  * 	This product includes software developed at the Information
19  * 	Technology Division, US Naval Research Laboratory.
20  * 4. Neither the name of the NRL nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THE SOFTWARE PROVIDED BY NRL IS PROVIDED BY NRL AND CONTRIBUTORS ``AS
25  * IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
26  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
27  * PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL NRL OR
28  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
29  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
30  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
31  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
32  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
33  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
34  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35  *
36  * The views and conclusions contained in the software and documentation
37  * are those of the authors and should not be interpreted as representing
38  * official policies, either expressed or implied, of the US Naval
39  * Research Laboratory (NRL).
40  */
41 
42 #ifndef _NET_PFKEY_V2_H_
43 #define _NET_PFKEY_V2_H_
44 
45 #define PF_KEY_V2			2
46 #define PFKEYV2_REVISION		199806L
47 
48 /* This should be updated whenever the API is altered.  */
49 #define _OPENBSD_IPSEC_API_VERSION	2
50 
51 #define SADB_RESERVED      0
52 #define SADB_GETSPI        1
53 #define SADB_UPDATE        2
54 #define SADB_ADD           3
55 #define SADB_DELETE        4
56 #define SADB_GET           5
57 #define SADB_ACQUIRE       6
58 #define SADB_REGISTER      7
59 #define SADB_EXPIRE        8
60 #define SADB_FLUSH         9
61 #define SADB_DUMP          10
62 #define SADB_X_PROMISC     11
63 #define SADB_X_ADDFLOW     12
64 #define SADB_X_DELFLOW     13
65 #define SADB_X_GRPSPIS     14
66 #define SADB_X_ASKPOLICY   15
67 #define SADB_MAX           15
68 
69 struct sadb_msg {
70 	uint8_t sadb_msg_version;
71 	uint8_t sadb_msg_type;
72 	uint8_t sadb_msg_errno;
73 	uint8_t sadb_msg_satype;
74 	uint16_t sadb_msg_len;
75 	uint16_t sadb_msg_reserved;
76 	uint32_t sadb_msg_seq;
77 	uint32_t sadb_msg_pid;
78 };
79 
80 struct sadb_ext {
81 	uint16_t sadb_ext_len;
82 	uint16_t sadb_ext_type;
83 };
84 
85 struct sadb_sa {
86 	uint16_t sadb_sa_len;
87 	uint16_t sadb_sa_exttype;
88 	uint32_t sadb_sa_spi;
89 	uint8_t sadb_sa_replay;
90 	uint8_t sadb_sa_state;
91 	uint8_t sadb_sa_auth;
92 	uint8_t sadb_sa_encrypt;
93 	uint32_t sadb_sa_flags;
94 };
95 
96 struct sadb_lifetime {
97 	uint16_t sadb_lifetime_len;
98 	uint16_t sadb_lifetime_exttype;
99 	uint32_t sadb_lifetime_allocations;
100 	uint64_t sadb_lifetime_bytes;
101 	uint64_t sadb_lifetime_addtime;
102 	uint64_t sadb_lifetime_usetime;
103 };
104 
105 struct sadb_address {
106 	uint16_t sadb_address_len;
107 	uint16_t sadb_address_exttype;
108 	uint32_t sadb_address_reserved;
109 };
110 
111 struct sadb_key {
112 	uint16_t sadb_key_len;
113 	uint16_t sadb_key_exttype;
114 	uint16_t sadb_key_bits;
115 	uint16_t sadb_key_reserved;
116 };
117 
118 struct sadb_ident {
119 	uint16_t sadb_ident_len;
120 	uint16_t sadb_ident_exttype;
121 	uint16_t sadb_ident_type;
122 	uint16_t sadb_ident_reserved;
123 	uint64_t sadb_ident_id;
124 };
125 
126 struct sadb_sens {
127 	uint16_t sadb_sens_len;
128 	uint16_t sadb_sens_exttype;
129 	uint32_t sadb_sens_dpd;
130 	uint8_t sadb_sens_sens_level;
131 	uint8_t sadb_sens_sens_len;
132 	uint8_t sadb_sens_integ_level;
133 	uint8_t sadb_sens_integ_len;
134 	uint32_t sadb_sens_reserved;
135 };
136 
137 struct sadb_prop {
138 	uint16_t sadb_prop_len;
139 	uint16_t sadb_prop_exttype;
140 	uint8_t sadb_prop_num;
141 	uint8_t sadb_prop_replay;
142 	uint16_t sadb_prop_reserved;
143 };
144 
145 struct sadb_comb {
146 	uint8_t sadb_comb_auth;
147 	uint8_t sadb_comb_encrypt;
148 	uint16_t sadb_comb_flags;
149 	uint16_t sadb_comb_auth_minbits;
150 	uint16_t sadb_comb_auth_maxbits;
151 	uint16_t sadb_comb_encrypt_minbits;
152 	uint16_t sadb_comb_encrypt_maxbits;
153 	uint32_t sadb_comb_reserved;
154 	uint32_t sadb_comb_soft_allocations;
155 	uint32_t sadb_comb_hard_allocations;
156 	uint64_t sadb_comb_soft_bytes;
157 	uint64_t sadb_comb_hard_bytes;
158 	uint64_t sadb_comb_soft_addtime;
159 	uint64_t sadb_comb_hard_addtime;
160 	uint64_t sadb_comb_soft_usetime;
161 	uint64_t sadb_comb_hard_usetime;
162 };
163 
164 struct sadb_supported {
165 	uint16_t sadb_supported_len;
166 	uint16_t sadb_supported_exttype;
167 	uint32_t sadb_supported_reserved;
168 };
169 
170 struct sadb_alg {
171 	uint8_t sadb_alg_id;
172 	uint8_t sadb_alg_ivlen;
173 	uint16_t sadb_alg_minbits;
174 	uint16_t sadb_alg_maxbits;
175 	uint16_t sadb_alg_reserved;
176 };
177 
178 struct sadb_spirange {
179 	uint16_t sadb_spirange_len;
180 	uint16_t sadb_spirange_exttype;
181 	uint32_t sadb_spirange_min;
182 	uint32_t sadb_spirange_max;
183 	uint32_t sadb_spirange_reserved;
184 };
185 
186 struct sadb_protocol {
187 	uint16_t sadb_protocol_len;
188 	uint16_t sadb_protocol_exttype;
189 	uint8_t  sadb_protocol_proto;
190 	uint8_t  sadb_protocol_direction;
191 	uint8_t  sadb_protocol_flags;
192 	uint8_t  sadb_protocol_reserved2;
193 };
194 
195 struct sadb_x_policy {
196 	uint16_t  sadb_x_policy_len;
197 	uint16_t  sadb_x_policy_exttype;
198 	u_int32_t sadb_x_policy_seq;
199 };
200 
201 struct sadb_x_cred {
202 	uint16_t sadb_x_cred_len;
203 	uint16_t sadb_x_cred_exttype;
204 	uint16_t sadb_x_cred_type;
205 	uint16_t sadb_x_cred_reserved;
206 };
207 
208 #ifdef _KERNEL
209 #define SADB_X_GETSPROTO(x) \
210 	( (x) == SADB_SATYPE_AH ? IPPROTO_AH :\
211 	(x) == SADB_SATYPE_ESP ? IPPROTO_ESP :\
212 	(x) == SADB_X_SATYPE_IPCOMP ? IPPROTO_IPCOMP: IPPROTO_IPIP )
213 #endif
214 
215 #define SADB_EXT_RESERVED             0
216 #define SADB_EXT_SA                   1
217 #define SADB_EXT_LIFETIME_CURRENT     2
218 #define SADB_EXT_LIFETIME_HARD        3
219 #define SADB_EXT_LIFETIME_SOFT        4
220 #define SADB_EXT_ADDRESS_SRC          5
221 #define SADB_EXT_ADDRESS_DST          6
222 #define SADB_EXT_ADDRESS_PROXY        7
223 #define SADB_EXT_KEY_AUTH             8
224 #define SADB_EXT_KEY_ENCRYPT          9
225 #define SADB_EXT_IDENTITY_SRC         10
226 #define SADB_EXT_IDENTITY_DST         11
227 #define SADB_EXT_SENSITIVITY          12
228 #define SADB_EXT_PROPOSAL             13
229 #define SADB_EXT_SUPPORTED_AUTH	      14
230 #define SADB_EXT_SUPPORTED_ENCRYPT    15
231 #define SADB_EXT_SPIRANGE             16
232 #define SADB_X_EXT_SRC_MASK           17
233 #define SADB_X_EXT_DST_MASK           18
234 #define SADB_X_EXT_PROTOCOL           19
235 #define SADB_X_EXT_FLOW_TYPE          20
236 #define SADB_X_EXT_SRC_FLOW           21
237 #define SADB_X_EXT_DST_FLOW           22
238 #define SADB_X_EXT_SA2                23
239 #define SADB_X_EXT_DST2               24
240 #define SADB_X_EXT_POLICY             25
241 #define SADB_X_EXT_LOCAL_CREDENTIALS  26
242 #define SADB_X_EXT_REMOTE_CREDENTIALS 27
243 #define SADB_X_EXT_LOCAL_AUTH         28
244 #define SADB_X_EXT_REMOTE_AUTH        29
245 #define SADB_X_EXT_SUPPORTED_COMP     30
246 #define SADB_EXT_MAX                  30
247 
248 /* Fix pfkeyv2.c struct pfkeyv2_socket if SATYPE_MAX > 31 */
249 #define SADB_SATYPE_UNSPEC		 0
250 #define SADB_SATYPE_AH			 1
251 #define SADB_SATYPE_ESP			 2
252 #define SADB_SATYPE_RSVP		 3
253 #define SADB_SATYPE_OSPFV2		 4
254 #define SADB_SATYPE_RIPV2		 5
255 #define SADB_SATYPE_MIP			 6
256 #define SADB_X_SATYPE_IPIP		 7
257 #define SADB_X_SATYPE_TCPSIGNATURE	 8
258 #define SADB_X_SATYPE_IPCOMP		 9
259 #define SADB_SATYPE_MAX			 9
260 
261 #define SADB_SASTATE_LARVAL   0
262 #define SADB_SASTATE_MATURE   1
263 #define SADB_SASTATE_DYING    2
264 #define SADB_SASTATE_DEAD     3
265 #define SADB_SASTATE_MAX      3
266 
267 #define SADB_AALG_NONE               0
268 #define SADB_AALG_MD5HMAC            2
269 #define SADB_AALG_SHA1HMAC           3
270 #define SADB_X_AALG_DES              4
271 #define SADB_X_AALG_SHA2_256         5
272 #define SADB_X_AALG_SHA2_384         6
273 #define SADB_X_AALG_SHA2_512         7
274 #define SADB_X_AALG_RIPEMD160HMAC    8
275 #define SADB_X_AALG_MD5              249
276 #define SADB_X_AALG_SHA1             250
277 #define SADB_AALG_MAX                250
278 
279 #define SADB_EALG_NONE        0
280 #define SADB_X_EALG_DES_IV64  1
281 #define SADB_EALG_DESCBC      2
282 #define SADB_EALG_3DESCBC     3
283 #define SADB_X_EALG_RC5       4
284 #define SADB_X_EALG_IDEA      5
285 #define SADB_X_EALG_CAST      6
286 #define SADB_X_EALG_BLF       7
287 #define SADB_X_EALG_3IDEA     8
288 #define SADB_X_EALG_DES_IV32  9
289 #define SADB_X_EALG_RC4       10
290 #define SADB_EALG_NULL        11
291 #define SADB_X_EALG_AES       12
292 #define SADB_X_EALG_SKIPJACK  249
293 #define SADB_EALG_MAX         249
294 
295 #define SADB_X_CALG_NONE	0
296 #define SADB_X_CALG_OUI		1
297 #define SADB_X_CALG_DEFLATE	2
298 #define SADB_X_CALG_LZS		3
299 #define SADB_X_CALG_MAX		3
300 
301 #define SADB_SAFLAGS_PFS         	0x001    /* perfect forward secrecy */
302 #define SADB_X_SAFLAGS_HALFIV    	0x002    /* Used for ESP-old */
303 #define SADB_X_SAFLAGS_TUNNEL	 	0x004    /* Force tunneling */
304 #define SADB_X_SAFLAGS_CHAINDEL  	0x008    /* Delete whole SA chain */
305 #define SADB_X_SAFLAGS_RANDOMPADDING    0x080    /* Random ESP padding */
306 #define SADB_X_SAFLAGS_NOREPLAY         0x100    /* No replay counter */
307 
308 #define SADB_X_POLICYFLAGS_POLICY       0x0001	/* This is a static policy */
309 
310 #define SADB_IDENTTYPE_RESERVED     0
311 #define SADB_IDENTTYPE_PREFIX       1
312 #define SADB_IDENTTYPE_FQDN         2
313 #define SADB_IDENTTYPE_USERFQDN     3
314 #define SADB_X_IDENTTYPE_CONNECTION 4
315 #define SADB_IDENTTYPE_MAX          4
316 
317 #define SADB_KEY_FLAGS_MAX 0
318 
319 #ifdef _KERNEL
320 #define PFKEYV2_LIFETIME_HARD      0
321 #define PFKEYV2_LIFETIME_SOFT      1
322 #define PFKEYV2_LIFETIME_CURRENT   2
323 
324 #define PFKEYV2_IDENTITY_SRC       0
325 #define PFKEYV2_IDENTITY_DST       1
326 
327 #define PFKEYV2_ENCRYPTION_KEY     0
328 #define PFKEYV2_AUTHENTICATION_KEY 1
329 
330 #define PFKEYV2_SOCKETFLAGS_REGISTERED 1
331 #define PFKEYV2_SOCKETFLAGS_PROMISC    2
332 
333 #define PFKEYV2_SENDMESSAGE_UNICAST    1
334 #define PFKEYV2_SENDMESSAGE_REGISTERED 2
335 #define PFKEYV2_SENDMESSAGE_BROADCAST  3
336 #endif /* _KERNEL */
337 
338 #define SADB_X_CREDTYPE_NONE         0
339 #define SADB_X_CREDTYPE_X509         1   /* ASN1 encoding of the certificate */
340 #define SADB_X_CREDTYPE_KEYNOTE      2   /* NUL-terminated buffer */
341 #define SADB_X_CREDTYPE_MAX          3
342 
343 #ifdef _KERNEL
344 #define PFKEYV2_AUTH_LOCAL           0
345 #define PFKEYV2_AUTH_REMOTE          1
346 
347 #define PFKEYV2_CRED_LOCAL           0
348 #define PFKEYV2_CRED_REMOTE          1
349 #endif /* _KERNEL */
350 
351 #define SADB_X_AUTHTYPE_NONE         0
352 #define SADB_X_AUTHTYPE_PASSPHRASE   1
353 #define SADB_X_AUTHTYPE_RSA          2
354 #define SADB_X_AUTHTYPE_MAX          2
355 
356 #define SADB_X_FLOW_TYPE_USE           1
357 #define SADB_X_FLOW_TYPE_ACQUIRE       2
358 #define SADB_X_FLOW_TYPE_REQUIRE       3
359 #define SADB_X_FLOW_TYPE_BYPASS        4
360 #define SADB_X_FLOW_TYPE_DENY          5
361 #define SADB_X_FLOW_TYPE_DONTACQ       6
362 
363 #ifdef _KERNEL
364 struct tdb;
365 struct socket;
366 struct mbuf;
367 
368 #define EXTLEN(x) (((struct sadb_ext *)(x))->sadb_ext_len * sizeof(uint64_t))
369 #define PADUP(x) (((x) + sizeof(uint64_t) - 1) & ~(sizeof(uint64_t) - 1))
370 
371 struct pfkey_version
372 {
373 	int protocol;
374 	int (*create)(struct socket *socket);
375 	int (*release)(struct socket *socket);
376 	int (*send)(struct socket *socket, void *message, int len);
377 };
378 
379 struct pfkeyv2_socket
380 {
381 	struct pfkeyv2_socket *next;
382 	struct socket *socket;
383 	int flags;
384 	uint32_t pid;
385 	uint32_t registration;    /* Increase size if SATYPE_MAX > 31 */
386 };
387 
388 struct dump_state
389 {
390 	struct sadb_msg *sadb_msg;
391 	struct socket *socket;
392 };
393 
394 int pfkeyv2_init(void);
395 int pfkeyv2_cleanup(void);
396 int pfkeyv2_parsemessage(void *, int, void **);
397 int pfkeyv2_expire(struct tdb *, u_int16_t);
398 int pfkeyv2_acquire(struct ipsec_policy *, union sockaddr_union *,
399     union sockaddr_union *, u_int32_t *, struct sockaddr_encap *);
400 
401 int pfkey_register(struct pfkey_version *version);
402 int pfkey_unregister(struct pfkey_version *version);
403 int pfkey_sendup(struct socket *socket, struct mbuf *packet, int more);
404 
405 int pfkeyv2_create(struct socket *);
406 int pfkeyv2_get(struct tdb *, void **, void **);
407 int pfkeyv2_policy(struct ipsec_acquire *, void **, void **);
408 int pfkeyv2_release(struct socket *);
409 int pfkeyv2_send(struct socket *, void *, int);
410 int pfkeyv2_sendmessage(void **, int, struct socket *, u_int8_t, int);
411 int pfkeyv2_dump_walker(struct tdb *, void *, int);
412 int pfkeyv2_flush_walker(struct tdb *, void *, int);
413 int pfkeyv2_get_proto_alg(u_int8_t, u_int8_t *, int *);
414 
415 int pfdatatopacket(void *, int, struct mbuf **);
416 
417 void export_address(void **, struct sockaddr *);
418 void export_identity(void **, struct tdb *, int);
419 void export_lifetime(void **, struct tdb *, int);
420 void export_credentials(void **, struct tdb *, int);
421 void export_sa(void **, struct tdb *);
422 void export_key(void **, struct tdb *, int);
423 void export_auth(void **, struct tdb *, int);
424 
425 void import_auth(struct tdb *, struct sadb_x_cred *, int);
426 void import_address(struct sockaddr *, struct sadb_address *);
427 void import_identity(struct tdb *, struct sadb_ident *, int);
428 void import_key(struct ipsecinit *, struct sadb_key *, int);
429 void import_lifetime(struct tdb *, struct sadb_lifetime *, int);
430 void import_credentials(struct tdb *, struct sadb_x_cred *, int);
431 void import_sa(struct tdb *, struct sadb_sa *, struct ipsecinit *);
432 void import_flow(struct sockaddr_encap *, struct sockaddr_encap *,
433     struct sadb_address *, struct sadb_address *, struct sadb_address *,
434     struct sadb_address *, struct sadb_protocol *, struct sadb_protocol *);
435 #endif /* _KERNEL */
436 #endif /* _NET_PFKEY_V2_H_ */
437