src/vnet/ipsec/esp.h

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 #ifndef __ESP_H__
  16 #define __ESP_H__
  17
  18 #include <vnet/ip/ip.h>
  19 #include <vnet/crypto/crypto.h>
  20 #include <vnet/ipsec/ipsec.h>
  21
  22 typedef struct
  23 {
  24   u32 spi;
  25   u32 seq;
  26   u8 data[0];
  27 } esp_header_t;
  28
  29 typedef struct
  30 {
  31   u8 pad_length;
  32   u8 next_header;
  33 } esp_footer_t;
  34
  35 /* *INDENT-OFF* */
  36 typedef CLIB_PACKED (struct {
  37   ip4_header_t ip4;
  38   esp_header_t esp;
  39 }) ip4_and_esp_header_t;
  40 /* *INDENT-ON* */
  41
  42 /* *INDENT-OFF* */
  43 typedef CLIB_PACKED (struct {
  44   ip4_header_t ip4;
  45   udp_header_t udp;
  46   esp_header_t esp;
  47 }) ip4_and_udp_and_esp_header_t;
  48 /* *INDENT-ON* */
  49
  50 /* *INDENT-OFF* */
  51 typedef CLIB_PACKED (struct {
  52   ip6_header_t ip6;
  53   esp_header_t esp;
  54 }) ip6_and_esp_header_t;
  55 /* *INDENT-ON* */
  56
  57 /**
  58  * AES GCM Additional Authentication data
  59  */
  60 typedef struct esp_aead_t_
  61 {
  62   /**
  63    * for GCM: when using ESN it's:
  64    *   SPI, seq-hi, seg-low
  65    * else
  66    *   SPI, seq-low
  67    */
  68   u32 data[3];
  69 } __clib_packed esp_aead_t;
  70
  71 #define ESP_SEQ_MAX             (4294967295UL)
  72 #define ESP_MAX_BLOCK_SIZE      (16)
  73 #define ESP_MAX_IV_SIZE         (16)
  74 #define ESP_MAX_ICV_SIZE        (32)
  75
  76 u8 *format_esp_header (u8 * s, va_list * args);
  77
  78 /* TODO seq increment should be atomic to be accessed by multiple workers */
  79 always_inline int
  80 esp_seq_advance (ipsec_sa_t * sa)
  81 {
  82   if (PREDICT_TRUE (ipsec_sa_is_set_USE_ESN (sa)))
  83     {
  84       if (PREDICT_FALSE (sa->seq == ESP_SEQ_MAX))
  85         {
  86           if (PREDICT_FALSE (ipsec_sa_is_set_USE_ANTI_REPLAY (sa) &&
  87                              sa->seq_hi == ESP_SEQ_MAX))
  88             return 1;
  89           sa->seq_hi++;
  90         }
  91       sa->seq++;
  92     }
  93   else
  94     {
  95       if (PREDICT_FALSE (ipsec_sa_is_set_USE_ANTI_REPLAY (sa) &&
  96                          sa->seq == ESP_SEQ_MAX))
  97         return 1;
  98       sa->seq++;
  99     }
 100
 101   return 0;
 102 }
 103
 104
 105 always_inline unsigned int
 106 hmac_calc (vlib_main_t * vm, ipsec_sa_t * sa, u8 * data, int data_len,
 107            u8 * signature)
 108 {
 109   vnet_crypto_op_t _op, *op = &_op;
 110
 111   if (PREDICT_FALSE (sa->integ_op_id == 0))
 112     return 0;
 113
 114   vnet_crypto_op_init (op, sa->integ_op_id);
 115   op->key_index = sa->integ_key_index;
 116   op->src = data;
 117   op->len = data_len;
 118   op->digest = signature;
 119   op->digest_len = sa->integ_icv_size;
 120
 121   if (ipsec_sa_is_set_USE_ESN (sa))
 122     {
 123       u32 seq_hi = clib_host_to_net_u32 (sa->seq_hi);
 124
 125       op->len += 4;
 126       clib_memcpy (data + data_len, &seq_hi, 4);
 127     }
 128
 129   vnet_crypto_process_ops (vm, op, 1);
 130   return sa->integ_icv_size;
 131 }
 132
 133 always_inline void
 134 esp_aad_fill (vnet_crypto_op_t * op,
 135               const esp_header_t * esp, const ipsec_sa_t * sa)
 136 {
 137   esp_aead_t *aad;
 138
 139   aad = (esp_aead_t *) op->aad;
 140   clib_memcpy_fast (aad, esp, 8);
 141
 142   if (ipsec_sa_is_set_USE_ESN (sa))
 143     {
 144       /* SPI, seq-hi, seq-low */
 145       aad->data[2] = aad->data[1];
 146       aad->data[1] = clib_host_to_net_u32 (sa->seq_hi);
 147       op->aad_len = 12;
 148     }
 149   else
 150     /* SPI, seq-low */
 151     op->aad_len = 8;
 152 }
 153 #endif /* __ESP_H__ */
 154
 155 /*
 156  * fd.io coding-style-patch-verification: ON
 157  *
 158  * Local Variables:
 159  * eval: (c-set-style "gnu")
 160  * End:
 161  */