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_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
  30 #define foreach_hmac_alg \
  31   _(MD5, "md5") \
  32   _(SHA1, "sha-1") \
  33   _(SHA224, "sha-224")  \
  34   _(SHA256, "sha-256")  \
  35   _(SHA384, "sha-384")  \
  36   _(SHA512, "sha-512")
  37
  38 /* *INDENT-OFF* */
  39 typedef enum
  40 {
  41 #define _(n, s) VNET_CRYPTO_ALG_##n,
  42   foreach_crypto_alg
  43 #undef _
  44 #define _(n, s) VNET_CRYPTO_ALG_##n,
  45   foreach_hmac_alg
  46 #undef _
  47   VNET_CRYPTO_N_ALGS,
  48 } vnet_crypto_alg_t;
  49
  50 typedef enum
  51 {
  52   VNET_CRYPTO_OP_NONE = 0,
  53 #define _(n, s) VNET_CRYPTO_OP_##n##_ENC, VNET_CRYPTO_OP_##n##_DEC,
  54   foreach_crypto_alg
  55 #undef _
  56 #define _(n, s) VNET_CRYPTO_OP_##n##_HMAC,
  57   foreach_hmac_alg
  58 #undef _
  59     VNET_CRYPTO_N_OP_TYPES,
  60 } __attribute__ ((packed)) vnet_crypto_op_type_t;
  61 /* *INDENT-ON* */
  62
  63 STATIC_ASSERT (sizeof (vnet_crypto_op_type_t) <= 2,
  64                "crypto op type > 2 bytes");
  65
  66 typedef struct
  67 {
  68   char *name;
  69 } vnet_crypto_alg_data_t;
  70
  71 typedef enum
  72 {
  73   VNET_CRYPTO_OP_STATUS_PENDING,
  74   VNET_CRYPTO_OP_STATUS_COMPLETED,
  75   VNET_CRYPTO_OP_STATUS_FAIL_NO_HANDLER,
  76 } __attribute__ ((packed)) vnet_crypto_op_status_t;
  77
  78 STATIC_ASSERT (sizeof (vnet_crypto_op_status_t) == 1,
  79                "crypto op status > 1 byte");
  80
  81 typedef struct
  82 {
  83   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  84   vnet_crypto_op_type_t op;
  85   vnet_crypto_op_status_t status;
  86   u8 key_len, hmac_trunc_len;
  87   u16 flags;
  88 #define VNET_CRYPTO_OP_FLAG_INIT_IV 1
  89   u32 len;
  90   u8 *key;
  91   u8 *iv;
  92   u8 *src;
  93   u8 *dst;
  94   uword user_data;
  95 } vnet_crypto_op_t;
  96
  97 typedef struct
  98 {
  99   vnet_crypto_alg_t alg;
 100   const char *desc;
 101   u32 active_engine_index;
 102 } vnet_crypto_op_type_data_t;
 103
 104 typedef struct
 105 {
 106   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 107   u32 head;
 108   u32 tail;
 109   u32 size;
 110   vnet_crypto_alg_t alg:8;
 111   vnet_crypto_op_type_t op:8;
 112   vnet_crypto_op_t *jobs[0];
 113 } vnet_crypto_queue_t;
 114
 115 typedef struct
 116 {
 117   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 118   clib_bitmap_t *act_queues;
 119   vnet_crypto_queue_t *queues[VNET_CRYPTO_N_OP_TYPES];
 120 } vnet_crypto_thread_t;
 121
 122 typedef u32 (vnet_crypto_ops_handler_t) (vlib_main_t * vm,
 123                                          vnet_crypto_op_t * ops[], u32 n_ops);
 124
 125 u32 vnet_crypto_register_engine (vlib_main_t * vm, char *name, int prio,
 126                                  char *desc);
 127
 128 vlib_error_t *vnet_crypto_register_ops_handler (vlib_main_t * vm,
 129                                                 u32 provider_index,
 130                                                 vnet_crypto_op_type_t opt,
 131                                                 vnet_crypto_ops_handler_t *
 132                                                 f);
 133
 134 typedef struct
 135 {
 136   char *name;
 137   char *desc;
 138   int priority;
 139   vnet_crypto_ops_handler_t *ops_handlers[VNET_CRYPTO_N_OP_TYPES];
 140 } vnet_crypto_engine_t;
 141
 142 typedef struct
 143 {
 144   vnet_crypto_alg_data_t *algs;
 145   vnet_crypto_thread_t *threads;
 146   vnet_crypto_ops_handler_t **ops_handlers;
 147   vnet_crypto_op_type_data_t opt_data[VNET_CRYPTO_N_OP_TYPES];
 148   vnet_crypto_engine_t *engines;
 149   uword *engine_index_by_name;
 150   uword *ops_handler_index_by_name;
 151 } vnet_crypto_main_t;
 152
 153 extern vnet_crypto_main_t crypto_main;
 154
 155 u32 vnet_crypto_submit_ops (vlib_main_t * vm, vnet_crypto_op_t ** jobs,
 156                             u32 n_jobs);
 157
 158 u32 vnet_crypto_process_ops (vlib_main_t * vm, vnet_crypto_op_t ops[],
 159                              u32 n_ops);
 160
 161
 162 int vnet_crypto_set_handler (char *ops_handler_name, char *engine);
 163
 164 format_function_t format_vnet_crypto_alg;
 165 format_function_t format_vnet_crypto_engine;
 166 format_function_t format_vnet_crypto_op;
 167
 168 #endif /* included_vnet_crypto_crypto_h */
 169
 170 /*
 171  * fd.io coding-style-patch-verification: ON
 172  *
 173  * Local Variables:
 174  * eval: (c-set-style "gnu")
 175  * End:
 176  */