xref: /freebsd/sys/netipsec/key.h (revision a812392203d7c4c3f0db9d8a0f3391374c49c71f)
1 /*	$FreeBSD$	*/
2 /*	$KAME: key.h,v 1.21 2001/07/27 03:51:30 itojun Exp $	*/
3 
4 /*-
5  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the project nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 #ifndef _NETIPSEC_KEY_H_
34 #define _NETIPSEC_KEY_H_
35 
36 #ifdef _KERNEL
37 
38 struct secpolicy;
39 struct secpolicyindex;
40 struct ipsecrequest;
41 struct secasvar;
42 struct sockaddr;
43 struct socket;
44 struct sadb_msg;
45 struct sadb_x_policy;
46 struct secasindex;
47 union sockaddr_union;
48 
49 extern void key_addref(struct secpolicy *sp);
50 extern	int key_havesp(u_int dir);
51 extern struct secpolicy *key_allocsp(struct secpolicyindex *, u_int,
52 	const char*, int);
53 extern struct secpolicy *key_allocsp2(u_int32_t spi, union sockaddr_union *dst,
54 	u_int8_t proto, u_int dir, const char*, int);
55 extern struct secpolicy *key_newsp(const char*, int);
56 #if 0
57 extern struct secpolicy *key_gettunnel(const struct sockaddr *,
58 	const struct sockaddr *, const struct sockaddr *,
59 	const struct sockaddr *, const char*, int);
60 #endif
61 /* NB: prepend with _ for KAME IPv6 compatbility */
62 extern void _key_freesp(struct secpolicy **, const char*, int);
63 
64 #define	KEY_ALLOCSP(spidx, dir)					\
65 	key_allocsp(spidx, dir, __FILE__, __LINE__)
66 #define	KEY_ALLOCSP2(spi, dst, proto, dir)			\
67 	key_allocsp2(spi, dst, proto, dir, __FILE__, __LINE__)
68 #define	KEY_NEWSP()						\
69 	key_newsp(__FILE__, __LINE__)
70 #if 0
71 #define	KEY_GETTUNNEL(osrc, odst, isrc, idst)			\
72 	key_gettunnel(osrc, odst, isrc, idst, __FILE__, __LINE__)
73 #endif
74 #define	KEY_FREESP(spp)						\
75 	_key_freesp(spp, __FILE__, __LINE__)
76 
77 extern struct secasvar *key_allocsa(union sockaddr_union *, u_int, u_int32_t,
78 	const char*, int);
79 extern void key_addrefsa(struct secasvar *, const char*, int);
80 extern void key_freesav(struct secasvar **, const char*, int);
81 
82 #define	KEY_ALLOCSA(dst, proto, spi)				\
83 	key_allocsa(dst, proto, spi, __FILE__, __LINE__)
84 #define	KEY_ADDREFSA(sav)					\
85 	key_addrefsa(sav, __FILE__, __LINE__)
86 #define	KEY_FREESAV(psav)					\
87 	key_freesav(psav, __FILE__, __LINE__)
88 
89 extern void key_freeso(struct socket *);
90 extern int key_checktunnelsanity(struct secasvar *, u_int,
91     caddr_t, caddr_t);
92 extern int key_checkrequest(struct ipsecrequest *isr,
93     const struct secasindex *);
94 extern struct secpolicy *key_msg2sp(struct sadb_x_policy *,
95     size_t, int *);
96 extern struct mbuf *key_sp2msg(struct secpolicy *);
97 extern int key_ismyaddr(struct sockaddr *);
98 extern int key_spdacquire(struct secpolicy *);
99 extern u_long key_random(void);
100 extern void key_randomfill(void *, size_t);
101 extern void key_freereg(struct socket *);
102 extern int key_parse(struct mbuf *, struct socket *);
103 extern void key_init(void);
104 #ifdef VIMAGE
105 extern void key_destroy(void);
106 #endif
107 extern void key_sa_recordxfer(struct secasvar *, struct mbuf *);
108 extern void key_sa_stir_iv(struct secasvar *);
109 #ifdef IPSEC_NAT_T
110 u_int16_t key_portfromsaddr(struct sockaddr *);
111 #define	KEY_PORTFROMSADDR(saddr)				\
112 	key_portfromsaddr((struct sockaddr *)(saddr))
113 #endif
114 
115 #ifdef MALLOC_DECLARE
116 MALLOC_DECLARE(M_IPSEC_SA);
117 MALLOC_DECLARE(M_IPSEC_SAH);
118 MALLOC_DECLARE(M_IPSEC_SP);
119 MALLOC_DECLARE(M_IPSEC_SR);
120 MALLOC_DECLARE(M_IPSEC_MISC);
121 MALLOC_DECLARE(M_IPSEC_SAQ);
122 MALLOC_DECLARE(M_IPSEC_SAR);
123 MALLOC_DECLARE(M_IPSEC_INPCB);
124 #endif /* MALLOC_DECLARE */
125 
126 #endif /* defined(_KERNEL) */
127 #endif /* _NETIPSEC_KEY_H_ */
128