blob: a44c8910555d7792424efe03e940f08ab906f6fd [file] [log] [blame]
Damjan Marion91f17dc2019-03-18 18:59:25 +01001/*
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:
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
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.
14 */
15
16#ifndef included_vnet_crypto_crypto_h
17#define included_vnet_crypto_crypto_h
18
Damjan Marion91f17dc2019-03-18 18:59:25 +010019#include <vlib/vlib.h>
20
PiotrX Kleski22848172020-07-08 14:36:34 +020021#define VNET_CRYPTO_FRAME_SIZE 64
Fan Zhange4db9452021-03-30 17:31:38 +010022#define VNET_CRYPTO_FRAME_POOL_SIZE 1024
Fan Zhangf5395782020-04-29 14:00:03 +010023
Benoît Gannebe954442019-04-29 16:05:46 +020024/* CRYPTO_ID, PRETTY_NAME, KEY_LENGTH_IN_BYTES */
Damjan Marion060bfb92019-03-29 13:47:54 +010025#define foreach_crypto_cipher_alg \
Benoît Gannebe954442019-04-29 16:05:46 +020026 _(DES_CBC, "des-cbc", 7) \
Neale Rannse6be7022019-06-04 15:37:34 +000027 _(3DES_CBC, "3des-cbc", 24) \
Benoît Gannebe954442019-04-29 16:05:46 +020028 _(AES_128_CBC, "aes-128-cbc", 16) \
29 _(AES_192_CBC, "aes-192-cbc", 24) \
30 _(AES_256_CBC, "aes-256-cbc", 32) \
31 _(AES_128_CTR, "aes-128-ctr", 16) \
32 _(AES_192_CTR, "aes-192-ctr", 24) \
33 _(AES_256_CTR, "aes-256-ctr", 32)
Damjan Marion91f17dc2019-03-18 18:59:25 +010034
Benoît Gannebe954442019-04-29 16:05:46 +020035/* CRYPTO_ID, PRETTY_NAME, KEY_LENGTH_IN_BYTES */
Damjan Marion060bfb92019-03-29 13:47:54 +010036#define foreach_crypto_aead_alg \
Benoît Gannebe954442019-04-29 16:05:46 +020037 _(AES_128_GCM, "aes-128-gcm", 16) \
38 _(AES_192_GCM, "aes-192-gcm", 24) \
Artem Glazychev61f49aa2020-08-31 15:37:39 +070039 _(AES_256_GCM, "aes-256-gcm", 32) \
40 _(CHACHA20_POLY1305, "chacha20-poly1305", 32)
Damjan Marion060bfb92019-03-29 13:47:54 +010041
42#define foreach_crypto_hmac_alg \
Filip Tehlare225f712019-03-19 10:37:06 -070043 _(MD5, "md5") \
Damjan Marion91f17dc2019-03-18 18:59:25 +010044 _(SHA1, "sha-1") \
45 _(SHA224, "sha-224") \
46 _(SHA256, "sha-256") \
47 _(SHA384, "sha-384") \
48 _(SHA512, "sha-512")
49
Damjan Marion060bfb92019-03-29 13:47:54 +010050#define foreach_crypto_op_type \
51 _(ENCRYPT, "encrypt") \
52 _(DECRYPT, "decrypt") \
53 _(AEAD_ENCRYPT, "aead-encrypt") \
54 _(AEAD_DECRYPT, "aead-decrypt") \
55 _(HMAC, "hmac")
56
57typedef enum
58{
59#define _(n, s) VNET_CRYPTO_OP_TYPE_##n,
60 foreach_crypto_op_type
61#undef _
62 VNET_CRYPTO_OP_N_TYPES,
63} vnet_crypto_op_type_t;
64
65#define foreach_crypto_op_status \
Fan Zhangf5395782020-04-29 14:00:03 +010066 _(IDLE, "idle") \
Damjan Marion060bfb92019-03-29 13:47:54 +010067 _(PENDING, "pending") \
Fan Zhangf5395782020-04-29 14:00:03 +010068 _(WORK_IN_PROGRESS, "work-in-progress") \
Damjan Marion060bfb92019-03-29 13:47:54 +010069 _(COMPLETED, "completed") \
70 _(FAIL_NO_HANDLER, "no-handler") \
Fan Zhangf5395782020-04-29 14:00:03 +010071 _(FAIL_BAD_HMAC, "bad-hmac") \
72 _(FAIL_ENGINE_ERR, "engine-error")
73
74/** async crypto **/
75
76/* CRYPTO_ID, PRETTY_NAME, KEY_LENGTH_IN_BYTES, TAG_LEN, AAD_LEN */
77#define foreach_crypto_aead_async_alg \
78 _(AES_128_GCM, "aes-128-gcm-aad8", 16, 16, 8) \
79 _(AES_128_GCM, "aes-128-gcm-aad12", 16, 16, 12) \
80 _(AES_192_GCM, "aes-192-gcm-aad8", 24, 16, 8) \
81 _(AES_192_GCM, "aes-192-gcm-aad12", 24, 16, 12) \
82 _(AES_256_GCM, "aes-256-gcm-aad8", 32, 16, 8) \
Artem Glazychev61f49aa2020-08-31 15:37:39 +070083 _(AES_256_GCM, "aes-256-gcm-aad12", 32, 16, 12) \
84 _(CHACHA20_POLY1305, "chacha20-poly1305-aad8", 32, 16, 8) \
85 _(CHACHA20_POLY1305, "chacha20-poly1305-aad12", 32, 16, 12)
Fan Zhangf5395782020-04-29 14:00:03 +010086
87/* CRYPTO_ID, INTEG_ID, PRETTY_NAME, KEY_LENGTH_IN_BYTES, DIGEST_LEN */
Benoît Ganne40ee2002021-01-22 18:09:40 +010088#define foreach_crypto_link_async_alg \
Alexander Chernavin005d1e42021-02-01 05:17:24 -050089 _ (3DES_CBC, MD5, "3des-cbc-hmac-md5", 24, 12) \
90 _ (AES_128_CBC, MD5, "aes-128-cbc-hmac-md5", 16, 12) \
91 _ (AES_192_CBC, MD5, "aes-192-cbc-hmac-md5", 24, 12) \
92 _ (AES_256_CBC, MD5, "aes-256-cbc-hmac-md5", 32, 12) \
93 _ (3DES_CBC, SHA1, "3des-cbc-hmac-sha-1", 24, 12) \
Benoît Ganne40ee2002021-01-22 18:09:40 +010094 _ (AES_128_CBC, SHA1, "aes-128-cbc-hmac-sha-1", 16, 12) \
95 _ (AES_192_CBC, SHA1, "aes-192-cbc-hmac-sha-1", 24, 12) \
96 _ (AES_256_CBC, SHA1, "aes-256-cbc-hmac-sha-1", 32, 12) \
Alexander Chernavin005d1e42021-02-01 05:17:24 -050097 _ (3DES_CBC, SHA224, "3des-cbc-hmac-sha-224", 24, 14) \
Benoît Ganne40ee2002021-01-22 18:09:40 +010098 _ (AES_128_CBC, SHA224, "aes-128-cbc-hmac-sha-224", 16, 14) \
99 _ (AES_192_CBC, SHA224, "aes-192-cbc-hmac-sha-224", 24, 14) \
100 _ (AES_256_CBC, SHA224, "aes-256-cbc-hmac-sha-224", 32, 14) \
Alexander Chernavin005d1e42021-02-01 05:17:24 -0500101 _ (3DES_CBC, SHA256, "3des-cbc-hmac-sha-256", 24, 16) \
Benoît Ganne40ee2002021-01-22 18:09:40 +0100102 _ (AES_128_CBC, SHA256, "aes-128-cbc-hmac-sha-256", 16, 16) \
103 _ (AES_192_CBC, SHA256, "aes-192-cbc-hmac-sha-256", 24, 16) \
104 _ (AES_256_CBC, SHA256, "aes-256-cbc-hmac-sha-256", 32, 16) \
Alexander Chernavin005d1e42021-02-01 05:17:24 -0500105 _ (3DES_CBC, SHA384, "3des-cbc-hmac-sha-384", 24, 24) \
Benoît Ganne40ee2002021-01-22 18:09:40 +0100106 _ (AES_128_CBC, SHA384, "aes-128-cbc-hmac-sha-384", 16, 24) \
107 _ (AES_192_CBC, SHA384, "aes-192-cbc-hmac-sha-384", 24, 24) \
108 _ (AES_256_CBC, SHA384, "aes-256-cbc-hmac-sha-384", 32, 24) \
Alexander Chernavin005d1e42021-02-01 05:17:24 -0500109 _ (3DES_CBC, SHA512, "3des-cbc-hmac-sha-512", 24, 32) \
Benoît Ganne40ee2002021-01-22 18:09:40 +0100110 _ (AES_128_CBC, SHA512, "aes-128-cbc-hmac-sha-512", 16, 32) \
111 _ (AES_192_CBC, SHA512, "aes-192-cbc-hmac-sha-512", 24, 32) \
112 _ (AES_256_CBC, SHA512, "aes-256-cbc-hmac-sha-512", 32, 32) \
113 _ (AES_128_CTR, SHA1, "aes-128-ctr-hmac-sha-1", 16, 12) \
114 _ (AES_192_CTR, SHA1, "aes-192-ctr-hmac-sha-1", 24, 12) \
115 _ (AES_256_CTR, SHA1, "aes-256-ctr-hmac-sha-1", 32, 12)
Fan Zhangf5395782020-04-29 14:00:03 +0100116
117#define foreach_crypto_async_op_type \
118 _(ENCRYPT, "async-encrypt") \
119 _(DECRYPT, "async-decrypt")
Damjan Marion060bfb92019-03-29 13:47:54 +0100120
121typedef enum
122{
Damjan Mariond1bed682019-04-24 15:20:35 +0200123 VNET_CRYPTO_KEY_OP_ADD,
124 VNET_CRYPTO_KEY_OP_DEL,
125 VNET_CRYPTO_KEY_OP_MODIFY,
126} vnet_crypto_key_op_t;
127
128typedef enum
129{
Damjan Marion060bfb92019-03-29 13:47:54 +0100130#define _(n, s) VNET_CRYPTO_OP_STATUS_##n,
131 foreach_crypto_op_status
132#undef _
133 VNET_CRYPTO_OP_N_STATUS,
134} vnet_crypto_op_status_t;
135
Damjan Marion91f17dc2019-03-18 18:59:25 +0100136/* *INDENT-OFF* */
137typedef enum
138{
Damjan Mariond1bed682019-04-24 15:20:35 +0200139 VNET_CRYPTO_ALG_NONE = 0,
Benoît Gannebe954442019-04-29 16:05:46 +0200140#define _(n, s, l) VNET_CRYPTO_ALG_##n,
Damjan Marion060bfb92019-03-29 13:47:54 +0100141 foreach_crypto_cipher_alg
142 foreach_crypto_aead_alg
Damjan Marion91f17dc2019-03-18 18:59:25 +0100143#undef _
Damjan Marion060bfb92019-03-29 13:47:54 +0100144#define _(n, s) VNET_CRYPTO_ALG_HMAC_##n,
145 foreach_crypto_hmac_alg
Damjan Marion91f17dc2019-03-18 18:59:25 +0100146#undef _
147 VNET_CRYPTO_N_ALGS,
148} vnet_crypto_alg_t;
149
Fan Zhangf5395782020-04-29 14:00:03 +0100150typedef enum
151{
152#define _(n, s) VNET_CRYPTO_ASYNC_OP_TYPE_##n,
153 foreach_crypto_async_op_type
154#undef _
155 VNET_CRYPTO_ASYNC_OP_N_TYPES,
156} vnet_crypto_async_op_type_t;
157
158typedef enum
159{
160 VNET_CRYPTO_ASYNC_ALG_NONE = 0,
161#define _(n, s, k, t, a) \
162 VNET_CRYPTO_ALG_##n##_TAG##t##_AAD##a,
163 foreach_crypto_aead_async_alg
164#undef _
165#define _(c, h, s, k ,d) \
166 VNET_CRYPTO_ALG_##c##_##h##_TAG##d,
167 foreach_crypto_link_async_alg
168#undef _
169 VNET_CRYPTO_N_ASYNC_ALGS,
170} vnet_crypto_async_alg_t;
171
172typedef enum
173{
174 VNET_CRYPTO_ASYNC_OP_NONE = 0,
175#define _(n, s, k, t, a) \
176 VNET_CRYPTO_OP_##n##_TAG##t##_AAD##a##_ENC, \
177 VNET_CRYPTO_OP_##n##_TAG##t##_AAD##a##_DEC,
178 foreach_crypto_aead_async_alg
179#undef _
180#define _(c, h, s, k ,d) \
181 VNET_CRYPTO_OP_##c##_##h##_TAG##d##_ENC, \
182 VNET_CRYPTO_OP_##c##_##h##_TAG##d##_DEC,
183 foreach_crypto_link_async_alg
184#undef _
185 VNET_CRYPTO_ASYNC_OP_N_IDS,
186} vnet_crypto_async_op_id_t;
187
Damjan Mariond1bed682019-04-24 15:20:35 +0200188typedef struct
189{
Fan Zhangf5395782020-04-29 14:00:03 +0100190 union
191 {
192 struct
193 {
194 u8 *data;
195 vnet_crypto_alg_t alg:8;
196 };
197 struct
198 {
199 u32 index_crypto;
200 u32 index_integ;
201 vnet_crypto_async_alg_t async_alg:8;
202 };
203 };
204#define VNET_CRYPTO_KEY_TYPE_DATA 0
205#define VNET_CRYPTO_KEY_TYPE_LINK 1
206 u8 type;
Damjan Mariond1bed682019-04-24 15:20:35 +0200207} vnet_crypto_key_t;
208
Damjan Marion91f17dc2019-03-18 18:59:25 +0100209typedef enum
210{
211 VNET_CRYPTO_OP_NONE = 0,
Benoît Gannebe954442019-04-29 16:05:46 +0200212#define _(n, s, l) VNET_CRYPTO_OP_##n##_ENC, VNET_CRYPTO_OP_##n##_DEC,
Damjan Marion060bfb92019-03-29 13:47:54 +0100213 foreach_crypto_cipher_alg
214 foreach_crypto_aead_alg
Damjan Marion91f17dc2019-03-18 18:59:25 +0100215#undef _
216#define _(n, s) VNET_CRYPTO_OP_##n##_HMAC,
Damjan Marion060bfb92019-03-29 13:47:54 +0100217 foreach_crypto_hmac_alg
Damjan Marion91f17dc2019-03-18 18:59:25 +0100218#undef _
Damjan Marion060bfb92019-03-29 13:47:54 +0100219 VNET_CRYPTO_N_OP_IDS,
220} vnet_crypto_op_id_t;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100221/* *INDENT-ON* */
222
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000223typedef enum
224{
225 CRYPTO_OP_SIMPLE,
226 CRYPTO_OP_CHAINED,
227 CRYPTO_OP_BOTH,
228} crypto_op_class_type_t;
229
Damjan Marion91f17dc2019-03-18 18:59:25 +0100230typedef struct
231{
232 char *name;
Damjan Marion060bfb92019-03-29 13:47:54 +0100233 vnet_crypto_op_id_t op_by_type[VNET_CRYPTO_OP_N_TYPES];
Damjan Marion91f17dc2019-03-18 18:59:25 +0100234} vnet_crypto_alg_data_t;
235
Damjan Marion91f17dc2019-03-18 18:59:25 +0100236typedef struct
237{
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000238 u8 *src;
239 u8 *dst;
240 u32 len;
241} vnet_crypto_op_chunk_t;
242
243typedef struct
244{
Damjan Marion91f17dc2019-03-18 18:59:25 +0100245 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000246 uword user_data;
Damjan Marion060bfb92019-03-29 13:47:54 +0100247 vnet_crypto_op_id_t op:16;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100248 vnet_crypto_op_status_t status:8;
Damjan Marion060bfb92019-03-29 13:47:54 +0100249 u8 flags;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100250#define VNET_CRYPTO_OP_FLAG_INIT_IV (1 << 0)
251#define VNET_CRYPTO_OP_FLAG_HMAC_CHECK (1 << 1)
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000252#define VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS (1 << 2)
253
254 union
255 {
256 u8 digest_len;
257 u8 tag_len;
258 };
Damjan Marion060bfb92019-03-29 13:47:54 +0100259 u16 aad_len;
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000260
261 union
262 {
263 struct
264 {
265 u8 *src;
266 u8 *dst;
267 };
268
269 /* valid if VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS is set */
270 u16 n_chunks;
271 };
272
273 union
274 {
275 u32 len;
276 /* valid if VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS is set */
277 u32 chunk_index;
278 };
279
280 u32 key_index;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100281 u8 *iv;
Damjan Marion060bfb92019-03-29 13:47:54 +0100282 u8 *aad;
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000283
284 union
285 {
286 u8 *tag;
287 u8 *digest;
288 };
Damjan Marion91f17dc2019-03-18 18:59:25 +0100289} vnet_crypto_op_t;
290
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000291STATIC_ASSERT_SIZEOF (vnet_crypto_op_t, CLIB_CACHE_LINE_BYTES);
292
Damjan Marion91f17dc2019-03-18 18:59:25 +0100293typedef struct
294{
Damjan Marion060bfb92019-03-29 13:47:54 +0100295 vnet_crypto_op_type_t type;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100296 vnet_crypto_alg_t alg;
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000297 u32 active_engine_index_simple;
298 u32 active_engine_index_chained;
Damjan Marion060bfb92019-03-29 13:47:54 +0100299} vnet_crypto_op_data_t;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100300
301typedef struct
302{
Fan Zhangf5395782020-04-29 14:00:03 +0100303 vnet_crypto_async_op_type_t type;
304 vnet_crypto_async_alg_t alg;
305 u32 active_engine_index_async;
306} vnet_crypto_async_op_data_t;
307
308typedef struct
309{
310 char *name;
311 vnet_crypto_async_op_id_t op_by_type[VNET_CRYPTO_ASYNC_OP_N_TYPES];
312} vnet_crypto_async_alg_data_t;
313
314typedef struct
315{
Fan Zhangf5395782020-04-29 14:00:03 +0100316 u8 *iv;
317 union
318 {
319 u8 *digest;
320 u8 *tag;
321 };
322 u8 *aad;
Neale Ranns63ab8512021-02-24 09:18:53 +0000323 u32 key_index;
324 u32 crypto_total_length;
325 i16 crypto_start_offset; /* first buffer offset */
326 i16 integ_start_offset;
327 /* adj total_length for integ, e.g.4 bytes for IPSec ESN */
328 u16 integ_length_adj;
329 vnet_crypto_op_status_t status : 8;
Fan Zhangf5395782020-04-29 14:00:03 +0100330 u8 flags; /**< share same VNET_CRYPTO_OP_FLAG_* values */
331} vnet_crypto_async_frame_elt_t;
332
Neale Ranns63ab8512021-02-24 09:18:53 +0000333/* Assert the size so the compiler will warn us when it changes */
334STATIC_ASSERT_SIZEOF (vnet_crypto_async_frame_elt_t, 5 * sizeof (u64));
335
336typedef enum vnet_crypto_async_frame_state_t_
337{
338 VNET_CRYPTO_FRAME_STATE_NOT_PROCESSED,
339 /* frame waiting to be processed */
340 VNET_CRYPTO_FRAME_STATE_PENDING,
341 VNET_CRYPTO_FRAME_STATE_WORK_IN_PROGRESS,
342 VNET_CRYPTO_FRAME_STATE_SUCCESS,
343 VNET_CRYPTO_FRAME_STATE_ELT_ERROR
344} __clib_packed vnet_crypto_async_frame_state_t;
345
Fan Zhangf5395782020-04-29 14:00:03 +0100346typedef struct
347{
Damjan Marion91f17dc2019-03-18 18:59:25 +0100348 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Neale Ranns63ab8512021-02-24 09:18:53 +0000349 vnet_crypto_async_frame_state_t state;
Fan Zhangf5395782020-04-29 14:00:03 +0100350 vnet_crypto_async_op_id_t op:8;
351 u16 n_elts;
352 vnet_crypto_async_frame_elt_t elts[VNET_CRYPTO_FRAME_SIZE];
353 u32 buffer_indices[VNET_CRYPTO_FRAME_SIZE];
354 u16 next_node_index[VNET_CRYPTO_FRAME_SIZE];
PiotrX Kleski22848172020-07-08 14:36:34 +0200355 u32 enqueue_thread_index;
Fan Zhangf5395782020-04-29 14:00:03 +0100356} vnet_crypto_async_frame_t;
357
358typedef struct
359{
360 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Fan Zhangf5395782020-04-29 14:00:03 +0100361 vnet_crypto_async_frame_t *frame_pool;
Neale Ranns63ab8512021-02-24 09:18:53 +0000362 u32 *buffer_indices;
Fan Zhangf5395782020-04-29 14:00:03 +0100363 u16 *nexts;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100364} vnet_crypto_thread_t;
365
Damjan Mariond1bed682019-04-24 15:20:35 +0200366typedef u32 vnet_crypto_key_index_t;
367
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000368typedef u32 (vnet_crypto_chained_ops_handler_t) (vlib_main_t * vm,
369 vnet_crypto_op_t * ops[],
370 vnet_crypto_op_chunk_t *
371 chunks, u32 n_ops);
372
Damjan Marion91f17dc2019-03-18 18:59:25 +0100373typedef u32 (vnet_crypto_ops_handler_t) (vlib_main_t * vm,
374 vnet_crypto_op_t * ops[], u32 n_ops);
375
Damjan Mariond1bed682019-04-24 15:20:35 +0200376typedef void (vnet_crypto_key_handler_t) (vlib_main_t * vm,
377 vnet_crypto_key_op_t kop,
378 vnet_crypto_key_index_t idx);
379
Fan Zhangf5395782020-04-29 14:00:03 +0100380/** async crypto function handlers **/
PiotrX Kleski22848172020-07-08 14:36:34 +0200381typedef int
382 (vnet_crypto_frame_enqueue_t) (vlib_main_t * vm,
383 vnet_crypto_async_frame_t * frame);
Fan Zhangf5395782020-04-29 14:00:03 +0100384typedef vnet_crypto_async_frame_t *
PiotrX Kleski22848172020-07-08 14:36:34 +0200385 (vnet_crypto_frame_dequeue_t) (vlib_main_t * vm, u32 * nb_elts_processed,
386 u32 * enqueue_thread_idx);
Fan Zhangf5395782020-04-29 14:00:03 +0100387
PiotrX Kleski22848172020-07-08 14:36:34 +0200388u32
389vnet_crypto_register_engine (vlib_main_t * vm, char *name, int prio,
390 char *desc);
Damjan Marion91f17dc2019-03-18 18:59:25 +0100391
Damjan Mariond1bed682019-04-24 15:20:35 +0200392void vnet_crypto_register_ops_handler (vlib_main_t * vm, u32 engine_index,
393 vnet_crypto_op_id_t opt,
394 vnet_crypto_ops_handler_t * oph);
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000395
396void vnet_crypto_register_chained_ops_handler (vlib_main_t * vm,
397 u32 engine_index,
398 vnet_crypto_op_id_t opt,
399 vnet_crypto_chained_ops_handler_t
400 * oph);
Fan Zhangf5395782020-04-29 14:00:03 +0100401
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000402void vnet_crypto_register_ops_handlers (vlib_main_t * vm, u32 engine_index,
403 vnet_crypto_op_id_t opt,
404 vnet_crypto_ops_handler_t * fn,
405 vnet_crypto_chained_ops_handler_t *
406 cfn);
407
Damjan Mariond1bed682019-04-24 15:20:35 +0200408void vnet_crypto_register_key_handler (vlib_main_t * vm, u32 engine_index,
409 vnet_crypto_key_handler_t * keyh);
Damjan Marion91f17dc2019-03-18 18:59:25 +0100410
Fan Zhangf5395782020-04-29 14:00:03 +0100411/** async crypto register functions */
412u32 vnet_crypto_register_post_node (vlib_main_t * vm, char *post_node_name);
413void vnet_crypto_register_async_handler (vlib_main_t * vm,
414 u32 engine_index,
415 vnet_crypto_async_op_id_t opt,
416 vnet_crypto_frame_enqueue_t * enq_fn,
417 vnet_crypto_frame_dequeue_t *
418 deq_fn);
419
Damjan Marion91f17dc2019-03-18 18:59:25 +0100420typedef struct
421{
422 char *name;
423 char *desc;
424 int priority;
Damjan Mariond1bed682019-04-24 15:20:35 +0200425 vnet_crypto_key_handler_t *key_op_handler;
Damjan Marion060bfb92019-03-29 13:47:54 +0100426 vnet_crypto_ops_handler_t *ops_handlers[VNET_CRYPTO_N_OP_IDS];
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000427 vnet_crypto_chained_ops_handler_t
428 * chained_ops_handlers[VNET_CRYPTO_N_OP_IDS];
Fan Zhangf5395782020-04-29 14:00:03 +0100429 vnet_crypto_frame_enqueue_t *enqueue_handlers[VNET_CRYPTO_ASYNC_OP_N_IDS];
430 vnet_crypto_frame_dequeue_t *dequeue_handlers[VNET_CRYPTO_ASYNC_OP_N_IDS];
Damjan Marion91f17dc2019-03-18 18:59:25 +0100431} vnet_crypto_engine_t;
432
433typedef struct
434{
Fan Zhangf5395782020-04-29 14:00:03 +0100435 u32 node_idx;
436 u32 next_idx;
437} vnet_crypto_async_next_node_t;
438
439typedef struct
440{
Damjan Marion91f17dc2019-03-18 18:59:25 +0100441 vnet_crypto_alg_data_t *algs;
442 vnet_crypto_thread_t *threads;
443 vnet_crypto_ops_handler_t **ops_handlers;
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000444 vnet_crypto_chained_ops_handler_t **chained_ops_handlers;
Fan Zhangf5395782020-04-29 14:00:03 +0100445 vnet_crypto_frame_enqueue_t **enqueue_handlers;
446 vnet_crypto_frame_dequeue_t **dequeue_handlers;
447 clib_bitmap_t *async_active_ids;
Damjan Marion060bfb92019-03-29 13:47:54 +0100448 vnet_crypto_op_data_t opt_data[VNET_CRYPTO_N_OP_IDS];
Fan Zhangf5395782020-04-29 14:00:03 +0100449 vnet_crypto_async_op_data_t async_opt_data[VNET_CRYPTO_ASYNC_OP_N_IDS];
Damjan Marion91f17dc2019-03-18 18:59:25 +0100450 vnet_crypto_engine_t *engines;
Damjan Mariond1bed682019-04-24 15:20:35 +0200451 vnet_crypto_key_t *keys;
Filip Tehlar1469d542019-03-25 09:04:41 -0700452 uword *engine_index_by_name;
Damjan Marion060bfb92019-03-29 13:47:54 +0100453 uword *alg_index_by_name;
Fan Zhangf5395782020-04-29 14:00:03 +0100454 uword *async_alg_index_by_name;
455 vnet_crypto_async_alg_data_t *async_algs;
456 u32 async_refcnt;
457 vnet_crypto_async_next_node_t *next_nodes;
PiotrX Kleski22848172020-07-08 14:36:34 +0200458 u32 crypto_node_index;
459#define VNET_CRYPTO_ASYNC_DISPATCH_POLLING 0
460#define VNET_CRYPTO_ASYNC_DISPATCH_INTERRUPT 1
461 u8 dispatch_mode;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100462} vnet_crypto_main_t;
463
464extern vnet_crypto_main_t crypto_main;
465
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000466u32 vnet_crypto_process_chained_ops (vlib_main_t * vm, vnet_crypto_op_t ops[],
467 vnet_crypto_op_chunk_t * chunks,
468 u32 n_ops);
Damjan Marion91f17dc2019-03-18 18:59:25 +0100469u32 vnet_crypto_process_ops (vlib_main_t * vm, vnet_crypto_op_t ops[],
470 u32 n_ops);
471
Fan Zhangf5395782020-04-29 14:00:03 +0100472
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000473int vnet_crypto_set_handler2 (char *ops_handler_name, char *engine,
474 crypto_op_class_type_t oct);
Neale Rannsece2ae02019-06-21 12:44:11 +0000475int vnet_crypto_is_set_handler (vnet_crypto_alg_t alg);
Filip Tehlar1469d542019-03-25 09:04:41 -0700476
Damjan Mariond1bed682019-04-24 15:20:35 +0200477u32 vnet_crypto_key_add (vlib_main_t * vm, vnet_crypto_alg_t alg,
478 u8 * data, u16 length);
479void vnet_crypto_key_del (vlib_main_t * vm, vnet_crypto_key_index_t index);
Damjan Mariond1bed682019-04-24 15:20:35 +0200480
Fan Zhangf5395782020-04-29 14:00:03 +0100481/**
482 * Use 2 created keys to generate new key for linked algs (cipher + integ)
483 * The returned key index is to be used for linked alg only.
484 **/
485u32 vnet_crypto_key_add_linked (vlib_main_t * vm,
486 vnet_crypto_key_index_t index_crypto,
487 vnet_crypto_key_index_t index_integ);
488
489clib_error_t *crypto_dispatch_enable_disable (int is_enable);
490
491int vnet_crypto_set_async_handler2 (char *alg_name, char *engine);
492
493int vnet_crypto_is_set_async_handler (vnet_crypto_async_op_id_t opt);
494
495void vnet_crypto_request_async_mode (int is_enable);
496
PiotrX Kleski22848172020-07-08 14:36:34 +0200497void vnet_crypto_set_async_dispatch_mode (u8 mode);
498
Fan Zhangf5395782020-04-29 14:00:03 +0100499vnet_crypto_async_alg_t vnet_crypto_link_algs (vnet_crypto_alg_t crypto_alg,
500 vnet_crypto_alg_t integ_alg);
501
502clib_error_t *crypto_dispatch_enable_disable (int is_enable);
503
Damjan Marion91f17dc2019-03-18 18:59:25 +0100504format_function_t format_vnet_crypto_alg;
505format_function_t format_vnet_crypto_engine;
506format_function_t format_vnet_crypto_op;
Damjan Marion060bfb92019-03-29 13:47:54 +0100507format_function_t format_vnet_crypto_op_type;
508format_function_t format_vnet_crypto_op_status;
Damjan Marion61c0a3d2019-04-05 19:42:21 +0200509unformat_function_t unformat_vnet_crypto_alg;
Damjan Mariona03d1822019-03-28 21:40:48 +0100510
Fan Zhangf5395782020-04-29 14:00:03 +0100511format_function_t format_vnet_crypto_async_op;
512format_function_t format_vnet_crypto_async_alg;
513format_function_t format_vnet_crypto_async_op_type;
514
Damjan Mariona03d1822019-03-28 21:40:48 +0100515static_always_inline void
Damjan Marion060bfb92019-03-29 13:47:54 +0100516vnet_crypto_op_init (vnet_crypto_op_t * op, vnet_crypto_op_id_t type)
Damjan Mariona03d1822019-03-28 21:40:48 +0100517{
518 if (CLIB_DEBUG > 0)
519 clib_memset (op, 0xfe, sizeof (*op));
520 op->op = type;
521 op->flags = 0;
Damjan Mariond1bed682019-04-24 15:20:35 +0200522 op->key_index = ~0;
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000523 op->n_chunks = 0;
Damjan Mariona03d1822019-03-28 21:40:48 +0100524}
525
Damjan Marion060bfb92019-03-29 13:47:54 +0100526static_always_inline vnet_crypto_op_type_t
527vnet_crypto_get_op_type (vnet_crypto_op_id_t id)
528{
529 vnet_crypto_main_t *cm = &crypto_main;
Lijian Zhangb15d7962019-09-27 16:25:35 +0800530 ASSERT (id < VNET_CRYPTO_N_OP_IDS);
531 vnet_crypto_op_data_t *od = cm->opt_data + id;
Damjan Marion060bfb92019-03-29 13:47:54 +0100532 return od->type;
533}
534
Damjan Mariond1bed682019-04-24 15:20:35 +0200535static_always_inline vnet_crypto_key_t *
536vnet_crypto_get_key (vnet_crypto_key_index_t index)
537{
538 vnet_crypto_main_t *cm = &crypto_main;
539 return vec_elt_at_index (cm->keys, index);
540}
541
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000542static_always_inline int
543vnet_crypto_set_handler (char *alg_name, char *engine)
544{
545 return vnet_crypto_set_handler2 (alg_name, engine, CRYPTO_OP_BOTH);
546}
547
Fan Zhangf5395782020-04-29 14:00:03 +0100548/** async crypto inline functions **/
549
550static_always_inline vnet_crypto_async_frame_t *
551vnet_crypto_async_get_frame (vlib_main_t * vm, vnet_crypto_async_op_id_t opt)
552{
553 vnet_crypto_main_t *cm = &crypto_main;
554 vnet_crypto_thread_t *ct = cm->threads + vm->thread_index;
Neale Rannsfc811342021-02-26 10:35:33 +0000555 vnet_crypto_async_frame_t *f = NULL;
Fan Zhangf5395782020-04-29 14:00:03 +0100556
Neale Rannsfc811342021-02-26 10:35:33 +0000557 pool_get_aligned (ct->frame_pool, f, CLIB_CACHE_LINE_BYTES);
558 if (CLIB_DEBUG > 0)
559 clib_memset (f, 0xfe, sizeof (*f));
560 f->state = VNET_CRYPTO_FRAME_STATE_NOT_PROCESSED;
561 f->op = opt;
562 f->n_elts = 0;
563
Fan Zhangf5395782020-04-29 14:00:03 +0100564 return f;
565}
566
567static_always_inline void
568vnet_crypto_async_free_frame (vlib_main_t * vm,
569 vnet_crypto_async_frame_t * frame)
570{
571 vnet_crypto_main_t *cm = &crypto_main;
572 vnet_crypto_thread_t *ct = cm->threads + vm->thread_index;
573 pool_put (ct->frame_pool, frame);
574}
575
576static_always_inline int
577vnet_crypto_async_submit_open_frame (vlib_main_t * vm,
578 vnet_crypto_async_frame_t * frame)
579{
580 vnet_crypto_main_t *cm = &crypto_main;
PiotrX Kleski22848172020-07-08 14:36:34 +0200581 vlib_thread_main_t *tm = vlib_get_thread_main ();
Fan Zhangf5395782020-04-29 14:00:03 +0100582 vnet_crypto_async_op_id_t opt = frame->op;
PiotrX Kleski22848172020-07-08 14:36:34 +0200583 u32 i = vlib_num_workers () > 0;
584
PiotrX Kleskief69b512020-11-24 08:26:26 +0000585 frame->state = VNET_CRYPTO_FRAME_STATE_PENDING;
PiotrX Kleski22848172020-07-08 14:36:34 +0200586 frame->enqueue_thread_index = vm->thread_index;
PiotrX Kleskief69b512020-11-24 08:26:26 +0000587
588 int ret = (cm->enqueue_handlers[frame->op]) (vm, frame);
589
Fan Zhangf5395782020-04-29 14:00:03 +0100590 clib_bitmap_set_no_check (cm->async_active_ids, opt, 1);
591 if (PREDICT_TRUE (ret == 0))
592 {
Neale Rannsfc811342021-02-26 10:35:33 +0000593 if (cm->dispatch_mode == VNET_CRYPTO_ASYNC_DISPATCH_INTERRUPT)
594 {
595 for (; i < tm->n_vlib_mains; i++)
Damjan Marion6ffb7c62021-03-26 13:06:13 +0100596 vlib_node_set_interrupt_pending (vlib_get_main_by_index (i),
Neale Rannsfc811342021-02-26 10:35:33 +0000597 cm->crypto_node_index);
598 }
Fan Zhangf5395782020-04-29 14:00:03 +0100599 }
PiotrX Kleskief69b512020-11-24 08:26:26 +0000600 else
601 {
602 frame->state = VNET_CRYPTO_FRAME_STATE_ELT_ERROR;
603 }
PiotrX Kleski22848172020-07-08 14:36:34 +0200604
Fan Zhangf5395782020-04-29 14:00:03 +0100605 return ret;
606}
607
Neale Rannsfc811342021-02-26 10:35:33 +0000608static_always_inline void
609vnet_crypto_async_add_to_frame (vlib_main_t *vm, vnet_crypto_async_frame_t *f,
610 u32 key_index, u32 crypto_len,
611 i16 integ_len_adj, i16 crypto_start_offset,
612 u16 integ_start_offset, u32 buffer_index,
613 u16 next_node, u8 *iv, u8 *tag, u8 *aad,
614 u8 flags)
Fan Zhangf5395782020-04-29 14:00:03 +0100615{
Fan Zhangf5395782020-04-29 14:00:03 +0100616 vnet_crypto_async_frame_elt_t *fe;
617 u16 index;
618
Neale Rannsfc811342021-02-26 10:35:33 +0000619 ASSERT (f->n_elts < VNET_CRYPTO_FRAME_SIZE);
Fan Zhangf5395782020-04-29 14:00:03 +0100620
621 index = f->n_elts;
622 fe = &f->elts[index];
623 f->n_elts++;
624 fe->key_index = key_index;
625 fe->crypto_total_length = crypto_len;
626 fe->crypto_start_offset = crypto_start_offset;
627 fe->integ_start_offset = integ_start_offset;
628 fe->integ_length_adj = integ_len_adj;
629 fe->iv = iv;
630 fe->tag = tag;
631 fe->aad = aad;
632 fe->flags = flags;
633 f->buffer_indices[index] = buffer_index;
634 f->next_node_index[index] = next_node;
Fan Zhangf5395782020-04-29 14:00:03 +0100635}
636
637static_always_inline void
638vnet_crypto_async_reset_frame (vnet_crypto_async_frame_t * f)
639{
640 vnet_crypto_async_op_id_t opt;
641 ASSERT (f != 0);
PiotrX Kleski8ed06c02020-11-24 07:34:09 +0000642 ASSERT ((f->state == VNET_CRYPTO_FRAME_STATE_NOT_PROCESSED
643 || f->state == VNET_CRYPTO_FRAME_STATE_ELT_ERROR));
Fan Zhangf5395782020-04-29 14:00:03 +0100644 opt = f->op;
645 if (CLIB_DEBUG > 0)
646 clib_memset (f, 0xfe, sizeof (*f));
647 f->state = VNET_CRYPTO_FRAME_STATE_NOT_PROCESSED;
648 f->op = opt;
649 f->n_elts = 0;
650}
651
Neale Rannsfc811342021-02-26 10:35:33 +0000652static_always_inline u8
653vnet_crypto_async_frame_is_full (const vnet_crypto_async_frame_t *f)
654{
655 return (f->n_elts == VNET_CRYPTO_FRAME_SIZE);
656}
657
Damjan Marion91f17dc2019-03-18 18:59:25 +0100658#endif /* included_vnet_crypto_crypto_h */
659
660/*
661 * fd.io coding-style-patch-verification: ON
662 *
663 * Local Variables:
664 * eval: (c-set-style "gnu")
665 * End:
666 */