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 foreach_ipsec_integ_alg \
48 _ (1, MD5_96, "md5-96") /* RFC2403 */ \
49 _ (2, SHA1_96, "sha1-96") /* RFC2404 */ \
50 _ (3, SHA_256_96, "sha-256-96") /* draft-ietf-ipsec-ciph-sha-256-00 */ \
51 _ (4, SHA_256_128, "sha-256-128") /* RFC4868 */ \
52 _ (5, SHA_384_192, "sha-384-192") /* RFC4868 */ \
53 _ (6, SHA_512_256, "sha-512-256") /* RFC4868 */
57 #define _(v, f, s) IPSEC_INTEG_ALG_##f = v,
58 foreach_ipsec_integ_alg
65 IPSEC_PROTOCOL_AH = 0,
66 IPSEC_PROTOCOL_ESP = 1
69 #define IPSEC_N_PROTOCOLS (IPSEC_PROTOCOL_ESP+1)
71 #define IPSEC_KEY_MAX_LEN 128
72 typedef struct ipsec_key_t_
75 u8 data[IPSEC_KEY_MAX_LEN];
79 * Enable extended sequence numbers
81 * IPsec tunnel mode if non-zero, else transport mode
82 * IPsec tunnel mode is IPv6 if non-zero,
83 * else IPv4 tunnel only valid if is_tunnel is non-zero
84 * enable UDP encapsulation for NAT traversal
86 #define foreach_ipsec_sa_flags \
88 _ (1, USE_ESN, "esn") \
89 _ (2, USE_ANTI_REPLAY, "anti-replay") \
90 _ (4, IS_TUNNEL, "tunnel") \
91 _ (8, IS_TUNNEL_V6, "tunnel-v6") \
92 _ (16, UDP_ENCAP, "udp-encap") \
93 _ (32, IS_GRE, "GRE") \
94 _ (64, IS_INBOUND, "inboud") \
96 typedef enum ipsec_sad_flags_t_
98 #define _(v, f, s) IPSEC_SA_FLAG_##f = v,
99 foreach_ipsec_sa_flags
101 } __clib_packed ipsec_sa_flags_t;
103 STATIC_ASSERT (sizeof (ipsec_sa_flags_t) == 1, "IPSEC SA flags > 1 byte");
107 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
110 ipsec_sa_flags_t flags;
113 u8 crypto_block_size;
122 vnet_crypto_op_type_t crypto_enc_op_type;
123 vnet_crypto_op_type_t crypto_dec_op_type;
124 vnet_crypto_op_type_t integ_op_type;
126 dpo_id_t dpo[IPSEC_N_PROTOCOLS];
128 /* data accessed by dataplane code should be above this comment */
129 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
133 ip4_header_t ip4_hdr;
134 ip6_header_t ip6_hdr;
136 udp_header_t udp_hdr;
142 ipsec_protocol_t protocol;
144 ipsec_crypto_alg_t crypto_alg;
145 ipsec_key_t crypto_key;
147 ipsec_integ_alg_t integ_alg;
148 ipsec_key_t integ_key;
150 ip46_address_t tunnel_src_addr;
151 ip46_address_t tunnel_dst_addr;
153 fib_node_index_t fib_entry_index;
162 STATIC_ASSERT_OFFSET_OF (ipsec_sa_t, cacheline1, CLIB_CACHE_LINE_BYTES);
166 ipsec_sa_is_set_##v (const ipsec_sa_t *sa) { \
167 return (sa->flags & IPSEC_SA_FLAG_##v); \
169 foreach_ipsec_sa_flags
173 ipsec_sa_set_##v (ipsec_sa_t *sa) { \
174 return (sa->flags |= IPSEC_SA_FLAG_##v); \
176 foreach_ipsec_sa_flags
180 * SA packet & bytes counters
182 extern vlib_combined_counter_main_t ipsec_sa_counters;
184 extern void ipsec_mk_key (ipsec_key_t * key, const u8 * data, u8 len);
186 extern int ipsec_sa_add (u32 id,
188 ipsec_protocol_t proto,
189 ipsec_crypto_alg_t crypto_alg,
190 const ipsec_key_t * ck,
191 ipsec_integ_alg_t integ_alg,
192 const ipsec_key_t * ik,
193 ipsec_sa_flags_t flags,
195 const ip46_address_t * tunnel_src_addr,
196 const ip46_address_t * tunnel_dst_addr,
198 extern u32 ipsec_sa_del (u32 id);
199 extern void ipsec_sa_stack (ipsec_sa_t * sa);
200 extern void ipsec_sa_set_crypto_alg (ipsec_sa_t * sa,
201 ipsec_crypto_alg_t crypto_alg);
202 extern void ipsec_sa_set_integ_alg (ipsec_sa_t * sa,
203 ipsec_integ_alg_t integ_alg);
205 extern u8 ipsec_is_sa_used (u32 sa_index);
206 extern int ipsec_set_sa_key (u32 id,
207 const ipsec_key_t * ck, const ipsec_key_t * ik);
208 extern u32 ipsec_get_sa_index_by_sa_id (u32 sa_id);
210 typedef walk_rc_t (*ipsec_sa_walk_cb_t) (ipsec_sa_t * sa, void *ctx);
211 extern void ipsec_sa_walk (ipsec_sa_walk_cb_t cd, void *ctx);
213 extern u8 *format_ipsec_crypto_alg (u8 * s, va_list * args);
214 extern u8 *format_ipsec_integ_alg (u8 * s, va_list * args);
215 extern u8 *format_ipsec_sa (u8 * s, va_list * args);
216 extern u8 *format_ipsec_key (u8 * s, va_list * args);
217 extern uword unformat_ipsec_crypto_alg (unformat_input_t * input,
219 extern uword unformat_ipsec_integ_alg (unformat_input_t * input,
221 extern uword unformat_ipsec_key (unformat_input_t * input, va_list * args);
224 ipsec_sa_anti_replay_check (ipsec_sa_t * sa, u32 * seqp)
226 u32 seq, diff, tl, th;
227 if ((sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
230 seq = clib_net_to_host_u32 (*seqp);
232 if ((sa->flags & IPSEC_SA_FLAG_USE_ESN) == 0)
235 if (PREDICT_TRUE (seq > sa->last_seq))
238 diff = sa->last_seq - seq;
240 if (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE > diff)
241 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
249 th = sa->last_seq_hi;
252 if (PREDICT_TRUE (tl >= (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE - 1)))
254 if (seq >= (tl - IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE + 1))
258 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
270 if (seq >= (tl - IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE + 1))
273 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
279 return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
289 ipsec_sa_anti_replay_advance (ipsec_sa_t * sa, u32 * seqp)
292 if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
295 seq = clib_host_to_net_u32 (*seqp);
296 if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ESN))
298 int wrap = sa->seq_hi - sa->last_seq_hi;
300 if (wrap == 0 && seq > sa->last_seq)
302 pos = seq - sa->last_seq;
303 if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
304 sa->replay_window = ((sa->replay_window) << pos) | 1;
306 sa->replay_window = 1;
311 pos = ~seq + sa->last_seq + 1;
312 if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
313 sa->replay_window = ((sa->replay_window) << pos) | 1;
315 sa->replay_window = 1;
317 sa->last_seq_hi = sa->seq_hi;
321 pos = ~seq + sa->last_seq + 1;
322 sa->replay_window |= (1ULL << pos);
326 pos = sa->last_seq - seq;
327 sa->replay_window |= (1ULL << pos);
332 if (seq > sa->last_seq)
334 pos = seq - sa->last_seq;
335 if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
336 sa->replay_window = ((sa->replay_window) << pos) | 1;
338 sa->replay_window = 1;
343 pos = sa->last_seq - seq;
344 sa->replay_window |= (1ULL << pos);
349 #endif /* __IPSEC_SPD_SA_H__ */
352 * fd.io coding-style-patch-verification: ON
355 * eval: (c-set-style "gnu")