2 *------------------------------------------------------------------
3 * Copyright (c) 2019 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
18 #include <sys/syscall.h>
20 #include <openssl/evp.h>
21 #include <openssl/hmac.h>
22 #include <openssl/rand.h>
23 #include <openssl/sha.h>
25 #include <vlib/vlib.h>
26 #include <vnet/plugin/plugin.h>
27 #include <vnet/crypto/crypto.h>
28 #include <vpp/app/version.h>
32 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
33 EVP_CIPHER_CTX *evp_cipher_ctx;
36 #if OPENSSL_VERSION_NUMBER < 0x10100000L
39 } openssl_per_thread_data_t;
41 static openssl_per_thread_data_t *per_thread_data = 0;
43 #define foreach_openssl_aes_evp_op \
44 _ (cbc, DES_CBC, EVP_des_cbc, 8) \
45 _ (cbc, 3DES_CBC, EVP_des_ede3_cbc, 8) \
46 _ (cbc, AES_128_CBC, EVP_aes_128_cbc, 16) \
47 _ (cbc, AES_192_CBC, EVP_aes_192_cbc, 16) \
48 _ (cbc, AES_256_CBC, EVP_aes_256_cbc, 16) \
49 _ (gcm, AES_128_GCM, EVP_aes_128_gcm, 8) \
50 _ (gcm, AES_192_GCM, EVP_aes_192_gcm, 8) \
51 _ (gcm, AES_256_GCM, EVP_aes_256_gcm, 8) \
52 _ (cbc, AES_128_CTR, EVP_aes_128_ctr, 8) \
53 _ (cbc, AES_192_CTR, EVP_aes_192_ctr, 8) \
54 _ (cbc, AES_256_CTR, EVP_aes_256_ctr, 8)
56 #define foreach_openssl_chacha20_evp_op \
57 _ (chacha20_poly1305, CHACHA20_POLY1305, EVP_chacha20_poly1305, 8)
59 #if OPENSSL_VERSION_NUMBER >= 0x10100000L
60 #define foreach_openssl_evp_op foreach_openssl_aes_evp_op \
61 foreach_openssl_chacha20_evp_op
63 #define foreach_openssl_evp_op foreach_openssl_aes_evp_op
66 #ifndef EVP_CTRL_AEAD_GET_TAG
67 #define EVP_CTRL_AEAD_GET_TAG EVP_CTRL_GCM_GET_TAG
70 #ifndef EVP_CTRL_AEAD_SET_TAG
71 #define EVP_CTRL_AEAD_SET_TAG EVP_CTRL_GCM_SET_TAG
74 #define foreach_openssl_hash_op \
76 _ (SHA224, EVP_sha224) \
77 _ (SHA256, EVP_sha256) \
78 _ (SHA384, EVP_sha384) \
79 _ (SHA512, EVP_sha512)
81 #define foreach_openssl_hmac_op \
84 _(SHA224, EVP_sha224) \
85 _(SHA256, EVP_sha256) \
86 _(SHA384, EVP_sha384) \
89 static_always_inline u32
90 openssl_ops_enc_cbc (vlib_main_t *vm, vnet_crypto_op_t *ops[],
91 vnet_crypto_op_chunk_t *chunks, u32 n_ops,
92 const EVP_CIPHER *cipher, const int iv_len)
94 openssl_per_thread_data_t *ptd = vec_elt_at_index (per_thread_data,
96 EVP_CIPHER_CTX *ctx = ptd->evp_cipher_ctx;
97 vnet_crypto_op_chunk_t *chp;
98 u32 i, j, curr_len = 0;
99 u8 out_buf[VLIB_BUFFER_DEFAULT_DATA_SIZE * 5];
101 for (i = 0; i < n_ops; i++)
103 vnet_crypto_op_t *op = ops[i];
104 vnet_crypto_key_t *key = vnet_crypto_get_key (op->key_index);
107 EVP_EncryptInit_ex (ctx, cipher, NULL, key->data, op->iv);
109 if (op->flags & VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS)
111 chp = chunks + op->chunk_index;
113 for (j = 0; j < op->n_chunks; j++)
115 EVP_EncryptUpdate (ctx, out_buf + offset, &out_len, chp->src,
121 if (out_len < curr_len)
122 EVP_EncryptFinal_ex (ctx, out_buf + offset, &out_len);
125 chp = chunks + op->chunk_index;
126 for (j = 0; j < op->n_chunks; j++)
128 clib_memcpy_fast (chp->dst, out_buf + offset, chp->len);
135 EVP_EncryptUpdate (ctx, op->dst, &out_len, op->src, op->len);
136 if (out_len < op->len)
137 EVP_EncryptFinal_ex (ctx, op->dst + out_len, &out_len);
139 op->status = VNET_CRYPTO_OP_STATUS_COMPLETED;
144 static_always_inline u32
145 openssl_ops_dec_cbc (vlib_main_t *vm, vnet_crypto_op_t *ops[],
146 vnet_crypto_op_chunk_t *chunks, u32 n_ops,
147 const EVP_CIPHER *cipher, const int iv_len)
149 openssl_per_thread_data_t *ptd = vec_elt_at_index (per_thread_data,
151 EVP_CIPHER_CTX *ctx = ptd->evp_cipher_ctx;
152 vnet_crypto_op_chunk_t *chp;
153 u32 i, j, curr_len = 0;
154 u8 out_buf[VLIB_BUFFER_DEFAULT_DATA_SIZE * 5];
156 for (i = 0; i < n_ops; i++)
158 vnet_crypto_op_t *op = ops[i];
159 vnet_crypto_key_t *key = vnet_crypto_get_key (op->key_index);
162 EVP_DecryptInit_ex (ctx, cipher, NULL, key->data, op->iv);
164 if (op->flags & VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS)
166 chp = chunks + op->chunk_index;
168 for (j = 0; j < op->n_chunks; j++)
170 EVP_DecryptUpdate (ctx, out_buf + offset, &out_len, chp->src,
176 if (out_len < curr_len)
177 EVP_DecryptFinal_ex (ctx, out_buf + offset, &out_len);
180 chp = chunks + op->chunk_index;
181 for (j = 0; j < op->n_chunks; j++)
183 clib_memcpy_fast (chp->dst, out_buf + offset, chp->len);
190 EVP_DecryptUpdate (ctx, op->dst, &out_len, op->src, op->len);
191 if (out_len < op->len)
192 EVP_DecryptFinal_ex (ctx, op->dst + out_len, &out_len);
194 op->status = VNET_CRYPTO_OP_STATUS_COMPLETED;
199 static_always_inline u32
200 openssl_ops_enc_aead (vlib_main_t *vm, vnet_crypto_op_t *ops[],
201 vnet_crypto_op_chunk_t *chunks, u32 n_ops,
202 const EVP_CIPHER *cipher, int is_gcm, const int iv_len)
204 openssl_per_thread_data_t *ptd = vec_elt_at_index (per_thread_data,
206 EVP_CIPHER_CTX *ctx = ptd->evp_cipher_ctx;
207 vnet_crypto_op_chunk_t *chp;
209 for (i = 0; i < n_ops; i++)
211 vnet_crypto_op_t *op = ops[i];
212 vnet_crypto_key_t *key = vnet_crypto_get_key (op->key_index);
215 EVP_EncryptInit_ex (ctx, cipher, 0, 0, 0);
217 EVP_CIPHER_CTX_ctrl (ctx, EVP_CTRL_GCM_SET_IVLEN, 12, NULL);
218 EVP_EncryptInit_ex (ctx, 0, 0, key->data, op->iv);
220 EVP_EncryptUpdate (ctx, NULL, &len, op->aad, op->aad_len);
221 if (op->flags & VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS)
223 chp = chunks + op->chunk_index;
224 for (j = 0; j < op->n_chunks; j++)
226 EVP_EncryptUpdate (ctx, chp->dst, &len, chp->src, chp->len);
231 EVP_EncryptUpdate (ctx, op->dst, &len, op->src, op->len);
232 EVP_EncryptFinal_ex (ctx, op->dst + len, &len);
233 EVP_CIPHER_CTX_ctrl (ctx, EVP_CTRL_AEAD_GET_TAG, op->tag_len, op->tag);
234 op->status = VNET_CRYPTO_OP_STATUS_COMPLETED;
239 static_always_inline u32
240 openssl_ops_enc_gcm (vlib_main_t *vm, vnet_crypto_op_t *ops[],
241 vnet_crypto_op_chunk_t *chunks, u32 n_ops,
242 const EVP_CIPHER *cipher, const int iv_len)
244 return openssl_ops_enc_aead (vm, ops, chunks, n_ops, cipher,
245 /* is_gcm */ 1, iv_len);
248 static_always_inline __clib_unused u32
249 openssl_ops_enc_chacha20_poly1305 (vlib_main_t *vm, vnet_crypto_op_t *ops[],
250 vnet_crypto_op_chunk_t *chunks, u32 n_ops,
251 const EVP_CIPHER *cipher, const int iv_len)
253 return openssl_ops_enc_aead (vm, ops, chunks, n_ops, cipher,
254 /* is_gcm */ 0, iv_len);
257 static_always_inline u32
258 openssl_ops_dec_aead (vlib_main_t *vm, vnet_crypto_op_t *ops[],
259 vnet_crypto_op_chunk_t *chunks, u32 n_ops,
260 const EVP_CIPHER *cipher, int is_gcm, const int iv_len)
262 openssl_per_thread_data_t *ptd = vec_elt_at_index (per_thread_data,
264 EVP_CIPHER_CTX *ctx = ptd->evp_cipher_ctx;
265 vnet_crypto_op_chunk_t *chp;
266 u32 i, j, n_fail = 0;
267 for (i = 0; i < n_ops; i++)
269 vnet_crypto_op_t *op = ops[i];
270 vnet_crypto_key_t *key = vnet_crypto_get_key (op->key_index);
273 EVP_DecryptInit_ex (ctx, cipher, 0, 0, 0);
275 EVP_CIPHER_CTX_ctrl (ctx, EVP_CTRL_GCM_SET_IVLEN, 12, 0);
276 EVP_DecryptInit_ex (ctx, 0, 0, key->data, op->iv);
278 EVP_DecryptUpdate (ctx, 0, &len, op->aad, op->aad_len);
279 if (op->flags & VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS)
281 chp = chunks + op->chunk_index;
282 for (j = 0; j < op->n_chunks; j++)
284 EVP_DecryptUpdate (ctx, chp->dst, &len, chp->src, chp->len);
289 EVP_DecryptUpdate (ctx, op->dst, &len, op->src, op->len);
290 EVP_CIPHER_CTX_ctrl (ctx, EVP_CTRL_AEAD_SET_TAG, op->tag_len, op->tag);
292 if (EVP_DecryptFinal_ex (ctx, op->dst + len, &len) > 0)
293 op->status = VNET_CRYPTO_OP_STATUS_COMPLETED;
297 op->status = VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC;
300 return n_ops - n_fail;
303 static_always_inline u32
304 openssl_ops_dec_gcm (vlib_main_t *vm, vnet_crypto_op_t *ops[],
305 vnet_crypto_op_chunk_t *chunks, u32 n_ops,
306 const EVP_CIPHER *cipher, const int iv_len)
308 return openssl_ops_dec_aead (vm, ops, chunks, n_ops, cipher,
309 /* is_gcm */ 1, iv_len);
312 static_always_inline __clib_unused u32
313 openssl_ops_dec_chacha20_poly1305 (vlib_main_t *vm, vnet_crypto_op_t *ops[],
314 vnet_crypto_op_chunk_t *chunks, u32 n_ops,
315 const EVP_CIPHER *cipher, const int iv_len)
317 return openssl_ops_dec_aead (vm, ops, chunks, n_ops, cipher,
318 /* is_gcm */ 0, iv_len);
321 static_always_inline u32
322 openssl_ops_hash (vlib_main_t *vm, vnet_crypto_op_t *ops[],
323 vnet_crypto_op_chunk_t *chunks, u32 n_ops, const EVP_MD *md)
325 openssl_per_thread_data_t *ptd =
326 vec_elt_at_index (per_thread_data, vm->thread_index);
327 EVP_MD_CTX *ctx = ptd->hash_ctx;
328 vnet_crypto_op_chunk_t *chp;
329 u32 md_len, i, j, n_fail = 0;
331 for (i = 0; i < n_ops; i++)
333 vnet_crypto_op_t *op = ops[i];
335 EVP_DigestInit_ex (ctx, md, NULL);
336 if (op->flags & VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS)
338 chp = chunks + op->chunk_index;
339 for (j = 0; j < op->n_chunks; j++)
341 EVP_DigestUpdate (ctx, chp->src, chp->len);
346 EVP_DigestUpdate (ctx, op->src, op->len);
348 EVP_DigestFinal_ex (ctx, op->digest, &md_len);
349 op->digest_len = md_len;
350 op->status = VNET_CRYPTO_OP_STATUS_COMPLETED;
352 return n_ops - n_fail;
355 static_always_inline u32
356 openssl_ops_hmac (vlib_main_t * vm, vnet_crypto_op_t * ops[],
357 vnet_crypto_op_chunk_t * chunks, u32 n_ops,
361 openssl_per_thread_data_t *ptd = vec_elt_at_index (per_thread_data,
363 HMAC_CTX *ctx = ptd->hmac_ctx;
364 vnet_crypto_op_chunk_t *chp;
365 u32 i, j, n_fail = 0;
366 for (i = 0; i < n_ops; i++)
368 vnet_crypto_op_t *op = ops[i];
369 vnet_crypto_key_t *key = vnet_crypto_get_key (op->key_index);
370 unsigned int out_len = 0;
371 size_t sz = op->digest_len ? op->digest_len : EVP_MD_size (md);
373 HMAC_Init_ex (ctx, key->data, vec_len (key->data), md, NULL);
374 if (op->flags & VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS)
376 chp = chunks + op->chunk_index;
377 for (j = 0; j < op->n_chunks; j++)
379 HMAC_Update (ctx, chp->src, chp->len);
384 HMAC_Update (ctx, op->src, op->len);
385 HMAC_Final (ctx, buffer, &out_len);
387 if (op->flags & VNET_CRYPTO_OP_FLAG_HMAC_CHECK)
389 if ((memcmp (op->digest, buffer, sz)))
392 op->status = VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC;
397 clib_memcpy_fast (op->digest, buffer, sz);
398 op->status = VNET_CRYPTO_OP_STATUS_COMPLETED;
400 return n_ops - n_fail;
403 #define _(m, a, b, iv) \
404 static u32 openssl_ops_enc_##a (vlib_main_t *vm, vnet_crypto_op_t *ops[], \
407 return openssl_ops_enc_##m (vm, ops, 0, n_ops, b (), iv); \
410 u32 openssl_ops_dec_##a (vlib_main_t *vm, vnet_crypto_op_t *ops[], \
413 return openssl_ops_dec_##m (vm, ops, 0, n_ops, b (), iv); \
416 static u32 openssl_ops_enc_chained_##a ( \
417 vlib_main_t *vm, vnet_crypto_op_t *ops[], vnet_crypto_op_chunk_t *chunks, \
420 return openssl_ops_enc_##m (vm, ops, chunks, n_ops, b (), iv); \
423 static u32 openssl_ops_dec_chained_##a ( \
424 vlib_main_t *vm, vnet_crypto_op_t *ops[], vnet_crypto_op_chunk_t *chunks, \
427 return openssl_ops_dec_##m (vm, ops, chunks, n_ops, b (), iv); \
430 foreach_openssl_evp_op;
434 static u32 openssl_ops_hash_##a (vlib_main_t *vm, vnet_crypto_op_t *ops[], \
437 return openssl_ops_hash (vm, ops, 0, n_ops, b ()); \
439 static u32 openssl_ops_hash_chained_##a ( \
440 vlib_main_t *vm, vnet_crypto_op_t *ops[], vnet_crypto_op_chunk_t *chunks, \
443 return openssl_ops_hash (vm, ops, chunks, n_ops, b ()); \
446 foreach_openssl_hash_op;
451 openssl_ops_hmac_##a (vlib_main_t * vm, vnet_crypto_op_t * ops[], u32 n_ops) \
452 { return openssl_ops_hmac (vm, ops, 0, n_ops, b ()); } \
454 openssl_ops_hmac_chained_##a (vlib_main_t * vm, vnet_crypto_op_t * ops[], \
455 vnet_crypto_op_chunk_t *chunks, u32 n_ops) \
456 { return openssl_ops_hmac (vm, ops, chunks, n_ops, b ()); } \
458 foreach_openssl_hmac_op;
463 crypto_openssl_init (vlib_main_t * vm)
465 vlib_thread_main_t *tm = vlib_get_thread_main ();
466 openssl_per_thread_data_t *ptd;
469 if (syscall (SYS_getrandom, &seed, sizeof (seed), 0) != sizeof (seed))
470 return clib_error_return_unix (0, "getrandom() failed");
472 RAND_seed (seed, sizeof (seed));
474 u32 eidx = vnet_crypto_register_engine (vm, "openssl", 50, "OpenSSL");
476 #define _(m, a, b, iv) \
477 vnet_crypto_register_ops_handlers (vm, eidx, VNET_CRYPTO_OP_##a##_ENC, \
478 openssl_ops_enc_##a, \
479 openssl_ops_enc_chained_##a); \
480 vnet_crypto_register_ops_handlers (vm, eidx, VNET_CRYPTO_OP_##a##_DEC, \
481 openssl_ops_dec_##a, \
482 openssl_ops_dec_chained_##a);
484 foreach_openssl_evp_op;
488 vnet_crypto_register_ops_handlers (vm, eidx, VNET_CRYPTO_OP_##a##_HMAC, \
489 openssl_ops_hmac_##a, \
490 openssl_ops_hmac_chained_##a); \
492 foreach_openssl_hmac_op;
496 vnet_crypto_register_ops_handlers (vm, eidx, VNET_CRYPTO_OP_##a##_HASH, \
497 openssl_ops_hash_##a, \
498 openssl_ops_hash_chained_##a);
500 foreach_openssl_hash_op;
503 vec_validate_aligned (per_thread_data, tm->n_vlib_mains - 1,
504 CLIB_CACHE_LINE_BYTES);
506 vec_foreach (ptd, per_thread_data)
508 ptd->evp_cipher_ctx = EVP_CIPHER_CTX_new ();
509 EVP_CIPHER_CTX_set_padding (ptd->evp_cipher_ctx, 0);
510 #if OPENSSL_VERSION_NUMBER >= 0x10100000L
511 ptd->hmac_ctx = HMAC_CTX_new ();
512 ptd->hash_ctx = EVP_MD_CTX_create ();
514 HMAC_CTX_init (&(ptd->_hmac_ctx));
515 ptd->hmac_ctx = &ptd->_hmac_ctx;
523 VLIB_INIT_FUNCTION (crypto_openssl_init) =
525 .runs_after = VLIB_INITS ("vnet_crypto_init"),
531 VLIB_PLUGIN_REGISTER () = {
532 .version = VPP_BUILD_VER,
533 .description = "OpenSSL Crypto Engine",
538 * fd.io coding-style-patch-verification: ON
541 * eval: (c-set-style "gnu")