===========================
===== ACVP_APP USAGE ======
===========================
To output version of library and of ACVP spec:
--version
-v
Logging level decides the amount of information output by the library. Logging level
can be controlled using:
--none
--error
--warn
--status(default)
--info
--verbose
Algorithm Test Suites:
Note: not all suites are supported by all supported implementations.
--all_algs (or -a, Enable all of the suites supported by the crypto module)
--aes
--tdes
--hash
--cmac
--hmac
--kdf
--dsa
--kas_ffc
--safe_primes
--rsa
--ecdsa
--eddsa
--drbg
--kas_ecc
--kas_ifc
--kda
--kts_ifc
--lms
--ml_dsa
--ml_kem
--slh_dsa
--kmac
--cshake
If running hash, a maximum size for large data testing (LDT) may be required on specific
memory-limited platforms. This can be set (in GiB) using:
--set_max_hash_size <GiB value>
Setting 0 will disable LDT and only use the typical hash message sizes in the KiB range.
Perform a FIPS Validation for this testSession:
--fips_validation <full metadata file>
To specify a cert number associated with all prerequisites:
--certnum <string>
To register manually using a JSON file instead of application settings use:
--manual_registration <file>
To retrieve and output the JSON form of the currently registered capabilities:
--get_registration
To register and save the vectors to file:
--vector_req <file>
-r <file>
To process saved vectors and write results/responses to file:
--vector_req <file>
--vector_rsp <file>
OR
-r <file>
-p <file>
To process a generic vector file without libacvp formatting, add:
--generic
To upload vector responses from file:
--vector_upload <file>
-u <file>
Note: --resume_session and --get_results use the test session info file created automatically by the library as input
To resume a previous test session that was interrupted:
--resume_session <session_file>
Note: this does not save your arguments from your initial run and you MUST include them
again (e.x. --aes, --vector_req and --fips_validation)
To cancel a test session that was previously initiated:
--cancel_session <session_file>
Note: This will request the server to halt all processing and delete all info related to the
test session - It is not recoverable
To get the results of a previous test session:
--get_results <session_file>
To GET status of request, such as validation or metadata:
--get <request string URL including ID>
To POST metadata for vendor, person, etc.:
--post <metadata file>
To PUT(modify) metadata for vendor, person, etc. or PUT for validation:
--put <metadata file>
To request to DELETE a resource you have created on the server:
--delete <url>
If you are running a sample registration (querying for correct answers
in addition to the normal registration flow) use:
--sample
To get the expected results of a sample test session:
--get_expected_results <session_file>
Some other options may support outputting to log OR saving to a file. To save to a file:
--save_to <file>
-s <file>
To request disabling FIPS for this run (may not apply to all supported modules):
-disable_fips
In addition some options are passed to acvp_app using
environment variables. The following variables can be set:
ACV_SERVER (when not set, defaults to 127.0.0.1)
ACV_PORT (when not set, defaults to 443)
ACV_URI_PREFIX (when not set, defaults to /acvp/v1/)
ACV_TOTP_SEED (when not set, client will not use Two-factor authentication)
ACV_CA_FILE
ACV_CERT_FILE
ACV_KEY_FILE
The CA certificates, cert and key should be PEM encoded. There should be no
password on the key file.
Some options can be passed to the library itself with environment variables:
ACV_SESSION_SAVE_PATH (Location where test session info files are saved)
ACV_SESSION_SAVE_PREFIX (Determines file name of info file, followed by ID number
The following are used by the library for an HTTP user-agent string, only when
the information cannot be automatically collected:
ACV_OE_OSNAME
ACV_OE_OSVERSION
ACV_OE_ARCHITECTURE
ACV_OE_PROCESSOR
ACV_OE_COMPILER
Options (49)
| Option | Description | Source |
|---|
--version | | help |
-v | | help |
--none | | help |
--error | | help |
--warn | | help |
--info | | help |
--verbose | | help |
--aes | | help |
--tdes | | help |
--hash | | help |
--cmac | | help |
--hmac | | help |
--kdf | | help |
--dsa | | help |
--kas_ffc | | help |
--safe_primes | | help |
--rsa | | help |
--ecdsa | | help |
--eddsa | | help |
--drbg | | help |
--kas_ecc | | help |
--kas_ifc | | help |
--kda | | help |
--kts_ifc | | help |
--lms | | help |
--ml_dsa | | help |
--ml_kem | | help |
--slh_dsa | | help |
--kmac | | help |
--cshake | | help |
--certnum string | | help |
--manual_registration file | | help |
--get_registration | | help |
--vector_req file | | help |
-r file | | help |
--vector_rsp file | | help |
-p file | | help |
--generic | | help |
--vector_upload file | | help |
-u file | | help |
--resume_session session_file | Note: this does not save your arguments from your initial run and you MUST include them again (e.x. | help |
--cancel_session session_file | Note: This will request the server to halt all processing and delete all info related to the test session - It is not recoverable | help |
--get_results session_file | | help |
--delete url | | help |
--sample | | help |
--get_expected_results session_file | | help |
--save_to file | | help |
-s file | | help |
-disable_fips | | help |
Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.