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/crypto/crypto.h>
20 #include <vnet/ip/ip.h>
21 #include <vnet/fib/fib_node.h>
23 #define foreach_ipsec_crypto_alg \
25 _ (1, AES_CBC_128, "aes-cbc-128") \
26 _ (2, AES_CBC_192, "aes-cbc-192") \
27 _ (3, AES_CBC_256, "aes-cbc-256") \
28 _ (4, AES_CTR_128, "aes-ctr-128") \
29 _ (5, AES_CTR_192, "aes-ctr-192") \
30 _ (6, AES_CTR_256, "aes-ctr-256") \
31 _ (7, AES_GCM_128, "aes-gcm-128") \
32 _ (8, AES_GCM_192, "aes-gcm-192") \
33 _ (9, AES_GCM_256, "aes-gcm-256") \
34 _ (10, DES_CBC, "des-cbc") \
35 _ (11, 3DES_CBC, "3des-cbc")
39 #define _(v, f, s) IPSEC_CRYPTO_ALG_##f = v,
40 foreach_ipsec_crypto_alg
43 } __clib_packed ipsec_crypto_alg_t;
45 #define IPSEC_CRYPTO_ALG_IS_GCM(_alg) \
46 (((_alg == IPSEC_CRYPTO_ALG_AES_GCM_128) || \
47 (_alg == IPSEC_CRYPTO_ALG_AES_GCM_192) || \
48 (_alg == IPSEC_CRYPTO_ALG_AES_GCM_256)))
50 #define foreach_ipsec_integ_alg \
52 _ (1, MD5_96, "md5-96") /* RFC2403 */ \
53 _ (2, SHA1_96, "sha1-96") /* RFC2404 */ \
54 _ (3, SHA_256_96, "sha-256-96") /* draft-ietf-ipsec-ciph-sha-256-00 */ \
55 _ (4, SHA_256_128, "sha-256-128") /* RFC4868 */ \
56 _ (5, SHA_384_192, "sha-384-192") /* RFC4868 */ \
57 _ (6, SHA_512_256, "sha-512-256") /* RFC4868 */
61 #define _(v, f, s) IPSEC_INTEG_ALG_##f = v,
62 foreach_ipsec_integ_alg
65 } __clib_packed ipsec_integ_alg_t;
69 IPSEC_PROTOCOL_AH = 0,
70 IPSEC_PROTOCOL_ESP = 1
71 } __clib_packed ipsec_protocol_t;
73 #define IPSEC_KEY_MAX_LEN 128
74 typedef struct ipsec_key_t_
77 u8 data[IPSEC_KEY_MAX_LEN];
81 * Enable extended sequence numbers
83 * IPsec tunnel mode if non-zero, else transport mode
84 * IPsec tunnel mode is IPv6 if non-zero,
85 * else IPv4 tunnel only valid if is_tunnel is non-zero
86 * enable UDP encapsulation for NAT traversal
88 #define foreach_ipsec_sa_flags \
90 _ (1, USE_ESN, "esn") \
91 _ (2, USE_ANTI_REPLAY, "anti-replay") \
92 _ (4, IS_TUNNEL, "tunnel") \
93 _ (8, IS_TUNNEL_V6, "tunnel-v6") \
94 _ (16, UDP_ENCAP, "udp-encap") \
95 _ (32, IS_PROTECT, "Protect") \
96 _ (64, IS_INBOUND, "inbound") \
97 _ (128, IS_AEAD, "aead") \
99 typedef enum ipsec_sad_flags_t_
101 #define _(v, f, s) IPSEC_SA_FLAG_##f = v,
102 foreach_ipsec_sa_flags
104 } __clib_packed ipsec_sa_flags_t;
106 STATIC_ASSERT (sizeof (ipsec_sa_flags_t) == 1, "IPSEC SA flags > 1 byte");
110 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
113 ipsec_sa_flags_t flags;
118 u32 encrypt_thread_index;
119 u32 decrypt_thread_index;
128 vnet_crypto_key_index_t crypto_key_index;
129 vnet_crypto_key_index_t integ_key_index;
131 /* Union data shared by sync and async ops, updated when mode is
137 vnet_crypto_op_id_t crypto_enc_op_id:16;
138 vnet_crypto_op_id_t crypto_dec_op_id:16;
139 vnet_crypto_op_id_t integ_op_id:16;
144 vnet_crypto_async_op_id_t crypto_async_enc_op_id:16;
145 vnet_crypto_async_op_id_t crypto_async_dec_op_id:16;
146 vnet_crypto_key_index_t linked_key_index;
152 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
157 ip4_header_t ip4_hdr;
158 ip6_header_t ip6_hdr;
160 udp_header_t udp_hdr;
162 /* Salt used in GCM modes - stored in network byte order */
165 ipsec_protocol_t protocol;
168 /* data accessed by dataplane code should be above this comment */
169 CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
171 /* Elements with u64 size multiples */
176 vnet_crypto_op_id_t crypto_enc_op_id:16;
177 vnet_crypto_op_id_t crypto_dec_op_id:16;
178 vnet_crypto_op_id_t integ_op_id:16;
187 vnet_crypto_async_op_id_t crypto_async_enc_op_id:16;
188 vnet_crypto_async_op_id_t crypto_async_dec_op_id:16;
189 vnet_crypto_key_index_t linked_key_index;
194 ip46_address_t tunnel_src_addr;
195 ip46_address_t tunnel_dst_addr;
199 /* elements with u32 size */
202 vnet_crypto_alg_t integ_calg;
203 vnet_crypto_alg_t crypto_calg;
205 fib_node_index_t fib_entry_index;
210 ipsec_crypto_alg_t crypto_alg;
211 ipsec_integ_alg_t integ_alg;
213 ipsec_key_t integ_key;
214 ipsec_key_t crypto_key;
217 STATIC_ASSERT_OFFSET_OF (ipsec_sa_t, cacheline1, CLIB_CACHE_LINE_BYTES);
218 STATIC_ASSERT_OFFSET_OF (ipsec_sa_t, cacheline2, 2 * CLIB_CACHE_LINE_BYTES);
222 ipsec_sa_is_set_##v (const ipsec_sa_t *sa) { \
223 return (sa->flags & IPSEC_SA_FLAG_##v); \
225 foreach_ipsec_sa_flags
229 ipsec_sa_set_##v (ipsec_sa_t *sa) { \
230 return (sa->flags |= IPSEC_SA_FLAG_##v); \
232 foreach_ipsec_sa_flags
236 ipsec_sa_unset_##v (ipsec_sa_t *sa) { \
237 return (sa->flags &= ~IPSEC_SA_FLAG_##v); \
239 foreach_ipsec_sa_flags
243 * SA packet & bytes counters
245 extern vlib_combined_counter_main_t ipsec_sa_counters;
247 extern void ipsec_mk_key (ipsec_key_t * key, const u8 * data, u8 len);
249 extern int ipsec_sa_add_and_lock (u32 id,
251 ipsec_protocol_t proto,
252 ipsec_crypto_alg_t crypto_alg,
253 const ipsec_key_t * ck,
254 ipsec_integ_alg_t integ_alg,
255 const ipsec_key_t * ik,
256 ipsec_sa_flags_t flags,
259 const ip46_address_t * tunnel_src_addr,
260 const ip46_address_t * tunnel_dst_addr,
261 u32 * sa_index, u16 src_port, u16 dst_port);
262 extern index_t ipsec_sa_find_and_lock (u32 id);
263 extern int ipsec_sa_unlock_id (u32 id);
264 extern void ipsec_sa_unlock (index_t sai);
265 extern void ipsec_sa_lock (index_t sai);
266 extern void ipsec_sa_clear (index_t sai);
267 extern void ipsec_sa_set_crypto_alg (ipsec_sa_t * sa,
268 ipsec_crypto_alg_t crypto_alg);
269 extern void ipsec_sa_set_integ_alg (ipsec_sa_t * sa,
270 ipsec_integ_alg_t integ_alg);
272 typedef walk_rc_t (*ipsec_sa_walk_cb_t) (ipsec_sa_t * sa, void *ctx);
273 extern void ipsec_sa_walk (ipsec_sa_walk_cb_t cd, void *ctx);
275 extern u8 *format_ipsec_crypto_alg (u8 * s, va_list * args);
276 extern u8 *format_ipsec_integ_alg (u8 * s, va_list * args);
277 extern u8 *format_ipsec_sa (u8 * s, va_list * args);
278 extern u8 *format_ipsec_key (u8 * s, va_list * args);
279 extern uword unformat_ipsec_crypto_alg (unformat_input_t * input,
281 extern uword unformat_ipsec_integ_alg (unformat_input_t * input,
283 extern uword unformat_ipsec_key (unformat_input_t * input, va_list * args);
285 #define IPSEC_UDP_PORT_NONE ((u16)~0)
288 * Anti Replay definitions
291 #define IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE (64)
292 #define IPSEC_SA_ANTI_REPLAY_WINDOW_MAX_INDEX (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE-1)
295 * sequence number less than the lower bound are outside of the window
296 * From RFC4303 Appendix A:
299 #define IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND(_tl) (_tl - IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE + 1)
303 * inputs need to be in host byte order.
306 ipsec_sa_anti_replay_check (ipsec_sa_t * sa, u32 seq)
310 if ((sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
313 if (!ipsec_sa_is_set_USE_ESN (sa))
315 if (PREDICT_TRUE (seq > sa->last_seq))
318 diff = sa->last_seq - seq;
320 if (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE > diff)
321 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
329 th = sa->last_seq_hi;
332 if (PREDICT_TRUE (tl >= (IPSEC_SA_ANTI_REPLAY_WINDOW_MAX_INDEX)))
335 * the last sequence number VPP recieved is more than one
336 * window size greater than zero.
337 * Case A from RFC4303 Appendix A.
339 if (seq < IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND (tl))
342 * the received sequence number is lower than the lower bound
343 * of the window, this could mean either a replay packet or that
344 * the high sequence number has wrapped. if it decrypts corrently
345 * then it's the latter.
353 * the recieved sequence number greater than the low
359 * The recieved seq number is within bounds of the window
360 * check if it's a duplicate
362 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
365 * The received sequence number is greater than the window
366 * upper bound. this packet will move the window along, assuming
367 * it decrypts correctly.
375 * the last sequence number VPP recieved is within one window
376 * size of zero, i.e. 0 < TL < WINDOW_SIZE, the lower bound is thus a
377 * large sequence number.
378 * Note that the check below uses unsiged integer arthimetic, so the
379 * RHS will be a larger number.
380 * Case B from RFC4303 Appendix A.
382 if (seq < IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND (tl))
385 * the sequence number is less than the lower bound.
390 * the packet is within the window upper bound.
391 * check for duplicates.
394 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
399 * the packet is less the window lower bound or greater than
400 * the higher bound, depending on how you look at it...
401 * We're assuming, given that the last sequence number received,
402 * TL < WINDOW_SIZE, that a largeer seq num is more likely to be
403 * a packet that moves the window forward, than a packet that has
404 * wrapped the high sequence again. If it were the latter then
405 * we've lost close to 2^32 packets.
414 * the packet seq number is between the lower bound (a large nubmer)
415 * and MAX_SEQ_NUM. This is in the window since the window upper bound
417 * However, since TL is the other side of 0 to the received
418 * packet, the SA has moved on to a higher sequence number.
421 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
429 * Anti replay window advance
430 * inputs need to be in host byte order.
433 ipsec_sa_anti_replay_advance (ipsec_sa_t * sa, u32 seq)
436 if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
439 if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ESN))
441 int wrap = sa->seq_hi - sa->last_seq_hi;
443 if (wrap == 0 && seq > sa->last_seq)
445 pos = seq - sa->last_seq;
446 if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
447 sa->replay_window = ((sa->replay_window) << pos) | 1;
449 sa->replay_window = 1;
454 pos = ~seq + sa->last_seq + 1;
455 if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
456 sa->replay_window = ((sa->replay_window) << pos) | 1;
458 sa->replay_window = 1;
460 sa->last_seq_hi = sa->seq_hi;
464 pos = ~seq + sa->last_seq + 1;
465 sa->replay_window |= (1ULL << pos);
469 pos = sa->last_seq - seq;
470 sa->replay_window |= (1ULL << pos);
475 if (seq > sa->last_seq)
477 pos = seq - sa->last_seq;
478 if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
479 sa->replay_window = ((sa->replay_window) << pos) | 1;
481 sa->replay_window = 1;
486 pos = sa->last_seq - seq;
487 sa->replay_window |= (1ULL << pos);
494 * Makes choice for thread_id should be assigned.
495 * if input ~0, gets random worker_id based on unix_time_now_nsec
498 ipsec_sa_assign_thread (u32 thread_id)
500 return ((thread_id) ? thread_id
501 : (unix_time_now_nsec () % vlib_num_workers ()) + 1);
504 #endif /* __IPSEC_SPD_SA_H__ */
507 * fd.io coding-style-patch-verification: ON
510 * eval: (c-set-style "gnu")