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/ipsec/ipsec.h>
24 #include <vnet/ipsec/esp.h>
26 #ifndef CLIB_MARCH_VARIANT
27 ipsec_proto_main_t ipsec_proto_main;
28 #endif /* CLIB_MARCH_VARIANT */
30 #define foreach_esp_encrypt_next \
31 _(DROP, "error-drop") \
32 _(IP4_LOOKUP, "ip4-lookup") \
33 _(IP6_LOOKUP, "ip6-lookup") \
34 _(INTERFACE_OUTPUT, "interface-output")
36 #define _(v, s) ESP_ENCRYPT_NEXT_##v,
39 foreach_esp_encrypt_next
44 #define foreach_esp_encrypt_error \
45 _(RX_PKTS, "ESP pkts received") \
46 _(NO_BUFFER, "No buffer (packet dropped)") \
47 _(DECRYPTION_FAILED, "ESP encryption failed") \
48 _(SEQ_CYCLED, "sequence number cycled")
53 #define _(sym,str) ESP_ENCRYPT_ERROR_##sym,
54 foreach_esp_encrypt_error
57 } esp_encrypt_error_t;
59 static char *esp_encrypt_error_strings[] = {
60 #define _(sym,string) string,
61 foreach_esp_encrypt_error
71 ipsec_crypto_alg_t crypto_alg;
72 ipsec_integ_alg_t integ_alg;
73 } esp_encrypt_trace_t;
75 /* packet trace format function */
77 format_esp_encrypt_trace (u8 * s, va_list * args)
79 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
80 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
81 esp_encrypt_trace_t *t = va_arg (*args, esp_encrypt_trace_t *);
83 s = format (s, "esp: sa-index %d spi %u seq %u crypto %U integrity %U%s",
84 t->sa_index, t->spi, t->seq,
85 format_ipsec_crypto_alg, t->crypto_alg,
86 format_ipsec_integ_alg, t->integ_alg,
87 t->udp_encap ? " udp-encap-enabled" : "");
92 esp_encrypt_cbc (vlib_main_t * vm, ipsec_crypto_alg_t alg,
93 u8 * in, u8 * out, size_t in_len, u8 * key, u8 * iv)
95 ipsec_proto_main_t *em = &ipsec_proto_main;
96 u32 thread_index = vm->thread_index;
97 #if OPENSSL_VERSION_NUMBER >= 0x10100000L
98 EVP_CIPHER_CTX *ctx = em->per_thread_data[thread_index].encrypt_ctx;
100 EVP_CIPHER_CTX *ctx = &(em->per_thread_data[thread_index].encrypt_ctx);
102 const EVP_CIPHER *cipher = NULL;
105 ASSERT (alg < IPSEC_CRYPTO_N_ALG);
108 (em->ipsec_proto_main_crypto_algs[alg].type == IPSEC_CRYPTO_ALG_NONE))
112 (alg != em->per_thread_data[thread_index].last_encrypt_alg))
114 cipher = em->ipsec_proto_main_crypto_algs[alg].type;
115 em->per_thread_data[thread_index].last_encrypt_alg = alg;
118 EVP_EncryptInit_ex (ctx, cipher, NULL, key, iv);
120 EVP_EncryptUpdate (ctx, out, &out_len, in, in_len);
121 EVP_EncryptFinal_ex (ctx, out + out_len, &out_len);
125 esp_encrypt_inline (vlib_main_t * vm,
126 vlib_node_runtime_t * node, vlib_frame_t * from_frame,
129 u32 n_left_from, *from, *to_next = 0, next_index;
130 from = vlib_frame_vector_args (from_frame);
131 n_left_from = from_frame->n_vectors;
132 ipsec_main_t *im = &ipsec_main;
133 ipsec_proto_main_t *em = &ipsec_proto_main;
135 u32 thread_index = vm->thread_index;
137 ipsec_alloc_empty_buffers (vm, im);
139 u32 *empty_buffers = im->empty_buffers[thread_index];
141 if (PREDICT_FALSE (vec_len (empty_buffers) < n_left_from))
143 vlib_node_increment_counter (vm, node->node_index,
144 ESP_ENCRYPT_ERROR_NO_BUFFER, n_left_from);
145 clib_warning ("not enough empty buffers. discarding frame");
146 goto free_buffers_and_exit;
149 next_index = node->cached_next_index;
151 while (n_left_from > 0)
155 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
157 while (n_left_from > 0 && n_left_to_next > 0)
159 u32 i_bi0, o_bi0, next0;
160 vlib_buffer_t *i_b0, *o_b0 = 0;
163 ip4_and_esp_header_t *oh0 = 0;
164 ip6_and_esp_header_t *ih6_0, *oh6_0 = 0;
165 ip4_and_udp_and_esp_header_t *iuh0, *ouh0 = 0;
166 uword last_empty_buffer;
167 esp_header_t *o_esp0;
172 u8 transport_mode = 0;
179 next0 = ESP_ENCRYPT_NEXT_DROP;
181 i_b0 = vlib_get_buffer (vm, i_bi0);
182 sa_index0 = vnet_buffer (i_b0)->ipsec.sad_index;
183 sa0 = pool_elt_at_index (im->sad, sa_index0);
185 vlib_prefetch_combined_counter
186 (&ipsec_sa_counters, thread_index, sa_index0);
188 if (PREDICT_FALSE (esp_seq_advance (sa0)))
190 clib_warning ("sequence number counter has cycled SPI %u",
192 vlib_node_increment_counter (vm, node->node_index,
193 ESP_ENCRYPT_ERROR_SEQ_CYCLED, 1);
201 /* grab free buffer */
202 last_empty_buffer = vec_len (empty_buffers) - 1;
203 o_bi0 = empty_buffers[last_empty_buffer];
204 o_b0 = vlib_get_buffer (vm, o_bi0);
205 o_b0->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
206 o_b0->current_data = sizeof (ethernet_header_t);
207 iuh0 = vlib_buffer_get_current (i_b0);
208 vlib_prefetch_buffer_with_index (vm,
209 empty_buffers[last_empty_buffer -
211 _vec_len (empty_buffers) = last_empty_buffer;
215 /* add old buffer to the recycle list */
216 vec_add1 (recycle, i_bi0);
220 ih6_0 = vlib_buffer_get_current (i_b0);
221 next_hdr_type = IP_PROTOCOL_IPV6;
222 oh6_0 = vlib_buffer_get_current (o_b0);
224 oh6_0->ip6.ip_version_traffic_class_and_flow_label =
225 ih6_0->ip6.ip_version_traffic_class_and_flow_label;
226 oh6_0->ip6.protocol = IP_PROTOCOL_IPSEC_ESP;
227 ip_udp_hdr_size = sizeof (ip6_header_t);
228 o_esp0 = vlib_buffer_get_current (o_b0) + ip_udp_hdr_size;
229 oh6_0->ip6.hop_limit = 254;
230 oh6_0->ip6.src_address.as_u64[0] =
231 ih6_0->ip6.src_address.as_u64[0];
232 oh6_0->ip6.src_address.as_u64[1] =
233 ih6_0->ip6.src_address.as_u64[1];
234 oh6_0->ip6.dst_address.as_u64[0] =
235 ih6_0->ip6.dst_address.as_u64[0];
236 oh6_0->ip6.dst_address.as_u64[1] =
237 ih6_0->ip6.dst_address.as_u64[1];
238 o_esp0->spi = clib_net_to_host_u32 (sa0->spi);
239 o_esp0->seq = clib_net_to_host_u32 (sa0->seq);
240 ip_proto = ih6_0->ip6.protocol;
242 next0 = ESP_ENCRYPT_NEXT_IP6_LOOKUP;
246 next_hdr_type = IP_PROTOCOL_IP_IN_IP;
247 oh0 = vlib_buffer_get_current (o_b0);
248 ouh0 = vlib_buffer_get_current (o_b0);
250 oh0->ip4.ip_version_and_header_length = 0x45;
251 oh0->ip4.tos = iuh0->ip4.tos;
252 oh0->ip4.fragment_id = 0;
253 oh0->ip4.flags_and_fragment_offset = 0;
258 clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
260 clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
261 ouh0->udp.checksum = 0;
262 ouh0->ip4.protocol = IP_PROTOCOL_UDP;
264 sizeof (udp_header_t) + sizeof (ip4_header_t);
268 oh0->ip4.protocol = IP_PROTOCOL_IPSEC_ESP;
269 ip_udp_hdr_size = sizeof (ip4_header_t);
271 o_esp0 = vlib_buffer_get_current (o_b0) + ip_udp_hdr_size;
272 oh0->ip4.src_address.as_u32 = iuh0->ip4.src_address.as_u32;
273 oh0->ip4.dst_address.as_u32 = iuh0->ip4.dst_address.as_u32;
274 o_esp0->spi = clib_net_to_host_u32 (sa0->spi);
275 o_esp0->seq = clib_net_to_host_u32 (sa0->seq);
276 ip_proto = iuh0->ip4.protocol;
278 next0 = ESP_ENCRYPT_NEXT_IP4_LOOKUP;
281 if (PREDICT_TRUE (!is_ip6 && sa0->is_tunnel && !sa0->is_tunnel_ip6))
283 oh0->ip4.src_address.as_u32 = sa0->tunnel_src_addr.ip4.as_u32;
284 oh0->ip4.dst_address.as_u32 = sa0->tunnel_dst_addr.ip4.as_u32;
286 next0 = sa0->dpo[IPSEC_PROTOCOL_ESP].dpoi_next_node;
287 vnet_buffer (o_b0)->ip.adj_index[VLIB_TX] =
288 sa0->dpo[IPSEC_PROTOCOL_ESP].dpoi_index;
290 else if (is_ip6 && sa0->is_tunnel && sa0->is_tunnel_ip6)
292 oh6_0->ip6.src_address.as_u64[0] =
293 sa0->tunnel_src_addr.ip6.as_u64[0];
294 oh6_0->ip6.src_address.as_u64[1] =
295 sa0->tunnel_src_addr.ip6.as_u64[1];
296 oh6_0->ip6.dst_address.as_u64[0] =
297 sa0->tunnel_dst_addr.ip6.as_u64[0];
298 oh6_0->ip6.dst_address.as_u64[1] =
299 sa0->tunnel_dst_addr.ip6.as_u64[1];
301 next0 = sa0->dpo[IPSEC_PROTOCOL_ESP].dpoi_next_node;
302 vnet_buffer (o_b0)->ip.adj_index[VLIB_TX] =
303 sa0->dpo[IPSEC_PROTOCOL_ESP].dpoi_index;
307 next_hdr_type = ip_proto;
308 if (vnet_buffer (i_b0)->sw_if_index[VLIB_TX] != ~0)
311 ethernet_header_t *ieh0, *oeh0;
313 (ethernet_header_t *) ((u8 *)
314 vlib_buffer_get_current (i_b0) -
315 sizeof (ethernet_header_t));
316 oeh0 = (ethernet_header_t *) o_b0->data;
317 clib_memcpy_fast (oeh0, ieh0, sizeof (ethernet_header_t));
318 next0 = ESP_ENCRYPT_NEXT_INTERFACE_OUTPUT;
319 vnet_buffer (o_b0)->sw_if_index[VLIB_TX] =
320 vnet_buffer (i_b0)->sw_if_index[VLIB_TX];
325 vlib_buffer_advance (i_b0, sizeof (ip6_header_t));
329 vlib_buffer_advance (i_b0, sizeof (ip4_header_t));
333 ASSERT (sa0->crypto_alg < IPSEC_CRYPTO_N_ALG);
334 vlib_increment_combined_counter
335 (&ipsec_sa_counters, thread_index, sa_index0,
336 1, i_b0->current_length);
338 if (PREDICT_TRUE (sa0->crypto_alg != IPSEC_CRYPTO_ALG_NONE))
341 const int BLOCK_SIZE =
342 em->ipsec_proto_main_crypto_algs[sa0->crypto_alg].block_size;
344 em->ipsec_proto_main_crypto_algs[sa0->crypto_alg].iv_size;
345 int blocks = 1 + (i_b0->current_length + 1) / BLOCK_SIZE;
347 /* pad packet in input buffer */
348 u8 pad_bytes = BLOCK_SIZE * blocks - 2 - i_b0->current_length;
351 vlib_buffer_get_current (i_b0) + i_b0->current_length;
352 i_b0->current_length = BLOCK_SIZE * blocks;
353 for (i = 0; i < pad_bytes; ++i)
357 f0 = vlib_buffer_get_current (i_b0) + i_b0->current_length - 2;
358 f0->pad_length = pad_bytes;
359 f0->next_header = next_hdr_type;
361 o_b0->current_length = ip_udp_hdr_size + sizeof (esp_header_t) +
362 BLOCK_SIZE * blocks + IV_SIZE;
364 vnet_buffer (o_b0)->sw_if_index[VLIB_RX] =
365 vnet_buffer (i_b0)->sw_if_index[VLIB_RX];
368 ipsec_proto_main_crypto_algs[sa0->crypto_alg].iv_size];
369 RAND_bytes (iv, sizeof (iv));
371 clib_memcpy_fast ((u8 *) vlib_buffer_get_current (o_b0) +
372 ip_udp_hdr_size + sizeof (esp_header_t), iv,
373 em->ipsec_proto_main_crypto_algs[sa0->
374 crypto_alg].iv_size);
376 esp_encrypt_cbc (vm, sa0->crypto_alg,
377 (u8 *) vlib_buffer_get_current (i_b0),
378 (u8 *) vlib_buffer_get_current (o_b0) +
379 ip_udp_hdr_size + sizeof (esp_header_t) +
380 IV_SIZE, BLOCK_SIZE * blocks,
381 sa0->crypto_key.data, iv);
384 o_b0->current_length +=
385 hmac_calc (sa0->integ_alg, sa0->integ_key.data,
386 sa0->integ_key.len, (u8 *) o_esp0,
387 o_b0->current_length - ip_udp_hdr_size,
388 vlib_buffer_get_current (o_b0) + o_b0->current_length,
389 sa0->use_esn, sa0->seq_hi);
394 oh6_0->ip6.payload_length =
395 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, o_b0) -
396 sizeof (ip6_header_t));
401 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, o_b0));
402 oh0->ip4.checksum = ip4_header_checksum (&oh0->ip4);
406 clib_host_to_net_u16 (clib_net_to_host_u16
408 ip4_header_bytes (&oh0->ip4));
413 vlib_buffer_reset (o_b0);
416 if (PREDICT_FALSE (i_b0->flags & VLIB_BUFFER_IS_TRACED))
420 o_b0->flags |= VLIB_BUFFER_IS_TRACED;
421 o_b0->trace_index = i_b0->trace_index;
422 esp_encrypt_trace_t *tr =
423 vlib_add_trace (vm, node, o_b0, sizeof (*tr));
424 tr->sa_index = sa_index0;
426 tr->seq = sa0->seq - 1;
427 tr->udp_encap = sa0->udp_encap;
428 tr->crypto_alg = sa0->crypto_alg;
429 tr->integ_alg = sa0->integ_alg;
433 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
434 to_next, n_left_to_next, o_bi0,
437 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
439 vlib_node_increment_counter (vm, node->node_index,
440 ESP_ENCRYPT_ERROR_RX_PKTS,
441 from_frame->n_vectors);
443 free_buffers_and_exit:
445 vlib_buffer_free (vm, recycle, vec_len (recycle));
447 return from_frame->n_vectors;
450 VLIB_NODE_FN (esp4_encrypt_node) (vlib_main_t * vm,
451 vlib_node_runtime_t * node,
452 vlib_frame_t * from_frame)
454 return esp_encrypt_inline (vm, node, from_frame, 0 /* is_ip6 */ );
458 VLIB_REGISTER_NODE (esp4_encrypt_node) = {
459 .name = "esp4-encrypt",
460 .vector_size = sizeof (u32),
461 .format_trace = format_esp_encrypt_trace,
462 .type = VLIB_NODE_TYPE_INTERNAL,
464 .n_errors = ARRAY_LEN(esp_encrypt_error_strings),
465 .error_strings = esp_encrypt_error_strings,
467 .n_next_nodes = ESP_ENCRYPT_N_NEXT,
469 #define _(s,n) [ESP_ENCRYPT_NEXT_##s] = n,
470 foreach_esp_encrypt_next
476 VLIB_NODE_FN (esp6_encrypt_node) (vlib_main_t * vm,
477 vlib_node_runtime_t * node,
478 vlib_frame_t * from_frame)
480 return esp_encrypt_inline (vm, node, from_frame, 1 /* is_ip6 */ );
484 VLIB_REGISTER_NODE (esp6_encrypt_node) = {
485 .name = "esp6-encrypt",
486 .vector_size = sizeof (u32),
487 .format_trace = format_esp_encrypt_trace,
488 .type = VLIB_NODE_TYPE_INTERNAL,
490 .n_errors = ARRAY_LEN(esp_encrypt_error_strings),
491 .error_strings = esp_encrypt_error_strings,
493 .n_next_nodes = ESP_ENCRYPT_N_NEXT,
495 #define _(s,n) [ESP_ENCRYPT_NEXT_##s] = n,
496 foreach_esp_encrypt_next
503 * fd.io coding-style-patch-verification: ON
506 * eval: (c-set-style "gnu")