QuasarApp/openssl
4
0
Fork 0
mirror of https://github.com/QuasarApp/openssl.git synced 2025-04-30 11:44:37 +00:00
Code Issues Projects Releases Wiki Activity

doc: update provider-mac documentation to account for the additional init() arguments

Browse Source 
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/14310)
This commit is contained in:
Pauli 2021-02-25 14:30:57 +10:00
parent 9258f7efa7
commit dc567dc746
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/man7/provider-mac.pod
View File

@ -23,7 +23,8 @@ provider-mac - The mac library E<lt>-E<gt> provider functions
void *OSSL_FUNC_mac_dupctx(void *src); void *OSSL_FUNC_mac_dupctx(void *src);
/* Encryption/decryption */ /* 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_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); 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 =head2 Encryption/Decryption Functions
OSSL_FUNC_mac_init() initialises a mac operation given a newly created provider 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 OSSL_FUNC_mac_update() is called to supply data for MAC computation of a previously
initialised mac operation. 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> =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> =item "iv" (B<OSSL_MAC_PARAM_IV>) <octet string>
@ -228,7 +231,7 @@ array, or NULL if none is offered.
=head1 SEE ALSO =head1 SEE ALSO
L<provider(7)> L<provider(7)>, L<EVP_MAC_init(3)>
=head1 HISTORY =head1 HISTORY