1 /* $KAME: ipsec.h,v 1.53 2001/11/20 08:32:38 itojun Exp $ */
4 * SPDX-License-Identifier: BSD-3-Clause
6 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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.
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
35 * IPsec controller part.
38 #ifndef _NETIPSEC_IPSEC_H_
39 #define _NETIPSEC_IPSEC_H_
41 #include <net/pfkeyv2.h>
42 #include <netipsec/keydb.h>
46 #include <sys/_lock.h>
47 #include <sys/_mutex.h>
48 #include <sys/_rwlock.h>
50 #define IPSEC_ASSERT(_c,_m) KASSERT(_c, _m)
53 * Security Policy Index
54 * Ensure that both address families in the "src" and "dst" are same.
55 * When the value of the ul_proto is ICMPv6, the port field in "src"
56 * specifies ICMPv6 type, and the port field in "dst" specifies ICMPv6 code.
58 struct secpolicyindex {
59 union sockaddr_union src; /* IP src address for SP */
60 union sockaddr_union dst; /* IP dst address for SP */
61 uint8_t ul_proto; /* upper layer Protocol */
62 uint8_t dir; /* direction of packet flow */
63 uint8_t prefs; /* prefix length in bits for src */
64 uint8_t prefd; /* prefix length in bits for dst */
67 /* Request for IPsec */
69 struct secasindex saidx;/* hint for search proper SA */
70 /* if __ss_len == 0 then no address specified.*/
71 u_int level; /* IPsec level defined below. */
74 /* Security Policy Data Base */
76 TAILQ_ENTRY(secpolicy) chain;
77 LIST_ENTRY(secpolicy) idhash;
78 LIST_ENTRY(secpolicy) drainq;
80 struct secpolicyindex spidx; /* selector */
81 #define IPSEC_MAXREQ 4
82 struct ipsecrequest *req[IPSEC_MAXREQ];
83 u_int tcount; /* IPsec transforms count */
84 volatile u_int refcnt; /* reference count */
85 u_int policy; /* policy_type per pfkeyv2.h */
87 #define IPSEC_SPSTATE_DEAD 0
88 #define IPSEC_SPSTATE_LARVAL 1
89 #define IPSEC_SPSTATE_ALIVE 2
90 #define IPSEC_SPSTATE_PCB 3
91 #define IPSEC_SPSTATE_IFNET 4
92 uint32_t priority; /* priority of this policy */
93 uint32_t id; /* It's unique number on the system. */
96 * the policy can be used without limitiation if both lifetime and
98 * "lifetime" is passed by sadb_lifetime.sadb_lifetime_addtime.
99 * "validtime" is passed by sadb_lifetime.sadb_lifetime_usetime.
101 time_t created; /* time created the policy */
102 time_t lastused; /* updated every when kernel sends a packet */
103 long lifetime; /* duration of the lifetime of this policy */
104 long validtime; /* duration this policy is valid without use */
108 * PCB security policies.
109 * Application can setup private security policies for socket.
110 * Such policies can have IPSEC, BYPASS and ENTRUST type.
111 * By default, policies are set to NULL. This means that they have ENTRUST type.
112 * When application sets BYPASS or IPSEC type policy, the flags field
113 * is also updated. When flags is not set, the system could store
114 * used security policy into the sp_in/sp_out pointer to speed up further
118 struct secpolicy *sp_in;
119 struct secpolicy *sp_out;
123 #define INP_INBOUND_POLICY 0x0001
124 #define INP_OUTBOUND_POLICY 0x0002
128 /* SP acquiring list table. */
130 LIST_ENTRY(secspacq) chain;
132 struct secpolicyindex spidx;
134 time_t created; /* for lifetime */
135 int count; /* for lifetime */
136 /* XXX: here is mbuf place holder to be sent ? */
140 /* buffer size for formatted output of ipsec address */
141 #define IPSEC_ADDRSTRLEN (INET6_ADDRSTRLEN + 11)
143 /* according to IANA assignment, port 0x0000 and proto 0xff are reserved. */
144 #define IPSEC_PORT_ANY 0
145 #define IPSEC_ULPROTO_ANY 255
146 #define IPSEC_PROTO_ANY 255
148 /* mode of security protocol */
149 /* NOTE: DON'T use IPSEC_MODE_ANY at SPD. It's only use in SAD */
150 #define IPSEC_MODE_ANY 0 /* i.e. wildcard. */
151 #define IPSEC_MODE_TRANSPORT 1
152 #define IPSEC_MODE_TUNNEL 2
153 #define IPSEC_MODE_TCPMD5 3 /* TCP MD5 mode */
156 * Direction of security policy.
157 * NOTE: Since INVALID is used just as flag.
158 * The other are used for loop counter too.
160 #define IPSEC_DIR_ANY 0
161 #define IPSEC_DIR_INBOUND 1
162 #define IPSEC_DIR_OUTBOUND 2
163 #define IPSEC_DIR_MAX 3
164 #define IPSEC_DIR_INVALID 4
168 * IPSEC, ENTRUST and BYPASS are allowed for setsockopt() in PCB,
169 * DISCARD, IPSEC and NONE are allowed for setkey() in SPD.
170 * DISCARD and NONE are allowed for system default.
172 #define IPSEC_POLICY_DISCARD 0 /* discarding packet */
173 #define IPSEC_POLICY_NONE 1 /* through IPsec engine */
174 #define IPSEC_POLICY_IPSEC 2 /* do IPsec */
175 #define IPSEC_POLICY_ENTRUST 3 /* consulting SPD if present. */
176 #define IPSEC_POLICY_BYPASS 4 /* only for privileged socket. */
179 #define IPSEC_POLICYSCOPE_ANY 0x00 /* unspecified */
180 #define IPSEC_POLICYSCOPE_GLOBAL 0x01 /* global scope */
181 #define IPSEC_POLICYSCOPE_IFNET 0x02 /* if_ipsec(4) scope */
182 #define IPSEC_POLICYSCOPE_PCB 0x04 /* PCB scope */
184 /* Security protocol level */
185 #define IPSEC_LEVEL_DEFAULT 0 /* reference to system default */
186 #define IPSEC_LEVEL_USE 1 /* use SA if present. */
187 #define IPSEC_LEVEL_REQUIRE 2 /* require SA. */
188 #define IPSEC_LEVEL_UNIQUE 3 /* unique SA. */
190 #define IPSEC_MANUAL_REQID_MAX 0x3fff
192 * if security policy level == unique, this id
193 * indicate to a relative SA for use, else is
195 * 1 - 0x3fff are reserved for manual keying.
196 * 0 are reserved for above reason. Others is
198 * Note that this id doesn't identify SA
201 #define IPSEC_REPLAYWSIZE 32
203 /* statistics for ipsec processing */
205 uint64_t ips_in_polvio; /* input: sec policy violation */
206 uint64_t ips_in_nomem; /* input: no memory available */
207 uint64_t ips_in_inval; /* input: generic error */
209 uint64_t ips_out_polvio; /* output: sec policy violation */
210 uint64_t ips_out_nosa; /* output: SA unavailable */
211 uint64_t ips_out_nomem; /* output: no memory available */
212 uint64_t ips_out_noroute; /* output: no route available */
213 uint64_t ips_out_inval; /* output: generic error */
214 uint64_t ips_out_bundlesa; /* output: bundled SA processed */
216 uint64_t ips_spdcache_hits; /* SPD cache hits */
217 uint64_t ips_spdcache_misses; /* SPD cache misses */
219 uint64_t ips_clcopied; /* clusters copied during clone */
220 uint64_t ips_mbinserted; /* mbufs inserted during makespace */
222 * Temporary statistics for performance analysis.
224 /* See where ESP/AH/IPCOMP header land in mbuf on input */
225 uint64_t ips_input_front;
226 uint64_t ips_input_middle;
227 uint64_t ips_input_end;
231 * Definitions for IPsec & Key sysctl operations.
233 #define IPSECCTL_STATS 1 /* stats */
234 #define IPSECCTL_DEF_POLICY 2
235 #define IPSECCTL_DEF_ESP_TRANSLEV 3 /* int; ESP transport mode */
236 #define IPSECCTL_DEF_ESP_NETLEV 4 /* int; ESP tunnel mode */
237 #define IPSECCTL_DEF_AH_TRANSLEV 5 /* int; AH transport mode */
238 #define IPSECCTL_DEF_AH_NETLEV 6 /* int; AH tunnel mode */
239 #if 0 /* obsolete, do not reuse */
240 #define IPSECCTL_INBOUND_CALL_IKE 7
242 #define IPSECCTL_AH_CLEARTOS 8
243 #define IPSECCTL_AH_OFFSETMASK 9
244 #define IPSECCTL_DFBIT 10
245 #define IPSECCTL_ECN 11
246 #define IPSECCTL_DEBUG 12
247 #define IPSECCTL_ESP_RANDPAD 13
248 #define IPSECCTL_MIN_PMTU 14
251 #include <sys/counter.h>
253 struct ipsec_ctx_data;
254 #define IPSEC_INIT_CTX(_ctx, _mp, _inp, _sav, _af, _enc) do { \
255 (_ctx)->mp = (_mp); \
256 (_ctx)->inp = (_inp); \
257 (_ctx)->sav = (_sav); \
258 (_ctx)->af = (_af); \
259 (_ctx)->enc = (_enc); \
261 int ipsec_run_hhooks(struct ipsec_ctx_data *ctx, int direction);
263 VNET_DECLARE(int, ipsec_debug);
264 #define V_ipsec_debug VNET(ipsec_debug)
267 VNET_DECLARE(int, ipsec_replay);
268 VNET_DECLARE(int, ipsec_integrity);
270 #define V_ipsec_replay VNET(ipsec_replay)
271 #define V_ipsec_integrity VNET(ipsec_integrity)
274 VNET_PCPUSTAT_DECLARE(struct ipsecstat, ipsec4stat);
275 VNET_DECLARE(int, ip4_esp_trans_deflev);
276 VNET_DECLARE(int, ip4_esp_net_deflev);
277 VNET_DECLARE(int, ip4_ah_trans_deflev);
278 VNET_DECLARE(int, ip4_ah_net_deflev);
279 VNET_DECLARE(int, ip4_ipsec_dfbit);
280 VNET_DECLARE(int, ip4_ipsec_min_pmtu);
281 VNET_DECLARE(int, ip4_ipsec_ecn);
282 VNET_DECLARE(int, crypto_support);
283 VNET_DECLARE(int, async_crypto);
284 VNET_DECLARE(int, natt_cksum_policy);
286 #define IPSECSTAT_INC(name) \
287 VNET_PCPUSTAT_ADD(struct ipsecstat, ipsec4stat, name, 1)
288 #define V_ip4_esp_trans_deflev VNET(ip4_esp_trans_deflev)
289 #define V_ip4_esp_net_deflev VNET(ip4_esp_net_deflev)
290 #define V_ip4_ah_trans_deflev VNET(ip4_ah_trans_deflev)
291 #define V_ip4_ah_net_deflev VNET(ip4_ah_net_deflev)
292 #define V_ip4_ipsec_dfbit VNET(ip4_ipsec_dfbit)
293 #define V_ip4_ipsec_min_pmtu VNET(ip4_ipsec_min_pmtu)
294 #define V_ip4_ipsec_ecn VNET(ip4_ipsec_ecn)
295 #define V_crypto_support VNET(crypto_support)
296 #define V_async_crypto VNET(async_crypto)
297 #define V_natt_cksum_policy VNET(natt_cksum_policy)
299 #define ipseclog(x) do { if (V_ipsec_debug) log x; } while (0)
300 /* for openbsd compatibility */
302 #define IPSEC_DEBUG_DECLARE(x) x
303 #define DPRINTF(x) do { if (V_ipsec_debug) printf x; } while (0)
305 #define IPSEC_DEBUG_DECLARE(x)
314 union sockaddr_union;
316 int ipsec_if_input(struct mbuf *, struct secasvar *, uint32_t);
318 struct ipsecrequest *ipsec_newisr(void);
319 void ipsec_delisr(struct ipsecrequest *);
320 struct secpolicy *ipsec4_checkpolicy(const struct mbuf *, struct inpcb *,
323 u_int ipsec_get_reqlevel(struct secpolicy *, u_int);
325 void udp_ipsec_adjust_cksum(struct mbuf *, struct secasvar *, int, int);
326 int udp_ipsec_output(struct mbuf *, struct secasvar *);
328 int ipsec_chkreplay(uint32_t, uint32_t *, struct secasvar *);
329 int ipsec_updatereplay(uint32_t, struct secasvar *);
330 int ipsec_updateid(struct secasvar *, crypto_session_t *, crypto_session_t *);
331 int ipsec_initialized(void);
332 size_t ipsec_hdrsiz_internal(struct secpolicy *);
334 void ipsec_setspidx_inpcb(struct inpcb *, struct secpolicyindex *, u_int);
336 void ipsec4_setsockaddrs(const struct mbuf *, union sockaddr_union *,
337 union sockaddr_union *);
338 int ipsec4_common_input_cb(struct mbuf *, struct secasvar *, int, int);
339 int ipsec4_check_pmtu(struct mbuf *, struct secpolicy *, int);
340 int ipsec4_process_packet(struct mbuf *, struct secpolicy *, struct inpcb *);
341 int ipsec_process_done(struct mbuf *, struct secpolicy *, struct secasvar *,
344 extern void m_checkalignment(const char* where, struct mbuf *m0,
346 extern struct mbuf *m_makespace(struct mbuf *m0, int skip, int hlen, int *off);
347 extern caddr_t m_pad(struct mbuf *m, int n);
348 extern int m_striphdr(struct mbuf *m, int skip, int hlen);
353 extern caddr_t ipsec_set_policy(char *, int);
354 extern int ipsec_get_policylen(caddr_t);
355 extern char *ipsec_dump_policy(caddr_t, char *);
356 extern const char *ipsec_strerror(void);
358 #endif /* ! KERNEL */
360 #endif /* _NETIPSEC_IPSEC_H_ */