1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright(c) 2018 Intel Corporation. 3 4Federal Information Processing Standards (FIPS) CryptoDev Validation 5==================================================================== 6 7Overview 8-------- 9 10Federal Information Processing Standards (FIPS) are publicly announced standards 11developed by the United States federal government for use in computer systems by 12non-military government agencies and government contractors. 13 14This application is used to parse and perform symmetric cryptography 15computation to the NIST Cryptographic Algorithm Validation Program (CAVP) test 16vectors. 17 18For an algorithm implementation to be listed on a cryptographic module 19validation certificate as an Approved security function, the algorithm 20implementation must meet all the requirements of FIPS 140-2 and must 21successfully complete the cryptographic algorithm validation process. 22 23Limitations 24----------- 25 26* Only NIST CAVP request files are parsed by this application. 27* The version of request file supported is ``CAVS 21.0`` 28* If the header comment in a ``.req`` file does not contain a Algo tag 29 i.e ``AES,TDES,GCM`` you need to manually add it into the header comment for 30 example:: 31 32 # VARIABLE KEY - KAT for CBC / # TDES VARIABLE KEY - KAT for CBC 33 34* The application does not supply the test vectors. The user is expected to 35 obtain the test vector files from `NIST 36 <https://csrc.nist.gov/projects/cryptographic-algorithm-validation- 37 program/block-ciphers>`_ website. To obtain the ``.req`` files you need to 38 email a person from the NIST website and pay for the ``.req`` files. 39 The ``.rsp`` files from the site can be used to validate and compare with 40 the ``.rsp`` files created by the FIPS application. 41 42* Supported test vectors 43 44Application Information 45----------------------- 46 47If a ``.req`` is used as the input file after the application is finished 48running it will generate a response file or ``.rsp``. Differences between the 49two files are, the ``.req`` file has missing information for instance if doing 50encryption you will not have the cipher text and that will be generated in the 51response file. Also if doing decryption it will not have the plain text until it 52finished the work and in the response file it will be added onto the end of each 53operation. 54 55The application can be run with a ``.rsp`` file and what the outcome of that 56will be is it will add a extra line in the generated ``.rsp`` which should be 57the same as the ``.rsp`` used to run the application, this is useful for 58validating if the application has done the operation correctly. 59 60 61Compiling the Application 62------------------------- 63 64* Compile Application 65 66 .. code-block:: console 67 68 make -C examples/fips_validation 69 70* Run ``dos2unix`` on the request files 71 72 .. code-block:: console 73 74 dos2unix AES/req/* 75 dos2unix AES_GCM/req/* 76 dos2unix CCM/req/* 77 dos2unix CMAC/req/* 78 dos2unix HMAC/req/* 79 dos2unix TDES/req/* 80 81Running the Application 82----------------------- 83 84The application requires a number of command line options: 85 86 .. code-block:: console 87 88 ./fips_validation [EAL options] 89 -- --req-file FILE_PATH/FOLDER_PATH 90 --rsp-file FILE_PATH/FOLDER_PATH 91 [--cryptodev DEVICE_NAME] [--cryptodev-id ID] [--path-is-folder] 92 93where, 94 * req-file: The path of the request file or folder, separated by 95 ``path-is-folder`` option. 96 97 * rsp-file: The path that the response file or folder is stored. separated by 98 ``path-is-folder`` option. 99 100 * cryptodev: The name of the target DPDK Crypto device to be validated. 101 102 * cryptodev-id: The id of the target DPDK Crypto device to be validated. 103 104 * path-is-folder: If presented the application expects req-file and rsp-file 105 are folder paths. 106 107 108To run the application in linuxapp environment to test one AES FIPS test data 109file for crypto_aesni_mb PMD, issue the command: 110 111.. code-block:: console 112 113 $ ./fips_validation --vdev crypto_aesni_mb -- 114 --req-file /PATH/TO/REQUEST/FILE.req --rsp-file ./PATH/TO/RESPONSE/FILE.rsp 115 --cryptodev crypto_aesni_mb 116 117To run the application in linuxapp environment to test all AES-GCM FIPS test 118data files in one folder for crypto_aesni_gcm PMD, issue the command: 119 120.. code-block:: console 121 122 $ ./fips_validation --vdev crypto_aesni_gcm0 -- 123 --req-file /PATH/TO/REQUEST/FILE/FOLDER/ 124 --rsp-file ./PATH/TO/RESPONSE/FILE/FOLDER/ 125 --cryptodev-id 0 --path-is-folder 126