blob: ee53b018552cc9d02591613e194ecdf81eeff649 [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
Neale Ranns568acbb2019-12-18 05:54:40 +000027#include <vnet/gre/gre.h>
28
Ed Warnickecb9cada2015-12-08 15:45:58 -070029#define foreach_esp_decrypt_next \
30_(DROP, "error-drop") \
Kingwel Xie561d1ca2019-03-05 22:56:17 -050031_(IP4_INPUT, "ip4-input-no-checksum") \
Neale Rannsf62a8c02019-04-02 08:13:33 +000032_(IP6_INPUT, "ip6-input") \
Neale Ranns568acbb2019-12-18 05:54:40 +000033_(L2_INPUT, "l2-input") \
Neale Rannsf62a8c02019-04-02 08:13:33 +000034_(HANDOFF, "handoff")
Ed Warnickecb9cada2015-12-08 15:45:58 -070035
36#define _(v, s) ESP_DECRYPT_NEXT_##v,
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070037typedef enum
38{
Ed Warnickecb9cada2015-12-08 15:45:58 -070039 foreach_esp_decrypt_next
40#undef _
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070041 ESP_DECRYPT_N_NEXT,
Ed Warnickecb9cada2015-12-08 15:45:58 -070042} esp_decrypt_next_t;
43
44
Damjan Marionb4fff3a2019-03-25 15:54:40 +010045#define foreach_esp_decrypt_error \
46 _(RX_PKTS, "ESP pkts received") \
47 _(DECRYPTION_FAILED, "ESP decryption failed") \
48 _(INTEG_ERROR, "Integrity check failed") \
49 _(CRYPTO_ENGINE_ERROR, "crypto engine error (packet dropped)") \
50 _(REPLAY, "SA replayed packet") \
Damjan Mariona829b132019-04-24 23:39:16 +020051 _(RUNT, "undersized packet") \
Damjan Marionb4fff3a2019-03-25 15:54:40 +010052 _(CHAINED_BUFFER, "chained buffers (packet dropped)") \
53 _(OVERSIZED_HEADER, "buffer with oversized header (dropped)") \
Neale Ranns12989b52019-09-26 16:20:19 +000054 _(NO_TAIL_SPACE, "no enough buffer tail space (dropped)") \
55 _(TUN_NO_PROTO, "no tunnel protocol") \
Neale Ranns02950402019-12-20 00:54:57 +000056 _(UNSUP_PAYLOAD, "unsupported payload") \
Ed Warnickecb9cada2015-12-08 15:45:58 -070057
58
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070059typedef enum
60{
Ed Warnickecb9cada2015-12-08 15:45:58 -070061#define _(sym,str) ESP_DECRYPT_ERROR_##sym,
62 foreach_esp_decrypt_error
63#undef _
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070064 ESP_DECRYPT_N_ERROR,
Ed Warnickecb9cada2015-12-08 15:45:58 -070065} esp_decrypt_error_t;
66
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070067static char *esp_decrypt_error_strings[] = {
Ed Warnickecb9cada2015-12-08 15:45:58 -070068#define _(sym,string) string,
69 foreach_esp_decrypt_error
70#undef _
71};
72
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070073typedef struct
74{
Damjan Marionb4fff3a2019-03-25 15:54:40 +010075 u32 seq;
Neale Ranns6afaae12019-07-17 15:07:14 +000076 u32 sa_seq;
77 u32 sa_seq_hi;
Ed Warnickecb9cada2015-12-08 15:45:58 -070078 ipsec_crypto_alg_t crypto_alg;
79 ipsec_integ_alg_t integ_alg;
80} esp_decrypt_trace_t;
81
82/* packet trace format function */
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070083static u8 *
84format_esp_decrypt_trace (u8 * s, va_list * args)
Ed Warnickecb9cada2015-12-08 15:45:58 -070085{
86 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
87 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070088 esp_decrypt_trace_t *t = va_arg (*args, esp_decrypt_trace_t *);
Ed Warnickecb9cada2015-12-08 15:45:58 -070089
Neale Ranns6afaae12019-07-17 15:07:14 +000090 s =
91 format (s,
92 "esp: crypto %U integrity %U pkt-seq %d sa-seq %u sa-seq-hi %u",
93 format_ipsec_crypto_alg, t->crypto_alg, format_ipsec_integ_alg,
94 t->integ_alg, t->seq, t->sa_seq, t->sa_seq_hi);
Ed Warnickecb9cada2015-12-08 15:45:58 -070095 return s;
96}
97
Damjan Marionb4fff3a2019-03-25 15:54:40 +010098typedef struct
Ed Warnickecb9cada2015-12-08 15:45:58 -070099{
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100100 union
101 {
102 struct
103 {
104 u8 icv_sz;
105 u8 iv_sz;
Neale Rannsc87b66c2019-02-07 07:26:12 -0800106 ipsec_sa_flags_t flags;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100107 u32 sa_index;
108 };
109 u64 sa_data;
110 };
Ed Warnickecb9cada2015-12-08 15:45:58 -0700111
Neale Ranns6afaae12019-07-17 15:07:14 +0000112 u32 seq;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100113 i16 current_data;
114 i16 current_length;
115 u16 hdr_sz;
116} esp_decrypt_packet_data_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700117
Neale Ranns6afaae12019-07-17 15:07:14 +0000118STATIC_ASSERT_SIZEOF (esp_decrypt_packet_data_t, 3 * sizeof (u64));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700119
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100120#define ESP_ENCRYPT_PD_F_FD_TRANSPORT (1 << 2)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700121
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200122always_inline uword
123esp_decrypt_inline (vlib_main_t * vm,
124 vlib_node_runtime_t * node, vlib_frame_t * from_frame,
Neale Rannsc87b66c2019-02-07 07:26:12 -0800125 int is_ip6, int is_tun)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700126{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700127 ipsec_main_t *im = &ipsec_main;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100128 u32 thread_index = vm->thread_index;
129 u16 buffer_data_size = vlib_buffer_get_default_data_size (vm);
130 u16 len;
131 ipsec_per_thread_data_t *ptd = vec_elt_at_index (im->ptd, thread_index);
Damjan Marionc98275f2019-03-06 14:05:01 +0100132 u32 *from = vlib_frame_vector_args (from_frame);
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100133 u32 n, n_left = from_frame->n_vectors;
134 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
Damjan Marionc98275f2019-03-06 14:05:01 +0100135 u16 nexts[VLIB_FRAME_SIZE], *next = nexts;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100136 esp_decrypt_packet_data_t pkt_data[VLIB_FRAME_SIZE], *pd = pkt_data;
137 esp_decrypt_packet_data_t cpd = { };
138 u32 current_sa_index = ~0, current_sa_bytes = 0, current_sa_pkts = 0;
139 const u8 esp_sz = sizeof (esp_header_t);
140 ipsec_sa_t *sa0 = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700141
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100142 vlib_get_buffers (vm, from, b, n_left);
143 vec_reset_length (ptd->crypto_ops);
144 vec_reset_length (ptd->integ_ops);
145 clib_memset_u16 (nexts, -1, n_left);
146
147 while (n_left > 0)
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700148 {
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100149 u8 *payload;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700150
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100151 if (n_left > 2)
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700152 {
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100153 u8 *p;
154 vlib_prefetch_buffer_header (b[2], LOAD);
155 p = vlib_buffer_get_current (b[1]);
156 CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
157 p -= CLIB_CACHE_LINE_BYTES;
158 CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
159 }
160
161 if (vlib_buffer_chain_linearize (vm, b[0]) != 1)
162 {
163 b[0]->error = node->errors[ESP_DECRYPT_ERROR_CHAINED_BUFFER];
Damjan Marion1f4e1cb2019-03-28 19:19:31 +0100164 next[0] = ESP_DECRYPT_NEXT_DROP;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100165 goto next;
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700166 }
Damjan Marionc98275f2019-03-06 14:05:01 +0100167
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100168 if (vnet_buffer (b[0])->ipsec.sad_index != current_sa_index)
Damjan Marionc98275f2019-03-06 14:05:01 +0100169 {
Damjan Marion867dfdd2019-06-05 15:42:54 +0200170 if (current_sa_pkts)
171 vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
172 current_sa_index,
173 current_sa_pkts,
174 current_sa_bytes);
175 current_sa_bytes = current_sa_pkts = 0;
176
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100177 current_sa_index = vnet_buffer (b[0])->ipsec.sad_index;
178 sa0 = pool_elt_at_index (im->sad, current_sa_index);
Damjan Marion7c22ff72019-04-04 12:25:44 +0200179 cpd.icv_sz = sa0->integ_icv_size;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100180 cpd.iv_sz = sa0->crypto_iv_size;
181 cpd.flags = sa0->flags;
182 cpd.sa_index = current_sa_index;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100183 }
184
Neale Rannsf62a8c02019-04-02 08:13:33 +0000185 if (PREDICT_FALSE (~0 == sa0->decrypt_thread_index))
186 {
187 /* this is the first packet to use this SA, claim the SA
188 * for this thread. this could happen simultaneously on
189 * another thread */
190 clib_atomic_cmp_and_swap (&sa0->decrypt_thread_index, ~0,
191 ipsec_sa_assign_thread (thread_index));
192 }
193
194 if (PREDICT_TRUE (thread_index != sa0->decrypt_thread_index))
195 {
196 next[0] = ESP_DECRYPT_NEXT_HANDOFF;
197 goto next;
198 }
199
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100200 /* store packet data for next round for easier prefetch */
201 pd->sa_data = cpd.sa_data;
202 pd->current_data = b[0]->current_data;
203 pd->current_length = b[0]->current_length;
204 pd->hdr_sz = pd->current_data - vnet_buffer (b[0])->l3_hdr_offset;
205 payload = b[0]->data + pd->current_data;
Neale Ranns6afaae12019-07-17 15:07:14 +0000206 pd->seq = clib_host_to_net_u32 (((esp_header_t *) payload)->seq);
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100207
208 /* we need 4 extra bytes for HMAC calculation when ESN are used */
Neale Ranns49e7ef62019-04-10 17:24:29 +0000209 if (ipsec_sa_is_set_USE_ESN (sa0) && pd->icv_sz &&
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100210 (pd->current_data + pd->current_length + 4 > buffer_data_size))
211 {
212 b[0]->error = node->errors[ESP_DECRYPT_ERROR_NO_TAIL_SPACE];
213 next[0] = ESP_DECRYPT_NEXT_DROP;
214 goto next;
215 }
216
217 /* anti-reply check */
Neale Ranns6afaae12019-07-17 15:07:14 +0000218 if (ipsec_sa_anti_replay_check (sa0, pd->seq))
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100219 {
220 b[0]->error = node->errors[ESP_DECRYPT_ERROR_REPLAY];
221 next[0] = ESP_DECRYPT_NEXT_DROP;
222 goto next;
223 }
224
Damjan Mariona829b132019-04-24 23:39:16 +0200225 if (pd->current_length < cpd.icv_sz + esp_sz + cpd.iv_sz)
226 {
227 b[0]->error = node->errors[ESP_DECRYPT_ERROR_RUNT];
228 next[0] = ESP_DECRYPT_NEXT_DROP;
229 goto next;
230 }
231
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100232 len = pd->current_length - cpd.icv_sz;
233 current_sa_pkts += 1;
234 current_sa_bytes += pd->current_length;
235
Neale Ranns47feb112019-04-11 15:14:07 +0000236 if (PREDICT_TRUE (sa0->integ_op_id != VNET_CRYPTO_OP_NONE))
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100237 {
238 vnet_crypto_op_t *op;
239 vec_add2_aligned (ptd->integ_ops, op, 1, CLIB_CACHE_LINE_BYTES);
240
Damjan Marion060bfb92019-03-29 13:47:54 +0100241 vnet_crypto_op_init (op, sa0->integ_op_id);
Damjan Mariond1bed682019-04-24 15:20:35 +0200242 op->key_index = sa0->integ_key_index;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100243 op->src = payload;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100244 op->flags = VNET_CRYPTO_OP_FLAG_HMAC_CHECK;
245 op->user_data = b - bufs;
Damjan Marion060bfb92019-03-29 13:47:54 +0100246 op->digest = payload + len;
247 op->digest_len = cpd.icv_sz;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100248 op->len = len;
Neale Ranns49e7ef62019-04-10 17:24:29 +0000249 if (ipsec_sa_is_set_USE_ESN (sa0))
Damjan Marionc98275f2019-03-06 14:05:01 +0100250 {
Neale Ranns6afaae12019-07-17 15:07:14 +0000251 /* shift ICV by 4 bytes to insert ESN */
252 u32 seq_hi = clib_host_to_net_u32 (sa0->seq_hi);
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100253 u8 tmp[ESP_MAX_ICV_SIZE], sz = sizeof (sa0->seq_hi);
254 clib_memcpy_fast (tmp, payload + len, ESP_MAX_ICV_SIZE);
Neale Ranns6afaae12019-07-17 15:07:14 +0000255 clib_memcpy_fast (payload + len, &seq_hi, sz);
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100256 clib_memcpy_fast (payload + len + sz, tmp, ESP_MAX_ICV_SIZE);
257 op->len += sz;
Neale Ranns49e7ef62019-04-10 17:24:29 +0000258 op->digest += sz;
Damjan Marionc98275f2019-03-06 14:05:01 +0100259 }
260 }
261
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100262 payload += esp_sz;
263 len -= esp_sz;
Damjan Marionc98275f2019-03-06 14:05:01 +0100264
Damjan Marion060bfb92019-03-29 13:47:54 +0100265 if (sa0->crypto_enc_op_id != VNET_CRYPTO_OP_NONE)
Damjan Marionc98275f2019-03-06 14:05:01 +0100266 {
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100267 vnet_crypto_op_t *op;
268 vec_add2_aligned (ptd->crypto_ops, op, 1, CLIB_CACHE_LINE_BYTES);
Damjan Marion060bfb92019-03-29 13:47:54 +0100269 vnet_crypto_op_init (op, sa0->crypto_dec_op_id);
Damjan Mariond1bed682019-04-24 15:20:35 +0200270 op->key_index = sa0->crypto_key_index;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100271 op->iv = payload;
Neale Ranns47feb112019-04-11 15:14:07 +0000272
273 if (ipsec_sa_is_set_IS_AEAD (sa0))
274 {
275 esp_header_t *esp0;
276 esp_aead_t *aad;
277 u8 *scratch;
Neale Ranns47feb112019-04-11 15:14:07 +0000278
279 /*
280 * construct the AAD and the nonce (Salt || IV) in a scratch
281 * space in front of the IP header.
282 */
283 scratch = payload - esp_sz;
284 esp0 = (esp_header_t *) (scratch);
285
286 scratch -= (sizeof (*aad) + pd->hdr_sz);
287 op->aad = scratch;
288
289 esp_aad_fill (op, esp0, sa0);
290
291 /*
292 * we don't need to refer to the ESP header anymore so we
293 * can overwrite it with the salt and use the IV where it is
294 * to form the nonce = (Salt + IV)
295 */
Neale Ranns47feb112019-04-11 15:14:07 +0000296 op->iv -= sizeof (sa0->salt);
Neale Ranns80f6fd52019-04-16 02:41:34 +0000297 clib_memcpy_fast (op->iv, &sa0->salt, sizeof (sa0->salt));
Neale Ranns47feb112019-04-11 15:14:07 +0000298
299 op->tag = payload + len;
300 op->tag_len = 16;
301 }
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100302 op->src = op->dst = payload += cpd.iv_sz;
Neale Ranns0a0c7ee2019-04-13 15:30:21 +0000303 op->len = len - cpd.iv_sz;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100304 op->user_data = b - bufs;
Damjan Marionc98275f2019-03-06 14:05:01 +0100305 }
306
307 /* next */
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100308 next:
309 n_left -= 1;
Damjan Marionc98275f2019-03-06 14:05:01 +0100310 next += 1;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100311 pd += 1;
312 b += 1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700313 }
Damjan Marionc98275f2019-03-06 14:05:01 +0100314
Neale Ranns02950402019-12-20 00:54:57 +0000315 if (PREDICT_TRUE (~0 != current_sa_index))
316 vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
317 current_sa_index, current_sa_pkts,
318 current_sa_bytes);
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200319
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100320 if ((n = vec_len (ptd->integ_ops)))
321 {
322 vnet_crypto_op_t *op = ptd->integ_ops;
323 n -= vnet_crypto_process_ops (vm, op, n);
324 while (n)
325 {
326 ASSERT (op - ptd->integ_ops < vec_len (ptd->integ_ops));
327 if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
328 {
329 u32 err, bi = op->user_data;
330 if (op->status == VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC)
331 err = ESP_DECRYPT_ERROR_INTEG_ERROR;
332 else
333 err = ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR;
334 bufs[bi]->error = node->errors[err];
335 nexts[bi] = ESP_DECRYPT_NEXT_DROP;
336 n--;
337 }
338 op++;
339 }
340 }
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100341 if ((n = vec_len (ptd->crypto_ops)))
342 {
343 vnet_crypto_op_t *op = ptd->crypto_ops;
344 n -= vnet_crypto_process_ops (vm, op, n);
345 while (n)
346 {
347 ASSERT (op - ptd->crypto_ops < vec_len (ptd->crypto_ops));
348 if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
349 {
Neale Ranns92e93842019-04-08 07:36:50 +0000350 u32 err, bi;
351
352 bi = op->user_data;
353
354 if (op->status == VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC)
Neale Ranns21ada3b2019-04-11 08:18:34 +0000355 err = ESP_DECRYPT_ERROR_DECRYPTION_FAILED;
Neale Ranns92e93842019-04-08 07:36:50 +0000356 else
357 err = ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR;
358
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100359 bufs[bi]->error = node->errors[err];
360 nexts[bi] = ESP_DECRYPT_NEXT_DROP;
361 n--;
362 }
363 op++;
364 }
365 }
366
367 /* Post decryption ronud - adjust packet data start and length and next
368 node */
369
370 n_left = from_frame->n_vectors;
371 next = nexts;
372 pd = pkt_data;
373 b = bufs;
374
375 while (n_left)
376 {
377 const u8 tun_flags = IPSEC_SA_FLAG_IS_TUNNEL |
378 IPSEC_SA_FLAG_IS_TUNNEL_V6;
379
380 if (n_left >= 2)
381 {
382 void *data = b[1]->data + pd[1].current_data;
383
384 /* buffer metadata */
385 vlib_prefetch_buffer_header (b[1], LOAD);
386
387 /* esp_footer_t */
388 CLIB_PREFETCH (data + pd[1].current_length - pd[1].icv_sz - 2,
389 CLIB_CACHE_LINE_BYTES, LOAD);
390
391 /* packet headers */
392 CLIB_PREFETCH (data - CLIB_CACHE_LINE_BYTES,
393 CLIB_CACHE_LINE_BYTES * 2, LOAD);
394 }
395
396 if (next[0] < ESP_DECRYPT_N_NEXT)
397 goto trace;
398
399 sa0 = vec_elt_at_index (im->sad, pd->sa_index);
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100400
Neale Ranns3b9374f2019-08-01 04:45:15 -0700401 /*
402 * redo the anti-reply check
403 * in this frame say we have sequence numbers, s, s+1, s+1, s+1
404 * and s and s+1 are in the window. When we did the anti-replay
405 * check above we did so against the state of the window (W),
406 * after packet s-1. So each of the packets in the sequence will be
407 * accepted.
408 * This time s will be cheked against Ws-1, s+1 chceked against Ws
409 * (i.e. the window state is updated/advnaced)
410 * so this time the successive s+! packet will be dropped.
411 * This is a consequence of batching the decrypts. If the
412 * check-dcrypt-advance process was done for each packet it would
413 * be fine. But we batch the decrypts because it's much more efficient
414 * to do so in SW and if we offload to HW and the process is async.
415 *
416 * You're probably thinking, but this means an attacker can send the
417 * above sequence and cause VPP to perform decrpyts that will fail,
418 * and that's true. But if the attacker can determine s (a valid
419 * sequence number in the window) which is non-trivial, it can generate
420 * a sequence s, s+1, s+2, s+3, ... s+n and nothing will prevent any
421 * implementation, sequential or batching, from decrypting these.
422 */
423 if (ipsec_sa_anti_replay_check (sa0, pd->seq))
424 {
425 b[0]->error = node->errors[ESP_DECRYPT_ERROR_REPLAY];
426 next[0] = ESP_DECRYPT_NEXT_DROP;
427 goto trace;
428 }
429
Neale Ranns6afaae12019-07-17 15:07:14 +0000430 ipsec_sa_anti_replay_advance (sa0, pd->seq);
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100431
432 esp_footer_t *f = (esp_footer_t *) (b[0]->data + pd->current_data +
433 pd->current_length - sizeof (*f) -
434 pd->icv_sz);
435 u16 adv = pd->iv_sz + esp_sz;
436 u16 tail = sizeof (esp_footer_t) + f->pad_length + pd->icv_sz;
437
Neale Rannsc87b66c2019-02-07 07:26:12 -0800438 if ((pd->flags & tun_flags) == 0 && !is_tun) /* transport mode */
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100439 {
440 u8 udp_sz = (is_ip6 == 0 && pd->flags & IPSEC_SA_FLAG_UDP_ENCAP) ?
441 sizeof (udp_header_t) : 0;
442 u16 ip_hdr_sz = pd->hdr_sz - udp_sz;
443 u8 *old_ip = b[0]->data + pd->current_data - ip_hdr_sz - udp_sz;
444 u8 *ip = old_ip + adv + udp_sz;
445
446 if (is_ip6 && ip_hdr_sz > 64)
447 memmove (ip, old_ip, ip_hdr_sz);
448 else
449 clib_memcpy_le64 (ip, old_ip, ip_hdr_sz);
450
451 b[0]->current_data = pd->current_data + adv - ip_hdr_sz;
452 b[0]->current_length = pd->current_length + ip_hdr_sz - tail - adv;
453
454 if (is_ip6)
455 {
456 ip6_header_t *ip6 = (ip6_header_t *) ip;
457 u16 len = clib_net_to_host_u16 (ip6->payload_length);
458 len -= adv + tail;
459 ip6->payload_length = clib_host_to_net_u16 (len);
460 ip6->protocol = f->next_header;
461 next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
462 }
463 else
464 {
465 ip4_header_t *ip4 = (ip4_header_t *) ip;
466 ip_csum_t sum = ip4->checksum;
467 u16 len = clib_net_to_host_u16 (ip4->length);
468 len = clib_host_to_net_u16 (len - adv - tail - udp_sz);
469 sum = ip_csum_update (sum, ip4->protocol, f->next_header,
470 ip4_header_t, protocol);
471 sum = ip_csum_update (sum, ip4->length, len,
472 ip4_header_t, length);
473 ip4->checksum = ip_csum_fold (sum);
474 ip4->protocol = f->next_header;
475 ip4->length = len;
476 next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
477 }
478 }
479 else
480 {
481 if (PREDICT_TRUE (f->next_header == IP_PROTOCOL_IP_IN_IP))
482 {
483 next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
484 b[0]->current_data = pd->current_data + adv;
Matthew G Smith2a2e5932019-05-22 13:34:08 -0500485 b[0]->current_length = pd->current_length - adv - tail;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100486 }
487 else if (f->next_header == IP_PROTOCOL_IPV6)
488 {
489 next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
490 b[0]->current_data = pd->current_data + adv;
Matthew G Smith2a2e5932019-05-22 13:34:08 -0500491 b[0]->current_length = pd->current_length - adv - tail;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100492 }
493 else
494 {
Neale Ranns568acbb2019-12-18 05:54:40 +0000495 if (is_tun && f->next_header == IP_PROTOCOL_GRE)
496 {
497 gre_header_t *gre;
498
499 b[0]->current_data = pd->current_data + adv;
500 b[0]->current_length = pd->current_length - adv - tail;
501
502 gre = vlib_buffer_get_current (b[0]);
503
504 vlib_buffer_advance (b[0], sizeof (*gre));
505
506 switch (clib_net_to_host_u16 (gre->protocol))
507 {
508 case GRE_PROTOCOL_teb:
509 next[0] = ESP_DECRYPT_NEXT_L2_INPUT;
510 break;
511 case GRE_PROTOCOL_ip4:
512 next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
513 break;
514 case GRE_PROTOCOL_ip6:
515 next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
516 break;
517 default:
Neale Ranns02950402019-12-20 00:54:57 +0000518 b[0]->error =
519 node->errors[ESP_DECRYPT_ERROR_UNSUP_PAYLOAD];
Neale Ranns568acbb2019-12-18 05:54:40 +0000520 next[0] = ESP_DECRYPT_NEXT_DROP;
521 break;
522 }
523 }
524 else
525 {
526 next[0] = ESP_DECRYPT_NEXT_DROP;
Neale Ranns02950402019-12-20 00:54:57 +0000527 b[0]->error = node->errors[ESP_DECRYPT_ERROR_UNSUP_PAYLOAD];
Neale Ranns568acbb2019-12-18 05:54:40 +0000528 goto trace;
529 }
Neale Rannsc87b66c2019-02-07 07:26:12 -0800530 }
531 if (is_tun)
532 {
533 if (ipsec_sa_is_set_IS_PROTECT (sa0))
534 {
535 /*
Neale Ranns02950402019-12-20 00:54:57 +0000536 * There are two encap possibilities
537 * 1) the tunnel and ths SA are prodiving encap, i.e. it's
538 * MAC | SA-IP | TUN-IP | ESP | PAYLOAD
539 * implying the SA is in tunnel mode (on a tunnel interface)
540 * 2) only the tunnel provides encap
541 * MAC | TUN-IP | ESP | PAYLOAD
542 * implying the SA is in transport mode.
543 *
544 * For 2) we need only strip the tunnel encap and we're good.
545 * since the tunnel and crypto ecnap (int the tun=protect
546 * object) are the same and we verified above that these match
547 * for 1) we need to strip the SA-IP outer headers, to
548 * reveal the tunnel IP and then check that this matches
549 * the configured tunnel.
Neale Rannsc87b66c2019-02-07 07:26:12 -0800550 */
551 const ipsec_tun_protect_t *itp;
552
Neale Ranns568acbb2019-12-18 05:54:40 +0000553 itp = ipsec_tun_protect_get
554 (vnet_buffer (b[0])->ipsec.protect_index);
555
Neale Rannsc87b66c2019-02-07 07:26:12 -0800556 if (PREDICT_TRUE (f->next_header == IP_PROTOCOL_IP_IN_IP))
557 {
558 const ip4_header_t *ip4;
559
560 ip4 = vlib_buffer_get_current (b[0]);
561
562 if (!ip46_address_is_equal_v4 (&itp->itp_tun.src,
563 &ip4->dst_address) ||
564 !ip46_address_is_equal_v4 (&itp->itp_tun.dst,
565 &ip4->src_address))
Neale Ranns12989b52019-09-26 16:20:19 +0000566 {
567 next[0] = ESP_DECRYPT_NEXT_DROP;
568 b[0]->error =
569 node->errors[ESP_DECRYPT_ERROR_TUN_NO_PROTO];
570 }
Neale Rannsc87b66c2019-02-07 07:26:12 -0800571 }
572 else if (f->next_header == IP_PROTOCOL_IPV6)
573 {
574 const ip6_header_t *ip6;
575
576 ip6 = vlib_buffer_get_current (b[0]);
577
578 if (!ip46_address_is_equal_v6 (&itp->itp_tun.src,
579 &ip6->dst_address) ||
580 !ip46_address_is_equal_v6 (&itp->itp_tun.dst,
581 &ip6->src_address))
Neale Ranns12989b52019-09-26 16:20:19 +0000582 {
583 next[0] = ESP_DECRYPT_NEXT_DROP;
584 b[0]->error =
585 node->errors[ESP_DECRYPT_ERROR_TUN_NO_PROTO];
586 }
Neale Rannsc87b66c2019-02-07 07:26:12 -0800587 }
588 }
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100589 }
590 }
591
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100592 trace:
593 if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
594 {
595 esp_decrypt_trace_t *tr;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100596 tr = vlib_add_trace (vm, node, b[0], sizeof (*tr));
597 sa0 = pool_elt_at_index (im->sad,
598 vnet_buffer (b[0])->ipsec.sad_index);
599 tr->crypto_alg = sa0->crypto_alg;
600 tr->integ_alg = sa0->integ_alg;
Neale Ranns6afaae12019-07-17 15:07:14 +0000601 tr->seq = pd->seq;
602 tr->sa_seq = sa0->last_seq;
603 tr->sa_seq_hi = sa0->seq_hi;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100604 }
605
606 /* next */
607 n_left -= 1;
608 next += 1;
609 pd += 1;
610 b += 1;
611 }
612
613 n_left = from_frame->n_vectors;
614 vlib_node_increment_counter (vm, node->node_index,
615 ESP_DECRYPT_ERROR_RX_PKTS, n_left);
616
617 vlib_buffer_enqueue_to_next (vm, node, from, nexts, n_left);
618
619 b = bufs;
620 return n_left;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700621}
622
Klement Sekerab8f35442018-10-29 13:38:19 +0100623VLIB_NODE_FN (esp4_decrypt_node) (vlib_main_t * vm,
624 vlib_node_runtime_t * node,
625 vlib_frame_t * from_frame)
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200626{
Neale Rannsc87b66c2019-02-07 07:26:12 -0800627 return esp_decrypt_inline (vm, node, from_frame, 0, 0);
628}
629
630VLIB_NODE_FN (esp4_decrypt_tun_node) (vlib_main_t * vm,
631 vlib_node_runtime_t * node,
632 vlib_frame_t * from_frame)
633{
634 return esp_decrypt_inline (vm, node, from_frame, 0, 1);
635}
636
637VLIB_NODE_FN (esp6_decrypt_node) (vlib_main_t * vm,
638 vlib_node_runtime_t * node,
639 vlib_frame_t * from_frame)
640{
641 return esp_decrypt_inline (vm, node, from_frame, 1, 0);
642}
643
644VLIB_NODE_FN (esp6_decrypt_tun_node) (vlib_main_t * vm,
645 vlib_node_runtime_t * node,
646 vlib_frame_t * from_frame)
647{
648 return esp_decrypt_inline (vm, node, from_frame, 1, 1);
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200649}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700650
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700651/* *INDENT-OFF* */
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200652VLIB_REGISTER_NODE (esp4_decrypt_node) = {
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200653 .name = "esp4-decrypt",
Ed Warnickecb9cada2015-12-08 15:45:58 -0700654 .vector_size = sizeof (u32),
655 .format_trace = format_esp_decrypt_trace,
656 .type = VLIB_NODE_TYPE_INTERNAL,
657
658 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
659 .error_strings = esp_decrypt_error_strings,
660
661 .n_next_nodes = ESP_DECRYPT_N_NEXT,
662 .next_nodes = {
Neale Rannsf62a8c02019-04-02 08:13:33 +0000663 [ESP_DECRYPT_NEXT_DROP] = "ip4-drop",
664 [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
665 [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
Neale Ranns568acbb2019-12-18 05:54:40 +0000666 [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
Neale Rannsf62a8c02019-04-02 08:13:33 +0000667 [ESP_DECRYPT_NEXT_HANDOFF] = "esp4-decrypt-handoff",
Ed Warnickecb9cada2015-12-08 15:45:58 -0700668 },
669};
670
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200671VLIB_REGISTER_NODE (esp6_decrypt_node) = {
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200672 .name = "esp6-decrypt",
673 .vector_size = sizeof (u32),
674 .format_trace = format_esp_decrypt_trace,
675 .type = VLIB_NODE_TYPE_INTERNAL,
676
677 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
678 .error_strings = esp_decrypt_error_strings,
679
680 .n_next_nodes = ESP_DECRYPT_N_NEXT,
681 .next_nodes = {
Neale Rannsf62a8c02019-04-02 08:13:33 +0000682 [ESP_DECRYPT_NEXT_DROP] = "ip6-drop",
683 [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
684 [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
Neale Ranns568acbb2019-12-18 05:54:40 +0000685 [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
Neale Rannsf62a8c02019-04-02 08:13:33 +0000686 [ESP_DECRYPT_NEXT_HANDOFF]= "esp6-decrypt-handoff",
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200687 },
688};
Neale Rannsc87b66c2019-02-07 07:26:12 -0800689
690VLIB_REGISTER_NODE (esp4_decrypt_tun_node) = {
691 .name = "esp4-decrypt-tun",
692 .vector_size = sizeof (u32),
693 .format_trace = format_esp_decrypt_trace,
694 .type = VLIB_NODE_TYPE_INTERNAL,
Neale Rannsc87b66c2019-02-07 07:26:12 -0800695 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
696 .error_strings = esp_decrypt_error_strings,
Neale Rannsf62a8c02019-04-02 08:13:33 +0000697 .n_next_nodes = ESP_DECRYPT_N_NEXT,
698 .next_nodes = {
699 [ESP_DECRYPT_NEXT_DROP] = "ip4-drop",
700 [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
701 [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
Neale Ranns568acbb2019-12-18 05:54:40 +0000702 [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
Neale Ranns4a56f4e2019-12-23 04:10:25 +0000703 [ESP_DECRYPT_NEXT_HANDOFF] = "esp4-decrypt-tun-handoff",
Neale Rannsf62a8c02019-04-02 08:13:33 +0000704 },
Neale Rannsc87b66c2019-02-07 07:26:12 -0800705};
706
707VLIB_REGISTER_NODE (esp6_decrypt_tun_node) = {
708 .name = "esp6-decrypt-tun",
709 .vector_size = sizeof (u32),
710 .format_trace = format_esp_decrypt_trace,
711 .type = VLIB_NODE_TYPE_INTERNAL,
Neale Rannsc87b66c2019-02-07 07:26:12 -0800712 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
713 .error_strings = esp_decrypt_error_strings,
Neale Rannsf62a8c02019-04-02 08:13:33 +0000714 .n_next_nodes = ESP_DECRYPT_N_NEXT,
715 .next_nodes = {
716 [ESP_DECRYPT_NEXT_DROP] = "ip6-drop",
717 [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
718 [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
Neale Ranns568acbb2019-12-18 05:54:40 +0000719 [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
Neale Ranns4a56f4e2019-12-23 04:10:25 +0000720 [ESP_DECRYPT_NEXT_HANDOFF]= "esp6-decrypt-tun-handoff",
Neale Rannsf62a8c02019-04-02 08:13:33 +0000721 },
Neale Rannsc87b66c2019-02-07 07:26:12 -0800722};
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200723/* *INDENT-ON* */
724
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700725/*
726 * fd.io coding-style-patch-verification: ON
727 *
728 * Local Variables:
729 * eval: (c-set-style "gnu")
730 * End:
731 */