From 041a96e7acc89685228980b5615a53bee7f07b0f Mon Sep 17 00:00:00 2001 From: Richard Levitte Date: Sat, 7 Mar 2020 08:00:51 +0100 Subject: [PATCH] DOCS: Clean up doc/man3/EVP_DigestInit.pod We touch it, we clean it up! Accordding to common man-pages(7) guidelines. Reviewed-by: Matt Caswell (Merged from https://github.com/openssl/openssl/pull/11270) --- doc/man3/EVP_DigestInit.pod | 72 ++++++++++++++++++------------------- 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/doc/man3/EVP_DigestInit.pod b/doc/man3/EVP_DigestInit.pod index 94f751a659..628e7c234f 100644 --- a/doc/man3/EVP_DigestInit.pod +++ b/doc/man3/EVP_DigestInit.pod @@ -110,8 +110,8 @@ The B type is a structure for digest method implementation. =item EVP_MD_fetch() -Fetches the digest implementation for the given B from any -provider offering it, within the criteria given by the B. +Fetches the digest implementation for the given I from any +provider offering it, within the criteria given by the I. See L for further information. The returned value must eventually be freed with EVP_MD_free(). @@ -133,12 +133,12 @@ Allocates and returns a digest context. =item EVP_MD_CTX_reset() -Resets the digest context B. This can be used to reuse an already +Resets the digest context I. This can be used to reuse an already existing context. =item EVP_MD_CTX_free() -Cleans up digest context B and frees up the space allocated to it. +Cleans up digest context I and frees up the space allocated to it. =item EVP_MD_CTX_ctrl() @@ -146,8 +146,8 @@ I -Performs digest-specific control actions on context B. The control command -is indicated in B and any additional arguments in B and B. +Performs digest-specific control actions on context I. The control command +is indicated in I and any additional arguments in I and I. EVP_MD_CTX_ctrl() must be called after EVP_DigestInit_ex(). Other restrictions may apply depending on the control type and digest implementation. @@ -161,17 +161,17 @@ being done. =item EVP_MD_get_params() -Retrieves the requested list of B from a MD B. +Retrieves the requested list of I from a MD I. See L below for more information. =item EVP_MD_CTX_get_params() -Retrieves the requested list of B from a MD context B. +Retrieves the requested list of I from a MD context I. See L below for more information. =item EVP_MD_CTX_set_params() -Sets the list of B into a MD context B. +Sets the list of I into a MD context I. See L below for more information. =item EVP_MD_gettable_params(), EVP_MD_gettable_ctx_params(), @@ -189,36 +189,36 @@ See L for the use of B as parameter descriptor. =item EVP_MD_CTX_set_flags(), EVP_MD_CTX_clear_flags(), EVP_MD_CTX_test_flags() -Sets, clears and tests B flags. See L below for more information. +Sets, clears and tests I flags. See L below for more information. =item EVP_Digest() A wrapper around the Digest Init_ex, Update and Final_ex functions. -Hashes B bytes of data at B using a digest B from ENGINE -B. The digest value is placed in B and its length is written at B +Hashes I bytes of data at I using a digest I from ENGINE +I. The digest value is placed in I and its length is written at I if the pointer is not NULL. At most B bytes will be written. -If B is NULL the default implementation of digest B is used. +If I is NULL the default implementation of digest I is used. =item EVP_DigestInit_ex() -Sets up digest context B to use a digest B. -B is typically supplied by a function such as EVP_sha1(), or a +Sets up digest context I to use a digest I. +I is typically supplied by a function such as EVP_sha1(), or a value explicitly fetched with EVP_MD_fetch(). -If B is non-NULL, its implementation of the digest B is used if +If I is non-NULL, its implementation of the digest I is used if there is one, and if not, the default implementation is used. =item EVP_DigestUpdate() -Hashes B bytes of data at B into the digest context B. This -function can be called several times on the same B to hash additional +Hashes I bytes of data at I into the digest context I. This +function can be called several times on the same I to hash additional data. =item EVP_DigestFinal_ex() -Retrieves the digest value from B and places it in B. If the B +Retrieves the digest value from I and places it in I. If the I parameter is not NULL then the number of bytes of data written (i.e. the -length of the digest) will be written to the integer at B, at most +length of the digest) will be written to the integer at I, at most B bytes will be written. After calling EVP_DigestFinal_ex() no additional calls to EVP_DigestUpdate() can be made, but EVP_DigestInit_ex() can be called to initialize a new digest operation. @@ -226,13 +226,13 @@ EVP_DigestInit_ex() can be called to initialize a new digest operation. =item EVP_DigestFinalXOF() Interfaces to extendable-output functions, XOFs, such as SHAKE128 and SHAKE256. -It retrieves the digest value from B and places it in B-sized md. +It retrieves the digest value from I and places it in I-sized md. After calling this function no additional calls to EVP_DigestUpdate() can be made, but EVP_DigestInit_ex() can be called to initialize a new operation. =item EVP_MD_CTX_copy_ex() -Can be used to copy the message digest state from B to B. This is +Can be used to copy the message digest state from I to I. This is useful if large amounts of data are to be hashed which only differ in the last few bytes. @@ -243,12 +243,12 @@ default digest implementation and calls EVP_MD_CTX_reset(). =item EVP_DigestFinal() -Similar to EVP_DigestFinal_ex() except the digest context B is +Similar to EVP_DigestFinal_ex() except the digest context I is automatically cleaned up. =item EVP_MD_CTX_copy() -Similar to EVP_MD_CTX_copy_ex() except the destination B does not have to +Similar to EVP_MD_CTX_copy_ex() except the destination I does not have to be initialized. =item EVP_MD_is_a() @@ -319,17 +319,17 @@ should not be used after the EVP_MD_CTX is freed. =item EVP_MD_CTX_set_update_fn() -Sets the update function for B to B. +Sets the update function for I to I. This is the function that is called by EVP_DigestUpdate. If not set, the update function from the B type specified at initialization is used. =item EVP_MD_CTX_update_fn() -Returns the update function for B. +Returns the update function for I. =item EVP_MD_flags() -Returns the B flags. Note that these are different from the B +Returns the I flags. Note that these are different from the B ones. See L for more information. =item EVP_MD_pkey_type() @@ -353,16 +353,16 @@ B structure respectively. =item EVP_MD_CTX_pkey_ctx() -Returns the B assigned to B. The returned pointer should not +Returns the B assigned to I. The returned pointer should not be freed by the caller. =item EVP_MD_CTX_set_pkey_ctx() Assigns an B to B. This is usually used to provide a customized B to L or -L. The B passed to this function should be freed -by the caller. A NULL B pointer is also allowed to clear the B -assigned to B. In such case, freeing the cleared B or not +L. The I passed to this function should be freed +by the caller. A NULL I pointer is also allowed to clear the B +assigned to I. In such case, freeing the cleared B or not depends on how the B is created. =item EVP_MD_do_all_provided() @@ -390,7 +390,7 @@ using a B. =item "pad_type" (B) -Sets the pad type. +Sets the padding type. It is used by the MDC2 algorithm. =back @@ -417,16 +417,16 @@ EVP_MD_CTX_ctrl() can be used to send the following standard controls: Gets the digest Message Integrity Check algorithm string. This is used when creating S/MIME multipart/signed messages, as specified in RFC 3851. -The string value is written to B. +The string value is written to I. When used with a fetched B, EVP_MD_CTX_get_params() gets called with an L item with the key "micalg" (B). =item EVP_MD_CTRL_XOF_LEN -This control sets the digest length for extendable output functions to B. +This control sets the digest length for extendable output functions to I. Sending this control directly should not be necessary, the use of -C is preferred. +EVP_DigestFinalXOF() is preferred. Currently used by SHAKE. When used with a fetched B, EVP_MD_CTX_get_params() gets called with @@ -543,7 +543,7 @@ New applications should use the SHA-2 (such as L) or the SHA-3 digest algorithms (such as L). The other digest algorithms are still in common use. -For most applications the B parameter to EVP_DigestInit_ex() will be +For most applications the I parameter to EVP_DigestInit_ex() will be set to NULL to use the default digest implementation. The functions EVP_DigestInit(), EVP_DigestFinal() and EVP_MD_CTX_copy() are -- 2.39.5