kernel tree reorganization stage 1: Major cvs repository work (not logged as
[dragonfly.git] / sys / netinet6 / ipsec.h
CommitLineData
984263bc 1/* $FreeBSD: src/sys/netinet6/ipsec.h,v 1.4.2.4 2003/01/23 21:06:47 sam Exp $ */
d2438d69 2/* $DragonFly: src/sys/netinet6/ipsec.h,v 1.3 2003/08/07 21:54:33 dillon Exp $ */
984263bc
MD
3/* $KAME: ipsec.h,v 1.53 2001/11/20 08:32:38 itojun 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/*
35 * IPsec controller part.
36 */
37
38#ifndef _NETINET6_IPSEC_H_
39#define _NETINET6_IPSEC_H_
40
41#if defined(_KERNEL) && !defined(_LKM) && !defined(KLD_MODULE)
42#include "opt_inet.h"
43#include "opt_ipsec.h"
44#endif
45
46#include <net/pfkeyv2.h>
d2438d69 47#include <netproto/key/keydb.h>
984263bc
MD
48
49#ifdef _KERNEL
50
51/*
52 * Security Policy Index
53 * Ensure that both address families in the "src" and "dst" are same.
54 * When the value of the ul_proto is ICMPv6, the port field in "src"
55 * specifies ICMPv6 type, and the port field in "dst" specifies ICMPv6 code.
56 */
57struct secpolicyindex {
58 u_int8_t dir; /* direction of packet flow, see blow */
59 struct sockaddr_storage src; /* IP src address for SP */
60 struct sockaddr_storage dst; /* IP dst address for SP */
61 u_int8_t prefs; /* prefix length in bits for src */
62 u_int8_t prefd; /* prefix length in bits for dst */
63 u_int16_t ul_proto; /* upper layer Protocol */
64#ifdef notyet
65 uid_t uids;
66 uid_t uidd;
67 gid_t gids;
68 gid_t gidd;
69#endif
70};
71
72/* Security Policy Data Base */
73struct secpolicy {
74 LIST_ENTRY(secpolicy) chain;
75
76 int refcnt; /* reference count */
77 struct secpolicyindex spidx; /* selector */
78 u_int32_t id; /* It's unique number on the system. */
79 u_int state; /* 0: dead, others: alive */
80#define IPSEC_SPSTATE_DEAD 0
81#define IPSEC_SPSTATE_ALIVE 1
82
83 u_int policy; /* DISCARD, NONE or IPSEC, see keyv2.h */
84 struct ipsecrequest *req;
85 /* pointer to the ipsec request tree, */
86 /* if policy == IPSEC else this value == NULL.*/
87
88 /*
89 * lifetime handler.
90 * the policy can be used without limitiation if both lifetime and
91 * validtime are zero.
92 * "lifetime" is passed by sadb_lifetime.sadb_lifetime_addtime.
93 * "validtime" is passed by sadb_lifetime.sadb_lifetime_usetime.
94 */
95 long created; /* time created the policy */
96 long lastused; /* updated every when kernel sends a packet */
97 long lifetime; /* duration of the lifetime of this policy */
98 long validtime; /* duration this policy is valid without use */
99};
100
101/* Request for IPsec */
102struct ipsecrequest {
103 struct ipsecrequest *next;
104 /* pointer to next structure */
105 /* If NULL, it means the end of chain. */
106 struct secasindex saidx;/* hint for search proper SA */
107 /* if __ss_len == 0 then no address specified.*/
108 u_int level; /* IPsec level defined below. */
109
110 struct secasvar *sav; /* place holder of SA for use */
111 struct secpolicy *sp; /* back pointer to SP */
112};
113
114/* security policy in PCB */
115struct inpcbpolicy {
116 struct secpolicy *sp_in;
117 struct secpolicy *sp_out;
118 int priv; /* privileged socket ? */
119};
120
121/* SP acquiring list table. */
122struct secspacq {
123 LIST_ENTRY(secspacq) chain;
124
125 struct secpolicyindex spidx;
126
127 long created; /* for lifetime */
128 int count; /* for lifetime */
129 /* XXX: here is mbuf place holder to be sent ? */
130};
131#endif /* _KERNEL */
132
133/* according to IANA assignment, port 0x0000 and proto 0xff are reserved. */
134#define IPSEC_PORT_ANY 0
135#define IPSEC_ULPROTO_ANY 255
136#define IPSEC_PROTO_ANY 255
137
138/* mode of security protocol */
139/* NOTE: DON'T use IPSEC_MODE_ANY at SPD. It's only use in SAD */
140#define IPSEC_MODE_ANY 0 /* i.e. wildcard. */
141#define IPSEC_MODE_TRANSPORT 1
142#define IPSEC_MODE_TUNNEL 2
143
144/*
145 * Direction of security policy.
146 * NOTE: Since INVALID is used just as flag.
147 * The other are used for loop counter too.
148 */
149#define IPSEC_DIR_ANY 0
150#define IPSEC_DIR_INBOUND 1
151#define IPSEC_DIR_OUTBOUND 2
152#define IPSEC_DIR_MAX 3
153#define IPSEC_DIR_INVALID 4
154
155/* Policy level */
156/*
157 * IPSEC, ENTRUST and BYPASS are allowed for setsockopt() in PCB,
158 * DISCARD, IPSEC and NONE are allowed for setkey() in SPD.
159 * DISCARD and NONE are allowed for system default.
160 */
161#define IPSEC_POLICY_DISCARD 0 /* discarding packet */
162#define IPSEC_POLICY_NONE 1 /* through IPsec engine */
163#define IPSEC_POLICY_IPSEC 2 /* do IPsec */
164#define IPSEC_POLICY_ENTRUST 3 /* consulting SPD if present. */
165#define IPSEC_POLICY_BYPASS 4 /* only for privileged socket. */
166
167/* Security protocol level */
168#define IPSEC_LEVEL_DEFAULT 0 /* reference to system default */
169#define IPSEC_LEVEL_USE 1 /* use SA if present. */
170#define IPSEC_LEVEL_REQUIRE 2 /* require SA. */
171#define IPSEC_LEVEL_UNIQUE 3 /* unique SA. */
172
173#define IPSEC_MANUAL_REQID_MAX 0x3fff
174 /*
175 * if security policy level == unique, this id
176 * indicate to a relative SA for use, else is
177 * zero.
178 * 1 - 0x3fff are reserved for manual keying.
179 * 0 are reserved for above reason. Others is
180 * for kernel use.
181 * Note that this id doesn't identify SA
182 * by only itself.
183 */
184#define IPSEC_REPLAYWSIZE 32
185
186/* statistics for ipsec processing */
187struct ipsecstat {
188 u_quad_t in_success; /* succeeded inbound process */
189 u_quad_t in_polvio;
190 /* security policy violation for inbound process */
191 u_quad_t in_nosa; /* inbound SA is unavailable */
192 u_quad_t in_inval; /* inbound processing failed due to EINVAL */
193 u_quad_t in_nomem; /* inbound processing failed due to ENOBUFS */
194 u_quad_t in_badspi; /* failed getting a SPI */
195 u_quad_t in_ahreplay; /* AH replay check failed */
196 u_quad_t in_espreplay; /* ESP replay check failed */
197 u_quad_t in_ahauthsucc; /* AH authentication success */
198 u_quad_t in_ahauthfail; /* AH authentication failure */
199 u_quad_t in_espauthsucc; /* ESP authentication success */
200 u_quad_t in_espauthfail; /* ESP authentication failure */
201 u_quad_t in_esphist[256];
202 u_quad_t in_ahhist[256];
203 u_quad_t in_comphist[256];
204 u_quad_t out_success; /* succeeded outbound process */
205 u_quad_t out_polvio;
206 /* security policy violation for outbound process */
207 u_quad_t out_nosa; /* outbound SA is unavailable */
208 u_quad_t out_inval; /* outbound process failed due to EINVAL */
209 u_quad_t out_nomem; /* inbound processing failed due to ENOBUFS */
210 u_quad_t out_noroute; /* there is no route */
211 u_quad_t out_esphist[256];
212 u_quad_t out_ahhist[256];
213 u_quad_t out_comphist[256];
214};
215
216/*
217 * Definitions for IPsec & Key sysctl operations.
218 */
219/*
220 * Names for IPsec & Key sysctl objects
221 */
222#define IPSECCTL_STATS 1 /* stats */
223#define IPSECCTL_DEF_POLICY 2
224#define IPSECCTL_DEF_ESP_TRANSLEV 3 /* int; ESP transport mode */
225#define IPSECCTL_DEF_ESP_NETLEV 4 /* int; ESP tunnel mode */
226#define IPSECCTL_DEF_AH_TRANSLEV 5 /* int; AH transport mode */
227#define IPSECCTL_DEF_AH_NETLEV 6 /* int; AH tunnel mode */
228#if 0 /* obsolete, do not reuse */
229#define IPSECCTL_INBOUND_CALL_IKE 7
230#endif
231#define IPSECCTL_AH_CLEARTOS 8
232#define IPSECCTL_AH_OFFSETMASK 9
233#define IPSECCTL_DFBIT 10
234#define IPSECCTL_ECN 11
235#define IPSECCTL_DEBUG 12
236#define IPSECCTL_ESP_RANDPAD 13
237#define IPSECCTL_MAXID 14
238
239#define IPSECCTL_NAMES { \
240 { 0, 0 }, \
241 { 0, 0 }, \
242 { "def_policy", CTLTYPE_INT }, \
243 { "esp_trans_deflev", CTLTYPE_INT }, \
244 { "esp_net_deflev", CTLTYPE_INT }, \
245 { "ah_trans_deflev", CTLTYPE_INT }, \
246 { "ah_net_deflev", CTLTYPE_INT }, \
247 { 0, 0 }, \
248 { "ah_cleartos", CTLTYPE_INT }, \
249 { "ah_offsetmask", CTLTYPE_INT }, \
250 { "dfbit", CTLTYPE_INT }, \
251 { "ecn", CTLTYPE_INT }, \
252 { "debug", CTLTYPE_INT }, \
253 { "esp_randpad", CTLTYPE_INT }, \
254}
255
256#define IPSEC6CTL_NAMES { \
257 { 0, 0 }, \
258 { 0, 0 }, \
259 { "def_policy", CTLTYPE_INT }, \
260 { "esp_trans_deflev", CTLTYPE_INT }, \
261 { "esp_net_deflev", CTLTYPE_INT }, \
262 { "ah_trans_deflev", CTLTYPE_INT }, \
263 { "ah_net_deflev", CTLTYPE_INT }, \
264 { 0, 0 }, \
265 { 0, 0 }, \
266 { 0, 0 }, \
267 { 0, 0 }, \
268 { "ecn", CTLTYPE_INT }, \
269 { "debug", CTLTYPE_INT }, \
270 { "esp_randpad", CTLTYPE_INT }, \
271}
272
273#ifdef _KERNEL
274struct ipsec_output_state {
275 struct mbuf *m;
276 struct route *ro;
277 struct sockaddr *dst;
278};
279
280struct ipsec_history {
281 int ih_proto;
282 u_int32_t ih_spi;
283};
284
285extern int ipsec_debug;
286
287extern struct ipsecstat ipsecstat;
288extern struct secpolicy ip4_def_policy;
289extern int ip4_esp_trans_deflev;
290extern int ip4_esp_net_deflev;
291extern int ip4_ah_trans_deflev;
292extern int ip4_ah_net_deflev;
293extern int ip4_ah_cleartos;
294extern int ip4_ah_offsetmask;
295extern int ip4_ipsec_dfbit;
296extern int ip4_ipsec_ecn;
297extern int ip4_esp_randpad;
298
299#define ipseclog(x) do { if (ipsec_debug) log x; } while (0)
300
301extern struct secpolicy *ipsec4_getpolicybysock
302 __P((struct mbuf *, u_int, struct socket *, int *));
303extern struct secpolicy *ipsec4_getpolicybyaddr
304 __P((struct mbuf *, u_int, int, int *));
305
306struct inpcb;
307extern int ipsec_init_policy __P((struct socket *so, struct inpcbpolicy **));
308extern int ipsec_copy_policy
309 __P((struct inpcbpolicy *, struct inpcbpolicy *));
310extern u_int ipsec_get_reqlevel __P((struct ipsecrequest *));
311
312extern int ipsec4_set_policy __P((struct inpcb *inp, int optname,
313 caddr_t request, size_t len, int priv));
314extern int ipsec4_get_policy __P((struct inpcb *inpcb, caddr_t request,
315 size_t len, struct mbuf **mp));
316extern int ipsec4_delete_pcbpolicy __P((struct inpcb *));
317extern int ipsec4_in_reject_so __P((struct mbuf *, struct socket *));
318extern int ipsec4_in_reject __P((struct mbuf *, struct inpcb *));
319
320struct secas;
321struct tcpcb;
322extern int ipsec_chkreplay __P((u_int32_t, struct secasvar *));
323extern int ipsec_updatereplay __P((u_int32_t, struct secasvar *));
324
325extern size_t ipsec4_hdrsiz __P((struct mbuf *, u_int, struct inpcb *));
326extern size_t ipsec_hdrsiz_tcp __P((struct tcpcb *));
327
328struct ip;
329extern const char *ipsec4_logpacketstr __P((struct ip *, u_int32_t));
330extern const char *ipsec_logsastr __P((struct secasvar *));
331
332extern void ipsec_dumpmbuf __P((struct mbuf *));
333
334extern int ipsec4_output __P((struct ipsec_output_state *, struct secpolicy *,
335 int));
336extern int ipsec4_tunnel_validate __P((struct mbuf *, int, u_int,
337 struct secasvar *));
338extern struct mbuf *ipsec_copypkt __P((struct mbuf *));
339extern void ipsec_delaux __P((struct mbuf *));
340extern int ipsec_addhist __P((struct mbuf *, int, u_int32_t));
341extern struct ipsec_history *ipsec_gethist __P((struct mbuf *, int *));
342#endif /* _KERNEL */
343
344#ifndef _KERNEL
345extern caddr_t ipsec_set_policy __P((char *, int));
346extern int ipsec_get_policylen __P((caddr_t));
347extern char *ipsec_dump_policy __P((caddr_t, char *));
348
349extern const char *ipsec_strerror __P((void));
350#endif /* !_KERNEL */
351
352#endif /* _NETINET6_IPSEC_H_ */