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
  22 #include <vnet/ipsec/ipsec.h>
  23 #include <vnet/ipsec/esp.h>
  24
  25
  26 #define foreach_esp_encrypt_next                   \
  27 _(DROP, "error-drop")                              \
  28 _(IP4_LOOKUP, "ip4-lookup")                        \
  29 _(IP6_LOOKUP, "ip6-lookup")                        \
  30 _(INTERFACE_OUTPUT, "interface-output")
  31
  32 #define _(v, s) ESP_ENCRYPT_NEXT_##v,
  33 typedef enum
  34 {
  35   foreach_esp_encrypt_next
  36 #undef _
  37     ESP_ENCRYPT_N_NEXT,
  38 } esp_encrypt_next_t;
  39
  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")
  45
  46
  47 typedef enum
  48 {
  49 #define _(sym,str) ESP_ENCRYPT_ERROR_##sym,
  50   foreach_esp_encrypt_error
  51 #undef _
  52     ESP_ENCRYPT_N_ERROR,
  53 } esp_encrypt_error_t;
  54
  55 static char *esp_encrypt_error_strings[] = {
  56 #define _(sym,string) string,
  57   foreach_esp_encrypt_error
  58 #undef _
  59 };
  60
  61 vlib_node_registration_t esp_encrypt_node;
  62
  63 typedef struct
  64 {
  65   u32 spi;
  66   u32 seq;
  67   ipsec_crypto_alg_t crypto_alg;
  68   ipsec_integ_alg_t integ_alg;
  69 } esp_encrypt_trace_t;
  70
  71 /* packet trace format function */
  72 static u8 *
  73 format_esp_encrypt_trace (u8 * s, va_list * args)
  74 {
  75   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  76   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  77   esp_encrypt_trace_t *t = va_arg (*args, esp_encrypt_trace_t *);
  78
  79   s = format (s, "esp: spi %u seq %u crypto %U integrity %U",
  80               t->spi, t->seq,
  81               format_ipsec_crypto_alg, t->crypto_alg,
  82               format_ipsec_integ_alg, t->integ_alg);
  83   return s;
  84 }
  85
  86 always_inline void
  87 esp_encrypt_aes_cbc (ipsec_crypto_alg_t alg,
  88                      u8 * in, u8 * out, size_t in_len, u8 * key, u8 * iv)
  89 {
  90   esp_main_t *em = &esp_main;
  91   u32 cpu_index = os_get_cpu_number ();
  92   EVP_CIPHER_CTX *ctx = &(em->per_thread_data[cpu_index].encrypt_ctx);
  93   const EVP_CIPHER *cipher = NULL;
  94   int out_len;
  95
  96   ASSERT (alg < IPSEC_CRYPTO_N_ALG);
  97
  98   if (PREDICT_FALSE (em->esp_crypto_algs[alg].type == IPSEC_CRYPTO_ALG_NONE))
  99     return;
 100
 101   if (PREDICT_FALSE (alg != em->per_thread_data[cpu_index].last_encrypt_alg))
 102     {
 103       cipher = em->esp_crypto_algs[alg].type;
 104       em->per_thread_data[cpu_index].last_encrypt_alg = alg;
 105     }
 106
 107   EVP_EncryptInit_ex (ctx, cipher, NULL, key, iv);
 108
 109   EVP_EncryptUpdate (ctx, out, &out_len, in, in_len);
 110   EVP_EncryptFinal_ex (ctx, out + out_len, &out_len);
 111 }
 112
 113 static uword
 114 esp_encrypt_node_fn (vlib_main_t * vm,
 115                      vlib_node_runtime_t * node, vlib_frame_t * from_frame)
 116 {
 117   u32 n_left_from, *from, *to_next = 0, next_index;
 118   from = vlib_frame_vector_args (from_frame);
 119   n_left_from = from_frame->n_vectors;
 120   ipsec_main_t *im = &ipsec_main;
 121   u32 *recycle = 0;
 122   u32 cpu_index = os_get_cpu_number ();
 123
 124   ipsec_alloc_empty_buffers (vm, im);
 125
 126   u32 *empty_buffers = im->empty_buffers[cpu_index];
 127
 128   if (PREDICT_FALSE (vec_len (empty_buffers) < n_left_from))
 129     {
 130       vlib_node_increment_counter (vm, esp_encrypt_node.index,
 131                                    ESP_ENCRYPT_ERROR_NO_BUFFER, n_left_from);
 132       clib_warning ("no enough empty buffers. discarding frame");
 133       goto free_buffers_and_exit;
 134     }
 135
 136   next_index = node->cached_next_index;
 137
 138   while (n_left_from > 0)
 139     {
 140       u32 n_left_to_next;
 141
 142       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 143
 144       while (n_left_from > 0 && n_left_to_next > 0)
 145         {
 146           u32 i_bi0, o_bi0, next0;
 147           vlib_buffer_t *i_b0, *o_b0 = 0;
 148           u32 sa_index0;
 149           ipsec_sa_t *sa0;
 150           ip4_and_esp_header_t *ih0, *oh0 = 0;
 151           ip6_and_esp_header_t *ih6_0, *oh6_0 = 0;
 152           uword last_empty_buffer;
 153           esp_header_t *o_esp0;
 154           esp_footer_t *f0;
 155           u8 is_ipv6;
 156           u8 ip_hdr_size;
 157           u8 next_hdr_type;
 158           u32 ip_proto = 0;
 159           u8 transport_mode = 0;
 160
 161           i_bi0 = from[0];
 162           from += 1;
 163           n_left_from -= 1;
 164           n_left_to_next -= 1;
 165
 166           next0 = ESP_ENCRYPT_NEXT_DROP;
 167
 168           i_b0 = vlib_get_buffer (vm, i_bi0);
 169           sa_index0 = vnet_buffer (i_b0)->ipsec.sad_index;
 170           sa0 = pool_elt_at_index (im->sad, sa_index0);
 171
 172           if (PREDICT_FALSE (esp_seq_advance (sa0)))
 173             {
 174               clib_warning ("sequence number counter has cycled SPI %u",
 175                             sa0->spi);
 176               vlib_node_increment_counter (vm, esp_encrypt_node.index,
 177                                            ESP_ENCRYPT_ERROR_SEQ_CYCLED, 1);
 178               //TODO: rekey SA
 179               o_bi0 = i_bi0;
 180               to_next[0] = o_bi0;
 181               to_next += 1;
 182               goto trace;
 183             }
 184
 185           sa0->total_data_size += i_b0->current_length;
 186
 187           /* grab free buffer */
 188           last_empty_buffer = vec_len (empty_buffers) - 1;
 189           o_bi0 = empty_buffers[last_empty_buffer];
 190           o_b0 = vlib_get_buffer (vm, o_bi0);
 191           o_b0->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
 192           o_b0->current_data = sizeof (ethernet_header_t);
 193           ih0 = vlib_buffer_get_current (i_b0);
 194           vlib_prefetch_buffer_with_index (vm,
 195                                            empty_buffers[last_empty_buffer -
 196                                                          1], STORE);
 197           _vec_len (empty_buffers) = last_empty_buffer;
 198           to_next[0] = o_bi0;
 199           to_next += 1;
 200
 201           /* add old buffer to the recycle list */
 202           vec_add1 (recycle, i_bi0);
 203
 204           /* is ipv6 */
 205           if (PREDICT_FALSE
 206               ((ih0->ip4.ip_version_and_header_length & 0xF0) == 0x60))
 207             {
 208               is_ipv6 = 1;
 209               ih6_0 = vlib_buffer_get_current (i_b0);
 210               ip_hdr_size = sizeof (ip6_header_t);
 211               next_hdr_type = IP_PROTOCOL_IPV6;
 212               oh6_0 = vlib_buffer_get_current (o_b0);
 213               o_esp0 = vlib_buffer_get_current (o_b0) + sizeof (ip6_header_t);
 214
 215               oh6_0->ip6.ip_version_traffic_class_and_flow_label =
 216                 ih6_0->ip6.ip_version_traffic_class_and_flow_label;
 217               oh6_0->ip6.protocol = IP_PROTOCOL_IPSEC_ESP;
 218               oh6_0->ip6.hop_limit = 254;
 219               oh6_0->ip6.src_address.as_u64[0] =
 220                 ih6_0->ip6.src_address.as_u64[0];
 221               oh6_0->ip6.src_address.as_u64[1] =
 222                 ih6_0->ip6.src_address.as_u64[1];
 223               oh6_0->ip6.dst_address.as_u64[0] =
 224                 ih6_0->ip6.dst_address.as_u64[0];
 225               oh6_0->ip6.dst_address.as_u64[1] =
 226                 ih6_0->ip6.dst_address.as_u64[1];
 227               oh6_0->esp.spi = clib_net_to_host_u32 (sa0->spi);
 228               oh6_0->esp.seq = clib_net_to_host_u32 (sa0->seq);
 229               ip_proto = ih6_0->ip6.protocol;
 230
 231               next0 = ESP_ENCRYPT_NEXT_IP6_LOOKUP;
 232             }
 233           else
 234             {
 235               is_ipv6 = 0;
 236               ip_hdr_size = sizeof (ip4_header_t);
 237               next_hdr_type = IP_PROTOCOL_IP_IN_IP;
 238               oh0 = vlib_buffer_get_current (o_b0);
 239               o_esp0 = vlib_buffer_get_current (o_b0) + sizeof (ip4_header_t);
 240
 241               oh0->ip4.ip_version_and_header_length = 0x45;
 242               oh0->ip4.tos = ih0->ip4.tos;
 243               oh0->ip4.fragment_id = 0;
 244               oh0->ip4.flags_and_fragment_offset = 0;
 245               oh0->ip4.ttl = 254;
 246               oh0->ip4.protocol = IP_PROTOCOL_IPSEC_ESP;
 247               oh0->ip4.src_address.as_u32 = ih0->ip4.src_address.as_u32;
 248               oh0->ip4.dst_address.as_u32 = ih0->ip4.dst_address.as_u32;
 249               oh0->esp.spi = clib_net_to_host_u32 (sa0->spi);
 250               oh0->esp.seq = clib_net_to_host_u32 (sa0->seq);
 251               ip_proto = ih0->ip4.protocol;
 252
 253               next0 = ESP_ENCRYPT_NEXT_IP4_LOOKUP;
 254             }
 255
 256           if (PREDICT_TRUE
 257               (!is_ipv6 && sa0->is_tunnel && !sa0->is_tunnel_ip6))
 258             {
 259               oh0->ip4.src_address.as_u32 = sa0->tunnel_src_addr.ip4.as_u32;
 260               oh0->ip4.dst_address.as_u32 = sa0->tunnel_dst_addr.ip4.as_u32;
 261
 262               vnet_buffer (o_b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
 263             }
 264           else if (is_ipv6 && sa0->is_tunnel && sa0->is_tunnel_ip6)
 265             {
 266               oh6_0->ip6.src_address.as_u64[0] =
 267                 sa0->tunnel_src_addr.ip6.as_u64[0];
 268               oh6_0->ip6.src_address.as_u64[1] =
 269                 sa0->tunnel_src_addr.ip6.as_u64[1];
 270               oh6_0->ip6.dst_address.as_u64[0] =
 271                 sa0->tunnel_dst_addr.ip6.as_u64[0];
 272               oh6_0->ip6.dst_address.as_u64[1] =
 273                 sa0->tunnel_dst_addr.ip6.as_u64[1];
 274
 275               vnet_buffer (o_b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
 276             }
 277           else
 278             {
 279               next_hdr_type = ip_proto;
 280               if (vnet_buffer (i_b0)->sw_if_index[VLIB_TX] != ~0)
 281                 {
 282                   transport_mode = 1;
 283                   ethernet_header_t *ieh0, *oeh0;
 284                   ieh0 =
 285                     (ethernet_header_t *) ((u8 *)
 286                                            vlib_buffer_get_current (i_b0) -
 287                                            sizeof (ethernet_header_t));
 288                   oeh0 = (ethernet_header_t *) o_b0->data;
 289                   clib_memcpy (oeh0, ieh0, sizeof (ethernet_header_t));
 290                   next0 = ESP_ENCRYPT_NEXT_INTERFACE_OUTPUT;
 291                   vnet_buffer (o_b0)->sw_if_index[VLIB_TX] =
 292                     vnet_buffer (i_b0)->sw_if_index[VLIB_TX];
 293                 }
 294               vlib_buffer_advance (i_b0, ip_hdr_size);
 295             }
 296
 297           ASSERT (sa0->crypto_alg < IPSEC_CRYPTO_N_ALG);
 298
 299           if (PREDICT_TRUE (sa0->crypto_alg != IPSEC_CRYPTO_ALG_NONE))
 300             {
 301
 302               const int BLOCK_SIZE = 16;
 303               const int IV_SIZE = 16;
 304               int blocks = 1 + (i_b0->current_length + 1) / BLOCK_SIZE;
 305
 306               /* pad packet in input buffer */
 307               u8 pad_bytes = BLOCK_SIZE * blocks - 2 - i_b0->current_length;
 308               u8 i;
 309               u8 *padding =
 310                 vlib_buffer_get_current (i_b0) + i_b0->current_length;
 311               i_b0->current_length = BLOCK_SIZE * blocks;
 312               for (i = 0; i < pad_bytes; ++i)
 313                 {
 314                   padding[i] = i + 1;
 315                 }
 316               f0 = vlib_buffer_get_current (i_b0) + i_b0->current_length - 2;
 317               f0->pad_length = pad_bytes;
 318               f0->next_header = next_hdr_type;
 319
 320               o_b0->current_length = ip_hdr_size + sizeof (esp_header_t) +
 321                 BLOCK_SIZE * blocks + IV_SIZE;
 322
 323               vnet_buffer (o_b0)->sw_if_index[VLIB_RX] =
 324                 vnet_buffer (i_b0)->sw_if_index[VLIB_RX];
 325
 326               u8 iv[16];
 327               RAND_bytes (iv, sizeof (iv));
 328
 329               clib_memcpy ((u8 *) vlib_buffer_get_current (o_b0) +
 330                            ip_hdr_size + sizeof (esp_header_t), iv, 16);
 331
 332               esp_encrypt_aes_cbc (sa0->crypto_alg,
 333                                    (u8 *) vlib_buffer_get_current (i_b0),
 334                                    (u8 *) vlib_buffer_get_current (o_b0) +
 335                                    ip_hdr_size + sizeof (esp_header_t) +
 336                                    IV_SIZE, BLOCK_SIZE * blocks,
 337                                    sa0->crypto_key, iv);
 338             }
 339
 340           o_b0->current_length += hmac_calc (sa0->integ_alg, sa0->integ_key,
 341                                              sa0->integ_key_len,
 342                                              (u8 *) o_esp0,
 343                                              o_b0->current_length -
 344                                              ip_hdr_size,
 345                                              vlib_buffer_get_current (o_b0) +
 346                                              o_b0->current_length,
 347                                              sa0->use_esn, sa0->seq_hi);
 348
 349
 350           if (PREDICT_FALSE (is_ipv6))
 351             {
 352               oh6_0->ip6.payload_length =
 353                 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, o_b0) -
 354                                       sizeof (ip6_header_t));
 355             }
 356           else
 357             {
 358               oh0->ip4.length =
 359                 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, o_b0));
 360               oh0->ip4.checksum = ip4_header_checksum (&oh0->ip4);
 361             }
 362
 363           if (transport_mode)
 364             vlib_buffer_reset (o_b0);
 365
 366         trace:
 367           if (PREDICT_FALSE (i_b0->flags & VLIB_BUFFER_IS_TRACED))
 368             {
 369               if (o_b0)
 370                 {
 371                   o_b0->flags |= VLIB_BUFFER_IS_TRACED;
 372                   o_b0->trace_index = i_b0->trace_index;
 373                   esp_encrypt_trace_t *tr =
 374                     vlib_add_trace (vm, node, o_b0, sizeof (*tr));
 375                   tr->spi = sa0->spi;
 376                   tr->seq = sa0->seq - 1;
 377                   tr->crypto_alg = sa0->crypto_alg;
 378                   tr->integ_alg = sa0->integ_alg;
 379                 }
 380             }
 381
 382           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 383                                            to_next, n_left_to_next, o_bi0,
 384                                            next0);
 385         }
 386       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 387     }
 388   vlib_node_increment_counter (vm, esp_encrypt_node.index,
 389                                ESP_ENCRYPT_ERROR_RX_PKTS,
 390                                from_frame->n_vectors);
 391
 392 free_buffers_and_exit:
 393   if (recycle)
 394     vlib_buffer_free (vm, recycle, vec_len (recycle));
 395   vec_free (recycle);
 396   return from_frame->n_vectors;
 397 }
 398
 399
 400 /* *INDENT-OFF* */
 401 VLIB_REGISTER_NODE (esp_encrypt_node) = {
 402   .function = esp_encrypt_node_fn,
 403   .name = "esp-encrypt",
 404   .vector_size = sizeof (u32),
 405   .format_trace = format_esp_encrypt_trace,
 406   .type = VLIB_NODE_TYPE_INTERNAL,
 407
 408   .n_errors = ARRAY_LEN(esp_encrypt_error_strings),
 409   .error_strings = esp_encrypt_error_strings,
 410
 411   .n_next_nodes = ESP_ENCRYPT_N_NEXT,
 412   .next_nodes = {
 413 #define _(s,n) [ESP_ENCRYPT_NEXT_##s] = n,
 414     foreach_esp_encrypt_next
 415 #undef _
 416   },
 417 };
 418 /* *INDENT-ON* */
 419
 420 VLIB_NODE_FUNCTION_MULTIARCH (esp_encrypt_node, esp_encrypt_node_fn)
 421 /*
 422  * fd.io coding-style-patch-verification: ON
 423  *
 424  * Local Variables:
 425  * eval: (c-set-style "gnu")
 426  * End:
 427  */