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 * AES-CBC (128,192,256) - GFSbox, KeySbox, MCT, MMT 44 45Application Information 46----------------------- 47 48If a ``.req`` is used as the input file after the application is finished 49running it will generate a response file or ``.rsp``. Differences between the 50two files are, the ``.req`` file has missing information for instance if doing 51encryption you will not have the cipher text and that will be generated in the 52response file. Also if doing decryption it will not have the plain text until it 53finished the work and in the response file it will be added onto the end of each 54operation. 55 56The application can be run with a ``.rsp`` file and what the outcome of that 57will be is it will add a extra line in the generated ``.rsp`` which should be 58the same as the ``.rsp`` used to run the application, this is useful for 59validating if the application has done the operation correctly. 60 61 62Compiling the Application 63------------------------- 64 65* Compile Application 66 67 .. code-block:: console 68 69 make -C examples/fips_validation 70 71* Run ``dos2unix`` on the request files 72 73 .. code-block:: console 74 75 dos2unix AES/req/* 76 dos2unix AES_GCM/req/* 77 dos2unix CCM/req/* 78 dos2unix CMAC/req/* 79 dos2unix HMAC/req/* 80 dos2unix TDES/req/* 81 82Running the Application 83----------------------- 84 85The application requires a number of command line options: 86 87 .. code-block:: console 88 89 ./fips_validation [EAL options] 90 -- --req-file FILE_PATH/FOLDER_PATH 91 --rsp-file FILE_PATH/FOLDER_PATH 92 [--cryptodev DEVICE_NAME] [--cryptodev-id ID] [--path-is-folder] 93 94where, 95 * req-file: The path of the request file or folder, separated by 96 ``path-is-folder`` option. 97 98 * rsp-file: The path that the response file or folder is stored. separated by 99 ``path-is-folder`` option. 100 101 * cryptodev: The name of the target DPDK Crypto device to be validated. 102 103 * cryptodev-id: The id of the target DPDK Crypto device to be validated. 104 105 * path-is-folder: If presented the application expects req-file and rsp-file 106 are folder paths. 107 108 109To run the application in linuxapp environment to test one AES FIPS test data 110file for crypto_aesni_mb PMD, issue the command: 111 112.. code-block:: console 113 114 $ ./fips_validation --vdev crypto_aesni_mb -- 115 --req-file /PATH/TO/REQUEST/FILE.req --rsp-file ./PATH/TO/RESPONSE/FILE.rsp 116 --cryptodev crypto_aesni_mb 117 118To run the application in linuxapp environment to test all AES-GCM FIPS test 119data files in one folder for crypto_aesni_gcm PMD, issue the command: 120 121.. code-block:: console 122 123 $ ./fips_validation --vdev crypto_aesni_gcm0 -- 124 --req-file /PATH/TO/REQUEST/FILE/FOLDER/ 125 --rsp-file ./PATH/TO/RESPONSE/FILE/FOLDER/ 126 --cryptodev-id 0 --path-is-folder 127