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 foreach_ipsec_crypto_alg \
24 _ (1, AES_CBC_128, "aes-cbc-128") \
25 _ (2, AES_CBC_192, "aes-cbc-192") \
26 _ (3, AES_CBC_256, "aes-cbc-256") \
27 _ (4, AES_CTR_128, "aes-ctr-128") \
28 _ (5, AES_CTR_192, "aes-ctr-192") \
29 _ (6, AES_CTR_256, "aes-ctr-256") \
30 _ (7, AES_GCM_128, "aes-gcm-128") \
31 _ (8, AES_GCM_192, "aes-gcm-192") \
32 _ (9, AES_GCM_256, "aes-gcm-256") \
33 _ (10, DES_CBC, "des-cbc") \
34 _ (11, 3DES_CBC, "3des-cbc")
38 #define _(v, f, s) IPSEC_CRYPTO_ALG_##f = v,
39 foreach_ipsec_crypto_alg
44 #define IPSEC_CRYPTO_ALG_IS_GCM(_alg) \
45 (((_alg == IPSEC_CRYPTO_ALG_AES_GCM_128) || \
46 (_alg == IPSEC_CRYPTO_ALG_AES_GCM_192) || \
47 (_alg == IPSEC_CRYPTO_ALG_AES_GCM_256)))
49 #define foreach_ipsec_integ_alg \
51 _ (1, MD5_96, "md5-96") /* RFC2403 */ \
52 _ (2, SHA1_96, "sha1-96") /* RFC2404 */ \
53 _ (3, SHA_256_96, "sha-256-96") /* draft-ietf-ipsec-ciph-sha-256-00 */ \
54 _ (4, SHA_256_128, "sha-256-128") /* RFC4868 */ \
55 _ (5, SHA_384_192, "sha-384-192") /* RFC4868 */ \
56 _ (6, SHA_512_256, "sha-512-256") /* RFC4868 */
60 #define _(v, f, s) IPSEC_INTEG_ALG_##f = v,
61 foreach_ipsec_integ_alg
68 IPSEC_PROTOCOL_AH = 0,
69 IPSEC_PROTOCOL_ESP = 1
72 #define IPSEC_KEY_MAX_LEN 128
73 typedef struct ipsec_key_t_
76 u8 data[IPSEC_KEY_MAX_LEN];
80 * Enable extended sequence numbers
82 * IPsec tunnel mode if non-zero, else transport mode
83 * IPsec tunnel mode is IPv6 if non-zero,
84 * else IPv4 tunnel only valid if is_tunnel is non-zero
85 * enable UDP encapsulation for NAT traversal
87 #define foreach_ipsec_sa_flags \
89 _ (1, USE_ESN, "esn") \
90 _ (2, USE_ANTI_REPLAY, "anti-replay") \
91 _ (4, IS_TUNNEL, "tunnel") \
92 _ (8, IS_TUNNEL_V6, "tunnel-v6") \
93 _ (16, UDP_ENCAP, "udp-encap") \
94 _ (32, IS_PROTECT, "Protect") \
95 _ (64, IS_INBOUND, "inbound") \
96 _ (128, IS_AEAD, "aead") \
98 typedef enum ipsec_sad_flags_t_
100 #define _(v, f, s) IPSEC_SA_FLAG_##f = v,
101 foreach_ipsec_sa_flags
103 } __clib_packed ipsec_sa_flags_t;
105 STATIC_ASSERT (sizeof (ipsec_sa_flags_t) == 1, "IPSEC SA flags > 1 byte");
109 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
112 ipsec_sa_flags_t flags;
115 u8 crypto_block_size;
117 u32 encrypt_thread_index;
118 u32 decrypt_thread_index;
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_lock (index_t sai);
217 extern void ipsec_sa_clear (index_t sai);
218 extern void ipsec_sa_set_crypto_alg (ipsec_sa_t * sa,
219 ipsec_crypto_alg_t crypto_alg);
220 extern void ipsec_sa_set_integ_alg (ipsec_sa_t * sa,
221 ipsec_integ_alg_t integ_alg);
223 typedef walk_rc_t (*ipsec_sa_walk_cb_t) (ipsec_sa_t * sa, void *ctx);
224 extern void ipsec_sa_walk (ipsec_sa_walk_cb_t cd, void *ctx);
226 extern u8 *format_ipsec_crypto_alg (u8 * s, va_list * args);
227 extern u8 *format_ipsec_integ_alg (u8 * s, va_list * args);
228 extern u8 *format_ipsec_sa (u8 * s, va_list * args);
229 extern u8 *format_ipsec_key (u8 * s, va_list * args);
230 extern uword unformat_ipsec_crypto_alg (unformat_input_t * input,
232 extern uword unformat_ipsec_integ_alg (unformat_input_t * input,
234 extern uword unformat_ipsec_key (unformat_input_t * input, va_list * args);
237 * Anti Replay definitions
240 #define IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE (64)
241 #define IPSEC_SA_ANTI_REPLAY_WINDOW_MAX_INDEX (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE-1)
244 * sequence number less than the lower bound are outside of the window
245 * From RFC4303 Appendix A:
248 #define IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND(_tl) (_tl - IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE + 1)
252 * inputs need to be in host byte order.
255 ipsec_sa_anti_replay_check (ipsec_sa_t * sa, u32 seq)
259 if ((sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
262 if (!ipsec_sa_is_set_USE_ESN (sa))
264 if (PREDICT_TRUE (seq > sa->last_seq))
267 diff = sa->last_seq - seq;
269 if (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE > diff)
270 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
278 th = sa->last_seq_hi;
281 if (PREDICT_TRUE (tl >= (IPSEC_SA_ANTI_REPLAY_WINDOW_MAX_INDEX)))
284 * the last sequence number VPP recieved is more than one
285 * window size greater than zero.
286 * Case A from RFC4303 Appendix A.
288 if (seq < IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND (tl))
291 * the received sequence number is lower than the lower bound
292 * of the window, this could mean either a replay packet or that
293 * the high sequence number has wrapped. if it decrypts corrently
294 * then it's the latter.
302 * the recieved sequence number greater than the low
308 * The recieved seq number is within bounds of the window
309 * check if it's a duplicate
311 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
314 * The received sequence number is greater than the window
315 * upper bound. this packet will move the window along, assuming
316 * it decrypts correctly.
324 * the last sequence number VPP recieved is within one window
325 * size of zero, i.e. 0 < TL < WINDOW_SIZE, the lower bound is thus a
326 * large sequence number.
327 * Note that the check below uses unsiged integer arthimetic, so the
328 * RHS will be a larger number.
329 * Case B from RFC4303 Appendix A.
331 if (seq < IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND (tl))
334 * the sequence number is less than the lower bound.
339 * the packet is within the window upper bound.
340 * check for duplicates.
343 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
348 * the packet is less the window lower bound or greater than
349 * the higher bound, depending on how you look at it...
350 * We're assuming, given that the last sequence number received,
351 * TL < WINDOW_SIZE, that a largeer seq num is more likely to be
352 * a packet that moves the window forward, than a packet that has
353 * wrapped the high sequence again. If it were the latter then
354 * we've lost close to 2^32 packets.
363 * the packet seq number is between the lower bound (a large nubmer)
364 * and MAX_SEQ_NUM. This is in the window since the window upper bound
366 * However, since TL is the other side of 0 to the received
367 * packet, the SA has moved on to a higher sequence number.
370 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
378 * Anti replay window advance
379 * inputs need to be in host byte order.
382 ipsec_sa_anti_replay_advance (ipsec_sa_t * sa, u32 seq)
385 if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
388 if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ESN))
390 int wrap = sa->seq_hi - sa->last_seq_hi;
392 if (wrap == 0 && seq > sa->last_seq)
394 pos = seq - sa->last_seq;
395 if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
396 sa->replay_window = ((sa->replay_window) << pos) | 1;
398 sa->replay_window = 1;
403 pos = ~seq + sa->last_seq + 1;
404 if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
405 sa->replay_window = ((sa->replay_window) << pos) | 1;
407 sa->replay_window = 1;
409 sa->last_seq_hi = sa->seq_hi;
413 pos = ~seq + sa->last_seq + 1;
414 sa->replay_window |= (1ULL << pos);
418 pos = sa->last_seq - seq;
419 sa->replay_window |= (1ULL << pos);
424 if (seq > sa->last_seq)
426 pos = seq - sa->last_seq;
427 if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
428 sa->replay_window = ((sa->replay_window) << pos) | 1;
430 sa->replay_window = 1;
435 pos = sa->last_seq - seq;
436 sa->replay_window |= (1ULL << pos);
443 * Makes choice for thread_id should be assigned.
444 * if input ~0, gets random worker_id based on unix_time_now_nsec
447 ipsec_sa_assign_thread (u32 thread_id)
449 return ((thread_id) ? thread_id
450 : (unix_time_now_nsec () % vlib_num_workers ()) + 1);
453 #endif /* __IPSEC_SPD_SA_H__ */
456 * fd.io coding-style-patch-verification: ON
459 * eval: (c-set-style "gnu")