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;
125 vnet_crypto_key_index_t crypto_key_index;
126 vnet_crypto_key_index_t integ_key_index;
127 vnet_crypto_op_id_t crypto_enc_op_id:16;
128 vnet_crypto_op_id_t crypto_dec_op_id:16;
129 vnet_crypto_op_id_t integ_op_id:16;
131 /* data accessed by dataplane code should be above this comment */
132 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
136 ip4_header_t ip4_hdr;
137 ip6_header_t ip6_hdr;
139 udp_header_t udp_hdr;
144 ipsec_protocol_t protocol;
146 ipsec_crypto_alg_t crypto_alg;
147 ipsec_key_t crypto_key;
148 vnet_crypto_alg_t crypto_calg;
150 ipsec_integ_alg_t integ_alg;
151 ipsec_key_t integ_key;
152 vnet_crypto_alg_t integ_calg;
154 ip46_address_t tunnel_src_addr;
155 ip46_address_t tunnel_dst_addr;
157 fib_node_index_t fib_entry_index;
162 /* Salt used in GCM modes - stored in network byte order */
167 STATIC_ASSERT_OFFSET_OF (ipsec_sa_t, cacheline1, CLIB_CACHE_LINE_BYTES);
171 ipsec_sa_is_set_##v (const ipsec_sa_t *sa) { \
172 return (sa->flags & IPSEC_SA_FLAG_##v); \
174 foreach_ipsec_sa_flags
178 ipsec_sa_set_##v (ipsec_sa_t *sa) { \
179 return (sa->flags |= IPSEC_SA_FLAG_##v); \
181 foreach_ipsec_sa_flags
185 ipsec_sa_unset_##v (ipsec_sa_t *sa) { \
186 return (sa->flags &= ~IPSEC_SA_FLAG_##v); \
188 foreach_ipsec_sa_flags
192 * SA packet & bytes counters
194 extern vlib_combined_counter_main_t ipsec_sa_counters;
196 extern void ipsec_mk_key (ipsec_key_t * key, const u8 * data, u8 len);
198 extern int ipsec_sa_add_and_lock (u32 id,
200 ipsec_protocol_t proto,
201 ipsec_crypto_alg_t crypto_alg,
202 const ipsec_key_t * ck,
203 ipsec_integ_alg_t integ_alg,
204 const ipsec_key_t * ik,
205 ipsec_sa_flags_t flags,
208 const ip46_address_t * tunnel_src_addr,
209 const ip46_address_t * tunnel_dst_addr,
211 extern index_t ipsec_sa_find_and_lock (u32 id);
212 extern int ipsec_sa_unlock_id (u32 id);
213 extern void ipsec_sa_unlock (index_t sai);
214 extern void ipsec_sa_clear (index_t sai);
215 extern void ipsec_sa_set_crypto_alg (ipsec_sa_t * sa,
216 ipsec_crypto_alg_t crypto_alg);
217 extern void ipsec_sa_set_integ_alg (ipsec_sa_t * sa,
218 ipsec_integ_alg_t integ_alg);
220 typedef walk_rc_t (*ipsec_sa_walk_cb_t) (ipsec_sa_t * sa, void *ctx);
221 extern void ipsec_sa_walk (ipsec_sa_walk_cb_t cd, void *ctx);
223 extern u8 *format_ipsec_crypto_alg (u8 * s, va_list * args);
224 extern u8 *format_ipsec_integ_alg (u8 * s, va_list * args);
225 extern u8 *format_ipsec_sa (u8 * s, va_list * args);
226 extern u8 *format_ipsec_key (u8 * s, va_list * args);
227 extern uword unformat_ipsec_crypto_alg (unformat_input_t * input,
229 extern uword unformat_ipsec_integ_alg (unformat_input_t * input,
231 extern uword unformat_ipsec_key (unformat_input_t * input, va_list * args);
234 * Anti Replay definitions
237 #define IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE (64)
238 #define IPSEC_SA_ANTI_REPLAY_WINDOW_MAX_INDEX (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE-1)
241 * sequence number less than the lower bound are outside of the window
242 * From RFC4303 Appendix A:
245 #define IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND(_tl) (_tl - IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE + 1)
249 * inputs need to be in host byte order.
252 ipsec_sa_anti_replay_check (ipsec_sa_t * sa, u32 seq)
256 if ((sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
259 if (!ipsec_sa_is_set_USE_ESN (sa))
261 if (PREDICT_TRUE (seq > sa->last_seq))
264 diff = sa->last_seq - seq;
266 if (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE > diff)
267 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
275 th = sa->last_seq_hi;
278 if (PREDICT_TRUE (tl >= (IPSEC_SA_ANTI_REPLAY_WINDOW_MAX_INDEX)))
281 * the last sequence number VPP recieved is more than one
282 * window size greater than zero.
283 * Case A from RFC4303 Appendix A.
285 if (seq < IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND (tl))
288 * the received sequence number is lower than the lower bound
289 * of the window, this could mean either a replay packet or that
290 * the high sequence number has wrapped. if it decrypts corrently
291 * then it's the latter.
299 * the recieved sequence number greater than the low
305 * The recieved seq number is within bounds of the window
306 * check if it's a duplicate
308 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
311 * The received sequence number is greater than the window
312 * upper bound. this packet will move the window along, assuming
313 * it decrypts correctly.
321 * the last sequence number VPP recieved is within one window
322 * size of zero, i.e. 0 < TL < WINDOW_SIZE, the lower bound is thus a
323 * large sequence number.
324 * Note that the check below uses unsiged integer arthimetic, so the
325 * RHS will be a larger number.
326 * Case B from RFC4303 Appendix A.
328 if (seq < IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND (tl))
331 * the sequence number is less than the lower bound.
336 * the packet is within the window upper bound.
337 * check for duplicates.
340 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
345 * the packet is less the window lower bound or greater than
346 * the higher bound, depending on how you look at it...
347 * We're assuming, given that the last sequence number received,
348 * TL < WINDOW_SIZE, that a largeer seq num is more likely to be
349 * a packet that moves the window forward, than a packet that has
350 * wrapped the high sequence again. If it were the latter then
351 * we've lost close to 2^32 packets.
360 * the packet seq number is between the lower bound (a large nubmer)
361 * and MAX_SEQ_NUM. This is in the window since the window upper bound
363 * However, since TL is the other side of 0 to the received
364 * packet, the SA has moved on to a higher sequence number.
367 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
375 * Anti replay window advance
376 * inputs need to be in host byte order.
379 ipsec_sa_anti_replay_advance (ipsec_sa_t * sa, u32 seq)
382 if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
385 if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ESN))
387 int wrap = sa->seq_hi - sa->last_seq_hi;
389 if (wrap == 0 && seq > sa->last_seq)
391 pos = seq - sa->last_seq;
392 if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
393 sa->replay_window = ((sa->replay_window) << pos) | 1;
395 sa->replay_window = 1;
400 pos = ~seq + sa->last_seq + 1;
401 if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
402 sa->replay_window = ((sa->replay_window) << pos) | 1;
404 sa->replay_window = 1;
406 sa->last_seq_hi = sa->seq_hi;
410 pos = ~seq + sa->last_seq + 1;
411 sa->replay_window |= (1ULL << pos);
415 pos = sa->last_seq - seq;
416 sa->replay_window |= (1ULL << pos);
421 if (seq > sa->last_seq)
423 pos = seq - sa->last_seq;
424 if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
425 sa->replay_window = ((sa->replay_window) << pos) | 1;
427 sa->replay_window = 1;
432 pos = sa->last_seq - seq;
433 sa->replay_window |= (1ULL << pos);
438 #endif /* __IPSEC_SPD_SA_H__ */
441 * fd.io coding-style-patch-verification: ON
444 * eval: (c-set-style "gnu")