1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016-2017 Intel Corporation
7 #include <rte_common.h>
8 #include <rte_malloc.h>
9 #include <rte_cryptodev_pmd.h>
11 #include "rte_openssl_pmd_private.h"
15 static const struct rte_cryptodev_capabilities openssl_pmd_capabilities[] = {
17 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
19 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
21 .algo = RTE_CRYPTO_AUTH_MD5_HMAC,
38 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
40 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
42 .algo = RTE_CRYPTO_AUTH_MD5,
59 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
61 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
63 .algo = RTE_CRYPTO_AUTH_SHA1_HMAC,
80 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
82 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
84 .algo = RTE_CRYPTO_AUTH_SHA1,
101 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
103 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
105 .algo = RTE_CRYPTO_AUTH_SHA224_HMAC,
122 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
124 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
126 .algo = RTE_CRYPTO_AUTH_SHA224,
143 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
145 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
147 .algo = RTE_CRYPTO_AUTH_SHA256_HMAC,
164 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
166 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
168 .algo = RTE_CRYPTO_AUTH_SHA256,
185 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
187 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
189 .algo = RTE_CRYPTO_AUTH_SHA384_HMAC,
206 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
208 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
210 .algo = RTE_CRYPTO_AUTH_SHA384,
227 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
229 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
231 .algo = RTE_CRYPTO_AUTH_SHA512_HMAC,
248 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
250 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
252 .algo = RTE_CRYPTO_AUTH_SHA512,
269 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
271 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
273 .algo = RTE_CRYPTO_CIPHER_AES_CBC,
289 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
291 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
293 .algo = RTE_CRYPTO_CIPHER_AES_CTR,
309 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
311 .xform_type = RTE_CRYPTO_SYM_XFORM_AEAD,
313 .algo = RTE_CRYPTO_AEAD_AES_GCM,
339 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
341 .xform_type = RTE_CRYPTO_SYM_XFORM_AEAD,
343 .algo = RTE_CRYPTO_AEAD_AES_CCM,
368 { /* AES GMAC (AUTH) */
369 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
371 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
373 .algo = RTE_CRYPTO_AUTH_AES_GMAC,
394 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
396 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
398 .algo = RTE_CRYPTO_CIPHER_3DES_CBC,
414 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
416 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
418 .algo = RTE_CRYPTO_CIPHER_3DES_CTR,
434 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
436 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
438 .algo = RTE_CRYPTO_CIPHER_DES_CBC,
453 { /* DES DOCSIS BPI */
454 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
456 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
458 .algo = RTE_CRYPTO_CIPHER_DES_DOCSISBPI,
474 .op = RTE_CRYPTO_OP_TYPE_ASYMMETRIC,
477 .xform_type = RTE_CRYPTO_ASYM_XFORM_RSA,
478 .op_types = ((1 << RTE_CRYPTO_ASYM_OP_SIGN) |
479 (1 << RTE_CRYPTO_ASYM_OP_VERIFY) |
480 (1 << RTE_CRYPTO_ASYM_OP_ENCRYPT) |
481 (1 << RTE_CRYPTO_ASYM_OP_DECRYPT)),
484 /* min length is based on openssl rsa keygen */
486 /* value 0 symbolizes no limit on max length */
495 .op = RTE_CRYPTO_OP_TYPE_ASYMMETRIC,
498 .xform_type = RTE_CRYPTO_ASYM_XFORM_MODEX,
502 /* value 0 symbolizes no limit on min length */
504 /* value 0 symbolizes no limit on max length */
513 .op = RTE_CRYPTO_OP_TYPE_ASYMMETRIC,
516 .xform_type = RTE_CRYPTO_ASYM_XFORM_MODINV,
520 /* value 0 symbolizes no limit on min length */
522 /* value 0 symbolizes no limit on max length */
531 RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
535 /** Configure device */
537 openssl_pmd_config(__rte_unused struct rte_cryptodev *dev,
538 __rte_unused struct rte_cryptodev_config *config)
545 openssl_pmd_start(__rte_unused struct rte_cryptodev *dev)
552 openssl_pmd_stop(__rte_unused struct rte_cryptodev *dev)
558 openssl_pmd_close(__rte_unused struct rte_cryptodev *dev)
564 /** Get device statistics */
566 openssl_pmd_stats_get(struct rte_cryptodev *dev,
567 struct rte_cryptodev_stats *stats)
571 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
572 struct openssl_qp *qp = dev->data->queue_pairs[qp_id];
574 stats->enqueued_count += qp->stats.enqueued_count;
575 stats->dequeued_count += qp->stats.dequeued_count;
577 stats->enqueue_err_count += qp->stats.enqueue_err_count;
578 stats->dequeue_err_count += qp->stats.dequeue_err_count;
582 /** Reset device statistics */
584 openssl_pmd_stats_reset(struct rte_cryptodev *dev)
588 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
589 struct openssl_qp *qp = dev->data->queue_pairs[qp_id];
591 memset(&qp->stats, 0, sizeof(qp->stats));
596 /** Get device info */
598 openssl_pmd_info_get(struct rte_cryptodev *dev,
599 struct rte_cryptodev_info *dev_info)
601 struct openssl_private *internals = dev->data->dev_private;
603 if (dev_info != NULL) {
604 dev_info->driver_id = dev->driver_id;
605 dev_info->feature_flags = dev->feature_flags;
606 dev_info->capabilities = openssl_pmd_capabilities;
607 dev_info->max_nb_queue_pairs = internals->max_nb_qpairs;
608 /* No limit of number of sessions */
609 dev_info->sym.max_nb_sessions = 0;
613 /** Release queue pair */
615 openssl_pmd_qp_release(struct rte_cryptodev *dev, uint16_t qp_id)
617 if (dev->data->queue_pairs[qp_id] != NULL) {
618 rte_free(dev->data->queue_pairs[qp_id]);
619 dev->data->queue_pairs[qp_id] = NULL;
624 /** set a unique name for the queue pair based on it's name, dev_id and qp_id */
626 openssl_pmd_qp_set_unique_name(struct rte_cryptodev *dev,
627 struct openssl_qp *qp)
629 unsigned int n = snprintf(qp->name, sizeof(qp->name),
630 "openssl_pmd_%u_qp_%u",
631 dev->data->dev_id, qp->id);
633 if (n >= sizeof(qp->name))
640 /** Create a ring to place processed operations on */
641 static struct rte_ring *
642 openssl_pmd_qp_create_processed_ops_ring(struct openssl_qp *qp,
643 unsigned int ring_size, int socket_id)
647 r = rte_ring_lookup(qp->name);
649 if (rte_ring_get_size(r) >= ring_size) {
651 "Reusing existing ring %s for processed ops",
657 "Unable to reuse existing ring %s for processed ops",
662 return rte_ring_create(qp->name, ring_size, socket_id,
663 RING_F_SP_ENQ | RING_F_SC_DEQ);
667 /** Setup a queue pair */
669 openssl_pmd_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id,
670 const struct rte_cryptodev_qp_conf *qp_conf,
671 int socket_id, struct rte_mempool *session_pool)
673 struct openssl_qp *qp = NULL;
675 /* Free memory prior to re-allocation if needed. */
676 if (dev->data->queue_pairs[qp_id] != NULL)
677 openssl_pmd_qp_release(dev, qp_id);
679 /* Allocate the queue pair data structure. */
680 qp = rte_zmalloc_socket("OPENSSL PMD Queue Pair", sizeof(*qp),
681 RTE_CACHE_LINE_SIZE, socket_id);
686 dev->data->queue_pairs[qp_id] = qp;
688 if (openssl_pmd_qp_set_unique_name(dev, qp))
689 goto qp_setup_cleanup;
691 qp->processed_ops = openssl_pmd_qp_create_processed_ops_ring(qp,
692 qp_conf->nb_descriptors, socket_id);
693 if (qp->processed_ops == NULL)
694 goto qp_setup_cleanup;
696 qp->sess_mp = session_pool;
698 memset(&qp->stats, 0, sizeof(qp->stats));
709 /** Return the number of allocated queue pairs */
711 openssl_pmd_qp_count(struct rte_cryptodev *dev)
713 return dev->data->nb_queue_pairs;
716 /** Returns the size of the symmetric session structure */
718 openssl_pmd_sym_session_get_size(struct rte_cryptodev *dev __rte_unused)
720 return sizeof(struct openssl_session);
723 /** Returns the size of the asymmetric session structure */
725 openssl_pmd_asym_session_get_size(struct rte_cryptodev *dev __rte_unused)
727 return sizeof(struct openssl_asym_session);
730 /** Configure the session from a crypto xform chain */
732 openssl_pmd_sym_session_configure(struct rte_cryptodev *dev __rte_unused,
733 struct rte_crypto_sym_xform *xform,
734 struct rte_cryptodev_sym_session *sess,
735 struct rte_mempool *mempool)
737 void *sess_private_data;
740 if (unlikely(sess == NULL)) {
741 OPENSSL_LOG(ERR, "invalid session struct");
745 if (rte_mempool_get(mempool, &sess_private_data)) {
747 "Couldn't get object from session mempool");
751 ret = openssl_set_session_parameters(sess_private_data, xform);
753 OPENSSL_LOG(ERR, "failed configure session parameters");
755 /* Return session to mempool */
756 rte_mempool_put(mempool, sess_private_data);
760 set_sym_session_private_data(sess, dev->driver_id,
766 static int openssl_set_asym_session_parameters(
767 struct openssl_asym_session *asym_session,
768 struct rte_crypto_asym_xform *xform)
772 if (xform->next != NULL) {
773 OPENSSL_LOG(ERR, "chained xfrms are not supported on %s",
774 rte_crypto_asym_xform_strings[xform->xform_type]);
778 switch (xform->xform_type) {
779 case RTE_CRYPTO_ASYM_XFORM_RSA:
784 BIGNUM *p = NULL, *q = NULL, *dmp1 = NULL;
785 BIGNUM *iqmp = NULL, *dmq1 = NULL;
787 /* copy xfrm data into rsa struct */
788 n = BN_bin2bn((const unsigned char *)xform->rsa.n.data,
789 xform->rsa.n.length, n);
790 e = BN_bin2bn((const unsigned char *)xform->rsa.e.data,
791 xform->rsa.e.length, e);
796 RSA *rsa = RSA_new();
800 if (xform->rsa.key_type == RTE_RSA_KEY_TYPE_EXP) {
802 (const unsigned char *)xform->rsa.d.data,
810 p = BN_bin2bn((const unsigned char *)
811 xform->rsa.qt.p.data,
812 xform->rsa.qt.p.length,
814 q = BN_bin2bn((const unsigned char *)
815 xform->rsa.qt.q.data,
816 xform->rsa.qt.q.length,
818 dmp1 = BN_bin2bn((const unsigned char *)
819 xform->rsa.qt.dP.data,
820 xform->rsa.qt.dP.length,
822 dmq1 = BN_bin2bn((const unsigned char *)
823 xform->rsa.qt.dQ.data,
824 xform->rsa.qt.dQ.length,
826 iqmp = BN_bin2bn((const unsigned char *)
827 xform->rsa.qt.qInv.data,
828 xform->rsa.qt.qInv.length,
831 if (!p || !q || !dmp1 || !dmq1 || !iqmp) {
835 set_rsa_params(rsa, p, q, ret);
838 "failed to set rsa params\n");
842 set_rsa_crt_params(rsa, dmp1, dmq1, iqmp, ret);
845 "failed to set crt params\n");
848 * set already populated params to NULL
849 * as its freed by call to RSA_free
856 set_rsa_keys(rsa, n, e, d, ret);
858 OPENSSL_LOG(ERR, "Failed to load rsa keys\n");
862 asym_session->u.r.rsa = rsa;
863 asym_session->xfrm_type = RTE_CRYPTO_ASYM_XFORM_RSA;
885 case RTE_CRYPTO_ASYM_XFORM_MODEX:
887 struct rte_crypto_modex_xform *xfrm = &(xform->modex);
889 BN_CTX *ctx = BN_CTX_new();
892 " failed to allocate resources\n");
896 BIGNUM *mod = BN_CTX_get(ctx);
897 BIGNUM *exp = BN_CTX_get(ctx);
898 if (mod == NULL || exp == NULL) {
904 mod = BN_bin2bn((const unsigned char *)
906 xfrm->modulus.length, mod);
907 exp = BN_bin2bn((const unsigned char *)
909 xfrm->exponent.length, exp);
910 asym_session->u.e.ctx = ctx;
911 asym_session->u.e.mod = mod;
912 asym_session->u.e.exp = exp;
913 asym_session->xfrm_type = RTE_CRYPTO_ASYM_XFORM_MODEX;
916 case RTE_CRYPTO_ASYM_XFORM_MODINV:
918 struct rte_crypto_modinv_xform *xfrm = &(xform->modinv);
920 BN_CTX *ctx = BN_CTX_new();
923 " failed to allocate resources\n");
927 BIGNUM *mod = BN_CTX_get(ctx);
934 mod = BN_bin2bn((const unsigned char *)
936 xfrm->modulus.length,
938 asym_session->u.m.ctx = ctx;
939 asym_session->u.m.modulus = mod;
940 asym_session->xfrm_type = RTE_CRYPTO_ASYM_XFORM_MODINV;
950 /** Configure the session from a crypto xform chain */
952 openssl_pmd_asym_session_configure(struct rte_cryptodev *dev __rte_unused,
953 struct rte_crypto_asym_xform *xform,
954 struct rte_cryptodev_asym_session *sess,
955 struct rte_mempool *mempool)
957 void *asym_sess_private_data;
960 if (unlikely(sess == NULL)) {
961 OPENSSL_LOG(ERR, "invalid asymmetric session struct");
965 if (rte_mempool_get(mempool, &asym_sess_private_data)) {
967 "Couldn't get object from session mempool");
971 ret = openssl_set_asym_session_parameters(asym_sess_private_data,
974 OPENSSL_LOG(ERR, "failed configure session parameters");
976 /* Return session to mempool */
977 rte_mempool_put(mempool, asym_sess_private_data);
981 set_asym_session_private_data(sess, dev->driver_id,
982 asym_sess_private_data);
987 /** Clear the memory of session so it doesn't leave key material behind */
989 openssl_pmd_sym_session_clear(struct rte_cryptodev *dev,
990 struct rte_cryptodev_sym_session *sess)
992 uint8_t index = dev->driver_id;
993 void *sess_priv = get_sym_session_private_data(sess, index);
995 /* Zero out the whole structure */
997 openssl_reset_session(sess_priv);
998 memset(sess_priv, 0, sizeof(struct openssl_session));
999 struct rte_mempool *sess_mp = rte_mempool_from_obj(sess_priv);
1000 set_sym_session_private_data(sess, index, NULL);
1001 rte_mempool_put(sess_mp, sess_priv);
1005 static void openssl_reset_asym_session(struct openssl_asym_session *sess)
1007 switch (sess->xfrm_type) {
1008 case RTE_CRYPTO_ASYM_XFORM_RSA:
1010 RSA_free(sess->u.r.rsa);
1012 case RTE_CRYPTO_ASYM_XFORM_MODEX:
1013 if (sess->u.e.ctx) {
1014 BN_CTX_end(sess->u.e.ctx);
1015 BN_CTX_free(sess->u.e.ctx);
1018 case RTE_CRYPTO_ASYM_XFORM_MODINV:
1019 if (sess->u.m.ctx) {
1020 BN_CTX_end(sess->u.m.ctx);
1021 BN_CTX_free(sess->u.m.ctx);
1029 /** Clear the memory of asymmetric session
1030 * so it doesn't leave key material behind
1033 openssl_pmd_asym_session_clear(struct rte_cryptodev *dev,
1034 struct rte_cryptodev_asym_session *sess)
1036 uint8_t index = dev->driver_id;
1037 void *sess_priv = get_asym_session_private_data(sess, index);
1039 /* Zero out the whole structure */
1041 openssl_reset_asym_session(sess_priv);
1042 memset(sess_priv, 0, sizeof(struct openssl_asym_session));
1043 struct rte_mempool *sess_mp = rte_mempool_from_obj(sess_priv);
1044 set_asym_session_private_data(sess, index, NULL);
1045 rte_mempool_put(sess_mp, sess_priv);
1049 struct rte_cryptodev_ops openssl_pmd_ops = {
1050 .dev_configure = openssl_pmd_config,
1051 .dev_start = openssl_pmd_start,
1052 .dev_stop = openssl_pmd_stop,
1053 .dev_close = openssl_pmd_close,
1055 .stats_get = openssl_pmd_stats_get,
1056 .stats_reset = openssl_pmd_stats_reset,
1058 .dev_infos_get = openssl_pmd_info_get,
1060 .queue_pair_setup = openssl_pmd_qp_setup,
1061 .queue_pair_release = openssl_pmd_qp_release,
1062 .queue_pair_count = openssl_pmd_qp_count,
1064 .sym_session_get_size = openssl_pmd_sym_session_get_size,
1065 .asym_session_get_size = openssl_pmd_asym_session_get_size,
1066 .sym_session_configure = openssl_pmd_sym_session_configure,
1067 .asym_session_configure = openssl_pmd_asym_session_configure,
1068 .sym_session_clear = openssl_pmd_sym_session_clear,
1069 .asym_session_clear = openssl_pmd_asym_session_clear
1072 struct rte_cryptodev_ops *rte_openssl_pmd_ops = &openssl_pmd_ops;