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   union
  25   {
  26     u32 spi;
  27     u8 spi_bytes[4];
  28   };
  29   u32 seq;
  30   u8 data[0];
  31 } esp_header_t;
  32
  33 typedef struct
  34 {
  35   u8 pad_length;
  36   u8 next_header;
  37 } esp_footer_t;
  38
  39 /* *INDENT-OFF* */
  40 typedef CLIB_PACKED (struct {
  41   ip4_header_t ip4;
  42   esp_header_t esp;
  43 }) ip4_and_esp_header_t;
  44 /* *INDENT-ON* */
  45
  46 /* *INDENT-OFF* */
  47 typedef CLIB_PACKED (struct {
  48   ip4_header_t ip4;
  49   udp_header_t udp;
  50   esp_header_t esp;
  51 }) ip4_and_udp_and_esp_header_t;
  52 /* *INDENT-ON* */
  53
  54 /* *INDENT-OFF* */
  55 typedef CLIB_PACKED (struct {
  56   ip6_header_t ip6;
  57   esp_header_t esp;
  58 }) ip6_and_esp_header_t;
  59 /* *INDENT-ON* */
  60
  61 /**
  62  * AES GCM Additional Authentication data
  63  */
  64 typedef struct esp_aead_t_
  65 {
  66   /**
  67    * for GCM: when using ESN it's:
  68    *   SPI, seq-hi, seg-low
  69    * else
  70    *   SPI, seq-low
  71    */
  72   u32 data[3];
  73 } __clib_packed esp_aead_t;
  74
  75 #define ESP_SEQ_MAX             (4294967295UL)
  76 #define ESP_MAX_BLOCK_SIZE      (16)
  77 #define ESP_MAX_IV_SIZE         (16)
  78 #define ESP_MAX_ICV_SIZE        (32)
  79
  80 u8 *format_esp_header (u8 * s, va_list * args);
  81
  82 /* TODO seq increment should be atomic to be accessed by multiple workers */
  83 always_inline int
  84 esp_seq_advance (ipsec_sa_t * sa)
  85 {
  86   if (PREDICT_TRUE (ipsec_sa_is_set_USE_ESN (sa)))
  87     {
  88       if (PREDICT_FALSE (sa->seq == ESP_SEQ_MAX))
  89         {
  90           if (PREDICT_FALSE (ipsec_sa_is_set_USE_ANTI_REPLAY (sa) &&
  91                              sa->seq_hi == ESP_SEQ_MAX))
  92             return 1;
  93           sa->seq_hi++;
  94         }
  95       sa->seq++;
  96     }
  97   else
  98     {
  99       if (PREDICT_FALSE (ipsec_sa_is_set_USE_ANTI_REPLAY (sa) &&
 100                          sa->seq == ESP_SEQ_MAX))
 101         return 1;
 102       sa->seq++;
 103     }
 104
 105   return 0;
 106 }
 107
 108 always_inline u16
 109 esp_aad_fill (u8 * data, const esp_header_t * esp, const ipsec_sa_t * sa)
 110 {
 111   esp_aead_t *aad;
 112
 113   aad = (esp_aead_t *) data;
 114   aad->data[0] = esp->spi;
 115
 116   if (ipsec_sa_is_set_USE_ESN (sa))
 117     {
 118       /* SPI, seq-hi, seq-low */
 119       aad->data[1] = (u32) clib_host_to_net_u32 (sa->seq_hi);
 120       aad->data[2] = esp->seq;
 121       return 12;
 122     }
 123   else
 124     {
 125       /* SPI, seq-low */
 126       aad->data[1] = esp->seq;
 127       return 8;
 128     }
 129 }
 130
 131 /* Special case to drop or hand off packets for sync/async modes.
 132  *
 133  * Different than sync mode, async mode only enqueue drop or hand-off packets
 134  * to next nodes.
 135  */
 136 always_inline void
 137 esp_set_next_index (int is_async, u32 * from, u16 * nexts, u32 bi,
 138                     u16 * drop_index, u16 drop_next, u16 * next)
 139 {
 140   if (is_async)
 141     {
 142       from[*drop_index] = bi;
 143       nexts[*drop_index] = drop_next;
 144       *drop_index += 1;
 145     }
 146   else
 147     next[0] = drop_next;
 148 }
 149
 150 /* when submitting a frame is failed, drop all buffers in the frame */
 151 always_inline void
 152 esp_async_recycle_failed_submit (vnet_crypto_async_frame_t * f,
 153                                  vlib_buffer_t ** b, u32 * from, u16 * nexts,
 154                                  u16 * n_dropped, u16 drop_next_index,
 155                                  vlib_error_t err)
 156 {
 157   u32 n_drop = f->n_elts;
 158   u32 *bi = f->buffer_indices;
 159   b -= n_drop;
 160   while (n_drop--)
 161     {
 162       b[0]->error = err;
 163       esp_set_next_index (1, from, nexts, bi[0], n_dropped, drop_next_index,
 164                           NULL);
 165       bi++;
 166       b++;
 167     }
 168   vnet_crypto_async_reset_frame (f);
 169 }
 170
 171 /**
 172  * The post data structure to for esp_encrypt/decrypt_inline to write to
 173  * vib_buffer_t opaque unused field, and for post nodes to pick up after
 174  * dequeue.
 175  **/
 176 typedef struct
 177 {
 178   union
 179   {
 180     struct
 181     {
 182       u8 icv_sz;
 183       u8 iv_sz;
 184       ipsec_sa_flags_t flags;
 185       u32 sa_index;
 186     };
 187     u64 sa_data;
 188   };
 189
 190   u32 seq;
 191   i16 current_data;
 192   i16 current_length;
 193   u16 hdr_sz;
 194   u16 is_chain;
 195   u32 protect_index;
 196 } esp_decrypt_packet_data_t;
 197
 198 STATIC_ASSERT_SIZEOF (esp_decrypt_packet_data_t, 3 * sizeof (u64));
 199
 200 /* we are forced to store the decrypt post data into 2 separate places -
 201    vlib_opaque and opaque2. */
 202 typedef struct
 203 {
 204   vlib_buffer_t *lb;
 205   u32 free_buffer_index;
 206   u8 icv_removed;
 207 } esp_decrypt_packet_data2_t;
 208
 209 typedef union
 210 {
 211   u16 next_index;
 212   esp_decrypt_packet_data_t decrypt_data;
 213 } esp_post_data_t;
 214
 215 STATIC_ASSERT (sizeof (esp_post_data_t) <=
 216                STRUCT_SIZE_OF (vnet_buffer_opaque_t, unused),
 217                "Custom meta-data too large for vnet_buffer_opaque_t");
 218
 219 #define esp_post_data(b) \
 220     ((esp_post_data_t *)((u8 *)((b)->opaque) \
 221         + STRUCT_OFFSET_OF (vnet_buffer_opaque_t, unused)))
 222
 223 STATIC_ASSERT (sizeof (esp_decrypt_packet_data2_t) <=
 224                STRUCT_SIZE_OF (vnet_buffer_opaque2_t, unused),
 225                "Custom meta-data too large for vnet_buffer_opaque2_t");
 226
 227 #define esp_post_data2(b) \
 228     ((esp_decrypt_packet_data2_t *)((u8 *)((b)->opaque2) \
 229         + STRUCT_OFFSET_OF (vnet_buffer_opaque2_t, unused)))
 230
 231 typedef struct
 232 {
 233   /* esp post node index for async crypto */
 234   u32 esp4_post_next;
 235   u32 esp6_post_next;
 236   u32 esp4_tun_post_next;
 237   u32 esp6_tun_post_next;
 238   u32 esp_mpls_tun_post_next;
 239 } esp_async_post_next_t;
 240
 241 extern esp_async_post_next_t esp_encrypt_async_next;
 242 extern esp_async_post_next_t esp_decrypt_async_next;
 243
 244 #endif /* __ESP_H__ */
 245
 246 /*
 247  * fd.io coding-style-patch-verification: ON
 248  *
 249  * Local Variables:
 250  * eval: (c-set-style "gnu")
 251  * End:
 252  */