crypto.h revision b15d796d
1/*
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
19#define VNET_CRYPTO_RING_SIZE 512
20
21#include <vlib/vlib.h>
22
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)
33
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
40#define foreach_crypto_hmac_alg \
41  _(MD5, "md5") \
42  _(SHA1, "sha-1") \
43  _(SHA224, "sha-224")  \
44  _(SHA256, "sha-256")  \
45  _(SHA384, "sha-384")  \
46  _(SHA512, "sha-512")
47
48
49#define foreach_crypto_op_type \
50  _(ENCRYPT, "encrypt") \
51  _(DECRYPT, "decrypt") \
52  _(AEAD_ENCRYPT, "aead-encrypt") \
53  _(AEAD_DECRYPT, "aead-decrypt") \
54  _(HMAC, "hmac")
55
56typedef enum
57{
58#define _(n, s) VNET_CRYPTO_OP_TYPE_##n,
59  foreach_crypto_op_type
60#undef _
61    VNET_CRYPTO_OP_N_TYPES,
62} vnet_crypto_op_type_t;
63
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
70typedef enum
71{
72  VNET_CRYPTO_KEY_OP_ADD,
73  VNET_CRYPTO_KEY_OP_DEL,
74  VNET_CRYPTO_KEY_OP_MODIFY,
75} vnet_crypto_key_op_t;
76
77typedef enum
78{
79#define _(n, s) VNET_CRYPTO_OP_STATUS_##n,
80  foreach_crypto_op_status
81#undef _
82    VNET_CRYPTO_OP_N_STATUS,
83} vnet_crypto_op_status_t;
84
85/* *INDENT-OFF* */
86typedef enum
87{
88  VNET_CRYPTO_ALG_NONE = 0,
89#define _(n, s, l) VNET_CRYPTO_ALG_##n,
90  foreach_crypto_cipher_alg
91  foreach_crypto_aead_alg
92#undef _
93#define _(n, s) VNET_CRYPTO_ALG_HMAC_##n,
94  foreach_crypto_hmac_alg
95#undef _
96  VNET_CRYPTO_N_ALGS,
97} vnet_crypto_alg_t;
98
99typedef struct
100{
101  u8 *data;
102  vnet_crypto_alg_t alg:8;
103} vnet_crypto_key_t;
104
105typedef enum
106{
107  VNET_CRYPTO_OP_NONE = 0,
108#define _(n, s, l) VNET_CRYPTO_OP_##n##_ENC, VNET_CRYPTO_OP_##n##_DEC,
109  foreach_crypto_cipher_alg
110  foreach_crypto_aead_alg
111#undef _
112#define _(n, s) VNET_CRYPTO_OP_##n##_HMAC,
113 foreach_crypto_hmac_alg
114#undef _
115    VNET_CRYPTO_N_OP_IDS,
116} vnet_crypto_op_id_t;
117/* *INDENT-ON* */
118
119typedef struct
120{
121  char *name;
122  vnet_crypto_op_id_t op_by_type[VNET_CRYPTO_OP_N_TYPES];
123} vnet_crypto_alg_data_t;
124
125typedef struct
126{
127  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
128  vnet_crypto_op_id_t op:16;
129  vnet_crypto_op_status_t status:8;
130  u8 flags;
131#define VNET_CRYPTO_OP_FLAG_INIT_IV (1 << 0)
132#define VNET_CRYPTO_OP_FLAG_HMAC_CHECK (1 << 1)
133  u32 key_index;
134  u32 len;
135  u16 aad_len;
136  u8 digest_len, tag_len;
137  u8 *iv;
138  u8 *src;
139  u8 *dst;
140  u8 *aad;
141  u8 *tag;
142  u8 *digest;
143  uword user_data;
144} vnet_crypto_op_t;
145
146typedef struct
147{
148  vnet_crypto_op_type_t type;
149  vnet_crypto_alg_t alg;
150  u32 active_engine_index;
151} vnet_crypto_op_data_t;
152
153typedef struct
154{
155  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
156  clib_bitmap_t *act_queues;
157} vnet_crypto_thread_t;
158
159typedef u32 vnet_crypto_key_index_t;
160
161typedef u32 (vnet_crypto_ops_handler_t) (vlib_main_t * vm,
162					 vnet_crypto_op_t * ops[], u32 n_ops);
163
164typedef void (vnet_crypto_key_handler_t) (vlib_main_t * vm,
165					  vnet_crypto_key_op_t kop,
166					  vnet_crypto_key_index_t idx);
167
168u32 vnet_crypto_register_engine (vlib_main_t * vm, char *name, int prio,
169				 char *desc);
170
171void vnet_crypto_register_ops_handler (vlib_main_t * vm, u32 engine_index,
172				       vnet_crypto_op_id_t opt,
173				       vnet_crypto_ops_handler_t * oph);
174void vnet_crypto_register_key_handler (vlib_main_t * vm, u32 engine_index,
175				       vnet_crypto_key_handler_t * keyh);
176
177typedef struct
178{
179  char *name;
180  char *desc;
181  int priority;
182  vnet_crypto_key_handler_t *key_op_handler;
183  vnet_crypto_ops_handler_t *ops_handlers[VNET_CRYPTO_N_OP_IDS];
184} vnet_crypto_engine_t;
185
186typedef struct
187{
188  vnet_crypto_alg_data_t *algs;
189  vnet_crypto_thread_t *threads;
190  vnet_crypto_ops_handler_t **ops_handlers;
191  vnet_crypto_op_data_t opt_data[VNET_CRYPTO_N_OP_IDS];
192  vnet_crypto_engine_t *engines;
193  vnet_crypto_key_t *keys;
194  uword *engine_index_by_name;
195  uword *alg_index_by_name;
196} vnet_crypto_main_t;
197
198extern vnet_crypto_main_t crypto_main;
199
200u32 vnet_crypto_submit_ops (vlib_main_t * vm, vnet_crypto_op_t ** jobs,
201			    u32 n_jobs);
202
203u32 vnet_crypto_process_ops (vlib_main_t * vm, vnet_crypto_op_t ops[],
204			     u32 n_ops);
205
206int vnet_crypto_set_handler (char *ops_handler_name, char *engine);
207int vnet_crypto_is_set_handler (vnet_crypto_alg_t alg);
208
209u32 vnet_crypto_key_add (vlib_main_t * vm, vnet_crypto_alg_t alg,
210			 u8 * data, u16 length);
211void vnet_crypto_key_del (vlib_main_t * vm, vnet_crypto_key_index_t index);
212
213format_function_t format_vnet_crypto_alg;
214format_function_t format_vnet_crypto_engine;
215format_function_t format_vnet_crypto_op;
216format_function_t format_vnet_crypto_op_type;
217format_function_t format_vnet_crypto_op_status;
218unformat_function_t unformat_vnet_crypto_alg;
219
220static_always_inline void
221vnet_crypto_op_init (vnet_crypto_op_t * op, vnet_crypto_op_id_t type)
222{
223  if (CLIB_DEBUG > 0)
224    clib_memset (op, 0xfe, sizeof (*op));
225  op->op = type;
226  op->flags = 0;
227  op->key_index = ~0;
228}
229
230static_always_inline vnet_crypto_op_type_t
231vnet_crypto_get_op_type (vnet_crypto_op_id_t id)
232{
233  vnet_crypto_main_t *cm = &crypto_main;
234  ASSERT (id < VNET_CRYPTO_N_OP_IDS);
235  vnet_crypto_op_data_t *od = cm->opt_data + id;
236  return od->type;
237}
238
239static_always_inline vnet_crypto_key_t *
240vnet_crypto_get_key (vnet_crypto_key_index_t index)
241{
242  vnet_crypto_main_t *cm = &crypto_main;
243  return vec_elt_at_index (cm->keys, index);
244}
245
246#endif /* included_vnet_crypto_crypto_h */
247
248/*
249 * fd.io coding-style-patch-verification: ON
250 *
251 * Local Variables:
252 * eval: (c-set-style "gnu")
253 * End:
254 */
255