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 <cryptodev_pmd.h>
11 #include "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 .op = RTE_CRYPTO_OP_TYPE_ASYMMETRIC,
534 .xform_type = RTE_CRYPTO_ASYM_XFORM_DH,
536 ((1<<RTE_CRYPTO_ASYM_OP_PRIVATE_KEY_GENERATE) |
537 (1 << RTE_CRYPTO_ASYM_OP_PUBLIC_KEY_GENERATE |
539 RTE_CRYPTO_ASYM_OP_SHARED_SECRET_COMPUTE))),
542 /* value 0 symbolizes no limit on min length */
544 /* value 0 symbolizes no limit on max length */
553 .op = RTE_CRYPTO_OP_TYPE_ASYMMETRIC,
556 .xform_type = RTE_CRYPTO_ASYM_XFORM_DSA,
558 ((1<<RTE_CRYPTO_ASYM_OP_SIGN) |
559 (1 << RTE_CRYPTO_ASYM_OP_VERIFY)),
562 /* value 0 symbolizes no limit on min length */
564 /* value 0 symbolizes no limit on max length */
573 RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
577 /** Configure device */
579 openssl_pmd_config(__rte_unused struct rte_cryptodev *dev,
580 __rte_unused struct rte_cryptodev_config *config)
587 openssl_pmd_start(__rte_unused struct rte_cryptodev *dev)
594 openssl_pmd_stop(__rte_unused struct rte_cryptodev *dev)
600 openssl_pmd_close(__rte_unused struct rte_cryptodev *dev)
606 /** Get device statistics */
608 openssl_pmd_stats_get(struct rte_cryptodev *dev,
609 struct rte_cryptodev_stats *stats)
613 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
614 struct openssl_qp *qp = dev->data->queue_pairs[qp_id];
616 stats->enqueued_count += qp->stats.enqueued_count;
617 stats->dequeued_count += qp->stats.dequeued_count;
619 stats->enqueue_err_count += qp->stats.enqueue_err_count;
620 stats->dequeue_err_count += qp->stats.dequeue_err_count;
624 /** Reset device statistics */
626 openssl_pmd_stats_reset(struct rte_cryptodev *dev)
630 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
631 struct openssl_qp *qp = dev->data->queue_pairs[qp_id];
633 memset(&qp->stats, 0, sizeof(qp->stats));
638 /** Get device info */
640 openssl_pmd_info_get(struct rte_cryptodev *dev,
641 struct rte_cryptodev_info *dev_info)
643 struct openssl_private *internals = dev->data->dev_private;
645 if (dev_info != NULL) {
646 dev_info->driver_id = dev->driver_id;
647 dev_info->feature_flags = dev->feature_flags;
648 dev_info->capabilities = openssl_pmd_capabilities;
649 dev_info->max_nb_queue_pairs = internals->max_nb_qpairs;
650 /* No limit of number of sessions */
651 dev_info->sym.max_nb_sessions = 0;
655 /** Release queue pair */
657 openssl_pmd_qp_release(struct rte_cryptodev *dev, uint16_t qp_id)
659 if (dev->data->queue_pairs[qp_id] != NULL) {
660 struct openssl_qp *qp = dev->data->queue_pairs[qp_id];
662 rte_ring_free(qp->processed_ops);
664 rte_free(dev->data->queue_pairs[qp_id]);
665 dev->data->queue_pairs[qp_id] = NULL;
670 /** set a unique name for the queue pair based on it's name, dev_id and qp_id */
672 openssl_pmd_qp_set_unique_name(struct rte_cryptodev *dev,
673 struct openssl_qp *qp)
675 unsigned int n = snprintf(qp->name, sizeof(qp->name),
676 "openssl_pmd_%u_qp_%u",
677 dev->data->dev_id, qp->id);
679 if (n >= sizeof(qp->name))
686 /** Create a ring to place processed operations on */
687 static struct rte_ring *
688 openssl_pmd_qp_create_processed_ops_ring(struct openssl_qp *qp,
689 unsigned int ring_size, int socket_id)
693 r = rte_ring_lookup(qp->name);
695 if (rte_ring_get_size(r) >= ring_size) {
697 "Reusing existing ring %s for processed ops",
703 "Unable to reuse existing ring %s for processed ops",
708 return rte_ring_create(qp->name, ring_size, socket_id,
709 RING_F_SP_ENQ | RING_F_SC_DEQ);
713 /** Setup a queue pair */
715 openssl_pmd_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id,
716 const struct rte_cryptodev_qp_conf *qp_conf,
719 struct openssl_qp *qp = NULL;
721 /* Free memory prior to re-allocation if needed. */
722 if (dev->data->queue_pairs[qp_id] != NULL)
723 openssl_pmd_qp_release(dev, qp_id);
725 /* Allocate the queue pair data structure. */
726 qp = rte_zmalloc_socket("OPENSSL PMD Queue Pair", sizeof(*qp),
727 RTE_CACHE_LINE_SIZE, socket_id);
732 dev->data->queue_pairs[qp_id] = qp;
734 if (openssl_pmd_qp_set_unique_name(dev, qp))
735 goto qp_setup_cleanup;
737 qp->processed_ops = openssl_pmd_qp_create_processed_ops_ring(qp,
738 qp_conf->nb_descriptors, socket_id);
739 if (qp->processed_ops == NULL)
740 goto qp_setup_cleanup;
742 qp->sess_mp = qp_conf->mp_session;
743 qp->sess_mp_priv = qp_conf->mp_session_private;
745 memset(&qp->stats, 0, sizeof(qp->stats));
755 /** Returns the size of the symmetric session structure */
757 openssl_pmd_sym_session_get_size(struct rte_cryptodev *dev __rte_unused)
759 return sizeof(struct openssl_session);
762 /** Returns the size of the asymmetric session structure */
764 openssl_pmd_asym_session_get_size(struct rte_cryptodev *dev __rte_unused)
766 return sizeof(struct openssl_asym_session);
769 /** Configure the session from a crypto xform chain */
771 openssl_pmd_sym_session_configure(struct rte_cryptodev *dev __rte_unused,
772 struct rte_crypto_sym_xform *xform,
773 struct rte_cryptodev_sym_session *sess,
774 struct rte_mempool *mempool)
776 void *sess_private_data;
779 if (unlikely(sess == NULL)) {
780 OPENSSL_LOG(ERR, "invalid session struct");
784 if (rte_mempool_get(mempool, &sess_private_data)) {
786 "Couldn't get object from session mempool");
790 ret = openssl_set_session_parameters(sess_private_data, xform);
792 OPENSSL_LOG(ERR, "failed configure session parameters");
794 /* Return session to mempool */
795 rte_mempool_put(mempool, sess_private_data);
799 set_sym_session_private_data(sess, dev->driver_id,
805 static int openssl_set_asym_session_parameters(
806 struct openssl_asym_session *asym_session,
807 struct rte_crypto_asym_xform *xform)
811 if ((xform->xform_type != RTE_CRYPTO_ASYM_XFORM_DH) &&
812 (xform->next != NULL)) {
813 OPENSSL_LOG(ERR, "chained xfrms are not supported on %s",
814 rte_crypto_asym_xform_strings[xform->xform_type]);
818 switch (xform->xform_type) {
819 case RTE_CRYPTO_ASYM_XFORM_RSA:
824 BIGNUM *p = NULL, *q = NULL, *dmp1 = NULL;
825 BIGNUM *iqmp = NULL, *dmq1 = NULL;
827 /* copy xfrm data into rsa struct */
828 n = BN_bin2bn((const unsigned char *)xform->rsa.n.data,
829 xform->rsa.n.length, n);
830 e = BN_bin2bn((const unsigned char *)xform->rsa.e.data,
831 xform->rsa.e.length, e);
836 RSA *rsa = RSA_new();
840 if (xform->rsa.key_type == RTE_RSA_KEY_TYPE_EXP) {
842 (const unsigned char *)xform->rsa.d.data,
850 p = BN_bin2bn((const unsigned char *)
851 xform->rsa.qt.p.data,
852 xform->rsa.qt.p.length,
854 q = BN_bin2bn((const unsigned char *)
855 xform->rsa.qt.q.data,
856 xform->rsa.qt.q.length,
858 dmp1 = BN_bin2bn((const unsigned char *)
859 xform->rsa.qt.dP.data,
860 xform->rsa.qt.dP.length,
862 dmq1 = BN_bin2bn((const unsigned char *)
863 xform->rsa.qt.dQ.data,
864 xform->rsa.qt.dQ.length,
866 iqmp = BN_bin2bn((const unsigned char *)
867 xform->rsa.qt.qInv.data,
868 xform->rsa.qt.qInv.length,
871 if (!p || !q || !dmp1 || !dmq1 || !iqmp) {
875 ret = set_rsa_params(rsa, p, q);
878 "failed to set rsa params\n");
882 ret = set_rsa_crt_params(rsa, dmp1, dmq1, iqmp);
885 "failed to set crt params\n");
888 * set already populated params to NULL
889 * as its freed by call to RSA_free
896 ret = set_rsa_keys(rsa, n, e, d);
898 OPENSSL_LOG(ERR, "Failed to load rsa keys\n");
902 asym_session->u.r.rsa = rsa;
903 asym_session->xfrm_type = RTE_CRYPTO_ASYM_XFORM_RSA;
917 case RTE_CRYPTO_ASYM_XFORM_MODEX:
919 struct rte_crypto_modex_xform *xfrm = &(xform->modex);
921 BN_CTX *ctx = BN_CTX_new();
924 " failed to allocate resources\n");
928 BIGNUM *mod = BN_CTX_get(ctx);
929 BIGNUM *exp = BN_CTX_get(ctx);
930 if (mod == NULL || exp == NULL) {
936 mod = BN_bin2bn((const unsigned char *)
938 xfrm->modulus.length, mod);
939 exp = BN_bin2bn((const unsigned char *)
941 xfrm->exponent.length, exp);
942 asym_session->u.e.ctx = ctx;
943 asym_session->u.e.mod = mod;
944 asym_session->u.e.exp = exp;
945 asym_session->xfrm_type = RTE_CRYPTO_ASYM_XFORM_MODEX;
948 case RTE_CRYPTO_ASYM_XFORM_MODINV:
950 struct rte_crypto_modinv_xform *xfrm = &(xform->modinv);
952 BN_CTX *ctx = BN_CTX_new();
955 " failed to allocate resources\n");
959 BIGNUM *mod = BN_CTX_get(ctx);
966 mod = BN_bin2bn((const unsigned char *)
968 xfrm->modulus.length,
970 asym_session->u.m.ctx = ctx;
971 asym_session->u.m.modulus = mod;
972 asym_session->xfrm_type = RTE_CRYPTO_ASYM_XFORM_MODINV;
975 case RTE_CRYPTO_ASYM_XFORM_DH:
980 p = BN_bin2bn((const unsigned char *)
984 g = BN_bin2bn((const unsigned char *)
994 "failed to allocate resources\n");
997 ret = set_dh_params(dh, p, g);
1005 * public key generate, or
1006 * DH Priv key generate, or both
1007 * public and private key generate
1009 asym_session->u.dh.key_op = (1 << xform->dh.type);
1011 if (xform->dh.type ==
1012 RTE_CRYPTO_ASYM_OP_PRIVATE_KEY_GENERATE) {
1013 /* check if next is pubkey */
1014 if ((xform->next != NULL) &&
1015 (xform->next->xform_type ==
1016 RTE_CRYPTO_ASYM_XFORM_DH) &&
1017 (xform->next->dh.type ==
1018 RTE_CRYPTO_ASYM_OP_PUBLIC_KEY_GENERATE)
1021 * setup op as pub/priv key
1024 asym_session->u.dh.key_op |=
1026 RTE_CRYPTO_ASYM_OP_PUBLIC_KEY_GENERATE);
1029 asym_session->u.dh.dh_key = dh;
1030 asym_session->xfrm_type = RTE_CRYPTO_ASYM_XFORM_DH;
1034 OPENSSL_LOG(ERR, " failed to set dh params\n");
1039 case RTE_CRYPTO_ASYM_XFORM_DSA:
1041 BIGNUM *p = NULL, *g = NULL;
1042 BIGNUM *q = NULL, *priv_key = NULL;
1043 BIGNUM *pub_key = BN_new();
1046 p = BN_bin2bn((const unsigned char *)
1048 xform->dsa.p.length,
1051 g = BN_bin2bn((const unsigned char *)
1053 xform->dsa.g.length,
1056 q = BN_bin2bn((const unsigned char *)
1058 xform->dsa.q.length,
1063 priv_key = BN_bin2bn((const unsigned char *)
1065 xform->dsa.x.length,
1067 if (priv_key == NULL)
1070 DSA *dsa = DSA_new();
1073 " failed to allocate resources\n");
1077 ret = set_dsa_params(dsa, p, q, g);
1080 OPENSSL_LOG(ERR, "Failed to dsa params\n");
1085 * openssl 1.1.0 mandate that public key can't be
1086 * NULL in very first call. so set a dummy pub key.
1087 * to keep consistency, lets follow same approach for
1090 /* just set dummy public for very 1st call */
1091 ret = set_dsa_keys(dsa, pub_key, priv_key);
1094 OPENSSL_LOG(ERR, "Failed to set keys\n");
1097 asym_session->u.s.dsa = dsa;
1098 asym_session->xfrm_type = RTE_CRYPTO_ASYM_XFORM_DSA;
1116 /** Configure the session from a crypto xform chain */
1118 openssl_pmd_asym_session_configure(struct rte_cryptodev *dev __rte_unused,
1119 struct rte_crypto_asym_xform *xform,
1120 struct rte_cryptodev_asym_session *sess,
1121 struct rte_mempool *mempool)
1123 void *asym_sess_private_data;
1126 if (unlikely(sess == NULL)) {
1127 OPENSSL_LOG(ERR, "invalid asymmetric session struct");
1131 if (rte_mempool_get(mempool, &asym_sess_private_data)) {
1133 "Couldn't get object from session mempool");
1137 ret = openssl_set_asym_session_parameters(asym_sess_private_data,
1140 OPENSSL_LOG(ERR, "failed configure session parameters");
1142 /* Return session to mempool */
1143 rte_mempool_put(mempool, asym_sess_private_data);
1147 set_asym_session_private_data(sess, dev->driver_id,
1148 asym_sess_private_data);
1153 /** Clear the memory of session so it doesn't leave key material behind */
1155 openssl_pmd_sym_session_clear(struct rte_cryptodev *dev,
1156 struct rte_cryptodev_sym_session *sess)
1158 uint8_t index = dev->driver_id;
1159 void *sess_priv = get_sym_session_private_data(sess, index);
1161 /* Zero out the whole structure */
1163 openssl_reset_session(sess_priv);
1164 memset(sess_priv, 0, sizeof(struct openssl_session));
1165 struct rte_mempool *sess_mp = rte_mempool_from_obj(sess_priv);
1166 set_sym_session_private_data(sess, index, NULL);
1167 rte_mempool_put(sess_mp, sess_priv);
1171 static void openssl_reset_asym_session(struct openssl_asym_session *sess)
1173 switch (sess->xfrm_type) {
1174 case RTE_CRYPTO_ASYM_XFORM_RSA:
1176 RSA_free(sess->u.r.rsa);
1178 case RTE_CRYPTO_ASYM_XFORM_MODEX:
1179 if (sess->u.e.ctx) {
1180 BN_CTX_end(sess->u.e.ctx);
1181 BN_CTX_free(sess->u.e.ctx);
1184 case RTE_CRYPTO_ASYM_XFORM_MODINV:
1185 if (sess->u.m.ctx) {
1186 BN_CTX_end(sess->u.m.ctx);
1187 BN_CTX_free(sess->u.m.ctx);
1190 case RTE_CRYPTO_ASYM_XFORM_DH:
1191 if (sess->u.dh.dh_key)
1192 DH_free(sess->u.dh.dh_key);
1194 case RTE_CRYPTO_ASYM_XFORM_DSA:
1196 DSA_free(sess->u.s.dsa);
1203 /** Clear the memory of asymmetric session
1204 * so it doesn't leave key material behind
1207 openssl_pmd_asym_session_clear(struct rte_cryptodev *dev,
1208 struct rte_cryptodev_asym_session *sess)
1210 uint8_t index = dev->driver_id;
1211 void *sess_priv = get_asym_session_private_data(sess, index);
1213 /* Zero out the whole structure */
1215 openssl_reset_asym_session(sess_priv);
1216 memset(sess_priv, 0, sizeof(struct openssl_asym_session));
1217 struct rte_mempool *sess_mp = rte_mempool_from_obj(sess_priv);
1218 set_asym_session_private_data(sess, index, NULL);
1219 rte_mempool_put(sess_mp, sess_priv);
1223 struct rte_cryptodev_ops openssl_pmd_ops = {
1224 .dev_configure = openssl_pmd_config,
1225 .dev_start = openssl_pmd_start,
1226 .dev_stop = openssl_pmd_stop,
1227 .dev_close = openssl_pmd_close,
1229 .stats_get = openssl_pmd_stats_get,
1230 .stats_reset = openssl_pmd_stats_reset,
1232 .dev_infos_get = openssl_pmd_info_get,
1234 .queue_pair_setup = openssl_pmd_qp_setup,
1235 .queue_pair_release = openssl_pmd_qp_release,
1237 .sym_session_get_size = openssl_pmd_sym_session_get_size,
1238 .asym_session_get_size = openssl_pmd_asym_session_get_size,
1239 .sym_session_configure = openssl_pmd_sym_session_configure,
1240 .asym_session_configure = openssl_pmd_asym_session_configure,
1241 .sym_session_clear = openssl_pmd_sym_session_clear,
1242 .asym_session_clear = openssl_pmd_asym_session_clear
1245 struct rte_cryptodev_ops *rte_openssl_pmd_ops = &openssl_pmd_ops;