diff options
| author | Pauli <paul.dale@oracle.com> | 2019-09-26 12:14:00 +1000 |
|---|---|---|
| committer | Pauli <paul.dale@oracle.com> | 2019-09-27 16:21:51 +1000 |
| commit | d56eba1fd109faa2c25fcb7cb2d9ee85e62b827f (patch) | |
| tree | 5a6c61cd87b3ae9d6c0705ea924a890ab62d3763 /doc/man7/provider-mac.pod | |
| parent | 318e074e1f55c556d0ab4f9e3fbdca7c9b284847 (diff) | |
Make OSSL_PARAM descriptions uniformly formatted.
=item B<MACRO> ("name") <type>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/10024)
Diffstat (limited to 'doc/man7/provider-mac.pod')
| -rw-r--r-- | doc/man7/provider-mac.pod | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/doc/man7/provider-mac.pod b/doc/man7/provider-mac.pod index f9d6e35329..fc179740fc 100644 --- a/doc/man7/provider-mac.pod +++ b/doc/man7/provider-mac.pod @@ -151,47 +151,47 @@ parameters are relevant to, or are understood by all macs: =over 4 -=item B<OSSL_MAC_PARAM_KEY> (octet string) +=item B<OSSL_MAC_PARAM_KEY> ("key") <octet string> Sets the key in the associated MAC ctx. -=item B<OSSL_MAC_PARAM_IV> (octet string) +=item B<OSSL_MAC_PARAM_IV> ("iv") <octet string> Sets the IV of the underlying cipher, when applicable. -=item B<OSSL_MAC_PARAM_CUSTOM> (UTF8 string) +=item B<OSSL_MAC_PARAM_CUSTOM> ("custom") <UTF8 string> Sets the custom string in the associated MAC ctx. -=item B<OSSL_MAC_PARAM_SALT> (octet string) +=item B<OSSL_MAC_PARAM_SALT> ("salt") <octet string> Sets the salt of the underlying cipher, when applicable. -=item B<OSSL_MAC_PARAM_BLOCK_XOF> (integer) +=item B<OSSL_MAC_PARAM_BLOCK_XOF> ("xof") <integer> Sets XOF mode in the associated MAC ctx. 0 means no XOF mode, 1 means XOF mode. -=item B<OSSL_MAC_PARAM_FLAGS> (integer) +=item B<OSSL_MAC_PARAM_FLAGS> ("flags") <integer> Gets flags associated with the MAC. =for comment We need to investigate if this is the right approach -=item B<OSSL_MAC_PARAM_CIPHER> (UTF8 string) +=item B<OSSL_MAC_PARAM_CIPHER> ("cipher") <UTF8 string> -=item B<OSSL_MAC_PARAM_DIGEST> (UTF8 string) +=item B<OSSL_MAC_PARAM_DIGEST> ("digest") <UTF8 string> Sets the name of the underlying cipher or digest to be used. It must name a suitable algorithm for the MAC that's being used. -=item B<OSSL_MAC_PARAM_PROPERTIES> (UTF8 string) +=item B<OSSL_MAC_PARAM_PROPERTIES> ("properties") <UTF8 string> Sets the properties to be queried when trying to fetch the underlying algorithm. This must be given together with the algorithm naming parameter to be considered valid. -=item B<OSSL_MAC_PARAM_SIZE> (integer) +=item B<OSSL_MAC_PARAM_SIZE> ("size") <integer> Can be used to get the resulting MAC size. |