4 * Copyright(c) 2016-2017 Intel Corporation. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
16 * * Neither the name of Intel Corporation nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 #include <rte_common.h>
34 #include <rte_hexdump.h>
35 #include <rte_cryptodev.h>
36 #include <rte_cryptodev_pmd.h>
37 #include <rte_cryptodev_vdev.h>
39 #include <rte_malloc.h>
40 #include <rte_cpuflags.h>
42 #include <openssl/evp.h>
44 #include "rte_openssl_pmd_private.h"
46 #define DES_BLOCK_SIZE 8
48 static int cryptodev_openssl_remove(struct rte_vdev_device *vdev);
50 /*----------------------------------------------------------------------------*/
53 * Increment counter by 1
54 * Counter is 64 bit array, big-endian
59 uint64_t *ctr64 = (uint64_t *)ctr;
61 *ctr64 = __builtin_bswap64(*ctr64);
63 *ctr64 = __builtin_bswap64(*ctr64);
67 *------------------------------------------------------------------------------
69 *------------------------------------------------------------------------------
72 /** Get xform chain order */
73 static enum openssl_chain_order
74 openssl_get_chain_order(const struct rte_crypto_sym_xform *xform)
76 enum openssl_chain_order res = OPENSSL_CHAIN_NOT_SUPPORTED;
79 if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
80 if (xform->next == NULL)
81 res = OPENSSL_CHAIN_ONLY_AUTH;
82 else if (xform->next->type ==
83 RTE_CRYPTO_SYM_XFORM_CIPHER)
84 res = OPENSSL_CHAIN_AUTH_CIPHER;
86 if (xform->type == RTE_CRYPTO_SYM_XFORM_CIPHER) {
87 if (xform->next == NULL)
88 res = OPENSSL_CHAIN_ONLY_CIPHER;
89 else if (xform->next->type == RTE_CRYPTO_SYM_XFORM_AUTH)
90 res = OPENSSL_CHAIN_CIPHER_AUTH;
97 /** Get session cipher key from input cipher key */
99 get_cipher_key(uint8_t *input_key, int keylen, uint8_t *session_key)
101 memcpy(session_key, input_key, keylen);
104 /** Get key ede 24 bytes standard from input key */
106 get_cipher_key_ede(uint8_t *key, int keylen, uint8_t *key_ede)
110 /* Initialize keys - 24 bytes: [key1-key2-key3] */
113 memcpy(key_ede, key, 24);
117 memcpy(key_ede, key, 16);
118 memcpy(key_ede + 16, key, 8);
121 /* K1 = K2 = K3 (DES compatibility) */
122 memcpy(key_ede, key, 8);
123 memcpy(key_ede + 8, key, 8);
124 memcpy(key_ede + 16, key, 8);
127 OPENSSL_LOG_ERR("Unsupported key size");
134 /** Get adequate openssl function for input cipher algorithm */
136 get_cipher_algo(enum rte_crypto_cipher_algorithm sess_algo, size_t keylen,
137 const EVP_CIPHER **algo)
143 case RTE_CRYPTO_CIPHER_3DES_CBC:
146 *algo = EVP_des_ede_cbc();
149 *algo = EVP_des_ede3_cbc();
155 case RTE_CRYPTO_CIPHER_3DES_CTR:
157 case RTE_CRYPTO_CIPHER_AES_CBC:
160 *algo = EVP_aes_128_cbc();
163 *algo = EVP_aes_192_cbc();
166 *algo = EVP_aes_256_cbc();
172 case RTE_CRYPTO_CIPHER_AES_CTR:
175 *algo = EVP_aes_128_ctr();
178 *algo = EVP_aes_192_ctr();
181 *algo = EVP_aes_256_ctr();
187 case RTE_CRYPTO_CIPHER_AES_GCM:
190 *algo = EVP_aes_128_gcm();
193 *algo = EVP_aes_192_gcm();
196 *algo = EVP_aes_256_gcm();
213 /** Get adequate openssl function for input auth algorithm */
215 get_auth_algo(enum rte_crypto_auth_algorithm sessalgo,
222 case RTE_CRYPTO_AUTH_MD5:
223 case RTE_CRYPTO_AUTH_MD5_HMAC:
226 case RTE_CRYPTO_AUTH_SHA1:
227 case RTE_CRYPTO_AUTH_SHA1_HMAC:
230 case RTE_CRYPTO_AUTH_SHA224:
231 case RTE_CRYPTO_AUTH_SHA224_HMAC:
232 *algo = EVP_sha224();
234 case RTE_CRYPTO_AUTH_SHA256:
235 case RTE_CRYPTO_AUTH_SHA256_HMAC:
236 *algo = EVP_sha256();
238 case RTE_CRYPTO_AUTH_SHA384:
239 case RTE_CRYPTO_AUTH_SHA384_HMAC:
240 *algo = EVP_sha384();
242 case RTE_CRYPTO_AUTH_SHA512:
243 case RTE_CRYPTO_AUTH_SHA512_HMAC:
244 *algo = EVP_sha512();
257 /** Set session cipher parameters */
259 openssl_set_session_cipher_parameters(struct openssl_session *sess,
260 const struct rte_crypto_sym_xform *xform)
262 /* Select cipher direction */
263 sess->cipher.direction = xform->cipher.op;
264 /* Select cipher key */
265 sess->cipher.key.length = xform->cipher.key.length;
267 /* Set IV parameters */
268 sess->iv.offset = xform->cipher.iv.offset;
269 sess->iv.length = xform->cipher.iv.length;
271 /* Select cipher algo */
272 switch (xform->cipher.algo) {
273 case RTE_CRYPTO_CIPHER_3DES_CBC:
274 case RTE_CRYPTO_CIPHER_AES_CBC:
275 case RTE_CRYPTO_CIPHER_AES_CTR:
276 case RTE_CRYPTO_CIPHER_AES_GCM:
277 sess->cipher.mode = OPENSSL_CIPHER_LIB;
278 sess->cipher.algo = xform->cipher.algo;
279 sess->cipher.ctx = EVP_CIPHER_CTX_new();
281 if (get_cipher_algo(sess->cipher.algo, sess->cipher.key.length,
282 &sess->cipher.evp_algo) != 0)
285 get_cipher_key(xform->cipher.key.data, sess->cipher.key.length,
286 sess->cipher.key.data);
290 case RTE_CRYPTO_CIPHER_3DES_CTR:
291 sess->cipher.mode = OPENSSL_CIPHER_DES3CTR;
292 sess->cipher.ctx = EVP_CIPHER_CTX_new();
294 if (get_cipher_key_ede(xform->cipher.key.data,
295 sess->cipher.key.length,
296 sess->cipher.key.data) != 0)
299 case RTE_CRYPTO_CIPHER_DES_DOCSISBPI:
300 sess->cipher.algo = xform->cipher.algo;
301 sess->chain_order = OPENSSL_CHAIN_CIPHER_BPI;
302 sess->cipher.ctx = EVP_CIPHER_CTX_new();
303 sess->cipher.evp_algo = EVP_des_cbc();
305 sess->cipher.bpi_ctx = EVP_CIPHER_CTX_new();
306 /* IV will be ECB encrypted whether direction is encrypt or decrypt */
307 if (EVP_EncryptInit_ex(sess->cipher.bpi_ctx, EVP_des_ecb(),
308 NULL, xform->cipher.key.data, 0) != 1)
311 get_cipher_key(xform->cipher.key.data, sess->cipher.key.length,
312 sess->cipher.key.data);
315 sess->cipher.algo = RTE_CRYPTO_CIPHER_NULL;
322 /* Set session auth parameters */
324 openssl_set_session_auth_parameters(struct openssl_session *sess,
325 const struct rte_crypto_sym_xform *xform)
327 /* Select auth generate/verify */
328 sess->auth.operation = xform->auth.op;
329 sess->auth.algo = xform->auth.algo;
331 /* Select auth algo */
332 switch (xform->auth.algo) {
333 case RTE_CRYPTO_AUTH_AES_GMAC:
334 case RTE_CRYPTO_AUTH_AES_GCM:
335 /* Check additional condition for AES_GMAC/GCM */
336 if (sess->cipher.algo != RTE_CRYPTO_CIPHER_AES_GCM)
338 sess->chain_order = OPENSSL_CHAIN_COMBINED;
341 case RTE_CRYPTO_AUTH_MD5:
342 case RTE_CRYPTO_AUTH_SHA1:
343 case RTE_CRYPTO_AUTH_SHA224:
344 case RTE_CRYPTO_AUTH_SHA256:
345 case RTE_CRYPTO_AUTH_SHA384:
346 case RTE_CRYPTO_AUTH_SHA512:
347 sess->auth.mode = OPENSSL_AUTH_AS_AUTH;
348 if (get_auth_algo(xform->auth.algo,
349 &sess->auth.auth.evp_algo) != 0)
351 sess->auth.auth.ctx = EVP_MD_CTX_create();
354 case RTE_CRYPTO_AUTH_MD5_HMAC:
355 case RTE_CRYPTO_AUTH_SHA1_HMAC:
356 case RTE_CRYPTO_AUTH_SHA224_HMAC:
357 case RTE_CRYPTO_AUTH_SHA256_HMAC:
358 case RTE_CRYPTO_AUTH_SHA384_HMAC:
359 case RTE_CRYPTO_AUTH_SHA512_HMAC:
360 sess->auth.mode = OPENSSL_AUTH_AS_HMAC;
361 sess->auth.hmac.ctx = EVP_MD_CTX_create();
362 if (get_auth_algo(xform->auth.algo,
363 &sess->auth.hmac.evp_algo) != 0)
365 sess->auth.hmac.pkey = EVP_PKEY_new_mac_key(EVP_PKEY_HMAC, NULL,
366 xform->auth.key.data, xform->auth.key.length);
376 /** Parse crypto xform chain and set private session parameters */
378 openssl_set_session_parameters(struct openssl_session *sess,
379 const struct rte_crypto_sym_xform *xform)
381 const struct rte_crypto_sym_xform *cipher_xform = NULL;
382 const struct rte_crypto_sym_xform *auth_xform = NULL;
384 sess->chain_order = openssl_get_chain_order(xform);
385 switch (sess->chain_order) {
386 case OPENSSL_CHAIN_ONLY_CIPHER:
387 cipher_xform = xform;
389 case OPENSSL_CHAIN_ONLY_AUTH:
392 case OPENSSL_CHAIN_CIPHER_AUTH:
393 cipher_xform = xform;
394 auth_xform = xform->next;
396 case OPENSSL_CHAIN_AUTH_CIPHER:
398 cipher_xform = xform->next;
404 /* Default IV length = 0 */
407 /* cipher_xform must be check before auth_xform */
409 if (openssl_set_session_cipher_parameters(
410 sess, cipher_xform)) {
412 "Invalid/unsupported cipher parameters");
418 if (openssl_set_session_auth_parameters(sess, auth_xform)) {
420 "Invalid/unsupported auth parameters");
428 /** Reset private session parameters */
430 openssl_reset_session(struct openssl_session *sess)
432 EVP_CIPHER_CTX_free(sess->cipher.ctx);
434 if (sess->chain_order == OPENSSL_CHAIN_CIPHER_BPI)
435 EVP_CIPHER_CTX_free(sess->cipher.bpi_ctx);
437 switch (sess->auth.mode) {
438 case OPENSSL_AUTH_AS_AUTH:
439 EVP_MD_CTX_destroy(sess->auth.auth.ctx);
441 case OPENSSL_AUTH_AS_HMAC:
442 EVP_PKEY_free(sess->auth.hmac.pkey);
443 EVP_MD_CTX_destroy(sess->auth.hmac.ctx);
450 /** Provide session for operation */
451 static struct openssl_session *
452 get_session(struct openssl_qp *qp, struct rte_crypto_op *op)
454 struct openssl_session *sess = NULL;
456 if (op->sess_type == RTE_CRYPTO_OP_WITH_SESSION) {
457 /* get existing session */
458 if (likely(op->sym->session != NULL &&
459 op->sym->session->dev_type ==
460 RTE_CRYPTODEV_OPENSSL_PMD))
461 sess = (struct openssl_session *)
462 op->sym->session->_private;
464 /* provide internal session */
467 if (!rte_mempool_get(qp->sess_mp, (void **)&_sess)) {
468 sess = (struct openssl_session *)
469 ((struct rte_cryptodev_sym_session *)_sess)
472 if (unlikely(openssl_set_session_parameters(
473 sess, op->sym->xform) != 0)) {
474 rte_mempool_put(qp->sess_mp, _sess);
477 op->sym->session = _sess;
482 op->status = RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
488 *------------------------------------------------------------------------------
490 *------------------------------------------------------------------------------
493 process_openssl_encryption_update(struct rte_mbuf *mbuf_src, int offset,
494 uint8_t **dst, int srclen, EVP_CIPHER_CTX *ctx)
501 for (m = mbuf_src; m != NULL && offset > rte_pktmbuf_data_len(m);
503 offset -= rte_pktmbuf_data_len(m);
508 src = rte_pktmbuf_mtod_offset(m, uint8_t *, offset);
510 l = rte_pktmbuf_data_len(m) - offset;
512 if (EVP_EncryptUpdate(ctx, *dst, &dstlen, src, srclen) <= 0)
518 if (EVP_EncryptUpdate(ctx, *dst, &dstlen, src, l) <= 0)
524 for (m = m->next; (m != NULL) && (n > 0); m = m->next) {
525 src = rte_pktmbuf_mtod(m, uint8_t *);
526 l = rte_pktmbuf_data_len(m) < n ? rte_pktmbuf_data_len(m) : n;
527 if (EVP_EncryptUpdate(ctx, *dst, &dstlen, src, l) <= 0)
537 process_openssl_decryption_update(struct rte_mbuf *mbuf_src, int offset,
538 uint8_t **dst, int srclen, EVP_CIPHER_CTX *ctx)
545 for (m = mbuf_src; m != NULL && offset > rte_pktmbuf_data_len(m);
547 offset -= rte_pktmbuf_data_len(m);
552 src = rte_pktmbuf_mtod_offset(m, uint8_t *, offset);
554 l = rte_pktmbuf_data_len(m) - offset;
556 if (EVP_DecryptUpdate(ctx, *dst, &dstlen, src, srclen) <= 0)
562 if (EVP_DecryptUpdate(ctx, *dst, &dstlen, src, l) <= 0)
568 for (m = m->next; (m != NULL) && (n > 0); m = m->next) {
569 src = rte_pktmbuf_mtod(m, uint8_t *);
570 l = rte_pktmbuf_data_len(m) < n ? rte_pktmbuf_data_len(m) : n;
571 if (EVP_DecryptUpdate(ctx, *dst, &dstlen, src, l) <= 0)
580 /** Process standard openssl cipher encryption */
582 process_openssl_cipher_encrypt(struct rte_mbuf *mbuf_src, uint8_t *dst,
583 int offset, uint8_t *iv, uint8_t *key, int srclen,
584 EVP_CIPHER_CTX *ctx, const EVP_CIPHER *algo)
588 if (EVP_EncryptInit_ex(ctx, algo, NULL, key, iv) <= 0)
589 goto process_cipher_encrypt_err;
591 EVP_CIPHER_CTX_set_padding(ctx, 0);
593 if (process_openssl_encryption_update(mbuf_src, offset, &dst,
595 goto process_cipher_encrypt_err;
597 if (EVP_EncryptFinal_ex(ctx, dst, &totlen) <= 0)
598 goto process_cipher_encrypt_err;
602 process_cipher_encrypt_err:
603 OPENSSL_LOG_ERR("Process openssl cipher encrypt failed");
607 /** Process standard openssl cipher encryption */
609 process_openssl_cipher_bpi_encrypt(uint8_t *src, uint8_t *dst,
610 uint8_t *iv, int srclen,
614 uint8_t encrypted_iv[DES_BLOCK_SIZE];
617 if (EVP_EncryptUpdate(ctx, encrypted_iv, &encrypted_ivlen,
618 iv, DES_BLOCK_SIZE) <= 0)
619 goto process_cipher_encrypt_err;
621 for (i = 0; i < srclen; i++)
622 *(dst + i) = *(src + i) ^ (encrypted_iv[i]);
626 process_cipher_encrypt_err:
627 OPENSSL_LOG_ERR("Process openssl cipher bpi encrypt failed");
630 /** Process standard openssl cipher decryption */
632 process_openssl_cipher_decrypt(struct rte_mbuf *mbuf_src, uint8_t *dst,
633 int offset, uint8_t *iv, uint8_t *key, int srclen,
634 EVP_CIPHER_CTX *ctx, const EVP_CIPHER *algo)
638 if (EVP_DecryptInit_ex(ctx, algo, NULL, key, iv) <= 0)
639 goto process_cipher_decrypt_err;
641 EVP_CIPHER_CTX_set_padding(ctx, 0);
643 if (process_openssl_decryption_update(mbuf_src, offset, &dst,
645 goto process_cipher_decrypt_err;
647 if (EVP_DecryptFinal_ex(ctx, dst, &totlen) <= 0)
648 goto process_cipher_decrypt_err;
651 process_cipher_decrypt_err:
652 OPENSSL_LOG_ERR("Process openssl cipher decrypt failed");
656 /** Process cipher des 3 ctr encryption, decryption algorithm */
658 process_openssl_cipher_des3ctr(struct rte_mbuf *mbuf_src, uint8_t *dst,
659 int offset, uint8_t *iv, uint8_t *key, int srclen,
662 uint8_t ebuf[8], ctr[8];
668 for (m = mbuf_src; m != NULL && offset > rte_pktmbuf_data_len(m);
670 offset -= rte_pktmbuf_data_len(m);
673 goto process_cipher_des3ctr_err;
675 src = rte_pktmbuf_mtod_offset(m, uint8_t *, offset);
676 l = rte_pktmbuf_data_len(m) - offset;
678 /* We use 3DES encryption also for decryption.
679 * IV is not important for 3DES ecb
681 if (EVP_EncryptInit_ex(ctx, EVP_des_ede3_ecb(), NULL, key, NULL) <= 0)
682 goto process_cipher_des3ctr_err;
686 for (n = 0; n < srclen; n++) {
688 if (EVP_EncryptUpdate(ctx,
689 (unsigned char *)&ebuf, &unused,
690 (const unsigned char *)&ctr, 8) <= 0)
691 goto process_cipher_des3ctr_err;
694 dst[n] = *(src++) ^ ebuf[n % 8];
700 src = rte_pktmbuf_mtod(m, uint8_t *);
701 l = rte_pktmbuf_data_len(m);
708 process_cipher_des3ctr_err:
709 OPENSSL_LOG_ERR("Process openssl cipher des 3 ede ctr failed");
713 /** Process auth/encription aes-gcm algorithm */
715 process_openssl_auth_encryption_gcm(struct rte_mbuf *mbuf_src, int offset,
716 int srclen, uint8_t *aad, int aadlen, uint8_t *iv, int ivlen,
717 uint8_t *key, uint8_t *dst, uint8_t *tag,
718 EVP_CIPHER_CTX *ctx, const EVP_CIPHER *algo)
720 int len = 0, unused = 0;
721 uint8_t empty[] = {};
723 if (EVP_EncryptInit_ex(ctx, algo, NULL, NULL, NULL) <= 0)
724 goto process_auth_encryption_gcm_err;
726 if (EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_GCM_SET_IVLEN, ivlen, NULL) <= 0)
727 goto process_auth_encryption_gcm_err;
729 if (EVP_EncryptInit_ex(ctx, NULL, NULL, key, iv) <= 0)
730 goto process_auth_encryption_gcm_err;
733 if (EVP_EncryptUpdate(ctx, NULL, &len, aad, aadlen) <= 0)
734 goto process_auth_encryption_gcm_err;
737 if (process_openssl_encryption_update(mbuf_src, offset, &dst,
739 goto process_auth_encryption_gcm_err;
741 /* Workaround open ssl bug in version less then 1.0.1f */
742 if (EVP_EncryptUpdate(ctx, empty, &unused, empty, 0) <= 0)
743 goto process_auth_encryption_gcm_err;
745 if (EVP_EncryptFinal_ex(ctx, dst, &len) <= 0)
746 goto process_auth_encryption_gcm_err;
748 if (EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_GCM_GET_TAG, 16, tag) <= 0)
749 goto process_auth_encryption_gcm_err;
753 process_auth_encryption_gcm_err:
754 OPENSSL_LOG_ERR("Process openssl auth encryption gcm failed");
759 process_openssl_auth_decryption_gcm(struct rte_mbuf *mbuf_src, int offset,
760 int srclen, uint8_t *aad, int aadlen, uint8_t *iv, int ivlen,
761 uint8_t *key, uint8_t *dst, uint8_t *tag, EVP_CIPHER_CTX *ctx,
762 const EVP_CIPHER *algo)
764 int len = 0, unused = 0;
765 uint8_t empty[] = {};
767 if (EVP_DecryptInit_ex(ctx, algo, NULL, NULL, NULL) <= 0)
768 goto process_auth_decryption_gcm_err;
770 if (EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_GCM_SET_IVLEN, ivlen, NULL) <= 0)
771 goto process_auth_decryption_gcm_err;
773 if (EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_GCM_SET_TAG, 16, tag) <= 0)
774 goto process_auth_decryption_gcm_err;
776 if (EVP_DecryptInit_ex(ctx, NULL, NULL, key, iv) <= 0)
777 goto process_auth_decryption_gcm_err;
780 if (EVP_DecryptUpdate(ctx, NULL, &len, aad, aadlen) <= 0)
781 goto process_auth_decryption_gcm_err;
784 if (process_openssl_decryption_update(mbuf_src, offset, &dst,
786 goto process_auth_decryption_gcm_err;
788 /* Workaround open ssl bug in version less then 1.0.1f */
789 if (EVP_DecryptUpdate(ctx, empty, &unused, empty, 0) <= 0)
790 goto process_auth_decryption_gcm_err;
792 if (EVP_DecryptFinal_ex(ctx, dst, &len) <= 0)
793 goto process_auth_decryption_gcm_final_err;
797 process_auth_decryption_gcm_err:
798 OPENSSL_LOG_ERR("Process openssl auth description gcm failed");
801 process_auth_decryption_gcm_final_err:
805 /** Process standard openssl auth algorithms */
807 process_openssl_auth(struct rte_mbuf *mbuf_src, uint8_t *dst, int offset,
808 __rte_unused uint8_t *iv, __rte_unused EVP_PKEY * pkey,
809 int srclen, EVP_MD_CTX *ctx, const EVP_MD *algo)
816 for (m = mbuf_src; m != NULL && offset > rte_pktmbuf_data_len(m);
818 offset -= rte_pktmbuf_data_len(m);
821 goto process_auth_err;
823 if (EVP_DigestInit_ex(ctx, algo, NULL) <= 0)
824 goto process_auth_err;
826 src = rte_pktmbuf_mtod_offset(m, uint8_t *, offset);
828 l = rte_pktmbuf_data_len(m) - offset;
830 if (EVP_DigestUpdate(ctx, (char *)src, srclen) <= 0)
831 goto process_auth_err;
832 goto process_auth_final;
835 if (EVP_DigestUpdate(ctx, (char *)src, l) <= 0)
836 goto process_auth_err;
840 for (m = m->next; (m != NULL) && (n > 0); m = m->next) {
841 src = rte_pktmbuf_mtod(m, uint8_t *);
842 l = rte_pktmbuf_data_len(m) < n ? rte_pktmbuf_data_len(m) : n;
843 if (EVP_DigestUpdate(ctx, (char *)src, l) <= 0)
844 goto process_auth_err;
849 if (EVP_DigestFinal_ex(ctx, dst, (unsigned int *)&dstlen) <= 0)
850 goto process_auth_err;
854 OPENSSL_LOG_ERR("Process openssl auth failed");
858 /** Process standard openssl auth algorithms with hmac */
860 process_openssl_auth_hmac(struct rte_mbuf *mbuf_src, uint8_t *dst, int offset,
861 __rte_unused uint8_t *iv, EVP_PKEY *pkey,
862 int srclen, EVP_MD_CTX *ctx, const EVP_MD *algo)
869 for (m = mbuf_src; m != NULL && offset > rte_pktmbuf_data_len(m);
871 offset -= rte_pktmbuf_data_len(m);
874 goto process_auth_err;
876 if (EVP_DigestSignInit(ctx, NULL, algo, NULL, pkey) <= 0)
877 goto process_auth_err;
879 src = rte_pktmbuf_mtod_offset(m, uint8_t *, offset);
881 l = rte_pktmbuf_data_len(m) - offset;
883 if (EVP_DigestSignUpdate(ctx, (char *)src, srclen) <= 0)
884 goto process_auth_err;
885 goto process_auth_final;
888 if (EVP_DigestSignUpdate(ctx, (char *)src, l) <= 0)
889 goto process_auth_err;
893 for (m = m->next; (m != NULL) && (n > 0); m = m->next) {
894 src = rte_pktmbuf_mtod(m, uint8_t *);
895 l = rte_pktmbuf_data_len(m) < n ? rte_pktmbuf_data_len(m) : n;
896 if (EVP_DigestSignUpdate(ctx, (char *)src, l) <= 0)
897 goto process_auth_err;
902 if (EVP_DigestSignFinal(ctx, dst, &dstlen) <= 0)
903 goto process_auth_err;
908 OPENSSL_LOG_ERR("Process openssl auth failed");
912 /*----------------------------------------------------------------------------*/
914 /** Process auth/cipher combined operation */
916 process_openssl_combined_op
917 (struct rte_crypto_op *op, struct openssl_session *sess,
918 struct rte_mbuf *mbuf_src, struct rte_mbuf *mbuf_dst)
921 uint8_t *dst = NULL, *iv, *tag, *aad;
922 int srclen, ivlen, aadlen, status = -1;
925 * Segmented destination buffer is not supported for
926 * encryption/decryption
928 if (!rte_pktmbuf_is_contiguous(mbuf_dst)) {
929 op->status = RTE_CRYPTO_OP_STATUS_ERROR;
933 iv = rte_crypto_op_ctod_offset(op, uint8_t *,
935 ivlen = sess->iv.length;
936 aad = op->sym->auth.aad.data;
937 aadlen = op->sym->auth.aad.length;
939 tag = op->sym->auth.digest.data;
941 tag = rte_pktmbuf_mtod_offset(mbuf_dst, uint8_t *,
942 op->sym->cipher.data.offset +
943 op->sym->cipher.data.length);
945 if (sess->auth.algo == RTE_CRYPTO_AUTH_AES_GMAC)
948 srclen = op->sym->cipher.data.length;
949 dst = rte_pktmbuf_mtod_offset(mbuf_dst, uint8_t *,
950 op->sym->cipher.data.offset);
953 if (sess->cipher.direction == RTE_CRYPTO_CIPHER_OP_ENCRYPT)
954 status = process_openssl_auth_encryption_gcm(
955 mbuf_src, op->sym->cipher.data.offset, srclen,
956 aad, aadlen, iv, ivlen, sess->cipher.key.data,
957 dst, tag, sess->cipher.ctx,
958 sess->cipher.evp_algo);
960 status = process_openssl_auth_decryption_gcm(
961 mbuf_src, op->sym->cipher.data.offset, srclen,
962 aad, aadlen, iv, ivlen, sess->cipher.key.data,
963 dst, tag, sess->cipher.ctx,
964 sess->cipher.evp_algo);
967 if (status == (-EFAULT) &&
968 sess->auth.operation ==
969 RTE_CRYPTO_AUTH_OP_VERIFY)
970 op->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
972 op->status = RTE_CRYPTO_OP_STATUS_ERROR;
976 /** Process cipher operation */
978 process_openssl_cipher_op
979 (struct rte_crypto_op *op, struct openssl_session *sess,
980 struct rte_mbuf *mbuf_src, struct rte_mbuf *mbuf_dst)
986 * Segmented destination buffer is not supported for
987 * encryption/decryption
989 if (!rte_pktmbuf_is_contiguous(mbuf_dst)) {
990 op->status = RTE_CRYPTO_OP_STATUS_ERROR;
994 srclen = op->sym->cipher.data.length;
995 dst = rte_pktmbuf_mtod_offset(mbuf_dst, uint8_t *,
996 op->sym->cipher.data.offset);
998 iv = rte_crypto_op_ctod_offset(op, uint8_t *,
1001 if (sess->cipher.mode == OPENSSL_CIPHER_LIB)
1002 if (sess->cipher.direction == RTE_CRYPTO_CIPHER_OP_ENCRYPT)
1003 status = process_openssl_cipher_encrypt(mbuf_src, dst,
1004 op->sym->cipher.data.offset, iv,
1005 sess->cipher.key.data, srclen,
1007 sess->cipher.evp_algo);
1009 status = process_openssl_cipher_decrypt(mbuf_src, dst,
1010 op->sym->cipher.data.offset, iv,
1011 sess->cipher.key.data, srclen,
1013 sess->cipher.evp_algo);
1015 status = process_openssl_cipher_des3ctr(mbuf_src, dst,
1016 op->sym->cipher.data.offset, iv,
1017 sess->cipher.key.data, srclen,
1021 op->status = RTE_CRYPTO_OP_STATUS_ERROR;
1024 /** Process cipher operation */
1026 process_openssl_docsis_bpi_op(struct rte_crypto_op *op,
1027 struct openssl_session *sess, struct rte_mbuf *mbuf_src,
1028 struct rte_mbuf *mbuf_dst)
1030 uint8_t *src, *dst, *iv;
1031 uint8_t block_size, last_block_len;
1032 int srclen, status = 0;
1034 srclen = op->sym->cipher.data.length;
1035 src = rte_pktmbuf_mtod_offset(mbuf_src, uint8_t *,
1036 op->sym->cipher.data.offset);
1037 dst = rte_pktmbuf_mtod_offset(mbuf_dst, uint8_t *,
1038 op->sym->cipher.data.offset);
1040 iv = rte_crypto_op_ctod_offset(op, uint8_t *,
1043 block_size = DES_BLOCK_SIZE;
1045 last_block_len = srclen % block_size;
1046 if (sess->cipher.direction == RTE_CRYPTO_CIPHER_OP_ENCRYPT) {
1047 /* Encrypt only with ECB mode XOR IV */
1048 if (srclen < block_size) {
1049 status = process_openssl_cipher_bpi_encrypt(src, dst,
1051 sess->cipher.bpi_ctx);
1053 srclen -= last_block_len;
1054 /* Encrypt with the block aligned stream with CBC mode */
1055 status = process_openssl_cipher_encrypt(mbuf_src, dst,
1056 op->sym->cipher.data.offset, iv,
1057 sess->cipher.key.data, srclen,
1058 sess->cipher.ctx, sess->cipher.evp_algo);
1059 if (last_block_len) {
1060 /* Point at last block */
1063 * IV is the last encrypted block from
1064 * the previous operation
1066 iv = dst - block_size;
1068 srclen = last_block_len;
1069 /* Encrypt the last frame with ECB mode */
1070 status |= process_openssl_cipher_bpi_encrypt(src,
1072 srclen, sess->cipher.bpi_ctx);
1076 /* Decrypt only with ECB mode (encrypt, as it is same operation) */
1077 if (srclen < block_size) {
1078 status = process_openssl_cipher_bpi_encrypt(src, dst,
1081 sess->cipher.bpi_ctx);
1083 if (last_block_len) {
1084 /* Point at last block */
1085 dst += srclen - last_block_len;
1086 src += srclen - last_block_len;
1088 * IV is the last full block
1090 iv = src - block_size;
1092 * Decrypt the last frame with ECB mode
1093 * (encrypt, as it is the same operation)
1095 status = process_openssl_cipher_bpi_encrypt(src,
1097 last_block_len, sess->cipher.bpi_ctx);
1098 /* Prepare parameters for CBC mode op */
1099 iv = rte_crypto_op_ctod_offset(op, uint8_t *,
1101 dst += last_block_len - srclen;
1102 srclen -= last_block_len;
1105 /* Decrypt with CBC mode */
1106 status |= process_openssl_cipher_decrypt(mbuf_src, dst,
1107 op->sym->cipher.data.offset, iv,
1108 sess->cipher.key.data, srclen,
1110 sess->cipher.evp_algo);
1115 op->status = RTE_CRYPTO_OP_STATUS_ERROR;
1118 /** Process auth operation */
1120 process_openssl_auth_op
1121 (struct rte_crypto_op *op, struct openssl_session *sess,
1122 struct rte_mbuf *mbuf_src, struct rte_mbuf *mbuf_dst)
1127 srclen = op->sym->auth.data.length;
1129 if (sess->auth.operation == RTE_CRYPTO_AUTH_OP_VERIFY)
1130 dst = (uint8_t *)rte_pktmbuf_append(mbuf_src,
1131 op->sym->auth.digest.length);
1133 dst = op->sym->auth.digest.data;
1135 dst = rte_pktmbuf_mtod_offset(mbuf_dst, uint8_t *,
1136 op->sym->auth.data.offset +
1137 op->sym->auth.data.length);
1140 switch (sess->auth.mode) {
1141 case OPENSSL_AUTH_AS_AUTH:
1142 status = process_openssl_auth(mbuf_src, dst,
1143 op->sym->auth.data.offset, NULL, NULL, srclen,
1144 sess->auth.auth.ctx, sess->auth.auth.evp_algo);
1146 case OPENSSL_AUTH_AS_HMAC:
1147 status = process_openssl_auth_hmac(mbuf_src, dst,
1148 op->sym->auth.data.offset, NULL,
1149 sess->auth.hmac.pkey, srclen,
1150 sess->auth.hmac.ctx, sess->auth.hmac.evp_algo);
1157 if (sess->auth.operation == RTE_CRYPTO_AUTH_OP_VERIFY) {
1158 if (memcmp(dst, op->sym->auth.digest.data,
1159 op->sym->auth.digest.length) != 0) {
1160 op->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
1162 /* Trim area used for digest from mbuf. */
1163 rte_pktmbuf_trim(mbuf_src, op->sym->auth.digest.length);
1167 op->status = RTE_CRYPTO_OP_STATUS_ERROR;
1170 /** Process crypto operation for mbuf */
1172 process_op(const struct openssl_qp *qp, struct rte_crypto_op *op,
1173 struct openssl_session *sess)
1175 struct rte_mbuf *msrc, *mdst;
1178 msrc = op->sym->m_src;
1179 mdst = op->sym->m_dst ? op->sym->m_dst : op->sym->m_src;
1181 op->status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
1183 switch (sess->chain_order) {
1184 case OPENSSL_CHAIN_ONLY_CIPHER:
1185 process_openssl_cipher_op(op, sess, msrc, mdst);
1187 case OPENSSL_CHAIN_ONLY_AUTH:
1188 process_openssl_auth_op(op, sess, msrc, mdst);
1190 case OPENSSL_CHAIN_CIPHER_AUTH:
1191 process_openssl_cipher_op(op, sess, msrc, mdst);
1192 process_openssl_auth_op(op, sess, mdst, mdst);
1194 case OPENSSL_CHAIN_AUTH_CIPHER:
1195 process_openssl_auth_op(op, sess, msrc, mdst);
1196 process_openssl_cipher_op(op, sess, msrc, mdst);
1198 case OPENSSL_CHAIN_COMBINED:
1199 process_openssl_combined_op(op, sess, msrc, mdst);
1201 case OPENSSL_CHAIN_CIPHER_BPI:
1202 process_openssl_docsis_bpi_op(op, sess, msrc, mdst);
1205 op->status = RTE_CRYPTO_OP_STATUS_ERROR;
1209 /* Free session if a session-less crypto op */
1210 if (op->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
1211 openssl_reset_session(sess);
1212 memset(sess, 0, sizeof(struct openssl_session));
1213 rte_mempool_put(qp->sess_mp, op->sym->session);
1214 op->sym->session = NULL;
1217 if (op->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED)
1218 op->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
1220 if (op->status != RTE_CRYPTO_OP_STATUS_ERROR)
1221 retval = rte_ring_enqueue(qp->processed_ops, (void *)op);
1229 *------------------------------------------------------------------------------
1231 *------------------------------------------------------------------------------
1234 /** Enqueue burst */
1236 openssl_pmd_enqueue_burst(void *queue_pair, struct rte_crypto_op **ops,
1239 struct openssl_session *sess;
1240 struct openssl_qp *qp = queue_pair;
1243 for (i = 0; i < nb_ops; i++) {
1244 sess = get_session(qp, ops[i]);
1245 if (unlikely(sess == NULL))
1248 retval = process_op(qp, ops[i], sess);
1249 if (unlikely(retval < 0))
1253 qp->stats.enqueued_count += i;
1257 qp->stats.enqueue_err_count++;
1261 /** Dequeue burst */
1263 openssl_pmd_dequeue_burst(void *queue_pair, struct rte_crypto_op **ops,
1266 struct openssl_qp *qp = queue_pair;
1268 unsigned int nb_dequeued = 0;
1270 nb_dequeued = rte_ring_dequeue_burst(qp->processed_ops,
1271 (void **)ops, nb_ops, NULL);
1272 qp->stats.dequeued_count += nb_dequeued;
1277 /** Create OPENSSL crypto device */
1279 cryptodev_openssl_create(const char *name,
1280 struct rte_vdev_device *vdev,
1281 struct rte_crypto_vdev_init_params *init_params)
1283 struct rte_cryptodev *dev;
1284 struct openssl_private *internals;
1286 if (init_params->name[0] == '\0')
1287 snprintf(init_params->name, sizeof(init_params->name),
1290 dev = rte_cryptodev_vdev_pmd_init(init_params->name,
1291 sizeof(struct openssl_private),
1292 init_params->socket_id,
1295 OPENSSL_LOG_ERR("failed to create cryptodev vdev");
1299 dev->dev_type = RTE_CRYPTODEV_OPENSSL_PMD;
1300 dev->dev_ops = rte_openssl_pmd_ops;
1302 /* register rx/tx burst functions for data path */
1303 dev->dequeue_burst = openssl_pmd_dequeue_burst;
1304 dev->enqueue_burst = openssl_pmd_enqueue_burst;
1306 dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
1307 RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
1308 RTE_CRYPTODEV_FF_CPU_AESNI |
1309 RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER;
1311 /* Set vector instructions mode supported */
1312 internals = dev->data->dev_private;
1314 internals->max_nb_qpairs = init_params->max_nb_queue_pairs;
1315 internals->max_nb_sessions = init_params->max_nb_sessions;
1320 OPENSSL_LOG_ERR("driver %s: cryptodev_openssl_create failed",
1323 cryptodev_openssl_remove(vdev);
1327 /** Initialise OPENSSL crypto device */
1329 cryptodev_openssl_probe(struct rte_vdev_device *vdev)
1331 struct rte_crypto_vdev_init_params init_params = {
1332 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_QUEUE_PAIRS,
1333 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS,
1338 const char *input_args;
1340 name = rte_vdev_device_name(vdev);
1343 input_args = rte_vdev_device_args(vdev);
1345 rte_cryptodev_vdev_parse_init_params(&init_params, input_args);
1347 RTE_LOG(INFO, PMD, "Initialising %s on NUMA node %d\n", name,
1348 init_params.socket_id);
1349 if (init_params.name[0] != '\0')
1350 RTE_LOG(INFO, PMD, " User defined name = %s\n",
1352 RTE_LOG(INFO, PMD, " Max number of queue pairs = %d\n",
1353 init_params.max_nb_queue_pairs);
1354 RTE_LOG(INFO, PMD, " Max number of sessions = %d\n",
1355 init_params.max_nb_sessions);
1357 return cryptodev_openssl_create(name, vdev, &init_params);
1360 /** Uninitialise OPENSSL crypto device */
1362 cryptodev_openssl_remove(struct rte_vdev_device *vdev)
1366 name = rte_vdev_device_name(vdev);
1371 "Closing OPENSSL crypto device %s on numa socket %u\n",
1372 name, rte_socket_id());
1377 static struct rte_vdev_driver cryptodev_openssl_pmd_drv = {
1378 .probe = cryptodev_openssl_probe,
1379 .remove = cryptodev_openssl_remove
1382 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_OPENSSL_PMD,
1383 cryptodev_openssl_pmd_drv);
1384 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_OPENSSL_PMD,
1385 "max_nb_queue_pairs=<int> "
1386 "max_nb_sessions=<int> "