blob: 2c1efa2f4bed0dd9e42c0dc6c8c62c4d2e070f20 [file] [log] [blame]
Ed Warnickecb9cada2015-12-08 15:45:58 -07001/*
2 * esp_decrypt.c : IPSec ESP decrypt node
3 *
4 * Copyright (c) 2015 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
Ed Warnickecb9cada2015-12-08 15:45:58 -070017#include <vnet/vnet.h>
18#include <vnet/api_errno.h>
19#include <vnet/ip/ip.h>
John Lo90430b62020-01-31 23:48:30 -050020#include <vnet/l2/l2_input.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070021
22#include <vnet/ipsec/ipsec.h>
23#include <vnet/ipsec/esp.h>
Neale Ranns918c1612019-02-21 23:34:59 -080024#include <vnet/ipsec/ipsec_io.h>
Neale Rannsc87b66c2019-02-07 07:26:12 -080025#include <vnet/ipsec/ipsec_tun.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070026
Neale Ranns119c0d72020-11-26 13:12:37 +000027#include <vnet/gre/packet.h>
Neale Ranns568acbb2019-12-18 05:54:40 +000028
Neale Ranns4a58e492020-12-21 13:19:10 +000029#define foreach_esp_decrypt_next \
30 _ (DROP, "error-drop") \
31 _ (IP4_INPUT, "ip4-input-no-checksum") \
32 _ (IP6_INPUT, "ip6-input") \
33 _ (L2_INPUT, "l2-input") \
34 _ (MPLS_INPUT, "mpls-input") \
35 _ (HANDOFF, "handoff")
Ed Warnickecb9cada2015-12-08 15:45:58 -070036
37#define _(v, s) ESP_DECRYPT_NEXT_##v,
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070038typedef enum
39{
Ed Warnickecb9cada2015-12-08 15:45:58 -070040 foreach_esp_decrypt_next
41#undef _
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070042 ESP_DECRYPT_N_NEXT,
Ed Warnickecb9cada2015-12-08 15:45:58 -070043} esp_decrypt_next_t;
44
Neale Ranns4a58e492020-12-21 13:19:10 +000045#define foreach_esp_decrypt_post_next \
46 _ (DROP, "error-drop") \
47 _ (IP4_INPUT, "ip4-input-no-checksum") \
48 _ (IP6_INPUT, "ip6-input") \
49 _ (MPLS_INPUT, "mpls-input") \
50 _ (L2_INPUT, "l2-input")
Fan Zhangf5395782020-04-29 14:00:03 +010051
52#define _(v, s) ESP_DECRYPT_POST_NEXT_##v,
53typedef enum
54{
55 foreach_esp_decrypt_post_next
56#undef _
57 ESP_DECRYPT_POST_N_NEXT,
58} esp_decrypt_post_next_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -070059
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070060typedef struct
61{
Damjan Marionb4fff3a2019-03-25 15:54:40 +010062 u32 seq;
Neale Ranns6afaae12019-07-17 15:07:14 +000063 u32 sa_seq;
64 u32 sa_seq_hi;
Neale Ranns5b891102021-06-28 13:31:28 +000065 u32 pkt_seq_hi;
Ed Warnickecb9cada2015-12-08 15:45:58 -070066 ipsec_crypto_alg_t crypto_alg;
67 ipsec_integ_alg_t integ_alg;
68} esp_decrypt_trace_t;
69
Neale Ranns93688d72022-08-09 03:34:51 +000070typedef vl_counter_esp_decrypt_enum_t esp_decrypt_error_t;
71
Neale Ranns5b891102021-06-28 13:31:28 +000072/* The number of byres in the hisequence number */
73#define N_HI_ESN_BYTES 4
74
Ed Warnickecb9cada2015-12-08 15:45:58 -070075/* packet trace format function */
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070076static u8 *
77format_esp_decrypt_trace (u8 * s, va_list * args)
Ed Warnickecb9cada2015-12-08 15:45:58 -070078{
79 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
80 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070081 esp_decrypt_trace_t *t = va_arg (*args, esp_decrypt_trace_t *);
Ed Warnickecb9cada2015-12-08 15:45:58 -070082
Neale Ranns5b891102021-06-28 13:31:28 +000083 s = format (s,
84 "esp: crypto %U integrity %U pkt-seq %d sa-seq %u sa-seq-hi %u "
85 "pkt-seq-hi %u",
86 format_ipsec_crypto_alg, t->crypto_alg, format_ipsec_integ_alg,
87 t->integ_alg, t->seq, t->sa_seq, t->sa_seq_hi, t->pkt_seq_hi);
Ed Warnickecb9cada2015-12-08 15:45:58 -070088 return s;
89}
90
Damjan Marionb4fff3a2019-03-25 15:54:40 +010091#define ESP_ENCRYPT_PD_F_FD_TRANSPORT (1 << 2)
Ed Warnickecb9cada2015-12-08 15:45:58 -070092
Filip Tehlarefcad1a2020-02-04 09:36:04 +000093static_always_inline void
94esp_process_ops (vlib_main_t * vm, vlib_node_runtime_t * node,
95 vnet_crypto_op_t * ops, vlib_buffer_t * b[], u16 * nexts,
96 int e)
97{
98 vnet_crypto_op_t *op = ops;
99 u32 n_fail, n_ops = vec_len (ops);
100
101 if (n_ops == 0)
102 return;
103
104 n_fail = n_ops - vnet_crypto_process_ops (vm, op, n_ops);
105
106 while (n_fail)
107 {
108 ASSERT (op - ops < n_ops);
109 if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
110 {
111 u32 err, bi = op->user_data;
112 if (op->status == VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC)
113 err = e;
114 else
115 err = ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR;
Arthur de Kerhorad95b062022-11-16 19:12:05 +0100116 esp_decrypt_set_next_index (b[bi], node, vm->thread_index, err, bi,
117 nexts, ESP_DECRYPT_NEXT_DROP,
118 vnet_buffer (b[bi])->ipsec.sad_index);
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000119 n_fail--;
120 }
121 op++;
122 }
123}
124
125static_always_inline void
126esp_process_chained_ops (vlib_main_t * vm, vlib_node_runtime_t * node,
127 vnet_crypto_op_t * ops, vlib_buffer_t * b[],
128 u16 * nexts, vnet_crypto_op_chunk_t * chunks, int e)
129{
130
131 vnet_crypto_op_t *op = ops;
132 u32 n_fail, n_ops = vec_len (ops);
133
Neale Rannsf16e9a52021-02-25 19:09:24 +0000134 if (PREDICT_TRUE (n_ops == 0))
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000135 return;
136
137 n_fail = n_ops - vnet_crypto_process_chained_ops (vm, op, chunks, n_ops);
138
139 while (n_fail)
140 {
141 ASSERT (op - ops < n_ops);
142 if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
143 {
144 u32 err, bi = op->user_data;
145 if (op->status == VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC)
146 err = e;
147 else
148 err = ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR;
Arthur de Kerhorad95b062022-11-16 19:12:05 +0100149 esp_decrypt_set_next_index (b[bi], node, vm->thread_index, err, bi,
150 nexts, ESP_DECRYPT_NEXT_DROP,
151 vnet_buffer (b[bi])->ipsec.sad_index);
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000152 n_fail--;
153 }
154 op++;
155 }
156}
157
158always_inline void
159esp_remove_tail (vlib_main_t * vm, vlib_buffer_t * b, vlib_buffer_t * last,
160 u16 tail)
161{
162 vlib_buffer_t *before_last = b;
163
164 if (last->current_length > tail)
165 {
166 last->current_length -= tail;
167 return;
168 }
169 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
170
171 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
172 {
173 before_last = b;
174 b = vlib_get_buffer (vm, b->next_buffer);
175 }
176 before_last->current_length -= tail - last->current_length;
177 vlib_buffer_free_one (vm, before_last->next_buffer);
178 before_last->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
179}
180
181/* ICV is splitted in last two buffers so move it to the last buffer and
182 return pointer to it */
183static_always_inline u8 *
184esp_move_icv (vlib_main_t * vm, vlib_buffer_t * first,
PiotrX Kleskia9585fd2020-12-11 15:10:31 +0000185 esp_decrypt_packet_data_t * pd,
Fan Zhangf5395782020-04-29 14:00:03 +0100186 esp_decrypt_packet_data2_t * pd2, u16 icv_sz, u16 * dif)
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000187{
188 vlib_buffer_t *before_last, *bp;
Fan Zhangf5395782020-04-29 14:00:03 +0100189 u16 last_sz = pd2->lb->current_length;
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000190 u16 first_sz = icv_sz - last_sz;
191
192 bp = before_last = first;
193 while (bp->flags & VLIB_BUFFER_NEXT_PRESENT)
194 {
195 before_last = bp;
196 bp = vlib_get_buffer (vm, bp->next_buffer);
197 }
198
Fan Zhangf5395782020-04-29 14:00:03 +0100199 u8 *lb_curr = vlib_buffer_get_current (pd2->lb);
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000200 memmove (lb_curr + first_sz, lb_curr, last_sz);
201 clib_memcpy_fast (lb_curr, vlib_buffer_get_tail (before_last) - first_sz,
202 first_sz);
203 before_last->current_length -= first_sz;
PiotrX Kleskia9585fd2020-12-11 15:10:31 +0000204 if (before_last == first)
205 pd->current_length -= first_sz;
Fan Zhangf5395782020-04-29 14:00:03 +0100206 clib_memset (vlib_buffer_get_tail (before_last), 0, first_sz);
Filip Tehlare4e8c6b2020-02-13 07:49:30 +0000207 if (dif)
208 dif[0] = first_sz;
Fan Zhangf5395782020-04-29 14:00:03 +0100209 pd2->lb = before_last;
210 pd2->icv_removed = 1;
211 pd2->free_buffer_index = before_last->next_buffer;
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000212 before_last->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
213 return lb_curr;
214}
215
Neale Ranns5b891102021-06-28 13:31:28 +0000216static_always_inline u16
217esp_insert_esn (vlib_main_t *vm, ipsec_sa_t *sa, esp_decrypt_packet_data_t *pd,
218 esp_decrypt_packet_data2_t *pd2, u32 *data_len, u8 **digest,
219 u16 *len, vlib_buffer_t *b, u8 *payload)
Filip Tehlare4e8c6b2020-02-13 07:49:30 +0000220{
221 if (!ipsec_sa_is_set_USE_ESN (sa))
Fan Zhangf5395782020-04-29 14:00:03 +0100222 return 0;
Filip Tehlare4e8c6b2020-02-13 07:49:30 +0000223 /* shift ICV by 4 bytes to insert ESN */
Neale Ranns5b891102021-06-28 13:31:28 +0000224 u32 seq_hi = clib_host_to_net_u32 (pd->seq_hi);
225 u8 tmp[ESP_MAX_ICV_SIZE];
Filip Tehlare4e8c6b2020-02-13 07:49:30 +0000226
Fan Zhangf5395782020-04-29 14:00:03 +0100227 if (pd2->icv_removed)
Filip Tehlare4e8c6b2020-02-13 07:49:30 +0000228 {
Fan Zhangf5395782020-04-29 14:00:03 +0100229 u16 space_left = vlib_buffer_space_left_at_end (vm, pd2->lb);
Neale Ranns5b891102021-06-28 13:31:28 +0000230 if (space_left >= N_HI_ESN_BYTES)
Filip Tehlare4e8c6b2020-02-13 07:49:30 +0000231 {
Neale Ranns5b891102021-06-28 13:31:28 +0000232 clib_memcpy_fast (vlib_buffer_get_tail (pd2->lb), &seq_hi,
233 N_HI_ESN_BYTES);
234 *data_len += N_HI_ESN_BYTES;
Filip Tehlare4e8c6b2020-02-13 07:49:30 +0000235 }
236 else
Neale Ranns5b891102021-06-28 13:31:28 +0000237 return N_HI_ESN_BYTES;
Filip Tehlare4e8c6b2020-02-13 07:49:30 +0000238
239 len[0] = b->current_length;
240 }
241 else
242 {
243 clib_memcpy_fast (tmp, payload + len[0], ESP_MAX_ICV_SIZE);
Neale Ranns5b891102021-06-28 13:31:28 +0000244 clib_memcpy_fast (payload + len[0], &seq_hi, N_HI_ESN_BYTES);
245 clib_memcpy_fast (payload + len[0] + N_HI_ESN_BYTES, tmp,
246 ESP_MAX_ICV_SIZE);
247 *data_len += N_HI_ESN_BYTES;
248 *digest += N_HI_ESN_BYTES;
Filip Tehlare4e8c6b2020-02-13 07:49:30 +0000249 }
Neale Ranns5b891102021-06-28 13:31:28 +0000250 return N_HI_ESN_BYTES;
Filip Tehlare4e8c6b2020-02-13 07:49:30 +0000251}
252
253static_always_inline u8 *
254esp_move_icv_esn (vlib_main_t * vm, vlib_buffer_t * first,
PiotrX Kleskia9585fd2020-12-11 15:10:31 +0000255 esp_decrypt_packet_data_t * pd,
Fan Zhangf5395782020-04-29 14:00:03 +0100256 esp_decrypt_packet_data2_t * pd2, u16 icv_sz,
257 ipsec_sa_t * sa, u8 * extra_esn, u32 * len)
Filip Tehlare4e8c6b2020-02-13 07:49:30 +0000258{
259 u16 dif = 0;
PiotrX Kleskia9585fd2020-12-11 15:10:31 +0000260 u8 *digest = esp_move_icv (vm, first, pd, pd2, icv_sz, &dif);
Filip Tehlare4e8c6b2020-02-13 07:49:30 +0000261 if (dif)
Fan Zhangf5395782020-04-29 14:00:03 +0100262 *len -= dif;
Filip Tehlare4e8c6b2020-02-13 07:49:30 +0000263
264 if (ipsec_sa_is_set_USE_ESN (sa))
265 {
Neale Ranns5b891102021-06-28 13:31:28 +0000266 u32 seq_hi = clib_host_to_net_u32 (pd->seq_hi);
Fan Zhangf5395782020-04-29 14:00:03 +0100267 u16 space_left = vlib_buffer_space_left_at_end (vm, pd2->lb);
Filip Tehlare4e8c6b2020-02-13 07:49:30 +0000268
Neale Ranns5b891102021-06-28 13:31:28 +0000269 if (space_left >= N_HI_ESN_BYTES)
Filip Tehlare4e8c6b2020-02-13 07:49:30 +0000270 {
Neale Ranns5b891102021-06-28 13:31:28 +0000271 clib_memcpy_fast (vlib_buffer_get_tail (pd2->lb), &seq_hi,
272 N_HI_ESN_BYTES);
273 *len += N_HI_ESN_BYTES;
Filip Tehlare4e8c6b2020-02-13 07:49:30 +0000274 }
275 else
276 {
277 /* no space for ESN at the tail, use the next buffer
278 * (with ICV data) */
Fan Zhangf5395782020-04-29 14:00:03 +0100279 ASSERT (pd2->icv_removed);
280 vlib_buffer_t *tmp = vlib_get_buffer (vm, pd2->free_buffer_index);
Neale Ranns5b891102021-06-28 13:31:28 +0000281 clib_memcpy_fast (vlib_buffer_get_current (tmp) - N_HI_ESN_BYTES,
282 &seq_hi, N_HI_ESN_BYTES);
Filip Tehlare4e8c6b2020-02-13 07:49:30 +0000283 extra_esn[0] = 1;
284 }
285 }
286 return digest;
287}
288
Fan Zhangf5395782020-04-29 14:00:03 +0100289static_always_inline int
Neale Ranns5b891102021-06-28 13:31:28 +0000290esp_decrypt_chain_integ (vlib_main_t *vm, ipsec_per_thread_data_t *ptd,
291 const esp_decrypt_packet_data_t *pd,
292 esp_decrypt_packet_data2_t *pd2, ipsec_sa_t *sa0,
293 vlib_buffer_t *b, u8 icv_sz, u8 *start_src,
294 u32 start_len, u8 **digest, u16 *n_ch,
295 u32 *integ_total_len)
Fan Zhangf5395782020-04-29 14:00:03 +0100296{
297 vnet_crypto_op_chunk_t *ch;
298 vlib_buffer_t *cb = vlib_get_buffer (vm, b->next_buffer);
299 u16 n_chunks = 1;
300 u32 total_len;
301 vec_add2 (ptd->chunks, ch, 1);
302 total_len = ch->len = start_len;
303 ch->src = start_src;
304
305 while (1)
306 {
307 vec_add2 (ptd->chunks, ch, 1);
308 n_chunks += 1;
309 ch->src = vlib_buffer_get_current (cb);
310 if (pd2->lb == cb)
311 {
312 if (pd2->icv_removed)
313 ch->len = cb->current_length;
314 else
315 ch->len = cb->current_length - icv_sz;
316 if (ipsec_sa_is_set_USE_ESN (sa0))
317 {
Neale Ranns5b891102021-06-28 13:31:28 +0000318 u32 seq_hi = clib_host_to_net_u32 (pd->seq_hi);
319 u8 tmp[ESP_MAX_ICV_SIZE];
Fan Zhangf5395782020-04-29 14:00:03 +0100320 u8 *esn;
321 vlib_buffer_t *tmp_b;
322 u16 space_left = vlib_buffer_space_left_at_end (vm, pd2->lb);
Neale Ranns5b891102021-06-28 13:31:28 +0000323 if (space_left < N_HI_ESN_BYTES)
Fan Zhangf5395782020-04-29 14:00:03 +0100324 {
325 if (pd2->icv_removed)
326 {
327 /* use pre-data area from the last bufer
328 that was removed from the chain */
329 tmp_b = vlib_get_buffer (vm, pd2->free_buffer_index);
Neale Ranns5b891102021-06-28 13:31:28 +0000330 esn = tmp_b->data - N_HI_ESN_BYTES;
Fan Zhangf5395782020-04-29 14:00:03 +0100331 }
332 else
333 {
334 /* no space, need to allocate new buffer */
335 u32 tmp_bi = 0;
336 if (vlib_buffer_alloc (vm, &tmp_bi, 1) != 1)
337 return -1;
338 tmp_b = vlib_get_buffer (vm, tmp_bi);
339 esn = tmp_b->data;
340 pd2->free_buffer_index = tmp_bi;
341 }
Neale Ranns5b891102021-06-28 13:31:28 +0000342 clib_memcpy_fast (esn, &seq_hi, N_HI_ESN_BYTES);
Fan Zhangf5395782020-04-29 14:00:03 +0100343
344 vec_add2 (ptd->chunks, ch, 1);
345 n_chunks += 1;
346 ch->src = esn;
Neale Ranns5b891102021-06-28 13:31:28 +0000347 ch->len = N_HI_ESN_BYTES;
Fan Zhangf5395782020-04-29 14:00:03 +0100348 }
349 else
350 {
351 if (pd2->icv_removed)
352 {
Neale Ranns5b891102021-06-28 13:31:28 +0000353 clib_memcpy_fast (vlib_buffer_get_tail (pd2->lb),
354 &seq_hi, N_HI_ESN_BYTES);
Fan Zhangf5395782020-04-29 14:00:03 +0100355 }
356 else
357 {
358 clib_memcpy_fast (tmp, *digest, ESP_MAX_ICV_SIZE);
Neale Ranns5b891102021-06-28 13:31:28 +0000359 clib_memcpy_fast (*digest, &seq_hi, N_HI_ESN_BYTES);
360 clib_memcpy_fast (*digest + N_HI_ESN_BYTES, tmp,
361 ESP_MAX_ICV_SIZE);
362 *digest += N_HI_ESN_BYTES;
Fan Zhangf5395782020-04-29 14:00:03 +0100363 }
Neale Ranns5b891102021-06-28 13:31:28 +0000364 ch->len += N_HI_ESN_BYTES;
Fan Zhangf5395782020-04-29 14:00:03 +0100365 }
366 }
367 total_len += ch->len;
368 break;
369 }
370 else
371 total_len += ch->len = cb->current_length;
372
373 if (!(cb->flags & VLIB_BUFFER_NEXT_PRESENT))
374 break;
375
376 cb = vlib_get_buffer (vm, cb->next_buffer);
377 }
378
379 if (n_ch)
380 *n_ch = n_chunks;
381 if (integ_total_len)
382 *integ_total_len = total_len;
383
384 return 0;
385}
386
387static_always_inline u32
388esp_decrypt_chain_crypto (vlib_main_t * vm, ipsec_per_thread_data_t * ptd,
PiotrX Kleskia9585fd2020-12-11 15:10:31 +0000389 esp_decrypt_packet_data_t * pd,
Fan Zhangf5395782020-04-29 14:00:03 +0100390 esp_decrypt_packet_data2_t * pd2,
391 ipsec_sa_t * sa0, vlib_buffer_t * b, u8 icv_sz,
392 u8 * start, u32 start_len, u8 ** tag, u16 * n_ch)
393{
394 vnet_crypto_op_chunk_t *ch;
395 vlib_buffer_t *cb = b;
396 u16 n_chunks = 1;
397 u32 total_len;
398 vec_add2 (ptd->chunks, ch, 1);
399 total_len = ch->len = start_len;
400 ch->src = ch->dst = start;
401 cb = vlib_get_buffer (vm, cb->next_buffer);
402 n_chunks = 1;
403
404 while (1)
405 {
406 vec_add2 (ptd->chunks, ch, 1);
407 n_chunks += 1;
408 ch->src = ch->dst = vlib_buffer_get_current (cb);
409 if (pd2->lb == cb)
410 {
411 if (ipsec_sa_is_set_IS_AEAD (sa0))
412 {
413 if (pd2->lb->current_length < icv_sz)
414 {
415 u16 dif = 0;
PiotrX Kleskia9585fd2020-12-11 15:10:31 +0000416 *tag = esp_move_icv (vm, b, pd, pd2, icv_sz, &dif);
Fan Zhangf5395782020-04-29 14:00:03 +0100417
418 /* this chunk does not contain crypto data */
419 n_chunks -= 1;
420 /* and fix previous chunk's length as it might have
421 been changed */
422 ASSERT (n_chunks > 0);
423 if (pd2->lb == b)
424 {
425 total_len -= dif;
426 ch[-1].len -= dif;
427 }
428 else
429 {
430 total_len = total_len + pd2->lb->current_length -
431 ch[-1].len;
432 ch[-1].len = pd2->lb->current_length;
433 }
434 break;
435 }
436 else
437 *tag = vlib_buffer_get_tail (pd2->lb) - icv_sz;
438 }
439
440 if (pd2->icv_removed)
441 total_len += ch->len = cb->current_length;
442 else
443 total_len += ch->len = cb->current_length - icv_sz;
444 }
445 else
446 total_len += ch->len = cb->current_length;
447
448 if (!(cb->flags & VLIB_BUFFER_NEXT_PRESENT))
449 break;
450
451 cb = vlib_get_buffer (vm, cb->next_buffer);
452 }
453
454 if (n_ch)
455 *n_ch = n_chunks;
456
457 return total_len;
458}
459
460static_always_inline void
461esp_decrypt_prepare_sync_op (vlib_main_t * vm, vlib_node_runtime_t * node,
462 ipsec_per_thread_data_t * ptd,
463 vnet_crypto_op_t *** crypto_ops,
464 vnet_crypto_op_t *** integ_ops,
465 vnet_crypto_op_t * op,
466 ipsec_sa_t * sa0, u8 * payload,
467 u16 len, u8 icv_sz, u8 iv_sz,
468 esp_decrypt_packet_data_t * pd,
469 esp_decrypt_packet_data2_t * pd2,
470 vlib_buffer_t * b, u16 * next, u32 index)
471{
472 const u8 esp_sz = sizeof (esp_header_t);
473
474 if (PREDICT_TRUE (sa0->integ_op_id != VNET_CRYPTO_OP_NONE))
475 {
476 vnet_crypto_op_init (op, sa0->integ_op_id);
477 op->key_index = sa0->integ_key_index;
478 op->src = payload;
479 op->flags = VNET_CRYPTO_OP_FLAG_HMAC_CHECK;
480 op->user_data = index;
481 op->digest = payload + len;
482 op->digest_len = icv_sz;
483 op->len = len;
484
485 if (pd->is_chain)
486 {
487 /* buffer is chained */
488 op->len = pd->current_length;
489
490 /* special case when ICV is splitted and needs to be reassembled
491 * first -> move it to the last buffer. Also take into account
492 * that ESN needs to be added after encrypted data and may or
493 * may not fit in the tail.*/
494 if (pd2->lb->current_length < icv_sz)
495 {
496 u8 extra_esn = 0;
497 op->digest =
PiotrX Kleskia9585fd2020-12-11 15:10:31 +0000498 esp_move_icv_esn (vm, b, pd, pd2, icv_sz, sa0,
Fan Zhangf5395782020-04-29 14:00:03 +0100499 &extra_esn, &op->len);
500
501 if (extra_esn)
502 {
503 /* esn is in the last buffer, that was unlinked from
504 * the chain */
505 op->len = b->current_length;
506 }
507 else
508 {
509 if (pd2->lb == b)
510 {
511 /* we now have a single buffer of crypto data, adjust
512 * the length (second buffer contains only ICV) */
513 *integ_ops = &ptd->integ_ops;
514 *crypto_ops = &ptd->crypto_ops;
515 len = b->current_length;
516 goto out;
517 }
518 }
519 }
520 else
521 op->digest = vlib_buffer_get_tail (pd2->lb) - icv_sz;
522
523 op->flags |= VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS;
524 op->chunk_index = vec_len (ptd->chunks);
Neale Ranns5b891102021-06-28 13:31:28 +0000525 if (esp_decrypt_chain_integ (vm, ptd, pd, pd2, sa0, b, icv_sz,
Fan Zhangf5395782020-04-29 14:00:03 +0100526 payload, pd->current_length,
527 &op->digest, &op->n_chunks, 0) < 0)
528 {
Arthur de Kerhorad95b062022-11-16 19:12:05 +0100529 esp_decrypt_set_next_index (
530 b, node, vm->thread_index, ESP_DECRYPT_ERROR_NO_BUFFERS, 0,
531 next, ESP_DECRYPT_NEXT_DROP, pd->sa_index);
Fan Zhangf5395782020-04-29 14:00:03 +0100532 return;
533 }
534 }
535 else
Neale Ranns5b891102021-06-28 13:31:28 +0000536 esp_insert_esn (vm, sa0, pd, pd2, &op->len, &op->digest, &len, b,
Fan Zhangf5395782020-04-29 14:00:03 +0100537 payload);
538 out:
539 vec_add_aligned (*(integ_ops[0]), op, 1, CLIB_CACHE_LINE_BYTES);
540 }
541
542 payload += esp_sz;
543 len -= esp_sz;
544
545 if (sa0->crypto_dec_op_id != VNET_CRYPTO_OP_NONE)
546 {
547 vnet_crypto_op_init (op, sa0->crypto_dec_op_id);
548 op->key_index = sa0->crypto_key_index;
549 op->iv = payload;
550
Benoît Ganne490b9272021-01-22 18:03:09 +0100551 if (ipsec_sa_is_set_IS_CTR (sa0))
Fan Zhangf5395782020-04-29 14:00:03 +0100552 {
Benoît Ganne490b9272021-01-22 18:03:09 +0100553 /* construct nonce in a scratch space in front of the IP header */
554 esp_ctr_nonce_t *nonce =
555 (esp_ctr_nonce_t *) (payload - esp_sz - pd->hdr_sz -
556 sizeof (*nonce));
557 if (ipsec_sa_is_set_IS_AEAD (sa0))
558 {
559 /* constuct aad in a scratch space in front of the nonce */
560 esp_header_t *esp0 = (esp_header_t *) (payload - esp_sz);
561 op->aad = (u8 *) nonce - sizeof (esp_aead_t);
Neale Ranns5b891102021-06-28 13:31:28 +0000562 op->aad_len = esp_aad_fill (op->aad, esp0, sa0, pd->seq_hi);
Benoît Ganne490b9272021-01-22 18:03:09 +0100563 op->tag = payload + len;
564 op->tag_len = 16;
Benoît Ganne84e66582023-03-10 17:33:03 +0100565 if (PREDICT_FALSE (ipsec_sa_is_set_IS_NULL_GMAC (sa0)))
566 {
567 /* RFC-4543 ENCR_NULL_AUTH_AES_GMAC: IV is part of AAD */
568 payload -= iv_sz;
569 len += iv_sz;
570 }
Benoît Ganne490b9272021-01-22 18:03:09 +0100571 }
572 else
573 {
574 nonce->ctr = clib_host_to_net_u32 (1);
575 }
576 nonce->salt = sa0->salt;
577 ASSERT (sizeof (u64) == iv_sz);
578 nonce->iv = *(u64 *) op->iv;
579 op->iv = (u8 *) nonce;
Fan Zhangf5395782020-04-29 14:00:03 +0100580 }
581 op->src = op->dst = payload += iv_sz;
582 op->len = len - iv_sz;
583 op->user_data = index;
584
585 if (pd->is_chain && (pd2->lb != b))
586 {
587 /* buffer is chained */
588 op->flags |= VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS;
589 op->chunk_index = vec_len (ptd->chunks);
PiotrX Kleskia9585fd2020-12-11 15:10:31 +0000590 esp_decrypt_chain_crypto (vm, ptd, pd, pd2, sa0, b, icv_sz,
Fan Zhangf5395782020-04-29 14:00:03 +0100591 payload, len - pd->iv_sz + pd->icv_sz,
592 &op->tag, &op->n_chunks);
593 }
594
595 vec_add_aligned (*(crypto_ops[0]), op, 1, CLIB_CACHE_LINE_BYTES);
596 }
597}
598
Neale Rannsfc811342021-02-26 10:35:33 +0000599static_always_inline esp_decrypt_error_t
600esp_decrypt_prepare_async_frame (vlib_main_t *vm, vlib_node_runtime_t *node,
601 ipsec_per_thread_data_t *ptd,
602 vnet_crypto_async_frame_t *f, ipsec_sa_t *sa0,
603 u8 *payload, u16 len, u8 icv_sz, u8 iv_sz,
604 esp_decrypt_packet_data_t *pd,
605 esp_decrypt_packet_data2_t *pd2, u32 bi,
606 vlib_buffer_t *b, u16 *next, u16 async_next)
Fan Zhangf5395782020-04-29 14:00:03 +0100607{
608 const u8 esp_sz = sizeof (esp_header_t);
Fan Zhangf5395782020-04-29 14:00:03 +0100609 esp_decrypt_packet_data_t *async_pd = &(esp_post_data (b))->decrypt_data;
610 esp_decrypt_packet_data2_t *async_pd2 = esp_post_data2 (b);
611 u8 *tag = payload + len, *iv = payload + esp_sz, *aad = 0;
Benoît Ganne5527a782022-01-18 15:56:41 +0100612 const u32 key_index = sa0->crypto_key_index;
Fan Zhangf5395782020-04-29 14:00:03 +0100613 u32 crypto_len, integ_len = 0;
614 i16 crypto_start_offset, integ_start_offset = 0;
615 u8 flags = 0;
616
617 if (!ipsec_sa_is_set_IS_AEAD (sa0))
618 {
619 /* linked algs */
Fan Zhangf5395782020-04-29 14:00:03 +0100620 integ_start_offset = payload - b->data;
621 integ_len = len;
Benoît Ganne48524a92021-01-22 18:11:37 +0100622 if (PREDICT_TRUE (sa0->integ_op_id != VNET_CRYPTO_OP_NONE))
623 flags |= VNET_CRYPTO_OP_FLAG_HMAC_CHECK;
Fan Zhangf5395782020-04-29 14:00:03 +0100624
625 if (pd->is_chain)
626 {
627 /* buffer is chained */
628 integ_len = pd->current_length;
629
630 /* special case when ICV is splitted and needs to be reassembled
631 * first -> move it to the last buffer. Also take into account
632 * that ESN needs to be added after encrypted data and may or
633 * may not fit in the tail.*/
634 if (pd2->lb->current_length < icv_sz)
635 {
636 u8 extra_esn = 0;
PiotrX Kleskia9585fd2020-12-11 15:10:31 +0000637 tag = esp_move_icv_esn (vm, b, pd, pd2, icv_sz, sa0,
Fan Zhangf5395782020-04-29 14:00:03 +0100638 &extra_esn, &integ_len);
639
640 if (extra_esn)
641 {
642 /* esn is in the last buffer, that was unlinked from
643 * the chain */
644 integ_len = b->current_length;
645 }
646 else
647 {
648 if (pd2->lb == b)
649 {
650 /* we now have a single buffer of crypto data, adjust
651 * the length (second buffer contains only ICV) */
652 len = b->current_length;
653 goto out;
654 }
655 }
656 }
657 else
658 tag = vlib_buffer_get_tail (pd2->lb) - icv_sz;
659
660 flags |= VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS;
Neale Ranns5b891102021-06-28 13:31:28 +0000661 if (esp_decrypt_chain_integ (vm, ptd, pd, pd2, sa0, b, icv_sz,
662 payload, pd->current_length, &tag, 0,
663 &integ_len) < 0)
Fan Zhangf5395782020-04-29 14:00:03 +0100664 {
665 /* allocate buffer failed, will not add to frame and drop */
Neale Rannsfc811342021-02-26 10:35:33 +0000666 return (ESP_DECRYPT_ERROR_NO_BUFFERS);
Fan Zhangf5395782020-04-29 14:00:03 +0100667 }
668 }
669 else
Neale Ranns5b891102021-06-28 13:31:28 +0000670 esp_insert_esn (vm, sa0, pd, pd2, &integ_len, &tag, &len, b, payload);
Fan Zhangf5395782020-04-29 14:00:03 +0100671 }
Fan Zhangf5395782020-04-29 14:00:03 +0100672
673out:
674 /* crypto */
675 payload += esp_sz;
676 len -= esp_sz;
677 iv = payload;
678
Benoît Ganne490b9272021-01-22 18:03:09 +0100679 if (ipsec_sa_is_set_IS_CTR (sa0))
Fan Zhangf5395782020-04-29 14:00:03 +0100680 {
Benoît Ganne490b9272021-01-22 18:03:09 +0100681 /* construct nonce in a scratch space in front of the IP header */
682 esp_ctr_nonce_t *nonce =
683 (esp_ctr_nonce_t *) (payload - esp_sz - pd->hdr_sz - sizeof (*nonce));
684 if (ipsec_sa_is_set_IS_AEAD (sa0))
685 {
686 /* constuct aad in a scratch space in front of the nonce */
687 esp_header_t *esp0 = (esp_header_t *) (payload - esp_sz);
688 aad = (u8 *) nonce - sizeof (esp_aead_t);
Neale Ranns5b891102021-06-28 13:31:28 +0000689 esp_aad_fill (aad, esp0, sa0, pd->seq_hi);
Benoît Ganne490b9272021-01-22 18:03:09 +0100690 tag = payload + len;
Benoît Ganne84e66582023-03-10 17:33:03 +0100691 if (PREDICT_FALSE (ipsec_sa_is_set_IS_NULL_GMAC (sa0)))
692 {
693 /* RFC-4543 ENCR_NULL_AUTH_AES_GMAC: IV is part of AAD */
694 payload -= iv_sz;
695 len += iv_sz;
696 }
Benoît Ganne490b9272021-01-22 18:03:09 +0100697 }
698 else
699 {
700 nonce->ctr = clib_host_to_net_u32 (1);
701 }
702 nonce->salt = sa0->salt;
703 ASSERT (sizeof (u64) == iv_sz);
704 nonce->iv = *(u64 *) iv;
705 iv = (u8 *) nonce;
Fan Zhangf5395782020-04-29 14:00:03 +0100706 }
707
708 crypto_start_offset = (payload += iv_sz) - b->data;
709 crypto_len = len - iv_sz;
710
711 if (pd->is_chain && (pd2->lb != b))
712 {
713 /* buffer is chained */
714 flags |= VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS;
715
PiotrX Kleskia9585fd2020-12-11 15:10:31 +0000716 crypto_len = esp_decrypt_chain_crypto (vm, ptd, pd, pd2, sa0, b, icv_sz,
Fan Zhangf5395782020-04-29 14:00:03 +0100717 payload,
718 len - pd->iv_sz + pd->icv_sz,
719 &tag, 0);
720 }
721
722 *async_pd = *pd;
723 *async_pd2 = *pd2;
Fan Zhangf5395782020-04-29 14:00:03 +0100724
725 /* for AEAD integ_len - crypto_len will be negative, it is ok since it
726 * is ignored by the engine. */
Neale Rannsfc811342021-02-26 10:35:33 +0000727 vnet_crypto_async_add_to_frame (
728 vm, f, key_index, crypto_len, integ_len - crypto_len, crypto_start_offset,
729 integ_start_offset, bi, async_next, iv, tag, aad, flags);
730
731 return (ESP_DECRYPT_ERROR_RX_PKTS);
Fan Zhangf5395782020-04-29 14:00:03 +0100732}
733
734static_always_inline void
Arthur de Kerhorad95b062022-11-16 19:12:05 +0100735esp_decrypt_post_crypto (vlib_main_t *vm, vlib_node_runtime_t *node,
Benoît Ganne98ca76a2022-04-11 18:51:25 +0200736 const u16 *next_by_next_header,
Neale Rannse11203e2021-09-21 12:34:19 +0000737 const esp_decrypt_packet_data_t *pd,
738 const esp_decrypt_packet_data2_t *pd2,
739 vlib_buffer_t *b, u16 *next, int is_ip6, int is_tun,
740 int is_async)
Fan Zhangf5395782020-04-29 14:00:03 +0100741{
Neale Rannsc5fe57d2021-02-25 16:01:28 +0000742 ipsec_sa_t *sa0 = ipsec_sa_get (pd->sa_index);
Fan Zhangf5395782020-04-29 14:00:03 +0100743 vlib_buffer_t *lb = b;
744 const u8 esp_sz = sizeof (esp_header_t);
745 const u8 tun_flags = IPSEC_SA_FLAG_IS_TUNNEL | IPSEC_SA_FLAG_IS_TUNNEL_V6;
746 u8 pad_length = 0, next_header = 0;
747 u16 icv_sz;
748
749 /*
750 * redo the anti-reply check
751 * in this frame say we have sequence numbers, s, s+1, s+1, s+1
752 * and s and s+1 are in the window. When we did the anti-replay
753 * check above we did so against the state of the window (W),
754 * after packet s-1. So each of the packets in the sequence will be
755 * accepted.
756 * This time s will be cheked against Ws-1, s+1 chceked against Ws
757 * (i.e. the window state is updated/advnaced)
758 * so this time the successive s+! packet will be dropped.
759 * This is a consequence of batching the decrypts. If the
760 * check-dcrypt-advance process was done for each packet it would
761 * be fine. But we batch the decrypts because it's much more efficient
762 * to do so in SW and if we offload to HW and the process is async.
763 *
764 * You're probably thinking, but this means an attacker can send the
765 * above sequence and cause VPP to perform decrpyts that will fail,
766 * and that's true. But if the attacker can determine s (a valid
767 * sequence number in the window) which is non-trivial, it can generate
768 * a sequence s, s+1, s+2, s+3, ... s+n and nothing will prevent any
769 * implementation, sequential or batching, from decrypting these.
770 */
Neale Ranns5b891102021-06-28 13:31:28 +0000771 if (ipsec_sa_anti_replay_and_sn_advance (sa0, pd->seq, pd->seq_hi, true,
772 NULL))
Fan Zhangf5395782020-04-29 14:00:03 +0100773 {
Arthur de Kerhorad95b062022-11-16 19:12:05 +0100774 esp_decrypt_set_next_index (b, node, vm->thread_index,
775 ESP_DECRYPT_ERROR_REPLAY, 0, next,
776 ESP_DECRYPT_NEXT_DROP, pd->sa_index);
Fan Zhangf5395782020-04-29 14:00:03 +0100777 return;
778 }
779
Neale Rannse11203e2021-09-21 12:34:19 +0000780 u64 n_lost =
781 ipsec_sa_anti_replay_advance (sa0, vm->thread_index, pd->seq, pd->seq_hi);
782
Arthur de Kerhorad95b062022-11-16 19:12:05 +0100783 vlib_prefetch_simple_counter (&ipsec_sa_err_counters[IPSEC_SA_ERROR_LOST],
784 vm->thread_index, pd->sa_index);
Fan Zhangf5395782020-04-29 14:00:03 +0100785
786 if (pd->is_chain)
787 {
788 lb = pd2->lb;
789 icv_sz = pd2->icv_removed ? 0 : pd->icv_sz;
790 if (pd2->free_buffer_index)
791 {
792 vlib_buffer_free_one (vm, pd2->free_buffer_index);
793 lb->next_buffer = 0;
794 }
795 if (lb->current_length < sizeof (esp_footer_t) + icv_sz)
796 {
797 /* esp footer is either splitted in two buffers or in the before
798 * last buffer */
799
800 vlib_buffer_t *before_last = b, *bp = b;
801 while (bp->flags & VLIB_BUFFER_NEXT_PRESENT)
802 {
803 before_last = bp;
804 bp = vlib_get_buffer (vm, bp->next_buffer);
805 }
806 u8 *bt = vlib_buffer_get_tail (before_last);
807
808 if (lb->current_length == icv_sz)
809 {
810 esp_footer_t *f = (esp_footer_t *) (bt - sizeof (*f));
811 pad_length = f->pad_length;
812 next_header = f->next_header;
813 }
814 else
815 {
816 pad_length = (bt - 1)[0];
817 next_header = ((u8 *) vlib_buffer_get_current (lb))[0];
818 }
819 }
820 else
821 {
822 esp_footer_t *f =
823 (esp_footer_t *) (lb->data + lb->current_data +
824 lb->current_length - sizeof (esp_footer_t) -
825 icv_sz);
826 pad_length = f->pad_length;
827 next_header = f->next_header;
828 }
829 }
830 else
831 {
832 icv_sz = pd->icv_sz;
833 esp_footer_t *f =
834 (esp_footer_t *) (lb->data + lb->current_data + lb->current_length -
835 sizeof (esp_footer_t) - icv_sz);
836 pad_length = f->pad_length;
837 next_header = f->next_header;
838 }
839
840 u16 adv = pd->iv_sz + esp_sz;
841 u16 tail = sizeof (esp_footer_t) + pad_length + icv_sz;
842 u16 tail_orig = sizeof (esp_footer_t) + pad_length + pd->icv_sz;
843 b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
844
845 if ((pd->flags & tun_flags) == 0 && !is_tun) /* transport mode */
846 {
847 u8 udp_sz = (is_ip6 == 0 && pd->flags & IPSEC_SA_FLAG_UDP_ENCAP) ?
848 sizeof (udp_header_t) : 0;
849 u16 ip_hdr_sz = pd->hdr_sz - udp_sz;
850 u8 *old_ip = b->data + pd->current_data - ip_hdr_sz - udp_sz;
851 u8 *ip = old_ip + adv + udp_sz;
852
853 if (is_ip6 && ip_hdr_sz > 64)
854 memmove (ip, old_ip, ip_hdr_sz);
855 else
856 clib_memcpy_le64 (ip, old_ip, ip_hdr_sz);
857
858 b->current_data = pd->current_data + adv - ip_hdr_sz;
859 b->current_length += ip_hdr_sz - adv;
860 esp_remove_tail (vm, b, lb, tail);
861
862 if (is_ip6)
863 {
864 ip6_header_t *ip6 = (ip6_header_t *) ip;
865 u16 len = clib_net_to_host_u16 (ip6->payload_length);
866 len -= adv + tail_orig;
867 ip6->payload_length = clib_host_to_net_u16 (len);
868 ip6->protocol = next_header;
869 next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
870 }
871 else
872 {
873 ip4_header_t *ip4 = (ip4_header_t *) ip;
874 ip_csum_t sum = ip4->checksum;
875 u16 len = clib_net_to_host_u16 (ip4->length);
876 len = clib_host_to_net_u16 (len - adv - tail_orig - udp_sz);
877 sum = ip_csum_update (sum, ip4->protocol, next_header,
878 ip4_header_t, protocol);
879 sum = ip_csum_update (sum, ip4->length, len, ip4_header_t, length);
880 ip4->checksum = ip_csum_fold (sum);
881 ip4->protocol = next_header;
882 ip4->length = len;
883 next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
884 }
885 }
886 else
887 {
888 if (PREDICT_TRUE (next_header == IP_PROTOCOL_IP_IN_IP))
889 {
890 next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
891 b->current_data = pd->current_data + adv;
892 b->current_length = pd->current_length - adv;
893 esp_remove_tail (vm, b, lb, tail);
894 }
895 else if (next_header == IP_PROTOCOL_IPV6)
896 {
897 next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
898 b->current_data = pd->current_data + adv;
899 b->current_length = pd->current_length - adv;
900 esp_remove_tail (vm, b, lb, tail);
901 }
Neale Ranns4a58e492020-12-21 13:19:10 +0000902 else if (next_header == IP_PROTOCOL_MPLS_IN_IP)
903 {
904 next[0] = ESP_DECRYPT_NEXT_MPLS_INPUT;
905 b->current_data = pd->current_data + adv;
906 b->current_length = pd->current_length - adv;
907 esp_remove_tail (vm, b, lb, tail);
908 }
Benoît Ganne98ca76a2022-04-11 18:51:25 +0200909 else if (is_tun && next_header == IP_PROTOCOL_GRE)
Fan Zhangf5395782020-04-29 14:00:03 +0100910 {
Benoît Ganne98ca76a2022-04-11 18:51:25 +0200911 gre_header_t *gre;
912
913 b->current_data = pd->current_data + adv;
914 b->current_length = pd->current_length - adv - tail;
915
916 gre = vlib_buffer_get_current (b);
917
918 vlib_buffer_advance (b, sizeof (*gre));
919
920 switch (clib_net_to_host_u16 (gre->protocol))
Fan Zhangf5395782020-04-29 14:00:03 +0100921 {
Benoît Ganne98ca76a2022-04-11 18:51:25 +0200922 case GRE_PROTOCOL_teb:
923 vnet_update_l2_len (b);
924 next[0] = ESP_DECRYPT_NEXT_L2_INPUT;
925 break;
926 case GRE_PROTOCOL_ip4:
927 next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
928 break;
929 case GRE_PROTOCOL_ip6:
930 next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
931 break;
932 default:
Arthur de Kerhorad95b062022-11-16 19:12:05 +0100933 esp_decrypt_set_next_index (
934 b, node, vm->thread_index, ESP_DECRYPT_ERROR_UNSUP_PAYLOAD, 0,
935 next, ESP_DECRYPT_NEXT_DROP, pd->sa_index);
Benoît Ganne98ca76a2022-04-11 18:51:25 +0200936 break;
Fan Zhangf5395782020-04-29 14:00:03 +0100937 }
938 }
Benoît Ganne98ca76a2022-04-11 18:51:25 +0200939 else if ((next[0] = vec_elt (next_by_next_header, next_header)) !=
940 (u16) ~0)
941 {
942 b->current_data = pd->current_data + adv;
943 b->current_length = pd->current_length - adv;
944 esp_remove_tail (vm, b, lb, tail);
945 }
946 else
947 {
Arthur de Kerhorad95b062022-11-16 19:12:05 +0100948 esp_decrypt_set_next_index (b, node, vm->thread_index,
949 ESP_DECRYPT_ERROR_UNSUP_PAYLOAD, 0, next,
950 ESP_DECRYPT_NEXT_DROP, pd->sa_index);
Benoît Ganne98ca76a2022-04-11 18:51:25 +0200951 return;
952 }
953
Fan Zhangf5395782020-04-29 14:00:03 +0100954 if (is_tun)
955 {
956 if (ipsec_sa_is_set_IS_PROTECT (sa0))
957 {
958 /*
959 * There are two encap possibilities
960 * 1) the tunnel and ths SA are prodiving encap, i.e. it's
961 * MAC | SA-IP | TUN-IP | ESP | PAYLOAD
962 * implying the SA is in tunnel mode (on a tunnel interface)
963 * 2) only the tunnel provides encap
964 * MAC | TUN-IP | ESP | PAYLOAD
965 * implying the SA is in transport mode.
966 *
967 * For 2) we need only strip the tunnel encap and we're good.
968 * since the tunnel and crypto ecnap (int the tun=protect
969 * object) are the same and we verified above that these match
970 * for 1) we need to strip the SA-IP outer headers, to
971 * reveal the tunnel IP and then check that this matches
972 * the configured tunnel.
973 */
974 const ipsec_tun_protect_t *itp;
975
Neale Ranns5b891102021-06-28 13:31:28 +0000976 itp =
977 ipsec_tun_protect_get (vnet_buffer (b)->ipsec.protect_index);
Fan Zhangf5395782020-04-29 14:00:03 +0100978
979 if (PREDICT_TRUE (next_header == IP_PROTOCOL_IP_IN_IP))
980 {
981 const ip4_header_t *ip4;
982
983 ip4 = vlib_buffer_get_current (b);
984
985 if (!ip46_address_is_equal_v4 (&itp->itp_tun.src,
986 &ip4->dst_address) ||
987 !ip46_address_is_equal_v4 (&itp->itp_tun.dst,
988 &ip4->src_address))
989 {
Arthur de Kerhorad95b062022-11-16 19:12:05 +0100990 esp_decrypt_set_next_index (
991 b, node, vm->thread_index,
992 ESP_DECRYPT_ERROR_TUN_NO_PROTO, 0, next,
993 ESP_DECRYPT_NEXT_DROP, pd->sa_index);
Fan Zhangf5395782020-04-29 14:00:03 +0100994 }
995 }
996 else if (next_header == IP_PROTOCOL_IPV6)
997 {
998 const ip6_header_t *ip6;
999
1000 ip6 = vlib_buffer_get_current (b);
1001
1002 if (!ip46_address_is_equal_v6 (&itp->itp_tun.src,
1003 &ip6->dst_address) ||
1004 !ip46_address_is_equal_v6 (&itp->itp_tun.dst,
1005 &ip6->src_address))
1006 {
Arthur de Kerhorad95b062022-11-16 19:12:05 +01001007 esp_decrypt_set_next_index (
1008 b, node, vm->thread_index,
1009 ESP_DECRYPT_ERROR_TUN_NO_PROTO, 0, next,
1010 ESP_DECRYPT_NEXT_DROP, pd->sa_index);
Fan Zhangf5395782020-04-29 14:00:03 +01001011 }
1012 }
1013 }
1014 }
1015 }
Neale Rannse11203e2021-09-21 12:34:19 +00001016
1017 if (PREDICT_FALSE (n_lost))
Arthur de Kerhorad95b062022-11-16 19:12:05 +01001018 vlib_increment_simple_counter (&ipsec_sa_err_counters[IPSEC_SA_ERROR_LOST],
1019 vm->thread_index, pd->sa_index, n_lost);
Fan Zhangf5395782020-04-29 14:00:03 +01001020}
1021
Klement Sekerabe5a5dd2018-10-09 16:05:48 +02001022always_inline uword
Neale Rannsf16e9a52021-02-25 19:09:24 +00001023esp_decrypt_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
1024 vlib_frame_t *from_frame, int is_ip6, int is_tun,
1025 u16 async_next_node)
Ed Warnickecb9cada2015-12-08 15:45:58 -07001026{
Ed Warnickecb9cada2015-12-08 15:45:58 -07001027 ipsec_main_t *im = &ipsec_main;
Benoît Ganne98ca76a2022-04-11 18:51:25 +02001028 const u16 *next_by_next_header = im->next_header_registrations;
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001029 u32 thread_index = vm->thread_index;
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001030 u16 len;
1031 ipsec_per_thread_data_t *ptd = vec_elt_at_index (im->ptd, thread_index);
Damjan Marionc98275f2019-03-06 14:05:01 +01001032 u32 *from = vlib_frame_vector_args (from_frame);
Filip Tehlarefcad1a2020-02-04 09:36:04 +00001033 u32 n_left = from_frame->n_vectors;
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001034 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
Neale Rannsf16e9a52021-02-25 19:09:24 +00001035 vlib_buffer_t *sync_bufs[VLIB_FRAME_SIZE];
1036 u16 sync_nexts[VLIB_FRAME_SIZE], *sync_next = sync_nexts, n_sync = 0;
Matthew Smith51d56ba2021-06-04 09:18:37 -05001037 u16 async_nexts[VLIB_FRAME_SIZE], *async_next = async_nexts;
Damjan Mariondd298e82022-10-12 16:02:18 +02001038 u16 noop_nexts[VLIB_FRAME_SIZE], n_noop = 0;
Neale Rannsf16e9a52021-02-25 19:09:24 +00001039 u32 sync_bi[VLIB_FRAME_SIZE];
1040 u32 noop_bi[VLIB_FRAME_SIZE];
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001041 esp_decrypt_packet_data_t pkt_data[VLIB_FRAME_SIZE], *pd = pkt_data;
Fan Zhangf5395782020-04-29 14:00:03 +01001042 esp_decrypt_packet_data2_t pkt_data2[VLIB_FRAME_SIZE], *pd2 = pkt_data2;
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001043 esp_decrypt_packet_data_t cpd = { };
1044 u32 current_sa_index = ~0, current_sa_bytes = 0, current_sa_pkts = 0;
1045 const u8 esp_sz = sizeof (esp_header_t);
1046 ipsec_sa_t *sa0 = 0;
Filip Tehlare4e8c6b2020-02-13 07:49:30 +00001047 vnet_crypto_op_t _op, *op = &_op;
Benoît Gannee631ece2021-05-27 18:49:42 +02001048 vnet_crypto_op_t **crypto_ops;
1049 vnet_crypto_op_t **integ_ops;
Fan Zhangf5395782020-04-29 14:00:03 +01001050 int is_async = im->async_mode;
Neale Rannsfc811342021-02-26 10:35:33 +00001051 vnet_crypto_async_op_id_t async_op = ~0;
Neale Rannsfc811342021-02-26 10:35:33 +00001052 vnet_crypto_async_frame_t *async_frames[VNET_CRYPTO_ASYNC_OP_N_IDS];
Neale Rannsf16e9a52021-02-25 19:09:24 +00001053 esp_decrypt_error_t err;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001054
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001055 vlib_get_buffers (vm, from, b, n_left);
Fan Zhangf5395782020-04-29 14:00:03 +01001056 if (!is_async)
1057 {
1058 vec_reset_length (ptd->crypto_ops);
1059 vec_reset_length (ptd->integ_ops);
1060 vec_reset_length (ptd->chained_crypto_ops);
1061 vec_reset_length (ptd->chained_integ_ops);
1062 }
Neale Rannsfc811342021-02-26 10:35:33 +00001063 vec_reset_length (ptd->async_frames);
Filip Tehlarefcad1a2020-02-04 09:36:04 +00001064 vec_reset_length (ptd->chunks);
Neale Rannsf16e9a52021-02-25 19:09:24 +00001065 clib_memset (sync_nexts, -1, sizeof (sync_nexts));
Neale Rannsfc811342021-02-26 10:35:33 +00001066 clib_memset (async_frames, 0, sizeof (async_frames));
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001067
1068 while (n_left > 0)
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -07001069 {
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001070 u8 *payload;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001071
Neale Rannsf16e9a52021-02-25 19:09:24 +00001072 err = ESP_DECRYPT_ERROR_RX_PKTS;
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001073 if (n_left > 2)
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -07001074 {
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001075 u8 *p;
1076 vlib_prefetch_buffer_header (b[2], LOAD);
1077 p = vlib_buffer_get_current (b[1]);
Damjan Marionaf7fb042021-07-15 11:54:41 +02001078 clib_prefetch_load (p);
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001079 p -= CLIB_CACHE_LINE_BYTES;
Damjan Marionaf7fb042021-07-15 11:54:41 +02001080 clib_prefetch_load (p);
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001081 }
1082
Filip Tehlarefcad1a2020-02-04 09:36:04 +00001083 u32 n_bufs = vlib_buffer_chain_linearize (vm, b[0]);
1084 if (n_bufs == 0)
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001085 {
Neale Rannsf16e9a52021-02-25 19:09:24 +00001086 err = ESP_DECRYPT_ERROR_NO_BUFFERS;
Arthur de Kerhorad95b062022-11-16 19:12:05 +01001087 esp_decrypt_set_next_index (b[0], node, thread_index, err, n_noop,
1088 noop_nexts, ESP_DECRYPT_NEXT_DROP,
1089 vnet_buffer (b[0])->ipsec.sad_index);
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001090 goto next;
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -07001091 }
Damjan Marionc98275f2019-03-06 14:05:01 +01001092
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001093 if (vnet_buffer (b[0])->ipsec.sad_index != current_sa_index)
Damjan Marionc98275f2019-03-06 14:05:01 +01001094 {
Damjan Marion867dfdd2019-06-05 15:42:54 +02001095 if (current_sa_pkts)
1096 vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
Arthur de Kerhorad95b062022-11-16 19:12:05 +01001097 current_sa_index, current_sa_pkts,
Damjan Marion867dfdd2019-06-05 15:42:54 +02001098 current_sa_bytes);
1099 current_sa_bytes = current_sa_pkts = 0;
1100
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001101 current_sa_index = vnet_buffer (b[0])->ipsec.sad_index;
Arthur de Kerhorad95b062022-11-16 19:12:05 +01001102 vlib_prefetch_combined_counter (&ipsec_sa_counters, thread_index,
1103 current_sa_index);
Neale Rannsc5fe57d2021-02-25 16:01:28 +00001104 sa0 = ipsec_sa_get (current_sa_index);
Neale Ranns123b5eb2020-10-16 14:03:55 +00001105
1106 /* fetch the second cacheline ASAP */
Damjan Marionaf7fb042021-07-15 11:54:41 +02001107 clib_prefetch_load (sa0->cacheline1);
Damjan Marion7c22ff72019-04-04 12:25:44 +02001108 cpd.icv_sz = sa0->integ_icv_size;
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001109 cpd.iv_sz = sa0->crypto_iv_size;
1110 cpd.flags = sa0->flags;
1111 cpd.sa_index = current_sa_index;
Neale Rannsf16e9a52021-02-25 19:09:24 +00001112 is_async = im->async_mode | ipsec_sa_is_set_IS_ASYNC (sa0);
Neale Rannsfc811342021-02-26 10:35:33 +00001113 }
Fan Zhangf5395782020-04-29 14:00:03 +01001114
Benoît Ganne5527a782022-01-18 15:56:41 +01001115 if (PREDICT_FALSE ((u16) ~0 == sa0->thread_index))
Neale Rannsf62a8c02019-04-02 08:13:33 +00001116 {
1117 /* this is the first packet to use this SA, claim the SA
1118 * for this thread. this could happen simultaneously on
1119 * another thread */
Neale Ranns1a52d372021-02-04 11:33:32 +00001120 clib_atomic_cmp_and_swap (&sa0->thread_index, ~0,
Neale Rannsf62a8c02019-04-02 08:13:33 +00001121 ipsec_sa_assign_thread (thread_index));
1122 }
1123
Neale Ranns1a52d372021-02-04 11:33:32 +00001124 if (PREDICT_FALSE (thread_index != sa0->thread_index))
Neale Rannsf62a8c02019-04-02 08:13:33 +00001125 {
Neale Rannsaa7d7662021-02-10 08:42:49 +00001126 vnet_buffer (b[0])->ipsec.thread_index = sa0->thread_index;
Neale Rannsf16e9a52021-02-25 19:09:24 +00001127 err = ESP_DECRYPT_ERROR_HANDOFF;
Arthur de Kerhorad95b062022-11-16 19:12:05 +01001128 esp_decrypt_set_next_index (b[0], node, thread_index, err, n_noop,
1129 noop_nexts, ESP_DECRYPT_NEXT_HANDOFF,
1130 current_sa_index);
Neale Rannsf62a8c02019-04-02 08:13:33 +00001131 goto next;
1132 }
1133
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001134 /* store packet data for next round for easier prefetch */
1135 pd->sa_data = cpd.sa_data;
1136 pd->current_data = b[0]->current_data;
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001137 pd->hdr_sz = pd->current_data - vnet_buffer (b[0])->l3_hdr_offset;
1138 payload = b[0]->data + pd->current_data;
Neale Ranns6afaae12019-07-17 15:07:14 +00001139 pd->seq = clib_host_to_net_u32 (((esp_header_t *) payload)->seq);
Fan Zhangf5395782020-04-29 14:00:03 +01001140 pd->is_chain = 0;
1141 pd2->lb = b[0];
1142 pd2->free_buffer_index = 0;
1143 pd2->icv_removed = 0;
Filip Tehlarefcad1a2020-02-04 09:36:04 +00001144
Filip Tehlarefcad1a2020-02-04 09:36:04 +00001145 if (n_bufs > 1)
1146 {
Fan Zhangf5395782020-04-29 14:00:03 +01001147 pd->is_chain = 1;
Filip Tehlarefcad1a2020-02-04 09:36:04 +00001148 /* find last buffer in the chain */
Fan Zhangf5395782020-04-29 14:00:03 +01001149 while (pd2->lb->flags & VLIB_BUFFER_NEXT_PRESENT)
1150 pd2->lb = vlib_get_buffer (vm, pd2->lb->next_buffer);
Filip Tehlarefcad1a2020-02-04 09:36:04 +00001151
1152 crypto_ops = &ptd->chained_crypto_ops;
1153 integ_ops = &ptd->chained_integ_ops;
1154 }
Benoît Gannee631ece2021-05-27 18:49:42 +02001155 else
1156 {
1157 crypto_ops = &ptd->crypto_ops;
1158 integ_ops = &ptd->integ_ops;
1159 }
Fan Zhangf5395782020-04-29 14:00:03 +01001160
Filip Tehlarefcad1a2020-02-04 09:36:04 +00001161 pd->current_length = b[0]->current_length;
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001162
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001163 /* anti-reply check */
Neale Ranns5b891102021-06-28 13:31:28 +00001164 if (ipsec_sa_anti_replay_and_sn_advance (sa0, pd->seq, ~0, false,
1165 &pd->seq_hi))
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001166 {
Neale Rannsf16e9a52021-02-25 19:09:24 +00001167 err = ESP_DECRYPT_ERROR_REPLAY;
Arthur de Kerhorad95b062022-11-16 19:12:05 +01001168 esp_decrypt_set_next_index (b[0], node, thread_index, err, n_noop,
1169 noop_nexts, ESP_DECRYPT_NEXT_DROP,
1170 current_sa_index);
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001171 goto next;
1172 }
1173
Damjan Mariona829b132019-04-24 23:39:16 +02001174 if (pd->current_length < cpd.icv_sz + esp_sz + cpd.iv_sz)
1175 {
Neale Rannsf16e9a52021-02-25 19:09:24 +00001176 err = ESP_DECRYPT_ERROR_RUNT;
Arthur de Kerhorad95b062022-11-16 19:12:05 +01001177 esp_decrypt_set_next_index (b[0], node, thread_index, err, n_noop,
1178 noop_nexts, ESP_DECRYPT_NEXT_DROP,
1179 current_sa_index);
Damjan Mariona829b132019-04-24 23:39:16 +02001180 goto next;
1181 }
1182
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001183 len = pd->current_length - cpd.icv_sz;
1184 current_sa_pkts += 1;
Filip Tehlarefcad1a2020-02-04 09:36:04 +00001185 current_sa_bytes += vlib_buffer_length_in_chain (vm, b[0]);
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001186
Fan Zhangf5395782020-04-29 14:00:03 +01001187 if (is_async)
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001188 {
Matthew Smith51d56ba2021-06-04 09:18:37 -05001189 async_op = sa0->crypto_async_dec_op_id;
1190
1191 /* get a frame for this op if we don't yet have one or it's full
1192 */
1193 if (NULL == async_frames[async_op] ||
1194 vnet_crypto_async_frame_is_full (async_frames[async_op]))
1195 {
1196 async_frames[async_op] =
1197 vnet_crypto_async_get_frame (vm, async_op);
gaoginskxf441b5d2021-06-07 12:07:01 +01001198 if (PREDICT_FALSE (!async_frames[async_op]))
1199 {
1200 err = ESP_DECRYPT_ERROR_NO_AVAIL_FRAME;
1201 esp_decrypt_set_next_index (
1202 b[0], node, thread_index, err, n_noop, noop_nexts,
1203 ESP_DECRYPT_NEXT_DROP, current_sa_index);
1204 goto next;
1205 }
1206
Matthew Smith51d56ba2021-06-04 09:18:37 -05001207 /* Save the frame to the list we'll submit at the end */
1208 vec_add1 (ptd->async_frames, async_frames[async_op]);
1209 }
Neale Rannsfc811342021-02-26 10:35:33 +00001210
1211 err = esp_decrypt_prepare_async_frame (
1212 vm, node, ptd, async_frames[async_op], sa0, payload, len,
Neale Rannsf16e9a52021-02-25 19:09:24 +00001213 cpd.icv_sz, cpd.iv_sz, pd, pd2, from[b - bufs], b[0], async_next,
1214 async_next_node);
Neale Rannsfc811342021-02-26 10:35:33 +00001215 if (ESP_DECRYPT_ERROR_RX_PKTS != err)
Filip Tehlarefcad1a2020-02-04 09:36:04 +00001216 {
Arthur de Kerhorad95b062022-11-16 19:12:05 +01001217 esp_decrypt_set_next_index (
1218 b[0], node, thread_index, err, n_noop, noop_nexts,
1219 ESP_DECRYPT_NEXT_DROP, current_sa_index);
Filip Tehlarefcad1a2020-02-04 09:36:04 +00001220 }
Damjan Marionc98275f2019-03-06 14:05:01 +01001221 }
Fan Zhangf5395782020-04-29 14:00:03 +01001222 else
Neale Rannsf16e9a52021-02-25 19:09:24 +00001223 esp_decrypt_prepare_sync_op (
1224 vm, node, ptd, &crypto_ops, &integ_ops, op, sa0, payload, len,
Neale Rannsfe2d23f2022-11-18 04:24:09 +00001225 cpd.icv_sz, cpd.iv_sz, pd, pd2, b[0], sync_next, n_sync);
Damjan Marionc98275f2019-03-06 14:05:01 +01001226 /* next */
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001227 next:
Neale Rannsf16e9a52021-02-25 19:09:24 +00001228 if (ESP_DECRYPT_ERROR_RX_PKTS != err)
1229 {
1230 noop_bi[n_noop] = from[b - bufs];
1231 n_noop++;
Neale Rannsf16e9a52021-02-25 19:09:24 +00001232 }
1233 else if (!is_async)
1234 {
1235 sync_bi[n_sync] = from[b - bufs];
1236 sync_bufs[n_sync] = b[0];
1237 n_sync++;
1238 sync_next++;
1239 pd += 1;
1240 pd2 += 1;
1241 }
1242 else
Matthew Smith51d56ba2021-06-04 09:18:37 -05001243 async_next++;
1244
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001245 n_left -= 1;
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001246 b += 1;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001247 }
Damjan Marionc98275f2019-03-06 14:05:01 +01001248
Neale Ranns02950402019-12-20 00:54:57 +00001249 if (PREDICT_TRUE (~0 != current_sa_index))
1250 vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
1251 current_sa_index, current_sa_pkts,
1252 current_sa_bytes);
Klement Sekerabe5a5dd2018-10-09 16:05:48 +02001253
Matthew Smith51d56ba2021-06-04 09:18:37 -05001254 /* submit or free all of the open frames */
1255 vnet_crypto_async_frame_t **async_frame;
Neale Rannsfc811342021-02-26 10:35:33 +00001256
Matthew Smith51d56ba2021-06-04 09:18:37 -05001257 vec_foreach (async_frame, ptd->async_frames)
1258 {
1259 /* free frame and move on if no ops were successfully added */
1260 if (PREDICT_FALSE (!(*async_frame)->n_elts))
Fan Zhangf5395782020-04-29 14:00:03 +01001261 {
Matthew Smith51d56ba2021-06-04 09:18:37 -05001262 vnet_crypto_async_free_frame (vm, *async_frame);
1263 continue;
1264 }
1265 if (vnet_crypto_async_submit_open_frame (vm, *async_frame) < 0)
1266 {
1267 n_noop += esp_async_recycle_failed_submit (
1268 vm, *async_frame, node, ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR,
Arthur de Kerhorad95b062022-11-16 19:12:05 +01001269 IPSEC_SA_ERROR_CRYPTO_ENGINE_ERROR, n_noop, noop_bi, noop_nexts,
Xiaoming Jiang0c1454c2023-05-05 02:28:20 +00001270 ESP_DECRYPT_NEXT_DROP, false);
Matthew Smith51d56ba2021-06-04 09:18:37 -05001271 vnet_crypto_async_reset_frame (*async_frame);
1272 vnet_crypto_async_free_frame (vm, *async_frame);
Fan Zhangf5395782020-04-29 14:00:03 +01001273 }
Fan Zhangf5395782020-04-29 14:00:03 +01001274 }
Fan Zhangf5395782020-04-29 14:00:03 +01001275
Neale Rannsf16e9a52021-02-25 19:09:24 +00001276 if (n_sync)
1277 {
1278 esp_process_ops (vm, node, ptd->integ_ops, sync_bufs, sync_nexts,
1279 ESP_DECRYPT_ERROR_INTEG_ERROR);
1280 esp_process_chained_ops (vm, node, ptd->chained_integ_ops, sync_bufs,
1281 sync_nexts, ptd->chunks,
1282 ESP_DECRYPT_ERROR_INTEG_ERROR);
1283
1284 esp_process_ops (vm, node, ptd->crypto_ops, sync_bufs, sync_nexts,
Fan Zhangf5395782020-04-29 14:00:03 +01001285 ESP_DECRYPT_ERROR_DECRYPTION_FAILED);
Neale Rannsf16e9a52021-02-25 19:09:24 +00001286 esp_process_chained_ops (vm, node, ptd->chained_crypto_ops, sync_bufs,
1287 sync_nexts, ptd->chunks,
Fan Zhangf5395782020-04-29 14:00:03 +01001288 ESP_DECRYPT_ERROR_DECRYPTION_FAILED);
1289 }
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001290
1291 /* Post decryption ronud - adjust packet data start and length and next
1292 node */
1293
Neale Rannsf16e9a52021-02-25 19:09:24 +00001294 n_left = n_sync;
1295 sync_next = sync_nexts;
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001296 pd = pkt_data;
Fan Zhangf5395782020-04-29 14:00:03 +01001297 pd2 = pkt_data2;
Neale Rannsf16e9a52021-02-25 19:09:24 +00001298 b = sync_bufs;
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001299
1300 while (n_left)
1301 {
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001302 if (n_left >= 2)
1303 {
1304 void *data = b[1]->data + pd[1].current_data;
1305
1306 /* buffer metadata */
1307 vlib_prefetch_buffer_header (b[1], LOAD);
1308
1309 /* esp_footer_t */
1310 CLIB_PREFETCH (data + pd[1].current_length - pd[1].icv_sz - 2,
1311 CLIB_CACHE_LINE_BYTES, LOAD);
1312
1313 /* packet headers */
1314 CLIB_PREFETCH (data - CLIB_CACHE_LINE_BYTES,
1315 CLIB_CACHE_LINE_BYTES * 2, LOAD);
1316 }
1317
Christian Hoppsd570e532020-08-25 12:40:40 -04001318 /* save the sa_index as GRE_teb post_crypto changes L2 opaque */
1319 if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
1320 current_sa_index = vnet_buffer (b[0])->ipsec.sad_index;
1321
Neale Rannsf16e9a52021-02-25 19:09:24 +00001322 if (sync_next[0] >= ESP_DECRYPT_N_NEXT)
Benoît Ganne98ca76a2022-04-11 18:51:25 +02001323 esp_decrypt_post_crypto (vm, node, next_by_next_header, pd, pd2, b[0],
1324 sync_next, is_ip6, is_tun, 0);
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001325
Fan Zhangf5395782020-04-29 14:00:03 +01001326 /* trace: */
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001327 if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
1328 {
1329 esp_decrypt_trace_t *tr;
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001330 tr = vlib_add_trace (vm, node, b[0], sizeof (*tr));
Neale Rannsc5fe57d2021-02-25 16:01:28 +00001331 sa0 = ipsec_sa_get (current_sa_index);
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001332 tr->crypto_alg = sa0->crypto_alg;
1333 tr->integ_alg = sa0->integ_alg;
Neale Ranns6afaae12019-07-17 15:07:14 +00001334 tr->seq = pd->seq;
Neale Ranns5b891102021-06-28 13:31:28 +00001335 tr->sa_seq = sa0->seq;
Neale Ranns6afaae12019-07-17 15:07:14 +00001336 tr->sa_seq_hi = sa0->seq_hi;
Neale Ranns5b891102021-06-28 13:31:28 +00001337 tr->pkt_seq_hi = pd->seq_hi;
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001338 }
1339
1340 /* next */
1341 n_left -= 1;
Neale Rannsf16e9a52021-02-25 19:09:24 +00001342 sync_next += 1;
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001343 pd += 1;
Fan Zhangf5395782020-04-29 14:00:03 +01001344 pd2 += 1;
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001345 b += 1;
1346 }
1347
Neale Rannsf16e9a52021-02-25 19:09:24 +00001348 vlib_node_increment_counter (vm, node->node_index, ESP_DECRYPT_ERROR_RX_PKTS,
1349 from_frame->n_vectors);
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001350
Neale Rannsf16e9a52021-02-25 19:09:24 +00001351 if (n_sync)
1352 vlib_buffer_enqueue_to_next (vm, node, sync_bi, sync_nexts, n_sync);
Damjan Marionb4fff3a2019-03-25 15:54:40 +01001353
Neale Rannsf16e9a52021-02-25 19:09:24 +00001354 if (n_noop)
1355 vlib_buffer_enqueue_to_next (vm, node, noop_bi, noop_nexts, n_noop);
1356
1357 return (from_frame->n_vectors);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001358}
1359
Fan Zhangf5395782020-04-29 14:00:03 +01001360always_inline uword
1361esp_decrypt_post_inline (vlib_main_t * vm,
1362 vlib_node_runtime_t * node,
1363 vlib_frame_t * from_frame, int is_ip6, int is_tun)
1364{
Benoît Ganne98ca76a2022-04-11 18:51:25 +02001365 const ipsec_main_t *im = &ipsec_main;
1366 const u16 *next_by_next_header = im->next_header_registrations;
Fan Zhangf5395782020-04-29 14:00:03 +01001367 u32 *from = vlib_frame_vector_args (from_frame);
1368 u32 n_left = from_frame->n_vectors;
1369 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
1370 u16 nexts[VLIB_FRAME_SIZE], *next = nexts;
1371 vlib_get_buffers (vm, from, b, n_left);
1372
1373 while (n_left > 0)
1374 {
1375 esp_decrypt_packet_data_t *pd = &(esp_post_data (b[0]))->decrypt_data;
1376
1377 if (n_left > 2)
1378 {
1379 vlib_prefetch_buffer_header (b[2], LOAD);
1380 vlib_prefetch_buffer_header (b[1], LOAD);
1381 }
1382
1383 if (!pd->is_chain)
Benoît Ganne98ca76a2022-04-11 18:51:25 +02001384 esp_decrypt_post_crypto (vm, node, next_by_next_header, pd, 0, b[0],
1385 next, is_ip6, is_tun, 1);
Fan Zhangf5395782020-04-29 14:00:03 +01001386 else
1387 {
1388 esp_decrypt_packet_data2_t *pd2 = esp_post_data2 (b[0]);
Benoît Ganne98ca76a2022-04-11 18:51:25 +02001389 esp_decrypt_post_crypto (vm, node, next_by_next_header, pd, pd2,
1390 b[0], next, is_ip6, is_tun, 1);
Fan Zhangf5395782020-04-29 14:00:03 +01001391 }
1392
1393 /*trace: */
1394 if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
1395 {
Neale Rannsc5fe57d2021-02-25 16:01:28 +00001396 ipsec_sa_t *sa0 = ipsec_sa_get (pd->sa_index);
Fan Zhangf5395782020-04-29 14:00:03 +01001397 esp_decrypt_trace_t *tr;
1398 esp_decrypt_packet_data_t *async_pd =
1399 &(esp_post_data (b[0]))->decrypt_data;
1400 tr = vlib_add_trace (vm, node, b[0], sizeof (*tr));
Neale Rannsc5fe57d2021-02-25 16:01:28 +00001401 sa0 = ipsec_sa_get (async_pd->sa_index);
Fan Zhangf5395782020-04-29 14:00:03 +01001402
1403 tr->crypto_alg = sa0->crypto_alg;
1404 tr->integ_alg = sa0->integ_alg;
1405 tr->seq = pd->seq;
Neale Ranns5b891102021-06-28 13:31:28 +00001406 tr->sa_seq = sa0->seq;
Fan Zhangf5395782020-04-29 14:00:03 +01001407 tr->sa_seq_hi = sa0->seq_hi;
1408 }
1409
1410 n_left--;
1411 next++;
1412 b++;
1413 }
1414
1415 n_left = from_frame->n_vectors;
1416 vlib_node_increment_counter (vm, node->node_index,
1417 ESP_DECRYPT_ERROR_RX_POST_PKTS, n_left);
1418
1419 vlib_buffer_enqueue_to_next (vm, node, from, nexts, n_left);
1420
1421 return n_left;
1422}
1423
Klement Sekerab8f35442018-10-29 13:38:19 +01001424VLIB_NODE_FN (esp4_decrypt_node) (vlib_main_t * vm,
1425 vlib_node_runtime_t * node,
1426 vlib_frame_t * from_frame)
Klement Sekerabe5a5dd2018-10-09 16:05:48 +02001427{
Fan Zhangf5395782020-04-29 14:00:03 +01001428 return esp_decrypt_inline (vm, node, from_frame, 0, 0,
1429 esp_decrypt_async_next.esp4_post_next);
1430}
1431
1432VLIB_NODE_FN (esp4_decrypt_post_node) (vlib_main_t * vm,
1433 vlib_node_runtime_t * node,
1434 vlib_frame_t * from_frame)
1435{
1436 return esp_decrypt_post_inline (vm, node, from_frame, 0, 0);
Neale Rannsc87b66c2019-02-07 07:26:12 -08001437}
1438
1439VLIB_NODE_FN (esp4_decrypt_tun_node) (vlib_main_t * vm,
1440 vlib_node_runtime_t * node,
1441 vlib_frame_t * from_frame)
1442{
Fan Zhangf5395782020-04-29 14:00:03 +01001443 return esp_decrypt_inline (vm, node, from_frame, 0, 1,
1444 esp_decrypt_async_next.esp4_tun_post_next);
1445}
1446
1447VLIB_NODE_FN (esp4_decrypt_tun_post_node) (vlib_main_t * vm,
1448 vlib_node_runtime_t * node,
1449 vlib_frame_t * from_frame)
1450{
1451 return esp_decrypt_post_inline (vm, node, from_frame, 0, 1);
Neale Rannsc87b66c2019-02-07 07:26:12 -08001452}
1453
1454VLIB_NODE_FN (esp6_decrypt_node) (vlib_main_t * vm,
1455 vlib_node_runtime_t * node,
1456 vlib_frame_t * from_frame)
1457{
Fan Zhangf5395782020-04-29 14:00:03 +01001458 return esp_decrypt_inline (vm, node, from_frame, 1, 0,
1459 esp_decrypt_async_next.esp6_post_next);
1460}
1461
1462VLIB_NODE_FN (esp6_decrypt_post_node) (vlib_main_t * vm,
1463 vlib_node_runtime_t * node,
1464 vlib_frame_t * from_frame)
1465{
1466 return esp_decrypt_post_inline (vm, node, from_frame, 1, 0);
Neale Rannsc87b66c2019-02-07 07:26:12 -08001467}
1468
1469VLIB_NODE_FN (esp6_decrypt_tun_node) (vlib_main_t * vm,
1470 vlib_node_runtime_t * node,
1471 vlib_frame_t * from_frame)
1472{
Fan Zhangf5395782020-04-29 14:00:03 +01001473 return esp_decrypt_inline (vm, node, from_frame, 1, 1,
1474 esp_decrypt_async_next.esp6_tun_post_next);
Klement Sekerabe5a5dd2018-10-09 16:05:48 +02001475}
Ed Warnickecb9cada2015-12-08 15:45:58 -07001476
Fan Zhangf5395782020-04-29 14:00:03 +01001477VLIB_NODE_FN (esp6_decrypt_tun_post_node) (vlib_main_t * vm,
1478 vlib_node_runtime_t * node,
1479 vlib_frame_t * from_frame)
1480{
1481 return esp_decrypt_post_inline (vm, node, from_frame, 1, 1);
1482}
1483
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -07001484/* *INDENT-OFF* */
Klement Sekerabe5a5dd2018-10-09 16:05:48 +02001485VLIB_REGISTER_NODE (esp4_decrypt_node) = {
Klement Sekerabe5a5dd2018-10-09 16:05:48 +02001486 .name = "esp4-decrypt",
Ed Warnickecb9cada2015-12-08 15:45:58 -07001487 .vector_size = sizeof (u32),
1488 .format_trace = format_esp_decrypt_trace,
1489 .type = VLIB_NODE_TYPE_INTERNAL,
1490
Neale Ranns93688d72022-08-09 03:34:51 +00001491 .n_errors = ESP_DECRYPT_N_ERROR,
1492 .error_counters = esp_decrypt_error_counters,
Ed Warnickecb9cada2015-12-08 15:45:58 -07001493
1494 .n_next_nodes = ESP_DECRYPT_N_NEXT,
1495 .next_nodes = {
Neale Rannsf62a8c02019-04-02 08:13:33 +00001496 [ESP_DECRYPT_NEXT_DROP] = "ip4-drop",
1497 [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
1498 [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
Neale Ranns4a58e492020-12-21 13:19:10 +00001499 [ESP_DECRYPT_NEXT_MPLS_INPUT] = "mpls-drop",
Neale Ranns568acbb2019-12-18 05:54:40 +00001500 [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
Neale Rannsf62a8c02019-04-02 08:13:33 +00001501 [ESP_DECRYPT_NEXT_HANDOFF] = "esp4-decrypt-handoff",
Ed Warnickecb9cada2015-12-08 15:45:58 -07001502 },
1503};
1504
Fan Zhangf5395782020-04-29 14:00:03 +01001505VLIB_REGISTER_NODE (esp4_decrypt_post_node) = {
1506 .name = "esp4-decrypt-post",
1507 .vector_size = sizeof (u32),
1508 .format_trace = format_esp_decrypt_trace,
1509 .type = VLIB_NODE_TYPE_INTERNAL,
1510
Neale Ranns93688d72022-08-09 03:34:51 +00001511 .n_errors = ESP_DECRYPT_N_ERROR,
1512 .error_counters = esp_decrypt_error_counters,
Fan Zhangf5395782020-04-29 14:00:03 +01001513
1514 .sibling_of = "esp4-decrypt",
1515};
1516
Klement Sekerabe5a5dd2018-10-09 16:05:48 +02001517VLIB_REGISTER_NODE (esp6_decrypt_node) = {
Klement Sekerabe5a5dd2018-10-09 16:05:48 +02001518 .name = "esp6-decrypt",
1519 .vector_size = sizeof (u32),
1520 .format_trace = format_esp_decrypt_trace,
1521 .type = VLIB_NODE_TYPE_INTERNAL,
1522
Neale Ranns93688d72022-08-09 03:34:51 +00001523 .n_errors = ESP_DECRYPT_N_ERROR,
1524 .error_counters = esp_decrypt_error_counters,
Klement Sekerabe5a5dd2018-10-09 16:05:48 +02001525
1526 .n_next_nodes = ESP_DECRYPT_N_NEXT,
1527 .next_nodes = {
Neale Rannsf62a8c02019-04-02 08:13:33 +00001528 [ESP_DECRYPT_NEXT_DROP] = "ip6-drop",
1529 [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
1530 [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
Neale Ranns4a58e492020-12-21 13:19:10 +00001531 [ESP_DECRYPT_NEXT_MPLS_INPUT] = "mpls-drop",
Neale Ranns568acbb2019-12-18 05:54:40 +00001532 [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
Neale Rannsf62a8c02019-04-02 08:13:33 +00001533 [ESP_DECRYPT_NEXT_HANDOFF]= "esp6-decrypt-handoff",
Klement Sekerabe5a5dd2018-10-09 16:05:48 +02001534 },
1535};
Neale Rannsc87b66c2019-02-07 07:26:12 -08001536
Fan Zhangf5395782020-04-29 14:00:03 +01001537VLIB_REGISTER_NODE (esp6_decrypt_post_node) = {
1538 .name = "esp6-decrypt-post",
1539 .vector_size = sizeof (u32),
1540 .format_trace = format_esp_decrypt_trace,
1541 .type = VLIB_NODE_TYPE_INTERNAL,
1542
Neale Ranns93688d72022-08-09 03:34:51 +00001543 .n_errors = ESP_DECRYPT_N_ERROR,
1544 .error_counters = esp_decrypt_error_counters,
Fan Zhangf5395782020-04-29 14:00:03 +01001545
1546 .sibling_of = "esp6-decrypt",
1547};
1548
Neale Rannsc87b66c2019-02-07 07:26:12 -08001549VLIB_REGISTER_NODE (esp4_decrypt_tun_node) = {
1550 .name = "esp4-decrypt-tun",
1551 .vector_size = sizeof (u32),
1552 .format_trace = format_esp_decrypt_trace,
1553 .type = VLIB_NODE_TYPE_INTERNAL,
Neale Ranns93688d72022-08-09 03:34:51 +00001554 .n_errors = ESP_DECRYPT_N_ERROR,
1555 .error_counters = esp_decrypt_error_counters,
Neale Rannsf62a8c02019-04-02 08:13:33 +00001556 .n_next_nodes = ESP_DECRYPT_N_NEXT,
1557 .next_nodes = {
1558 [ESP_DECRYPT_NEXT_DROP] = "ip4-drop",
1559 [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
1560 [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
Neale Ranns4a58e492020-12-21 13:19:10 +00001561 [ESP_DECRYPT_NEXT_MPLS_INPUT] = "mpls-input",
Neale Ranns568acbb2019-12-18 05:54:40 +00001562 [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
Neale Ranns4a56f4e2019-12-23 04:10:25 +00001563 [ESP_DECRYPT_NEXT_HANDOFF] = "esp4-decrypt-tun-handoff",
Neale Rannsf62a8c02019-04-02 08:13:33 +00001564 },
Neale Rannsc87b66c2019-02-07 07:26:12 -08001565};
1566
Fan Zhangf5395782020-04-29 14:00:03 +01001567VLIB_REGISTER_NODE (esp4_decrypt_tun_post_node) = {
1568 .name = "esp4-decrypt-tun-post",
1569 .vector_size = sizeof (u32),
1570 .format_trace = format_esp_decrypt_trace,
1571 .type = VLIB_NODE_TYPE_INTERNAL,
1572
Neale Ranns93688d72022-08-09 03:34:51 +00001573 .n_errors = ESP_DECRYPT_N_ERROR,
1574 .error_counters = esp_decrypt_error_counters,
Fan Zhangf5395782020-04-29 14:00:03 +01001575
1576 .sibling_of = "esp4-decrypt-tun",
1577};
1578
Neale Rannsc87b66c2019-02-07 07:26:12 -08001579VLIB_REGISTER_NODE (esp6_decrypt_tun_node) = {
1580 .name = "esp6-decrypt-tun",
1581 .vector_size = sizeof (u32),
1582 .format_trace = format_esp_decrypt_trace,
1583 .type = VLIB_NODE_TYPE_INTERNAL,
Neale Ranns93688d72022-08-09 03:34:51 +00001584 .n_errors = ESP_DECRYPT_N_ERROR,
1585 .error_counters = esp_decrypt_error_counters,
Neale Rannsf62a8c02019-04-02 08:13:33 +00001586 .n_next_nodes = ESP_DECRYPT_N_NEXT,
1587 .next_nodes = {
1588 [ESP_DECRYPT_NEXT_DROP] = "ip6-drop",
1589 [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
1590 [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
Neale Ranns4a58e492020-12-21 13:19:10 +00001591 [ESP_DECRYPT_NEXT_MPLS_INPUT] = "mpls-input",
Neale Ranns568acbb2019-12-18 05:54:40 +00001592 [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
Neale Ranns4a56f4e2019-12-23 04:10:25 +00001593 [ESP_DECRYPT_NEXT_HANDOFF]= "esp6-decrypt-tun-handoff",
Neale Rannsf62a8c02019-04-02 08:13:33 +00001594 },
Neale Rannsc87b66c2019-02-07 07:26:12 -08001595};
Fan Zhangf5395782020-04-29 14:00:03 +01001596
1597VLIB_REGISTER_NODE (esp6_decrypt_tun_post_node) = {
1598 .name = "esp6-decrypt-tun-post",
1599 .vector_size = sizeof (u32),
1600 .format_trace = format_esp_decrypt_trace,
1601 .type = VLIB_NODE_TYPE_INTERNAL,
1602
Neale Ranns93688d72022-08-09 03:34:51 +00001603 .n_errors = ESP_DECRYPT_N_ERROR,
1604 .error_counters = esp_decrypt_error_counters,
Fan Zhangf5395782020-04-29 14:00:03 +01001605
1606 .sibling_of = "esp6-decrypt-tun",
1607};
Klement Sekerabe5a5dd2018-10-09 16:05:48 +02001608/* *INDENT-ON* */
1609
Neale Ranns2d498302021-02-25 08:38:58 +00001610#ifndef CLIB_MARCH_VARIANT
1611
1612static clib_error_t *
1613esp_decrypt_init (vlib_main_t *vm)
1614{
1615 ipsec_main_t *im = &ipsec_main;
1616
1617 im->esp4_dec_fq_index =
1618 vlib_frame_queue_main_init (esp4_decrypt_node.index, 0);
1619 im->esp6_dec_fq_index =
1620 vlib_frame_queue_main_init (esp6_decrypt_node.index, 0);
1621 im->esp4_dec_tun_fq_index =
1622 vlib_frame_queue_main_init (esp4_decrypt_tun_node.index, 0);
1623 im->esp6_dec_tun_fq_index =
1624 vlib_frame_queue_main_init (esp6_decrypt_tun_node.index, 0);
1625
1626 return 0;
1627}
1628
1629VLIB_INIT_FUNCTION (esp_decrypt_init);
1630
1631#endif
1632
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -07001633/*
1634 * fd.io coding-style-patch-verification: ON
1635 *
1636 * Local Variables:
1637 * eval: (c-set-style "gnu")
1638 * End:
1639 */