1/*	$NetBSD: key.h,v 1.11 2011/06/09 19:54:18 drochner 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
41struct secpolicy;
42struct secpolicyindex;
43struct ipsecrequest;
44struct secasvar;
45struct sockaddr;
46struct socket;
47struct sadb_msg;
48struct sadb_x_policy;
49struct secasindex;
50union sockaddr_union;
51
52int key_havesp(u_int dir);
53struct secpolicy *key_allocsp(const struct secpolicyindex *, u_int,
54	const char*, int);
55struct secpolicy *key_allocsp2(u_int32_t spi, const union sockaddr_union *dst,
56	u_int8_t proto, u_int dir, const char*, int);
57struct secpolicy *key_newsp(const char*, int);
58struct 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 */
62void _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
82struct secasvar *key_allocsa(const union sockaddr_union *,
83		u_int, u_int32_t, u_int16_t, u_int16_t, const char*, int);
84void 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
91void key_freeso (struct socket *);
92int key_checktunnelsanity (struct secasvar *, u_int, void *, void *);
93int key_checkrequest (struct ipsecrequest *isr, const struct secasindex *);
94
95struct secpolicy *key_msg2sp (const struct sadb_x_policy *, size_t, int *);
96struct mbuf *key_sp2msg (const struct secpolicy *);
97int key_ismyaddr (const struct sockaddr *);
98int key_cmpspidx_exactly (const struct secpolicyindex *, const struct secpolicyindex *);
99int key_cmpspidx_withmask (const struct secpolicyindex *, const struct secpolicyindex *);
100int key_spdacquire (const struct secpolicy *);
101void key_timehandler (void*);
102u_long key_random (void);
103void key_randomfill (void *, size_t);
104void key_freereg (struct socket *);
105int key_parse (struct mbuf *, struct socket *);
106void key_init (void);
107void key_sa_recordxfer (struct secasvar *, struct mbuf *);
108void key_sa_routechange (struct sockaddr *);
109
110#ifdef IPSEC_NAT_T
111u_int16_t key_portfromsaddr (const union sockaddr_union *);
112#endif
113
114
115
116#ifdef MALLOC_DECLARE
117MALLOC_DECLARE(M_SECA);
118#endif /* MALLOC_DECLARE */
119
120/* XXX: referenced by kernfs, but not implemented... */
121extern TAILQ_HEAD(_satailq, secasvar) satailq;
122extern TAILQ_HEAD(_sptailq, secpolicy) sptailq;
123
124#endif /* defined(_KERNEL) */
125#endif /* !_NETIPSEC_KEY_H_ */
126