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