From 7df9d02e68c5e44e008cb6151021c04c428ed735 Mon Sep 17 00:00:00 2001 From: Fiona Trahe Date: Wed, 3 Apr 2019 11:38:20 +0100 Subject: [PATCH] doc: fix missing asymmetric crypto table Fixes: 11e5ba72cf67 ("doc: add crypto asymmetric feature list") Cc: stable@dpdk.org Signed-off-by: Fiona Trahe Acked-by: Akhil Goyal --- .gitignore | 1 + doc/guides/conf.py | 5 +++++ doc/guides/cryptodevs/features/aesni_gcm.ini | 5 +++++ doc/guides/cryptodevs/features/aesni_mb.ini | 5 +++++ doc/guides/cryptodevs/features/armv8.ini | 5 +++++ doc/guides/cryptodevs/features/caam_jr.ini | 5 +++++ doc/guides/cryptodevs/features/ccp.ini | 5 +++++ doc/guides/cryptodevs/features/default.ini | 9 +++++++++ doc/guides/cryptodevs/features/dpaa2_sec.ini | 5 +++++ doc/guides/cryptodevs/features/dpaa_sec.ini | 5 +++++ doc/guides/cryptodevs/features/kasumi.ini | 5 +++++ doc/guides/cryptodevs/features/mvsam.ini | 5 +++++ doc/guides/cryptodevs/features/null.ini | 5 +++++ doc/guides/cryptodevs/features/octeontx.ini | 5 +++++ doc/guides/cryptodevs/features/qat.ini | 5 +++++ doc/guides/cryptodevs/features/snow3g.ini | 5 +++++ doc/guides/cryptodevs/features/virtio.ini | 5 +++++ doc/guides/cryptodevs/features/zuc.ini | 5 +++++ doc/guides/cryptodevs/openssl.rst | 8 ++++++++ doc/guides/cryptodevs/overview.rst | 7 +++++++ 20 files changed, 105 insertions(+) diff --git a/.gitignore b/.gitignore index b830c33f7a..5eda2c31ec 100644 --- a/.gitignore +++ b/.gitignore @@ -7,6 +7,7 @@ doc/guides/cryptodevs/overview_feature_table.txt doc/guides/cryptodevs/overview_cipher_table.txt doc/guides/cryptodevs/overview_auth_table.txt doc/guides/cryptodevs/overview_aead_table.txt +doc/guides/cryptodevs/overview_asym_table.txt doc/guides/compressdevs/overview_feature_table.txt # ignore generated ctags/cscope files diff --git a/doc/guides/conf.py b/doc/guides/conf.py index da99a3f848..a85f6c9d99 100644 --- a/doc/guides/conf.py +++ b/doc/guides/conf.py @@ -391,6 +391,11 @@ def setup(app): 'AEAD', 'AEAD algorithms in crypto drivers', 'AEAD algorithm') + table_file = dirname(__file__) + '/cryptodevs/overview_asym_table.txt' + generate_overview_table(table_file, 5, + 'Asymmetric', + 'Asymmetric algorithms in crypto drivers', + 'Asymmetric algorithm') table_file = dirname(__file__) + '/compressdevs/overview_feature_table.txt' generate_overview_table(table_file, 1, 'Features', diff --git a/doc/guides/cryptodevs/features/aesni_gcm.ini b/doc/guides/cryptodevs/features/aesni_gcm.ini index e32e83c203..86303c5198 100644 --- a/doc/guides/cryptodevs/features/aesni_gcm.ini +++ b/doc/guides/cryptodevs/features/aesni_gcm.ini @@ -31,3 +31,8 @@ AES GMAC = Y AES GCM (128) = Y AES GCM (192) = Y AES GCM (256) = Y + +; +; Supported Asymmetric algorithms of the 'aesni_gcm' crypto driver. +; +[Asymmetric] \ No newline at end of file diff --git a/doc/guides/cryptodevs/features/aesni_mb.ini b/doc/guides/cryptodevs/features/aesni_mb.ini index aa4df033dc..ee6a07460a 100644 --- a/doc/guides/cryptodevs/features/aesni_mb.ini +++ b/doc/guides/cryptodevs/features/aesni_mb.ini @@ -55,3 +55,8 @@ AES CCM (128) = Y AES GCM (128) = Y AES GCM (192) = Y AES GCM (256) = Y + +; +; Supported Asymmetric algorithms of the 'aesni_mb' crypto driver. +; +[Asymmetric] diff --git a/doc/guides/cryptodevs/features/armv8.ini b/doc/guides/cryptodevs/features/armv8.ini index 1e10477140..e588f90217 100644 --- a/doc/guides/cryptodevs/features/armv8.ini +++ b/doc/guides/cryptodevs/features/armv8.ini @@ -26,3 +26,8 @@ SHA256 HMAC = Y ; Supported AEAD algorithms of the 'armv8' crypto driver. ; [AEAD] + +; +; Supported Asymmetric algorithms of the 'armv8' crypto driver. +; +[Asymmetric] diff --git a/doc/guides/cryptodevs/features/caam_jr.ini b/doc/guides/cryptodevs/features/caam_jr.ini index 68f8d81956..c64bd35dae 100644 --- a/doc/guides/cryptodevs/features/caam_jr.ini +++ b/doc/guides/cryptodevs/features/caam_jr.ini @@ -44,3 +44,8 @@ SHA512 HMAC = Y AES GCM (128) = Y AES GCM (192) = Y AES GCM (256) = Y + +; +; Supported Asymmetric algorithms of the 'dpaa2_sec' crypto driver. +; +[Asymmetric] \ No newline at end of file diff --git a/doc/guides/cryptodevs/features/ccp.ini b/doc/guides/cryptodevs/features/ccp.ini index 4722e135dc..2970076b8f 100644 --- a/doc/guides/cryptodevs/features/ccp.ini +++ b/doc/guides/cryptodevs/features/ccp.ini @@ -57,3 +57,8 @@ SHA3_512 HMAC = Y AES GCM (128) = Y AES GCM (192) = Y AES GCM (256) = Y + +; +; Supported Asymmetric algorithms of the 'ccp' crypto driver. +; +[Asymmetric] \ No newline at end of file diff --git a/doc/guides/cryptodevs/features/default.ini b/doc/guides/cryptodevs/features/default.ini index 5f3ed30490..0e06261a5d 100644 --- a/doc/guides/cryptodevs/features/default.ini +++ b/doc/guides/cryptodevs/features/default.ini @@ -97,3 +97,12 @@ AES GCM (256) = AES CCM (128) = AES CCM (192) = AES CCM (256) = +; +; Supported Asymmetric algorithms of a default crypto driver. +; +[Asymmetric] +RSA = +DSA = +Modular Exponentiation = +Modular Inversion = +Diffie-hellman = \ No newline at end of file diff --git a/doc/guides/cryptodevs/features/dpaa2_sec.ini b/doc/guides/cryptodevs/features/dpaa2_sec.ini index 69700df40a..9f4e4029c4 100644 --- a/doc/guides/cryptodevs/features/dpaa2_sec.ini +++ b/doc/guides/cryptodevs/features/dpaa2_sec.ini @@ -44,3 +44,8 @@ SHA512 HMAC = Y AES GCM (128) = Y AES GCM (192) = Y AES GCM (256) = Y + +; +; Supported Asymmetric algorithms of the 'dpaa2_sec' crypto driver. +; +[Asymmetric] \ No newline at end of file diff --git a/doc/guides/cryptodevs/features/dpaa_sec.ini b/doc/guides/cryptodevs/features/dpaa_sec.ini index 937b621c09..954a708088 100644 --- a/doc/guides/cryptodevs/features/dpaa_sec.ini +++ b/doc/guides/cryptodevs/features/dpaa_sec.ini @@ -44,3 +44,8 @@ SHA512 HMAC = Y AES GCM (128) = Y AES GCM (192) = Y AES GCM (256) = Y + +; +; Supported Asymmetric algorithms of the 'dpaa_sec' crypto driver. +; +[Asymmetric] \ No newline at end of file diff --git a/doc/guides/cryptodevs/features/kasumi.ini b/doc/guides/cryptodevs/features/kasumi.ini index 0e138f5a64..f3d061009b 100644 --- a/doc/guides/cryptodevs/features/kasumi.ini +++ b/doc/guides/cryptodevs/features/kasumi.ini @@ -22,3 +22,8 @@ KASUMI F9 = Y ; Supported AEAD algorithms of the 'kasumi' crypto driver. ; [AEAD] + +; +; Supported Asymmetric algorithms of the 'kasumi' crypto driver. +; +[Asymmetric] \ No newline at end of file diff --git a/doc/guides/cryptodevs/features/mvsam.ini b/doc/guides/cryptodevs/features/mvsam.ini index 0cc90a53df..829deff681 100644 --- a/doc/guides/cryptodevs/features/mvsam.ini +++ b/doc/guides/cryptodevs/features/mvsam.ini @@ -52,3 +52,8 @@ AES GMAC = Y AES GCM (128) = Y AES GCM (192) = Y AES GCM (256) = Y + +; +; Supported Asymmetric algorithms of the 'mvsam' crypto driver. +; +[Asymmetric] \ No newline at end of file diff --git a/doc/guides/cryptodevs/features/null.ini b/doc/guides/cryptodevs/features/null.ini index ecf5779ac8..a1c3e22a36 100644 --- a/doc/guides/cryptodevs/features/null.ini +++ b/doc/guides/cryptodevs/features/null.ini @@ -24,3 +24,8 @@ NULL = Y ; Supported AEAD algorithms of the 'null' crypto driver. ; [AEAD] + +; +; Supported Asymmetric algorithms of the 'null' crypto driver. +; +[Asymmetric] \ No newline at end of file diff --git a/doc/guides/cryptodevs/features/octeontx.ini b/doc/guides/cryptodevs/features/octeontx.ini index 307ab88cc3..1735b8f5ad 100644 --- a/doc/guides/cryptodevs/features/octeontx.ini +++ b/doc/guides/cryptodevs/features/octeontx.ini @@ -60,3 +60,8 @@ ZUC EIA3 = Y AES GCM (128) = Y AES GCM (192) = Y AES GCM (256) = Y + +; +; Supported Asymmetric algorithms of the 'octeontx' crypto driver. +; +[Asymmetric] \ No newline at end of file diff --git a/doc/guides/cryptodevs/features/qat.ini b/doc/guides/cryptodevs/features/qat.ini index a7c7273444..81325801e5 100644 --- a/doc/guides/cryptodevs/features/qat.ini +++ b/doc/guides/cryptodevs/features/qat.ini @@ -62,3 +62,8 @@ AES GCM (256) = Y AES CCM (128) = Y AES CCM (192) = Y AES CCM (256) = Y + +; +; Supported Asymmetric algorithms of the 'qat' crypto driver. +; +[Asymmetric] diff --git a/doc/guides/cryptodevs/features/snow3g.ini b/doc/guides/cryptodevs/features/snow3g.ini index 277136177c..ec2daf6c64 100644 --- a/doc/guides/cryptodevs/features/snow3g.ini +++ b/doc/guides/cryptodevs/features/snow3g.ini @@ -22,3 +22,8 @@ SNOW3G UIA2 = Y ; Supported AEAD algorithms of the 'snow3g' crypto driver. ; [AEAD] + +; +; Supported Asymmetric algorithms of the 'snow3g' crypto driver. +; +[Asymmetric] \ No newline at end of file diff --git a/doc/guides/cryptodevs/features/virtio.ini b/doc/guides/cryptodevs/features/virtio.ini index 168fc174c1..b59f1669bb 100644 --- a/doc/guides/cryptodevs/features/virtio.ini +++ b/doc/guides/cryptodevs/features/virtio.ini @@ -24,3 +24,8 @@ SHA1 HMAC = Y ; Supported AEAD algorithms of the 'virtio' crypto driver. ; [AEAD] + +; +; Supported Asymmetric algorithms of the 'virtio' crypto driver. +; +[Asymmetric] diff --git a/doc/guides/cryptodevs/features/zuc.ini b/doc/guides/cryptodevs/features/zuc.ini index 5bb02afd4e..9b6a4287e8 100644 --- a/doc/guides/cryptodevs/features/zuc.ini +++ b/doc/guides/cryptodevs/features/zuc.ini @@ -22,3 +22,8 @@ ZUC EIA3 = Y ; Supported AEAD algorithms of the 'zuc' crypto driver. ; [AEAD] + +; +; Supported Asymmetric algorithms of the 'zuc' crypto driver. +; +[Asymmetric] diff --git a/doc/guides/cryptodevs/openssl.rst b/doc/guides/cryptodevs/openssl.rst index 89aa5bac4d..d7269870b6 100644 --- a/doc/guides/cryptodevs/openssl.rst +++ b/doc/guides/cryptodevs/openssl.rst @@ -46,6 +46,14 @@ Supported AEAD algorithms: * ``RTE_CRYPTO_AEAD_AES_GCM`` * ``RTE_CRYPTO_AEAD_AES_CCM`` +Supported Asymmetric Crypto algorithms: + +* ``RTE_CRYPTO_ASYM_XFORM_RSA`` +* ``RTE_CRYPTO_ASYM_XFORM_DSA`` +* ``RTE_CRYPTO_ASYM_XFORM_DH`` +* ``RTE_CRYPTO_ASYM_XFORM_MODINV`` +* ``RTE_CRYPTO_ASYM_XFORM_MODEX`` + Installation ------------ diff --git a/doc/guides/cryptodevs/overview.rst b/doc/guides/cryptodevs/overview.rst index d7b7141a95..12f342b0f2 100644 --- a/doc/guides/cryptodevs/overview.rst +++ b/doc/guides/cryptodevs/overview.rst @@ -64,3 +64,10 @@ Supported AEAD Algorithms .. _table_crypto_pmd_aead_algos: .. include:: overview_aead_table.txt + +Supported Asymmetric Algorithms +------------------------------- + +.. _table_crypto_pmd_asym_algos: + +.. include:: overview_asym_table.txt -- 2.20.1