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) and 16Automated Crypto Validation Protocol (ACVP) test vectors. 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 (in case of CAVP) 21and FIPS 140-3 (in case of ACVP) and must successfully complete the 22cryptographic algorithm validation process. 23 24Limitations 25----------- 26 27CAVP 28---- 29 30* The version of request file supported is ``CAVS 21.0``. 31* If the header comment in a ``.req`` file does not contain a Algo tag 32 i.e ``AES,TDES,GCM`` you need to manually add it into the header comment for 33 example:: 34 35 # VARIABLE KEY - KAT for CBC / # TDES VARIABLE KEY - KAT for CBC 36 37* The application does not supply the test vectors. The user is expected to 38 obtain the test vector files from `CAVP 39 <https://csrc.nist.gov/projects/cryptographic-algorithm-validation- 40 program/block-ciphers>`_ website. To obtain the ``.req`` files you need to 41 email a person from the NIST website and pay for the ``.req`` files. 42 The ``.rsp`` files from the site can be used to validate and compare with 43 the ``.rsp`` files created by the FIPS application. 44 45* Supported test vectors 46 * AES-CBC (128,192,256) - GFSbox, KeySbox, MCT, MMT 47 * AES-GCM (128,192,256) - EncryptExtIV, Decrypt 48 * AES-CCM (128) - VADT, VNT, VPT, VTT, DVPT 49 * AES-CMAC (128) - Generate, Verify 50 * HMAC (SHA1, SHA224, SHA256, SHA384, SHA512) 51 * TDES-CBC (1 Key, 2 Keys, 3 Keys) - MMT, Monte, Permop, Subkey, Varkey, 52 VarText 53 54ACVP 55---- 56 57* The application does not supply the test vectors. The user is expected to 58 obtain the test vector files from `ACVP <https://pages.nist.gov/ACVP>`_ 59 website. 60* Supported test vectors 61 * AES-CBC (128,192,256) - AFT, MCT 62 * AES-GCM (128,192,256) - AFT 63 * AES-CMAC (128,192,256) - AFT 64 * AES-XTS (128,256) - AFT 65 * HMAC (SHA1, SHA224, SHA256, SHA384, SHA512) 66 * SHA (1, 256, 384, 512) - AFT, MCT 67 * TDES-CBC - AFT, MCT 68 * TDES-ECB - AFT, MCT 69 70 71Application Information 72----------------------- 73 74If a ``.req`` is used as the input file after the application is finished 75running it will generate a response file or ``.rsp``. Differences between the 76two files are, the ``.req`` file has missing information for instance if doing 77encryption you will not have the cipher text and that will be generated in the 78response file. Also if doing decryption it will not have the plain text until it 79finished the work and in the response file it will be added onto the end of each 80operation. 81 82The application can be run with a ``.rsp`` file and what the outcome of that 83will be is it will add a extra line in the generated ``.rsp`` which should be 84the same as the ``.rsp`` used to run the application, this is useful for 85validating if the application has done the operation correctly. 86 87 88Compiling the Application 89------------------------- 90 91* Compile Application 92 93 To compile the sample application see :doc:`compiling`. 94 95* Run ``dos2unix`` on the request files 96 97 .. code-block:: console 98 99 dos2unix AES/req/* 100 dos2unix GCM/req/* 101 dos2unix CCM/req/* 102 dos2unix CMAC/req/* 103 dos2unix HMAC/req/* 104 dos2unix TDES/req/* 105 dos2unix SHA/req/* 106 107Running the Application 108----------------------- 109 110The application requires a number of command line options: 111 112 .. code-block:: console 113 114 ./dpdk-fips_validation [EAL options] 115 -- --req-file FILE_PATH/FOLDER_PATH 116 --rsp-file FILE_PATH/FOLDER_PATH 117 [--cryptodev DEVICE_NAME] [--cryptodev-id ID] [--path-is-folder] 118 --mbuf-dataroom DATAROOM_SIZE 119 120where, 121 * req-file: The path of the request file or folder, separated by 122 ``path-is-folder`` option. 123 124 * rsp-file: The path that the response file or folder is stored. separated by 125 ``path-is-folder`` option. 126 127 * cryptodev: The name of the target DPDK Crypto device to be validated. 128 129 * cryptodev-id: The id of the target DPDK Crypto device to be validated. 130 131 * path-is-folder: If presented the application expects req-file and rsp-file 132 are folder paths. 133 134 * mbuf-dataroom: By default the application creates mbuf pool with maximum 135 possible data room (65535 bytes). If the user wants to test scatter-gather 136 list feature of the PMD he or she may set this value to reduce the dataroom 137 size so that the input data may be divided into multiple chained mbufs. 138 139 140To run the application in linux environment to test one AES FIPS test data 141file for crypto_aesni_mb PMD, issue the command: 142 143.. code-block:: console 144 145 $ ./dpdk-fips_validation --vdev crypto_aesni_mb -- 146 --req-file /PATH/TO/REQUEST/FILE.req --rsp-file ./PATH/TO/RESPONSE/FILE.rsp 147 --cryptodev crypto_aesni_mb 148 149To run the application in linux environment to test all AES-GCM FIPS test 150data files in one folder for crypto_aesni_gcm PMD, issue the command: 151 152.. code-block:: console 153 154 $ ./dpdk-fips_validation --vdev crypto_aesni_gcm0 -- 155 --req-file /PATH/TO/REQUEST/FILE/FOLDER/ 156 --rsp-file ./PATH/TO/RESPONSE/FILE/FOLDER/ 157 --cryptodev-id 0 --path-is-folder 158