src/vnet/ipsec/esp_encrypt.c

   1 /*
   2  * esp_encrypt.c : IPSec ESP encrypt 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/udp/udp.h>
  22
  23 #include <vnet/crypto/crypto.h>
  24
  25 #include <vnet/ipsec/ipsec.h>
  26 #include <vnet/ipsec/esp.h>
  27
  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")
  33
  34 #define _(v, s) ESP_ENCRYPT_NEXT_##v,
  35 typedef enum
  36 {
  37   foreach_esp_encrypt_next
  38 #undef _
  39     ESP_ENCRYPT_N_NEXT,
  40 } esp_encrypt_next_t;
  41
  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")
  47
  48
  49 typedef enum
  50 {
  51 #define _(sym,str) ESP_ENCRYPT_ERROR_##sym,
  52   foreach_esp_encrypt_error
  53 #undef _
  54     ESP_ENCRYPT_N_ERROR,
  55 } esp_encrypt_error_t;
  56
  57 static char *esp_encrypt_error_strings[] = {
  58 #define _(sym,string) string,
  59   foreach_esp_encrypt_error
  60 #undef _
  61 };
  62
  63 typedef struct
  64 {
  65   u32 sa_index;
  66   u32 spi;
  67   u32 seq;
  68   u8 udp_encap;
  69   ipsec_crypto_alg_t crypto_alg;
  70   ipsec_integ_alg_t integ_alg;
  71 } esp_encrypt_trace_t;
  72
  73 /* packet trace format function */
  74 static u8 *
  75 format_esp_encrypt_trace (u8 * s, va_list * args)
  76 {
  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 *);
  80
  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" : "");
  86   return s;
  87 }
  88
  89 always_inline void
  90 esp_encrypt_cbc (vlib_main_t * vm, ipsec_sa_t * sa,
  91                  u8 * in, u8 * out, size_t in_len, u8 * key, u8 * iv)
  92 {
  93   vnet_crypto_op_t _op, *op = &_op;
  94
  95
  96   if (PREDICT_FALSE (sa->crypto_enc_op_type == VNET_CRYPTO_OP_NONE))
  97     return;
  98
  99   op->op = sa->crypto_enc_op_type;
 100   op->flags = VNET_CRYPTO_OP_FLAG_INIT_IV;
 101   op->iv = iv;
 102   op->src = in;
 103   op->dst = out;
 104   op->len = in_len;
 105   op->key = key;
 106
 107   vnet_crypto_process_ops (vm, op, 1);
 108 }
 109
 110 always_inline uword
 111 esp_encrypt_inline (vlib_main_t * vm,
 112                     vlib_node_runtime_t * node, vlib_frame_t * from_frame,
 113                     int is_ip6)
 114 {
 115   u32 *from = vlib_frame_vector_args (from_frame);
 116   u32 n_left_from = from_frame->n_vectors;
 117   ipsec_main_t *im = &ipsec_main;
 118   u32 new_bufs[VLIB_FRAME_SIZE];
 119   vlib_buffer_t *i_bufs[VLIB_FRAME_SIZE], **ib = i_bufs;
 120   vlib_buffer_t *o_bufs[VLIB_FRAME_SIZE], **ob = o_bufs;
 121   u16 nexts[VLIB_FRAME_SIZE], *next = nexts;
 122   u32 n_alloc, thread_index = vm->thread_index;
 123
 124   n_alloc = vlib_buffer_alloc (vm, new_bufs, n_left_from);
 125   if (n_alloc != n_left_from)
 126     {
 127       vlib_node_increment_counter (vm, node->node_index,
 128                                    ESP_ENCRYPT_ERROR_NO_BUFFER,
 129                                    n_left_from - n_alloc);
 130       if (n_alloc == 0)
 131         goto done;
 132       n_left_from = n_alloc;
 133     }
 134
 135   vlib_get_buffers (vm, from, ib, n_left_from);
 136   vlib_get_buffers (vm, new_bufs, ob, n_left_from);
 137
 138   while (n_left_from > 0)
 139     {
 140       u32 sa_index0;
 141       ipsec_sa_t *sa0;
 142       ip4_and_esp_header_t *oh0 = 0;
 143       ip6_and_esp_header_t *ih6_0, *oh6_0 = 0;
 144       ip4_and_udp_and_esp_header_t *iuh0, *ouh0 = 0;
 145       esp_header_t *o_esp0;
 146       esp_footer_t *f0;
 147       u8 ip_udp_hdr_size;
 148       u8 next_hdr_type;
 149       u32 ip_proto = 0;
 150       u8 transport_mode = 0;
 151       u32 esp_seq_err;
 152
 153       next[0] = ESP_ENCRYPT_NEXT_DROP;
 154
 155       sa_index0 = vnet_buffer (ib[0])->ipsec.sad_index;
 156       sa0 = pool_elt_at_index (im->sad, sa_index0);
 157
 158       vlib_prefetch_combined_counter (&ipsec_sa_counters, thread_index,
 159                                       sa_index0);
 160
 161       esp_seq_err = esp_seq_advance (sa0);
 162
 163       /* grab free buffer */
 164       ob[0]->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
 165       ob[0]->current_data = sizeof (ethernet_header_t);
 166       iuh0 = vlib_buffer_get_current (ib[0]);
 167
 168       if (is_ip6)
 169         {
 170           ih6_0 = vlib_buffer_get_current (ib[0]);
 171           next_hdr_type = IP_PROTOCOL_IPV6;
 172           oh6_0 = vlib_buffer_get_current (ob[0]);
 173
 174           oh6_0->ip6.ip_version_traffic_class_and_flow_label =
 175             ih6_0->ip6.ip_version_traffic_class_and_flow_label;
 176           oh6_0->ip6.protocol = IP_PROTOCOL_IPSEC_ESP;
 177           ip_udp_hdr_size = sizeof (ip6_header_t);
 178           o_esp0 = vlib_buffer_get_current (ob[0]) + ip_udp_hdr_size;
 179           oh6_0->ip6.hop_limit = 254;
 180           oh6_0->ip6.src_address.as_u64[0] = ih6_0->ip6.src_address.as_u64[0];
 181           oh6_0->ip6.src_address.as_u64[1] = ih6_0->ip6.src_address.as_u64[1];
 182           oh6_0->ip6.dst_address.as_u64[0] = ih6_0->ip6.dst_address.as_u64[0];
 183           oh6_0->ip6.dst_address.as_u64[1] = ih6_0->ip6.dst_address.as_u64[1];
 184           o_esp0->spi = clib_net_to_host_u32 (sa0->spi);
 185           o_esp0->seq = clib_net_to_host_u32 (sa0->seq);
 186           ip_proto = ih6_0->ip6.protocol;
 187
 188           next[0] = ESP_ENCRYPT_NEXT_IP6_LOOKUP;
 189         }
 190       else
 191         {
 192           next_hdr_type = IP_PROTOCOL_IP_IN_IP;
 193           oh0 = vlib_buffer_get_current (ob[0]);
 194           ouh0 = vlib_buffer_get_current (ob[0]);
 195
 196           oh0->ip4.ip_version_and_header_length = 0x45;
 197           oh0->ip4.tos = iuh0->ip4.tos;
 198           oh0->ip4.fragment_id = 0;
 199           oh0->ip4.flags_and_fragment_offset = 0;
 200           oh0->ip4.ttl = 254;
 201           if (sa0->udp_encap)
 202             {
 203               ouh0->udp.src_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
 204               ouh0->udp.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
 205               ouh0->udp.checksum = 0;
 206               ouh0->ip4.protocol = IP_PROTOCOL_UDP;
 207               ip_udp_hdr_size = sizeof (udp_header_t) + sizeof (ip4_header_t);
 208             }
 209           else
 210             {
 211               oh0->ip4.protocol = IP_PROTOCOL_IPSEC_ESP;
 212               ip_udp_hdr_size = sizeof (ip4_header_t);
 213             }
 214           o_esp0 = vlib_buffer_get_current (ob[0]) + ip_udp_hdr_size;
 215           oh0->ip4.src_address.as_u32 = iuh0->ip4.src_address.as_u32;
 216           oh0->ip4.dst_address.as_u32 = iuh0->ip4.dst_address.as_u32;
 217           o_esp0->spi = clib_net_to_host_u32 (sa0->spi);
 218           o_esp0->seq = clib_net_to_host_u32 (sa0->seq);
 219           ip_proto = iuh0->ip4.protocol;
 220
 221           next[0] = ESP_ENCRYPT_NEXT_IP4_LOOKUP;
 222         }
 223
 224       if (PREDICT_TRUE (!is_ip6 && sa0->is_tunnel && !sa0->is_tunnel_ip6))
 225         {
 226           oh0->ip4.src_address.as_u32 = sa0->tunnel_src_addr.ip4.as_u32;
 227           oh0->ip4.dst_address.as_u32 = sa0->tunnel_dst_addr.ip4.as_u32;
 228
 229           next[0] = sa0->dpo[IPSEC_PROTOCOL_ESP].dpoi_next_node;
 230           vnet_buffer (ob[0])->ip.adj_index[VLIB_TX] =
 231             sa0->dpo[IPSEC_PROTOCOL_ESP].dpoi_index;
 232         }
 233       else if (is_ip6 && sa0->is_tunnel && sa0->is_tunnel_ip6)
 234         {
 235           oh6_0->ip6.src_address.as_u64[0] =
 236             sa0->tunnel_src_addr.ip6.as_u64[0];
 237           oh6_0->ip6.src_address.as_u64[1] =
 238             sa0->tunnel_src_addr.ip6.as_u64[1];
 239           oh6_0->ip6.dst_address.as_u64[0] =
 240             sa0->tunnel_dst_addr.ip6.as_u64[0];
 241           oh6_0->ip6.dst_address.as_u64[1] =
 242             sa0->tunnel_dst_addr.ip6.as_u64[1];
 243
 244           next[0] = sa0->dpo[IPSEC_PROTOCOL_ESP].dpoi_next_node;
 245           vnet_buffer (ob[0])->ip.adj_index[VLIB_TX] =
 246             sa0->dpo[IPSEC_PROTOCOL_ESP].dpoi_index;
 247         }
 248       else
 249         {
 250           next_hdr_type = ip_proto;
 251           if (vnet_buffer (ib[0])->sw_if_index[VLIB_TX] != ~0)
 252             {
 253               transport_mode = 1;
 254               ethernet_header_t *ieh0, *oeh0;
 255               ieh0 =
 256                 (ethernet_header_t *) ((u8 *)
 257                                        vlib_buffer_get_current (ib[0]) -
 258                                        sizeof (ethernet_header_t));
 259               oeh0 = (ethernet_header_t *) ob[0]->data;
 260               clib_memcpy_fast (oeh0, ieh0, sizeof (ethernet_header_t));
 261               next[0] = ESP_ENCRYPT_NEXT_INTERFACE_OUTPUT;
 262               vnet_buffer (ob[0])->sw_if_index[VLIB_TX] =
 263                 vnet_buffer (ib[0])->sw_if_index[VLIB_TX];
 264             }
 265
 266           if (is_ip6)
 267             vlib_buffer_advance (ib[0], sizeof (ip6_header_t));
 268           else
 269             vlib_buffer_advance (ib[0], sizeof (ip4_header_t));
 270         }
 271
 272       ASSERT (sa0->crypto_alg < IPSEC_CRYPTO_N_ALG);
 273       vlib_increment_combined_counter
 274         (&ipsec_sa_counters, thread_index, sa_index0,
 275          1, ib[0]->current_length);
 276
 277       if (PREDICT_TRUE (sa0->crypto_alg != IPSEC_CRYPTO_ALG_NONE))
 278         {
 279
 280           const int BLOCK_SIZE = sa0->crypto_block_size;
 281           const int IV_SIZE = sa0->crypto_iv_size;
 282           int blocks = 1 + (ib[0]->current_length + 1) / BLOCK_SIZE;
 283
 284           /* pad packet in input buffer */
 285           u8 pad_bytes = BLOCK_SIZE * blocks - 2 - ib[0]->current_length;
 286           u8 i;
 287           u8 *padding =
 288             vlib_buffer_get_current (ib[0]) + ib[0]->current_length;
 289           ib[0]->current_length = BLOCK_SIZE * blocks;
 290           for (i = 0; i < pad_bytes; ++i)
 291             {
 292               padding[i] = i + 1;
 293             }
 294           f0 = vlib_buffer_get_current (ib[0]) + ib[0]->current_length - 2;
 295           f0->pad_length = pad_bytes;
 296           f0->next_header = next_hdr_type;
 297
 298           ob[0]->current_length = ip_udp_hdr_size + sizeof (esp_header_t) +
 299             BLOCK_SIZE * blocks + IV_SIZE;
 300
 301           vnet_buffer (ob[0])->sw_if_index[VLIB_RX] =
 302             vnet_buffer (ib[0])->sw_if_index[VLIB_RX];
 303
 304           u8 *iv = vlib_buffer_get_current (ob[0]) + ip_udp_hdr_size +
 305             sizeof (esp_header_t);
 306
 307           clib_memcpy_fast ((u8 *) vlib_buffer_get_current (ob[0]) +
 308                             ip_udp_hdr_size + sizeof (esp_header_t), iv,
 309                             IV_SIZE);
 310
 311           esp_encrypt_cbc (vm, sa0, (u8 *) vlib_buffer_get_current (ib[0]),
 312                            (u8 *) vlib_buffer_get_current (ob[0]) +
 313                            ip_udp_hdr_size + sizeof (esp_header_t) +
 314                            IV_SIZE, BLOCK_SIZE * blocks,
 315                            sa0->crypto_key.data, iv);
 316         }
 317
 318       ob[0]->current_length +=
 319         hmac_calc (vm, sa0, (u8 *) o_esp0,
 320                    ob[0]->current_length - ip_udp_hdr_size,
 321                    vlib_buffer_get_current (ob[0]) + ob[0]->current_length);
 322
 323
 324       if (is_ip6)
 325         {
 326           oh6_0->ip6.payload_length =
 327             clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, ob[0]) -
 328                                   sizeof (ip6_header_t));
 329         }
 330       else
 331         {
 332           oh0->ip4.length =
 333             clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, ob[0]));
 334           oh0->ip4.checksum = ip4_header_checksum (&oh0->ip4);
 335           if (sa0->udp_encap)
 336             {
 337               ouh0->udp.length =
 338                 clib_host_to_net_u16 (clib_net_to_host_u16
 339                                       (oh0->ip4.length) -
 340                                       ip4_header_bytes (&oh0->ip4));
 341             }
 342         }
 343
 344       if (transport_mode)
 345         vlib_buffer_reset (ob[0]);
 346
 347       if (PREDICT_FALSE (esp_seq_err))
 348         {
 349           ob[0]->error = node->errors[ESP_ENCRYPT_ERROR_SEQ_CYCLED];
 350           next[0] = ESP_ENCRYPT_NEXT_DROP;
 351         }
 352
 353       if (PREDICT_FALSE (ib[0]->flags & VLIB_BUFFER_IS_TRACED))
 354         {
 355           if (ob[0])
 356             {
 357               ob[0]->flags |= VLIB_BUFFER_IS_TRACED;
 358               ob[0]->trace_index = ib[0]->trace_index;
 359               esp_encrypt_trace_t *tr =
 360                 vlib_add_trace (vm, node, ob[0], sizeof (*tr));
 361               tr->sa_index = sa_index0;
 362               tr->spi = sa0->spi;
 363               tr->seq = sa0->seq - 1;
 364               tr->udp_encap = sa0->udp_encap;
 365               tr->crypto_alg = sa0->crypto_alg;
 366               tr->integ_alg = sa0->integ_alg;
 367             }
 368         }
 369
 370       /* next */
 371       n_left_from -= 1;
 372       ib += 1;
 373       ob += 1;
 374       next += 1;
 375     }
 376
 377   vlib_node_increment_counter (vm, node->node_index,
 378                                ESP_ENCRYPT_ERROR_RX_PKTS, n_alloc);
 379
 380   vlib_buffer_enqueue_to_next (vm, node, new_bufs, nexts, n_alloc);
 381 done:
 382   vlib_buffer_free (vm, from, from_frame->n_vectors);
 383   return n_alloc;
 384 }
 385
 386 VLIB_NODE_FN (esp4_encrypt_node) (vlib_main_t * vm,
 387                                   vlib_node_runtime_t * node,
 388                                   vlib_frame_t * from_frame)
 389 {
 390   return esp_encrypt_inline (vm, node, from_frame, 0 /* is_ip6 */ );
 391 }
 392
 393 /* *INDENT-OFF* */
 394 VLIB_REGISTER_NODE (esp4_encrypt_node) = {
 395   .name = "esp4-encrypt",
 396   .vector_size = sizeof (u32),
 397   .format_trace = format_esp_encrypt_trace,
 398   .type = VLIB_NODE_TYPE_INTERNAL,
 399
 400   .n_errors = ARRAY_LEN(esp_encrypt_error_strings),
 401   .error_strings = esp_encrypt_error_strings,
 402
 403   .n_next_nodes = ESP_ENCRYPT_N_NEXT,
 404   .next_nodes = {
 405 #define _(s,n) [ESP_ENCRYPT_NEXT_##s] = n,
 406     foreach_esp_encrypt_next
 407 #undef _
 408   },
 409 };
 410 /* *INDENT-ON* */
 411
 412 VLIB_NODE_FN (esp6_encrypt_node) (vlib_main_t * vm,
 413                                   vlib_node_runtime_t * node,
 414                                   vlib_frame_t * from_frame)
 415 {
 416   return esp_encrypt_inline (vm, node, from_frame, 1 /* is_ip6 */ );
 417 }
 418
 419 /* *INDENT-OFF* */
 420 VLIB_REGISTER_NODE (esp6_encrypt_node) = {
 421   .name = "esp6-encrypt",
 422   .vector_size = sizeof (u32),
 423   .format_trace = format_esp_encrypt_trace,
 424   .type = VLIB_NODE_TYPE_INTERNAL,
 425
 426   .n_errors = ARRAY_LEN(esp_encrypt_error_strings),
 427   .error_strings = esp_encrypt_error_strings,
 428
 429   .n_next_nodes = ESP_ENCRYPT_N_NEXT,
 430   .next_nodes = {
 431 #define _(s,n) [ESP_ENCRYPT_NEXT_##s] = n,
 432     foreach_esp_encrypt_next
 433 #undef _
 434   },
 435 };
 436 /* *INDENT-ON* */
 437
 438 /*
 439  * fd.io coding-style-patch-verification: ON
 440  *
 441  * Local Variables:
 442  * eval: (c-set-style "gnu")
 443  * End:
 444  */