blob: 986ac94676c252d88ab21d09db4ad241b24300dc [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 */
17
18#include <vnet/vnet.h>
19#include <vnet/api_errno.h>
20#include <vnet/ip/ip.h>
21
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
Ed Warnickecb9cada2015-12-08 15:45:58 -070027#define foreach_esp_decrypt_next \
28_(DROP, "error-drop") \
Kingwel Xie561d1ca2019-03-05 22:56:17 -050029_(IP4_INPUT, "ip4-input-no-checksum") \
Neale Rannsc87b66c2019-02-07 07:26:12 -080030_(IP6_INPUT, "ip6-input")
Ed Warnickecb9cada2015-12-08 15:45:58 -070031
32#define _(v, s) ESP_DECRYPT_NEXT_##v,
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070033typedef enum
34{
Ed Warnickecb9cada2015-12-08 15:45:58 -070035 foreach_esp_decrypt_next
36#undef _
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070037 ESP_DECRYPT_N_NEXT,
Ed Warnickecb9cada2015-12-08 15:45:58 -070038} esp_decrypt_next_t;
39
40
Damjan Marionb4fff3a2019-03-25 15:54:40 +010041#define foreach_esp_decrypt_error \
42 _(RX_PKTS, "ESP pkts received") \
43 _(DECRYPTION_FAILED, "ESP decryption failed") \
44 _(INTEG_ERROR, "Integrity check failed") \
45 _(CRYPTO_ENGINE_ERROR, "crypto engine error (packet dropped)") \
46 _(REPLAY, "SA replayed packet") \
Damjan Mariona829b132019-04-24 23:39:16 +020047 _(RUNT, "undersized packet") \
Damjan Marionb4fff3a2019-03-25 15:54:40 +010048 _(CHAINED_BUFFER, "chained buffers (packet dropped)") \
49 _(OVERSIZED_HEADER, "buffer with oversized header (dropped)") \
50 _(NO_TAIL_SPACE, "no enough buffer tail space (dropped)")
Ed Warnickecb9cada2015-12-08 15:45:58 -070051
52
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070053typedef enum
54{
Ed Warnickecb9cada2015-12-08 15:45:58 -070055#define _(sym,str) ESP_DECRYPT_ERROR_##sym,
56 foreach_esp_decrypt_error
57#undef _
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070058 ESP_DECRYPT_N_ERROR,
Ed Warnickecb9cada2015-12-08 15:45:58 -070059} esp_decrypt_error_t;
60
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070061static char *esp_decrypt_error_strings[] = {
Ed Warnickecb9cada2015-12-08 15:45:58 -070062#define _(sym,string) string,
63 foreach_esp_decrypt_error
64#undef _
65};
66
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070067typedef struct
68{
Damjan Marionb4fff3a2019-03-25 15:54:40 +010069 u32 seq;
Neale Ranns6afaae12019-07-17 15:07:14 +000070 u32 sa_seq;
71 u32 sa_seq_hi;
Ed Warnickecb9cada2015-12-08 15:45:58 -070072 ipsec_crypto_alg_t crypto_alg;
73 ipsec_integ_alg_t integ_alg;
74} esp_decrypt_trace_t;
75
76/* packet trace format function */
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070077static u8 *
78format_esp_decrypt_trace (u8 * s, va_list * args)
Ed Warnickecb9cada2015-12-08 15:45:58 -070079{
80 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
81 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070082 esp_decrypt_trace_t *t = va_arg (*args, esp_decrypt_trace_t *);
Ed Warnickecb9cada2015-12-08 15:45:58 -070083
Neale Ranns6afaae12019-07-17 15:07:14 +000084 s =
85 format (s,
86 "esp: crypto %U integrity %U pkt-seq %d sa-seq %u sa-seq-hi %u",
87 format_ipsec_crypto_alg, t->crypto_alg, format_ipsec_integ_alg,
88 t->integ_alg, t->seq, t->sa_seq, t->sa_seq_hi);
Ed Warnickecb9cada2015-12-08 15:45:58 -070089 return s;
90}
91
Damjan Marionb4fff3a2019-03-25 15:54:40 +010092typedef struct
Ed Warnickecb9cada2015-12-08 15:45:58 -070093{
Damjan Marionb4fff3a2019-03-25 15:54:40 +010094 union
95 {
96 struct
97 {
98 u8 icv_sz;
99 u8 iv_sz;
Neale Rannsc87b66c2019-02-07 07:26:12 -0800100 ipsec_sa_flags_t flags;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100101 u32 sa_index;
102 };
103 u64 sa_data;
104 };
Ed Warnickecb9cada2015-12-08 15:45:58 -0700105
Neale Ranns6afaae12019-07-17 15:07:14 +0000106 u32 seq;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100107 i16 current_data;
108 i16 current_length;
109 u16 hdr_sz;
110} esp_decrypt_packet_data_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700111
Neale Ranns6afaae12019-07-17 15:07:14 +0000112STATIC_ASSERT_SIZEOF (esp_decrypt_packet_data_t, 3 * sizeof (u64));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700113
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100114#define ESP_ENCRYPT_PD_F_FD_TRANSPORT (1 << 2)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700115
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200116always_inline uword
117esp_decrypt_inline (vlib_main_t * vm,
118 vlib_node_runtime_t * node, vlib_frame_t * from_frame,
Neale Rannsc87b66c2019-02-07 07:26:12 -0800119 int is_ip6, int is_tun)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700120{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700121 ipsec_main_t *im = &ipsec_main;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100122 u32 thread_index = vm->thread_index;
123 u16 buffer_data_size = vlib_buffer_get_default_data_size (vm);
124 u16 len;
125 ipsec_per_thread_data_t *ptd = vec_elt_at_index (im->ptd, thread_index);
Damjan Marionc98275f2019-03-06 14:05:01 +0100126 u32 *from = vlib_frame_vector_args (from_frame);
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100127 u32 n, n_left = from_frame->n_vectors;
128 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
Damjan Marionc98275f2019-03-06 14:05:01 +0100129 u16 nexts[VLIB_FRAME_SIZE], *next = nexts;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100130 esp_decrypt_packet_data_t pkt_data[VLIB_FRAME_SIZE], *pd = pkt_data;
131 esp_decrypt_packet_data_t cpd = { };
132 u32 current_sa_index = ~0, current_sa_bytes = 0, current_sa_pkts = 0;
133 const u8 esp_sz = sizeof (esp_header_t);
134 ipsec_sa_t *sa0 = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700135
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100136 vlib_get_buffers (vm, from, b, n_left);
137 vec_reset_length (ptd->crypto_ops);
138 vec_reset_length (ptd->integ_ops);
139 clib_memset_u16 (nexts, -1, n_left);
140
141 while (n_left > 0)
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700142 {
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100143 u8 *payload;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700144
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100145 if (n_left > 2)
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700146 {
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100147 u8 *p;
148 vlib_prefetch_buffer_header (b[2], LOAD);
149 p = vlib_buffer_get_current (b[1]);
150 CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
151 p -= CLIB_CACHE_LINE_BYTES;
152 CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
153 }
154
155 if (vlib_buffer_chain_linearize (vm, b[0]) != 1)
156 {
157 b[0]->error = node->errors[ESP_DECRYPT_ERROR_CHAINED_BUFFER];
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100158 next[0] = ESP_DECRYPT_NEXT_DROP;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100159 goto next;
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700160 }
Damjan Marionc98275f2019-03-06 14:05:01 +0100161
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100162 if (vnet_buffer (b[0])->ipsec.sad_index != current_sa_index)
Damjan Marionc98275f2019-03-06 14:05:01 +0100163 {
Damjan Marion867dfdd2019-06-05 15:42:54 +0200164 if (current_sa_pkts)
165 vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
166 current_sa_index,
167 current_sa_pkts,
168 current_sa_bytes);
169 current_sa_bytes = current_sa_pkts = 0;
170
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100171 current_sa_index = vnet_buffer (b[0])->ipsec.sad_index;
172 sa0 = pool_elt_at_index (im->sad, current_sa_index);
Damjan Marion7c22ff72019-04-04 12:25:44 +0200173 cpd.icv_sz = sa0->integ_icv_size;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100174 cpd.iv_sz = sa0->crypto_iv_size;
175 cpd.flags = sa0->flags;
176 cpd.sa_index = current_sa_index;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100177 }
178
179 /* store packet data for next round for easier prefetch */
180 pd->sa_data = cpd.sa_data;
181 pd->current_data = b[0]->current_data;
182 pd->current_length = b[0]->current_length;
183 pd->hdr_sz = pd->current_data - vnet_buffer (b[0])->l3_hdr_offset;
184 payload = b[0]->data + pd->current_data;
Neale Ranns6afaae12019-07-17 15:07:14 +0000185 pd->seq = clib_host_to_net_u32 (((esp_header_t *) payload)->seq);
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100186
187 /* we need 4 extra bytes for HMAC calculation when ESN are used */
Neale Ranns49e7ef62019-04-10 17:24:29 +0000188 if (ipsec_sa_is_set_USE_ESN (sa0) && pd->icv_sz &&
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100189 (pd->current_data + pd->current_length + 4 > buffer_data_size))
190 {
191 b[0]->error = node->errors[ESP_DECRYPT_ERROR_NO_TAIL_SPACE];
192 next[0] = ESP_DECRYPT_NEXT_DROP;
193 goto next;
194 }
195
196 /* anti-reply check */
Neale Ranns6afaae12019-07-17 15:07:14 +0000197 if (ipsec_sa_anti_replay_check (sa0, pd->seq))
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100198 {
199 b[0]->error = node->errors[ESP_DECRYPT_ERROR_REPLAY];
200 next[0] = ESP_DECRYPT_NEXT_DROP;
201 goto next;
202 }
203
Damjan Mariona829b132019-04-24 23:39:16 +0200204 if (pd->current_length < cpd.icv_sz + esp_sz + cpd.iv_sz)
205 {
206 b[0]->error = node->errors[ESP_DECRYPT_ERROR_RUNT];
207 next[0] = ESP_DECRYPT_NEXT_DROP;
208 goto next;
209 }
210
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100211 len = pd->current_length - cpd.icv_sz;
212 current_sa_pkts += 1;
213 current_sa_bytes += pd->current_length;
214
Neale Ranns47feb112019-04-11 15:14:07 +0000215 if (PREDICT_TRUE (sa0->integ_op_id != VNET_CRYPTO_OP_NONE))
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100216 {
217 vnet_crypto_op_t *op;
218 vec_add2_aligned (ptd->integ_ops, op, 1, CLIB_CACHE_LINE_BYTES);
219
Damjan Marion060bfb92019-03-29 13:47:54 +0100220 vnet_crypto_op_init (op, sa0->integ_op_id);
Damjan Mariond1bed682019-04-24 15:20:35 +0200221 op->key_index = sa0->integ_key_index;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100222 op->src = payload;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100223 op->flags = VNET_CRYPTO_OP_FLAG_HMAC_CHECK;
224 op->user_data = b - bufs;
Damjan Marion060bfb92019-03-29 13:47:54 +0100225 op->digest = payload + len;
226 op->digest_len = cpd.icv_sz;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100227 op->len = len;
Neale Ranns49e7ef62019-04-10 17:24:29 +0000228 if (ipsec_sa_is_set_USE_ESN (sa0))
Damjan Marionc98275f2019-03-06 14:05:01 +0100229 {
Neale Ranns6afaae12019-07-17 15:07:14 +0000230 /* shift ICV by 4 bytes to insert ESN */
231 u32 seq_hi = clib_host_to_net_u32 (sa0->seq_hi);
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100232 u8 tmp[ESP_MAX_ICV_SIZE], sz = sizeof (sa0->seq_hi);
233 clib_memcpy_fast (tmp, payload + len, ESP_MAX_ICV_SIZE);
Neale Ranns6afaae12019-07-17 15:07:14 +0000234 clib_memcpy_fast (payload + len, &seq_hi, sz);
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100235 clib_memcpy_fast (payload + len + sz, tmp, ESP_MAX_ICV_SIZE);
236 op->len += sz;
Neale Ranns49e7ef62019-04-10 17:24:29 +0000237 op->digest += sz;
Damjan Marionc98275f2019-03-06 14:05:01 +0100238 }
239 }
240
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100241 payload += esp_sz;
242 len -= esp_sz;
Damjan Marionc98275f2019-03-06 14:05:01 +0100243
Damjan Marion060bfb92019-03-29 13:47:54 +0100244 if (sa0->crypto_enc_op_id != VNET_CRYPTO_OP_NONE)
Damjan Marionc98275f2019-03-06 14:05:01 +0100245 {
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100246 vnet_crypto_op_t *op;
247 vec_add2_aligned (ptd->crypto_ops, op, 1, CLIB_CACHE_LINE_BYTES);
Damjan Marion060bfb92019-03-29 13:47:54 +0100248 vnet_crypto_op_init (op, sa0->crypto_dec_op_id);
Damjan Mariond1bed682019-04-24 15:20:35 +0200249 op->key_index = sa0->crypto_key_index;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100250 op->iv = payload;
Neale Ranns47feb112019-04-11 15:14:07 +0000251
252 if (ipsec_sa_is_set_IS_AEAD (sa0))
253 {
254 esp_header_t *esp0;
255 esp_aead_t *aad;
256 u8 *scratch;
Neale Ranns47feb112019-04-11 15:14:07 +0000257
258 /*
259 * construct the AAD and the nonce (Salt || IV) in a scratch
260 * space in front of the IP header.
261 */
262 scratch = payload - esp_sz;
263 esp0 = (esp_header_t *) (scratch);
264
265 scratch -= (sizeof (*aad) + pd->hdr_sz);
266 op->aad = scratch;
267
268 esp_aad_fill (op, esp0, sa0);
269
270 /*
271 * we don't need to refer to the ESP header anymore so we
272 * can overwrite it with the salt and use the IV where it is
273 * to form the nonce = (Salt + IV)
274 */
Neale Ranns47feb112019-04-11 15:14:07 +0000275 op->iv -= sizeof (sa0->salt);
Neale Ranns80f6fd52019-04-16 02:41:34 +0000276 clib_memcpy_fast (op->iv, &sa0->salt, sizeof (sa0->salt));
Neale Ranns47feb112019-04-11 15:14:07 +0000277
278 op->tag = payload + len;
279 op->tag_len = 16;
280 }
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100281 op->src = op->dst = payload += cpd.iv_sz;
Neale Ranns0a0c7ee2019-04-13 15:30:21 +0000282 op->len = len - cpd.iv_sz;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100283 op->user_data = b - bufs;
Damjan Marionc98275f2019-03-06 14:05:01 +0100284 }
285
286 /* next */
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100287 next:
288 n_left -= 1;
Damjan Marionc98275f2019-03-06 14:05:01 +0100289 next += 1;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100290 pd += 1;
291 b += 1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700292 }
Damjan Marionc98275f2019-03-06 14:05:01 +0100293
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100294 vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
295 current_sa_index, current_sa_pkts,
296 current_sa_bytes);
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200297
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100298 if ((n = vec_len (ptd->integ_ops)))
299 {
300 vnet_crypto_op_t *op = ptd->integ_ops;
301 n -= vnet_crypto_process_ops (vm, op, n);
302 while (n)
303 {
304 ASSERT (op - ptd->integ_ops < vec_len (ptd->integ_ops));
305 if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
306 {
307 u32 err, bi = op->user_data;
308 if (op->status == VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC)
309 err = ESP_DECRYPT_ERROR_INTEG_ERROR;
310 else
311 err = ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR;
312 bufs[bi]->error = node->errors[err];
313 nexts[bi] = ESP_DECRYPT_NEXT_DROP;
314 n--;
315 }
316 op++;
317 }
318 }
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100319 if ((n = vec_len (ptd->crypto_ops)))
320 {
321 vnet_crypto_op_t *op = ptd->crypto_ops;
322 n -= vnet_crypto_process_ops (vm, op, n);
323 while (n)
324 {
325 ASSERT (op - ptd->crypto_ops < vec_len (ptd->crypto_ops));
326 if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
327 {
Neale Ranns92e93842019-04-08 07:36:50 +0000328 u32 err, bi;
329
330 bi = op->user_data;
331
332 if (op->status == VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC)
Neale Ranns21ada3b2019-04-11 08:18:34 +0000333 err = ESP_DECRYPT_ERROR_DECRYPTION_FAILED;
Neale Ranns92e93842019-04-08 07:36:50 +0000334 else
335 err = ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR;
336
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100337 bufs[bi]->error = node->errors[err];
338 nexts[bi] = ESP_DECRYPT_NEXT_DROP;
339 n--;
340 }
341 op++;
342 }
343 }
344
345 /* Post decryption ronud - adjust packet data start and length and next
346 node */
347
348 n_left = from_frame->n_vectors;
349 next = nexts;
350 pd = pkt_data;
351 b = bufs;
352
353 while (n_left)
354 {
355 const u8 tun_flags = IPSEC_SA_FLAG_IS_TUNNEL |
356 IPSEC_SA_FLAG_IS_TUNNEL_V6;
357
358 if (n_left >= 2)
359 {
360 void *data = b[1]->data + pd[1].current_data;
361
362 /* buffer metadata */
363 vlib_prefetch_buffer_header (b[1], LOAD);
364
365 /* esp_footer_t */
366 CLIB_PREFETCH (data + pd[1].current_length - pd[1].icv_sz - 2,
367 CLIB_CACHE_LINE_BYTES, LOAD);
368
369 /* packet headers */
370 CLIB_PREFETCH (data - CLIB_CACHE_LINE_BYTES,
371 CLIB_CACHE_LINE_BYTES * 2, LOAD);
372 }
373
374 if (next[0] < ESP_DECRYPT_N_NEXT)
375 goto trace;
376
377 sa0 = vec_elt_at_index (im->sad, pd->sa_index);
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100378
Neale Ranns3b9374f2019-08-01 04:45:15 -0700379 /*
380 * redo the anti-reply check
381 * in this frame say we have sequence numbers, s, s+1, s+1, s+1
382 * and s and s+1 are in the window. When we did the anti-replay
383 * check above we did so against the state of the window (W),
384 * after packet s-1. So each of the packets in the sequence will be
385 * accepted.
386 * This time s will be cheked against Ws-1, s+1 chceked against Ws
387 * (i.e. the window state is updated/advnaced)
388 * so this time the successive s+! packet will be dropped.
389 * This is a consequence of batching the decrypts. If the
390 * check-dcrypt-advance process was done for each packet it would
391 * be fine. But we batch the decrypts because it's much more efficient
392 * to do so in SW and if we offload to HW and the process is async.
393 *
394 * You're probably thinking, but this means an attacker can send the
395 * above sequence and cause VPP to perform decrpyts that will fail,
396 * and that's true. But if the attacker can determine s (a valid
397 * sequence number in the window) which is non-trivial, it can generate
398 * a sequence s, s+1, s+2, s+3, ... s+n and nothing will prevent any
399 * implementation, sequential or batching, from decrypting these.
400 */
401 if (ipsec_sa_anti_replay_check (sa0, pd->seq))
402 {
403 b[0]->error = node->errors[ESP_DECRYPT_ERROR_REPLAY];
404 next[0] = ESP_DECRYPT_NEXT_DROP;
405 goto trace;
406 }
407
Neale Ranns6afaae12019-07-17 15:07:14 +0000408 ipsec_sa_anti_replay_advance (sa0, pd->seq);
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100409
410 esp_footer_t *f = (esp_footer_t *) (b[0]->data + pd->current_data +
411 pd->current_length - sizeof (*f) -
412 pd->icv_sz);
413 u16 adv = pd->iv_sz + esp_sz;
414 u16 tail = sizeof (esp_footer_t) + f->pad_length + pd->icv_sz;
415
Neale Rannsc87b66c2019-02-07 07:26:12 -0800416 if ((pd->flags & tun_flags) == 0 && !is_tun) /* transport mode */
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100417 {
418 u8 udp_sz = (is_ip6 == 0 && pd->flags & IPSEC_SA_FLAG_UDP_ENCAP) ?
419 sizeof (udp_header_t) : 0;
420 u16 ip_hdr_sz = pd->hdr_sz - udp_sz;
421 u8 *old_ip = b[0]->data + pd->current_data - ip_hdr_sz - udp_sz;
422 u8 *ip = old_ip + adv + udp_sz;
423
424 if (is_ip6 && ip_hdr_sz > 64)
425 memmove (ip, old_ip, ip_hdr_sz);
426 else
427 clib_memcpy_le64 (ip, old_ip, ip_hdr_sz);
428
429 b[0]->current_data = pd->current_data + adv - ip_hdr_sz;
430 b[0]->current_length = pd->current_length + ip_hdr_sz - tail - adv;
431
432 if (is_ip6)
433 {
434 ip6_header_t *ip6 = (ip6_header_t *) ip;
435 u16 len = clib_net_to_host_u16 (ip6->payload_length);
436 len -= adv + tail;
437 ip6->payload_length = clib_host_to_net_u16 (len);
438 ip6->protocol = f->next_header;
439 next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
440 }
441 else
442 {
443 ip4_header_t *ip4 = (ip4_header_t *) ip;
444 ip_csum_t sum = ip4->checksum;
445 u16 len = clib_net_to_host_u16 (ip4->length);
446 len = clib_host_to_net_u16 (len - adv - tail - udp_sz);
447 sum = ip_csum_update (sum, ip4->protocol, f->next_header,
448 ip4_header_t, protocol);
449 sum = ip_csum_update (sum, ip4->length, len,
450 ip4_header_t, length);
451 ip4->checksum = ip_csum_fold (sum);
452 ip4->protocol = f->next_header;
453 ip4->length = len;
454 next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
455 }
456 }
457 else
458 {
459 if (PREDICT_TRUE (f->next_header == IP_PROTOCOL_IP_IN_IP))
460 {
461 next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
462 b[0]->current_data = pd->current_data + adv;
Matthew G Smith2a2e5932019-05-22 13:34:08 -0500463 b[0]->current_length = pd->current_length - adv - tail;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100464 }
465 else if (f->next_header == IP_PROTOCOL_IPV6)
466 {
467 next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
468 b[0]->current_data = pd->current_data + adv;
Matthew G Smith2a2e5932019-05-22 13:34:08 -0500469 b[0]->current_length = pd->current_length - adv - tail;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100470 }
471 else
472 {
473 next[0] = ESP_DECRYPT_NEXT_DROP;
474 b[0]->error = node->errors[ESP_DECRYPT_ERROR_DECRYPTION_FAILED];
Neale Rannsc87b66c2019-02-07 07:26:12 -0800475 goto trace;
476 }
477 if (is_tun)
478 {
479 if (ipsec_sa_is_set_IS_PROTECT (sa0))
480 {
481 /*
482 * Check that the reveal IP header matches that
483 * of the tunnel we are protecting
484 */
485 const ipsec_tun_protect_t *itp;
486
487 itp =
488 ipsec_tun_protect_get (vnet_buffer (b[0])->
489 ipsec.protect_index);
490 if (PREDICT_TRUE (f->next_header == IP_PROTOCOL_IP_IN_IP))
491 {
492 const ip4_header_t *ip4;
493
494 ip4 = vlib_buffer_get_current (b[0]);
495
496 if (!ip46_address_is_equal_v4 (&itp->itp_tun.src,
497 &ip4->dst_address) ||
498 !ip46_address_is_equal_v4 (&itp->itp_tun.dst,
499 &ip4->src_address))
500 next[0] = ESP_DECRYPT_NEXT_DROP;
501
502 }
503 else if (f->next_header == IP_PROTOCOL_IPV6)
504 {
505 const ip6_header_t *ip6;
506
507 ip6 = vlib_buffer_get_current (b[0]);
508
509 if (!ip46_address_is_equal_v6 (&itp->itp_tun.src,
510 &ip6->dst_address) ||
511 !ip46_address_is_equal_v6 (&itp->itp_tun.dst,
512 &ip6->src_address))
513 next[0] = ESP_DECRYPT_NEXT_DROP;
514 }
515 }
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100516 }
517 }
518
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100519 trace:
520 if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
521 {
522 esp_decrypt_trace_t *tr;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100523 tr = vlib_add_trace (vm, node, b[0], sizeof (*tr));
524 sa0 = pool_elt_at_index (im->sad,
525 vnet_buffer (b[0])->ipsec.sad_index);
526 tr->crypto_alg = sa0->crypto_alg;
527 tr->integ_alg = sa0->integ_alg;
Neale Ranns6afaae12019-07-17 15:07:14 +0000528 tr->seq = pd->seq;
529 tr->sa_seq = sa0->last_seq;
530 tr->sa_seq_hi = sa0->seq_hi;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100531 }
532
533 /* next */
534 n_left -= 1;
535 next += 1;
536 pd += 1;
537 b += 1;
538 }
539
540 n_left = from_frame->n_vectors;
541 vlib_node_increment_counter (vm, node->node_index,
542 ESP_DECRYPT_ERROR_RX_PKTS, n_left);
543
544 vlib_buffer_enqueue_to_next (vm, node, from, nexts, n_left);
545
546 b = bufs;
547 return n_left;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700548}
549
Klement Sekerab8f35442018-10-29 13:38:19 +0100550VLIB_NODE_FN (esp4_decrypt_node) (vlib_main_t * vm,
551 vlib_node_runtime_t * node,
552 vlib_frame_t * from_frame)
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200553{
Neale Rannsc87b66c2019-02-07 07:26:12 -0800554 return esp_decrypt_inline (vm, node, from_frame, 0, 0);
555}
556
557VLIB_NODE_FN (esp4_decrypt_tun_node) (vlib_main_t * vm,
558 vlib_node_runtime_t * node,
559 vlib_frame_t * from_frame)
560{
561 return esp_decrypt_inline (vm, node, from_frame, 0, 1);
562}
563
564VLIB_NODE_FN (esp6_decrypt_node) (vlib_main_t * vm,
565 vlib_node_runtime_t * node,
566 vlib_frame_t * from_frame)
567{
568 return esp_decrypt_inline (vm, node, from_frame, 1, 0);
569}
570
571VLIB_NODE_FN (esp6_decrypt_tun_node) (vlib_main_t * vm,
572 vlib_node_runtime_t * node,
573 vlib_frame_t * from_frame)
574{
575 return esp_decrypt_inline (vm, node, from_frame, 1, 1);
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200576}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700577
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700578/* *INDENT-OFF* */
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200579VLIB_REGISTER_NODE (esp4_decrypt_node) = {
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200580 .name = "esp4-decrypt",
Ed Warnickecb9cada2015-12-08 15:45:58 -0700581 .vector_size = sizeof (u32),
582 .format_trace = format_esp_decrypt_trace,
583 .type = VLIB_NODE_TYPE_INTERNAL,
584
585 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
586 .error_strings = esp_decrypt_error_strings,
587
588 .n_next_nodes = ESP_DECRYPT_N_NEXT,
589 .next_nodes = {
590#define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
591 foreach_esp_decrypt_next
592#undef _
593 },
594};
595
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200596VLIB_REGISTER_NODE (esp6_decrypt_node) = {
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200597 .name = "esp6-decrypt",
598 .vector_size = sizeof (u32),
599 .format_trace = format_esp_decrypt_trace,
600 .type = VLIB_NODE_TYPE_INTERNAL,
601
602 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
603 .error_strings = esp_decrypt_error_strings,
604
605 .n_next_nodes = ESP_DECRYPT_N_NEXT,
606 .next_nodes = {
607#define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
608 foreach_esp_decrypt_next
609#undef _
610 },
611};
Neale Rannsc87b66c2019-02-07 07:26:12 -0800612
613VLIB_REGISTER_NODE (esp4_decrypt_tun_node) = {
614 .name = "esp4-decrypt-tun",
615 .vector_size = sizeof (u32),
616 .format_trace = format_esp_decrypt_trace,
617 .type = VLIB_NODE_TYPE_INTERNAL,
618
619 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
620 .error_strings = esp_decrypt_error_strings,
621
622 .n_next_nodes = ESP_DECRYPT_N_NEXT,
623 .next_nodes = {
624#define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
625 foreach_esp_decrypt_next
626#undef _
627 },
628};
629
630VLIB_REGISTER_NODE (esp6_decrypt_tun_node) = {
631 .name = "esp6-decrypt-tun",
632 .vector_size = sizeof (u32),
633 .format_trace = format_esp_decrypt_trace,
634 .type = VLIB_NODE_TYPE_INTERNAL,
635
636 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
637 .error_strings = esp_decrypt_error_strings,
638
639 .n_next_nodes = ESP_DECRYPT_N_NEXT,
640 .next_nodes = {
641#define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
642 foreach_esp_decrypt_next
643#undef _
644 },
645};
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200646/* *INDENT-ON* */
647
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700648/*
649 * fd.io coding-style-patch-verification: ON
650 *
651 * Local Variables:
652 * eval: (c-set-style "gnu")
653 * End:
654 */