1/* $NetBSD: key.h,v 1.36 2018/04/19 08:27:38 maxv Exp $ */
2/* $FreeBSD: 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
39struct secpolicy;
40struct secpolicyindex;
41struct ipsecrequest;
42struct secasvar;
43struct sockaddr;
44struct socket;
45struct secasindex;
46union sockaddr_union;
47
48#include <net/pfkeyv2.h>
49
50struct sadb_msghdr {
51 struct sadb_msg *msg;
52 void *ext[SADB_EXT_MAX + 1];
53 int extoff[SADB_EXT_MAX + 1];
54 int extlen[SADB_EXT_MAX + 1];
55};
56
57int key_havesp(u_int dir);
58struct secpolicy *key_lookup_sp_byspidx(const struct secpolicyindex *, u_int,
59 const char *, int);
60struct secpolicy *key_newsp(const char*, int);
61struct secpolicy *key_gettunnel(const struct sockaddr *,
62 const struct sockaddr *, const struct sockaddr *,
63 const struct sockaddr *, const char *, int);
64/* NB: prepend with _ for KAME IPv6 compatbility */
65void key_init_sp(struct secpolicy *);
66void key_free_sp(struct secpolicy *);
67u_int key_sp_refcnt(const struct secpolicy *);
68void key_sp_ref(struct secpolicy *, const char *, int);
69void key_sp_unref(struct secpolicy *, const char *, int);
70void key_sa_ref(struct secasvar *, const char *, int);
71void key_sa_unref(struct secasvar *, const char *, int);
72u_int key_sa_refcnt(const struct secasvar *);
73
74void key_socksplist_add(struct secpolicy *);
75
76/*
77 * Access to the SADB are interlocked with splsoftnet. In particular,
78 * holders of SA's use this to block accesses by protocol processing
79 * that can happen either by network swi's or by continuations that
80 * occur on crypto callbacks. Much of this could go away if
81 * key_checkrequest were redone.
82 */
83#define KEY_LOOKUP_SP_BYSPIDX(spidx, dir) \
84 key_lookup_sp_byspidx(spidx, dir, __func__, __LINE__)
85#define KEY_NEWSP() \
86 key_newsp(__func__, __LINE__)
87#define KEY_GETTUNNEL(osrc, odst, isrc, idst) \
88 key_gettunnel(osrc, odst, isrc, idst, __func__, __LINE__)
89#define KEY_SP_UNREF(spp) \
90 key_sp_unref(*(spp), __func__, __LINE__)
91#define KEY_SP_REF(sp) \
92 key_sp_ref(sp, __func__, __LINE__)
93#define KEY_SA_REF(sav) \
94 key_sa_ref(sav, __func__, __LINE__)
95#define KEY_SA_UNREF(psav) \
96 key_sa_unref(*(psav), __func__, __LINE__)
97
98struct secasvar *key_lookup_sa(const union sockaddr_union *,
99 u_int, u_int32_t, u_int16_t, u_int16_t, const char *, int);
100void key_freesav(struct secasvar **, const char *, int);
101struct secasvar *key_lookup_sa_bysaidx(const struct secasindex *);
102
103#define KEY_LOOKUP_SA(dst, proto, spi, sport, dport) \
104 key_lookup_sa(dst, proto, spi, sport, dport, __func__, __LINE__)
105
106int key_checktunnelsanity(struct secasvar *, u_int, void *, void *);
107int key_checkrequest(const struct ipsecrequest *, const struct secasindex *,
108 struct secasvar **);
109
110struct secpolicy *key_msg2sp(const struct sadb_x_policy *, size_t, int *);
111struct mbuf *key_sp2msg(const struct secpolicy *, int);
112int key_ismyaddr(const struct sockaddr *);
113int key_spdacquire(const struct secpolicy *);
114u_long key_random(void);
115void key_randomfill(void *, size_t);
116void key_freereg(struct socket *);
117int key_parse(struct mbuf *, struct socket *);
118void key_init(void);
119void key_sa_recordxfer(struct secasvar *, struct mbuf *);
120void key_sa_routechange(struct sockaddr *);
121void key_update_used(void);
122int key_get_used(void);
123
124u_int16_t key_portfromsaddr(const union sockaddr_union *);
125
126/* for ipsec(4) */
127struct secpolicy *key_kpi_spdadd(struct mbuf *);
128int key_kpi_spddelete2(struct mbuf *);
129u_int16_t key_newreqid(void);
130
131#endif /* defined(_KERNEL) */
132#endif /* !_NETIPSEC_KEY_H_ */
133