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