xref: /netbsd/sys/netipsec/key.h (revision 6550d01e)
1 /*	$NetBSD: key.h,v 1.8 2007/07/07 18:38:23 degroote Exp $	*/
2 /*	$FreeBSD: src/sys/netipsec/key.h,v 1.1.4.1 2003/01/24 05:11:36 sam Exp $	*/
3 /*	$KAME: key.h,v 1.21 2001/07/27 03:51:30 itojun 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_KEY_H_
35 #define _NETIPSEC_KEY_H_
36 
37 #ifdef _KERNEL
38 
39 #include "opt_ipsec.h"
40 
41 struct secpolicy;
42 struct secpolicyindex;
43 struct ipsecrequest;
44 struct secasvar;
45 struct sockaddr;
46 struct socket;
47 struct sadb_msg;
48 struct sadb_x_policy;
49 struct secasindex;
50 union sockaddr_union;
51 
52 int key_havesp(u_int dir);
53 struct secpolicy *key_allocsp(struct secpolicyindex *, u_int,
54 	const char*, int);
55 struct secpolicy *key_allocsp2(u_int32_t spi, union sockaddr_union *dst,
56 	u_int8_t proto, u_int dir, const char*, int);
57 struct secpolicy *key_newsp(const char*, int);
58 struct secpolicy *key_gettunnel(const struct sockaddr *,
59 	const struct sockaddr *, const struct sockaddr *,
60 	const struct sockaddr *, const char*, int);
61 /* NB: prepend with _ for KAME IPv6 compatbility */
62 void _key_freesp(struct secpolicy **, const char*, int);
63 
64 /*
65  * Access to the SADB are interlocked with splsoftnet.  In particular,
66  * holders of SA's use this to block accesses by protocol processing
67  * that can happen either by network swi's or by continuations that
68  * occur on crypto callbacks.  Much of this could go away if
69  * key_checkrequest were redone.
70  */
71 #define	KEY_ALLOCSP(spidx, dir)					\
72 	key_allocsp(spidx, dir, __FILE__, __LINE__)
73 #define	KEY_ALLOCSP2(spi, dst, proto, dir)			\
74 	key_allocsp2(spi, dst, proto, dir, __FILE__, __LINE__)
75 #define	KEY_NEWSP()						\
76 	key_newsp(__FILE__, __LINE__)
77 #define	KEY_GETTUNNEL(osrc, odst, isrc, idst)			\
78 	key_gettunnel(osrc, odst, isrc, idst, __FILE__, __LINE__)
79 #define	KEY_FREESP(spp)						\
80 	_key_freesp(spp, __FILE__, __LINE__)
81 
82 struct secasvar *key_allocsa(const union sockaddr_union *,
83 		u_int, u_int32_t, u_int16_t, u_int16_t, const char*, int);
84 void key_freesav(struct secasvar **, const char*, int);
85 
86 #define	KEY_ALLOCSA(dst, proto, spi, sport, dport)				\
87 	key_allocsa(dst, proto, spi, sport, dport,  __FILE__, __LINE__)
88 #define	KEY_FREESAV(psav)					\
89 	key_freesav(psav, __FILE__, __LINE__)
90 
91 void key_freeso (struct socket *);
92 int key_checktunnelsanity (struct secasvar *, u_int, void *, void *);
93 int key_checkrequest (struct ipsecrequest *isr, const struct secasindex *);
94 
95 struct secpolicy *key_msg2sp (struct sadb_x_policy *, size_t, int *);
96 struct mbuf *key_sp2msg (struct secpolicy *);
97 int key_ismyaddr (struct sockaddr *);
98 int key_cmpspidx_exactly (struct secpolicyindex *, struct secpolicyindex *);
99 int key_cmpspidx_withmask (struct secpolicyindex *, struct secpolicyindex *);
100 int key_spdacquire (struct secpolicy *);
101 void key_timehandler (void*);
102 u_long key_random (void);
103 void key_randomfill (void *, size_t);
104 void key_freereg (struct socket *);
105 int key_parse (struct mbuf *, struct socket *);
106 void key_init (void);
107 void key_sa_recordxfer (struct secasvar *, struct mbuf *);
108 void key_sa_routechange (struct sockaddr *);
109 void key_sa_stir_iv (struct secasvar *);
110 
111 #ifdef IPSEC_NAT_T
112 u_int16_t key_portfromsaddr (const union sockaddr_union *);
113 #endif
114 
115 
116 
117 #ifdef MALLOC_DECLARE
118 MALLOC_DECLARE(M_SECA);
119 #endif /* MALLOC_DECLARE */
120 
121 #endif /* defined(_KERNEL) */
122 #endif /* !_NETIPSEC_KEY_H_ */
123