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 #include <vlib/vlib.h>
21 #define VNET_CRYPTO_FRAME_SIZE 64
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) \
39 _(CHACHA20_POLY1305, "chacha20-poly1305", 32)
41 #define foreach_crypto_hmac_alg \
44 _(SHA224, "sha-224") \
45 _(SHA256, "sha-256") \
46 _(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 \
66 _(PENDING, "pending") \
67 _(WORK_IN_PROGRESS, "work-in-progress") \
68 _(COMPLETED, "completed") \
69 _(FAIL_NO_HANDLER, "no-handler") \
70 _(FAIL_BAD_HMAC, "bad-hmac") \
71 _(FAIL_ENGINE_ERR, "engine-error")
75 /* CRYPTO_ID, PRETTY_NAME, KEY_LENGTH_IN_BYTES, TAG_LEN, AAD_LEN */
76 #define foreach_crypto_aead_async_alg \
77 _(AES_128_GCM, "aes-128-gcm-aad8", 16, 16, 8) \
78 _(AES_128_GCM, "aes-128-gcm-aad12", 16, 16, 12) \
79 _(AES_192_GCM, "aes-192-gcm-aad8", 24, 16, 8) \
80 _(AES_192_GCM, "aes-192-gcm-aad12", 24, 16, 12) \
81 _(AES_256_GCM, "aes-256-gcm-aad8", 32, 16, 8) \
82 _(AES_256_GCM, "aes-256-gcm-aad12", 32, 16, 12) \
83 _(CHACHA20_POLY1305, "chacha20-poly1305-aad8", 32, 16, 8) \
84 _(CHACHA20_POLY1305, "chacha20-poly1305-aad12", 32, 16, 12)
86 /* CRYPTO_ID, INTEG_ID, PRETTY_NAME, KEY_LENGTH_IN_BYTES, DIGEST_LEN */
87 #define foreach_crypto_link_async_alg \
88 _ (AES_128_CBC, SHA1, "aes-128-cbc-hmac-sha-1", 16, 12) \
89 _ (AES_192_CBC, SHA1, "aes-192-cbc-hmac-sha-1", 24, 12) \
90 _ (AES_256_CBC, SHA1, "aes-256-cbc-hmac-sha-1", 32, 12) \
91 _ (AES_128_CBC, SHA224, "aes-128-cbc-hmac-sha-224", 16, 14) \
92 _ (AES_192_CBC, SHA224, "aes-192-cbc-hmac-sha-224", 24, 14) \
93 _ (AES_256_CBC, SHA224, "aes-256-cbc-hmac-sha-224", 32, 14) \
94 _ (AES_128_CBC, SHA256, "aes-128-cbc-hmac-sha-256", 16, 16) \
95 _ (AES_192_CBC, SHA256, "aes-192-cbc-hmac-sha-256", 24, 16) \
96 _ (AES_256_CBC, SHA256, "aes-256-cbc-hmac-sha-256", 32, 16) \
97 _ (AES_128_CBC, SHA384, "aes-128-cbc-hmac-sha-384", 16, 24) \
98 _ (AES_192_CBC, SHA384, "aes-192-cbc-hmac-sha-384", 24, 24) \
99 _ (AES_256_CBC, SHA384, "aes-256-cbc-hmac-sha-384", 32, 24) \
100 _ (AES_128_CBC, SHA512, "aes-128-cbc-hmac-sha-512", 16, 32) \
101 _ (AES_192_CBC, SHA512, "aes-192-cbc-hmac-sha-512", 24, 32) \
102 _ (AES_256_CBC, SHA512, "aes-256-cbc-hmac-sha-512", 32, 32)
104 #define foreach_crypto_async_op_type \
105 _(ENCRYPT, "async-encrypt") \
106 _(DECRYPT, "async-decrypt")
110 VNET_CRYPTO_KEY_OP_ADD,
111 VNET_CRYPTO_KEY_OP_DEL,
112 VNET_CRYPTO_KEY_OP_MODIFY,
113 } vnet_crypto_key_op_t;
117 #define _(n, s) VNET_CRYPTO_OP_STATUS_##n,
118 foreach_crypto_op_status
120 VNET_CRYPTO_OP_N_STATUS,
121 } vnet_crypto_op_status_t;
126 VNET_CRYPTO_ALG_NONE = 0,
127 #define _(n, s, l) VNET_CRYPTO_ALG_##n,
128 foreach_crypto_cipher_alg
129 foreach_crypto_aead_alg
131 #define _(n, s) VNET_CRYPTO_ALG_HMAC_##n,
132 foreach_crypto_hmac_alg
139 #define _(n, s) VNET_CRYPTO_ASYNC_OP_TYPE_##n,
140 foreach_crypto_async_op_type
142 VNET_CRYPTO_ASYNC_OP_N_TYPES,
143 } vnet_crypto_async_op_type_t;
147 VNET_CRYPTO_ASYNC_ALG_NONE = 0,
148 #define _(n, s, k, t, a) \
149 VNET_CRYPTO_ALG_##n##_TAG##t##_AAD##a,
150 foreach_crypto_aead_async_alg
152 #define _(c, h, s, k ,d) \
153 VNET_CRYPTO_ALG_##c##_##h##_TAG##d,
154 foreach_crypto_link_async_alg
156 VNET_CRYPTO_N_ASYNC_ALGS,
157 } vnet_crypto_async_alg_t;
161 VNET_CRYPTO_ASYNC_OP_NONE = 0,
162 #define _(n, s, k, t, a) \
163 VNET_CRYPTO_OP_##n##_TAG##t##_AAD##a##_ENC, \
164 VNET_CRYPTO_OP_##n##_TAG##t##_AAD##a##_DEC,
165 foreach_crypto_aead_async_alg
167 #define _(c, h, s, k ,d) \
168 VNET_CRYPTO_OP_##c##_##h##_TAG##d##_ENC, \
169 VNET_CRYPTO_OP_##c##_##h##_TAG##d##_DEC,
170 foreach_crypto_link_async_alg
172 VNET_CRYPTO_ASYNC_OP_N_IDS,
173 } vnet_crypto_async_op_id_t;
182 vnet_crypto_alg_t alg:8;
188 vnet_crypto_async_alg_t async_alg:8;
191 #define VNET_CRYPTO_KEY_TYPE_DATA 0
192 #define VNET_CRYPTO_KEY_TYPE_LINK 1
198 VNET_CRYPTO_OP_NONE = 0,
199 #define _(n, s, l) VNET_CRYPTO_OP_##n##_ENC, VNET_CRYPTO_OP_##n##_DEC,
200 foreach_crypto_cipher_alg
201 foreach_crypto_aead_alg
203 #define _(n, s) VNET_CRYPTO_OP_##n##_HMAC,
204 foreach_crypto_hmac_alg
206 VNET_CRYPTO_N_OP_IDS,
207 } vnet_crypto_op_id_t;
215 } crypto_op_class_type_t;
220 vnet_crypto_op_id_t op_by_type[VNET_CRYPTO_OP_N_TYPES];
221 } vnet_crypto_alg_data_t;
228 } vnet_crypto_op_chunk_t;
232 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
234 vnet_crypto_op_id_t op:16;
235 vnet_crypto_op_status_t status:8;
237 #define VNET_CRYPTO_OP_FLAG_INIT_IV (1 << 0)
238 #define VNET_CRYPTO_OP_FLAG_HMAC_CHECK (1 << 1)
239 #define VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS (1 << 2)
256 /* valid if VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS is set */
263 /* valid if VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS is set */
278 STATIC_ASSERT_SIZEOF (vnet_crypto_op_t, CLIB_CACHE_LINE_BYTES);
282 vnet_crypto_op_type_t type;
283 vnet_crypto_alg_t alg;
284 u32 active_engine_index_simple;
285 u32 active_engine_index_chained;
286 } vnet_crypto_op_data_t;
290 vnet_crypto_async_op_type_t type;
291 vnet_crypto_async_alg_t alg;
292 u32 active_engine_index_async;
293 } vnet_crypto_async_op_data_t;
298 vnet_crypto_async_op_id_t op_by_type[VNET_CRYPTO_ASYNC_OP_N_TYPES];
299 } vnet_crypto_async_alg_data_t;
303 vnet_crypto_op_status_t status:8;
305 i16 crypto_start_offset; /* first buffer offset */
306 i16 integ_start_offset;
307 u32 crypto_total_length;
308 /* adj total_length for integ, e.g.4 bytes for IPSec ESN */
309 u16 integ_length_adj;
317 u8 flags; /**< share same VNET_CRYPTO_OP_FLAG_* values */
318 } vnet_crypto_async_frame_elt_t;
322 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
323 #define VNET_CRYPTO_FRAME_STATE_NOT_PROCESSED 0
324 #define VNET_CRYPTO_FRAME_STATE_PENDING 1 /* frame waiting to be processed */
325 #define VNET_CRYPTO_FRAME_STATE_WORK_IN_PROGRESS 2
326 #define VNET_CRYPTO_FRAME_STATE_SUCCESS 3
327 #define VNET_CRYPTO_FRAME_STATE_ELT_ERROR 4
329 vnet_crypto_async_op_id_t op:8;
331 vnet_crypto_async_frame_elt_t elts[VNET_CRYPTO_FRAME_SIZE];
332 u32 buffer_indices[VNET_CRYPTO_FRAME_SIZE];
333 u16 next_node_index[VNET_CRYPTO_FRAME_SIZE];
334 u32 enqueue_thread_index;
335 } vnet_crypto_async_frame_t;
339 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
340 vnet_crypto_async_frame_t *frames[VNET_CRYPTO_ASYNC_OP_N_IDS];
341 vnet_crypto_async_frame_t *frame_pool;
344 } vnet_crypto_thread_t;
346 typedef u32 vnet_crypto_key_index_t;
348 typedef u32 (vnet_crypto_chained_ops_handler_t) (vlib_main_t * vm,
349 vnet_crypto_op_t * ops[],
350 vnet_crypto_op_chunk_t *
353 typedef u32 (vnet_crypto_ops_handler_t) (vlib_main_t * vm,
354 vnet_crypto_op_t * ops[], u32 n_ops);
356 typedef void (vnet_crypto_key_handler_t) (vlib_main_t * vm,
357 vnet_crypto_key_op_t kop,
358 vnet_crypto_key_index_t idx);
360 /** async crypto function handlers **/
362 (vnet_crypto_frame_enqueue_t) (vlib_main_t * vm,
363 vnet_crypto_async_frame_t * frame);
364 typedef vnet_crypto_async_frame_t *
365 (vnet_crypto_frame_dequeue_t) (vlib_main_t * vm, u32 * nb_elts_processed,
366 u32 * enqueue_thread_idx);
369 vnet_crypto_register_engine (vlib_main_t * vm, char *name, int prio,
372 void vnet_crypto_register_ops_handler (vlib_main_t * vm, u32 engine_index,
373 vnet_crypto_op_id_t opt,
374 vnet_crypto_ops_handler_t * oph);
376 void vnet_crypto_register_chained_ops_handler (vlib_main_t * vm,
378 vnet_crypto_op_id_t opt,
379 vnet_crypto_chained_ops_handler_t
382 void vnet_crypto_register_ops_handlers (vlib_main_t * vm, u32 engine_index,
383 vnet_crypto_op_id_t opt,
384 vnet_crypto_ops_handler_t * fn,
385 vnet_crypto_chained_ops_handler_t *
388 void vnet_crypto_register_key_handler (vlib_main_t * vm, u32 engine_index,
389 vnet_crypto_key_handler_t * keyh);
391 /** async crypto register functions */
392 u32 vnet_crypto_register_post_node (vlib_main_t * vm, char *post_node_name);
393 void vnet_crypto_register_async_handler (vlib_main_t * vm,
395 vnet_crypto_async_op_id_t opt,
396 vnet_crypto_frame_enqueue_t * enq_fn,
397 vnet_crypto_frame_dequeue_t *
405 vnet_crypto_key_handler_t *key_op_handler;
406 vnet_crypto_ops_handler_t *ops_handlers[VNET_CRYPTO_N_OP_IDS];
407 vnet_crypto_chained_ops_handler_t
408 * chained_ops_handlers[VNET_CRYPTO_N_OP_IDS];
409 vnet_crypto_frame_enqueue_t *enqueue_handlers[VNET_CRYPTO_ASYNC_OP_N_IDS];
410 vnet_crypto_frame_dequeue_t *dequeue_handlers[VNET_CRYPTO_ASYNC_OP_N_IDS];
411 } vnet_crypto_engine_t;
417 } vnet_crypto_async_next_node_t;
421 vnet_crypto_alg_data_t *algs;
422 vnet_crypto_thread_t *threads;
423 vnet_crypto_ops_handler_t **ops_handlers;
424 vnet_crypto_chained_ops_handler_t **chained_ops_handlers;
425 vnet_crypto_frame_enqueue_t **enqueue_handlers;
426 vnet_crypto_frame_dequeue_t **dequeue_handlers;
427 clib_bitmap_t *async_active_ids;
428 vnet_crypto_op_data_t opt_data[VNET_CRYPTO_N_OP_IDS];
429 vnet_crypto_async_op_data_t async_opt_data[VNET_CRYPTO_ASYNC_OP_N_IDS];
430 vnet_crypto_engine_t *engines;
431 vnet_crypto_key_t *keys;
432 uword *engine_index_by_name;
433 uword *alg_index_by_name;
434 uword *async_alg_index_by_name;
435 vnet_crypto_async_alg_data_t *async_algs;
437 vnet_crypto_async_next_node_t *next_nodes;
438 u32 crypto_node_index;
439 #define VNET_CRYPTO_ASYNC_DISPATCH_POLLING 0
440 #define VNET_CRYPTO_ASYNC_DISPATCH_INTERRUPT 1
442 } vnet_crypto_main_t;
444 extern vnet_crypto_main_t crypto_main;
446 u32 vnet_crypto_process_chained_ops (vlib_main_t * vm, vnet_crypto_op_t ops[],
447 vnet_crypto_op_chunk_t * chunks,
449 u32 vnet_crypto_process_ops (vlib_main_t * vm, vnet_crypto_op_t ops[],
453 int vnet_crypto_set_handler2 (char *ops_handler_name, char *engine,
454 crypto_op_class_type_t oct);
455 int vnet_crypto_is_set_handler (vnet_crypto_alg_t alg);
457 u32 vnet_crypto_key_add (vlib_main_t * vm, vnet_crypto_alg_t alg,
458 u8 * data, u16 length);
459 void vnet_crypto_key_del (vlib_main_t * vm, vnet_crypto_key_index_t index);
462 * Use 2 created keys to generate new key for linked algs (cipher + integ)
463 * The returned key index is to be used for linked alg only.
465 u32 vnet_crypto_key_add_linked (vlib_main_t * vm,
466 vnet_crypto_key_index_t index_crypto,
467 vnet_crypto_key_index_t index_integ);
469 clib_error_t *crypto_dispatch_enable_disable (int is_enable);
471 int vnet_crypto_set_async_handler2 (char *alg_name, char *engine);
473 int vnet_crypto_is_set_async_handler (vnet_crypto_async_op_id_t opt);
475 void vnet_crypto_request_async_mode (int is_enable);
477 void vnet_crypto_set_async_dispatch_mode (u8 mode);
479 vnet_crypto_async_alg_t vnet_crypto_link_algs (vnet_crypto_alg_t crypto_alg,
480 vnet_crypto_alg_t integ_alg);
482 clib_error_t *crypto_dispatch_enable_disable (int is_enable);
484 format_function_t format_vnet_crypto_alg;
485 format_function_t format_vnet_crypto_engine;
486 format_function_t format_vnet_crypto_op;
487 format_function_t format_vnet_crypto_op_type;
488 format_function_t format_vnet_crypto_op_status;
489 unformat_function_t unformat_vnet_crypto_alg;
491 format_function_t format_vnet_crypto_async_op;
492 format_function_t format_vnet_crypto_async_alg;
493 format_function_t format_vnet_crypto_async_op_type;
495 static_always_inline void
496 vnet_crypto_op_init (vnet_crypto_op_t * op, vnet_crypto_op_id_t type)
499 clib_memset (op, 0xfe, sizeof (*op));
506 static_always_inline vnet_crypto_op_type_t
507 vnet_crypto_get_op_type (vnet_crypto_op_id_t id)
509 vnet_crypto_main_t *cm = &crypto_main;
510 ASSERT (id < VNET_CRYPTO_N_OP_IDS);
511 vnet_crypto_op_data_t *od = cm->opt_data + id;
515 static_always_inline vnet_crypto_key_t *
516 vnet_crypto_get_key (vnet_crypto_key_index_t index)
518 vnet_crypto_main_t *cm = &crypto_main;
519 return vec_elt_at_index (cm->keys, index);
522 static_always_inline int
523 vnet_crypto_set_handler (char *alg_name, char *engine)
525 return vnet_crypto_set_handler2 (alg_name, engine, CRYPTO_OP_BOTH);
528 /** async crypto inline functions **/
530 static_always_inline vnet_crypto_async_frame_t *
531 vnet_crypto_async_get_frame (vlib_main_t * vm, vnet_crypto_async_op_id_t opt)
533 vnet_crypto_main_t *cm = &crypto_main;
534 vnet_crypto_thread_t *ct = cm->threads + vm->thread_index;
535 vnet_crypto_async_frame_t *f = ct->frames[opt];
539 pool_get_aligned (ct->frame_pool, f, CLIB_CACHE_LINE_BYTES);
541 clib_memset (f, 0xfe, sizeof (*f));
542 f->state = VNET_CRYPTO_FRAME_STATE_NOT_PROCESSED;
550 static_always_inline void
551 vnet_crypto_async_free_frame (vlib_main_t * vm,
552 vnet_crypto_async_frame_t * frame)
554 vnet_crypto_main_t *cm = &crypto_main;
555 vnet_crypto_thread_t *ct = cm->threads + vm->thread_index;
556 pool_put (ct->frame_pool, frame);
559 static_always_inline int
560 vnet_crypto_async_submit_open_frame (vlib_main_t * vm,
561 vnet_crypto_async_frame_t * frame)
563 vnet_crypto_main_t *cm = &crypto_main;
564 vlib_thread_main_t *tm = vlib_get_thread_main ();
565 vnet_crypto_thread_t *ct = cm->threads + vm->thread_index;
566 vnet_crypto_async_op_id_t opt = frame->op;
567 u32 i = vlib_num_workers () > 0;
569 int ret = (cm->enqueue_handlers[frame->op]) (vm, frame);
570 frame->enqueue_thread_index = vm->thread_index;
571 clib_bitmap_set_no_check (cm->async_active_ids, opt, 1);
572 if (PREDICT_TRUE (ret == 0))
574 vnet_crypto_async_frame_t *nf = 0;
575 frame->state = VNET_CRYPTO_FRAME_STATE_PENDING;
576 pool_get_aligned (ct->frame_pool, nf, CLIB_CACHE_LINE_BYTES);
578 clib_memset (nf, 0xfe, sizeof (*nf));
579 nf->state = VNET_CRYPTO_FRAME_STATE_NOT_PROCESSED;
582 ct->frames[opt] = nf;
585 if (cm->dispatch_mode == VNET_CRYPTO_ASYNC_DISPATCH_INTERRUPT)
587 for (; i < tm->n_vlib_mains; i++)
589 vlib_node_set_interrupt_pending (vlib_mains[i],
590 cm->crypto_node_index);
596 static_always_inline int
597 vnet_crypto_async_add_to_frame (vlib_main_t * vm,
598 vnet_crypto_async_frame_t ** frame,
600 u32 crypto_len, i16 integ_len_adj,
601 i16 crypto_start_offset,
602 u16 integ_start_offset,
605 u8 * iv, u8 * tag, u8 * aad, u8 flags)
607 vnet_crypto_async_frame_t *f = *frame;
608 vnet_crypto_async_frame_elt_t *fe;
611 if (PREDICT_FALSE (f->n_elts == VNET_CRYPTO_FRAME_SIZE))
613 vnet_crypto_async_op_id_t opt = f->op;
615 ret = vnet_crypto_async_submit_open_frame (vm, f);
616 if (PREDICT_FALSE (ret < 0))
618 f = vnet_crypto_async_get_frame (vm, opt);
623 fe = &f->elts[index];
625 fe->key_index = key_index;
626 fe->crypto_total_length = crypto_len;
627 fe->crypto_start_offset = crypto_start_offset;
628 fe->integ_start_offset = integ_start_offset;
629 fe->integ_length_adj = integ_len_adj;
634 f->buffer_indices[index] = buffer_index;
635 f->next_node_index[index] = next_node;
640 static_always_inline void
641 vnet_crypto_async_reset_frame (vnet_crypto_async_frame_t * f)
643 vnet_crypto_async_op_id_t opt;
645 ASSERT (f->state == VNET_CRYPTO_FRAME_STATE_NOT_PROCESSED);
648 clib_memset (f, 0xfe, sizeof (*f));
649 f->state = VNET_CRYPTO_FRAME_STATE_NOT_PROCESSED;
654 #endif /* included_vnet_crypto_crypto_h */
657 * fd.io coding-style-patch-verification: ON
660 * eval: (c-set-style "gnu")