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", 14) \
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") \
69 _(FAIL_DECRYPT, "decrypt-fail")
73 VNET_CRYPTO_KEY_OP_ADD,
74 VNET_CRYPTO_KEY_OP_DEL,
75 VNET_CRYPTO_KEY_OP_MODIFY,
76 } vnet_crypto_key_op_t;
80 #define _(n, s) VNET_CRYPTO_OP_STATUS_##n,
81 foreach_crypto_op_status
83 VNET_CRYPTO_OP_N_STATUS,
84 } vnet_crypto_op_status_t;
89 VNET_CRYPTO_ALG_NONE = 0,
90 #define _(n, s, l) VNET_CRYPTO_ALG_##n,
91 foreach_crypto_cipher_alg
92 foreach_crypto_aead_alg
94 #define _(n, s) VNET_CRYPTO_ALG_HMAC_##n,
95 foreach_crypto_hmac_alg
103 vnet_crypto_alg_t alg:8;
108 VNET_CRYPTO_OP_NONE = 0,
109 #define _(n, s, l) VNET_CRYPTO_OP_##n##_ENC, VNET_CRYPTO_OP_##n##_DEC,
110 foreach_crypto_cipher_alg
111 foreach_crypto_aead_alg
113 #define _(n, s) VNET_CRYPTO_OP_##n##_HMAC,
114 foreach_crypto_hmac_alg
116 VNET_CRYPTO_N_OP_IDS,
117 } vnet_crypto_op_id_t;
123 vnet_crypto_op_id_t op_by_type[VNET_CRYPTO_OP_N_TYPES];
124 } vnet_crypto_alg_data_t;
128 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
129 vnet_crypto_op_id_t op:16;
130 vnet_crypto_op_status_t status:8;
132 #define VNET_CRYPTO_OP_FLAG_INIT_IV (1 << 0)
133 #define VNET_CRYPTO_OP_FLAG_HMAC_CHECK (1 << 1)
137 u8 digest_len, tag_len;
149 vnet_crypto_op_type_t type;
150 vnet_crypto_alg_t alg;
151 u32 active_engine_index;
152 } vnet_crypto_op_data_t;
156 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
157 clib_bitmap_t *act_queues;
158 } vnet_crypto_thread_t;
160 typedef u32 vnet_crypto_key_index_t;
162 typedef u32 (vnet_crypto_ops_handler_t) (vlib_main_t * vm,
163 vnet_crypto_op_t * ops[], u32 n_ops);
165 typedef void (vnet_crypto_key_handler_t) (vlib_main_t * vm,
166 vnet_crypto_key_op_t kop,
167 vnet_crypto_key_index_t idx);
169 u32 vnet_crypto_register_engine (vlib_main_t * vm, char *name, int prio,
172 void vnet_crypto_register_ops_handler (vlib_main_t * vm, u32 engine_index,
173 vnet_crypto_op_id_t opt,
174 vnet_crypto_ops_handler_t * oph);
175 void vnet_crypto_register_key_handler (vlib_main_t * vm, u32 engine_index,
176 vnet_crypto_key_handler_t * keyh);
183 vnet_crypto_key_handler_t *key_op_handler;
184 vnet_crypto_ops_handler_t *ops_handlers[VNET_CRYPTO_N_OP_IDS];
185 } vnet_crypto_engine_t;
189 vnet_crypto_alg_data_t *algs;
190 vnet_crypto_thread_t *threads;
191 vnet_crypto_ops_handler_t **ops_handlers;
192 vnet_crypto_op_data_t opt_data[VNET_CRYPTO_N_OP_IDS];
193 vnet_crypto_engine_t *engines;
194 vnet_crypto_key_t *keys;
195 uword *engine_index_by_name;
196 uword *alg_index_by_name;
197 } vnet_crypto_main_t;
199 extern vnet_crypto_main_t crypto_main;
201 u32 vnet_crypto_submit_ops (vlib_main_t * vm, vnet_crypto_op_t ** jobs,
204 u32 vnet_crypto_process_ops (vlib_main_t * vm, vnet_crypto_op_t ops[],
207 int vnet_crypto_set_handler (char *ops_handler_name, char *engine);
209 u32 vnet_crypto_key_add (vlib_main_t * vm, vnet_crypto_alg_t alg,
210 u8 * data, u16 length);
211 void vnet_crypto_key_del (vlib_main_t * vm, vnet_crypto_key_index_t index);
212 void vnet_crypto_key_modify (vlib_main_t * vm, vnet_crypto_key_index_t index,
213 vnet_crypto_alg_t alg, u8 * data, u16 len);
215 format_function_t format_vnet_crypto_alg;
216 format_function_t format_vnet_crypto_engine;
217 format_function_t format_vnet_crypto_op;
218 format_function_t format_vnet_crypto_op_type;
219 format_function_t format_vnet_crypto_op_status;
220 unformat_function_t unformat_vnet_crypto_alg;
222 static_always_inline void
223 vnet_crypto_op_init (vnet_crypto_op_t * op, vnet_crypto_op_id_t type)
226 clib_memset (op, 0xfe, sizeof (*op));
232 static_always_inline vnet_crypto_op_type_t
233 vnet_crypto_get_op_type (vnet_crypto_op_id_t id)
235 vnet_crypto_main_t *cm = &crypto_main;
236 vnet_crypto_op_data_t *od = vec_elt_at_index (cm->opt_data, id);
240 static_always_inline vnet_crypto_key_t *
241 vnet_crypto_get_key (vnet_crypto_key_index_t index)
243 vnet_crypto_main_t *cm = &crypto_main;
244 return vec_elt_at_index (cm->keys, index);
247 #endif /* included_vnet_crypto_crypto_h */
250 * fd.io coding-style-patch-verification: ON
253 * eval: (c-set-style "gnu")