keydb.h revision 1.21
1/* $NetBSD: keydb.h,v 1.21 2018/03/02 07:37:13 ozaki-r Exp $ */ 2/* $FreeBSD: src/sys/netipsec/keydb.h,v 1.1.4.1 2003/01/24 05:11:36 sam Exp $ */ 3/* $KAME: keydb.h,v 1.14 2000/08/02 17:58:26 sakane 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_KEYDB_H_ 35#define _NETIPSEC_KEYDB_H_ 36 37#ifdef _KERNEL 38 39#include <sys/localcount.h> 40#include <sys/percpu.h> 41 42#include <netipsec/key_var.h> 43#include <net/route.h> 44#include <netinet/in.h> 45 46#ifndef _SOCKADDR_UNION_DEFINED 47#define _SOCKADDR_UNION_DEFINED 48/* 49 * The union of all possible address formats we handle. 50 */ 51union sockaddr_union { 52 struct sockaddr sa; 53 struct sockaddr_in sin; 54 struct sockaddr_in6 sin6; 55}; 56#endif /* _SOCKADDR_UNION_DEFINED */ 57 58/* Security Assocciation Index */ 59/* NOTE: Ensure to be same address family */ 60struct secasindex { 61 union sockaddr_union src; /* source address for SA */ 62 union sockaddr_union dst; /* destination address for SA */ 63 u_int16_t proto; /* IPPROTO_ESP or IPPROTO_AH */ 64 u_int8_t mode; /* mode of protocol, see ipsec.h */ 65 u_int32_t reqid; /* reqid id who owned this SA */ 66 /* see IPSEC_MANUAL_REQID_MAX. */ 67}; 68 69/* Security Association Data Base */ 70struct secashead { 71 struct pslist_entry pslist_entry; 72 struct localcount localcount; /* reference count */ 73 74 struct secasindex saidx; 75 76 struct sadb_ident *idents; /* source identity */ 77 struct sadb_ident *identd; /* destination identity */ 78 /* XXX I don't know how to use them. */ 79 size_t idents_len; /* length of idents */ 80 size_t identd_len; /* length of identd */ 81 82 u_int8_t state; /* MATURE or DEAD. */ 83 struct pslist_head savlist[SADB_SASTATE_MAX+1]; 84 /* SA chain */ 85 /* The first of this list is newer SA */ 86 87 struct route sa_route; /* route cache */ 88}; 89 90struct xformsw; 91struct enc_xform; 92struct auth_hash; 93struct comp_algo; 94 95/* Security Association */ 96struct secasvar { 97 struct pslist_entry pslist_entry; 98 struct localcount localcount; /* reference count */ 99 100 u_int8_t state; /* Status of this Association */ 101 102 u_int8_t alg_auth; /* Authentication Algorithm Identifier*/ 103 u_int8_t alg_enc; /* Cipher Algorithm Identifier */ 104 u_int8_t alg_comp; /* Compression Algorithm Identifier */ 105 u_int32_t spi; /* SPI Value, network byte order */ 106 u_int32_t flags; /* holder for SADB_KEY_FLAGS */ 107 108 struct sadb_key *key_auth; /* Key for Authentication */ 109 size_t key_auth_len; /* length of key_auth */ 110 struct sadb_key *key_enc; /* Key for Encryption */ 111 size_t key_enc_len; /* length of key_enc */ 112 u_int ivlen; /* length of IV */ 113 114 struct secreplay *replay; /* replay prevention */ 115 size_t replay_len; /* length of replay */ 116 time_t created; /* for lifetime */ 117 118 struct sadb_lifetime *lft_c; /* CURRENT lifetime, it's constant. */ 119 struct sadb_lifetime *lft_h; /* HARD lifetime */ 120 struct sadb_lifetime *lft_s; /* SOFT lifetime */ 121 122 /* percpu counters for lft_c->sadb_lifetime_{allocations,bytes} */ 123 percpu_t *lft_c_counters_percpu; 124 125 u_int32_t seq; /* sequence number */ 126 pid_t pid; /* message's pid */ 127 128 struct secashead *sah; /* back pointer to the secashead */ 129 130 /* 131 * NB: Fields with a tdb_ prefix are part of the "glue" used 132 * to interface to the OpenBSD crypto support. This was done 133 * to distinguish this code from the mainline KAME code. 134 */ 135 const struct xformsw *tdb_xform; /* transform */ 136 const struct enc_xform *tdb_encalgxform; /* encoding algorithm */ 137 const struct auth_hash *tdb_authalgxform; /* authentication algorithm */ 138 const struct comp_algo *tdb_compalgxform; /* compression algorithm */ 139 u_int64_t tdb_cryptoid; /* crypto session id */ 140 141 u_int16_t natt_type; 142 u_int16_t esp_frag; 143}; 144 145/* replay prevention */ 146struct secreplay { 147 u_int32_t count; 148 u_int wsize; /* window size, i.g. 4 bytes */ 149 u_int32_t seq; /* used by sender */ 150 u_int32_t lastseq; /* used by receiver */ 151 char *bitmap; /* used by receiver */ 152 int overflow; /* overflow flag */ 153}; 154 155/* socket table due to send PF_KEY messages. */ 156struct secreg { 157 LIST_ENTRY(secreg) chain; 158 159 struct socket *so; 160}; 161 162#ifndef IPSEC_NONBLOCK_ACQUIRE 163/* acquiring list table. */ 164struct secacq { 165 LIST_ENTRY(secacq) chain; 166 167 struct secasindex saidx; 168 169 u_int32_t seq; /* sequence number */ 170 time_t created; /* for lifetime */ 171 int count; /* for lifetime */ 172}; 173#endif 174 175/* Sensitivity Level Specification */ 176/* nothing */ 177 178#define SADB_KILL_INTERVAL 600 /* six seconds */ 179 180/* secpolicy */ 181struct secpolicy *keydb_newsecpolicy (void); 182void keydb_delsecpolicy (struct secpolicy *); 183/* secashead */ 184struct secashead *keydb_newsecashead (void); 185void keydb_delsecashead (struct secashead *); 186/* secasvar */ 187struct secasvar *keydb_newsecasvar (void); 188void keydb_refsecasvar (struct secasvar *); 189void keydb_freesecasvar (struct secasvar *); 190/* secreplay */ 191struct secreplay *keydb_newsecreplay (size_t); 192void keydb_delsecreplay (struct secreplay *); 193/* secreg */ 194struct secreg *keydb_newsecreg (void); 195void keydb_delsecreg (struct secreg *); 196 197#endif /* _KERNEL */ 198 199#endif /* !_NETIPSEC_KEYDB_H_ */ 200