blob: cd90ef5c4413ada919eefcffd7e76109462e332b [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>
Benoît Ganne5527a782022-01-18 15:56:41 +010019#include <vppinfra/pcg.h>
Filip Tehlare5d34912020-03-02 15:17:37 +000020#include <vnet/crypto/crypto.h>
Neale Ranns999c8ee2019-02-01 03:31:24 -080021#include <vnet/ip/ip.h>
Neale Ranns8d7c5022019-02-06 01:41:05 -080022#include <vnet/fib/fib_node.h>
Neale Ranns041add72020-01-02 04:06:10 +000023#include <vnet/tunnel/tunnel.h>
Neale Ranns999c8ee2019-02-01 03:31:24 -080024
Benoît Ganne5527a782022-01-18 15:56:41 +010025#define ESP_MAX_ICV_SIZE (32)
26#define ESP_MAX_IV_SIZE (16)
27#define ESP_MAX_BLOCK_SIZE (16)
28
Vladimir Ratnikovd7c030d2022-09-13 13:09:53 +000029#define foreach_ipsec_crypto_alg \
30 _ (0, NONE, "none") \
31 _ (1, AES_CBC_128, "aes-cbc-128") \
32 _ (2, AES_CBC_192, "aes-cbc-192") \
33 _ (3, AES_CBC_256, "aes-cbc-256") \
34 _ (4, AES_CTR_128, "aes-ctr-128") \
35 _ (5, AES_CTR_192, "aes-ctr-192") \
36 _ (6, AES_CTR_256, "aes-ctr-256") \
37 _ (7, AES_GCM_128, "aes-gcm-128") \
38 _ (8, AES_GCM_192, "aes-gcm-192") \
39 _ (9, AES_GCM_256, "aes-gcm-256") \
40 _ (10, DES_CBC, "des-cbc") \
41 _ (11, 3DES_CBC, "3des-cbc") \
Benoît Ganne84e66582023-03-10 17:33:03 +010042 _ (12, CHACHA20_POLY1305, "chacha20-poly1305") \
43 _ (13, AES_NULL_GMAC_128, "aes-null-gmac-128") \
44 _ (14, AES_NULL_GMAC_192, "aes-null-gmac-192") \
45 _ (15, AES_NULL_GMAC_256, "aes-null-gmac-256")
Neale Ranns999c8ee2019-02-01 03:31:24 -080046
47typedef enum
48{
49#define _(v, f, s) IPSEC_CRYPTO_ALG_##f = v,
50 foreach_ipsec_crypto_alg
51#undef _
52 IPSEC_CRYPTO_N_ALG,
Neale Ranns123b5eb2020-10-16 14:03:55 +000053} __clib_packed ipsec_crypto_alg_t;
Neale Ranns999c8ee2019-02-01 03:31:24 -080054
Benoît Ganne84e66582023-03-10 17:33:03 +010055#define IPSEC_CRYPTO_ALG_IS_NULL_GMAC(_alg) \
56 ((_alg == IPSEC_CRYPTO_ALG_AES_NULL_GMAC_128) || \
57 (_alg == IPSEC_CRYPTO_ALG_AES_NULL_GMAC_192) || \
58 (_alg == IPSEC_CRYPTO_ALG_AES_NULL_GMAC_256))
59
Neale Ranns47feb112019-04-11 15:14:07 +000060#define IPSEC_CRYPTO_ALG_IS_GCM(_alg) \
61 (((_alg == IPSEC_CRYPTO_ALG_AES_GCM_128) || \
62 (_alg == IPSEC_CRYPTO_ALG_AES_GCM_192) || \
63 (_alg == IPSEC_CRYPTO_ALG_AES_GCM_256)))
64
Benoît Ganne490b9272021-01-22 18:03:09 +010065#define IPSEC_CRYPTO_ALG_IS_CTR(_alg) \
66 (((_alg == IPSEC_CRYPTO_ALG_AES_CTR_128) || \
67 (_alg == IPSEC_CRYPTO_ALG_AES_CTR_192) || \
68 (_alg == IPSEC_CRYPTO_ALG_AES_CTR_256)))
69
Vladimir Ratnikovd7c030d2022-09-13 13:09:53 +000070#define IPSEC_CRYPTO_ALG_CTR_AEAD_OTHERS(_alg) \
71 (_alg == IPSEC_CRYPTO_ALG_CHACHA20_POLY1305)
72
Neale Ranns999c8ee2019-02-01 03:31:24 -080073#define foreach_ipsec_integ_alg \
74 _ (0, NONE, "none") \
75 _ (1, MD5_96, "md5-96") /* RFC2403 */ \
76 _ (2, SHA1_96, "sha1-96") /* RFC2404 */ \
77 _ (3, SHA_256_96, "sha-256-96") /* draft-ietf-ipsec-ciph-sha-256-00 */ \
78 _ (4, SHA_256_128, "sha-256-128") /* RFC4868 */ \
79 _ (5, SHA_384_192, "sha-384-192") /* RFC4868 */ \
80 _ (6, SHA_512_256, "sha-512-256") /* RFC4868 */
81
82typedef enum
83{
84#define _(v, f, s) IPSEC_INTEG_ALG_##f = v,
85 foreach_ipsec_integ_alg
86#undef _
87 IPSEC_INTEG_N_ALG,
Neale Ranns123b5eb2020-10-16 14:03:55 +000088} __clib_packed ipsec_integ_alg_t;
Neale Ranns999c8ee2019-02-01 03:31:24 -080089
90typedef enum
91{
92 IPSEC_PROTOCOL_AH = 0,
93 IPSEC_PROTOCOL_ESP = 1
Neale Ranns123b5eb2020-10-16 14:03:55 +000094} __clib_packed ipsec_protocol_t;
Neale Ranns999c8ee2019-02-01 03:31:24 -080095
Neale Ranns8d7c5022019-02-06 01:41:05 -080096#define IPSEC_KEY_MAX_LEN 128
97typedef struct ipsec_key_t_
98{
99 u8 len;
100 u8 data[IPSEC_KEY_MAX_LEN];
101} ipsec_key_t;
102
103/*
104 * Enable extended sequence numbers
105 * Enable Anti-replay
106 * IPsec tunnel mode if non-zero, else transport mode
107 * IPsec tunnel mode is IPv6 if non-zero,
108 * else IPv4 tunnel only valid if is_tunnel is non-zero
109 * enable UDP encapsulation for NAT traversal
110 */
Benoît Ganne490b9272021-01-22 18:03:09 +0100111#define foreach_ipsec_sa_flags \
112 _ (0, NONE, "none") \
113 _ (1, USE_ESN, "esn") \
114 _ (2, USE_ANTI_REPLAY, "anti-replay") \
115 _ (4, IS_TUNNEL, "tunnel") \
116 _ (8, IS_TUNNEL_V6, "tunnel-v6") \
117 _ (16, UDP_ENCAP, "udp-encap") \
118 _ (32, IS_PROTECT, "Protect") \
119 _ (64, IS_INBOUND, "inbound") \
120 _ (128, IS_AEAD, "aead") \
Neale Rannsf16e9a52021-02-25 19:09:24 +0000121 _ (256, IS_CTR, "ctr") \
Neale Ranns6fdcc3d2021-10-08 07:30:47 +0000122 _ (512, IS_ASYNC, "async") \
Benoît Ganne84e66582023-03-10 17:33:03 +0100123 _ (1024, NO_ALGO_NO_DROP, "no-algo-no-drop") \
124 _ (2048, IS_NULL_GMAC, "null-gmac")
Neale Ranns8d7c5022019-02-06 01:41:05 -0800125
126typedef enum ipsec_sad_flags_t_
127{
128#define _(v, f, s) IPSEC_SA_FLAG_##f = v,
129 foreach_ipsec_sa_flags
130#undef _
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100131} __clib_packed ipsec_sa_flags_t;
Damjan Mariond709cbc2019-03-26 13:16:42 +0100132
Benoît Ganne490b9272021-01-22 18:03:09 +0100133STATIC_ASSERT (sizeof (ipsec_sa_flags_t) == 2, "IPSEC SA flags != 2 byte");
Neale Ranns8d7c5022019-02-06 01:41:05 -0800134
Arthur de Kerhorad95b062022-11-16 19:12:05 +0100135#define foreach_ipsec_sa_err \
136 _ (0, LOST, lost, "packets lost") \
137 _ (1, HANDOFF, handoff, "hand-off") \
138 _ (2, INTEG_ERROR, integ_error, "Integrity check failed") \
139 _ (3, DECRYPTION_FAILED, decryption_failed, "Decryption failed") \
140 _ (4, CRYPTO_ENGINE_ERROR, crypto_engine_error, \
141 "crypto engine error (dropped)") \
142 _ (5, REPLAY, replay, "SA replayed packet") \
143 _ (6, RUNT, runt, "undersized packet") \
144 _ (7, NO_BUFFERS, no_buffers, "no buffers (dropped)") \
145 _ (8, OVERSIZED_HEADER, oversized_header, \
146 "buffer with oversized header (dropped)") \
147 _ (9, NO_TAIL_SPACE, no_tail_space, \
148 "no enough buffer tail space (dropped)") \
149 _ (10, TUN_NO_PROTO, tun_no_proto, "no tunnel protocol") \
150 _ (11, UNSUP_PAYLOAD, unsup_payload, "unsupported payload") \
151 _ (12, SEQ_CYCLED, seq_cycled, "sequence number cycled (dropped)") \
152 _ (13, CRYPTO_QUEUE_FULL, crypto_queue_full, "crypto queue full (dropped)") \
153 _ (14, NO_ENCRYPTION, no_encryption, "no Encrypting SA (dropped)") \
154 _ (15, DROP_FRAGMENTS, drop_fragments, "IP fragments drop")
155
156typedef enum
157{
158#define _(v, f, s, d) IPSEC_SA_ERROR_##f = v,
159 foreach_ipsec_sa_err
160#undef _
161 IPSEC_SA_N_ERRORS,
162} __clib_packed ipsec_sa_err_t;
163
Neale Ranns999c8ee2019-02-01 03:31:24 -0800164typedef struct
165{
Damjan Mariond709cbc2019-03-26 13:16:42 +0100166 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Neale Ranns999c8ee2019-02-01 03:31:24 -0800167
Benoît Ganne5527a782022-01-18 15:56:41 +0100168 clib_pcg64i_random_t iv_prng;
Damjan Mariond709cbc2019-03-26 13:16:42 +0100169
Neale Ranns999c8ee2019-02-01 03:31:24 -0800170 u64 replay_window;
Neale Ranns72f2a3a2019-06-17 15:43:38 +0000171 dpo_id_t dpo;
Damjan Mariond709cbc2019-03-26 13:16:42 +0100172
Damjan Mariond1bed682019-04-24 15:20:35 +0200173 vnet_crypto_key_index_t crypto_key_index;
174 vnet_crypto_key_index_t integ_key_index;
Fan Zhangf5395782020-04-29 14:00:03 +0100175
Benoît Ganne5527a782022-01-18 15:56:41 +0100176 u32 spi;
177 u32 seq;
178 u32 seq_hi;
Fan Zhangf5395782020-04-29 14:00:03 +0100179
Benoît Ganne5527a782022-01-18 15:56:41 +0100180 u16 crypto_enc_op_id;
181 u16 crypto_dec_op_id;
182 u16 integ_op_id;
183 ipsec_sa_flags_t flags;
184 u16 thread_index;
Fan Zhangf5395782020-04-29 14:00:03 +0100185
Benoît Ganne5527a782022-01-18 15:56:41 +0100186 u16 integ_icv_size : 6;
187 u16 crypto_iv_size : 5;
188 u16 esp_block_align : 5;
Damjan Mariond709cbc2019-03-26 13:16:42 +0100189
Benoît Ganne490b9272021-01-22 18:03:09 +0100190 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
Damjan Mariond709cbc2019-03-26 13:16:42 +0100191
192 union
193 {
194 ip4_header_t ip4_hdr;
195 ip6_header_t ip6_hdr;
196 };
197 udp_header_t udp_hdr;
198
Benoît Ganne490b9272021-01-22 18:03:09 +0100199 /* Salt used in CTR modes (incl. GCM) - stored in network byte order */
Neale Ranns80f6fd52019-04-16 02:41:34 +0000200 u32 salt;
Fan Zhangf5395782020-04-29 14:00:03 +0100201
Neale Ranns123b5eb2020-10-16 14:03:55 +0000202 ipsec_protocol_t protocol;
Neale Ranns041add72020-01-02 04:06:10 +0000203 tunnel_encap_decap_flags_t tunnel_flags;
Neale Ranns9ec846c2021-02-09 14:04:02 +0000204 u8 __pad[2];
Neale Ranns123b5eb2020-10-16 14:03:55 +0000205
206 /* data accessed by dataplane code should be above this comment */
207 CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
208
209 /* Elements with u64 size multiples */
Neale Ranns9ec846c2021-02-09 14:04:02 +0000210 tunnel_t tunnel;
Neale Ranns123b5eb2020-10-16 14:03:55 +0000211 fib_node_t node;
212
213 /* elements with u32 size */
214 u32 id;
215 u32 stat_index;
216 vnet_crypto_alg_t integ_calg;
217 vnet_crypto_alg_t crypto_calg;
Benoît Ganne5527a782022-01-18 15:56:41 +0100218 u32 crypto_sync_key_index;
219 u32 integ_sync_key_index;
220 u32 crypto_async_key_index;
221
222 /* elements with u16 size */
223 u16 crypto_sync_enc_op_id;
224 u16 crypto_sync_dec_op_id;
225 u16 integ_sync_op_id;
226 u16 crypto_async_enc_op_id;
227 u16 crypto_async_dec_op_id;
Neale Ranns123b5eb2020-10-16 14:03:55 +0000228
Neale Ranns123b5eb2020-10-16 14:03:55 +0000229 /* else u8 packed */
230 ipsec_crypto_alg_t crypto_alg;
231 ipsec_integ_alg_t integ_alg;
232
233 ipsec_key_t integ_key;
234 ipsec_key_t crypto_key;
Neale Ranns999c8ee2019-02-01 03:31:24 -0800235} ipsec_sa_t;
236
Benoît Ganne5527a782022-01-18 15:56:41 +0100237STATIC_ASSERT (VNET_CRYPTO_N_OP_IDS < (1 << 16), "crypto ops overflow");
238STATIC_ASSERT (ESP_MAX_ICV_SIZE < (1 << 6), "integer icv overflow");
239STATIC_ASSERT (ESP_MAX_IV_SIZE < (1 << 5), "esp iv overflow");
240STATIC_ASSERT (ESP_MAX_BLOCK_SIZE < (1 << 5), "esp alignment overflow");
Damjan Mariond709cbc2019-03-26 13:16:42 +0100241STATIC_ASSERT_OFFSET_OF (ipsec_sa_t, cacheline1, CLIB_CACHE_LINE_BYTES);
Neale Ranns123b5eb2020-10-16 14:03:55 +0000242STATIC_ASSERT_OFFSET_OF (ipsec_sa_t, cacheline2, 2 * CLIB_CACHE_LINE_BYTES);
Damjan Mariond709cbc2019-03-26 13:16:42 +0100243
Neale Rannsc5fe57d2021-02-25 16:01:28 +0000244/**
245 * Pool of IPSec SAs
246 */
247extern ipsec_sa_t *ipsec_sa_pool;
248
Neale Rannsaa7d7662021-02-10 08:42:49 +0000249/*
250 * Ensure that the IPsec data does not overlap with the IP data in
251 * the buffer meta data
252 */
253STATIC_ASSERT (STRUCT_OFFSET_OF (vnet_buffer_opaque_t, ipsec.sad_index) ==
254 STRUCT_OFFSET_OF (vnet_buffer_opaque_t, ip.save_protocol),
255 "IPSec data is overlapping with IP data");
256
Damjan Mariond709cbc2019-03-26 13:16:42 +0100257#define _(a,v,s) \
258 always_inline int \
259 ipsec_sa_is_set_##v (const ipsec_sa_t *sa) { \
260 return (sa->flags & IPSEC_SA_FLAG_##v); \
261 }
262foreach_ipsec_sa_flags
263#undef _
264#define _(a,v,s) \
265 always_inline int \
266 ipsec_sa_set_##v (ipsec_sa_t *sa) { \
267 return (sa->flags |= IPSEC_SA_FLAG_##v); \
268 }
269 foreach_ipsec_sa_flags
270#undef _
Neale Rannsc87b66c2019-02-07 07:26:12 -0800271#define _(a,v,s) \
272 always_inline int \
273 ipsec_sa_unset_##v (ipsec_sa_t *sa) { \
274 return (sa->flags &= ~IPSEC_SA_FLAG_##v); \
275 }
276 foreach_ipsec_sa_flags
277#undef _
Neale Rannseba31ec2019-02-17 18:04:27 +0000278/**
279 * @brief
280 * SA packet & bytes counters
281 */
282extern vlib_combined_counter_main_t ipsec_sa_counters;
Arthur de Kerhorad95b062022-11-16 19:12:05 +0100283extern vlib_simple_counter_main_t ipsec_sa_err_counters[IPSEC_SA_N_ERRORS];
Neale Rannseba31ec2019-02-17 18:04:27 +0000284
Neale Ranns8d7c5022019-02-06 01:41:05 -0800285extern void ipsec_mk_key (ipsec_key_t * key, const u8 * data, u8 len);
286
Arthur de Kerhor4117b242022-08-31 19:13:03 +0200287extern int ipsec_sa_update (u32 id, u16 src_port, u16 dst_port,
288 const tunnel_t *tun, bool is_tun);
Neale Ranns9ec846c2021-02-09 14:04:02 +0000289extern int
290ipsec_sa_add_and_lock (u32 id, u32 spi, ipsec_protocol_t proto,
291 ipsec_crypto_alg_t crypto_alg, const ipsec_key_t *ck,
292 ipsec_integ_alg_t integ_alg, const ipsec_key_t *ik,
293 ipsec_sa_flags_t flags, u32 salt, u16 src_port,
294 u16 dst_port, const tunnel_t *tun, u32 *sa_out_index);
Maxime Peim1271e3a2023-03-20 14:13:56 +0000295extern int ipsec_sa_bind (u32 id, u32 worker, bool bind);
Neale Ranns495d7ff2019-07-12 09:15:26 +0000296extern index_t ipsec_sa_find_and_lock (u32 id);
297extern int ipsec_sa_unlock_id (u32 id);
298extern void ipsec_sa_unlock (index_t sai);
Neale Ranns12989b52019-09-26 16:20:19 +0000299extern void ipsec_sa_lock (index_t sai);
Neale Rannsc87b66c2019-02-07 07:26:12 -0800300extern void ipsec_sa_clear (index_t sai);
Damjan Marionb966e8b2019-03-20 16:07:09 +0100301extern void ipsec_sa_set_crypto_alg (ipsec_sa_t * sa,
302 ipsec_crypto_alg_t crypto_alg);
303extern void ipsec_sa_set_integ_alg (ipsec_sa_t * sa,
304 ipsec_integ_alg_t integ_alg);
Benoît Ganne5527a782022-01-18 15:56:41 +0100305extern void ipsec_sa_set_async_mode (ipsec_sa_t *sa, int is_enabled);
Neale Ranns8d7c5022019-02-06 01:41:05 -0800306
Neale Rannsb4cfd552019-02-13 02:08:06 -0800307typedef walk_rc_t (*ipsec_sa_walk_cb_t) (ipsec_sa_t * sa, void *ctx);
308extern void ipsec_sa_walk (ipsec_sa_walk_cb_t cd, void *ctx);
309
Neale Rannsc5fe57d2021-02-25 16:01:28 +0000310extern u8 *format_ipsec_replay_window (u8 *s, va_list *args);
Neale Ranns999c8ee2019-02-01 03:31:24 -0800311extern u8 *format_ipsec_crypto_alg (u8 * s, va_list * args);
312extern u8 *format_ipsec_integ_alg (u8 * s, va_list * args);
Neale Ranns8d7c5022019-02-06 01:41:05 -0800313extern u8 *format_ipsec_sa (u8 * s, va_list * args);
314extern u8 *format_ipsec_key (u8 * s, va_list * args);
Neale Ranns999c8ee2019-02-01 03:31:24 -0800315extern uword unformat_ipsec_crypto_alg (unformat_input_t * input,
316 va_list * args);
317extern uword unformat_ipsec_integ_alg (unformat_input_t * input,
318 va_list * args);
Neale Ranns8d7c5022019-02-06 01:41:05 -0800319extern uword unformat_ipsec_key (unformat_input_t * input, va_list * args);
Neale Ranns999c8ee2019-02-01 03:31:24 -0800320
Filip Tehlare5d34912020-03-02 15:17:37 +0000321#define IPSEC_UDP_PORT_NONE ((u16)~0)
322
Neale Ranns6afaae12019-07-17 15:07:14 +0000323/*
324 * Anti Replay definitions
325 */
326
327#define IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE (64)
328#define IPSEC_SA_ANTI_REPLAY_WINDOW_MAX_INDEX (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE-1)
329
330/*
331 * sequence number less than the lower bound are outside of the window
332 * From RFC4303 Appendix A:
333 * Bl = Tl - W + 1
334 */
335#define IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND(_tl) (_tl - IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE + 1)
336
Neale Ranns5b891102021-06-28 13:31:28 +0000337always_inline int
338ipsec_sa_anti_replay_check (const ipsec_sa_t *sa, u32 seq)
339{
340 if (ipsec_sa_is_set_USE_ANTI_REPLAY (sa) &&
341 sa->replay_window & (1ULL << (sa->seq - seq)))
342 return 1;
343 else
344 return 0;
345}
346
Neale Ranns6afaae12019-07-17 15:07:14 +0000347/*
348 * Anti replay check.
349 * inputs need to be in host byte order.
Neale Ranns5b891102021-06-28 13:31:28 +0000350 *
351 * The function runs in two contexts. pre and post decrypt.
352 * Pre-decrypt it:
353 * 1 - determines if a packet is a replay - a simple check in the window
354 * 2 - returns the hi-seq number that should be used to decrypt.
355 * post-decrypt:
356 * Checks whether the packet is a replay or falls out of window
357 *
358 * This funcion should be called even without anti-replay enabled to ensure
359 * the high sequence number is set.
Neale Ranns6afaae12019-07-17 15:07:14 +0000360 */
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100361always_inline int
Neale Ranns5b891102021-06-28 13:31:28 +0000362ipsec_sa_anti_replay_and_sn_advance (const ipsec_sa_t *sa, u32 seq,
363 u32 hi_seq_used, bool post_decrypt,
364 u32 *hi_seq_req)
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100365{
Neale Ranns5b891102021-06-28 13:31:28 +0000366 ASSERT ((post_decrypt == false) == (hi_seq_req != 0));
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100367
Neale Ranns6afaae12019-07-17 15:07:14 +0000368 if (!ipsec_sa_is_set_USE_ESN (sa))
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100369 {
Neale Ranns5b891102021-06-28 13:31:28 +0000370 if (hi_seq_req)
371 /* no ESN, therefore the hi-seq is always 0 */
372 *hi_seq_req = 0;
373
374 if (!ipsec_sa_is_set_USE_ANTI_REPLAY (sa))
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100375 return 0;
376
Neale Ranns5b891102021-06-28 13:31:28 +0000377 if (PREDICT_TRUE (seq > sa->seq))
378 return 0;
379
380 u32 diff = sa->seq - seq;
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100381
382 if (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE > diff)
Neale Ranns5b891102021-06-28 13:31:28 +0000383 return ((sa->replay_window & (1ULL << diff)) ? 1 : 0);
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100384 else
385 return 1;
386
387 return 0;
388 }
389
Neale Ranns5b891102021-06-28 13:31:28 +0000390 if (!ipsec_sa_is_set_USE_ANTI_REPLAY (sa))
391 {
392 /* there's no AR configured for this SA, but in order
393 * to know whether a packet has wrapped the hi ESN we need
394 * to know whether it is out of window. if we use the default
395 * lower bound then we are effectively forcing AR because
396 * out of window packets will get the increased hi seq number
397 * and will thus fail to decrypt. IOW we need a window to know
398 * if the SN has wrapped, but we don't want a window to check for
399 * anti replay. to resolve the contradiction we use a huge window.
400 * if the packet is not within 2^30 of the current SN, we'll consider
401 * it a wrap.
402 */
403 if (hi_seq_req)
404 {
405 if (seq >= sa->seq)
406 /* The packet's sequence number is larger that the SA's.
407 * that can't be a warp - unless we lost more than
408 * 2^32 packets ... how could we know? */
409 *hi_seq_req = sa->seq_hi;
410 else
411 {
412 /* The packet's SN is less than the SAs, so either the SN has
413 * wrapped or the SN is just old. */
414 if (sa->seq - seq > (1 << 30))
415 /* It's really really really old => it wrapped */
416 *hi_seq_req = sa->seq_hi + 1;
417 else
418 *hi_seq_req = sa->seq_hi;
419 }
420 }
421 /*
422 * else
423 * this is post-decrpyt and since it decrypted we accept it
424 */
425 return 0;
426 }
427 if (PREDICT_TRUE (sa->seq >= (IPSEC_SA_ANTI_REPLAY_WINDOW_MAX_INDEX)))
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100428 {
Neale Ranns6afaae12019-07-17 15:07:14 +0000429 /*
430 * the last sequence number VPP recieved is more than one
431 * window size greater than zero.
432 * Case A from RFC4303 Appendix A.
433 */
Neale Ranns5b891102021-06-28 13:31:28 +0000434 if (seq < IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND (sa->seq))
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100435 {
Neale Ranns6afaae12019-07-17 15:07:14 +0000436 /*
437 * the received sequence number is lower than the lower bound
438 * of the window, this could mean either a replay packet or that
439 * the high sequence number has wrapped. if it decrypts corrently
440 * then it's the latter.
441 */
Neale Ranns5b891102021-06-28 13:31:28 +0000442 if (post_decrypt)
443 {
444 if (hi_seq_used == sa->seq_hi)
445 /* the high sequence number used to succesfully decrypt this
446 * packet is the same as the last-sequnence number of the SA.
447 * that means this packet did not cause a wrap.
448 * this packet is thus out of window and should be dropped */
449 return 1;
450 else
451 /* The packet decrypted with a different high sequence number
452 * to the SA, that means it is the wrap packet and should be
453 * accepted */
454 return 0;
455 }
456 else
457 {
458 /* pre-decrypt it might be the might that casues a wrap, we
459 * need to decrpyt to find out */
460 if (hi_seq_req)
461 *hi_seq_req = sa->seq_hi + 1;
462 return 0;
463 }
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100464 }
465 else
466 {
Neale Ranns6afaae12019-07-17 15:07:14 +0000467 /*
468 * the recieved sequence number greater than the low
469 * end of the window.
470 */
Neale Ranns5b891102021-06-28 13:31:28 +0000471 if (hi_seq_req)
472 *hi_seq_req = sa->seq_hi;
473 if (seq <= sa->seq)
Neale Ranns6afaae12019-07-17 15:07:14 +0000474 /*
475 * The recieved seq number is within bounds of the window
476 * check if it's a duplicate
477 */
Neale Ranns5b891102021-06-28 13:31:28 +0000478 return (ipsec_sa_anti_replay_check (sa, seq));
Neale Ranns6afaae12019-07-17 15:07:14 +0000479 else
480 /*
481 * The received sequence number is greater than the window
482 * upper bound. this packet will move the window along, assuming
483 * it decrypts correctly.
484 */
485 return 0;
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100486 }
487 }
488 else
489 {
Neale Ranns6afaae12019-07-17 15:07:14 +0000490 /*
491 * the last sequence number VPP recieved is within one window
492 * size of zero, i.e. 0 < TL < WINDOW_SIZE, the lower bound is thus a
493 * large sequence number.
494 * Note that the check below uses unsiged integer arthimetic, so the
495 * RHS will be a larger number.
496 * Case B from RFC4303 Appendix A.
497 */
Neale Ranns5b891102021-06-28 13:31:28 +0000498 if (seq < IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND (sa->seq))
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100499 {
Neale Ranns6afaae12019-07-17 15:07:14 +0000500 /*
501 * the sequence number is less than the lower bound.
502 */
Neale Ranns5b891102021-06-28 13:31:28 +0000503 if (seq <= sa->seq)
Neale Ranns6afaae12019-07-17 15:07:14 +0000504 {
505 /*
506 * the packet is within the window upper bound.
507 * check for duplicates.
508 */
Neale Ranns5b891102021-06-28 13:31:28 +0000509 if (hi_seq_req)
510 *hi_seq_req = sa->seq_hi;
511 return (ipsec_sa_anti_replay_check (sa, seq));
Neale Ranns6afaae12019-07-17 15:07:14 +0000512 }
513 else
514 {
515 /*
516 * the packet is less the window lower bound or greater than
517 * the higher bound, depending on how you look at it...
518 * We're assuming, given that the last sequence number received,
519 * TL < WINDOW_SIZE, that a largeer seq num is more likely to be
520 * a packet that moves the window forward, than a packet that has
521 * wrapped the high sequence again. If it were the latter then
522 * we've lost close to 2^32 packets.
523 */
Neale Ranns5b891102021-06-28 13:31:28 +0000524 if (hi_seq_req)
525 *hi_seq_req = sa->seq_hi;
Neale Ranns6afaae12019-07-17 15:07:14 +0000526 return 0;
527 }
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100528 }
529 else
530 {
Neale Ranns6afaae12019-07-17 15:07:14 +0000531 /*
532 * the packet seq number is between the lower bound (a large nubmer)
533 * and MAX_SEQ_NUM. This is in the window since the window upper bound
534 * tl > 0.
535 * However, since TL is the other side of 0 to the received
536 * packet, the SA has moved on to a higher sequence number.
537 */
Neale Ranns5b891102021-06-28 13:31:28 +0000538 if (hi_seq_req)
539 *hi_seq_req = sa->seq_hi - 1;
540 return (ipsec_sa_anti_replay_check (sa, seq));
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100541 }
542 }
543
Neale Ranns5b891102021-06-28 13:31:28 +0000544 /* unhandled case */
545 ASSERT (0);
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100546 return 0;
547}
548
Neale Rannse11203e2021-09-21 12:34:19 +0000549always_inline u32
550ipsec_sa_anti_replay_window_shift (ipsec_sa_t *sa, u32 inc)
551{
552 u32 n_lost = 0;
553
554 if (inc < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
555 {
556 if (sa->seq > IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
557 {
558 /*
559 * count how many holes there are in the portion
560 * of the window that we will right shift of the end
561 * as a result of this increments
562 */
563 u64 mask = (((u64) 1 << inc) - 1) << (BITS (u64) - inc);
564 u64 old = sa->replay_window & mask;
565 /* the number of packets we saw in this section of the window */
566 u64 seen = count_set_bits (old);
567
568 /*
569 * the number we missed is the size of the window section
570 * minus the number we saw.
571 */
572 n_lost = inc - seen;
573 }
574 sa->replay_window = ((sa->replay_window) << inc) | 1;
575 }
576 else
577 {
578 /* holes in the replay window are lost packets */
579 n_lost = BITS (u64) - count_set_bits (sa->replay_window);
580
581 /* any sequence numbers that now fall outside the window
582 * are forever lost */
583 n_lost += inc - IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE;
584
585 sa->replay_window = 1;
586 }
587
588 return (n_lost);
589}
590
Neale Ranns6afaae12019-07-17 15:07:14 +0000591/*
592 * Anti replay window advance
593 * inputs need to be in host byte order.
Neale Ranns5b891102021-06-28 13:31:28 +0000594 * This function both advances the anti-replay window and the sequence number
595 * We always need to move on the SN but the window updates are only needed
596 * if AR is on.
597 * However, updating the window is trivial, so we do it anyway to save
598 * the branch cost.
Neale Ranns6afaae12019-07-17 15:07:14 +0000599 */
Neale Rannse11203e2021-09-21 12:34:19 +0000600always_inline u64
601ipsec_sa_anti_replay_advance (ipsec_sa_t *sa, u32 thread_index, u32 seq,
602 u32 hi_seq)
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100603{
Neale Rannse11203e2021-09-21 12:34:19 +0000604 u64 n_lost = 0;
Neale Ranns6afaae12019-07-17 15:07:14 +0000605 u32 pos;
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100606
Neale Ranns5b891102021-06-28 13:31:28 +0000607 if (ipsec_sa_is_set_USE_ESN (sa))
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100608 {
Neale Ranns5b891102021-06-28 13:31:28 +0000609 int wrap = hi_seq - sa->seq_hi;
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100610
Neale Ranns5b891102021-06-28 13:31:28 +0000611 if (wrap == 0 && seq > sa->seq)
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100612 {
Neale Ranns5b891102021-06-28 13:31:28 +0000613 pos = seq - sa->seq;
Neale Rannse11203e2021-09-21 12:34:19 +0000614 n_lost = ipsec_sa_anti_replay_window_shift (sa, pos);
Neale Ranns5b891102021-06-28 13:31:28 +0000615 sa->seq = seq;
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100616 }
617 else if (wrap > 0)
618 {
Neale Ranns5b891102021-06-28 13:31:28 +0000619 pos = ~seq + sa->seq + 1;
Neale Rannse11203e2021-09-21 12:34:19 +0000620 n_lost = ipsec_sa_anti_replay_window_shift (sa, pos);
Neale Ranns5b891102021-06-28 13:31:28 +0000621 sa->seq = seq;
622 sa->seq_hi = hi_seq;
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100623 }
624 else if (wrap < 0)
625 {
Neale Ranns5b891102021-06-28 13:31:28 +0000626 pos = ~seq + sa->seq + 1;
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100627 sa->replay_window |= (1ULL << pos);
628 }
629 else
630 {
Neale Ranns5b891102021-06-28 13:31:28 +0000631 pos = sa->seq - seq;
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100632 sa->replay_window |= (1ULL << pos);
633 }
634 }
635 else
636 {
Neale Ranns5b891102021-06-28 13:31:28 +0000637 if (seq > sa->seq)
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100638 {
Neale Ranns5b891102021-06-28 13:31:28 +0000639 pos = seq - sa->seq;
Neale Rannse11203e2021-09-21 12:34:19 +0000640 n_lost = ipsec_sa_anti_replay_window_shift (sa, pos);
Neale Ranns5b891102021-06-28 13:31:28 +0000641 sa->seq = seq;
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100642 }
643 else
644 {
Neale Ranns5b891102021-06-28 13:31:28 +0000645 pos = sa->seq - seq;
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100646 sa->replay_window |= (1ULL << pos);
647 }
648 }
Neale Rannse11203e2021-09-21 12:34:19 +0000649
650 return n_lost;
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100651}
652
Neale Rannsf62a8c02019-04-02 08:13:33 +0000653
654/*
655 * Makes choice for thread_id should be assigned.
656 * if input ~0, gets random worker_id based on unix_time_now_nsec
657*/
Benoît Ganne5527a782022-01-18 15:56:41 +0100658always_inline u16
659ipsec_sa_assign_thread (u16 thread_id)
Neale Rannsf62a8c02019-04-02 08:13:33 +0000660{
661 return ((thread_id) ? thread_id
662 : (unix_time_now_nsec () % vlib_num_workers ()) + 1);
663}
664
Neale Rannsc5fe57d2021-02-25 16:01:28 +0000665always_inline ipsec_sa_t *
666ipsec_sa_get (u32 sa_index)
667{
668 return (pool_elt_at_index (ipsec_sa_pool, sa_index));
669}
670
Neale Ranns999c8ee2019-02-01 03:31:24 -0800671#endif /* __IPSEC_SPD_SA_H__ */
672
673/*
674 * fd.io coding-style-patch-verification: ON
675 *
676 * Local Variables:
677 * eval: (c-set-style "gnu")
678 * End:
679 */