xref: /netbsd-src/sys/netipsec/key.h (revision 796c32c94f6e154afc9de0f63da35c91bb739b45)
1 /*	$NetBSD: key.h,v 1.33 2017/11/21 07:03:08 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_lookup_sp_byspidx(const struct secpolicyindex *, u_int,
52 	const char*, int);
53 struct secpolicy *key_newsp(const char*, int);
54 struct secpolicy *key_gettunnel(const struct sockaddr *,
55 	const struct sockaddr *, const struct sockaddr *,
56 	const struct sockaddr *, const char*, int);
57 /* NB: prepend with _ for KAME IPv6 compatbility */
58 void key_init_sp(struct secpolicy *);
59 void key_free_sp(struct secpolicy *);
60 u_int key_sp_refcnt(const struct secpolicy *);
61 void key_sp_ref(struct secpolicy *, const char*, int);
62 void key_sp_unref(struct secpolicy *, const char*, int);
63 void key_sa_ref(struct secasvar *, const char*, int);
64 void key_sa_unref(struct secasvar *, const char*, int);
65 u_int key_sa_refcnt(const struct secasvar *);
66 
67 void key_socksplist_add(struct secpolicy *);
68 
69 /*
70  * Access to the SADB are interlocked with splsoftnet.  In particular,
71  * holders of SA's use this to block accesses by protocol processing
72  * that can happen either by network swi's or by continuations that
73  * occur on crypto callbacks.  Much of this could go away if
74  * key_checkrequest were redone.
75  */
76 #define	KEY_LOOKUP_SP_BYSPIDX(spidx, dir)			\
77 	key_lookup_sp_byspidx(spidx, dir, __func__, __LINE__)
78 #define	KEY_NEWSP()						\
79 	key_newsp(__func__, __LINE__)
80 #define	KEY_GETTUNNEL(osrc, odst, isrc, idst)			\
81 	key_gettunnel(osrc, odst, isrc, idst, __func__, __LINE__)
82 #define	KEY_SP_UNREF(spp)					\
83 	key_sp_unref(*(spp), __func__, __LINE__)
84 #define	KEY_SP_REF(sp)						\
85 	key_sp_ref(sp, __func__, __LINE__)
86 #define KEY_SA_REF(sav)						\
87 	key_sa_ref(sav, __func__, __LINE__)
88 #define	KEY_SA_UNREF(psav)					\
89 	key_sa_unref(*(psav), __func__, __LINE__)
90 
91 struct secasvar *key_lookup_sa(const union sockaddr_union *,
92 		u_int, u_int32_t, u_int16_t, u_int16_t, const char*, int);
93 void key_freesav(struct secasvar **, const char*, int);
94 struct secasvar *key_lookup_sa_bysaidx(const struct secasindex *);
95 
96 #define	KEY_LOOKUP_SA(dst, proto, spi, sport, dport)		\
97 	key_lookup_sa(dst, proto, spi, sport, dport,  __func__, __LINE__)
98 
99 int key_checktunnelsanity (struct secasvar *, u_int, void *, void *);
100 int key_checkrequest(const struct ipsecrequest *, const struct secasindex *,
101     struct secasvar **);
102 
103 struct secpolicy *key_msg2sp (const struct sadb_x_policy *, size_t, int *);
104 struct mbuf *key_sp2msg(const struct secpolicy *, int);
105 int key_ismyaddr (const struct sockaddr *);
106 int key_spdacquire (const struct secpolicy *);
107 u_long key_random (void);
108 void key_randomfill (void *, size_t);
109 void key_freereg (struct socket *);
110 int key_parse (struct mbuf *, struct socket *);
111 void key_init (void);
112 void key_sa_recordxfer (struct secasvar *, struct mbuf *);
113 void key_sa_routechange (struct sockaddr *);
114 void key_update_used(void);
115 int key_get_used(void);
116 
117 u_int16_t key_portfromsaddr (const union sockaddr_union *);
118 
119 
120 
121 #ifdef MALLOC_DECLARE
122 MALLOC_DECLARE(M_SECA);
123 #endif /* MALLOC_DECLARE */
124 
125 #endif /* defined(_KERNEL) */
126 #endif /* !_NETIPSEC_KEY_H_ */
127