blob: 36fde2a548f6fd383fb6c9236be94f244116733d [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
Filip Tehlar06111a82021-05-03 15:29:56 +000042#define foreach_crypto_hash_alg \
43 _ (SHA1, "sha-1") \
44 _ (SHA224, "sha-224") \
45 _ (SHA256, "sha-256") \
46 _ (SHA384, "sha-384") \
47 _ (SHA512, "sha-512")
48
Damjan Marion060bfb92019-03-29 13:47:54 +010049#define foreach_crypto_hmac_alg \
Filip Tehlare225f712019-03-19 10:37:06 -070050 _(MD5, "md5") \
Damjan Marion91f17dc2019-03-18 18:59:25 +010051 _(SHA1, "sha-1") \
52 _(SHA224, "sha-224") \
53 _(SHA256, "sha-256") \
54 _(SHA384, "sha-384") \
55 _(SHA512, "sha-512")
56
Filip Tehlar06111a82021-05-03 15:29:56 +000057#define foreach_crypto_op_type \
58 _ (ENCRYPT, "encrypt") \
59 _ (DECRYPT, "decrypt") \
60 _ (AEAD_ENCRYPT, "aead-encrypt") \
61 _ (AEAD_DECRYPT, "aead-decrypt") \
62 _ (HMAC, "hmac") \
63 _ (HASH, "hash")
Damjan Marion060bfb92019-03-29 13:47:54 +010064
65typedef enum
66{
67#define _(n, s) VNET_CRYPTO_OP_TYPE_##n,
68 foreach_crypto_op_type
69#undef _
70 VNET_CRYPTO_OP_N_TYPES,
71} vnet_crypto_op_type_t;
72
73#define foreach_crypto_op_status \
Fan Zhangf5395782020-04-29 14:00:03 +010074 _(IDLE, "idle") \
Damjan Marion060bfb92019-03-29 13:47:54 +010075 _(PENDING, "pending") \
Fan Zhangf5395782020-04-29 14:00:03 +010076 _(WORK_IN_PROGRESS, "work-in-progress") \
Damjan Marion060bfb92019-03-29 13:47:54 +010077 _(COMPLETED, "completed") \
78 _(FAIL_NO_HANDLER, "no-handler") \
Fan Zhangf5395782020-04-29 14:00:03 +010079 _(FAIL_BAD_HMAC, "bad-hmac") \
80 _(FAIL_ENGINE_ERR, "engine-error")
81
82/** async crypto **/
83
84/* CRYPTO_ID, PRETTY_NAME, KEY_LENGTH_IN_BYTES, TAG_LEN, AAD_LEN */
Gabriel Oginski492d7792021-11-10 07:59:56 +000085#define foreach_crypto_aead_async_alg \
86 _ (AES_128_GCM, "aes-128-gcm-aad8", 16, 16, 8) \
87 _ (AES_128_GCM, "aes-128-gcm-aad12", 16, 16, 12) \
88 _ (AES_192_GCM, "aes-192-gcm-aad8", 24, 16, 8) \
89 _ (AES_192_GCM, "aes-192-gcm-aad12", 24, 16, 12) \
90 _ (AES_256_GCM, "aes-256-gcm-aad8", 32, 16, 8) \
91 _ (AES_256_GCM, "aes-256-gcm-aad12", 32, 16, 12) \
92 _ (CHACHA20_POLY1305, "chacha20-poly1305-aad8", 32, 16, 8) \
93 _ (CHACHA20_POLY1305, "chacha20-poly1305-aad12", 32, 16, 12) \
94 _ (CHACHA20_POLY1305, "chacha20-poly1305", 32, 16, 0)
Fan Zhangf5395782020-04-29 14:00:03 +010095
96/* CRYPTO_ID, INTEG_ID, PRETTY_NAME, KEY_LENGTH_IN_BYTES, DIGEST_LEN */
Benoît Ganne40ee2002021-01-22 18:09:40 +010097#define foreach_crypto_link_async_alg \
Alexander Chernavin005d1e42021-02-01 05:17:24 -050098 _ (3DES_CBC, MD5, "3des-cbc-hmac-md5", 24, 12) \
99 _ (AES_128_CBC, MD5, "aes-128-cbc-hmac-md5", 16, 12) \
100 _ (AES_192_CBC, MD5, "aes-192-cbc-hmac-md5", 24, 12) \
101 _ (AES_256_CBC, MD5, "aes-256-cbc-hmac-md5", 32, 12) \
102 _ (3DES_CBC, SHA1, "3des-cbc-hmac-sha-1", 24, 12) \
Benoît Ganne40ee2002021-01-22 18:09:40 +0100103 _ (AES_128_CBC, SHA1, "aes-128-cbc-hmac-sha-1", 16, 12) \
104 _ (AES_192_CBC, SHA1, "aes-192-cbc-hmac-sha-1", 24, 12) \
105 _ (AES_256_CBC, SHA1, "aes-256-cbc-hmac-sha-1", 32, 12) \
Alexander Chernavin005d1e42021-02-01 05:17:24 -0500106 _ (3DES_CBC, SHA224, "3des-cbc-hmac-sha-224", 24, 14) \
Benoît Ganne40ee2002021-01-22 18:09:40 +0100107 _ (AES_128_CBC, SHA224, "aes-128-cbc-hmac-sha-224", 16, 14) \
108 _ (AES_192_CBC, SHA224, "aes-192-cbc-hmac-sha-224", 24, 14) \
109 _ (AES_256_CBC, SHA224, "aes-256-cbc-hmac-sha-224", 32, 14) \
Alexander Chernavin005d1e42021-02-01 05:17:24 -0500110 _ (3DES_CBC, SHA256, "3des-cbc-hmac-sha-256", 24, 16) \
Benoît Ganne40ee2002021-01-22 18:09:40 +0100111 _ (AES_128_CBC, SHA256, "aes-128-cbc-hmac-sha-256", 16, 16) \
112 _ (AES_192_CBC, SHA256, "aes-192-cbc-hmac-sha-256", 24, 16) \
113 _ (AES_256_CBC, SHA256, "aes-256-cbc-hmac-sha-256", 32, 16) \
Alexander Chernavin005d1e42021-02-01 05:17:24 -0500114 _ (3DES_CBC, SHA384, "3des-cbc-hmac-sha-384", 24, 24) \
Benoît Ganne40ee2002021-01-22 18:09:40 +0100115 _ (AES_128_CBC, SHA384, "aes-128-cbc-hmac-sha-384", 16, 24) \
116 _ (AES_192_CBC, SHA384, "aes-192-cbc-hmac-sha-384", 24, 24) \
117 _ (AES_256_CBC, SHA384, "aes-256-cbc-hmac-sha-384", 32, 24) \
Alexander Chernavin005d1e42021-02-01 05:17:24 -0500118 _ (3DES_CBC, SHA512, "3des-cbc-hmac-sha-512", 24, 32) \
Benoît Ganne40ee2002021-01-22 18:09:40 +0100119 _ (AES_128_CBC, SHA512, "aes-128-cbc-hmac-sha-512", 16, 32) \
120 _ (AES_192_CBC, SHA512, "aes-192-cbc-hmac-sha-512", 24, 32) \
121 _ (AES_256_CBC, SHA512, "aes-256-cbc-hmac-sha-512", 32, 32) \
122 _ (AES_128_CTR, SHA1, "aes-128-ctr-hmac-sha-1", 16, 12) \
123 _ (AES_192_CTR, SHA1, "aes-192-ctr-hmac-sha-1", 24, 12) \
124 _ (AES_256_CTR, SHA1, "aes-256-ctr-hmac-sha-1", 32, 12)
Fan Zhangf5395782020-04-29 14:00:03 +0100125
126#define foreach_crypto_async_op_type \
127 _(ENCRYPT, "async-encrypt") \
128 _(DECRYPT, "async-decrypt")
Damjan Marion060bfb92019-03-29 13:47:54 +0100129
130typedef enum
131{
Damjan Mariond1bed682019-04-24 15:20:35 +0200132 VNET_CRYPTO_KEY_OP_ADD,
133 VNET_CRYPTO_KEY_OP_DEL,
134 VNET_CRYPTO_KEY_OP_MODIFY,
135} vnet_crypto_key_op_t;
136
137typedef enum
138{
Damjan Marion060bfb92019-03-29 13:47:54 +0100139#define _(n, s) VNET_CRYPTO_OP_STATUS_##n,
140 foreach_crypto_op_status
141#undef _
142 VNET_CRYPTO_OP_N_STATUS,
143} vnet_crypto_op_status_t;
144
Damjan Marion91f17dc2019-03-18 18:59:25 +0100145/* *INDENT-OFF* */
146typedef enum
147{
Damjan Mariond1bed682019-04-24 15:20:35 +0200148 VNET_CRYPTO_ALG_NONE = 0,
Benoît Gannebe954442019-04-29 16:05:46 +0200149#define _(n, s, l) VNET_CRYPTO_ALG_##n,
Filip Tehlar06111a82021-05-03 15:29:56 +0000150 foreach_crypto_cipher_alg foreach_crypto_aead_alg
Damjan Marion91f17dc2019-03-18 18:59:25 +0100151#undef _
Damjan Marion060bfb92019-03-29 13:47:54 +0100152#define _(n, s) VNET_CRYPTO_ALG_HMAC_##n,
Filip Tehlar06111a82021-05-03 15:29:56 +0000153 foreach_crypto_hmac_alg
Damjan Marion91f17dc2019-03-18 18:59:25 +0100154#undef _
Filip Tehlar06111a82021-05-03 15:29:56 +0000155#define _(n, s) VNET_CRYPTO_ALG_HASH_##n,
156 foreach_crypto_hash_alg
157#undef _
158 VNET_CRYPTO_N_ALGS,
Damjan Marion91f17dc2019-03-18 18:59:25 +0100159} vnet_crypto_alg_t;
160
Fan Zhangf5395782020-04-29 14:00:03 +0100161typedef enum
162{
163#define _(n, s) VNET_CRYPTO_ASYNC_OP_TYPE_##n,
164 foreach_crypto_async_op_type
165#undef _
166 VNET_CRYPTO_ASYNC_OP_N_TYPES,
167} vnet_crypto_async_op_type_t;
168
169typedef enum
170{
171 VNET_CRYPTO_ASYNC_ALG_NONE = 0,
172#define _(n, s, k, t, a) \
173 VNET_CRYPTO_ALG_##n##_TAG##t##_AAD##a,
174 foreach_crypto_aead_async_alg
175#undef _
176#define _(c, h, s, k ,d) \
177 VNET_CRYPTO_ALG_##c##_##h##_TAG##d,
178 foreach_crypto_link_async_alg
179#undef _
180 VNET_CRYPTO_N_ASYNC_ALGS,
181} vnet_crypto_async_alg_t;
182
183typedef enum
184{
185 VNET_CRYPTO_ASYNC_OP_NONE = 0,
186#define _(n, s, k, t, a) \
187 VNET_CRYPTO_OP_##n##_TAG##t##_AAD##a##_ENC, \
188 VNET_CRYPTO_OP_##n##_TAG##t##_AAD##a##_DEC,
189 foreach_crypto_aead_async_alg
190#undef _
191#define _(c, h, s, k ,d) \
192 VNET_CRYPTO_OP_##c##_##h##_TAG##d##_ENC, \
193 VNET_CRYPTO_OP_##c##_##h##_TAG##d##_DEC,
194 foreach_crypto_link_async_alg
195#undef _
196 VNET_CRYPTO_ASYNC_OP_N_IDS,
197} vnet_crypto_async_op_id_t;
198
Damjan Mariond1bed682019-04-24 15:20:35 +0200199typedef struct
200{
Fan Zhangf5395782020-04-29 14:00:03 +0100201 union
202 {
203 struct
204 {
205 u8 *data;
206 vnet_crypto_alg_t alg:8;
207 };
208 struct
209 {
210 u32 index_crypto;
211 u32 index_integ;
212 vnet_crypto_async_alg_t async_alg:8;
213 };
214 };
215#define VNET_CRYPTO_KEY_TYPE_DATA 0
216#define VNET_CRYPTO_KEY_TYPE_LINK 1
217 u8 type;
Damjan Mariond1bed682019-04-24 15:20:35 +0200218} vnet_crypto_key_t;
219
Damjan Marion91f17dc2019-03-18 18:59:25 +0100220typedef enum
221{
222 VNET_CRYPTO_OP_NONE = 0,
Benoît Gannebe954442019-04-29 16:05:46 +0200223#define _(n, s, l) VNET_CRYPTO_OP_##n##_ENC, VNET_CRYPTO_OP_##n##_DEC,
Filip Tehlar06111a82021-05-03 15:29:56 +0000224 foreach_crypto_cipher_alg foreach_crypto_aead_alg
Damjan Marion91f17dc2019-03-18 18:59:25 +0100225#undef _
226#define _(n, s) VNET_CRYPTO_OP_##n##_HMAC,
Filip Tehlar06111a82021-05-03 15:29:56 +0000227 foreach_crypto_hmac_alg
Damjan Marion91f17dc2019-03-18 18:59:25 +0100228#undef _
Filip Tehlar06111a82021-05-03 15:29:56 +0000229#define _(n, s) VNET_CRYPTO_OP_##n##_HASH,
230 foreach_crypto_hash_alg
231#undef _
232 VNET_CRYPTO_N_OP_IDS,
Damjan Marion060bfb92019-03-29 13:47:54 +0100233} vnet_crypto_op_id_t;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100234/* *INDENT-ON* */
235
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000236typedef enum
237{
238 CRYPTO_OP_SIMPLE,
239 CRYPTO_OP_CHAINED,
240 CRYPTO_OP_BOTH,
241} crypto_op_class_type_t;
242
Damjan Marion91f17dc2019-03-18 18:59:25 +0100243typedef struct
244{
245 char *name;
Damjan Marion060bfb92019-03-29 13:47:54 +0100246 vnet_crypto_op_id_t op_by_type[VNET_CRYPTO_OP_N_TYPES];
Damjan Marion91f17dc2019-03-18 18:59:25 +0100247} vnet_crypto_alg_data_t;
248
Damjan Marion91f17dc2019-03-18 18:59:25 +0100249typedef struct
250{
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000251 u8 *src;
252 u8 *dst;
253 u32 len;
254} vnet_crypto_op_chunk_t;
255
256typedef struct
257{
Damjan Marion91f17dc2019-03-18 18:59:25 +0100258 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000259 uword user_data;
Damjan Marion060bfb92019-03-29 13:47:54 +0100260 vnet_crypto_op_id_t op:16;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100261 vnet_crypto_op_status_t status:8;
Damjan Marion060bfb92019-03-29 13:47:54 +0100262 u8 flags;
Benoît Ganne063549f2022-01-19 10:09:42 +0100263#define VNET_CRYPTO_OP_FLAG_HMAC_CHECK (1 << 0)
264#define VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS (1 << 1)
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000265
266 union
267 {
268 u8 digest_len;
269 u8 tag_len;
270 };
Damjan Marion060bfb92019-03-29 13:47:54 +0100271 u16 aad_len;
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000272
273 union
274 {
275 struct
276 {
277 u8 *src;
278 u8 *dst;
279 };
280
281 /* valid if VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS is set */
282 u16 n_chunks;
283 };
284
285 union
286 {
287 u32 len;
288 /* valid if VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS is set */
289 u32 chunk_index;
290 };
291
292 u32 key_index;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100293 u8 *iv;
Damjan Marion060bfb92019-03-29 13:47:54 +0100294 u8 *aad;
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000295
296 union
297 {
298 u8 *tag;
299 u8 *digest;
300 };
Damjan Marion91f17dc2019-03-18 18:59:25 +0100301} vnet_crypto_op_t;
302
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000303STATIC_ASSERT_SIZEOF (vnet_crypto_op_t, CLIB_CACHE_LINE_BYTES);
304
Damjan Marion91f17dc2019-03-18 18:59:25 +0100305typedef struct
306{
Damjan Marion060bfb92019-03-29 13:47:54 +0100307 vnet_crypto_op_type_t type;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100308 vnet_crypto_alg_t alg;
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000309 u32 active_engine_index_simple;
310 u32 active_engine_index_chained;
Damjan Marion060bfb92019-03-29 13:47:54 +0100311} vnet_crypto_op_data_t;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100312
313typedef struct
314{
Fan Zhangf5395782020-04-29 14:00:03 +0100315 vnet_crypto_async_op_type_t type;
316 vnet_crypto_async_alg_t alg;
317 u32 active_engine_index_async;
318} vnet_crypto_async_op_data_t;
319
320typedef struct
321{
322 char *name;
323 vnet_crypto_async_op_id_t op_by_type[VNET_CRYPTO_ASYNC_OP_N_TYPES];
324} vnet_crypto_async_alg_data_t;
325
326typedef struct
327{
Fan Zhangf5395782020-04-29 14:00:03 +0100328 u8 *iv;
329 union
330 {
331 u8 *digest;
332 u8 *tag;
333 };
334 u8 *aad;
Neale Ranns63ab8512021-02-24 09:18:53 +0000335 u32 key_index;
336 u32 crypto_total_length;
337 i16 crypto_start_offset; /* first buffer offset */
338 i16 integ_start_offset;
339 /* adj total_length for integ, e.g.4 bytes for IPSec ESN */
Benoît Ganne02dfd292022-01-18 15:56:41 +0100340 i16 integ_length_adj;
Neale Ranns63ab8512021-02-24 09:18:53 +0000341 vnet_crypto_op_status_t status : 8;
Fan Zhangf5395782020-04-29 14:00:03 +0100342 u8 flags; /**< share same VNET_CRYPTO_OP_FLAG_* values */
343} vnet_crypto_async_frame_elt_t;
344
Neale Ranns63ab8512021-02-24 09:18:53 +0000345/* Assert the size so the compiler will warn us when it changes */
346STATIC_ASSERT_SIZEOF (vnet_crypto_async_frame_elt_t, 5 * sizeof (u64));
347
348typedef enum vnet_crypto_async_frame_state_t_
349{
350 VNET_CRYPTO_FRAME_STATE_NOT_PROCESSED,
351 /* frame waiting to be processed */
352 VNET_CRYPTO_FRAME_STATE_PENDING,
353 VNET_CRYPTO_FRAME_STATE_WORK_IN_PROGRESS,
354 VNET_CRYPTO_FRAME_STATE_SUCCESS,
355 VNET_CRYPTO_FRAME_STATE_ELT_ERROR
356} __clib_packed vnet_crypto_async_frame_state_t;
357
Fan Zhangf5395782020-04-29 14:00:03 +0100358typedef struct
359{
Damjan Marion91f17dc2019-03-18 18:59:25 +0100360 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Neale Ranns63ab8512021-02-24 09:18:53 +0000361 vnet_crypto_async_frame_state_t state;
Fan Zhangf5395782020-04-29 14:00:03 +0100362 vnet_crypto_async_op_id_t op:8;
363 u16 n_elts;
364 vnet_crypto_async_frame_elt_t elts[VNET_CRYPTO_FRAME_SIZE];
365 u32 buffer_indices[VNET_CRYPTO_FRAME_SIZE];
366 u16 next_node_index[VNET_CRYPTO_FRAME_SIZE];
PiotrX Kleski22848172020-07-08 14:36:34 +0200367 u32 enqueue_thread_index;
Fan Zhangf5395782020-04-29 14:00:03 +0100368} vnet_crypto_async_frame_t;
369
370typedef struct
371{
372 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Fan Zhangf5395782020-04-29 14:00:03 +0100373 vnet_crypto_async_frame_t *frame_pool;
Neale Ranns63ab8512021-02-24 09:18:53 +0000374 u32 *buffer_indices;
Fan Zhangf5395782020-04-29 14:00:03 +0100375 u16 *nexts;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100376} vnet_crypto_thread_t;
377
Damjan Mariond1bed682019-04-24 15:20:35 +0200378typedef u32 vnet_crypto_key_index_t;
379
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000380typedef u32 (vnet_crypto_chained_ops_handler_t) (vlib_main_t * vm,
381 vnet_crypto_op_t * ops[],
382 vnet_crypto_op_chunk_t *
383 chunks, u32 n_ops);
384
Damjan Marion91f17dc2019-03-18 18:59:25 +0100385typedef u32 (vnet_crypto_ops_handler_t) (vlib_main_t * vm,
386 vnet_crypto_op_t * ops[], u32 n_ops);
387
Damjan Mariond1bed682019-04-24 15:20:35 +0200388typedef void (vnet_crypto_key_handler_t) (vlib_main_t * vm,
389 vnet_crypto_key_op_t kop,
390 vnet_crypto_key_index_t idx);
391
Fan Zhangf5395782020-04-29 14:00:03 +0100392/** async crypto function handlers **/
PiotrX Kleski22848172020-07-08 14:36:34 +0200393typedef int
394 (vnet_crypto_frame_enqueue_t) (vlib_main_t * vm,
395 vnet_crypto_async_frame_t * frame);
Fan Zhangf5395782020-04-29 14:00:03 +0100396typedef vnet_crypto_async_frame_t *
PiotrX Kleski22848172020-07-08 14:36:34 +0200397 (vnet_crypto_frame_dequeue_t) (vlib_main_t * vm, u32 * nb_elts_processed,
398 u32 * enqueue_thread_idx);
Fan Zhangf5395782020-04-29 14:00:03 +0100399
PiotrX Kleski22848172020-07-08 14:36:34 +0200400u32
401vnet_crypto_register_engine (vlib_main_t * vm, char *name, int prio,
402 char *desc);
Damjan Marion91f17dc2019-03-18 18:59:25 +0100403
Damjan Mariond1bed682019-04-24 15:20:35 +0200404void vnet_crypto_register_ops_handler (vlib_main_t * vm, u32 engine_index,
405 vnet_crypto_op_id_t opt,
406 vnet_crypto_ops_handler_t * oph);
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000407
408void vnet_crypto_register_chained_ops_handler (vlib_main_t * vm,
409 u32 engine_index,
410 vnet_crypto_op_id_t opt,
411 vnet_crypto_chained_ops_handler_t
412 * oph);
Fan Zhangf5395782020-04-29 14:00:03 +0100413
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000414void vnet_crypto_register_ops_handlers (vlib_main_t * vm, u32 engine_index,
415 vnet_crypto_op_id_t opt,
416 vnet_crypto_ops_handler_t * fn,
417 vnet_crypto_chained_ops_handler_t *
418 cfn);
419
Damjan Mariond1bed682019-04-24 15:20:35 +0200420void vnet_crypto_register_key_handler (vlib_main_t * vm, u32 engine_index,
421 vnet_crypto_key_handler_t * keyh);
Damjan Marion91f17dc2019-03-18 18:59:25 +0100422
Fan Zhangf5395782020-04-29 14:00:03 +0100423/** async crypto register functions */
424u32 vnet_crypto_register_post_node (vlib_main_t * vm, char *post_node_name);
Jakub Wysocki83b2bb82021-11-30 10:53:03 +0000425
426void
427vnet_crypto_register_enqueue_handler (vlib_main_t *vm, u32 engine_index,
428 vnet_crypto_async_op_id_t opt,
429 vnet_crypto_frame_enqueue_t *enq_fn);
430
431void
432vnet_crypto_register_dequeue_handler (vlib_main_t *vm, u32 engine_index,
433 vnet_crypto_frame_dequeue_t *deq_fn);
Fan Zhangf5395782020-04-29 14:00:03 +0100434
Damjan Marion91f17dc2019-03-18 18:59:25 +0100435typedef struct
436{
437 char *name;
438 char *desc;
439 int priority;
Damjan Mariond1bed682019-04-24 15:20:35 +0200440 vnet_crypto_key_handler_t *key_op_handler;
Damjan Marion060bfb92019-03-29 13:47:54 +0100441 vnet_crypto_ops_handler_t *ops_handlers[VNET_CRYPTO_N_OP_IDS];
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000442 vnet_crypto_chained_ops_handler_t
443 * chained_ops_handlers[VNET_CRYPTO_N_OP_IDS];
Fan Zhangf5395782020-04-29 14:00:03 +0100444 vnet_crypto_frame_enqueue_t *enqueue_handlers[VNET_CRYPTO_ASYNC_OP_N_IDS];
Jakub Wysocki83b2bb82021-11-30 10:53:03 +0000445 vnet_crypto_frame_dequeue_t *dequeue_handler;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100446} vnet_crypto_engine_t;
447
448typedef struct
449{
Fan Zhangf5395782020-04-29 14:00:03 +0100450 u32 node_idx;
451 u32 next_idx;
452} vnet_crypto_async_next_node_t;
453
454typedef struct
455{
Damjan Marion91f17dc2019-03-18 18:59:25 +0100456 vnet_crypto_alg_data_t *algs;
457 vnet_crypto_thread_t *threads;
458 vnet_crypto_ops_handler_t **ops_handlers;
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000459 vnet_crypto_chained_ops_handler_t **chained_ops_handlers;
Fan Zhangf5395782020-04-29 14:00:03 +0100460 vnet_crypto_frame_enqueue_t **enqueue_handlers;
461 vnet_crypto_frame_dequeue_t **dequeue_handlers;
Damjan Marion060bfb92019-03-29 13:47:54 +0100462 vnet_crypto_op_data_t opt_data[VNET_CRYPTO_N_OP_IDS];
Fan Zhangf5395782020-04-29 14:00:03 +0100463 vnet_crypto_async_op_data_t async_opt_data[VNET_CRYPTO_ASYNC_OP_N_IDS];
Damjan Marion91f17dc2019-03-18 18:59:25 +0100464 vnet_crypto_engine_t *engines;
Damjan Mariond1bed682019-04-24 15:20:35 +0200465 vnet_crypto_key_t *keys;
Filip Tehlar1469d542019-03-25 09:04:41 -0700466 uword *engine_index_by_name;
Damjan Marion060bfb92019-03-29 13:47:54 +0100467 uword *alg_index_by_name;
Fan Zhangf5395782020-04-29 14:00:03 +0100468 uword *async_alg_index_by_name;
469 vnet_crypto_async_alg_data_t *async_algs;
Fan Zhangf5395782020-04-29 14:00:03 +0100470 vnet_crypto_async_next_node_t *next_nodes;
PiotrX Kleski22848172020-07-08 14:36:34 +0200471 u32 crypto_node_index;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100472} vnet_crypto_main_t;
473
474extern vnet_crypto_main_t crypto_main;
475
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000476u32 vnet_crypto_process_chained_ops (vlib_main_t * vm, vnet_crypto_op_t ops[],
477 vnet_crypto_op_chunk_t * chunks,
478 u32 n_ops);
Damjan Marion91f17dc2019-03-18 18:59:25 +0100479u32 vnet_crypto_process_ops (vlib_main_t * vm, vnet_crypto_op_t ops[],
480 u32 n_ops);
481
Fan Zhangf5395782020-04-29 14:00:03 +0100482
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000483int vnet_crypto_set_handler2 (char *ops_handler_name, char *engine,
484 crypto_op_class_type_t oct);
Neale Rannsece2ae02019-06-21 12:44:11 +0000485int vnet_crypto_is_set_handler (vnet_crypto_alg_t alg);
Filip Tehlar1469d542019-03-25 09:04:41 -0700486
Damjan Mariond1bed682019-04-24 15:20:35 +0200487u32 vnet_crypto_key_add (vlib_main_t * vm, vnet_crypto_alg_t alg,
488 u8 * data, u16 length);
489void vnet_crypto_key_del (vlib_main_t * vm, vnet_crypto_key_index_t index);
Damjan Mariond1bed682019-04-24 15:20:35 +0200490
Fan Zhangf5395782020-04-29 14:00:03 +0100491/**
492 * Use 2 created keys to generate new key for linked algs (cipher + integ)
493 * The returned key index is to be used for linked alg only.
494 **/
495u32 vnet_crypto_key_add_linked (vlib_main_t * vm,
496 vnet_crypto_key_index_t index_crypto,
497 vnet_crypto_key_index_t index_integ);
498
Fan Zhangf5395782020-04-29 14:00:03 +0100499int vnet_crypto_set_async_handler2 (char *alg_name, char *engine);
500
501int vnet_crypto_is_set_async_handler (vnet_crypto_async_op_id_t opt);
502
Fan Zhangf5395782020-04-29 14:00:03 +0100503vnet_crypto_async_alg_t vnet_crypto_link_algs (vnet_crypto_alg_t crypto_alg,
504 vnet_crypto_alg_t integ_alg);
505
Damjan Marion91f17dc2019-03-18 18:59:25 +0100506format_function_t format_vnet_crypto_alg;
507format_function_t format_vnet_crypto_engine;
508format_function_t format_vnet_crypto_op;
Damjan Marion060bfb92019-03-29 13:47:54 +0100509format_function_t format_vnet_crypto_op_type;
510format_function_t format_vnet_crypto_op_status;
Damjan Marion61c0a3d2019-04-05 19:42:21 +0200511unformat_function_t unformat_vnet_crypto_alg;
Damjan Mariona03d1822019-03-28 21:40:48 +0100512
Fan Zhangf5395782020-04-29 14:00:03 +0100513format_function_t format_vnet_crypto_async_op;
514format_function_t format_vnet_crypto_async_alg;
515format_function_t format_vnet_crypto_async_op_type;
516
Damjan Mariona03d1822019-03-28 21:40:48 +0100517static_always_inline void
Damjan Marion060bfb92019-03-29 13:47:54 +0100518vnet_crypto_op_init (vnet_crypto_op_t * op, vnet_crypto_op_id_t type)
Damjan Mariona03d1822019-03-28 21:40:48 +0100519{
520 if (CLIB_DEBUG > 0)
521 clib_memset (op, 0xfe, sizeof (*op));
522 op->op = type;
523 op->flags = 0;
Damjan Mariond1bed682019-04-24 15:20:35 +0200524 op->key_index = ~0;
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000525 op->n_chunks = 0;
Damjan Mariona03d1822019-03-28 21:40:48 +0100526}
527
Damjan Marion060bfb92019-03-29 13:47:54 +0100528static_always_inline vnet_crypto_op_type_t
529vnet_crypto_get_op_type (vnet_crypto_op_id_t id)
530{
531 vnet_crypto_main_t *cm = &crypto_main;
Lijian Zhangb15d7962019-09-27 16:25:35 +0800532 ASSERT (id < VNET_CRYPTO_N_OP_IDS);
533 vnet_crypto_op_data_t *od = cm->opt_data + id;
Damjan Marion060bfb92019-03-29 13:47:54 +0100534 return od->type;
535}
536
Damjan Mariond1bed682019-04-24 15:20:35 +0200537static_always_inline vnet_crypto_key_t *
538vnet_crypto_get_key (vnet_crypto_key_index_t index)
539{
540 vnet_crypto_main_t *cm = &crypto_main;
541 return vec_elt_at_index (cm->keys, index);
542}
543
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000544static_always_inline int
545vnet_crypto_set_handler (char *alg_name, char *engine)
546{
547 return vnet_crypto_set_handler2 (alg_name, engine, CRYPTO_OP_BOTH);
548}
549
Fan Zhangf5395782020-04-29 14:00:03 +0100550/** async crypto inline functions **/
551
552static_always_inline vnet_crypto_async_frame_t *
553vnet_crypto_async_get_frame (vlib_main_t * vm, vnet_crypto_async_op_id_t opt)
554{
555 vnet_crypto_main_t *cm = &crypto_main;
556 vnet_crypto_thread_t *ct = cm->threads + vm->thread_index;
Neale Rannsfc811342021-02-26 10:35:33 +0000557 vnet_crypto_async_frame_t *f = NULL;
Fan Zhangf5395782020-04-29 14:00:03 +0100558
Neale Rannsfc811342021-02-26 10:35:33 +0000559 pool_get_aligned (ct->frame_pool, f, CLIB_CACHE_LINE_BYTES);
560 if (CLIB_DEBUG > 0)
561 clib_memset (f, 0xfe, sizeof (*f));
562 f->state = VNET_CRYPTO_FRAME_STATE_NOT_PROCESSED;
563 f->op = opt;
564 f->n_elts = 0;
565
Fan Zhangf5395782020-04-29 14:00:03 +0100566 return f;
567}
568
569static_always_inline void
570vnet_crypto_async_free_frame (vlib_main_t * vm,
571 vnet_crypto_async_frame_t * frame)
572{
573 vnet_crypto_main_t *cm = &crypto_main;
574 vnet_crypto_thread_t *ct = cm->threads + vm->thread_index;
575 pool_put (ct->frame_pool, frame);
576}
577
578static_always_inline int
579vnet_crypto_async_submit_open_frame (vlib_main_t * vm,
580 vnet_crypto_async_frame_t * frame)
581{
582 vnet_crypto_main_t *cm = &crypto_main;
PiotrX Kleski22848172020-07-08 14:36:34 +0200583 vlib_thread_main_t *tm = vlib_get_thread_main ();
Xiaoming Jiang9a9604b2023-03-09 02:03:50 +0000584 u32 i;
585 vlib_node_t *n;
PiotrX Kleski22848172020-07-08 14:36:34 +0200586
PiotrX Kleskief69b512020-11-24 08:26:26 +0000587 frame->state = VNET_CRYPTO_FRAME_STATE_PENDING;
PiotrX Kleski22848172020-07-08 14:36:34 +0200588 frame->enqueue_thread_index = vm->thread_index;
PiotrX Kleskief69b512020-11-24 08:26:26 +0000589
Dastin Wilski8a4a7c22022-03-31 11:55:09 +0200590 if (PREDICT_FALSE (cm->enqueue_handlers == NULL))
591 {
592 frame->state = VNET_CRYPTO_FRAME_STATE_ELT_ERROR;
593 return -1;
594 }
595
PiotrX Kleskief69b512020-11-24 08:26:26 +0000596 int ret = (cm->enqueue_handlers[frame->op]) (vm, frame);
597
Fan Zhangf5395782020-04-29 14:00:03 +0100598 if (PREDICT_TRUE (ret == 0))
599 {
Xiaoming Jiang9a9604b2023-03-09 02:03:50 +0000600 n = vlib_get_node (vm, cm->crypto_node_index);
601 if (n->state == VLIB_NODE_STATE_INTERRUPT)
Neale Rannsfc811342021-02-26 10:35:33 +0000602 {
Xiaoming Jiang9a9604b2023-03-09 02:03:50 +0000603 for (i = 0; i < tm->n_vlib_mains; i++)
Damjan Marion6ffb7c62021-03-26 13:06:13 +0100604 vlib_node_set_interrupt_pending (vlib_get_main_by_index (i),
Neale Rannsfc811342021-02-26 10:35:33 +0000605 cm->crypto_node_index);
606 }
Fan Zhangf5395782020-04-29 14:00:03 +0100607 }
PiotrX Kleskief69b512020-11-24 08:26:26 +0000608 else
609 {
610 frame->state = VNET_CRYPTO_FRAME_STATE_ELT_ERROR;
611 }
PiotrX Kleski22848172020-07-08 14:36:34 +0200612
Fan Zhangf5395782020-04-29 14:00:03 +0100613 return ret;
614}
615
Neale Rannsfc811342021-02-26 10:35:33 +0000616static_always_inline void
617vnet_crypto_async_add_to_frame (vlib_main_t *vm, vnet_crypto_async_frame_t *f,
618 u32 key_index, u32 crypto_len,
619 i16 integ_len_adj, i16 crypto_start_offset,
Benoît Ganne02dfd292022-01-18 15:56:41 +0100620 i16 integ_start_offset, u32 buffer_index,
Neale Rannsfc811342021-02-26 10:35:33 +0000621 u16 next_node, u8 *iv, u8 *tag, u8 *aad,
622 u8 flags)
Fan Zhangf5395782020-04-29 14:00:03 +0100623{
Fan Zhangf5395782020-04-29 14:00:03 +0100624 vnet_crypto_async_frame_elt_t *fe;
625 u16 index;
626
Neale Rannsfc811342021-02-26 10:35:33 +0000627 ASSERT (f->n_elts < VNET_CRYPTO_FRAME_SIZE);
Fan Zhangf5395782020-04-29 14:00:03 +0100628
629 index = f->n_elts;
630 fe = &f->elts[index];
631 f->n_elts++;
632 fe->key_index = key_index;
633 fe->crypto_total_length = crypto_len;
634 fe->crypto_start_offset = crypto_start_offset;
635 fe->integ_start_offset = integ_start_offset;
636 fe->integ_length_adj = integ_len_adj;
637 fe->iv = iv;
638 fe->tag = tag;
639 fe->aad = aad;
640 fe->flags = flags;
641 f->buffer_indices[index] = buffer_index;
642 f->next_node_index[index] = next_node;
Fan Zhangf5395782020-04-29 14:00:03 +0100643}
644
645static_always_inline void
646vnet_crypto_async_reset_frame (vnet_crypto_async_frame_t * f)
647{
648 vnet_crypto_async_op_id_t opt;
649 ASSERT (f != 0);
PiotrX Kleski8ed06c02020-11-24 07:34:09 +0000650 ASSERT ((f->state == VNET_CRYPTO_FRAME_STATE_NOT_PROCESSED
651 || f->state == VNET_CRYPTO_FRAME_STATE_ELT_ERROR));
Fan Zhangf5395782020-04-29 14:00:03 +0100652 opt = f->op;
653 if (CLIB_DEBUG > 0)
654 clib_memset (f, 0xfe, sizeof (*f));
655 f->state = VNET_CRYPTO_FRAME_STATE_NOT_PROCESSED;
656 f->op = opt;
657 f->n_elts = 0;
658}
659
Neale Rannsfc811342021-02-26 10:35:33 +0000660static_always_inline u8
661vnet_crypto_async_frame_is_full (const vnet_crypto_async_frame_t *f)
662{
663 return (f->n_elts == VNET_CRYPTO_FRAME_SIZE);
664}
665
Damjan Marion91f17dc2019-03-18 18:59:25 +0100666#endif /* included_vnet_crypto_crypto_h */
667
668/*
669 * fd.io coding-style-patch-verification: ON
670 *
671 * Local Variables:
672 * eval: (c-set-style "gnu")
673 * End:
674 */