[dpdk-dev v10 1/2] app: move FIPS validation under app/
Kai Ji
kai.ji at intel.com
Thu Nov 5 17:31:50 CET 2026
Rename the sample guide to crypto_validation.rst and make FIPS
validation its first section. Update the app registration and guide
references to match the new location.
Signed-off-by: Kai Ji <kai.ji at intel.com>
---
MAINTAINERS | 6 ++--
{examples => app}/fips_validation/Makefile | 0
.../fips_validation/fips_dev_self_test.c | 0
.../fips_validation/fips_dev_self_test.h | 0
.../fips_validation/fips_validation.c | 0
.../fips_validation/fips_validation.h | 0
.../fips_validation/fips_validation_aes.c | 0
.../fips_validation/fips_validation_ccm.c | 0
.../fips_validation/fips_validation_cmac.c | 0
.../fips_validation/fips_validation_ecdsa.c | 0
.../fips_validation/fips_validation_eddsa.c | 0
.../fips_validation/fips_validation_gcm.c | 0
.../fips_validation/fips_validation_hmac.c | 0
.../fips_validation/fips_validation_rsa.c | 0
.../fips_validation/fips_validation_sha.c | 0
.../fips_validation/fips_validation_tdes.c | 0
.../fips_validation/fips_validation_xts.c | 0
{examples => app}/fips_validation/main.c | 0
{examples => app}/fips_validation/meson.build | 2 +-
app/meson.build | 1 +
doc/guides/rel_notes/release_22_11.rst | 2 +-
...s_validation.rst => crypto_validation.rst} | 36 ++++++++++++-------
doc/guides/sample_app_ug/index.rst | 2 +-
examples/meson.build | 1 -
24 files changed, 30 insertions(+), 20 deletions(-)
rename {examples => app}/fips_validation/Makefile (100%)
rename {examples => app}/fips_validation/fips_dev_self_test.c (100%)
rename {examples => app}/fips_validation/fips_dev_self_test.h (100%)
rename {examples => app}/fips_validation/fips_validation.c (100%)
rename {examples => app}/fips_validation/fips_validation.h (100%)
rename {examples => app}/fips_validation/fips_validation_aes.c (100%)
rename {examples => app}/fips_validation/fips_validation_ccm.c (100%)
rename {examples => app}/fips_validation/fips_validation_cmac.c (100%)
rename {examples => app}/fips_validation/fips_validation_ecdsa.c (100%)
rename {examples => app}/fips_validation/fips_validation_eddsa.c (100%)
rename {examples => app}/fips_validation/fips_validation_gcm.c (100%)
rename {examples => app}/fips_validation/fips_validation_hmac.c (100%)
rename {examples => app}/fips_validation/fips_validation_rsa.c (100%)
rename {examples => app}/fips_validation/fips_validation_sha.c (100%)
rename {examples => app}/fips_validation/fips_validation_tdes.c (100%)
rename {examples => app}/fips_validation/fips_validation_xts.c (100%)
rename {examples => app}/fips_validation/main.c (100%)
rename {examples => app}/fips_validation/meson.build (92%)
rename doc/guides/sample_app_ug/{fips_validation.rst => crypto_validation.rst} (89%)
diff --git a/MAINTAINERS b/MAINTAINERS
index 1d865ffd46..736f39c70e 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -2040,10 +2040,10 @@ Ethtool example
F: examples/ethtool/
F: doc/guides/sample_app_ug/ethtool.rst
-FIPS validation example
+FIPS validation application
M: Gowrishankar Muthukrishnan <gmuthukrishn at marvell.com>
-F: examples/fips_validation/
-F: doc/guides/sample_app_ug/fips_validation.rst
+F: app/fips_validation/
+F: doc/guides/sample_app_ug/crypto_validation.rst
Flow filtering example
M: Ori Kam <orika at nvidia.com>
diff --git a/examples/fips_validation/Makefile b/app/fips_validation/Makefile
similarity index 100%
rename from examples/fips_validation/Makefile
rename to app/fips_validation/Makefile
diff --git a/examples/fips_validation/fips_dev_self_test.c b/app/fips_validation/fips_dev_self_test.c
similarity index 100%
rename from examples/fips_validation/fips_dev_self_test.c
rename to app/fips_validation/fips_dev_self_test.c
diff --git a/examples/fips_validation/fips_dev_self_test.h b/app/fips_validation/fips_dev_self_test.h
similarity index 100%
rename from examples/fips_validation/fips_dev_self_test.h
rename to app/fips_validation/fips_dev_self_test.h
diff --git a/examples/fips_validation/fips_validation.c b/app/fips_validation/fips_validation.c
similarity index 100%
rename from examples/fips_validation/fips_validation.c
rename to app/fips_validation/fips_validation.c
diff --git a/examples/fips_validation/fips_validation.h b/app/fips_validation/fips_validation.h
similarity index 100%
rename from examples/fips_validation/fips_validation.h
rename to app/fips_validation/fips_validation.h
diff --git a/examples/fips_validation/fips_validation_aes.c b/app/fips_validation/fips_validation_aes.c
similarity index 100%
rename from examples/fips_validation/fips_validation_aes.c
rename to app/fips_validation/fips_validation_aes.c
diff --git a/examples/fips_validation/fips_validation_ccm.c b/app/fips_validation/fips_validation_ccm.c
similarity index 100%
rename from examples/fips_validation/fips_validation_ccm.c
rename to app/fips_validation/fips_validation_ccm.c
diff --git a/examples/fips_validation/fips_validation_cmac.c b/app/fips_validation/fips_validation_cmac.c
similarity index 100%
rename from examples/fips_validation/fips_validation_cmac.c
rename to app/fips_validation/fips_validation_cmac.c
diff --git a/examples/fips_validation/fips_validation_ecdsa.c b/app/fips_validation/fips_validation_ecdsa.c
similarity index 100%
rename from examples/fips_validation/fips_validation_ecdsa.c
rename to app/fips_validation/fips_validation_ecdsa.c
diff --git a/examples/fips_validation/fips_validation_eddsa.c b/app/fips_validation/fips_validation_eddsa.c
similarity index 100%
rename from examples/fips_validation/fips_validation_eddsa.c
rename to app/fips_validation/fips_validation_eddsa.c
diff --git a/examples/fips_validation/fips_validation_gcm.c b/app/fips_validation/fips_validation_gcm.c
similarity index 100%
rename from examples/fips_validation/fips_validation_gcm.c
rename to app/fips_validation/fips_validation_gcm.c
diff --git a/examples/fips_validation/fips_validation_hmac.c b/app/fips_validation/fips_validation_hmac.c
similarity index 100%
rename from examples/fips_validation/fips_validation_hmac.c
rename to app/fips_validation/fips_validation_hmac.c
diff --git a/examples/fips_validation/fips_validation_rsa.c b/app/fips_validation/fips_validation_rsa.c
similarity index 100%
rename from examples/fips_validation/fips_validation_rsa.c
rename to app/fips_validation/fips_validation_rsa.c
diff --git a/examples/fips_validation/fips_validation_sha.c b/app/fips_validation/fips_validation_sha.c
similarity index 100%
rename from examples/fips_validation/fips_validation_sha.c
rename to app/fips_validation/fips_validation_sha.c
diff --git a/examples/fips_validation/fips_validation_tdes.c b/app/fips_validation/fips_validation_tdes.c
similarity index 100%
rename from examples/fips_validation/fips_validation_tdes.c
rename to app/fips_validation/fips_validation_tdes.c
diff --git a/examples/fips_validation/fips_validation_xts.c b/app/fips_validation/fips_validation_xts.c
similarity index 100%
rename from examples/fips_validation/fips_validation_xts.c
rename to app/fips_validation/fips_validation_xts.c
diff --git a/examples/fips_validation/main.c b/app/fips_validation/main.c
similarity index 100%
rename from examples/fips_validation/main.c
rename to app/fips_validation/main.c
diff --git a/examples/fips_validation/meson.build b/app/fips_validation/meson.build
similarity index 92%
rename from examples/fips_validation/meson.build
rename to app/fips_validation/meson.build
index 6c29b535cb..3d1a7bc9a6 100644
--- a/examples/fips_validation/meson.build
+++ b/app/fips_validation/meson.build
@@ -1,7 +1,7 @@
# SPDX-License-Identifier: BSD-3-Clause
# Copyright(c) 2018 Intel Corporation
-# meson file, for building this example as part of a main DPDK build.
+# meson file, for building this application as part of a main DPDK build.
#
# To build this example as a standalone application with an already-installed
# DPDK instance, use 'make'
diff --git a/app/meson.build b/app/meson.build
index 24fadc1963..927f79d0b3 100644
--- a/app/meson.build
+++ b/app/meson.build
@@ -14,6 +14,7 @@ endif
apps = [
'dumpcap',
+ 'fips_validation',
'graph',
'pdump',
'proc-info',
diff --git a/doc/guides/rel_notes/release_22_11.rst b/doc/guides/rel_notes/release_22_11.rst
index a8d48344c3..f5d47de741 100644
--- a/doc/guides/rel_notes/release_22_11.rst
+++ b/doc/guides/rel_notes/release_22_11.rst
@@ -273,7 +273,7 @@ New Features
* **Updated FIPS validation sample application.**
Added support for asymmetric crypto algorithms.
- See the :doc:`/sample_app_ug/fips_validation` for more details.
+ See the :doc:`/sample_app_ug/crypto_validation` for more details.
* **Rewrote pmdinfo script.**
diff --git a/doc/guides/sample_app_ug/fips_validation.rst b/doc/guides/sample_app_ug/crypto_validation.rst
similarity index 89%
rename from doc/guides/sample_app_ug/fips_validation.rst
rename to doc/guides/sample_app_ug/crypto_validation.rst
index 613c5afd19..2a773c9892 100644
--- a/doc/guides/sample_app_ug/fips_validation.rst
+++ b/doc/guides/sample_app_ug/crypto_validation.rst
@@ -1,11 +1,14 @@
.. SPDX-License-Identifier: BSD-3-Clause
Copyright(c) 2018 Intel Corporation.
-Federal Information Processing Standards (FIPS) CryptoDev Validation
-====================================================================
+Cryptographic Validation Applications
+=====================================
+
+FIPS Validation
+---------------
Overview
---------
+~~~~~~~~
Federal Information Processing Standards (FIPS) are publicly announced standards
developed by the United States federal government for use in computer systems by
@@ -22,10 +25,10 @@ and FIPS 140-3 (in case of ACVP) and must successfully complete the
cryptographic algorithm validation process.
Limitations
------------
+~~~~~~~~~~~
CAVP
-----
+^^^^
* The version of request file supported is ``CAVS 21.0``.
* If the header comment in a ``.req`` file does not contain a Algo tag
@@ -52,7 +55,7 @@ CAVP
VarText
ACVP
-----
+^^^^
* The application does not supply the test vectors. The user is expected to
obtain the test vector files from `ACVP <https://pages.nist.gov/ACVP>`_
@@ -76,7 +79,7 @@ ACVP
Application Information
------------------------
+~~~~~~~~~~~~~~~~~~~~~~~
If a ``.req`` is used as the input file after the application is finished
running it will generate a response file or ``.rsp``. Differences between the
@@ -93,11 +96,18 @@ validating if the application has done the operation correctly.
Compiling the Application
--------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~
* Compile Application
- To compile the sample application see :doc:`compiling`.
+ From the DPDK source tree, build the application with Meson:
+
+ .. code-block:: console
+
+ meson setup build -Denable_apps=fips_validation
+ meson compile -C build
+
+ The standalone Makefile can also be used from ``app/fips_validation``.
* Run ``dos2unix`` on the request files
@@ -112,13 +122,13 @@ Compiling the Application
dos2unix SHA/req/*
Running the Application
------------------------
+~~~~~~~~~~~~~~~~~~~~~~~
The application requires a number of command line options:
.. code-block:: console
- ./dpdk-fips_validation [EAL options]
+ ./build/app/dpdk-fips_validation [EAL options]
-- --req-file FILE_PATH/FOLDER_PATH
--rsp-file FILE_PATH/FOLDER_PATH
[--cryptodev DEVICE_NAME] [--cryptodev-id ID] [--path-is-folder]
@@ -149,7 +159,7 @@ file for crypto_aesni_mb PMD, issue the command:
.. code-block:: console
- $ ./dpdk-fips_validation --vdev crypto_aesni_mb --
+ $ ./build/app/dpdk-fips_validation --vdev crypto_aesni_mb --
--req-file /PATH/TO/REQUEST/FILE.req --rsp-file ./PATH/TO/RESPONSE/FILE.rsp
--cryptodev crypto_aesni_mb
@@ -158,7 +168,7 @@ data files in one folder for crypto_aesni_gcm PMD, issue the command:
.. code-block:: console
- $ ./dpdk-fips_validation --vdev crypto_aesni_gcm0 --
+ $ ./build/app/dpdk-fips_validation --vdev crypto_aesni_gcm0 --
--req-file /PATH/TO/REQUEST/FILE/FOLDER/
--rsp-file ./PATH/TO/RESPONSE/FILE/FOLDER/
--cryptodev-id 0 --path-is-folder
diff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst
index 28c4c9a5b2..a71d14f83f 100644
--- a/doc/guides/sample_app_ug/index.rst
+++ b/doc/guides/sample_app_ug/index.rst
@@ -50,7 +50,7 @@ Sample Applications User Guides
vm_power_management
ptpclient
ptp_tap_relay_sw
- fips_validation
+ crypto_validation
ipsec_secgw
bbdev_app
ntb
diff --git a/examples/meson.build b/examples/meson.build
index 544ec5eadd..4b739c9b82 100644
--- a/examples/meson.build
+++ b/examples/meson.build
@@ -15,7 +15,6 @@ all_examples = [
'dma',
'ethtool',
'eventdev_pipeline',
- 'fips_validation',
'flow_filtering',
'helloworld',
'ip_fragmentation',
--
2.34.1
More information about the dev
mailing list