FD.io VPP  v20.01-48-g3e0dafb74
Vector Packet Processing
esp_decrypt.c
Go to the documentation of this file.
1 /*
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 #include <vnet/l2/l2_input.h>
22 
23 #include <vnet/ipsec/ipsec.h>
24 #include <vnet/ipsec/esp.h>
25 #include <vnet/ipsec/ipsec_io.h>
26 #include <vnet/ipsec/ipsec_tun.h>
27 
28 #include <vnet/gre/gre.h>
29 
30 #define foreach_esp_decrypt_next \
31 _(DROP, "error-drop") \
32 _(IP4_INPUT, "ip4-input-no-checksum") \
33 _(IP6_INPUT, "ip6-input") \
34 _(L2_INPUT, "l2-input") \
35 _(HANDOFF, "handoff")
36 
37 #define _(v, s) ESP_DECRYPT_NEXT_##v,
38 typedef enum
39 {
41 #undef _
44 
45 
46 #define foreach_esp_decrypt_error \
47  _(RX_PKTS, "ESP pkts received") \
48  _(DECRYPTION_FAILED, "ESP decryption failed") \
49  _(INTEG_ERROR, "Integrity check failed") \
50  _(CRYPTO_ENGINE_ERROR, "crypto engine error (packet dropped)") \
51  _(REPLAY, "SA replayed packet") \
52  _(RUNT, "undersized packet") \
53  _(CHAINED_BUFFER, "chained buffers (packet dropped)") \
54  _(OVERSIZED_HEADER, "buffer with oversized header (dropped)") \
55  _(NO_TAIL_SPACE, "no enough buffer tail space (dropped)") \
56  _(TUN_NO_PROTO, "no tunnel protocol") \
57  _(UNSUP_PAYLOAD, "unsupported payload") \
58 
59 
60 typedef enum
61 {
62 #define _(sym,str) ESP_DECRYPT_ERROR_##sym,
64 #undef _
67 
68 static char *esp_decrypt_error_strings[] = {
69 #define _(sym,string) string,
71 #undef _
72 };
73 
74 typedef struct
75 {
79  ipsec_crypto_alg_t crypto_alg;
80  ipsec_integ_alg_t integ_alg;
82 
83 /* packet trace format function */
84 static u8 *
85 format_esp_decrypt_trace (u8 * s, va_list * args)
86 {
87  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
88  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
89  esp_decrypt_trace_t *t = va_arg (*args, esp_decrypt_trace_t *);
90 
91  s =
92  format (s,
93  "esp: crypto %U integrity %U pkt-seq %d sa-seq %u sa-seq-hi %u",
95  t->integ_alg, t->seq, t->sa_seq, t->sa_seq_hi);
96  return s;
97 }
98 
99 typedef struct
100 {
101  union
102  {
103  struct
104  {
109  };
111  };
112 
118 
120 
121 #define ESP_ENCRYPT_PD_F_FD_TRANSPORT (1 << 2)
122 
125  vlib_node_runtime_t * node, vlib_frame_t * from_frame,
126  int is_ip6, int is_tun)
127 {
128  ipsec_main_t *im = &ipsec_main;
129  u32 thread_index = vm->thread_index;
130  u16 buffer_data_size = vlib_buffer_get_default_data_size (vm);
131  u16 len;
132  ipsec_per_thread_data_t *ptd = vec_elt_at_index (im->ptd, thread_index);
133  u32 *from = vlib_frame_vector_args (from_frame);
134  u32 n, n_left = from_frame->n_vectors;
135  vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
136  u16 nexts[VLIB_FRAME_SIZE], *next = nexts;
137  esp_decrypt_packet_data_t pkt_data[VLIB_FRAME_SIZE], *pd = pkt_data;
138  esp_decrypt_packet_data_t cpd = { };
139  u32 current_sa_index = ~0, current_sa_bytes = 0, current_sa_pkts = 0;
140  const u8 esp_sz = sizeof (esp_header_t);
141  ipsec_sa_t *sa0 = 0;
142 
143  vlib_get_buffers (vm, from, b, n_left);
146  clib_memset_u16 (nexts, -1, n_left);
147 
148  while (n_left > 0)
149  {
150  u8 *payload;
151 
152  if (n_left > 2)
153  {
154  u8 *p;
155  vlib_prefetch_buffer_header (b[2], LOAD);
156  p = vlib_buffer_get_current (b[1]);
160  }
161 
162  if (vlib_buffer_chain_linearize (vm, b[0]) != 1)
163  {
164  b[0]->error = node->errors[ESP_DECRYPT_ERROR_CHAINED_BUFFER];
165  next[0] = ESP_DECRYPT_NEXT_DROP;
166  goto next;
167  }
168 
169  if (vnet_buffer (b[0])->ipsec.sad_index != current_sa_index)
170  {
171  if (current_sa_pkts)
173  current_sa_index,
174  current_sa_pkts,
175  current_sa_bytes);
176  current_sa_bytes = current_sa_pkts = 0;
177 
178  current_sa_index = vnet_buffer (b[0])->ipsec.sad_index;
179  sa0 = pool_elt_at_index (im->sad, current_sa_index);
180  cpd.icv_sz = sa0->integ_icv_size;
181  cpd.iv_sz = sa0->crypto_iv_size;
182  cpd.flags = sa0->flags;
183  cpd.sa_index = current_sa_index;
184  }
185 
186  if (PREDICT_FALSE (~0 == sa0->decrypt_thread_index))
187  {
188  /* this is the first packet to use this SA, claim the SA
189  * for this thread. this could happen simultaneously on
190  * another thread */
192  ipsec_sa_assign_thread (thread_index));
193  }
194 
195  if (PREDICT_TRUE (thread_index != sa0->decrypt_thread_index))
196  {
197  next[0] = ESP_DECRYPT_NEXT_HANDOFF;
198  goto next;
199  }
200 
201  /* store packet data for next round for easier prefetch */
202  pd->sa_data = cpd.sa_data;
203  pd->current_data = b[0]->current_data;
204  pd->current_length = b[0]->current_length;
205  pd->hdr_sz = pd->current_data - vnet_buffer (b[0])->l3_hdr_offset;
206  payload = b[0]->data + pd->current_data;
207  pd->seq = clib_host_to_net_u32 (((esp_header_t *) payload)->seq);
208 
209  /* we need 4 extra bytes for HMAC calculation when ESN are used */
210  if (ipsec_sa_is_set_USE_ESN (sa0) && pd->icv_sz &&
211  (pd->current_data + pd->current_length + 4 > buffer_data_size))
212  {
213  b[0]->error = node->errors[ESP_DECRYPT_ERROR_NO_TAIL_SPACE];
214  next[0] = ESP_DECRYPT_NEXT_DROP;
215  goto next;
216  }
217 
218  /* anti-reply check */
219  if (ipsec_sa_anti_replay_check (sa0, pd->seq))
220  {
221  b[0]->error = node->errors[ESP_DECRYPT_ERROR_REPLAY];
222  next[0] = ESP_DECRYPT_NEXT_DROP;
223  goto next;
224  }
225 
226  if (pd->current_length < cpd.icv_sz + esp_sz + cpd.iv_sz)
227  {
228  b[0]->error = node->errors[ESP_DECRYPT_ERROR_RUNT];
229  next[0] = ESP_DECRYPT_NEXT_DROP;
230  goto next;
231  }
232 
233  len = pd->current_length - cpd.icv_sz;
234  current_sa_pkts += 1;
235  current_sa_bytes += pd->current_length;
236 
238  {
239  vnet_crypto_op_t *op;
241 
242  vnet_crypto_op_init (op, sa0->integ_op_id);
243  op->key_index = sa0->integ_key_index;
244  op->src = payload;
246  op->user_data = b - bufs;
247  op->digest = payload + len;
248  op->digest_len = cpd.icv_sz;
249  op->len = len;
250  if (ipsec_sa_is_set_USE_ESN (sa0))
251  {
252  /* shift ICV by 4 bytes to insert ESN */
253  u32 seq_hi = clib_host_to_net_u32 (sa0->seq_hi);
254  u8 tmp[ESP_MAX_ICV_SIZE], sz = sizeof (sa0->seq_hi);
255  clib_memcpy_fast (tmp, payload + len, ESP_MAX_ICV_SIZE);
256  clib_memcpy_fast (payload + len, &seq_hi, sz);
257  clib_memcpy_fast (payload + len + sz, tmp, ESP_MAX_ICV_SIZE);
258  op->len += sz;
259  op->digest += sz;
260  }
261  }
262 
263  payload += esp_sz;
264  len -= esp_sz;
265 
267  {
268  vnet_crypto_op_t *op;
271  op->key_index = sa0->crypto_key_index;
272  op->iv = payload;
273 
274  if (ipsec_sa_is_set_IS_AEAD (sa0))
275  {
276  esp_header_t *esp0;
277  esp_aead_t *aad;
278  u8 *scratch;
279 
280  /*
281  * construct the AAD and the nonce (Salt || IV) in a scratch
282  * space in front of the IP header.
283  */
284  scratch = payload - esp_sz;
285  esp0 = (esp_header_t *) (scratch);
286 
287  scratch -= (sizeof (*aad) + pd->hdr_sz);
288  op->aad = scratch;
289 
290  esp_aad_fill (op, esp0, sa0);
291 
292  /*
293  * we don't need to refer to the ESP header anymore so we
294  * can overwrite it with the salt and use the IV where it is
295  * to form the nonce = (Salt + IV)
296  */
297  op->iv -= sizeof (sa0->salt);
298  clib_memcpy_fast (op->iv, &sa0->salt, sizeof (sa0->salt));
299 
300  op->tag = payload + len;
301  op->tag_len = 16;
302  }
303  op->src = op->dst = payload += cpd.iv_sz;
304  op->len = len - cpd.iv_sz;
305  op->user_data = b - bufs;
306  }
307 
308  /* next */
309  next:
310  n_left -= 1;
311  next += 1;
312  pd += 1;
313  b += 1;
314  }
315 
316  if (PREDICT_TRUE (~0 != current_sa_index))
318  current_sa_index, current_sa_pkts,
319  current_sa_bytes);
320 
321  if ((n = vec_len (ptd->integ_ops)))
322  {
323  vnet_crypto_op_t *op = ptd->integ_ops;
324  n -= vnet_crypto_process_ops (vm, op, n);
325  while (n)
326  {
327  ASSERT (op - ptd->integ_ops < vec_len (ptd->integ_ops));
328  if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
329  {
330  u32 err, bi = op->user_data;
331  if (op->status == VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC)
332  err = ESP_DECRYPT_ERROR_INTEG_ERROR;
333  else
334  err = ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR;
335  bufs[bi]->error = node->errors[err];
336  nexts[bi] = ESP_DECRYPT_NEXT_DROP;
337  n--;
338  }
339  op++;
340  }
341  }
342  if ((n = vec_len (ptd->crypto_ops)))
343  {
344  vnet_crypto_op_t *op = ptd->crypto_ops;
345  n -= vnet_crypto_process_ops (vm, op, n);
346  while (n)
347  {
348  ASSERT (op - ptd->crypto_ops < vec_len (ptd->crypto_ops));
349  if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
350  {
351  u32 err, bi;
352 
353  bi = op->user_data;
354 
355  if (op->status == VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC)
356  err = ESP_DECRYPT_ERROR_DECRYPTION_FAILED;
357  else
358  err = ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR;
359 
360  bufs[bi]->error = node->errors[err];
361  nexts[bi] = ESP_DECRYPT_NEXT_DROP;
362  n--;
363  }
364  op++;
365  }
366  }
367 
368  /* Post decryption ronud - adjust packet data start and length and next
369  node */
370 
371  n_left = from_frame->n_vectors;
372  next = nexts;
373  pd = pkt_data;
374  b = bufs;
375 
376  while (n_left)
377  {
378  const u8 tun_flags = IPSEC_SA_FLAG_IS_TUNNEL |
379  IPSEC_SA_FLAG_IS_TUNNEL_V6;
380 
381  if (n_left >= 2)
382  {
383  void *data = b[1]->data + pd[1].current_data;
384 
385  /* buffer metadata */
386  vlib_prefetch_buffer_header (b[1], LOAD);
387 
388  /* esp_footer_t */
389  CLIB_PREFETCH (data + pd[1].current_length - pd[1].icv_sz - 2,
390  CLIB_CACHE_LINE_BYTES, LOAD);
391 
392  /* packet headers */
394  CLIB_CACHE_LINE_BYTES * 2, LOAD);
395  }
396 
397  if (next[0] < ESP_DECRYPT_N_NEXT)
398  goto trace;
399 
400  sa0 = vec_elt_at_index (im->sad, pd->sa_index);
401 
402  /*
403  * redo the anti-reply check
404  * in this frame say we have sequence numbers, s, s+1, s+1, s+1
405  * and s and s+1 are in the window. When we did the anti-replay
406  * check above we did so against the state of the window (W),
407  * after packet s-1. So each of the packets in the sequence will be
408  * accepted.
409  * This time s will be cheked against Ws-1, s+1 chceked against Ws
410  * (i.e. the window state is updated/advnaced)
411  * so this time the successive s+! packet will be dropped.
412  * This is a consequence of batching the decrypts. If the
413  * check-dcrypt-advance process was done for each packet it would
414  * be fine. But we batch the decrypts because it's much more efficient
415  * to do so in SW and if we offload to HW and the process is async.
416  *
417  * You're probably thinking, but this means an attacker can send the
418  * above sequence and cause VPP to perform decrpyts that will fail,
419  * and that's true. But if the attacker can determine s (a valid
420  * sequence number in the window) which is non-trivial, it can generate
421  * a sequence s, s+1, s+2, s+3, ... s+n and nothing will prevent any
422  * implementation, sequential or batching, from decrypting these.
423  */
424  if (ipsec_sa_anti_replay_check (sa0, pd->seq))
425  {
426  b[0]->error = node->errors[ESP_DECRYPT_ERROR_REPLAY];
427  next[0] = ESP_DECRYPT_NEXT_DROP;
428  goto trace;
429  }
430 
432 
433  esp_footer_t *f = (esp_footer_t *) (b[0]->data + pd->current_data +
434  pd->current_length - sizeof (*f) -
435  pd->icv_sz);
436  u16 adv = pd->iv_sz + esp_sz;
437  u16 tail = sizeof (esp_footer_t) + f->pad_length + pd->icv_sz;
438 
439  if ((pd->flags & tun_flags) == 0 && !is_tun) /* transport mode */
440  {
441  u8 udp_sz = (is_ip6 == 0 && pd->flags & IPSEC_SA_FLAG_UDP_ENCAP) ?
442  sizeof (udp_header_t) : 0;
443  u16 ip_hdr_sz = pd->hdr_sz - udp_sz;
444  u8 *old_ip = b[0]->data + pd->current_data - ip_hdr_sz - udp_sz;
445  u8 *ip = old_ip + adv + udp_sz;
446 
447  if (is_ip6 && ip_hdr_sz > 64)
448  memmove (ip, old_ip, ip_hdr_sz);
449  else
450  clib_memcpy_le64 (ip, old_ip, ip_hdr_sz);
451 
452  b[0]->current_data = pd->current_data + adv - ip_hdr_sz;
453  b[0]->current_length = pd->current_length + ip_hdr_sz - tail - adv;
454 
455  if (is_ip6)
456  {
457  ip6_header_t *ip6 = (ip6_header_t *) ip;
458  u16 len = clib_net_to_host_u16 (ip6->payload_length);
459  len -= adv + tail;
460  ip6->payload_length = clib_host_to_net_u16 (len);
461  ip6->protocol = f->next_header;
462  next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
463  }
464  else
465  {
466  ip4_header_t *ip4 = (ip4_header_t *) ip;
467  ip_csum_t sum = ip4->checksum;
468  u16 len = clib_net_to_host_u16 (ip4->length);
469  len = clib_host_to_net_u16 (len - adv - tail - udp_sz);
470  sum = ip_csum_update (sum, ip4->protocol, f->next_header,
472  sum = ip_csum_update (sum, ip4->length, len,
473  ip4_header_t, length);
474  ip4->checksum = ip_csum_fold (sum);
475  ip4->protocol = f->next_header;
476  ip4->length = len;
477  next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
478  }
479  }
480  else
481  {
482  if (PREDICT_TRUE (f->next_header == IP_PROTOCOL_IP_IN_IP))
483  {
484  next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
485  b[0]->current_data = pd->current_data + adv;
486  b[0]->current_length = pd->current_length - adv - tail;
487  }
488  else if (f->next_header == IP_PROTOCOL_IPV6)
489  {
490  next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
491  b[0]->current_data = pd->current_data + adv;
492  b[0]->current_length = pd->current_length - adv - tail;
493  }
494  else
495  {
496  if (is_tun && f->next_header == IP_PROTOCOL_GRE)
497  {
498  gre_header_t *gre;
499 
500  b[0]->current_data = pd->current_data + adv;
501  b[0]->current_length = pd->current_length - adv - tail;
502 
503  gre = vlib_buffer_get_current (b[0]);
504 
505  vlib_buffer_advance (b[0], sizeof (*gre));
506 
507  switch (clib_net_to_host_u16 (gre->protocol))
508  {
509  case GRE_PROTOCOL_teb:
510  vnet_update_l2_len (b[0]);
511  next[0] = ESP_DECRYPT_NEXT_L2_INPUT;
512  break;
513  case GRE_PROTOCOL_ip4:
514  next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
515  break;
516  case GRE_PROTOCOL_ip6:
517  next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
518  break;
519  default:
520  b[0]->error =
521  node->errors[ESP_DECRYPT_ERROR_UNSUP_PAYLOAD];
522  next[0] = ESP_DECRYPT_NEXT_DROP;
523  break;
524  }
525  }
526  else
527  {
528  next[0] = ESP_DECRYPT_NEXT_DROP;
529  b[0]->error = node->errors[ESP_DECRYPT_ERROR_UNSUP_PAYLOAD];
530  goto trace;
531  }
532  }
533  if (is_tun)
534  {
535  if (ipsec_sa_is_set_IS_PROTECT (sa0))
536  {
537  /*
538  * There are two encap possibilities
539  * 1) the tunnel and ths SA are prodiving encap, i.e. it's
540  * MAC | SA-IP | TUN-IP | ESP | PAYLOAD
541  * implying the SA is in tunnel mode (on a tunnel interface)
542  * 2) only the tunnel provides encap
543  * MAC | TUN-IP | ESP | PAYLOAD
544  * implying the SA is in transport mode.
545  *
546  * For 2) we need only strip the tunnel encap and we're good.
547  * since the tunnel and crypto ecnap (int the tun=protect
548  * object) are the same and we verified above that these match
549  * for 1) we need to strip the SA-IP outer headers, to
550  * reveal the tunnel IP and then check that this matches
551  * the configured tunnel.
552  */
553  const ipsec_tun_protect_t *itp;
554 
556  (vnet_buffer (b[0])->ipsec.protect_index);
557 
558  if (PREDICT_TRUE (f->next_header == IP_PROTOCOL_IP_IN_IP))
559  {
560  const ip4_header_t *ip4;
561 
562  ip4 = vlib_buffer_get_current (b[0]);
563 
565  &ip4->dst_address) ||
567  &ip4->src_address))
568  {
569  next[0] = ESP_DECRYPT_NEXT_DROP;
570  b[0]->error =
571  node->errors[ESP_DECRYPT_ERROR_TUN_NO_PROTO];
572  }
573  }
574  else if (f->next_header == IP_PROTOCOL_IPV6)
575  {
576  const ip6_header_t *ip6;
577 
578  ip6 = vlib_buffer_get_current (b[0]);
579 
581  &ip6->dst_address) ||
583  &ip6->src_address))
584  {
585  next[0] = ESP_DECRYPT_NEXT_DROP;
586  b[0]->error =
587  node->errors[ESP_DECRYPT_ERROR_TUN_NO_PROTO];
588  }
589  }
590  }
591  }
592  }
593 
594  trace:
595  if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
596  {
598  tr = vlib_add_trace (vm, node, b[0], sizeof (*tr));
599  sa0 = pool_elt_at_index (im->sad,
600  vnet_buffer (b[0])->ipsec.sad_index);
601  tr->crypto_alg = sa0->crypto_alg;
602  tr->integ_alg = sa0->integ_alg;
603  tr->seq = pd->seq;
604  tr->sa_seq = sa0->last_seq;
605  tr->sa_seq_hi = sa0->seq_hi;
606  }
607 
608  /* next */
609  n_left -= 1;
610  next += 1;
611  pd += 1;
612  b += 1;
613  }
614 
615  n_left = from_frame->n_vectors;
617  ESP_DECRYPT_ERROR_RX_PKTS, n_left);
618 
619  vlib_buffer_enqueue_to_next (vm, node, from, nexts, n_left);
620 
621  b = bufs;
622  return n_left;
623 }
624 
625 VLIB_NODE_FN (esp4_decrypt_node) (vlib_main_t * vm,
627  vlib_frame_t * from_frame)
628 {
629  return esp_decrypt_inline (vm, node, from_frame, 0, 0);
630 }
631 
632 VLIB_NODE_FN (esp4_decrypt_tun_node) (vlib_main_t * vm,
634  vlib_frame_t * from_frame)
635 {
636  return esp_decrypt_inline (vm, node, from_frame, 0, 1);
637 }
638 
639 VLIB_NODE_FN (esp6_decrypt_node) (vlib_main_t * vm,
641  vlib_frame_t * from_frame)
642 {
643  return esp_decrypt_inline (vm, node, from_frame, 1, 0);
644 }
645 
646 VLIB_NODE_FN (esp6_decrypt_tun_node) (vlib_main_t * vm,
648  vlib_frame_t * from_frame)
649 {
650  return esp_decrypt_inline (vm, node, from_frame, 1, 1);
651 }
652 
653 /* *INDENT-OFF* */
654 VLIB_REGISTER_NODE (esp4_decrypt_node) = {
655  .name = "esp4-decrypt",
656  .vector_size = sizeof (u32),
657  .format_trace = format_esp_decrypt_trace,
659 
660  .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
661  .error_strings = esp_decrypt_error_strings,
662 
663  .n_next_nodes = ESP_DECRYPT_N_NEXT,
664  .next_nodes = {
665  [ESP_DECRYPT_NEXT_DROP] = "ip4-drop",
666  [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
667  [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
668  [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
669  [ESP_DECRYPT_NEXT_HANDOFF] = "esp4-decrypt-handoff",
670  },
671 };
672 
673 VLIB_REGISTER_NODE (esp6_decrypt_node) = {
674  .name = "esp6-decrypt",
675  .vector_size = sizeof (u32),
676  .format_trace = format_esp_decrypt_trace,
678 
679  .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
680  .error_strings = esp_decrypt_error_strings,
681 
682  .n_next_nodes = ESP_DECRYPT_N_NEXT,
683  .next_nodes = {
684  [ESP_DECRYPT_NEXT_DROP] = "ip6-drop",
685  [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
686  [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
687  [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
688  [ESP_DECRYPT_NEXT_HANDOFF]= "esp6-decrypt-handoff",
689  },
690 };
691 
692 VLIB_REGISTER_NODE (esp4_decrypt_tun_node) = {
693  .name = "esp4-decrypt-tun",
694  .vector_size = sizeof (u32),
695  .format_trace = format_esp_decrypt_trace,
697  .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
698  .error_strings = esp_decrypt_error_strings,
699  .n_next_nodes = ESP_DECRYPT_N_NEXT,
700  .next_nodes = {
701  [ESP_DECRYPT_NEXT_DROP] = "ip4-drop",
702  [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
703  [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
704  [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
705  [ESP_DECRYPT_NEXT_HANDOFF] = "esp4-decrypt-tun-handoff",
706  },
707 };
708 
709 VLIB_REGISTER_NODE (esp6_decrypt_tun_node) = {
710  .name = "esp6-decrypt-tun",
711  .vector_size = sizeof (u32),
712  .format_trace = format_esp_decrypt_trace,
714  .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
715  .error_strings = esp_decrypt_error_strings,
716  .n_next_nodes = ESP_DECRYPT_N_NEXT,
717  .next_nodes = {
718  [ESP_DECRYPT_NEXT_DROP] = "ip6-drop",
719  [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
720  [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
721  [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
722  [ESP_DECRYPT_NEXT_HANDOFF]= "esp6-decrypt-tun-handoff",
723  },
724 };
725 /* *INDENT-ON* */
726 
727 /*
728  * fd.io coding-style-patch-verification: ON
729  *
730  * Local Variables:
731  * eval: (c-set-style "gnu")
732  * End:
733  */
u32 vnet_crypto_process_ops(vlib_main_t *vm, vnet_crypto_op_t ops[], u32 n_ops)
Definition: crypto.c:46
u8 * format_ipsec_integ_alg(u8 *s, va_list *args)
Definition: ipsec_format.c:110
static vlib_cli_command_t trace
(constructor) VLIB_CLI_COMMAND (trace)
Definition: vlib_api_cli.c:898
static u8 * format_esp_decrypt_trace(u8 *s, va_list *args)
Definition: esp_decrypt.c:85
#define CLIB_UNUSED(x)
Definition: clib.h:82
ipsec_per_thread_data_t * ptd
Definition: ipsec.h:177
vnet_crypto_op_t * integ_ops
Definition: ipsec.h:94
static char * esp_decrypt_error_strings[]
Definition: esp_decrypt.c:68
static void vlib_increment_combined_counter(vlib_combined_counter_main_t *cm, u32 thread_index, u32 index, u64 n_packets, u64 n_bytes)
Increment a combined counter.
Definition: counter.h:220
ip4_address_t src_address
Definition: ip4_packet.h:170
#define PREDICT_TRUE(x)
Definition: clib.h:112
ipsec_integ_alg_t
Definition: ipsec_sa.h:58
i16 current_data
signed offset in data[], pre_data[] that we are currently processing.
Definition: buffer.h:110
unsigned long u64
Definition: types.h:89
#define clib_memcpy_fast(a, b, c)
Definition: string.h:81
static u32 ipsec_sa_assign_thread(u32 thread_id)
Definition: ipsec_sa.h:447
#define vec_add2_aligned(V, P, N, A)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:573
ipsec_integ_alg_t integ_alg
Definition: ipsec_sa.h:152
u32 thread_index
Definition: main.h:218
u16 current_length
Nbytes between current data and the end of this buffer.
Definition: buffer.h:113
vnet_crypto_op_t * crypto_ops
Definition: ipsec.h:93
u8 data[0]
Packet data.
Definition: buffer.h:181
ipsec_crypto_alg_t crypto_alg
Definition: esp_decrypt.c:73
AES GCM Additional Authentication data.
Definition: esp.h:64
uword ip_csum_t
Definition: ip_packet.h:244
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
#define VLIB_NODE_FN(node)
Definition: node.h:202
vlib_error_t * errors
Vector of errors for this node.
Definition: node.h:470
vnet_crypto_op_id_t integ_op_id
Definition: ipsec_sa.h:131
static_always_inline int ip46_address_is_equal_v6(const ip46_address_t *ip46, const ip6_address_t *ip6)
Definition: ip46_address.h:115
ip6_address_t src_address
Definition: ip6_packet.h:307
unsigned char u8
Definition: types.h:56
#define vec_reset_length(v)
Reset vector length to zero NULL-pointer tolerant.
u32 seq_hi
Definition: ipsec_sa.h:121
vnet_crypto_key_index_t crypto_key_index
Definition: ipsec_sa.h:127
vl_api_ip_proto_t protocol
Definition: lb_types.api:71
ip46_address_t src
Definition: ipsec_tun.h:58
ipsec_main_t ipsec_main
Definition: ipsec.c:28
esp_decrypt_next_t
Definition: esp_decrypt.c:35
ip4_address_t dst_address
Definition: ip4_packet.h:170
#define vlib_prefetch_buffer_header(b, type)
Prefetch buffer metadata.
Definition: buffer.h:203
static_always_inline void vnet_crypto_op_init(vnet_crypto_op_t *op, vnet_crypto_op_id_t type)
Definition: crypto.h:221
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
ipsec_ep_t itp_tun
Definition: ipsec_tun.h:78
u8 * format_ipsec_crypto_alg(u8 *s, va_list *args)
Definition: ipsec_format.c:78
unsigned int u32
Definition: types.h:88
esp_decrypt_error_t
Definition: esp_decrypt.c:54
#define foreach_esp_decrypt_error
Definition: esp_decrypt.c:46
ipsec_sa_flags_t flags
Definition: ipsec_sa.h:112
#define VLIB_FRAME_SIZE
Definition: node.h:378
bool is_ip6
Definition: ip.api:43
vl_api_fib_path_type_t type
Definition: fib_types.api:123
vlib_error_t error
Error code for buffers to be enqueued to error handler.
Definition: buffer.h:136
u32 last_seq
Definition: ipsec_sa.h:122
static u32 vlib_buffer_chain_linearize(vlib_main_t *vm, vlib_buffer_t *b)
#define ESP_MAX_ICV_SIZE
Definition: esp.h:78
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:519
static void esp_aad_fill(vnet_crypto_op_t *op, const esp_header_t *esp, const ipsec_sa_t *sa)
Definition: esp.h:138
uword user_data
Definition: crypto.h:143
u32 salt
Definition: ipsec_sa.h:165
static void ipsec_sa_anti_replay_advance(ipsec_sa_t *sa, u32 seq)
Definition: ipsec_sa.h:382
unsigned short u16
Definition: types.h:57
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:229
#define PREDICT_FALSE(x)
Definition: clib.h:111
#define always_inline
Definition: ipsec.h:28
u32 node_index
Node index.
Definition: node.h:496
vlib_main_t * vm
Definition: in2out_ed.c:1810
#define VNET_CRYPTO_OP_FLAG_HMAC_CHECK
Definition: crypto.h:132
STATIC_ASSERT_SIZEOF(esp_decrypt_packet_data_t, 3 *sizeof(u64))
static void vlib_node_increment_counter(vlib_main_t *vm, u32 node_index, u32 counter_index, u64 increment)
Definition: node_funcs.h:1150
u8 len
Definition: ip_types.api:91
static_always_inline u32 vlib_buffer_get_default_data_size(vlib_main_t *vm)
Definition: buffer_funcs.h:96
u8 ip6[16]
Definition: one.api:477
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:169
u32 flags
Definition: vhost_user.h:141
u16 n_vectors
Definition: node.h:397
static uword esp_decrypt_inline(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *from_frame, int is_ip6, int is_tun)
Definition: esp_decrypt.c:124
#define CLIB_PREFETCH(addr, size, type)
Definition: cache.h:80
static_always_inline void vlib_buffer_enqueue_to_next(vlib_main_t *vm, vlib_node_runtime_t *node, u32 *buffers, u16 *nexts, uword count)
Definition: buffer_node.h:332
u16 protocol
Definition: packet.h:55
enum ipsec_sad_flags_t_ ipsec_sa_flags_t
#define ARRAY_LEN(x)
Definition: clib.h:62
vlib_main_t vlib_node_runtime_t * node
Definition: in2out_ed.c:1810
#define clib_atomic_cmp_and_swap(addr, old, new)
Definition: atomics.h:37
ip46_address_t dst
Definition: ipsec_tun.h:59
vlib_combined_counter_main_t ipsec_sa_counters
SA packet & bytes counters.
Definition: ipsec_sa.c:27
#define ASSERT(truth)
u8 data[128]
Definition: ipsec_types.api:87
ipsec_sa_t * sad
Definition: ipsec.h:102
static ipsec_tun_protect_t * ipsec_tun_protect_get(u32 index)
Definition: ipsec_tun.h:138
ipsec_sa_flags_t flags
Definition: esp_decrypt.c:107
static int ipsec_sa_anti_replay_check(ipsec_sa_t *sa, u32 seq)
Definition: ipsec_sa.h:255
static void vlib_buffer_advance(vlib_buffer_t *b, word l)
Advance current data pointer by the supplied (signed!) amount.
Definition: buffer.h:248
vnet_crypto_key_index_t integ_key_index
Definition: ipsec_sa.h:128
static void * vlib_add_trace(vlib_main_t *vm, vlib_node_runtime_t *r, vlib_buffer_t *b, u32 n_data_bytes)
Definition: trace_funcs.h:55
static_always_inline void clib_memset_u16(void *p, u16 val, uword count)
Definition: string.h:378
static_always_inline void clib_memcpy_le64(u8 *dst, u8 *src, u8 len)
Definition: string.h:283
u16 payload_length
Definition: ip6_packet.h:298
vl_api_address_t ip
Definition: l2.api:490
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
static void vnet_update_l2_len(vlib_buffer_t *b)
Definition: l2_input.h:236
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:244
ipsec_crypto_alg_t
Definition: ipsec_sa.h:36
#define ip_csum_update(sum, old, new, type, field)
Definition: ip_packet.h:294
vnet_crypto_op_id_t crypto_enc_op_id
Definition: ipsec_sa.h:129
static_always_inline int ip46_address_is_equal_v4(const ip46_address_t *ip46, const ip4_address_t *ip4)
Definition: ip46_address.h:108
vnet_crypto_op_status_t status
Definition: crypto.h:129
#define vnet_buffer(b)
Definition: buffer.h:408
#define foreach_esp_decrypt_next
Definition: esp_decrypt.c:30
ipsec_crypto_alg_t crypto_alg
Definition: ipsec_sa.h:148
u32 ip4
Definition: one.api:440
static_always_inline void vlib_get_buffers(vlib_main_t *vm, u32 *bi, vlib_buffer_t **b, int count)
Translate array of buffer indices into buffer pointers.
Definition: buffer_funcs.h:244
u8 crypto_iv_size
Definition: ipsec_sa.h:114
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
vnet_crypto_op_id_t crypto_dec_op_id
Definition: ipsec_sa.h:130
u8 integ_icv_size
Definition: ipsec_sa.h:116
u32 decrypt_thread_index
Definition: ipsec_sa.h:118
static u16 ip_csum_fold(ip_csum_t c)
Definition: ip_packet.h:300
ipsec_integ_alg_t integ_alg
Definition: esp_decrypt.c:74
ip6_address_t dst_address
Definition: ip6_packet.h:307
signed short i16
Definition: types.h:46