doc: update provider-mac documentation to account for the additional init() arguments
authorPauli <ppzgs1@gmail.com>
Thu, 25 Feb 2021 04:30:57 +0000 (14:30 +1000)
committerPauli <ppzgs1@gmail.com>
Sun, 28 Feb 2021 07:25:49 +0000 (17:25 +1000)
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/14310)

doc/man7/provider-mac.pod

index fdeda79ab5e7a83f618e128e34bb2766204c4083..47f26ca89b3e43d8061bf5879d9baf8ff0dab097 100644 (file)
@@ -23,7 +23,8 @@ provider-mac - The mac library E<lt>-E<gt> provider functions
  void *OSSL_FUNC_mac_dupctx(void *src);
 
  /* Encryption/decryption */
- int OSSL_FUNC_mac_init(void *mctx);
+ int OSSL_FUNC_mac_init(void *mctx, unsigned char *key, size_t keylen,
+                        const OSSL_PARAM params[]);
  int OSSL_FUNC_mac_update(void *mctx, const unsigned char *in, size_t inl);
  int OSSL_FUNC_mac_final(void *mctx, unsigned char *out, size_t *outl, size_t outsize);
 
@@ -108,7 +109,8 @@ I<mctx> parameter and return the duplicate copy.
 =head2 Encryption/Decryption Functions
 
 OSSL_FUNC_mac_init() initialises a mac operation given a newly created provider
-side mac context in the I<mctx> parameter.
+side mac context in the I<mctx> parameter.  The I<params> are set before setting
+the MAC I<key> of I<keylen> bytes.
 
 OSSL_FUNC_mac_update() is called to supply data for MAC computation of a previously
 initialised mac operation.
@@ -158,7 +160,8 @@ parameters are relevant to, or are understood by all macs:
 
 =item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>
 
-Sets the key in the associated MAC ctx.
+Sets the key in the associated MAC ctx.  This is identical to passing a I<key>
+argument to the OSSL_FUNC_mac_init() function.
 
 =item "iv" (B<OSSL_MAC_PARAM_IV>) <octet string>
 
@@ -228,7 +231,7 @@ array, or NULL if none is offered.
 
 =head1 SEE ALSO
 
-L<provider(7)>
+L<provider(7)>, L<EVP_MAC_init(3)>
 
 =head1 HISTORY