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 void
 109 esp_aad_fill (vnet_crypto_op_t * op,
 110               const esp_header_t * esp, const ipsec_sa_t * sa)
 111 {
 112   esp_aead_t *aad;
 113
 114   aad = (esp_aead_t *) op->aad;
 115   aad->data[0] = esp->spi;
 116
 117   if (ipsec_sa_is_set_USE_ESN (sa))
 118     {
 119       /* SPI, seq-hi, seq-low */
 120       aad->data[1] = clib_host_to_net_u32 (sa->seq_hi);
 121       aad->data[2] = esp->seq;
 122       op->aad_len = 12;
 123     }
 124   else
 125     {
 126       /* SPI, seq-low */
 127       aad->data[1] = esp->seq;
 128       op->aad_len = 8;
 129     }
 130 }
 131 #endif /* __ESP_H__ */
 132
 133 /*
 134  * fd.io coding-style-patch-verification: ON
 135  *
 136  * Local Variables:
 137  * eval: (c-set-style "gnu")
 138  * End:
 139  */