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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #ifndef included_vnet_crypto_crypto_h
17 #define included_vnet_crypto_crypto_h
19 #define VNET_CRYPTO_RING_SIZE 512
21 #include <vlib/vlib.h>
23 /* CRYPTO_ID, PRETTY_NAME, KEY_LENGTH_IN_BYTES */
24 #define foreach_crypto_cipher_alg \
25 _(DES_CBC, "des-cbc", 7) \
26 _(3DES_CBC, "3des-cbc", 24) \
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)
34 /* CRYPTO_ID, PRETTY_NAME, KEY_LENGTH_IN_BYTES */
35 #define foreach_crypto_aead_alg \
36 _(AES_128_GCM, "aes-128-gcm", 16) \
37 _(AES_192_GCM, "aes-192-gcm", 24) \
38 _(AES_256_GCM, "aes-256-gcm", 32)
40 #define foreach_crypto_hmac_alg \
43 _(SHA224, "sha-224") \
44 _(SHA256, "sha-256") \
45 _(SHA384, "sha-384") \
49 #define foreach_crypto_op_type \
50 _(ENCRYPT, "encrypt") \
51 _(DECRYPT, "decrypt") \
52 _(AEAD_ENCRYPT, "aead-encrypt") \
53 _(AEAD_DECRYPT, "aead-decrypt") \
58 #define _(n, s) VNET_CRYPTO_OP_TYPE_##n,
59 foreach_crypto_op_type
61 VNET_CRYPTO_OP_N_TYPES,
62 } vnet_crypto_op_type_t;
64 #define foreach_crypto_op_status \
65 _(PENDING, "pending") \
66 _(COMPLETED, "completed") \
67 _(FAIL_NO_HANDLER, "no-handler") \
68 _(FAIL_BAD_HMAC, "bad-hmac")
72 VNET_CRYPTO_KEY_OP_ADD,
73 VNET_CRYPTO_KEY_OP_DEL,
74 VNET_CRYPTO_KEY_OP_MODIFY,
75 } vnet_crypto_key_op_t;
79 #define _(n, s) VNET_CRYPTO_OP_STATUS_##n,
80 foreach_crypto_op_status
82 VNET_CRYPTO_OP_N_STATUS,
83 } vnet_crypto_op_status_t;
88 VNET_CRYPTO_ALG_NONE = 0,
89 #define _(n, s, l) VNET_CRYPTO_ALG_##n,
90 foreach_crypto_cipher_alg
91 foreach_crypto_aead_alg
93 #define _(n, s) VNET_CRYPTO_ALG_HMAC_##n,
94 foreach_crypto_hmac_alg
102 vnet_crypto_alg_t alg:8;
107 VNET_CRYPTO_OP_NONE = 0,
108 #define _(n, s, l) VNET_CRYPTO_OP_##n##_ENC, VNET_CRYPTO_OP_##n##_DEC,
109 foreach_crypto_cipher_alg
110 foreach_crypto_aead_alg
112 #define _(n, s) VNET_CRYPTO_OP_##n##_HMAC,
113 foreach_crypto_hmac_alg
115 VNET_CRYPTO_N_OP_IDS,
116 } vnet_crypto_op_id_t;
124 } crypto_op_class_type_t;
129 vnet_crypto_op_id_t op_by_type[VNET_CRYPTO_OP_N_TYPES];
130 } vnet_crypto_alg_data_t;
137 } vnet_crypto_op_chunk_t;
141 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
143 vnet_crypto_op_id_t op:16;
144 vnet_crypto_op_status_t status:8;
146 #define VNET_CRYPTO_OP_FLAG_INIT_IV (1 << 0)
147 #define VNET_CRYPTO_OP_FLAG_HMAC_CHECK (1 << 1)
148 #define VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS (1 << 2)
165 /* valid if VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS is set */
172 /* valid if VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS is set */
187 STATIC_ASSERT_SIZEOF (vnet_crypto_op_t, CLIB_CACHE_LINE_BYTES);
191 vnet_crypto_op_type_t type;
192 vnet_crypto_alg_t alg;
193 u32 active_engine_index_simple;
194 u32 active_engine_index_chained;
195 } vnet_crypto_op_data_t;
199 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
200 clib_bitmap_t *act_queues;
201 } vnet_crypto_thread_t;
203 typedef u32 vnet_crypto_key_index_t;
205 typedef u32 (vnet_crypto_chained_ops_handler_t) (vlib_main_t * vm,
206 vnet_crypto_op_t * ops[],
207 vnet_crypto_op_chunk_t *
210 typedef u32 (vnet_crypto_ops_handler_t) (vlib_main_t * vm,
211 vnet_crypto_op_t * ops[], u32 n_ops);
213 typedef void (vnet_crypto_key_handler_t) (vlib_main_t * vm,
214 vnet_crypto_key_op_t kop,
215 vnet_crypto_key_index_t idx);
217 u32 vnet_crypto_register_engine (vlib_main_t * vm, char *name, int prio,
220 void vnet_crypto_register_ops_handler (vlib_main_t * vm, u32 engine_index,
221 vnet_crypto_op_id_t opt,
222 vnet_crypto_ops_handler_t * oph);
224 void vnet_crypto_register_chained_ops_handler (vlib_main_t * vm,
226 vnet_crypto_op_id_t opt,
227 vnet_crypto_chained_ops_handler_t
229 void vnet_crypto_register_ops_handlers (vlib_main_t * vm, u32 engine_index,
230 vnet_crypto_op_id_t opt,
231 vnet_crypto_ops_handler_t * fn,
232 vnet_crypto_chained_ops_handler_t *
235 void vnet_crypto_register_key_handler (vlib_main_t * vm, u32 engine_index,
236 vnet_crypto_key_handler_t * keyh);
243 vnet_crypto_key_handler_t *key_op_handler;
244 vnet_crypto_ops_handler_t *ops_handlers[VNET_CRYPTO_N_OP_IDS];
245 vnet_crypto_chained_ops_handler_t
246 * chained_ops_handlers[VNET_CRYPTO_N_OP_IDS];
247 } vnet_crypto_engine_t;
251 vnet_crypto_alg_data_t *algs;
252 vnet_crypto_thread_t *threads;
253 vnet_crypto_ops_handler_t **ops_handlers;
254 vnet_crypto_chained_ops_handler_t **chained_ops_handlers;
255 vnet_crypto_op_data_t opt_data[VNET_CRYPTO_N_OP_IDS];
256 vnet_crypto_engine_t *engines;
257 vnet_crypto_key_t *keys;
258 uword *engine_index_by_name;
259 uword *alg_index_by_name;
260 } vnet_crypto_main_t;
262 extern vnet_crypto_main_t crypto_main;
264 u32 vnet_crypto_submit_ops (vlib_main_t * vm, vnet_crypto_op_t ** jobs,
267 u32 vnet_crypto_process_chained_ops (vlib_main_t * vm, vnet_crypto_op_t ops[],
268 vnet_crypto_op_chunk_t * chunks,
270 u32 vnet_crypto_process_ops (vlib_main_t * vm, vnet_crypto_op_t ops[],
273 int vnet_crypto_set_handler2 (char *ops_handler_name, char *engine,
274 crypto_op_class_type_t oct);
275 int vnet_crypto_is_set_handler (vnet_crypto_alg_t alg);
277 u32 vnet_crypto_key_add (vlib_main_t * vm, vnet_crypto_alg_t alg,
278 u8 * data, u16 length);
279 void vnet_crypto_key_del (vlib_main_t * vm, vnet_crypto_key_index_t index);
281 format_function_t format_vnet_crypto_alg;
282 format_function_t format_vnet_crypto_engine;
283 format_function_t format_vnet_crypto_op;
284 format_function_t format_vnet_crypto_op_type;
285 format_function_t format_vnet_crypto_op_status;
286 unformat_function_t unformat_vnet_crypto_alg;
288 static_always_inline void
289 vnet_crypto_op_init (vnet_crypto_op_t * op, vnet_crypto_op_id_t type)
292 clib_memset (op, 0xfe, sizeof (*op));
299 static_always_inline vnet_crypto_op_type_t
300 vnet_crypto_get_op_type (vnet_crypto_op_id_t id)
302 vnet_crypto_main_t *cm = &crypto_main;
303 ASSERT (id < VNET_CRYPTO_N_OP_IDS);
304 vnet_crypto_op_data_t *od = cm->opt_data + id;
308 static_always_inline vnet_crypto_key_t *
309 vnet_crypto_get_key (vnet_crypto_key_index_t index)
311 vnet_crypto_main_t *cm = &crypto_main;
312 return vec_elt_at_index (cm->keys, index);
315 static_always_inline int
316 vnet_crypto_set_handler (char *alg_name, char *engine)
318 return vnet_crypto_set_handler2 (alg_name, engine, CRYPTO_OP_BOTH);
321 #endif /* included_vnet_crypto_crypto_h */
324 * fd.io coding-style-patch-verification: ON
327 * eval: (c-set-style "gnu")