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