- Rewrite Buffer object to maintain only write pointer. There is no
[dragonfly.git] / sys / netproto / key / keydb.h
1 /*      $FreeBSD: src/sys/netkey/keydb.h,v 1.2.2.3 2003/01/11 19:10:59 ume Exp $        */
2 /*      $DragonFly: src/sys/netproto/key/keydb.h,v 1.4 2003/08/23 10:06:24 rob 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 _NETKEY_KEYDB_H_
35 #define _NETKEY_KEYDB_H_
36
37 #ifdef _KERNEL
38
39 #include "key_var.h"
40
41 /* Security Assocciation Index */
42 /* NOTE: Ensure to be same address family */
43 struct secasindex {
44         struct sockaddr_storage src;    /* srouce address for SA */
45         struct sockaddr_storage dst;    /* destination address for SA */
46         u_int16_t proto;                /* IPPROTO_ESP or IPPROTO_AH */
47         u_int8_t mode;                  /* mode of protocol, see ipsec.h */
48         u_int32_t reqid;                /* reqid id who owned this SA */
49                                         /* see IPSEC_MANUAL_REQID_MAX. */
50 };
51
52 /* Security Association Data Base */
53 struct secashead {
54         LIST_ENTRY(secashead) chain;
55
56         struct secasindex saidx;
57
58         struct sadb_ident *idents;      /* source identity */
59         struct sadb_ident *identd;      /* destination identity */
60                                         /* XXX I don't know how to use them. */
61
62         u_int8_t state;                 /* MATURE or DEAD. */
63         LIST_HEAD(_satree, secasvar) savtree[SADB_SASTATE_MAX+1];
64                                         /* SA chain */
65                                         /* The first of this list is newer SA */
66
67         union {
68                 struct route sau_route;
69                 struct route_in6 sau_route6;
70         } sa_u;
71 #define sa_route sa_u.sau_route
72 };
73
74 /* Security Association */
75 struct secasvar {
76         LIST_ENTRY(secasvar) chain;
77
78         int refcnt;                     /* reference count */
79         u_int8_t state;                 /* Status of this Association */
80
81         u_int8_t alg_auth;              /* Authentication Algorithm Identifier*/
82         u_int8_t alg_enc;               /* Cipher Algorithm Identifier */
83         u_int32_t spi;                  /* SPI Value, network byte order */
84         u_int32_t flags;                /* holder for SADB_KEY_FLAGS */
85
86         struct sadb_key *key_auth;      /* Key for Authentication */
87         struct sadb_key *key_enc;       /* Key for Encryption */
88         caddr_t iv;                     /* Initilization Vector */
89         u_int ivlen;                    /* length of IV */
90         void *sched;                    /* intermediate encryption key */
91         size_t schedlen;
92
93         struct secreplay *replay;       /* replay prevention */
94         long created;                   /* for lifetime */
95
96         struct sadb_lifetime *lft_c;    /* CURRENT lifetime, it's constant. */
97         struct sadb_lifetime *lft_h;    /* HARD lifetime */
98         struct sadb_lifetime *lft_s;    /* SOFT lifetime */
99
100         u_int32_t seq;                  /* sequence number */
101         pid_t pid;                      /* message's pid */
102
103         struct secashead *sah;          /* back pointer to the secashead */
104 };
105
106 /* replay prevention */
107 struct secreplay {
108         u_int32_t count;
109         u_int wsize;            /* window size, i.g. 4 bytes */
110         u_int32_t seq;          /* used by sender */
111         u_int32_t lastseq;      /* used by receiver */
112         caddr_t bitmap;         /* used by receiver */
113         int overflow;           /* overflow flag */
114 };
115
116 /* socket table due to send PF_KEY messages. */
117 struct secreg {
118         LIST_ENTRY(secreg) chain;
119
120         struct socket *so;
121 };
122
123 #ifndef IPSEC_NONBLOCK_ACQUIRE
124 /* acquiring list table. */
125 struct secacq {
126         LIST_ENTRY(secacq) chain;
127
128         struct secasindex saidx;
129
130         u_int32_t seq;          /* sequence number */
131         long created;           /* for lifetime */
132         int count;              /* for lifetime */
133 };
134 #endif
135
136 /* Sensitivity Level Specification */
137 /* nothing */
138
139 #define SADB_KILL_INTERVAL      600     /* six seconds */
140
141 struct key_cb {
142         int key_count;
143         int any_count;
144 };
145
146 /* secpolicy */
147 extern struct secpolicy *keydb_newsecpolicy (void);
148 extern void keydb_delsecpolicy (struct secpolicy *);
149 /* secashead */
150 extern struct secashead *keydb_newsecashead (void);
151 extern void keydb_delsecashead (struct secashead *);
152 /* secasvar */
153 extern struct secasvar *keydb_newsecasvar (void);
154 extern void keydb_refsecasvar (struct secasvar *);
155 extern void keydb_freesecasvar (struct secasvar *);
156 /* secreplay */
157 extern struct secreplay *keydb_newsecreplay (size_t);
158 extern void keydb_delsecreplay (struct secreplay *);
159 /* secreg */
160 extern struct secreg *keydb_newsecreg (void);
161 extern void keydb_delsecreg (struct secreg *);
162
163 #endif /* _KERNEL */
164
165 #endif /* _NETKEY_KEYDB_H_ */