src/vnet/crypto/crypto.h

   1 /*
   2  * Copyright (c) 2019 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
  16 #ifndef included_vnet_crypto_crypto_h
  17 #define included_vnet_crypto_crypto_h
  18
  19 #define VNET_CRYPTO_RING_SIZE 512
  20
  21 #include <vlib/vlib.h>
  22
  23 #define foreach_crypto_cipher_alg \
  24   _(DES_CBC,     "des-cbc") \
  25   _(3DES_CBC,    "3des-cbc") \
  26   _(AES_128_CBC, "aes-128-cbc") \
  27   _(AES_192_CBC, "aes-192-cbc") \
  28   _(AES_256_CBC, "aes-256-cbc") \
  29   _(AES_128_CTR, "aes-128-ctr") \
  30   _(AES_192_CTR, "aes-192-ctr") \
  31   _(AES_256_CTR, "aes-256-ctr")
  32
  33 #define foreach_crypto_aead_alg \
  34   _(AES_128_GCM, "aes-128-gcm") \
  35   _(AES_192_GCM, "aes-192-gcm") \
  36   _(AES_256_GCM, "aes-256-gcm")
  37
  38 #define foreach_crypto_hmac_alg \
  39   _(MD5, "md5") \
  40   _(SHA1, "sha-1") \
  41   _(SHA224, "sha-224")  \
  42   _(SHA256, "sha-256")  \
  43   _(SHA384, "sha-384")  \
  44   _(SHA512, "sha-512")
  45
  46
  47 #define foreach_crypto_op_type \
  48   _(ENCRYPT, "encrypt") \
  49   _(DECRYPT, "decrypt") \
  50   _(AEAD_ENCRYPT, "aead-encrypt") \
  51   _(AEAD_DECRYPT, "aead-decrypt") \
  52   _(HMAC, "hmac")
  53
  54 typedef enum
  55 {
  56 #define _(n, s) VNET_CRYPTO_OP_TYPE_##n,
  57   foreach_crypto_op_type
  58 #undef _
  59     VNET_CRYPTO_OP_N_TYPES,
  60 } vnet_crypto_op_type_t;
  61
  62 #define foreach_crypto_op_status \
  63   _(PENDING, "pending") \
  64   _(COMPLETED, "completed") \
  65   _(FAIL_NO_HANDLER, "no-handler") \
  66   _(FAIL_BAD_HMAC, "bad-hmac") \
  67   _(FAIL_DECRYPT, "decrypt-fail")
  68
  69 typedef enum
  70 {
  71 #define _(n, s) VNET_CRYPTO_OP_STATUS_##n,
  72   foreach_crypto_op_status
  73 #undef _
  74     VNET_CRYPTO_OP_N_STATUS,
  75 } vnet_crypto_op_status_t;
  76
  77 /* *INDENT-OFF* */
  78 typedef enum
  79 {
  80 #define _(n, s) VNET_CRYPTO_ALG_##n,
  81   foreach_crypto_cipher_alg
  82   foreach_crypto_aead_alg
  83 #undef _
  84 #define _(n, s) VNET_CRYPTO_ALG_HMAC_##n,
  85   foreach_crypto_hmac_alg
  86 #undef _
  87   VNET_CRYPTO_N_ALGS,
  88 } vnet_crypto_alg_t;
  89
  90 typedef enum
  91 {
  92   VNET_CRYPTO_OP_NONE = 0,
  93 #define _(n, s) VNET_CRYPTO_OP_##n##_ENC, VNET_CRYPTO_OP_##n##_DEC,
  94   foreach_crypto_cipher_alg
  95   foreach_crypto_aead_alg
  96 #undef _
  97 #define _(n, s) VNET_CRYPTO_OP_##n##_HMAC,
  98  foreach_crypto_hmac_alg
  99 #undef _
 100     VNET_CRYPTO_N_OP_IDS,
 101 } vnet_crypto_op_id_t;
 102 /* *INDENT-ON* */
 103
 104 typedef struct
 105 {
 106   char *name;
 107   vnet_crypto_op_id_t op_by_type[VNET_CRYPTO_OP_N_TYPES];
 108 } vnet_crypto_alg_data_t;
 109
 110 typedef struct
 111 {
 112   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 113   vnet_crypto_op_id_t op:16;
 114   vnet_crypto_op_status_t status:8;
 115   u8 flags;
 116 #define VNET_CRYPTO_OP_FLAG_INIT_IV (1 << 0)
 117 #define VNET_CRYPTO_OP_FLAG_HMAC_CHECK (1 << 1)
 118   u32 len;
 119   u16 aad_len;
 120   u8 key_len, iv_len, digest_len, tag_len;
 121   u8 *key;
 122   u8 *iv;
 123   u8 *src;
 124   u8 *dst;
 125   u8 *aad;
 126   u8 *tag;
 127   u8 *digest;
 128   uword user_data;
 129 } vnet_crypto_op_t;
 130
 131 typedef struct
 132 {
 133   vnet_crypto_op_type_t type;
 134   vnet_crypto_alg_t alg;
 135   u32 active_engine_index;
 136 } vnet_crypto_op_data_t;
 137
 138 typedef struct
 139 {
 140   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 141   clib_bitmap_t *act_queues;
 142 } vnet_crypto_thread_t;
 143
 144 typedef u32 (vnet_crypto_ops_handler_t) (vlib_main_t * vm,
 145                                          vnet_crypto_op_t * ops[], u32 n_ops);
 146
 147 u32 vnet_crypto_register_engine (vlib_main_t * vm, char *name, int prio,
 148                                  char *desc);
 149
 150 vlib_error_t *vnet_crypto_register_ops_handler (vlib_main_t * vm,
 151                                                 u32 provider_index,
 152                                                 vnet_crypto_op_id_t opt,
 153                                                 vnet_crypto_ops_handler_t *
 154                                                 f);
 155
 156 typedef struct
 157 {
 158   char *name;
 159   char *desc;
 160   int priority;
 161   vnet_crypto_ops_handler_t *ops_handlers[VNET_CRYPTO_N_OP_IDS];
 162 } vnet_crypto_engine_t;
 163
 164 typedef struct
 165 {
 166   vnet_crypto_alg_data_t *algs;
 167   vnet_crypto_thread_t *threads;
 168   vnet_crypto_ops_handler_t **ops_handlers;
 169   vnet_crypto_op_data_t opt_data[VNET_CRYPTO_N_OP_IDS];
 170   vnet_crypto_engine_t *engines;
 171   uword *engine_index_by_name;
 172   uword *alg_index_by_name;
 173 } vnet_crypto_main_t;
 174
 175 extern vnet_crypto_main_t crypto_main;
 176
 177 u32 vnet_crypto_submit_ops (vlib_main_t * vm, vnet_crypto_op_t ** jobs,
 178                             u32 n_jobs);
 179
 180 u32 vnet_crypto_process_ops (vlib_main_t * vm, vnet_crypto_op_t ops[],
 181                              u32 n_ops);
 182
 183
 184 int vnet_crypto_set_handler (char *ops_handler_name, char *engine);
 185
 186 format_function_t format_vnet_crypto_alg;
 187 format_function_t format_vnet_crypto_engine;
 188 format_function_t format_vnet_crypto_op;
 189 format_function_t format_vnet_crypto_op_type;
 190 format_function_t format_vnet_crypto_op_status;
 191 unformat_function_t unformat_vnet_crypto_alg;
 192
 193 static_always_inline void
 194 vnet_crypto_op_init (vnet_crypto_op_t * op, vnet_crypto_op_id_t type)
 195 {
 196   if (CLIB_DEBUG > 0)
 197     clib_memset (op, 0xfe, sizeof (*op));
 198   op->op = type;
 199   op->flags = 0;
 200 }
 201
 202 static_always_inline vnet_crypto_op_type_t
 203 vnet_crypto_get_op_type (vnet_crypto_op_id_t id)
 204 {
 205   vnet_crypto_main_t *cm = &crypto_main;
 206   vnet_crypto_op_data_t *od = vec_elt_at_index (cm->opt_data, id);
 207   return od->type;
 208 }
 209
 210 #endif /* included_vnet_crypto_crypto_h */
 211
 212 /*
 213  * fd.io coding-style-patch-verification: ON
 214  *
 215  * Local Variables:
 216  * eval: (c-set-style "gnu")
 217  * End:
 218  */