2 * esp_encrypt.c : IPSec ESP encrypt node
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:
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #include <vnet/vnet.h>
19 #include <vnet/api_errno.h>
20 #include <vnet/ip/ip.h>
21 #include <vnet/udp/udp.h>
23 #include <vnet/crypto/crypto.h>
25 #include <vnet/ipsec/ipsec.h>
26 #include <vnet/ipsec/esp.h>
28 #define foreach_esp_encrypt_next \
29 _(DROP, "error-drop") \
30 _(IP4_LOOKUP, "ip4-lookup") \
31 _(IP6_LOOKUP, "ip6-lookup") \
32 _(INTERFACE_OUTPUT, "interface-output")
34 #define _(v, s) ESP_ENCRYPT_NEXT_##v,
37 foreach_esp_encrypt_next
42 #define foreach_esp_encrypt_error \
43 _(RX_PKTS, "ESP pkts received") \
44 _(SEQ_CYCLED, "sequence number cycled (packet dropped)") \
45 _(CRYPTO_ENGINE_ERROR, "crypto engine error (packet dropped)") \
46 _(CHAINED_BUFFER, "chained buffers (packet dropped)") \
47 _(NO_TRAILER_SPACE, "no trailer space (packet dropped)")
51 #define _(sym,str) ESP_ENCRYPT_ERROR_##sym,
52 foreach_esp_encrypt_error
55 } esp_encrypt_error_t;
57 static char *esp_encrypt_error_strings[] = {
58 #define _(sym,string) string,
59 foreach_esp_encrypt_error
69 ipsec_crypto_alg_t crypto_alg;
70 ipsec_integ_alg_t integ_alg;
71 } esp_encrypt_trace_t;
73 /* packet trace format function */
75 format_esp_encrypt_trace (u8 * s, va_list * args)
77 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
78 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
79 esp_encrypt_trace_t *t = va_arg (*args, esp_encrypt_trace_t *);
81 s = format (s, "esp: sa-index %d spi %u seq %u crypto %U integrity %U%s",
82 t->sa_index, t->spi, t->seq,
83 format_ipsec_crypto_alg, t->crypto_alg,
84 format_ipsec_integ_alg, t->integ_alg,
85 t->udp_encap ? " udp-encap-enabled" : "");
89 /* pad packet in input buffer */
90 static_always_inline u8 *
91 esp_add_footer_and_icv (vlib_buffer_t * b, u8 block_size, u8 icv_sz)
93 static const u8 pad_data[ESP_MAX_BLOCK_SIZE] = {
94 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08,
95 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x00, 0x00,
98 u16 min_length = b->current_length + sizeof (esp_footer_t);
99 u16 new_length = round_pow2 (min_length, block_size);
100 u8 pad_bytes = new_length - min_length;
101 esp_footer_t *f = (esp_footer_t *) (vlib_buffer_get_current (b) +
102 new_length - sizeof (esp_footer_t));
105 clib_memcpy_fast ((u8 *) f - pad_bytes, pad_data, ESP_MAX_BLOCK_SIZE);
107 f->pad_length = pad_bytes;
108 b->current_length = new_length + icv_sz;
109 return &f->next_header;
112 static_always_inline void
113 esp_update_ip4_hdr (ip4_header_t * ip4, u16 len, int is_transport, int is_udp)
118 len = clib_net_to_host_u16 (len);
119 old_len = ip4->length;
123 u8 prot = is_udp ? IP_PROTOCOL_UDP : IP_PROTOCOL_IPSEC_ESP;
125 sum = ip_csum_update (ip4->checksum, ip4->protocol,
126 prot, ip4_header_t, protocol);
127 ip4->protocol = prot;
129 sum = ip_csum_update (sum, old_len, len, ip4_header_t, length);
132 sum = ip_csum_update (ip4->checksum, old_len, len, ip4_header_t, length);
135 ip4->checksum = ip_csum_fold (sum);
138 static_always_inline void
139 esp_fill_udp_hdr (ipsec_sa_t * sa, udp_header_t * udp, u16 len)
141 clib_memcpy_fast (udp, &sa->udp_hdr, sizeof (udp_header_t));
142 udp->length = clib_net_to_host_u16 (len);
145 static_always_inline u8
146 ext_hdr_is_pre_esp (u8 nexthdr)
148 #ifdef CLIB_HAVE_VEC128
149 static const u8x16 ext_hdr_types = {
150 IP_PROTOCOL_IP6_HOP_BY_HOP_OPTIONS,
151 IP_PROTOCOL_IPV6_ROUTE,
152 IP_PROTOCOL_IPV6_FRAGMENTATION,
155 return !u8x16_is_all_zero (ext_hdr_types == u8x16_splat (nexthdr));
157 return ((nexthdr ^ IP_PROTOCOL_IP6_HOP_BY_HOP_OPTIONS) |
158 (nexthdr ^ IP_PROTOCOL_IPV6_ROUTE) |
159 (nexthdr ^ IP_PROTOCOL_IPV6_FRAGMENTATION) != 0);
163 static_always_inline u8
164 esp_get_ip6_hdr_len (ip6_header_t * ip6)
166 /* this code assumes that HbH, route and frag headers will be before
167 others, if that is not the case, they will end up encrypted */
169 u8 len = sizeof (ip6_header_t);
172 /* if next packet doesn't have ext header */
173 if (ext_hdr_is_pre_esp (ip6->protocol) == 0)
176 p = (void *) (ip6 + 1);
177 len += ip6_ext_header_len (p);
179 while (ext_hdr_is_pre_esp (p->next_hdr))
181 len += ip6_ext_header_len (p);
182 p = ip6_ext_next_header (p);
188 static_always_inline int
189 esp_trailer_icv_overflow (vlib_node_runtime_t * node, vlib_buffer_t * b,
190 u16 * next, u16 buffer_data_size)
192 if (b->current_data + b->current_length <= buffer_data_size)
195 b->current_length -= buffer_data_size - b->current_data;
196 b->error = node->errors[ESP_ENCRYPT_ERROR_NO_TRAILER_SPACE];
197 next[0] = ESP_ENCRYPT_NEXT_DROP;
201 static_always_inline void
202 esp_process_ops (vlib_main_t * vm, vlib_node_runtime_t * node,
203 vnet_crypto_op_t * ops, vlib_buffer_t * b[], u16 * nexts)
205 u32 n_fail, n_ops = vec_len (ops);
206 vnet_crypto_op_t *op = ops;
211 n_fail = n_ops - vnet_crypto_process_ops (vm, op, n_ops);
215 ASSERT (op - ops < n_ops);
217 if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
219 u32 bi = op->user_data;
220 b[bi]->error = node->errors[ESP_ENCRYPT_ERROR_CRYPTO_ENGINE_ERROR];
221 nexts[bi] = ESP_ENCRYPT_NEXT_DROP;
232 } __clib_packed esp_gcm_nonce_t;
234 STATIC_ASSERT_SIZEOF (esp_gcm_nonce_t, 12);
237 esp_encrypt_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
238 vlib_frame_t * frame, int is_ip6, int is_tun)
240 ipsec_main_t *im = &ipsec_main;
241 ipsec_per_thread_data_t *ptd = vec_elt_at_index (im->ptd, vm->thread_index);
242 u32 *from = vlib_frame_vector_args (frame);
243 u32 n_left = frame->n_vectors;
244 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
245 u16 nexts[VLIB_FRAME_SIZE], *next = nexts;
246 esp_gcm_nonce_t nonces[VLIB_FRAME_SIZE], *nonce = nonces;
247 u32 thread_index = vm->thread_index;
248 u16 buffer_data_size = vlib_buffer_get_default_data_size (vm);
249 u32 current_sa_index = ~0, current_sa_packets = 0;
250 u32 current_sa_bytes = 0, spi = 0;
251 u8 block_sz = 0, iv_sz = 0, icv_sz = 0;
254 vlib_get_buffers (vm, from, b, n_left);
255 vec_reset_length (ptd->crypto_ops);
256 vec_reset_length (ptd->integ_ops);
263 u8 *payload, *next_hdr_ptr;
270 vlib_prefetch_buffer_header (b[2], LOAD);
271 p = vlib_buffer_get_current (b[1]);
272 CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
273 p -= CLIB_CACHE_LINE_BYTES;
274 CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
279 /* we are on a ipsec tunnel's feature arc */
281 sa_index0 = *(u32 *) vnet_feature_next_with_data (&next0, b[0],
287 sa_index0 = vnet_buffer (b[0])->ipsec.sad_index;
289 if (sa_index0 != current_sa_index)
291 sa0 = pool_elt_at_index (im->sad, sa_index0);
292 current_sa_index = sa_index0;
293 vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
294 sa_index0, current_sa_packets,
296 current_sa_packets = current_sa_bytes = 0;
297 spi = clib_net_to_host_u32 (sa0->spi);
298 block_sz = sa0->crypto_block_size;
299 icv_sz = sa0->integ_icv_size;
300 iv_sz = sa0->crypto_iv_size;
303 if (vlib_buffer_chain_linearize (vm, b[0]) != 1)
305 b[0]->error = node->errors[ESP_ENCRYPT_ERROR_CHAINED_BUFFER];
306 next[0] = ESP_ENCRYPT_NEXT_DROP;
310 if (PREDICT_FALSE (esp_seq_advance (sa0)))
312 b[0]->error = node->errors[ESP_ENCRYPT_ERROR_SEQ_CYCLED];
313 next[0] = ESP_ENCRYPT_NEXT_DROP;
320 if (ipsec_sa_is_set_IS_TUNNEL (sa0))
322 payload = vlib_buffer_get_current (b[0]);
323 next_hdr_ptr = esp_add_footer_and_icv (b[0], block_sz, icv_sz);
324 payload_len = b[0]->current_length;
326 if (esp_trailer_icv_overflow (node, b[0], next, buffer_data_size))
330 hdr_len += sizeof (*esp);
331 esp = (esp_header_t *) (payload - hdr_len);
333 /* optional UDP header */
334 if (ipsec_sa_is_set_UDP_ENCAP (sa0))
336 hdr_len += sizeof (udp_header_t);
337 esp_fill_udp_hdr (sa0, (udp_header_t *) (payload - hdr_len),
338 payload_len + hdr_len);
342 if (ipsec_sa_is_set_IS_TUNNEL_V6 (sa0))
345 u16 len = sizeof (ip6_header_t);
347 ip6 = (ip6_header_t *) (payload - hdr_len);
348 clib_memcpy_fast (ip6, &sa0->ip6_hdr, len);
349 *next_hdr_ptr = (is_ip6 ?
350 IP_PROTOCOL_IPV6 : IP_PROTOCOL_IP_IN_IP);
351 len = payload_len + hdr_len - len;
352 ip6->payload_length = clib_net_to_host_u16 (len);
357 u16 len = sizeof (ip4_header_t);
359 ip4 = (ip4_header_t *) (payload - hdr_len);
360 clib_memcpy_fast (ip4, &sa0->ip4_hdr, len);
361 *next_hdr_ptr = (is_ip6 ?
362 IP_PROTOCOL_IPV6 : IP_PROTOCOL_IP_IN_IP);
363 len = payload_len + hdr_len;
364 esp_update_ip4_hdr (ip4, len, /* is_transport */ 0, 0);
367 dpo = sa0->dpo + IPSEC_PROTOCOL_ESP;
370 next[0] = dpo->dpoi_next_node;
371 vnet_buffer (b[0])->ip.adj_index[VLIB_TX] = dpo->dpoi_index;
374 else /* transport mode */
376 u8 *l2_hdr, l2_len, *ip_hdr, ip_len;
377 udp_header_t *udp = 0;
378 u8 *old_ip_hdr = vlib_buffer_get_current (b[0]);
381 esp_get_ip6_hdr_len ((ip6_header_t *) old_ip_hdr) :
382 ip4_header_bytes ((ip4_header_t *) old_ip_hdr);
384 vlib_buffer_advance (b[0], ip_len);
385 payload = vlib_buffer_get_current (b[0]);
386 next_hdr_ptr = esp_add_footer_and_icv (b[0], block_sz, icv_sz);
387 payload_len = b[0]->current_length;
389 if (esp_trailer_icv_overflow (node, b[0], next, buffer_data_size))
393 hdr_len += sizeof (*esp);
394 esp = (esp_header_t *) (payload - hdr_len);
396 /* optional UDP header */
397 if (ipsec_sa_is_set_UDP_ENCAP (sa0))
399 hdr_len += sizeof (udp_header_t);
400 udp = (udp_header_t *) (payload - hdr_len);
405 ip_hdr = payload - hdr_len;
408 l2_len = vnet_buffer (b[0])->ip.save_rewrite_length;
410 l2_hdr = payload - hdr_len;
412 /* copy l2 and ip header */
413 clib_memcpy_le32 (l2_hdr, old_ip_hdr - l2_len, l2_len);
414 clib_memcpy_le64 (ip_hdr, old_ip_hdr, ip_len);
418 ip6_header_t *ip6 = (ip6_header_t *) (ip_hdr);
419 *next_hdr_ptr = ip6->protocol;
420 ip6->protocol = IP_PROTOCOL_IPSEC_ESP;
421 ip6->payload_length =
422 clib_host_to_net_u16 (payload_len + hdr_len - l2_len -
428 ip4_header_t *ip4 = (ip4_header_t *) (ip_hdr);
429 *next_hdr_ptr = ip4->protocol;
430 len = payload_len + hdr_len - l2_len;
433 esp_update_ip4_hdr (ip4, len, /* is_transport */ 1, 1);
434 esp_fill_udp_hdr (sa0, udp, len - ip_len);
437 esp_update_ip4_hdr (ip4, len, /* is_transport */ 1, 0);
440 next[0] = ESP_ENCRYPT_NEXT_INTERFACE_OUTPUT;
444 esp->seq = clib_net_to_host_u32 (sa0->seq);
446 if (sa0->crypto_enc_op_id)
448 vnet_crypto_op_t *op;
449 vec_add2_aligned (ptd->crypto_ops, op, 1, CLIB_CACHE_LINE_BYTES);
450 vnet_crypto_op_init (op, sa0->crypto_enc_op_id);
451 op->src = op->dst = payload;
452 op->key_index = sa0->crypto_key_index;
453 op->len = payload_len - icv_sz;
454 op->user_data = b - bufs;
456 if (ipsec_sa_is_set_IS_AEAD (sa0))
459 * construct the AAD in a scratch space in front
462 op->aad = payload - hdr_len - sizeof (esp_aead_t);
464 esp_aad_fill (op, esp, sa0);
466 op->tag = payload + op->len;
469 u64 *iv = (u64 *) (payload - iv_sz);
470 nonce->salt = sa0->salt;
471 nonce->iv = *iv = clib_host_to_net_u64 (sa0->gcm_iv_counter++);
472 op->iv = (u8 *) nonce;
477 op->iv = payload - iv_sz;
478 op->flags = VNET_CRYPTO_OP_FLAG_INIT_IV;
482 if (sa0->integ_op_id)
484 vnet_crypto_op_t *op;
485 vec_add2_aligned (ptd->integ_ops, op, 1, CLIB_CACHE_LINE_BYTES);
486 vnet_crypto_op_init (op, sa0->integ_op_id);
487 op->src = payload - iv_sz - sizeof (esp_header_t);
488 op->digest = payload + payload_len - icv_sz;
489 op->key_index = sa0->integ_key_index;
490 op->digest_len = icv_sz;
491 op->len = payload_len - icv_sz + iv_sz + sizeof (esp_header_t);
492 op->user_data = b - bufs;
493 if (ipsec_sa_is_set_USE_ESN (sa0))
495 u32 seq_hi = clib_net_to_host_u32 (sa0->seq_hi);
496 clib_memcpy_fast (op->digest, &seq_hi, sizeof (seq_hi));
497 op->len += sizeof (seq_hi);
501 vlib_buffer_advance (b[0], 0LL - hdr_len);
503 current_sa_packets += 1;
504 current_sa_bytes += payload_len;
507 if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
509 esp_encrypt_trace_t *tr = vlib_add_trace (vm, node, b[0],
511 tr->sa_index = sa_index0;
513 tr->seq = sa0->seq - 1;
514 tr->udp_encap = ipsec_sa_is_set_UDP_ENCAP (sa0);
515 tr->crypto_alg = sa0->crypto_alg;
516 tr->integ_alg = sa0->integ_alg;
524 vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
525 current_sa_index, current_sa_packets,
527 esp_process_ops (vm, node, ptd->crypto_ops, bufs, nexts);
528 esp_process_ops (vm, node, ptd->integ_ops, bufs, nexts);
530 vlib_node_increment_counter (vm, node->node_index,
531 ESP_ENCRYPT_ERROR_RX_PKTS, frame->n_vectors);
533 vlib_buffer_enqueue_to_next (vm, node, from, nexts, frame->n_vectors);
534 return frame->n_vectors;
537 VLIB_NODE_FN (esp4_encrypt_node) (vlib_main_t * vm,
538 vlib_node_runtime_t * node,
539 vlib_frame_t * from_frame)
541 return esp_encrypt_inline (vm, node, from_frame, 0 /* is_ip6 */ , 0);
545 VLIB_REGISTER_NODE (esp4_encrypt_node) = {
546 .name = "esp4-encrypt",
547 .vector_size = sizeof (u32),
548 .format_trace = format_esp_encrypt_trace,
549 .type = VLIB_NODE_TYPE_INTERNAL,
551 .n_errors = ARRAY_LEN(esp_encrypt_error_strings),
552 .error_strings = esp_encrypt_error_strings,
554 .n_next_nodes = ESP_ENCRYPT_N_NEXT,
556 #define _(s,n) [ESP_ENCRYPT_NEXT_##s] = n,
557 foreach_esp_encrypt_next
563 VLIB_NODE_FN (esp6_encrypt_node) (vlib_main_t * vm,
564 vlib_node_runtime_t * node,
565 vlib_frame_t * from_frame)
567 return esp_encrypt_inline (vm, node, from_frame, 1 /* is_ip6 */ , 0);
571 VLIB_REGISTER_NODE (esp6_encrypt_node) = {
572 .name = "esp6-encrypt",
573 .vector_size = sizeof (u32),
574 .format_trace = format_esp_encrypt_trace,
575 .type = VLIB_NODE_TYPE_INTERNAL,
577 .n_errors = ARRAY_LEN(esp_encrypt_error_strings),
578 .error_strings = esp_encrypt_error_strings,
580 .n_next_nodes = ESP_ENCRYPT_N_NEXT,
582 #define _(s,n) [ESP_ENCRYPT_NEXT_##s] = n,
583 foreach_esp_encrypt_next
589 VLIB_NODE_FN (esp4_encrypt_tun_node) (vlib_main_t * vm,
590 vlib_node_runtime_t * node,
591 vlib_frame_t * from_frame)
593 return esp_encrypt_inline (vm, node, from_frame, 0 /* is_ip6 */ , 1);
597 VLIB_REGISTER_NODE (esp4_encrypt_tun_node) = {
598 .name = "esp4-encrypt-tun",
599 .vector_size = sizeof (u32),
600 .format_trace = format_esp_encrypt_trace,
601 .type = VLIB_NODE_TYPE_INTERNAL,
603 .n_errors = ARRAY_LEN(esp_encrypt_error_strings),
604 .error_strings = esp_encrypt_error_strings,
608 [ESP_ENCRYPT_NEXT_DROP] = "ip4-drop",
612 VNET_FEATURE_INIT (esp4_encrypt_tun_feat_node, static) =
614 .arc_name = "ip4-output",
615 .node_name = "esp4-encrypt-tun",
616 .runs_before = VNET_FEATURES ("adj-midchain-tx"),
620 VLIB_NODE_FN (esp6_encrypt_tun_node) (vlib_main_t * vm,
621 vlib_node_runtime_t * node,
622 vlib_frame_t * from_frame)
624 return esp_encrypt_inline (vm, node, from_frame, 1 /* is_ip6 */ , 1);
628 VLIB_REGISTER_NODE (esp6_encrypt_tun_node) = {
629 .name = "esp6-encrypt-tun",
630 .vector_size = sizeof (u32),
631 .format_trace = format_esp_encrypt_trace,
632 .type = VLIB_NODE_TYPE_INTERNAL,
634 .n_errors = ARRAY_LEN(esp_encrypt_error_strings),
635 .error_strings = esp_encrypt_error_strings,
639 [ESP_ENCRYPT_NEXT_DROP] = "ip6-drop",
643 VNET_FEATURE_INIT (esp6_encrypt_tun_feat_node, static) =
645 .arc_name = "ip6-output",
646 .node_name = "esp6-encrypt-tun",
647 .runs_before = VNET_FEATURES ("adj-midchain-tx"),
652 * fd.io coding-style-patch-verification: ON
655 * eval: (c-set-style "gnu")