doc: document that 'openssl rand' is cryptographically secure
[openssl.git] / doc / man1 / openssl-mac.pod
index 8fd911142f384543a372a4d2f910078c4427722d..e5ec76395e340fa0bc1662cd6588de99046f8578 100644 (file)
@@ -12,9 +12,7 @@ B<openssl mac>
 [B<-in> I<filename>]
 [B<-out> I<filename>]
 [B<-binary>]
-B<mac_name>
-
-B<openssl> I<mac> [B<...>] B<mac_name>
+I<mac_name>
 
 =head1 DESCRIPTION
 
@@ -53,58 +51,59 @@ Common parameter names used by EVP_MAC_CTX_get_params() are:
 
 =over 4
 
-=item B<key:string>
+=item B<key:>I<string>
 
 Specifies the MAC key as an alphanumeric string (use if the key contains
 printable characters only).
 The string length must conform to any restrictions of the MAC algorithm.
 A key must be specified for every MAC algorithm.
 
-=item B<hexkey:string>
+=item B<hexkey:>I<string>
 
 Specifies the MAC key in hexadecimal form (two hex digits per byte).
 The key length must conform to any restrictions of the MAC algorithm.
 A key must be specified for every MAC algorithm.
 
-=item B<digest:string>
+=item B<digest:>I<string>
 
 Used by HMAC as an alphanumeric string (use if the key contains printable
 characters only).
 The string length must conform to any restrictions of the MAC algorithm.
-To see the list of supported digests, use the command I<list -digest-commands>.
+To see the list of supported digests, use C<openssl list -digest-commands>.
 
-=item B<cipher:string>
+=item B<cipher:>I<string>
 
 Used by CMAC and GMAC to specify the cipher algorithm.
 For CMAC it must be one of AES-128-CBC, AES-192-CBC, AES-256-CBC or
 DES-EDE3-CBC.
 For GMAC it should be a GCM mode cipher e.g. AES-128-GCM.
 
-=item B<iv:string>
+=item B<iv:>I<string>
 
 Used by GMAC to specify an IV as an alphanumeric string (use if the IV contains
 printable characters only).
 
-=item B<hexiv:string>
+=item B<hexiv:>I<string>
 
 Used by GMAC to specify an IV in hexadecimal form (two hex digits per byte).
 
-=item B<outlen:int>
+=item B<size:>I<int>
 
 Used by KMAC128 or KMAC256 to specify an output length.
 The default sizes are 32 or 64 bytes respectively.
 
-=item B<custom:string>
+=item B<custom:>I<string>
 
 Used by KMAC128 or KMAC256 to specify a customization string.
 The default is the empty string "".
 
 =back
 
-=item B<mac_name>
+=item I<mac_name>
 
 Specifies the name of a supported MAC algorithm which will be used.
-To see the list of supported MAC's use the command I<list -mac-algorithms>.
+To see the list of supported MAC's use the command C<opensssl list
+-mac-algorithms>.
 
 =back
 
@@ -128,7 +127,7 @@ To create a hex-encoded CMAC-AES-128-CBC MAC from a file:\
 To create a hex-encoded KMAC128 MAC from a file with a Customisation String
 'Tag' and output length of 16: \
  openssl mac -macopt custom:Tag -macopt hexkey:40414243444546 \
-         -macopt outlen:16 -in msg.bin KMAC128
+         -macopt size:16 -in msg.bin KMAC128
 
 To create a hex-encoded GMAC-AES-128-GCM with a IV from a file: \
  openssl mac -macopt cipher:AES-128-GCM -macopt hexiv:E0E00F19FED7BA0136A797F3 \
@@ -138,7 +137,7 @@ To create a hex-encoded GMAC-AES-128-GCM with a IV from a file: \
 
 The MAC mechanisms that are available will depend on the options
 used when building OpenSSL.
-The B<list -mac-algorithms> command can be used to list them.
+Use C<openssl list -mac-algorithms> to list them.
 
 =head1 SEE ALSO
 
@@ -148,8 +147,8 @@ L<EVP_MAC-CMAC(7)>,
 L<EVP_MAC-GMAC(7)>,
 L<EVP_MAC-HMAC(7)>,
 L<EVP_MAC-KMAC(7)>,
-L<EVP_MAC-SIPHASH(7)>,
-L<EVP_MAC-POLY1305(7)>
+L<EVP_MAC-Siphash(7)>,
+L<EVP_MAC-Poly1305(7)>
 
 =head1 COPYRIGHT