src/vnet/ipsec/ah_decrypt.c

   1 /*
   2  * ah_decrypt.c : IPSec AH decrypt 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 #include <vnet/ipsec/ah.h>
  25 #include <vnet/ipsec/ipsec_io.h>
  26
  27 #define foreach_ah_decrypt_next \
  28   _ (DROP, "error-drop")        \
  29   _ (IP4_INPUT, "ip4-input")    \
  30   _ (IP6_INPUT, "ip6-input")    \
  31   _ (IPSEC_GRE_INPUT, "ipsec-gre-input")
  32
  33 #define _(v, s) AH_DECRYPT_NEXT_##v,
  34 typedef enum
  35 {
  36   foreach_ah_decrypt_next
  37 #undef _
  38     AH_DECRYPT_N_NEXT,
  39 } ah_decrypt_next_t;
  40
  41 #define foreach_ah_decrypt_error                \
  42   _ (RX_PKTS, "AH pkts received")               \
  43   _ (DECRYPTION_FAILED, "AH decryption failed") \
  44   _ (INTEG_ERROR, "Integrity check failed")     \
  45   _ (REPLAY, "SA replayed packet")
  46
  47 typedef enum
  48 {
  49 #define _(sym,str) AH_DECRYPT_ERROR_##sym,
  50   foreach_ah_decrypt_error
  51 #undef _
  52     AH_DECRYPT_N_ERROR,
  53 } ah_decrypt_error_t;
  54
  55 static char *ah_decrypt_error_strings[] = {
  56 #define _(sym,string) string,
  57   foreach_ah_decrypt_error
  58 #undef _
  59 };
  60
  61 typedef struct
  62 {
  63   ipsec_integ_alg_t integ_alg;
  64   u32 seq_num;
  65 } ah_decrypt_trace_t;
  66
  67 /* packet trace format function */
  68 static u8 *
  69 format_ah_decrypt_trace (u8 * s, va_list * args)
  70 {
  71   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  72   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  73   ah_decrypt_trace_t *t = va_arg (*args, ah_decrypt_trace_t *);
  74
  75   s = format (s, "ah: integrity %U seq-num %d",
  76               format_ipsec_integ_alg, t->integ_alg, t->seq_num);
  77   return s;
  78 }
  79
  80 always_inline uword
  81 ah_decrypt_inline (vlib_main_t * vm,
  82                    vlib_node_runtime_t * node, vlib_frame_t * from_frame,
  83                    int is_ip6)
  84 {
  85   u32 n_left_from, *from, next_index, *to_next, thread_index;
  86   ipsec_main_t *im = &ipsec_main;
  87   from = vlib_frame_vector_args (from_frame);
  88   n_left_from = from_frame->n_vectors;
  89   int icv_size;
  90
  91   next_index = node->cached_next_index;
  92   thread_index = vm->thread_index;
  93
  94   while (n_left_from > 0)
  95     {
  96       u32 n_left_to_next;
  97
  98       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
  99
 100       while (n_left_from > 0 && n_left_to_next > 0)
 101         {
 102           u32 i_bi0;
 103           u32 next0;
 104           vlib_buffer_t *i_b0;
 105           ah_header_t *ah0;
 106           ipsec_sa_t *sa0;
 107           u32 sa_index0 = ~0;
 108           u32 seq;
 109           ip4_header_t *ih4 = 0, *oh4 = 0;
 110           ip6_header_t *ih6 = 0, *oh6 = 0;
 111           u8 ip_hdr_size = 0;
 112           u8 tos = 0;
 113           u8 ttl = 0;
 114           u32 ip_version_traffic_class_and_flow_label = 0;
 115           u8 hop_limit = 0;
 116           u8 nexthdr = 0;
 117           u8 icv_padding_len = 0;
 118
 119
 120           i_bi0 = from[0];
 121           from += 1;
 122           n_left_from -= 1;
 123           n_left_to_next -= 1;
 124
 125           next0 = AH_DECRYPT_NEXT_DROP;
 126
 127           i_b0 = vlib_get_buffer (vm, i_bi0);
 128           to_next[0] = i_bi0;
 129           to_next += 1;
 130           ih4 = vlib_buffer_get_current (i_b0);
 131           ih6 = vlib_buffer_get_current (i_b0);
 132           sa_index0 = vnet_buffer (i_b0)->ipsec.sad_index;
 133           sa0 = pool_elt_at_index (im->sad, sa_index0);
 134
 135           vlib_prefetch_combined_counter (&ipsec_sa_counters,
 136                                           thread_index, sa_index0);
 137
 138           if (is_ip6)
 139             {
 140               ip6_ext_header_t *prev = NULL;
 141               ip6_ext_header_find_t (ih6, prev, ah0, IP_PROTOCOL_IPSEC_AH);
 142               ip_hdr_size = sizeof (ip6_header_t);
 143               ASSERT ((u8 *) ah0 - (u8 *) ih6 == ip_hdr_size);
 144             }
 145           else
 146             {
 147               ip_hdr_size = ip4_header_bytes (ih4);
 148               ah0 = (ah_header_t *) ((u8 *) ih4 + ip_hdr_size);
 149             }
 150
 151           seq = clib_host_to_net_u32 (ah0->seq_no);
 152
 153           /* anti-replay check */
 154           if (sa0->use_anti_replay)
 155             {
 156               int rv = 0;
 157
 158               if (PREDICT_TRUE (sa0->use_esn))
 159                 rv = esp_replay_check_esn (sa0, seq);
 160               else
 161                 rv = esp_replay_check (sa0, seq);
 162
 163               if (PREDICT_FALSE (rv))
 164                 {
 165                   vlib_node_increment_counter (vm, node->node_index,
 166                                                AH_DECRYPT_ERROR_REPLAY, 1);
 167                   goto trace;
 168                 }
 169             }
 170
 171           vlib_increment_combined_counter
 172             (&ipsec_sa_counters, thread_index, sa_index0,
 173              1, i_b0->current_length);
 174
 175           icv_size = im->integ_algs[sa0->integ_alg].trunc_size;
 176           if (PREDICT_TRUE (sa0->integ_alg != IPSEC_INTEG_ALG_NONE))
 177             {
 178               u8 sig[64];
 179               u8 digest[icv_size];
 180               u8 *icv = ah0->auth_data;
 181               memcpy (digest, icv, icv_size);
 182               clib_memset (icv, 0, icv_size);
 183
 184               if (is_ip6)
 185                 {
 186                   ip_version_traffic_class_and_flow_label =
 187                     ih6->ip_version_traffic_class_and_flow_label;
 188                   hop_limit = ih6->hop_limit;
 189                   ih6->ip_version_traffic_class_and_flow_label = 0x60;
 190                   ih6->hop_limit = 0;
 191                   nexthdr = ah0->nexthdr;
 192                   icv_padding_len =
 193                     ah_calc_icv_padding_len (icv_size, 1 /* is_ipv6 */ );
 194                 }
 195               else
 196                 {
 197                   tos = ih4->tos;
 198                   ttl = ih4->ttl;
 199                   ih4->tos = 0;
 200                   ih4->ttl = 0;
 201                   ih4->checksum = 0;
 202                   ih4->flags_and_fragment_offset = 0;
 203                   icv_padding_len =
 204                     ah_calc_icv_padding_len (icv_size, 0 /* is_ipv6 */ );
 205                 }
 206               hmac_calc (vm, sa0->integ_alg, sa0->integ_key.data,
 207                          sa0->integ_key.len, (u8 *) ih4, i_b0->current_length,
 208                          sig, sa0->use_esn, sa0->seq_hi);
 209
 210               if (PREDICT_FALSE (memcmp (digest, sig, icv_size)))
 211                 {
 212                   vlib_node_increment_counter (vm, node->node_index,
 213                                                AH_DECRYPT_ERROR_INTEG_ERROR,
 214                                                1);
 215                   goto trace;
 216                 }
 217
 218               if (PREDICT_TRUE (sa0->use_anti_replay))
 219                 {
 220                   if (PREDICT_TRUE (sa0->use_esn))
 221                     esp_replay_advance_esn (sa0, seq);
 222                   else
 223                     esp_replay_advance (sa0, seq);
 224                 }
 225
 226             }
 227
 228           vlib_buffer_advance (i_b0,
 229                                ip_hdr_size + sizeof (ah_header_t) + icv_size +
 230                                icv_padding_len);
 231           i_b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
 232
 233           if (PREDICT_TRUE (sa0->is_tunnel))
 234             {                   /* tunnel mode */
 235               if (PREDICT_TRUE (ah0->nexthdr == IP_PROTOCOL_IP_IN_IP))
 236                 next0 = AH_DECRYPT_NEXT_IP4_INPUT;
 237               else if (ah0->nexthdr == IP_PROTOCOL_IPV6)
 238                 next0 = AH_DECRYPT_NEXT_IP6_INPUT;
 239               else
 240                 {
 241                   vlib_node_increment_counter (vm, node->node_index,
 242                                                AH_DECRYPT_ERROR_DECRYPTION_FAILED,
 243                                                1);
 244                   goto trace;
 245                 }
 246             }
 247           else
 248             {                   /* transport mode */
 249               if (is_ip6)
 250                 {
 251                   vlib_buffer_advance (i_b0, -sizeof (ip6_header_t));
 252                   oh6 = vlib_buffer_get_current (i_b0);
 253                   memmove (oh6, ih6, sizeof (ip6_header_t));
 254
 255                   next0 = AH_DECRYPT_NEXT_IP6_INPUT;
 256                   oh6->protocol = nexthdr;
 257                   oh6->hop_limit = hop_limit;
 258                   oh6->ip_version_traffic_class_and_flow_label =
 259                     ip_version_traffic_class_and_flow_label;
 260                   oh6->payload_length =
 261                     clib_host_to_net_u16 (vlib_buffer_length_in_chain
 262                                           (vm, i_b0) - sizeof (ip6_header_t));
 263                 }
 264               else
 265                 {
 266                   vlib_buffer_advance (i_b0, -sizeof (ip4_header_t));
 267                   oh4 = vlib_buffer_get_current (i_b0);
 268                   memmove (oh4, ih4, sizeof (ip4_header_t));
 269
 270                   next0 = AH_DECRYPT_NEXT_IP4_INPUT;
 271                   oh4->ip_version_and_header_length = 0x45;
 272                   oh4->fragment_id = 0;
 273                   oh4->flags_and_fragment_offset = 0;
 274                   oh4->protocol = ah0->nexthdr;
 275                   oh4->length =
 276                     clib_host_to_net_u16 (vlib_buffer_length_in_chain
 277                                           (vm, i_b0));
 278                   oh4->ttl = ttl;
 279                   oh4->tos = tos;
 280                   oh4->checksum = ip4_header_checksum (oh4);
 281                 }
 282             }
 283
 284           /* for IPSec-GRE tunnel next node is ipsec-gre-input */
 285           if (PREDICT_FALSE
 286               ((vnet_buffer (i_b0)->ipsec.flags) &
 287                IPSEC_FLAG_IPSEC_GRE_TUNNEL))
 288             next0 = AH_DECRYPT_NEXT_IPSEC_GRE_INPUT;
 289
 290
 291           vnet_buffer (i_b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
 292         trace:
 293           if (PREDICT_FALSE (i_b0->flags & VLIB_BUFFER_IS_TRACED))
 294             {
 295               i_b0->flags |= VLIB_BUFFER_IS_TRACED;
 296               ah_decrypt_trace_t *tr =
 297                 vlib_add_trace (vm, node, i_b0, sizeof (*tr));
 298               tr->integ_alg = sa0->integ_alg;
 299               tr->seq_num = seq;
 300             }
 301           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
 302                                            n_left_to_next, i_bi0, next0);
 303         }
 304       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 305     }
 306   vlib_node_increment_counter (vm, node->node_index, AH_DECRYPT_ERROR_RX_PKTS,
 307                                from_frame->n_vectors);
 308
 309   return from_frame->n_vectors;
 310 }
 311
 312 VLIB_NODE_FN (ah4_decrypt_node) (vlib_main_t * vm,
 313                                  vlib_node_runtime_t * node,
 314                                  vlib_frame_t * from_frame)
 315 {
 316   return ah_decrypt_inline (vm, node, from_frame, 0 /* is_ip6 */ );
 317 }
 318
 319 /* *INDENT-OFF* */
 320 VLIB_REGISTER_NODE (ah4_decrypt_node) = {
 321   .name = "ah4-decrypt",
 322   .vector_size = sizeof (u32),
 323   .format_trace = format_ah_decrypt_trace,
 324   .type = VLIB_NODE_TYPE_INTERNAL,
 325
 326   .n_errors = ARRAY_LEN(ah_decrypt_error_strings),
 327   .error_strings = ah_decrypt_error_strings,
 328
 329   .n_next_nodes = AH_DECRYPT_N_NEXT,
 330   .next_nodes = {
 331 #define _(s,n) [AH_DECRYPT_NEXT_##s] = n,
 332     foreach_ah_decrypt_next
 333 #undef _
 334   },
 335 };
 336 /* *INDENT-ON* */
 337
 338 VLIB_NODE_FN (ah6_decrypt_node) (vlib_main_t * vm,
 339                                  vlib_node_runtime_t * node,
 340                                  vlib_frame_t * from_frame)
 341 {
 342   return ah_decrypt_inline (vm, node, from_frame, 1 /* is_ip6 */ );
 343 }
 344
 345 /* *INDENT-OFF* */
 346 VLIB_REGISTER_NODE (ah6_decrypt_node) = {
 347   .name = "ah6-decrypt",
 348   .vector_size = sizeof (u32),
 349   .format_trace = format_ah_decrypt_trace,
 350   .type = VLIB_NODE_TYPE_INTERNAL,
 351
 352   .n_errors = ARRAY_LEN(ah_decrypt_error_strings),
 353   .error_strings = ah_decrypt_error_strings,
 354
 355   .n_next_nodes = AH_DECRYPT_N_NEXT,
 356   .next_nodes = {
 357 #define _(s,n) [AH_DECRYPT_NEXT_##s] = n,
 358     foreach_ah_decrypt_next
 359 #undef _
 360   },
 361 };
 362 /* *INDENT-ON* */
 363
 364 /*
 365  * fd.io coding-style-patch-verification: ON
 366  *
 367  * Local Variables:
 368  * eval: (c-set-style "gnu")
 369  * End:
 370  */