X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=doc%2Fman7%2Fprovider-mac.pod;h=d0a8881eef5e1d90b39b82e5837ef86c758a657c;hb=3c49e4ff519abee92d9557eca8653ab82cd5787c;hp=f9d6e3532937d294428a5bfc4fd886758e7d9cb9;hpb=72c162abb093857b2b3ea4fa2c1785eda7d6228f;p=oweals%2Fopenssl.git diff --git a/doc/man7/provider-mac.pod b/doc/man7/provider-mac.pod index f9d6e35329..d0a8881eef 100644 --- a/doc/man7/provider-mac.pod +++ b/doc/man7/provider-mac.pod @@ -6,7 +6,7 @@ provider-mac - The mac library E-E provider functions =head1 SYNOPSIS -=for comment multiple includes +=for openssl multiple includes #include #include @@ -44,7 +44,7 @@ for further information. The MAC operation enables providers to implement mac algorithms and make them available to applications via the API functions L, -L and L. +L and L. All "functions" mentioned here are passed as function pointers between F and the provider in B arrays via @@ -93,8 +93,8 @@ OP_mac_newctx() should create and return a pointer to a provider side structure for holding context information during a mac operation. A pointer to this context will be passed back in a number of the other mac operation function calls. -The paramater I is the provider context generated during provider -initialisation (see L). +The parameter I is the provider context generated during provider +initialisation (see L). OP_mac_freectx() is passed a pointer to the provider side mac context in the I parameter. @@ -108,7 +108,7 @@ I parameter and return the duplicate copy. =head2 Encryption/Decryption Functions OP_mac_init() initialises a mac operation given a newly created provider -side mac context in the I paramter. +side mac context in the I parameter. OP_mac_update() is called to supply data for MAC computation of a previously initialised mac operation. @@ -151,47 +151,47 @@ parameters are relevant to, or are understood by all macs: =over 4 -=item B (octet string) +=item "key" (B) Sets the key in the associated MAC ctx. -=item B (octet string) +=item "iv" (B) Sets the IV of the underlying cipher, when applicable. -=item B (UTF8 string) +=item "custom" (B) Sets the custom string in the associated MAC ctx. -=item B (octet string) +=item "salt" (B) Sets the salt of the underlying cipher, when applicable. -=item B (integer) +=item "xof" (B) Sets XOF mode in the associated MAC ctx. 0 means no XOF mode, 1 means XOF mode. -=item B (integer) +=item "flags" (B) Gets flags associated with the MAC. =for comment We need to investigate if this is the right approach -=item B (UTF8 string) +=item "cipher" (B) -=item B (UTF8 string) +=item "digest" (B) 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 (UTF8 string) +=item "properties" (B) 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 (integer) +=item "size" (B) Can be used to get the resulting MAC size.