]> git.saurik.com Git - apple/xnu.git/blame - bsd/netkey/keydb.h
xnu-2422.115.4.tar.gz
[apple/xnu.git] / bsd / netkey / keydb.h
CommitLineData
1c79356b
A
1/* $KAME: keydb.h,v 1.9 2000/02/22 14:06:41 itojun Exp $ */
2
3/*
4 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the project nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 */
31
32#ifndef _NETKEY_KEYDB_H_
33#define _NETKEY_KEYDB_H_
9bccf70c 34#include <sys/appleapiopts.h>
1c79356b 35
39236c6e 36#ifdef BSD_KERNEL_PRIVATE
1c79356b
A
37
38#include <netkey/key_var.h>
316670eb 39#include <net/if_utun.h>
1c79356b
A
40
41/* Security Assocciation Index */
42/* NOTE: Ensure to be same address family */
43struct 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 */
53struct 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
b0d623f7 62 u_int8_t dir; /* IPSEC_DIR_INBOUND or IPSEC_DIR_OUTBOUND */
1c79356b
A
63 u_int8_t state; /* MATURE or DEAD. */
64 LIST_HEAD(_satree, secasvar) savtree[SADB_SASTATE_MAX+1];
65 /* SA chain */
66 /* The first of this list is newer SA */
67
68 struct route sa_route; /* route cache */
69};
70
316670eb
A
71typedef int (*utun_is_keepalive_func) __P((void *, void *, u_int16_t, u_int32_t, size_t));
72typedef int (*utun_input_func) __P((void *, void *, protocol_family_t family));
73
1c79356b
A
74/* Security Association */
75struct secasvar {
76 LIST_ENTRY(secasvar) chain;
91447636 77 LIST_ENTRY(secasvar) spihash;
1c79356b
A
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 */
1c79356b 87 struct sadb_key *key_enc; /* Key for Encryption */
1c79356b
A
88 caddr_t iv; /* Initilization Vector */
89 u_int ivlen; /* length of IV */
9bccf70c
A
90 void *sched; /* intermediate encryption key */
91 size_t schedlen;
1c79356b
A
92
93 struct secreplay *replay; /* replay prevention */
9bccf70c 94 long created; /* for lifetime */
1c79356b
A
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 */
55e303ae
A
104
105 /* Nat Traversal related bits */
106 u_int32_t natt_last_activity;
107 u_int16_t remote_ike_port;
2d21ac55 108 u_int16_t natt_encapsulated_src_port; /* network byte order */
39236c6e
A
109
110 u_int8_t always_expire; /* Send expire/delete messages even if unused */
316670eb
A
111
112 void *utun_pcb;
113 utun_is_keepalive_func utun_is_keepalive_fn;
114 utun_input_func utun_in_fn;
1c79356b
A
115};
116
117/* replay prevention */
118struct secreplay {
119 u_int32_t count;
120 u_int wsize; /* window size, i.g. 4 bytes */
121 u_int32_t seq; /* used by sender */
122 u_int32_t lastseq; /* used by receiver */
123 caddr_t bitmap; /* used by receiver */
124 int overflow; /* overflow flag */
125};
126
127/* socket table due to send PF_KEY messages. */
128struct secreg {
129 LIST_ENTRY(secreg) chain;
130
131 struct socket *so;
132};
133
134#ifndef IPSEC_NONBLOCK_ACQUIRE
135/* acquiring list table. */
136struct secacq {
137 LIST_ENTRY(secacq) chain;
138
139 struct secasindex saidx;
140
141 u_int32_t seq; /* sequence number */
9bccf70c 142 long created; /* for lifetime */
1c79356b
A
143 int count; /* for lifetime */
144};
145#endif
146
147/* Sensitivity Level Specification */
148/* nothing */
149
150#define SADB_KILL_INTERVAL 600 /* six seconds */
151
152struct key_cb {
153 int key_count;
154 int any_count;
155};
156
157/* secpolicy */
91447636
A
158extern struct secpolicy *keydb_newsecpolicy(void);
159extern void keydb_delsecpolicy(struct secpolicy *);
1c79356b 160/* secashead */
91447636 161extern struct secashead *keydb_newsecashead(void);
2d21ac55 162// extern void keydb_delsecashead(struct secashead *); // not used
1c79356b 163/* secasvar */
2d21ac55
A
164// extern struct secasvar *keydb_newsecasvar(void); // not used
165// extern void keydb_refsecasvar(struct secasvar *); // not used
166// extern void keydb_freesecasvar(struct secasvar *); // not used
1c79356b 167/* secreplay */
91447636
A
168extern struct secreplay *keydb_newsecreplay(size_t);
169extern void keydb_delsecreplay(struct secreplay *);
1c79356b 170/* secreg */
2d21ac55
A
171// extern struct secreg *keydb_newsecreg(void); // not used
172// extern void keydb_delsecreg(struct secreg *); // not used
1c79356b 173
39236c6e 174#endif /* BSD_KERNEL_PRIVATE */
1c79356b
A
175
176#endif /* _NETKEY_KEYDB_H_ */