blob: 626e71d50300c970ab905eab5a010e478ca4cac6 [file] [log] [blame]
Damjan Marion91f17dc2019-03-18 18:59:25 +01001/*
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 Gannebe954442019-04-29 16:05:46 +020023/* CRYPTO_ID, PRETTY_NAME, KEY_LENGTH_IN_BYTES */
Damjan Marion060bfb92019-03-29 13:47:54 +010024#define foreach_crypto_cipher_alg \
Benoît Gannebe954442019-04-29 16:05:46 +020025 _(DES_CBC, "des-cbc", 7) \
Neale Rannse6be7022019-06-04 15:37:34 +000026 _(3DES_CBC, "3des-cbc", 24) \
Benoît Gannebe954442019-04-29 16:05:46 +020027 _(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 Marion91f17dc2019-03-18 18:59:25 +010033
Benoît Gannebe954442019-04-29 16:05:46 +020034/* CRYPTO_ID, PRETTY_NAME, KEY_LENGTH_IN_BYTES */
Damjan Marion060bfb92019-03-29 13:47:54 +010035#define foreach_crypto_aead_alg \
Benoît Gannebe954442019-04-29 16:05:46 +020036 _(AES_128_GCM, "aes-128-gcm", 16) \
37 _(AES_192_GCM, "aes-192-gcm", 24) \
38 _(AES_256_GCM, "aes-256-gcm", 32)
Damjan Marion060bfb92019-03-29 13:47:54 +010039
40#define foreach_crypto_hmac_alg \
Filip Tehlare225f712019-03-19 10:37:06 -070041 _(MD5, "md5") \
Damjan Marion91f17dc2019-03-18 18:59:25 +010042 _(SHA1, "sha-1") \
43 _(SHA224, "sha-224") \
44 _(SHA256, "sha-256") \
45 _(SHA384, "sha-384") \
46 _(SHA512, "sha-512")
47
Damjan Marion060bfb92019-03-29 13:47:54 +010048
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
56typedef 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 Ranns6afaae12019-07-17 15:07:14 +000068 _(FAIL_BAD_HMAC, "bad-hmac")
Damjan Marion060bfb92019-03-29 13:47:54 +010069
70typedef enum
71{
Damjan Mariond1bed682019-04-24 15:20:35 +020072 VNET_CRYPTO_KEY_OP_ADD,
73 VNET_CRYPTO_KEY_OP_DEL,
74 VNET_CRYPTO_KEY_OP_MODIFY,
75} vnet_crypto_key_op_t;
76
77typedef enum
78{
Damjan Marion060bfb92019-03-29 13:47:54 +010079#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 Marion91f17dc2019-03-18 18:59:25 +010085/* *INDENT-OFF* */
86typedef enum
87{
Damjan Mariond1bed682019-04-24 15:20:35 +020088 VNET_CRYPTO_ALG_NONE = 0,
Benoît Gannebe954442019-04-29 16:05:46 +020089#define _(n, s, l) VNET_CRYPTO_ALG_##n,
Damjan Marion060bfb92019-03-29 13:47:54 +010090 foreach_crypto_cipher_alg
91 foreach_crypto_aead_alg
Damjan Marion91f17dc2019-03-18 18:59:25 +010092#undef _
Damjan Marion060bfb92019-03-29 13:47:54 +010093#define _(n, s) VNET_CRYPTO_ALG_HMAC_##n,
94 foreach_crypto_hmac_alg
Damjan Marion91f17dc2019-03-18 18:59:25 +010095#undef _
96 VNET_CRYPTO_N_ALGS,
97} vnet_crypto_alg_t;
98
Damjan Mariond1bed682019-04-24 15:20:35 +020099typedef struct
100{
101 u8 *data;
102 vnet_crypto_alg_t alg:8;
103} vnet_crypto_key_t;
104
Damjan Marion91f17dc2019-03-18 18:59:25 +0100105typedef enum
106{
107 VNET_CRYPTO_OP_NONE = 0,
Benoît Gannebe954442019-04-29 16:05:46 +0200108#define _(n, s, l) VNET_CRYPTO_OP_##n##_ENC, VNET_CRYPTO_OP_##n##_DEC,
Damjan Marion060bfb92019-03-29 13:47:54 +0100109 foreach_crypto_cipher_alg
110 foreach_crypto_aead_alg
Damjan Marion91f17dc2019-03-18 18:59:25 +0100111#undef _
112#define _(n, s) VNET_CRYPTO_OP_##n##_HMAC,
Damjan Marion060bfb92019-03-29 13:47:54 +0100113 foreach_crypto_hmac_alg
Damjan Marion91f17dc2019-03-18 18:59:25 +0100114#undef _
Damjan Marion060bfb92019-03-29 13:47:54 +0100115 VNET_CRYPTO_N_OP_IDS,
116} vnet_crypto_op_id_t;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100117/* *INDENT-ON* */
118
119typedef struct
120{
121 char *name;
Damjan Marion060bfb92019-03-29 13:47:54 +0100122 vnet_crypto_op_id_t op_by_type[VNET_CRYPTO_OP_N_TYPES];
Damjan Marion91f17dc2019-03-18 18:59:25 +0100123} vnet_crypto_alg_data_t;
124
Damjan Marion91f17dc2019-03-18 18:59:25 +0100125typedef struct
126{
127 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Damjan Marion060bfb92019-03-29 13:47:54 +0100128 vnet_crypto_op_id_t op:16;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100129 vnet_crypto_op_status_t status:8;
Damjan Marion060bfb92019-03-29 13:47:54 +0100130 u8 flags;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100131#define VNET_CRYPTO_OP_FLAG_INIT_IV (1 << 0)
132#define VNET_CRYPTO_OP_FLAG_HMAC_CHECK (1 << 1)
Damjan Mariond1bed682019-04-24 15:20:35 +0200133 u32 key_index;
Damjan Mariond97918e2019-04-25 18:28:31 +0200134 u32 len;
Damjan Marion060bfb92019-03-29 13:47:54 +0100135 u16 aad_len;
Damjan Marion82d81d42019-04-25 18:24:04 +0200136 u8 digest_len, tag_len;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100137 u8 *iv;
138 u8 *src;
139 u8 *dst;
Damjan Marion060bfb92019-03-29 13:47:54 +0100140 u8 *aad;
141 u8 *tag;
142 u8 *digest;
Damjan Marionc59b9a22019-03-19 15:38:40 +0100143 uword user_data;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100144} vnet_crypto_op_t;
145
146typedef struct
147{
Damjan Marion060bfb92019-03-29 13:47:54 +0100148 vnet_crypto_op_type_t type;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100149 vnet_crypto_alg_t alg;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100150 u32 active_engine_index;
Damjan Marion060bfb92019-03-29 13:47:54 +0100151} vnet_crypto_op_data_t;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100152
153typedef struct
154{
155 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
156 clib_bitmap_t *act_queues;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100157} vnet_crypto_thread_t;
158
Damjan Mariond1bed682019-04-24 15:20:35 +0200159typedef u32 vnet_crypto_key_index_t;
160
Damjan Marion91f17dc2019-03-18 18:59:25 +0100161typedef u32 (vnet_crypto_ops_handler_t) (vlib_main_t * vm,
162 vnet_crypto_op_t * ops[], u32 n_ops);
163
Damjan Mariond1bed682019-04-24 15:20:35 +0200164typedef 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 Marion91f17dc2019-03-18 18:59:25 +0100168u32 vnet_crypto_register_engine (vlib_main_t * vm, char *name, int prio,
169 char *desc);
170
Damjan Mariond1bed682019-04-24 15:20:35 +0200171void 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);
174void vnet_crypto_register_key_handler (vlib_main_t * vm, u32 engine_index,
175 vnet_crypto_key_handler_t * keyh);
Damjan Marion91f17dc2019-03-18 18:59:25 +0100176
177typedef struct
178{
179 char *name;
180 char *desc;
181 int priority;
Damjan Mariond1bed682019-04-24 15:20:35 +0200182 vnet_crypto_key_handler_t *key_op_handler;
Damjan Marion060bfb92019-03-29 13:47:54 +0100183 vnet_crypto_ops_handler_t *ops_handlers[VNET_CRYPTO_N_OP_IDS];
Damjan Marion91f17dc2019-03-18 18:59:25 +0100184} vnet_crypto_engine_t;
185
186typedef struct
187{
188 vnet_crypto_alg_data_t *algs;
189 vnet_crypto_thread_t *threads;
190 vnet_crypto_ops_handler_t **ops_handlers;
Damjan Marion060bfb92019-03-29 13:47:54 +0100191 vnet_crypto_op_data_t opt_data[VNET_CRYPTO_N_OP_IDS];
Damjan Marion91f17dc2019-03-18 18:59:25 +0100192 vnet_crypto_engine_t *engines;
Damjan Mariond1bed682019-04-24 15:20:35 +0200193 vnet_crypto_key_t *keys;
Filip Tehlar1469d542019-03-25 09:04:41 -0700194 uword *engine_index_by_name;
Damjan Marion060bfb92019-03-29 13:47:54 +0100195 uword *alg_index_by_name;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100196} vnet_crypto_main_t;
197
198extern vnet_crypto_main_t crypto_main;
199
200u32 vnet_crypto_submit_ops (vlib_main_t * vm, vnet_crypto_op_t ** jobs,
201 u32 n_jobs);
202
203u32 vnet_crypto_process_ops (vlib_main_t * vm, vnet_crypto_op_t ops[],
204 u32 n_ops);
205
Filip Tehlar1469d542019-03-25 09:04:41 -0700206int vnet_crypto_set_handler (char *ops_handler_name, char *engine);
Neale Rannsece2ae02019-06-21 12:44:11 +0000207int vnet_crypto_is_set_handler (vnet_crypto_alg_t alg);
Filip Tehlar1469d542019-03-25 09:04:41 -0700208
Damjan Mariond1bed682019-04-24 15:20:35 +0200209u32 vnet_crypto_key_add (vlib_main_t * vm, vnet_crypto_alg_t alg,
210 u8 * data, u16 length);
211void vnet_crypto_key_del (vlib_main_t * vm, vnet_crypto_key_index_t index);
Damjan Mariond1bed682019-04-24 15:20:35 +0200212
Damjan Marion91f17dc2019-03-18 18:59:25 +0100213format_function_t format_vnet_crypto_alg;
214format_function_t format_vnet_crypto_engine;
215format_function_t format_vnet_crypto_op;
Damjan Marion060bfb92019-03-29 13:47:54 +0100216format_function_t format_vnet_crypto_op_type;
217format_function_t format_vnet_crypto_op_status;
Damjan Marion61c0a3d2019-04-05 19:42:21 +0200218unformat_function_t unformat_vnet_crypto_alg;
Damjan Mariona03d1822019-03-28 21:40:48 +0100219
220static_always_inline void
Damjan Marion060bfb92019-03-29 13:47:54 +0100221vnet_crypto_op_init (vnet_crypto_op_t * op, vnet_crypto_op_id_t type)
Damjan Mariona03d1822019-03-28 21:40:48 +0100222{
223 if (CLIB_DEBUG > 0)
224 clib_memset (op, 0xfe, sizeof (*op));
225 op->op = type;
226 op->flags = 0;
Damjan Mariond1bed682019-04-24 15:20:35 +0200227 op->key_index = ~0;
Damjan Mariona03d1822019-03-28 21:40:48 +0100228}
229
Damjan Marion060bfb92019-03-29 13:47:54 +0100230static_always_inline vnet_crypto_op_type_t
231vnet_crypto_get_op_type (vnet_crypto_op_id_t id)
232{
233 vnet_crypto_main_t *cm = &crypto_main;
Lijian Zhangb15d7962019-09-27 16:25:35 +0800234 ASSERT (id < VNET_CRYPTO_N_OP_IDS);
235 vnet_crypto_op_data_t *od = cm->opt_data + id;
Damjan Marion060bfb92019-03-29 13:47:54 +0100236 return od->type;
237}
238
Damjan Mariond1bed682019-04-24 15:20:35 +0200239static_always_inline vnet_crypto_key_t *
240vnet_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 Marion91f17dc2019-03-18 18:59:25 +0100246#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 */