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>
22 #include <vnet/ipsec/ipsec.h>
23 #include <vnet/ipsec/esp.h>
25 #define ESP_SEQ_MAX (4294967295UL)
27 #define foreach_esp_encrypt_next \
28 _(DROP, "error-drop") \
29 _(IP4_INPUT, "ip4-input") \
30 _(IP6_INPUT, "ip6-input") \
31 _(INTERFACE_OUTPUT, "interface-output")
33 #define _(v, s) ESP_ENCRYPT_NEXT_##v,
35 foreach_esp_encrypt_next
40 #define foreach_esp_encrypt_error \
41 _(RX_PKTS, "ESP pkts received") \
42 _(NO_BUFFER, "No buffer (packet dropped)") \
43 _(DECRYPTION_FAILED, "ESP encryption failed") \
44 _(SEQ_CYCLED, "sequence number cycled")
48 #define _(sym,str) ESP_ENCRYPT_ERROR_##sym,
49 foreach_esp_encrypt_error
52 } esp_encrypt_error_t;
54 static char * esp_encrypt_error_strings[] = {
55 #define _(sym,string) string,
56 foreach_esp_encrypt_error
60 vlib_node_registration_t esp_encrypt_node;
65 ipsec_crypto_alg_t crypto_alg;
66 ipsec_integ_alg_t integ_alg;
67 } esp_encrypt_trace_t;
69 /* packet trace format function */
70 static u8 * format_esp_encrypt_trace (u8 * s, va_list * args)
72 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
73 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
74 esp_encrypt_trace_t * t = va_arg (*args, esp_encrypt_trace_t *);
76 s = format (s, "esp: spi %u seq %u crypto %U integrity %U",
78 format_ipsec_crypto_alg, t->crypto_alg,
79 format_ipsec_integ_alg, t->integ_alg);
84 esp_encrypt_aes_cbc(ipsec_crypto_alg_t alg,
91 esp_main_t * em = &esp_main;
92 u32 cpu_index = os_get_cpu_number();
93 EVP_CIPHER_CTX * ctx = &(em->per_thread_data[cpu_index].encrypt_ctx);
94 const EVP_CIPHER * cipher = NULL;
97 ASSERT(alg < IPSEC_CRYPTO_N_ALG);
99 if (PREDICT_FALSE(em->esp_crypto_algs[alg].type == IPSEC_CRYPTO_ALG_NONE))
102 if (PREDICT_FALSE(alg != em->per_thread_data[cpu_index].last_encrypt_alg)) {
103 cipher = em->esp_crypto_algs[alg].type;
104 em->per_thread_data[cpu_index].last_encrypt_alg = alg;
107 EVP_EncryptInit_ex(ctx, cipher, NULL, key, iv);
109 EVP_EncryptUpdate(ctx, out, &out_len, in, in_len);
110 EVP_EncryptFinal_ex(ctx, out + out_len, &out_len);
114 esp_seq_advance (ipsec_sa_t * sa)
116 if (PREDICT_TRUE(sa->use_esn))
118 if (PREDICT_FALSE(sa->seq == ESP_SEQ_MAX))
120 if (PREDICT_FALSE(sa->use_anti_replay && sa->seq_hi == ESP_SEQ_MAX))
128 if (PREDICT_FALSE(sa->use_anti_replay && sa->seq == ESP_SEQ_MAX))
137 esp_encrypt_node_fn (vlib_main_t * vm,
138 vlib_node_runtime_t * node,
139 vlib_frame_t * from_frame)
141 u32 n_left_from, *from, * to_next = 0, next_index;
142 from = vlib_frame_vector_args (from_frame);
143 n_left_from = from_frame->n_vectors;
144 ipsec_main_t *im = &ipsec_main;
146 u32 cpu_index = os_get_cpu_number();
148 ipsec_alloc_empty_buffers(vm, im);
150 u32 * empty_buffers = im->empty_buffers[cpu_index];
152 if (PREDICT_FALSE(vec_len (empty_buffers) < n_left_from)){
153 vlib_node_increment_counter (vm, esp_encrypt_node.index,
154 ESP_ENCRYPT_ERROR_NO_BUFFER, n_left_from);
155 clib_warning("no enough empty buffers. discarding frame");
156 goto free_buffers_and_exit;
159 next_index = node->cached_next_index;
161 while (n_left_from > 0)
165 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
167 while (n_left_from > 0 && n_left_to_next > 0)
169 u32 i_bi0, o_bi0, next0;
170 vlib_buffer_t * i_b0, *o_b0 = 0;
173 ip4_and_esp_header_t * ih0, * oh0 = 0;
174 ip6_and_esp_header_t * ih6_0, * oh6_0 = 0;
175 uword last_empty_buffer;
176 esp_header_t * o_esp0;
187 next0 = ESP_ENCRYPT_NEXT_DROP;
189 i_b0 = vlib_get_buffer (vm, i_bi0);
190 sa_index0 = vnet_buffer(i_b0)->output_features.ipsec_sad_index;
191 sa0 = pool_elt_at_index(im->sad, sa_index0);
193 if (PREDICT_FALSE(esp_seq_advance(sa0)))
195 clib_warning("sequence number counter has cycled SPI %u", sa0->spi);
196 vlib_node_increment_counter (vm, esp_encrypt_node.index,
197 ESP_ENCRYPT_ERROR_SEQ_CYCLED, 1);
203 /* grab free buffer */
204 last_empty_buffer = vec_len (empty_buffers) - 1;
205 o_bi0 = empty_buffers[last_empty_buffer];
206 o_b0 = vlib_get_buffer (vm, o_bi0);
207 o_b0->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
208 o_b0->current_data = sizeof(ethernet_header_t);
209 ih0 = vlib_buffer_get_current (i_b0);
210 vlib_prefetch_buffer_with_index (vm, empty_buffers[last_empty_buffer-1], STORE);
211 _vec_len (empty_buffers) = last_empty_buffer;
215 /* add old buffer to the recycle list */
216 vec_add1(recycle, i_bi0);
219 if (PREDICT_FALSE((ih0->ip4.ip_version_and_header_length & 0xF0 ) == 0x60))
222 ih6_0 = vlib_buffer_get_current (i_b0);
223 ip_hdr_size = sizeof(ip6_header_t);
224 next_hdr_type = IP_PROTOCOL_IPV6;
225 oh6_0 = vlib_buffer_get_current (o_b0);
226 o_esp0 = vlib_buffer_get_current (o_b0) + sizeof(ip6_header_t);
228 oh6_0->ip6.ip_version_traffic_class_and_flow_label =
229 ih6_0->ip6.ip_version_traffic_class_and_flow_label;
230 oh6_0->ip6.protocol = IP_PROTOCOL_IPSEC_ESP;
231 oh6_0->ip6.hop_limit = 254;
232 oh6_0->esp.spi = clib_net_to_host_u32(sa0->spi);
233 oh6_0->esp.seq = clib_net_to_host_u32(sa0->seq);
238 ip_hdr_size = sizeof(ip4_header_t);
239 next_hdr_type = IP_PROTOCOL_IP_IN_IP;
240 oh0 = vlib_buffer_get_current (o_b0);
241 o_esp0 = vlib_buffer_get_current (o_b0) + sizeof(ip4_header_t);
243 oh0->ip4.ip_version_and_header_length = 0x45;
244 oh0->ip4.tos = ih0->ip4.tos;
245 oh0->ip4.fragment_id = 0;
246 oh0->ip4.flags_and_fragment_offset = 0;
248 oh0->ip4.protocol = IP_PROTOCOL_IPSEC_ESP;
249 oh0->esp.spi = clib_net_to_host_u32(sa0->spi);
250 oh0->esp.seq = clib_net_to_host_u32(sa0->seq);
253 if (PREDICT_TRUE(sa0->is_tunnel && !sa0->is_tunnel_ip6))
255 oh0->ip4.src_address.as_u32 = sa0->tunnel_src_addr.ip4.as_u32;
256 oh0->ip4.dst_address.as_u32 = sa0->tunnel_dst_addr.ip4.as_u32;
258 /* in tunnel mode send it back to FIB */
259 next0 = ESP_ENCRYPT_NEXT_IP4_INPUT;
260 vnet_buffer (o_b0)->sw_if_index[VLIB_TX] = (u32)~0;
262 else if(sa0->is_tunnel && sa0->is_tunnel_ip6)
264 oh6_0->ip6.src_address.as_u64[0] = sa0->tunnel_src_addr.ip6.as_u64[0];
265 oh6_0->ip6.src_address.as_u64[1] = sa0->tunnel_src_addr.ip6.as_u64[1];
266 oh6_0->ip6.dst_address.as_u64[0] = sa0->tunnel_dst_addr.ip6.as_u64[0];
267 oh6_0->ip6.dst_address.as_u64[1] = sa0->tunnel_dst_addr.ip6.as_u64[1];
269 /* in tunnel mode send it back to FIB */
270 next0 = ESP_ENCRYPT_NEXT_IP6_INPUT;
271 vnet_buffer (o_b0)->sw_if_index[VLIB_TX] = (u32)~0;
275 next0 = ESP_ENCRYPT_NEXT_INTERFACE_OUTPUT;
276 o_b0->flags |= BUFFER_OUTPUT_FEAT_DONE;
277 vnet_buffer (o_b0)->sw_if_index[VLIB_TX] =
278 vnet_buffer (i_b0)->sw_if_index[VLIB_TX];
279 vnet_buffer(o_b0)->output_features.bitmap =
280 vnet_buffer(i_b0)->output_features.bitmap;
283 ASSERT(sa0->crypto_alg < IPSEC_CRYPTO_N_ALG);
285 if (PREDICT_TRUE(sa0->crypto_alg != IPSEC_CRYPTO_ALG_NONE)) {
287 const int BLOCK_SIZE = 16;
288 const int IV_SIZE = 16;
289 int blocks = 1 + (i_b0->current_length + 1) / BLOCK_SIZE;
291 /* pad packet in input buffer */
292 u8 pad_bytes = BLOCK_SIZE * blocks - 2 - i_b0->current_length;
294 u8 * padding = vlib_buffer_get_current (i_b0) + i_b0->current_length;
295 i_b0->current_length = BLOCK_SIZE * blocks;
296 for (i = 0; i < pad_bytes; ++i)
300 f0 = vlib_buffer_get_current (i_b0) + i_b0->current_length - 2;
301 f0->pad_length = pad_bytes;
302 f0->next_header = next_hdr_type;
304 o_b0->current_length = ip_hdr_size + sizeof(esp_header_t) +
305 BLOCK_SIZE * blocks + IV_SIZE;
307 vnet_buffer (o_b0)->sw_if_index[VLIB_RX] =
308 vnet_buffer (i_b0)->sw_if_index[VLIB_RX];
311 RAND_bytes(iv, sizeof(iv));
313 clib_memcpy((u8 *) vlib_buffer_get_current (o_b0) + ip_hdr_size +
314 sizeof(esp_header_t), iv, 16 );
316 esp_encrypt_aes_cbc(sa0->crypto_alg,
317 (u8 *) vlib_buffer_get_current (i_b0),
318 (u8 *) vlib_buffer_get_current (o_b0) +
319 ip_hdr_size + sizeof(esp_header_t) + IV_SIZE,
325 o_b0->current_length += hmac_calc(sa0->integ_alg, sa0->integ_key,
328 o_b0->current_length - ip_hdr_size,
329 vlib_buffer_get_current (o_b0) +
330 o_b0->current_length,
335 if (PREDICT_FALSE(is_ipv6))
337 oh6_0->ip6.payload_length = clib_host_to_net_u16 (
338 vlib_buffer_length_in_chain (vm, o_b0) - sizeof(ip6_header_t));
342 oh0->ip4.length = clib_host_to_net_u16 (
343 vlib_buffer_length_in_chain (vm, o_b0));
344 oh0->ip4.checksum = ip4_header_checksum (&oh0->ip4);
348 if (PREDICT_FALSE(i_b0->flags & VLIB_BUFFER_IS_TRACED)) {
350 o_b0->flags |= VLIB_BUFFER_IS_TRACED;
351 o_b0->trace_index = i_b0->trace_index;
353 esp_encrypt_trace_t *tr = vlib_add_trace (vm, node, o_b0, sizeof (*tr));
355 tr->seq = sa0->seq - 1;
356 tr->crypto_alg = sa0->crypto_alg;
357 tr->integ_alg = sa0->integ_alg;
360 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
361 to_next, n_left_to_next, o_bi0, next0);
363 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
365 vlib_node_increment_counter (vm, esp_encrypt_node.index,
366 ESP_ENCRYPT_ERROR_RX_PKTS,
367 from_frame->n_vectors);
369 free_buffers_and_exit:
370 vlib_buffer_free (vm, recycle, vec_len(recycle));
372 return from_frame->n_vectors;
376 VLIB_REGISTER_NODE (esp_encrypt_node) = {
377 .function = esp_encrypt_node_fn,
378 .name = "esp-encrypt",
379 .vector_size = sizeof (u32),
380 .format_trace = format_esp_encrypt_trace,
381 .type = VLIB_NODE_TYPE_INTERNAL,
383 .n_errors = ARRAY_LEN(esp_encrypt_error_strings),
384 .error_strings = esp_encrypt_error_strings,
386 .n_next_nodes = ESP_ENCRYPT_N_NEXT,
388 #define _(s,n) [ESP_ENCRYPT_NEXT_##s] = n,
389 foreach_esp_encrypt_next
394 VLIB_NODE_FUNCTION_MULTIARCH (esp_encrypt_node, esp_encrypt_node_fn)