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 #define foreach_crypto_cipher_alg \
24 _(DES_CBC, "des-cbc") \
25 _(3DES_CBC, "3des-cbc") \
26 _(AES_128_CBC, "aes-128-cbc") \
27 _(AES_192_CBC, "aes-192-cbc") \
28 _(AES_256_CBC, "aes-256-cbc")
30 #define foreach_crypto_aead_alg \
31 _(AES_128_GCM, "aes-128-gcm") \
32 _(AES_192_GCM, "aes-192-gcm") \
33 _(AES_256_GCM, "aes-256-gcm")
35 #define foreach_crypto_hmac_alg \
38 _(SHA224, "sha-224") \
39 _(SHA256, "sha-256") \
40 _(SHA384, "sha-384") \
44 #define foreach_crypto_op_type \
45 _(ENCRYPT, "encrypt") \
46 _(DECRYPT, "decrypt") \
47 _(AEAD_ENCRYPT, "aead-encrypt") \
48 _(AEAD_DECRYPT, "aead-decrypt") \
53 #define _(n, s) VNET_CRYPTO_OP_TYPE_##n,
54 foreach_crypto_op_type
56 VNET_CRYPTO_OP_N_TYPES,
57 } vnet_crypto_op_type_t;
59 #define foreach_crypto_op_status \
60 _(PENDING, "pending") \
61 _(COMPLETED, "completed") \
62 _(FAIL_NO_HANDLER, "no-handler") \
63 _(FAIL_BAD_HMAC, "bad-hmac") \
64 _(FAIL_DECRYPT, "decrypt-fail")
68 #define _(n, s) VNET_CRYPTO_OP_STATUS_##n,
69 foreach_crypto_op_status
71 VNET_CRYPTO_OP_N_STATUS,
72 } vnet_crypto_op_status_t;
77 #define _(n, s) VNET_CRYPTO_ALG_##n,
78 foreach_crypto_cipher_alg
79 foreach_crypto_aead_alg
81 #define _(n, s) VNET_CRYPTO_ALG_HMAC_##n,
82 foreach_crypto_hmac_alg
89 VNET_CRYPTO_OP_NONE = 0,
90 #define _(n, s) VNET_CRYPTO_OP_##n##_ENC, VNET_CRYPTO_OP_##n##_DEC,
91 foreach_crypto_cipher_alg
92 foreach_crypto_aead_alg
94 #define _(n, s) VNET_CRYPTO_OP_##n##_HMAC,
95 foreach_crypto_hmac_alg
98 } vnet_crypto_op_id_t;
104 vnet_crypto_op_id_t op_by_type[VNET_CRYPTO_OP_N_TYPES];
105 } vnet_crypto_alg_data_t;
109 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
110 vnet_crypto_op_id_t op:16;
111 vnet_crypto_op_status_t status:8;
113 #define VNET_CRYPTO_OP_FLAG_INIT_IV (1 << 0)
114 #define VNET_CRYPTO_OP_FLAG_HMAC_CHECK (1 << 1)
117 u8 key_len, iv_len, digest_len, tag_len;
130 vnet_crypto_op_type_t type;
131 vnet_crypto_alg_t alg;
132 u32 active_engine_index;
133 } vnet_crypto_op_data_t;
137 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
138 clib_bitmap_t *act_queues;
139 } vnet_crypto_thread_t;
141 typedef u32 (vnet_crypto_ops_handler_t) (vlib_main_t * vm,
142 vnet_crypto_op_t * ops[], u32 n_ops);
144 u32 vnet_crypto_register_engine (vlib_main_t * vm, char *name, int prio,
147 vlib_error_t *vnet_crypto_register_ops_handler (vlib_main_t * vm,
149 vnet_crypto_op_id_t opt,
150 vnet_crypto_ops_handler_t *
158 vnet_crypto_ops_handler_t *ops_handlers[VNET_CRYPTO_N_OP_IDS];
159 } vnet_crypto_engine_t;
163 vnet_crypto_alg_data_t *algs;
164 vnet_crypto_thread_t *threads;
165 vnet_crypto_ops_handler_t **ops_handlers;
166 vnet_crypto_op_data_t opt_data[VNET_CRYPTO_N_OP_IDS];
167 vnet_crypto_engine_t *engines;
168 uword *engine_index_by_name;
169 uword *alg_index_by_name;
170 } vnet_crypto_main_t;
172 extern vnet_crypto_main_t crypto_main;
174 u32 vnet_crypto_submit_ops (vlib_main_t * vm, vnet_crypto_op_t ** jobs,
177 u32 vnet_crypto_process_ops (vlib_main_t * vm, vnet_crypto_op_t ops[],
181 int vnet_crypto_set_handler (char *ops_handler_name, char *engine);
183 format_function_t format_vnet_crypto_alg;
184 format_function_t format_vnet_crypto_engine;
185 format_function_t format_vnet_crypto_op;
186 format_function_t format_vnet_crypto_op_type;
187 format_function_t format_vnet_crypto_op_status;
188 unformat_function_t unformat_vnet_crypto_alg;
190 static_always_inline void
191 vnet_crypto_op_init (vnet_crypto_op_t * op, vnet_crypto_op_id_t type)
194 clib_memset (op, 0xfe, sizeof (*op));
199 static_always_inline vnet_crypto_op_type_t
200 vnet_crypto_get_op_type (vnet_crypto_op_id_t id)
202 vnet_crypto_main_t *cm = &crypto_main;
203 vnet_crypto_op_data_t *od = vec_elt_at_index (cm->opt_data, id);
207 #endif /* included_vnet_crypto_crypto_h */
210 * fd.io coding-style-patch-verification: ON
213 * eval: (c-set-style "gnu")