2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
15 #ifndef __IPSEC_SPD_SA_H__
16 #define __IPSEC_SPD_SA_H__
18 #include <vlib/vlib.h>
19 #include <vnet/ip/ip.h>
20 #include <vnet/fib/fib_node.h>
22 #define IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE (64)
24 #define foreach_ipsec_crypto_alg \
26 _ (1, AES_CBC_128, "aes-cbc-128") \
27 _ (2, AES_CBC_192, "aes-cbc-192") \
28 _ (3, AES_CBC_256, "aes-cbc-256") \
29 _ (4, AES_CTR_128, "aes-ctr-128") \
30 _ (5, AES_CTR_192, "aes-ctr-192") \
31 _ (6, AES_CTR_256, "aes-ctr-256") \
32 _ (7, AES_GCM_128, "aes-gcm-128") \
33 _ (8, AES_GCM_192, "aes-gcm-192") \
34 _ (9, AES_GCM_256, "aes-gcm-256") \
35 _ (10, DES_CBC, "des-cbc") \
36 _ (11, 3DES_CBC, "3des-cbc")
40 #define _(v, f, s) IPSEC_CRYPTO_ALG_##f = v,
41 foreach_ipsec_crypto_alg
46 #define IPSEC_CRYPTO_ALG_IS_GCM(_alg) \
47 (((_alg == IPSEC_CRYPTO_ALG_AES_GCM_128) || \
48 (_alg == IPSEC_CRYPTO_ALG_AES_GCM_192) || \
49 (_alg == IPSEC_CRYPTO_ALG_AES_GCM_256)))
51 #define foreach_ipsec_integ_alg \
53 _ (1, MD5_96, "md5-96") /* RFC2403 */ \
54 _ (2, SHA1_96, "sha1-96") /* RFC2404 */ \
55 _ (3, SHA_256_96, "sha-256-96") /* draft-ietf-ipsec-ciph-sha-256-00 */ \
56 _ (4, SHA_256_128, "sha-256-128") /* RFC4868 */ \
57 _ (5, SHA_384_192, "sha-384-192") /* RFC4868 */ \
58 _ (6, SHA_512_256, "sha-512-256") /* RFC4868 */
62 #define _(v, f, s) IPSEC_INTEG_ALG_##f = v,
63 foreach_ipsec_integ_alg
70 IPSEC_PROTOCOL_AH = 0,
71 IPSEC_PROTOCOL_ESP = 1
74 #define IPSEC_KEY_MAX_LEN 128
75 typedef struct ipsec_key_t_
78 u8 data[IPSEC_KEY_MAX_LEN];
82 * Enable extended sequence numbers
84 * IPsec tunnel mode if non-zero, else transport mode
85 * IPsec tunnel mode is IPv6 if non-zero,
86 * else IPv4 tunnel only valid if is_tunnel is non-zero
87 * enable UDP encapsulation for NAT traversal
89 #define foreach_ipsec_sa_flags \
91 _ (1, USE_ESN, "esn") \
92 _ (2, USE_ANTI_REPLAY, "anti-replay") \
93 _ (4, IS_TUNNEL, "tunnel") \
94 _ (8, IS_TUNNEL_V6, "tunnel-v6") \
95 _ (16, UDP_ENCAP, "udp-encap") \
96 _ (32, IS_PROTECT, "Protect") \
97 _ (64, IS_INBOUND, "inboud") \
98 _ (128, IS_AEAD, "aead") \
100 typedef enum ipsec_sad_flags_t_
102 #define _(v, f, s) IPSEC_SA_FLAG_##f = v,
103 foreach_ipsec_sa_flags
105 } __clib_packed ipsec_sa_flags_t;
107 STATIC_ASSERT (sizeof (ipsec_sa_flags_t) == 1, "IPSEC SA flags > 1 byte");
111 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
114 ipsec_sa_flags_t flags;
117 u8 crypto_block_size;
127 vnet_crypto_key_index_t crypto_key_index;
128 vnet_crypto_key_index_t integ_key_index;
129 vnet_crypto_op_id_t crypto_enc_op_id:16;
130 vnet_crypto_op_id_t crypto_dec_op_id:16;
131 vnet_crypto_op_id_t integ_op_id:16;
133 /* data accessed by dataplane code should be above this comment */
134 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
138 ip4_header_t ip4_hdr;
139 ip6_header_t ip6_hdr;
141 udp_header_t udp_hdr;
146 ipsec_protocol_t protocol;
148 ipsec_crypto_alg_t crypto_alg;
149 ipsec_key_t crypto_key;
150 vnet_crypto_alg_t crypto_calg;
152 ipsec_integ_alg_t integ_alg;
153 ipsec_key_t integ_key;
154 vnet_crypto_alg_t integ_calg;
156 ip46_address_t tunnel_src_addr;
157 ip46_address_t tunnel_dst_addr;
159 fib_node_index_t fib_entry_index;
164 /* Salt used in GCM modes - stored in network byte order */
169 STATIC_ASSERT_OFFSET_OF (ipsec_sa_t, cacheline1, CLIB_CACHE_LINE_BYTES);
173 ipsec_sa_is_set_##v (const ipsec_sa_t *sa) { \
174 return (sa->flags & IPSEC_SA_FLAG_##v); \
176 foreach_ipsec_sa_flags
180 ipsec_sa_set_##v (ipsec_sa_t *sa) { \
181 return (sa->flags |= IPSEC_SA_FLAG_##v); \
183 foreach_ipsec_sa_flags
187 ipsec_sa_unset_##v (ipsec_sa_t *sa) { \
188 return (sa->flags &= ~IPSEC_SA_FLAG_##v); \
190 foreach_ipsec_sa_flags
194 * SA packet & bytes counters
196 extern vlib_combined_counter_main_t ipsec_sa_counters;
198 extern void ipsec_mk_key (ipsec_key_t * key, const u8 * data, u8 len);
200 extern int ipsec_sa_add_and_lock (u32 id,
202 ipsec_protocol_t proto,
203 ipsec_crypto_alg_t crypto_alg,
204 const ipsec_key_t * ck,
205 ipsec_integ_alg_t integ_alg,
206 const ipsec_key_t * ik,
207 ipsec_sa_flags_t flags,
210 const ip46_address_t * tunnel_src_addr,
211 const ip46_address_t * tunnel_dst_addr,
213 extern index_t ipsec_sa_find_and_lock (u32 id);
214 extern int ipsec_sa_unlock_id (u32 id);
215 extern void ipsec_sa_unlock (index_t sai);
216 extern void ipsec_sa_clear (index_t sai);
217 extern void ipsec_sa_set_crypto_alg (ipsec_sa_t * sa,
218 ipsec_crypto_alg_t crypto_alg);
219 extern void ipsec_sa_set_integ_alg (ipsec_sa_t * sa,
220 ipsec_integ_alg_t integ_alg);
222 typedef walk_rc_t (*ipsec_sa_walk_cb_t) (ipsec_sa_t * sa, void *ctx);
223 extern void ipsec_sa_walk (ipsec_sa_walk_cb_t cd, void *ctx);
225 extern u8 *format_ipsec_crypto_alg (u8 * s, va_list * args);
226 extern u8 *format_ipsec_integ_alg (u8 * s, va_list * args);
227 extern u8 *format_ipsec_sa (u8 * s, va_list * args);
228 extern u8 *format_ipsec_key (u8 * s, va_list * args);
229 extern uword unformat_ipsec_crypto_alg (unformat_input_t * input,
231 extern uword unformat_ipsec_integ_alg (unformat_input_t * input,
233 extern uword unformat_ipsec_key (unformat_input_t * input, va_list * args);
236 ipsec_sa_anti_replay_check (ipsec_sa_t * sa, u32 * seqp)
238 u32 seq, diff, tl, th;
239 if ((sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
242 seq = clib_net_to_host_u32 (*seqp);
244 if ((sa->flags & IPSEC_SA_FLAG_USE_ESN) == 0)
247 if (PREDICT_TRUE (seq > sa->last_seq))
250 diff = sa->last_seq - seq;
252 if (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE > diff)
253 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
261 th = sa->last_seq_hi;
264 if (PREDICT_TRUE (tl >= (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE - 1)))
266 if (seq >= (tl - IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE + 1))
270 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
282 if (seq >= (tl - IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE + 1))
285 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
291 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
301 ipsec_sa_anti_replay_advance (ipsec_sa_t * sa, u32 seqp)
304 if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
307 seq = clib_host_to_net_u32 (seqp);
308 if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ESN))
310 int wrap = sa->seq_hi - sa->last_seq_hi;
312 if (wrap == 0 && seq > sa->last_seq)
314 pos = seq - sa->last_seq;
315 if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
316 sa->replay_window = ((sa->replay_window) << pos) | 1;
318 sa->replay_window = 1;
323 pos = ~seq + sa->last_seq + 1;
324 if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
325 sa->replay_window = ((sa->replay_window) << pos) | 1;
327 sa->replay_window = 1;
329 sa->last_seq_hi = sa->seq_hi;
333 pos = ~seq + sa->last_seq + 1;
334 sa->replay_window |= (1ULL << pos);
338 pos = sa->last_seq - seq;
339 sa->replay_window |= (1ULL << pos);
344 if (seq > sa->last_seq)
346 pos = seq - sa->last_seq;
347 if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
348 sa->replay_window = ((sa->replay_window) << pos) | 1;
350 sa->replay_window = 1;
355 pos = sa->last_seq - seq;
356 sa->replay_window |= (1ULL << pos);
361 #endif /* __IPSEC_SPD_SA_H__ */
364 * fd.io coding-style-patch-verification: ON
367 * eval: (c-set-style "gnu")