Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 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 | |
Benoît Ganne | be95444 | 2019-04-29 16:05:46 +0200 | [diff] [blame] | 23 | /* CRYPTO_ID, PRETTY_NAME, KEY_LENGTH_IN_BYTES */ |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 24 | #define foreach_crypto_cipher_alg \ |
Benoît Ganne | be95444 | 2019-04-29 16:05:46 +0200 | [diff] [blame] | 25 | _(DES_CBC, "des-cbc", 7) \ |
Neale Ranns | e6be702 | 2019-06-04 15:37:34 +0000 | [diff] [blame] | 26 | _(3DES_CBC, "3des-cbc", 24) \ |
Benoît Ganne | be95444 | 2019-04-29 16:05:46 +0200 | [diff] [blame] | 27 | _(AES_128_CBC, "aes-128-cbc", 16) \ |
| 28 | _(AES_192_CBC, "aes-192-cbc", 24) \ |
| 29 | _(AES_256_CBC, "aes-256-cbc", 32) \ |
| 30 | _(AES_128_CTR, "aes-128-ctr", 16) \ |
| 31 | _(AES_192_CTR, "aes-192-ctr", 24) \ |
| 32 | _(AES_256_CTR, "aes-256-ctr", 32) |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 33 | |
Benoît Ganne | be95444 | 2019-04-29 16:05:46 +0200 | [diff] [blame] | 34 | /* CRYPTO_ID, PRETTY_NAME, KEY_LENGTH_IN_BYTES */ |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 35 | #define foreach_crypto_aead_alg \ |
Benoît Ganne | be95444 | 2019-04-29 16:05:46 +0200 | [diff] [blame] | 36 | _(AES_128_GCM, "aes-128-gcm", 16) \ |
| 37 | _(AES_192_GCM, "aes-192-gcm", 24) \ |
| 38 | _(AES_256_GCM, "aes-256-gcm", 32) |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 39 | |
| 40 | #define foreach_crypto_hmac_alg \ |
Filip Tehlar | e225f71 | 2019-03-19 10:37:06 -0700 | [diff] [blame] | 41 | _(MD5, "md5") \ |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 42 | _(SHA1, "sha-1") \ |
| 43 | _(SHA224, "sha-224") \ |
| 44 | _(SHA256, "sha-256") \ |
| 45 | _(SHA384, "sha-384") \ |
| 46 | _(SHA512, "sha-512") |
| 47 | |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 48 | |
| 49 | #define foreach_crypto_op_type \ |
| 50 | _(ENCRYPT, "encrypt") \ |
| 51 | _(DECRYPT, "decrypt") \ |
| 52 | _(AEAD_ENCRYPT, "aead-encrypt") \ |
| 53 | _(AEAD_DECRYPT, "aead-decrypt") \ |
| 54 | _(HMAC, "hmac") |
| 55 | |
| 56 | typedef enum |
| 57 | { |
| 58 | #define _(n, s) VNET_CRYPTO_OP_TYPE_##n, |
| 59 | foreach_crypto_op_type |
| 60 | #undef _ |
| 61 | VNET_CRYPTO_OP_N_TYPES, |
| 62 | } vnet_crypto_op_type_t; |
| 63 | |
| 64 | #define foreach_crypto_op_status \ |
| 65 | _(PENDING, "pending") \ |
| 66 | _(COMPLETED, "completed") \ |
| 67 | _(FAIL_NO_HANDLER, "no-handler") \ |
Neale Ranns | 6afaae1 | 2019-07-17 15:07:14 +0000 | [diff] [blame] | 68 | _(FAIL_BAD_HMAC, "bad-hmac") |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 69 | |
| 70 | typedef enum |
| 71 | { |
Damjan Marion | d1bed68 | 2019-04-24 15:20:35 +0200 | [diff] [blame] | 72 | VNET_CRYPTO_KEY_OP_ADD, |
| 73 | VNET_CRYPTO_KEY_OP_DEL, |
| 74 | VNET_CRYPTO_KEY_OP_MODIFY, |
| 75 | } vnet_crypto_key_op_t; |
| 76 | |
| 77 | typedef enum |
| 78 | { |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 79 | #define _(n, s) VNET_CRYPTO_OP_STATUS_##n, |
| 80 | foreach_crypto_op_status |
| 81 | #undef _ |
| 82 | VNET_CRYPTO_OP_N_STATUS, |
| 83 | } vnet_crypto_op_status_t; |
| 84 | |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 85 | /* *INDENT-OFF* */ |
| 86 | typedef enum |
| 87 | { |
Damjan Marion | d1bed68 | 2019-04-24 15:20:35 +0200 | [diff] [blame] | 88 | VNET_CRYPTO_ALG_NONE = 0, |
Benoît Ganne | be95444 | 2019-04-29 16:05:46 +0200 | [diff] [blame] | 89 | #define _(n, s, l) VNET_CRYPTO_ALG_##n, |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 90 | foreach_crypto_cipher_alg |
| 91 | foreach_crypto_aead_alg |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 92 | #undef _ |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 93 | #define _(n, s) VNET_CRYPTO_ALG_HMAC_##n, |
| 94 | foreach_crypto_hmac_alg |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 95 | #undef _ |
| 96 | VNET_CRYPTO_N_ALGS, |
| 97 | } vnet_crypto_alg_t; |
| 98 | |
Damjan Marion | d1bed68 | 2019-04-24 15:20:35 +0200 | [diff] [blame] | 99 | typedef struct |
| 100 | { |
| 101 | u8 *data; |
| 102 | vnet_crypto_alg_t alg:8; |
| 103 | } vnet_crypto_key_t; |
| 104 | |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 105 | typedef enum |
| 106 | { |
| 107 | VNET_CRYPTO_OP_NONE = 0, |
Benoît Ganne | be95444 | 2019-04-29 16:05:46 +0200 | [diff] [blame] | 108 | #define _(n, s, l) VNET_CRYPTO_OP_##n##_ENC, VNET_CRYPTO_OP_##n##_DEC, |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 109 | foreach_crypto_cipher_alg |
| 110 | foreach_crypto_aead_alg |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 111 | #undef _ |
| 112 | #define _(n, s) VNET_CRYPTO_OP_##n##_HMAC, |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 113 | foreach_crypto_hmac_alg |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 114 | #undef _ |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 115 | VNET_CRYPTO_N_OP_IDS, |
| 116 | } vnet_crypto_op_id_t; |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 117 | /* *INDENT-ON* */ |
| 118 | |
| 119 | typedef struct |
| 120 | { |
| 121 | char *name; |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 122 | vnet_crypto_op_id_t op_by_type[VNET_CRYPTO_OP_N_TYPES]; |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 123 | } vnet_crypto_alg_data_t; |
| 124 | |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 125 | typedef struct |
| 126 | { |
| 127 | CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 128 | vnet_crypto_op_id_t op:16; |
Damjan Marion | b4fff3a | 2019-03-25 15:54:40 +0100 | [diff] [blame] | 129 | vnet_crypto_op_status_t status:8; |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 130 | u8 flags; |
Damjan Marion | b4fff3a | 2019-03-25 15:54:40 +0100 | [diff] [blame] | 131 | #define VNET_CRYPTO_OP_FLAG_INIT_IV (1 << 0) |
| 132 | #define VNET_CRYPTO_OP_FLAG_HMAC_CHECK (1 << 1) |
Damjan Marion | d1bed68 | 2019-04-24 15:20:35 +0200 | [diff] [blame] | 133 | u32 key_index; |
Damjan Marion | d97918e | 2019-04-25 18:28:31 +0200 | [diff] [blame] | 134 | u32 len; |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 135 | u16 aad_len; |
Damjan Marion | 82d81d4 | 2019-04-25 18:24:04 +0200 | [diff] [blame] | 136 | u8 digest_len, tag_len; |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 137 | u8 *iv; |
| 138 | u8 *src; |
| 139 | u8 *dst; |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 140 | u8 *aad; |
| 141 | u8 *tag; |
| 142 | u8 *digest; |
Damjan Marion | c59b9a2 | 2019-03-19 15:38:40 +0100 | [diff] [blame] | 143 | uword user_data; |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 144 | } vnet_crypto_op_t; |
| 145 | |
| 146 | typedef struct |
| 147 | { |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 148 | vnet_crypto_op_type_t type; |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 149 | vnet_crypto_alg_t alg; |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 150 | u32 active_engine_index; |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 151 | } vnet_crypto_op_data_t; |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 152 | |
| 153 | typedef struct |
| 154 | { |
| 155 | CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); |
| 156 | clib_bitmap_t *act_queues; |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 157 | } vnet_crypto_thread_t; |
| 158 | |
Damjan Marion | d1bed68 | 2019-04-24 15:20:35 +0200 | [diff] [blame] | 159 | typedef u32 vnet_crypto_key_index_t; |
| 160 | |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 161 | typedef u32 (vnet_crypto_ops_handler_t) (vlib_main_t * vm, |
| 162 | vnet_crypto_op_t * ops[], u32 n_ops); |
| 163 | |
Damjan Marion | d1bed68 | 2019-04-24 15:20:35 +0200 | [diff] [blame] | 164 | typedef void (vnet_crypto_key_handler_t) (vlib_main_t * vm, |
| 165 | vnet_crypto_key_op_t kop, |
| 166 | vnet_crypto_key_index_t idx); |
| 167 | |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 168 | u32 vnet_crypto_register_engine (vlib_main_t * vm, char *name, int prio, |
| 169 | char *desc); |
| 170 | |
Damjan Marion | d1bed68 | 2019-04-24 15:20:35 +0200 | [diff] [blame] | 171 | void vnet_crypto_register_ops_handler (vlib_main_t * vm, u32 engine_index, |
| 172 | vnet_crypto_op_id_t opt, |
| 173 | vnet_crypto_ops_handler_t * oph); |
| 174 | void vnet_crypto_register_key_handler (vlib_main_t * vm, u32 engine_index, |
| 175 | vnet_crypto_key_handler_t * keyh); |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 176 | |
| 177 | typedef struct |
| 178 | { |
| 179 | char *name; |
| 180 | char *desc; |
| 181 | int priority; |
Damjan Marion | d1bed68 | 2019-04-24 15:20:35 +0200 | [diff] [blame] | 182 | vnet_crypto_key_handler_t *key_op_handler; |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 183 | vnet_crypto_ops_handler_t *ops_handlers[VNET_CRYPTO_N_OP_IDS]; |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 184 | } vnet_crypto_engine_t; |
| 185 | |
| 186 | typedef struct |
| 187 | { |
| 188 | vnet_crypto_alg_data_t *algs; |
| 189 | vnet_crypto_thread_t *threads; |
| 190 | vnet_crypto_ops_handler_t **ops_handlers; |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 191 | vnet_crypto_op_data_t opt_data[VNET_CRYPTO_N_OP_IDS]; |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 192 | vnet_crypto_engine_t *engines; |
Damjan Marion | d1bed68 | 2019-04-24 15:20:35 +0200 | [diff] [blame] | 193 | vnet_crypto_key_t *keys; |
Filip Tehlar | 1469d54 | 2019-03-25 09:04:41 -0700 | [diff] [blame] | 194 | uword *engine_index_by_name; |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 195 | uword *alg_index_by_name; |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 196 | } vnet_crypto_main_t; |
| 197 | |
| 198 | extern vnet_crypto_main_t crypto_main; |
| 199 | |
| 200 | u32 vnet_crypto_submit_ops (vlib_main_t * vm, vnet_crypto_op_t ** jobs, |
| 201 | u32 n_jobs); |
| 202 | |
| 203 | u32 vnet_crypto_process_ops (vlib_main_t * vm, vnet_crypto_op_t ops[], |
| 204 | u32 n_ops); |
| 205 | |
Filip Tehlar | 1469d54 | 2019-03-25 09:04:41 -0700 | [diff] [blame] | 206 | int vnet_crypto_set_handler (char *ops_handler_name, char *engine); |
Neale Ranns | ece2ae0 | 2019-06-21 12:44:11 +0000 | [diff] [blame] | 207 | int vnet_crypto_is_set_handler (vnet_crypto_alg_t alg); |
Filip Tehlar | 1469d54 | 2019-03-25 09:04:41 -0700 | [diff] [blame] | 208 | |
Damjan Marion | d1bed68 | 2019-04-24 15:20:35 +0200 | [diff] [blame] | 209 | u32 vnet_crypto_key_add (vlib_main_t * vm, vnet_crypto_alg_t alg, |
| 210 | u8 * data, u16 length); |
| 211 | void vnet_crypto_key_del (vlib_main_t * vm, vnet_crypto_key_index_t index); |
Damjan Marion | d1bed68 | 2019-04-24 15:20:35 +0200 | [diff] [blame] | 212 | |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 213 | format_function_t format_vnet_crypto_alg; |
| 214 | format_function_t format_vnet_crypto_engine; |
| 215 | format_function_t format_vnet_crypto_op; |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 216 | format_function_t format_vnet_crypto_op_type; |
| 217 | format_function_t format_vnet_crypto_op_status; |
Damjan Marion | 61c0a3d | 2019-04-05 19:42:21 +0200 | [diff] [blame] | 218 | unformat_function_t unformat_vnet_crypto_alg; |
Damjan Marion | a03d182 | 2019-03-28 21:40:48 +0100 | [diff] [blame] | 219 | |
| 220 | static_always_inline void |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 221 | vnet_crypto_op_init (vnet_crypto_op_t * op, vnet_crypto_op_id_t type) |
Damjan Marion | a03d182 | 2019-03-28 21:40:48 +0100 | [diff] [blame] | 222 | { |
| 223 | if (CLIB_DEBUG > 0) |
| 224 | clib_memset (op, 0xfe, sizeof (*op)); |
| 225 | op->op = type; |
| 226 | op->flags = 0; |
Damjan Marion | d1bed68 | 2019-04-24 15:20:35 +0200 | [diff] [blame] | 227 | op->key_index = ~0; |
Damjan Marion | a03d182 | 2019-03-28 21:40:48 +0100 | [diff] [blame] | 228 | } |
| 229 | |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 230 | static_always_inline vnet_crypto_op_type_t |
| 231 | vnet_crypto_get_op_type (vnet_crypto_op_id_t id) |
| 232 | { |
| 233 | vnet_crypto_main_t *cm = &crypto_main; |
Lijian Zhang | b15d796 | 2019-09-27 16:25:35 +0800 | [diff] [blame] | 234 | ASSERT (id < VNET_CRYPTO_N_OP_IDS); |
| 235 | vnet_crypto_op_data_t *od = cm->opt_data + id; |
Damjan Marion | 060bfb9 | 2019-03-29 13:47:54 +0100 | [diff] [blame] | 236 | return od->type; |
| 237 | } |
| 238 | |
Damjan Marion | d1bed68 | 2019-04-24 15:20:35 +0200 | [diff] [blame] | 239 | static_always_inline vnet_crypto_key_t * |
| 240 | vnet_crypto_get_key (vnet_crypto_key_index_t index) |
| 241 | { |
| 242 | vnet_crypto_main_t *cm = &crypto_main; |
| 243 | return vec_elt_at_index (cm->keys, index); |
| 244 | } |
| 245 | |
Damjan Marion | 91f17dc | 2019-03-18 18:59:25 +0100 | [diff] [blame] | 246 | #endif /* included_vnet_crypto_crypto_h */ |
| 247 | |
| 248 | /* |
| 249 | * fd.io coding-style-patch-verification: ON |
| 250 | * |
| 251 | * Local Variables: |
| 252 | * eval: (c-set-style "gnu") |
| 253 | * End: |
| 254 | */ |