blob: e0d74e1309ee87cc517dcb51ee8f811a09d8bcdb [file] [log] [blame]
Neale Ranns999c8ee2019-02-01 03:31:24 -08001/*
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:
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
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.
14 */
15#ifndef __IPSEC_SPD_SA_H__
16#define __IPSEC_SPD_SA_H__
17
18#include <vlib/vlib.h>
19#include <vnet/ip/ip.h>
Neale Ranns8d7c5022019-02-06 01:41:05 -080020#include <vnet/fib/fib_node.h>
Neale Ranns999c8ee2019-02-01 03:31:24 -080021
22#define foreach_ipsec_crypto_alg \
23 _ (0, NONE, "none") \
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")
35
36typedef enum
37{
38#define _(v, f, s) IPSEC_CRYPTO_ALG_##f = v,
39 foreach_ipsec_crypto_alg
40#undef _
41 IPSEC_CRYPTO_N_ALG,
42} ipsec_crypto_alg_t;
43
Neale Ranns47feb112019-04-11 15:14:07 +000044#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)))
48
Neale Ranns999c8ee2019-02-01 03:31:24 -080049#define foreach_ipsec_integ_alg \
50 _ (0, NONE, "none") \
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 */
57
58typedef enum
59{
60#define _(v, f, s) IPSEC_INTEG_ALG_##f = v,
61 foreach_ipsec_integ_alg
62#undef _
63 IPSEC_INTEG_N_ALG,
64} ipsec_integ_alg_t;
65
66typedef enum
67{
68 IPSEC_PROTOCOL_AH = 0,
69 IPSEC_PROTOCOL_ESP = 1
70} ipsec_protocol_t;
71
Neale Ranns8d7c5022019-02-06 01:41:05 -080072#define IPSEC_KEY_MAX_LEN 128
73typedef struct ipsec_key_t_
74{
75 u8 len;
76 u8 data[IPSEC_KEY_MAX_LEN];
77} ipsec_key_t;
78
79/*
80 * Enable extended sequence numbers
81 * Enable Anti-replay
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
86 */
87#define foreach_ipsec_sa_flags \
88 _ (0, NONE, "none") \
Damjan Marion1e3aa5e2019-03-28 10:58:59 +010089 _ (1, USE_ESN, "esn") \
Neale Ranns8d7c5022019-02-06 01:41:05 -080090 _ (2, USE_ANTI_REPLAY, "anti-replay") \
91 _ (4, IS_TUNNEL, "tunnel") \
92 _ (8, IS_TUNNEL_V6, "tunnel-v6") \
93 _ (16, UDP_ENCAP, "udp-encap") \
Neale Rannsc87b66c2019-02-07 07:26:12 -080094 _ (32, IS_PROTECT, "Protect") \
Neale Ranns6b43ce52019-07-31 01:04:43 -070095 _ (64, IS_INBOUND, "inbound") \
Neale Ranns47feb112019-04-11 15:14:07 +000096 _ (128, IS_AEAD, "aead") \
Neale Ranns8d7c5022019-02-06 01:41:05 -080097
98typedef enum ipsec_sad_flags_t_
99{
100#define _(v, f, s) IPSEC_SA_FLAG_##f = v,
101 foreach_ipsec_sa_flags
102#undef _
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100103} __clib_packed ipsec_sa_flags_t;
Damjan Mariond709cbc2019-03-26 13:16:42 +0100104
105STATIC_ASSERT (sizeof (ipsec_sa_flags_t) == 1, "IPSEC SA flags > 1 byte");
Neale Ranns8d7c5022019-02-06 01:41:05 -0800106
Neale Ranns999c8ee2019-02-01 03:31:24 -0800107typedef struct
108{
Damjan Mariond709cbc2019-03-26 13:16:42 +0100109 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Neale Ranns999c8ee2019-02-01 03:31:24 -0800110
Damjan Mariond709cbc2019-03-26 13:16:42 +0100111 /* flags */
112 ipsec_sa_flags_t flags;
113
Damjan Marionb966e8b2019-03-20 16:07:09 +0100114 u8 crypto_iv_size;
115 u8 crypto_block_size;
Damjan Marion7c22ff72019-04-04 12:25:44 +0200116 u8 integ_icv_size;
Neale Rannsf62a8c02019-04-02 08:13:33 +0000117 u32 encrypt_thread_index;
118 u32 decrypt_thread_index;
Damjan Mariond709cbc2019-03-26 13:16:42 +0100119 u32 spi;
Neale Ranns999c8ee2019-02-01 03:31:24 -0800120 u32 seq;
121 u32 seq_hi;
122 u32 last_seq;
123 u32 last_seq_hi;
124 u64 replay_window;
Neale Ranns72f2a3a2019-06-17 15:43:38 +0000125 dpo_id_t dpo;
Damjan Mariond709cbc2019-03-26 13:16:42 +0100126
Damjan Mariond1bed682019-04-24 15:20:35 +0200127 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;
Damjan Mariond709cbc2019-03-26 13:16:42 +0100132
Damjan Mariond709cbc2019-03-26 13:16:42 +0100133 /* data accessed by dataplane code should be above this comment */
134 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
135
136 union
137 {
138 ip4_header_t ip4_hdr;
139 ip6_header_t ip6_hdr;
140 };
141 udp_header_t udp_hdr;
142
Damjan Mariond709cbc2019-03-26 13:16:42 +0100143 fib_node_t node;
144 u32 id;
145 u32 stat_index;
146 ipsec_protocol_t protocol;
147
148 ipsec_crypto_alg_t crypto_alg;
149 ipsec_key_t crypto_key;
Damjan Mariond1bed682019-04-24 15:20:35 +0200150 vnet_crypto_alg_t crypto_calg;
Damjan Mariond709cbc2019-03-26 13:16:42 +0100151
152 ipsec_integ_alg_t integ_alg;
153 ipsec_key_t integ_key;
Damjan Mariond1bed682019-04-24 15:20:35 +0200154 vnet_crypto_alg_t integ_calg;
Damjan Mariond709cbc2019-03-26 13:16:42 +0100155
156 ip46_address_t tunnel_src_addr;
157 ip46_address_t tunnel_dst_addr;
158
159 fib_node_index_t fib_entry_index;
160 u32 sibling;
161
162 u32 tx_fib_index;
Damjan Mariond709cbc2019-03-26 13:16:42 +0100163
Neale Ranns80f6fd52019-04-16 02:41:34 +0000164 /* Salt used in GCM modes - stored in network byte order */
165 u32 salt;
Damjan Mariond97918e2019-04-25 18:28:31 +0200166 u64 gcm_iv_counter;
Neale Ranns999c8ee2019-02-01 03:31:24 -0800167} ipsec_sa_t;
168
Damjan Mariond709cbc2019-03-26 13:16:42 +0100169STATIC_ASSERT_OFFSET_OF (ipsec_sa_t, cacheline1, CLIB_CACHE_LINE_BYTES);
170
171#define _(a,v,s) \
172 always_inline int \
173 ipsec_sa_is_set_##v (const ipsec_sa_t *sa) { \
174 return (sa->flags & IPSEC_SA_FLAG_##v); \
175 }
176foreach_ipsec_sa_flags
177#undef _
178#define _(a,v,s) \
179 always_inline int \
180 ipsec_sa_set_##v (ipsec_sa_t *sa) { \
181 return (sa->flags |= IPSEC_SA_FLAG_##v); \
182 }
183 foreach_ipsec_sa_flags
184#undef _
Neale Rannsc87b66c2019-02-07 07:26:12 -0800185#define _(a,v,s) \
186 always_inline int \
187 ipsec_sa_unset_##v (ipsec_sa_t *sa) { \
188 return (sa->flags &= ~IPSEC_SA_FLAG_##v); \
189 }
190 foreach_ipsec_sa_flags
191#undef _
Neale Rannseba31ec2019-02-17 18:04:27 +0000192/**
193 * @brief
194 * SA packet & bytes counters
195 */
196extern vlib_combined_counter_main_t ipsec_sa_counters;
197
Neale Ranns8d7c5022019-02-06 01:41:05 -0800198extern void ipsec_mk_key (ipsec_key_t * key, const u8 * data, u8 len);
199
Neale Ranns495d7ff2019-07-12 09:15:26 +0000200extern int ipsec_sa_add_and_lock (u32 id,
201 u32 spi,
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,
208 u32 tx_table_id,
209 u32 salt,
210 const ip46_address_t * tunnel_src_addr,
211 const ip46_address_t * tunnel_dst_addr,
212 u32 * sa_index);
213extern index_t ipsec_sa_find_and_lock (u32 id);
214extern int ipsec_sa_unlock_id (u32 id);
215extern void ipsec_sa_unlock (index_t sai);
Neale Ranns12989b52019-09-26 16:20:19 +0000216extern void ipsec_sa_lock (index_t sai);
Neale Rannsc87b66c2019-02-07 07:26:12 -0800217extern void ipsec_sa_clear (index_t sai);
Damjan Marionb966e8b2019-03-20 16:07:09 +0100218extern void ipsec_sa_set_crypto_alg (ipsec_sa_t * sa,
219 ipsec_crypto_alg_t crypto_alg);
220extern void ipsec_sa_set_integ_alg (ipsec_sa_t * sa,
221 ipsec_integ_alg_t integ_alg);
Neale Ranns8d7c5022019-02-06 01:41:05 -0800222
Neale Rannsb4cfd552019-02-13 02:08:06 -0800223typedef walk_rc_t (*ipsec_sa_walk_cb_t) (ipsec_sa_t * sa, void *ctx);
224extern void ipsec_sa_walk (ipsec_sa_walk_cb_t cd, void *ctx);
225
Neale Ranns999c8ee2019-02-01 03:31:24 -0800226extern u8 *format_ipsec_crypto_alg (u8 * s, va_list * args);
227extern u8 *format_ipsec_integ_alg (u8 * s, va_list * args);
Neale Ranns8d7c5022019-02-06 01:41:05 -0800228extern u8 *format_ipsec_sa (u8 * s, va_list * args);
229extern u8 *format_ipsec_key (u8 * s, va_list * args);
Neale Ranns999c8ee2019-02-01 03:31:24 -0800230extern uword unformat_ipsec_crypto_alg (unformat_input_t * input,
231 va_list * args);
232extern uword unformat_ipsec_integ_alg (unformat_input_t * input,
233 va_list * args);
Neale Ranns8d7c5022019-02-06 01:41:05 -0800234extern uword unformat_ipsec_key (unformat_input_t * input, va_list * args);
Neale Ranns999c8ee2019-02-01 03:31:24 -0800235
Neale Ranns6afaae12019-07-17 15:07:14 +0000236/*
237 * Anti Replay definitions
238 */
239
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)
242
243/*
244 * sequence number less than the lower bound are outside of the window
245 * From RFC4303 Appendix A:
246 * Bl = Tl - W + 1
247 */
248#define IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND(_tl) (_tl - IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE + 1)
249
250/*
251 * Anti replay check.
252 * inputs need to be in host byte order.
253 */
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100254always_inline int
Neale Ranns6afaae12019-07-17 15:07:14 +0000255ipsec_sa_anti_replay_check (ipsec_sa_t * sa, u32 seq)
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100256{
Neale Ranns6afaae12019-07-17 15:07:14 +0000257 u32 diff, tl, th;
258
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100259 if ((sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
260 return 0;
261
Neale Ranns6afaae12019-07-17 15:07:14 +0000262 if (!ipsec_sa_is_set_USE_ESN (sa))
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100263 {
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100264 if (PREDICT_TRUE (seq > sa->last_seq))
265 return 0;
266
267 diff = sa->last_seq - seq;
268
269 if (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE > diff)
270 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
271 else
272 return 1;
273
274 return 0;
275 }
276
277 tl = sa->last_seq;
278 th = sa->last_seq_hi;
279 diff = tl - seq;
280
Neale Ranns6afaae12019-07-17 15:07:14 +0000281 if (PREDICT_TRUE (tl >= (IPSEC_SA_ANTI_REPLAY_WINDOW_MAX_INDEX)))
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100282 {
Neale Ranns6afaae12019-07-17 15:07:14 +0000283 /*
284 * the last sequence number VPP recieved is more than one
285 * window size greater than zero.
286 * Case A from RFC4303 Appendix A.
287 */
288 if (seq < IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND (tl))
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100289 {
Neale Ranns6afaae12019-07-17 15:07:14 +0000290 /*
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.
295 */
296 sa->seq_hi = th + 1;
297 return 0;
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100298 }
299 else
300 {
Neale Ranns6afaae12019-07-17 15:07:14 +0000301 /*
302 * the recieved sequence number greater than the low
303 * end of the window.
304 */
305 sa->seq_hi = th;
306 if (seq <= tl)
307 /*
308 * The recieved seq number is within bounds of the window
309 * check if it's a duplicate
310 */
311 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
312 else
313 /*
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.
317 */
318 return 0;
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100319 }
320 }
321 else
322 {
Neale Ranns6afaae12019-07-17 15:07:14 +0000323 /*
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.
330 */
331 if (seq < IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND (tl))
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100332 {
Neale Ranns6afaae12019-07-17 15:07:14 +0000333 /*
334 * the sequence number is less than the lower bound.
335 */
336 if (seq <= tl)
337 {
338 /*
339 * the packet is within the window upper bound.
340 * check for duplicates.
341 */
342 sa->seq_hi = th;
343 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
344 }
345 else
346 {
347 /*
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.
355 */
356 sa->seq_hi = th;
357 return 0;
358 }
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100359 }
360 else
361 {
Neale Ranns6afaae12019-07-17 15:07:14 +0000362 /*
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
365 * tl > 0.
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.
368 */
369 sa->seq_hi = th - 1;
370 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100371 }
372 }
373
374 return 0;
375}
376
Neale Ranns6afaae12019-07-17 15:07:14 +0000377/*
378 * Anti replay window advance
379 * inputs need to be in host byte order.
380 */
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100381always_inline void
Neale Ranns6afaae12019-07-17 15:07:14 +0000382ipsec_sa_anti_replay_advance (ipsec_sa_t * sa, u32 seq)
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100383{
Neale Ranns6afaae12019-07-17 15:07:14 +0000384 u32 pos;
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100385 if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
386 return;
387
Damjan Marion1e3aa5e2019-03-28 10:58:59 +0100388 if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ESN))
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100389 {
390 int wrap = sa->seq_hi - sa->last_seq_hi;
391
392 if (wrap == 0 && seq > sa->last_seq)
393 {
394 pos = seq - sa->last_seq;
395 if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
396 sa->replay_window = ((sa->replay_window) << pos) | 1;
397 else
398 sa->replay_window = 1;
399 sa->last_seq = seq;
400 }
401 else if (wrap > 0)
402 {
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;
406 else
407 sa->replay_window = 1;
408 sa->last_seq = seq;
409 sa->last_seq_hi = sa->seq_hi;
410 }
411 else if (wrap < 0)
412 {
413 pos = ~seq + sa->last_seq + 1;
414 sa->replay_window |= (1ULL << pos);
415 }
416 else
417 {
418 pos = sa->last_seq - seq;
419 sa->replay_window |= (1ULL << pos);
420 }
421 }
422 else
423 {
424 if (seq > sa->last_seq)
425 {
426 pos = seq - sa->last_seq;
427 if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
428 sa->replay_window = ((sa->replay_window) << pos) | 1;
429 else
430 sa->replay_window = 1;
431 sa->last_seq = seq;
432 }
433 else
434 {
435 pos = sa->last_seq - seq;
436 sa->replay_window |= (1ULL << pos);
437 }
438 }
439}
440
Neale Rannsf62a8c02019-04-02 08:13:33 +0000441
442/*
443 * Makes choice for thread_id should be assigned.
444 * if input ~0, gets random worker_id based on unix_time_now_nsec
445*/
446always_inline u32
447ipsec_sa_assign_thread (u32 thread_id)
448{
449 return ((thread_id) ? thread_id
450 : (unix_time_now_nsec () % vlib_num_workers ()) + 1);
451}
452
Neale Ranns999c8ee2019-02-01 03:31:24 -0800453#endif /* __IPSEC_SPD_SA_H__ */
454
455/*
456 * fd.io coding-style-patch-verification: ON
457 *
458 * Local Variables:
459 * eval: (c-set-style "gnu")
460 * End:
461 */