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) \
103 _ (AES_128_CTR, SHA1, "aes-128-ctr-hmac-sha-1", 16, 12) \
104 _ (AES_192_CTR, SHA1, "aes-192-ctr-hmac-sha-1", 24, 12) \
105 _ (AES_256_CTR, SHA1, "aes-256-ctr-hmac-sha-1", 32, 12)
107 #define foreach_crypto_async_op_type \
108 _(ENCRYPT, "async-encrypt") \
109 _(DECRYPT, "async-decrypt")
113 VNET_CRYPTO_KEY_OP_ADD,
114 VNET_CRYPTO_KEY_OP_DEL,
115 VNET_CRYPTO_KEY_OP_MODIFY,
116 } vnet_crypto_key_op_t;
120 #define _(n, s) VNET_CRYPTO_OP_STATUS_##n,
121 foreach_crypto_op_status
123 VNET_CRYPTO_OP_N_STATUS,
124 } vnet_crypto_op_status_t;
129 VNET_CRYPTO_ALG_NONE = 0,
130 #define _(n, s, l) VNET_CRYPTO_ALG_##n,
131 foreach_crypto_cipher_alg
132 foreach_crypto_aead_alg
134 #define _(n, s) VNET_CRYPTO_ALG_HMAC_##n,
135 foreach_crypto_hmac_alg
142 #define _(n, s) VNET_CRYPTO_ASYNC_OP_TYPE_##n,
143 foreach_crypto_async_op_type
145 VNET_CRYPTO_ASYNC_OP_N_TYPES,
146 } vnet_crypto_async_op_type_t;
150 VNET_CRYPTO_ASYNC_ALG_NONE = 0,
151 #define _(n, s, k, t, a) \
152 VNET_CRYPTO_ALG_##n##_TAG##t##_AAD##a,
153 foreach_crypto_aead_async_alg
155 #define _(c, h, s, k ,d) \
156 VNET_CRYPTO_ALG_##c##_##h##_TAG##d,
157 foreach_crypto_link_async_alg
159 VNET_CRYPTO_N_ASYNC_ALGS,
160 } vnet_crypto_async_alg_t;
164 VNET_CRYPTO_ASYNC_OP_NONE = 0,
165 #define _(n, s, k, t, a) \
166 VNET_CRYPTO_OP_##n##_TAG##t##_AAD##a##_ENC, \
167 VNET_CRYPTO_OP_##n##_TAG##t##_AAD##a##_DEC,
168 foreach_crypto_aead_async_alg
170 #define _(c, h, s, k ,d) \
171 VNET_CRYPTO_OP_##c##_##h##_TAG##d##_ENC, \
172 VNET_CRYPTO_OP_##c##_##h##_TAG##d##_DEC,
173 foreach_crypto_link_async_alg
175 VNET_CRYPTO_ASYNC_OP_N_IDS,
176 } vnet_crypto_async_op_id_t;
185 vnet_crypto_alg_t alg:8;
191 vnet_crypto_async_alg_t async_alg:8;
194 #define VNET_CRYPTO_KEY_TYPE_DATA 0
195 #define VNET_CRYPTO_KEY_TYPE_LINK 1
201 VNET_CRYPTO_OP_NONE = 0,
202 #define _(n, s, l) VNET_CRYPTO_OP_##n##_ENC, VNET_CRYPTO_OP_##n##_DEC,
203 foreach_crypto_cipher_alg
204 foreach_crypto_aead_alg
206 #define _(n, s) VNET_CRYPTO_OP_##n##_HMAC,
207 foreach_crypto_hmac_alg
209 VNET_CRYPTO_N_OP_IDS,
210 } vnet_crypto_op_id_t;
218 } crypto_op_class_type_t;
223 vnet_crypto_op_id_t op_by_type[VNET_CRYPTO_OP_N_TYPES];
224 } vnet_crypto_alg_data_t;
231 } vnet_crypto_op_chunk_t;
235 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
237 vnet_crypto_op_id_t op:16;
238 vnet_crypto_op_status_t status:8;
240 #define VNET_CRYPTO_OP_FLAG_INIT_IV (1 << 0)
241 #define VNET_CRYPTO_OP_FLAG_HMAC_CHECK (1 << 1)
242 #define VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS (1 << 2)
259 /* valid if VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS is set */
266 /* valid if VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS is set */
281 STATIC_ASSERT_SIZEOF (vnet_crypto_op_t, CLIB_CACHE_LINE_BYTES);
285 vnet_crypto_op_type_t type;
286 vnet_crypto_alg_t alg;
287 u32 active_engine_index_simple;
288 u32 active_engine_index_chained;
289 } vnet_crypto_op_data_t;
293 vnet_crypto_async_op_type_t type;
294 vnet_crypto_async_alg_t alg;
295 u32 active_engine_index_async;
296 } vnet_crypto_async_op_data_t;
301 vnet_crypto_async_op_id_t op_by_type[VNET_CRYPTO_ASYNC_OP_N_TYPES];
302 } vnet_crypto_async_alg_data_t;
314 u32 crypto_total_length;
315 i16 crypto_start_offset; /* first buffer offset */
316 i16 integ_start_offset;
317 /* adj total_length for integ, e.g.4 bytes for IPSec ESN */
318 u16 integ_length_adj;
319 vnet_crypto_op_status_t status : 8;
320 u8 flags; /**< share same VNET_CRYPTO_OP_FLAG_* values */
321 } vnet_crypto_async_frame_elt_t;
323 /* Assert the size so the compiler will warn us when it changes */
324 STATIC_ASSERT_SIZEOF (vnet_crypto_async_frame_elt_t, 5 * sizeof (u64));
326 typedef enum vnet_crypto_async_frame_state_t_
328 VNET_CRYPTO_FRAME_STATE_NOT_PROCESSED,
329 /* frame waiting to be processed */
330 VNET_CRYPTO_FRAME_STATE_PENDING,
331 VNET_CRYPTO_FRAME_STATE_WORK_IN_PROGRESS,
332 VNET_CRYPTO_FRAME_STATE_SUCCESS,
333 VNET_CRYPTO_FRAME_STATE_ELT_ERROR
334 } __clib_packed vnet_crypto_async_frame_state_t;
338 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
339 vnet_crypto_async_frame_state_t state;
340 vnet_crypto_async_op_id_t op:8;
342 vnet_crypto_async_frame_elt_t elts[VNET_CRYPTO_FRAME_SIZE];
343 u32 buffer_indices[VNET_CRYPTO_FRAME_SIZE];
344 u16 next_node_index[VNET_CRYPTO_FRAME_SIZE];
345 u32 enqueue_thread_index;
346 } vnet_crypto_async_frame_t;
350 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
351 vnet_crypto_async_frame_t *frame_pool;
354 } vnet_crypto_thread_t;
356 typedef u32 vnet_crypto_key_index_t;
358 typedef u32 (vnet_crypto_chained_ops_handler_t) (vlib_main_t * vm,
359 vnet_crypto_op_t * ops[],
360 vnet_crypto_op_chunk_t *
363 typedef u32 (vnet_crypto_ops_handler_t) (vlib_main_t * vm,
364 vnet_crypto_op_t * ops[], u32 n_ops);
366 typedef void (vnet_crypto_key_handler_t) (vlib_main_t * vm,
367 vnet_crypto_key_op_t kop,
368 vnet_crypto_key_index_t idx);
370 /** async crypto function handlers **/
372 (vnet_crypto_frame_enqueue_t) (vlib_main_t * vm,
373 vnet_crypto_async_frame_t * frame);
374 typedef vnet_crypto_async_frame_t *
375 (vnet_crypto_frame_dequeue_t) (vlib_main_t * vm, u32 * nb_elts_processed,
376 u32 * enqueue_thread_idx);
379 vnet_crypto_register_engine (vlib_main_t * vm, char *name, int prio,
382 void vnet_crypto_register_ops_handler (vlib_main_t * vm, u32 engine_index,
383 vnet_crypto_op_id_t opt,
384 vnet_crypto_ops_handler_t * oph);
386 void vnet_crypto_register_chained_ops_handler (vlib_main_t * vm,
388 vnet_crypto_op_id_t opt,
389 vnet_crypto_chained_ops_handler_t
392 void vnet_crypto_register_ops_handlers (vlib_main_t * vm, u32 engine_index,
393 vnet_crypto_op_id_t opt,
394 vnet_crypto_ops_handler_t * fn,
395 vnet_crypto_chained_ops_handler_t *
398 void vnet_crypto_register_key_handler (vlib_main_t * vm, u32 engine_index,
399 vnet_crypto_key_handler_t * keyh);
401 /** async crypto register functions */
402 u32 vnet_crypto_register_post_node (vlib_main_t * vm, char *post_node_name);
403 void vnet_crypto_register_async_handler (vlib_main_t * vm,
405 vnet_crypto_async_op_id_t opt,
406 vnet_crypto_frame_enqueue_t * enq_fn,
407 vnet_crypto_frame_dequeue_t *
415 vnet_crypto_key_handler_t *key_op_handler;
416 vnet_crypto_ops_handler_t *ops_handlers[VNET_CRYPTO_N_OP_IDS];
417 vnet_crypto_chained_ops_handler_t
418 * chained_ops_handlers[VNET_CRYPTO_N_OP_IDS];
419 vnet_crypto_frame_enqueue_t *enqueue_handlers[VNET_CRYPTO_ASYNC_OP_N_IDS];
420 vnet_crypto_frame_dequeue_t *dequeue_handlers[VNET_CRYPTO_ASYNC_OP_N_IDS];
421 } vnet_crypto_engine_t;
427 } vnet_crypto_async_next_node_t;
431 vnet_crypto_alg_data_t *algs;
432 vnet_crypto_thread_t *threads;
433 vnet_crypto_ops_handler_t **ops_handlers;
434 vnet_crypto_chained_ops_handler_t **chained_ops_handlers;
435 vnet_crypto_frame_enqueue_t **enqueue_handlers;
436 vnet_crypto_frame_dequeue_t **dequeue_handlers;
437 clib_bitmap_t *async_active_ids;
438 vnet_crypto_op_data_t opt_data[VNET_CRYPTO_N_OP_IDS];
439 vnet_crypto_async_op_data_t async_opt_data[VNET_CRYPTO_ASYNC_OP_N_IDS];
440 vnet_crypto_engine_t *engines;
441 vnet_crypto_key_t *keys;
442 uword *engine_index_by_name;
443 uword *alg_index_by_name;
444 uword *async_alg_index_by_name;
445 vnet_crypto_async_alg_data_t *async_algs;
447 vnet_crypto_async_next_node_t *next_nodes;
448 u32 crypto_node_index;
449 #define VNET_CRYPTO_ASYNC_DISPATCH_POLLING 0
450 #define VNET_CRYPTO_ASYNC_DISPATCH_INTERRUPT 1
452 } vnet_crypto_main_t;
454 extern vnet_crypto_main_t crypto_main;
456 u32 vnet_crypto_process_chained_ops (vlib_main_t * vm, vnet_crypto_op_t ops[],
457 vnet_crypto_op_chunk_t * chunks,
459 u32 vnet_crypto_process_ops (vlib_main_t * vm, vnet_crypto_op_t ops[],
463 int vnet_crypto_set_handler2 (char *ops_handler_name, char *engine,
464 crypto_op_class_type_t oct);
465 int vnet_crypto_is_set_handler (vnet_crypto_alg_t alg);
467 u32 vnet_crypto_key_add (vlib_main_t * vm, vnet_crypto_alg_t alg,
468 u8 * data, u16 length);
469 void vnet_crypto_key_del (vlib_main_t * vm, vnet_crypto_key_index_t index);
472 * Use 2 created keys to generate new key for linked algs (cipher + integ)
473 * The returned key index is to be used for linked alg only.
475 u32 vnet_crypto_key_add_linked (vlib_main_t * vm,
476 vnet_crypto_key_index_t index_crypto,
477 vnet_crypto_key_index_t index_integ);
479 clib_error_t *crypto_dispatch_enable_disable (int is_enable);
481 int vnet_crypto_set_async_handler2 (char *alg_name, char *engine);
483 int vnet_crypto_is_set_async_handler (vnet_crypto_async_op_id_t opt);
485 void vnet_crypto_request_async_mode (int is_enable);
487 void vnet_crypto_set_async_dispatch_mode (u8 mode);
489 vnet_crypto_async_alg_t vnet_crypto_link_algs (vnet_crypto_alg_t crypto_alg,
490 vnet_crypto_alg_t integ_alg);
492 clib_error_t *crypto_dispatch_enable_disable (int is_enable);
494 format_function_t format_vnet_crypto_alg;
495 format_function_t format_vnet_crypto_engine;
496 format_function_t format_vnet_crypto_op;
497 format_function_t format_vnet_crypto_op_type;
498 format_function_t format_vnet_crypto_op_status;
499 unformat_function_t unformat_vnet_crypto_alg;
501 format_function_t format_vnet_crypto_async_op;
502 format_function_t format_vnet_crypto_async_alg;
503 format_function_t format_vnet_crypto_async_op_type;
505 static_always_inline void
506 vnet_crypto_op_init (vnet_crypto_op_t * op, vnet_crypto_op_id_t type)
509 clib_memset (op, 0xfe, sizeof (*op));
516 static_always_inline vnet_crypto_op_type_t
517 vnet_crypto_get_op_type (vnet_crypto_op_id_t id)
519 vnet_crypto_main_t *cm = &crypto_main;
520 ASSERT (id < VNET_CRYPTO_N_OP_IDS);
521 vnet_crypto_op_data_t *od = cm->opt_data + id;
525 static_always_inline vnet_crypto_key_t *
526 vnet_crypto_get_key (vnet_crypto_key_index_t index)
528 vnet_crypto_main_t *cm = &crypto_main;
529 return vec_elt_at_index (cm->keys, index);
532 static_always_inline int
533 vnet_crypto_set_handler (char *alg_name, char *engine)
535 return vnet_crypto_set_handler2 (alg_name, engine, CRYPTO_OP_BOTH);
538 /** async crypto inline functions **/
540 static_always_inline vnet_crypto_async_frame_t *
541 vnet_crypto_async_get_frame (vlib_main_t * vm, vnet_crypto_async_op_id_t opt)
543 vnet_crypto_main_t *cm = &crypto_main;
544 vnet_crypto_thread_t *ct = cm->threads + vm->thread_index;
545 vnet_crypto_async_frame_t *f = NULL;
547 pool_get_aligned (ct->frame_pool, f, CLIB_CACHE_LINE_BYTES);
549 clib_memset (f, 0xfe, sizeof (*f));
550 f->state = VNET_CRYPTO_FRAME_STATE_NOT_PROCESSED;
557 static_always_inline void
558 vnet_crypto_async_free_frame (vlib_main_t * vm,
559 vnet_crypto_async_frame_t * frame)
561 vnet_crypto_main_t *cm = &crypto_main;
562 vnet_crypto_thread_t *ct = cm->threads + vm->thread_index;
563 pool_put (ct->frame_pool, frame);
566 static_always_inline int
567 vnet_crypto_async_submit_open_frame (vlib_main_t * vm,
568 vnet_crypto_async_frame_t * frame)
570 vnet_crypto_main_t *cm = &crypto_main;
571 vlib_thread_main_t *tm = vlib_get_thread_main ();
572 vnet_crypto_async_op_id_t opt = frame->op;
573 u32 i = vlib_num_workers () > 0;
575 frame->state = VNET_CRYPTO_FRAME_STATE_PENDING;
576 frame->enqueue_thread_index = vm->thread_index;
578 int ret = (cm->enqueue_handlers[frame->op]) (vm, frame);
580 clib_bitmap_set_no_check (cm->async_active_ids, opt, 1);
581 if (PREDICT_TRUE (ret == 0))
583 if (cm->dispatch_mode == VNET_CRYPTO_ASYNC_DISPATCH_INTERRUPT)
585 for (; i < tm->n_vlib_mains; i++)
586 vlib_node_set_interrupt_pending (vlib_mains[i],
587 cm->crypto_node_index);
592 frame->state = VNET_CRYPTO_FRAME_STATE_ELT_ERROR;
598 static_always_inline void
599 vnet_crypto_async_add_to_frame (vlib_main_t *vm, vnet_crypto_async_frame_t *f,
600 u32 key_index, u32 crypto_len,
601 i16 integ_len_adj, i16 crypto_start_offset,
602 u16 integ_start_offset, u32 buffer_index,
603 u16 next_node, u8 *iv, u8 *tag, u8 *aad,
606 vnet_crypto_async_frame_elt_t *fe;
609 ASSERT (f->n_elts < VNET_CRYPTO_FRAME_SIZE);
612 fe = &f->elts[index];
614 fe->key_index = key_index;
615 fe->crypto_total_length = crypto_len;
616 fe->crypto_start_offset = crypto_start_offset;
617 fe->integ_start_offset = integ_start_offset;
618 fe->integ_length_adj = integ_len_adj;
623 f->buffer_indices[index] = buffer_index;
624 f->next_node_index[index] = next_node;
627 static_always_inline void
628 vnet_crypto_async_reset_frame (vnet_crypto_async_frame_t * f)
630 vnet_crypto_async_op_id_t opt;
632 ASSERT ((f->state == VNET_CRYPTO_FRAME_STATE_NOT_PROCESSED
633 || f->state == VNET_CRYPTO_FRAME_STATE_ELT_ERROR));
636 clib_memset (f, 0xfe, sizeof (*f));
637 f->state = VNET_CRYPTO_FRAME_STATE_NOT_PROCESSED;
642 static_always_inline u8
643 vnet_crypto_async_frame_is_full (const vnet_crypto_async_frame_t *f)
645 return (f->n_elts == VNET_CRYPTO_FRAME_SIZE);
648 #endif /* included_vnet_crypto_crypto_h */
651 * fd.io coding-style-patch-verification: ON
654 * eval: (c-set-style "gnu")