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-CTR (128,192,256) - AFT, CTR 65 * AES-GMAC (128,192,256) - AFT 66 * AES-XTS (128,256) - AFT 67 * HMAC (SHA1, SHA224, SHA256, SHA384, SHA512) 68 * SHA (1, 256, 384, 512) - AFT, MCT 69 * TDES-CBC - AFT, MCT 70 * TDES-ECB - AFT, MCT 71 72 73Application Information 74----------------------- 75 76If a ``.req`` is used as the input file after the application is finished 77running it will generate a response file or ``.rsp``. Differences between the 78two files are, the ``.req`` file has missing information for instance if doing 79encryption you will not have the cipher text and that will be generated in the 80response file. Also if doing decryption it will not have the plain text until it 81finished the work and in the response file it will be added onto the end of each 82operation. 83 84The application can be run with a ``.rsp`` file and what the outcome of that 85will be is it will add a extra line in the generated ``.rsp`` which should be 86the same as the ``.rsp`` used to run the application, this is useful for 87validating if the application has done the operation correctly. 88 89 90Compiling the Application 91------------------------- 92 93* Compile Application 94 95 To compile the sample application see :doc:`compiling`. 96 97* Run ``dos2unix`` on the request files 98 99 .. code-block:: console 100 101 dos2unix AES/req/* 102 dos2unix GCM/req/* 103 dos2unix CCM/req/* 104 dos2unix CMAC/req/* 105 dos2unix HMAC/req/* 106 dos2unix TDES/req/* 107 dos2unix SHA/req/* 108 109Running the Application 110----------------------- 111 112The application requires a number of command line options: 113 114 .. code-block:: console 115 116 ./dpdk-fips_validation [EAL options] 117 -- --req-file FILE_PATH/FOLDER_PATH 118 --rsp-file FILE_PATH/FOLDER_PATH 119 [--cryptodev DEVICE_NAME] [--cryptodev-id ID] [--path-is-folder] 120 --mbuf-dataroom DATAROOM_SIZE 121 122where, 123 * req-file: The path of the request file or folder, separated by 124 ``path-is-folder`` option. 125 126 * rsp-file: The path that the response file or folder is stored. separated by 127 ``path-is-folder`` option. 128 129 * cryptodev: The name of the target DPDK Crypto device to be validated. 130 131 * cryptodev-id: The id of the target DPDK Crypto device to be validated. 132 133 * path-is-folder: If presented the application expects req-file and rsp-file 134 are folder paths. 135 136 * mbuf-dataroom: By default the application creates mbuf pool with maximum 137 possible data room (65535 bytes). If the user wants to test scatter-gather 138 list feature of the PMD he or she may set this value to reduce the dataroom 139 size so that the input data may be divided into multiple chained mbufs. 140 141 142To run the application in linux environment to test one AES FIPS test data 143file for crypto_aesni_mb PMD, issue the command: 144 145.. code-block:: console 146 147 $ ./dpdk-fips_validation --vdev crypto_aesni_mb -- 148 --req-file /PATH/TO/REQUEST/FILE.req --rsp-file ./PATH/TO/RESPONSE/FILE.rsp 149 --cryptodev crypto_aesni_mb 150 151To run the application in linux environment to test all AES-GCM FIPS test 152data files in one folder for crypto_aesni_gcm PMD, issue the command: 153 154.. code-block:: console 155 156 $ ./dpdk-fips_validation --vdev crypto_aesni_gcm0 -- 157 --req-file /PATH/TO/REQUEST/FILE/FOLDER/ 158 --rsp-file ./PATH/TO/RESPONSE/FILE/FOLDER/ 159 --cryptodev-id 0 --path-is-folder 160