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