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 _(NO_BUFFER, "No buffer (packet dropped)") \
45 _(DECRYPTION_FAILED, "ESP encryption failed") \
46 _(SEQ_CYCLED, "sequence number cycled")
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" : "");
90 esp_encrypt_cbc (vlib_main_t * vm, ipsec_crypto_alg_t alg,
91 u8 * in, u8 * out, size_t in_len, u8 * key, u8 * iv)
93 ipsec_main_t *im = &ipsec_main;
94 ipsec_main_crypto_alg_t *a;
95 vnet_crypto_op_t _op, *op = &_op;
97 ASSERT (alg < IPSEC_CRYPTO_N_ALG);
99 a = &im->crypto_algs[alg];
101 if (PREDICT_FALSE (a->enc_op_type == VNET_CRYPTO_OP_NONE))
104 op->op = a->enc_op_type;
105 op->flags = VNET_CRYPTO_OP_FLAG_INIT_IV;
112 vnet_crypto_process_ops (vm, op, 1);
116 esp_encrypt_inline (vlib_main_t * vm,
117 vlib_node_runtime_t * node, vlib_frame_t * from_frame,
120 u32 *from = vlib_frame_vector_args (from_frame);
121 u32 n_left_from = from_frame->n_vectors;
122 ipsec_main_t *im = &ipsec_main;
123 u32 new_bufs[VLIB_FRAME_SIZE];
124 vlib_buffer_t *i_bufs[VLIB_FRAME_SIZE], **ib = i_bufs;
125 vlib_buffer_t *o_bufs[VLIB_FRAME_SIZE], **ob = o_bufs;
126 u16 nexts[VLIB_FRAME_SIZE], *next = nexts;
127 u32 n_alloc, thread_index = vm->thread_index;
129 n_alloc = vlib_buffer_alloc (vm, new_bufs, n_left_from);
130 if (n_alloc != n_left_from)
132 vlib_node_increment_counter (vm, node->node_index,
133 ESP_ENCRYPT_ERROR_NO_BUFFER,
134 n_left_from - n_alloc);
137 n_left_from = n_alloc;
140 vlib_get_buffers (vm, from, ib, n_left_from);
141 vlib_get_buffers (vm, new_bufs, ob, n_left_from);
143 while (n_left_from > 0)
147 ip4_and_esp_header_t *oh0 = 0;
148 ip6_and_esp_header_t *ih6_0, *oh6_0 = 0;
149 ip4_and_udp_and_esp_header_t *iuh0, *ouh0 = 0;
150 esp_header_t *o_esp0;
155 u8 transport_mode = 0;
158 next[0] = ESP_ENCRYPT_NEXT_DROP;
160 sa_index0 = vnet_buffer (ib[0])->ipsec.sad_index;
161 sa0 = pool_elt_at_index (im->sad, sa_index0);
163 vlib_prefetch_combined_counter (&ipsec_sa_counters, thread_index,
166 esp_seq_err = esp_seq_advance (sa0);
168 /* grab free buffer */
169 ob[0]->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
170 ob[0]->current_data = sizeof (ethernet_header_t);
171 iuh0 = vlib_buffer_get_current (ib[0]);
175 ih6_0 = vlib_buffer_get_current (ib[0]);
176 next_hdr_type = IP_PROTOCOL_IPV6;
177 oh6_0 = vlib_buffer_get_current (ob[0]);
179 oh6_0->ip6.ip_version_traffic_class_and_flow_label =
180 ih6_0->ip6.ip_version_traffic_class_and_flow_label;
181 oh6_0->ip6.protocol = IP_PROTOCOL_IPSEC_ESP;
182 ip_udp_hdr_size = sizeof (ip6_header_t);
183 o_esp0 = vlib_buffer_get_current (ob[0]) + ip_udp_hdr_size;
184 oh6_0->ip6.hop_limit = 254;
185 oh6_0->ip6.src_address.as_u64[0] = ih6_0->ip6.src_address.as_u64[0];
186 oh6_0->ip6.src_address.as_u64[1] = ih6_0->ip6.src_address.as_u64[1];
187 oh6_0->ip6.dst_address.as_u64[0] = ih6_0->ip6.dst_address.as_u64[0];
188 oh6_0->ip6.dst_address.as_u64[1] = ih6_0->ip6.dst_address.as_u64[1];
189 o_esp0->spi = clib_net_to_host_u32 (sa0->spi);
190 o_esp0->seq = clib_net_to_host_u32 (sa0->seq);
191 ip_proto = ih6_0->ip6.protocol;
193 next[0] = ESP_ENCRYPT_NEXT_IP6_LOOKUP;
197 next_hdr_type = IP_PROTOCOL_IP_IN_IP;
198 oh0 = vlib_buffer_get_current (ob[0]);
199 ouh0 = vlib_buffer_get_current (ob[0]);
201 oh0->ip4.ip_version_and_header_length = 0x45;
202 oh0->ip4.tos = iuh0->ip4.tos;
203 oh0->ip4.fragment_id = 0;
204 oh0->ip4.flags_and_fragment_offset = 0;
208 ouh0->udp.src_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
209 ouh0->udp.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
210 ouh0->udp.checksum = 0;
211 ouh0->ip4.protocol = IP_PROTOCOL_UDP;
212 ip_udp_hdr_size = sizeof (udp_header_t) + sizeof (ip4_header_t);
216 oh0->ip4.protocol = IP_PROTOCOL_IPSEC_ESP;
217 ip_udp_hdr_size = sizeof (ip4_header_t);
219 o_esp0 = vlib_buffer_get_current (ob[0]) + ip_udp_hdr_size;
220 oh0->ip4.src_address.as_u32 = iuh0->ip4.src_address.as_u32;
221 oh0->ip4.dst_address.as_u32 = iuh0->ip4.dst_address.as_u32;
222 o_esp0->spi = clib_net_to_host_u32 (sa0->spi);
223 o_esp0->seq = clib_net_to_host_u32 (sa0->seq);
224 ip_proto = iuh0->ip4.protocol;
226 next[0] = ESP_ENCRYPT_NEXT_IP4_LOOKUP;
229 if (PREDICT_TRUE (!is_ip6 && sa0->is_tunnel && !sa0->is_tunnel_ip6))
231 oh0->ip4.src_address.as_u32 = sa0->tunnel_src_addr.ip4.as_u32;
232 oh0->ip4.dst_address.as_u32 = sa0->tunnel_dst_addr.ip4.as_u32;
234 next[0] = sa0->dpo[IPSEC_PROTOCOL_ESP].dpoi_next_node;
235 vnet_buffer (ob[0])->ip.adj_index[VLIB_TX] =
236 sa0->dpo[IPSEC_PROTOCOL_ESP].dpoi_index;
238 else if (is_ip6 && sa0->is_tunnel && sa0->is_tunnel_ip6)
240 oh6_0->ip6.src_address.as_u64[0] =
241 sa0->tunnel_src_addr.ip6.as_u64[0];
242 oh6_0->ip6.src_address.as_u64[1] =
243 sa0->tunnel_src_addr.ip6.as_u64[1];
244 oh6_0->ip6.dst_address.as_u64[0] =
245 sa0->tunnel_dst_addr.ip6.as_u64[0];
246 oh6_0->ip6.dst_address.as_u64[1] =
247 sa0->tunnel_dst_addr.ip6.as_u64[1];
249 next[0] = sa0->dpo[IPSEC_PROTOCOL_ESP].dpoi_next_node;
250 vnet_buffer (ob[0])->ip.adj_index[VLIB_TX] =
251 sa0->dpo[IPSEC_PROTOCOL_ESP].dpoi_index;
255 next_hdr_type = ip_proto;
256 if (vnet_buffer (ib[0])->sw_if_index[VLIB_TX] != ~0)
259 ethernet_header_t *ieh0, *oeh0;
261 (ethernet_header_t *) ((u8 *)
262 vlib_buffer_get_current (ib[0]) -
263 sizeof (ethernet_header_t));
264 oeh0 = (ethernet_header_t *) ob[0]->data;
265 clib_memcpy_fast (oeh0, ieh0, sizeof (ethernet_header_t));
266 next[0] = ESP_ENCRYPT_NEXT_INTERFACE_OUTPUT;
267 vnet_buffer (ob[0])->sw_if_index[VLIB_TX] =
268 vnet_buffer (ib[0])->sw_if_index[VLIB_TX];
272 vlib_buffer_advance (ib[0], sizeof (ip6_header_t));
274 vlib_buffer_advance (ib[0], sizeof (ip4_header_t));
277 ASSERT (sa0->crypto_alg < IPSEC_CRYPTO_N_ALG);
278 vlib_increment_combined_counter
279 (&ipsec_sa_counters, thread_index, sa_index0,
280 1, ib[0]->current_length);
282 if (PREDICT_TRUE (sa0->crypto_alg != IPSEC_CRYPTO_ALG_NONE))
285 const int BLOCK_SIZE = im->crypto_algs[sa0->crypto_alg].block_size;
286 const int IV_SIZE = im->crypto_algs[sa0->crypto_alg].iv_size;
287 int blocks = 1 + (ib[0]->current_length + 1) / BLOCK_SIZE;
289 /* pad packet in input buffer */
290 u8 pad_bytes = BLOCK_SIZE * blocks - 2 - ib[0]->current_length;
293 vlib_buffer_get_current (ib[0]) + ib[0]->current_length;
294 ib[0]->current_length = BLOCK_SIZE * blocks;
295 for (i = 0; i < pad_bytes; ++i)
299 f0 = vlib_buffer_get_current (ib[0]) + ib[0]->current_length - 2;
300 f0->pad_length = pad_bytes;
301 f0->next_header = next_hdr_type;
303 ob[0]->current_length = ip_udp_hdr_size + sizeof (esp_header_t) +
304 BLOCK_SIZE * blocks + IV_SIZE;
306 vnet_buffer (ob[0])->sw_if_index[VLIB_RX] =
307 vnet_buffer (ib[0])->sw_if_index[VLIB_RX];
309 u8 *iv = vlib_buffer_get_current (ob[0]) + ip_udp_hdr_size +
310 sizeof (esp_header_t);
312 clib_memcpy_fast ((u8 *) vlib_buffer_get_current (ob[0]) +
313 ip_udp_hdr_size + sizeof (esp_header_t), iv,
314 im->crypto_algs[sa0->crypto_alg].iv_size);
316 esp_encrypt_cbc (vm, sa0->crypto_alg,
317 (u8 *) vlib_buffer_get_current (ib[0]),
318 (u8 *) vlib_buffer_get_current (ob[0]) +
319 ip_udp_hdr_size + sizeof (esp_header_t) +
320 IV_SIZE, BLOCK_SIZE * blocks,
321 sa0->crypto_key.data, iv);
324 ob[0]->current_length +=
325 hmac_calc (vm, sa0->integ_alg, sa0->integ_key.data,
326 sa0->integ_key.len, (u8 *) o_esp0,
327 ob[0]->current_length - ip_udp_hdr_size,
328 vlib_buffer_get_current (ob[0]) + ob[0]->current_length,
329 sa0->use_esn, sa0->seq_hi);
334 oh6_0->ip6.payload_length =
335 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, ob[0]) -
336 sizeof (ip6_header_t));
341 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, ob[0]));
342 oh0->ip4.checksum = ip4_header_checksum (&oh0->ip4);
346 clib_host_to_net_u16 (clib_net_to_host_u16
348 ip4_header_bytes (&oh0->ip4));
353 vlib_buffer_reset (ob[0]);
355 if (PREDICT_FALSE (esp_seq_err))
357 ob[0]->error = node->errors[ESP_ENCRYPT_ERROR_SEQ_CYCLED];
358 next[0] = ESP_ENCRYPT_NEXT_DROP;
361 if (PREDICT_FALSE (ib[0]->flags & VLIB_BUFFER_IS_TRACED))
365 ob[0]->flags |= VLIB_BUFFER_IS_TRACED;
366 ob[0]->trace_index = ib[0]->trace_index;
367 esp_encrypt_trace_t *tr =
368 vlib_add_trace (vm, node, ob[0], sizeof (*tr));
369 tr->sa_index = sa_index0;
371 tr->seq = sa0->seq - 1;
372 tr->udp_encap = sa0->udp_encap;
373 tr->crypto_alg = sa0->crypto_alg;
374 tr->integ_alg = sa0->integ_alg;
385 vlib_node_increment_counter (vm, node->node_index,
386 ESP_ENCRYPT_ERROR_RX_PKTS, n_alloc);
388 vlib_buffer_enqueue_to_next (vm, node, new_bufs, nexts, n_alloc);
390 vlib_buffer_free (vm, from, from_frame->n_vectors);
394 VLIB_NODE_FN (esp4_encrypt_node) (vlib_main_t * vm,
395 vlib_node_runtime_t * node,
396 vlib_frame_t * from_frame)
398 return esp_encrypt_inline (vm, node, from_frame, 0 /* is_ip6 */ );
402 VLIB_REGISTER_NODE (esp4_encrypt_node) = {
403 .name = "esp4-encrypt",
404 .vector_size = sizeof (u32),
405 .format_trace = format_esp_encrypt_trace,
406 .type = VLIB_NODE_TYPE_INTERNAL,
408 .n_errors = ARRAY_LEN(esp_encrypt_error_strings),
409 .error_strings = esp_encrypt_error_strings,
411 .n_next_nodes = ESP_ENCRYPT_N_NEXT,
413 #define _(s,n) [ESP_ENCRYPT_NEXT_##s] = n,
414 foreach_esp_encrypt_next
420 VLIB_NODE_FN (esp6_encrypt_node) (vlib_main_t * vm,
421 vlib_node_runtime_t * node,
422 vlib_frame_t * from_frame)
424 return esp_encrypt_inline (vm, node, from_frame, 1 /* is_ip6 */ );
428 VLIB_REGISTER_NODE (esp6_encrypt_node) = {
429 .name = "esp6-encrypt",
430 .vector_size = sizeof (u32),
431 .format_trace = format_esp_encrypt_trace,
432 .type = VLIB_NODE_TYPE_INTERNAL,
434 .n_errors = ARRAY_LEN(esp_encrypt_error_strings),
435 .error_strings = esp_encrypt_error_strings,
437 .n_next_nodes = ESP_ENCRYPT_N_NEXT,
439 #define _(s,n) [ESP_ENCRYPT_NEXT_##s] = n,
440 foreach_esp_encrypt_next
447 * fd.io coding-style-patch-verification: ON
450 * eval: (c-set-style "gnu")