Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 379d972b authored by Rabin Vincent's avatar Rabin Vincent Committed by Herbert Xu
Browse files

crypto: doc - Fix hash export state information 



The documentation states that crypto_ahash_reqsize() provides the size
of the state structure used by crypto_ahash_export().  But it's actually
crypto_ahash_statesize() which provides this size.

Signed-off-by: default avatarRabin Vincent <rabinv@axis.com>
Signed-off-by: default avatarHerbert Xu <herbert@gondor.apana.org.au>
parent 34cb5821

Documentation/crypto/api-digest.rst

+1 −1
Original line number Diff line number Diff line
@@ -14,7 +14,7 @@ Asynchronous Message Digest API 
   :doc: Asynchronous Message Digest API



.. kernel-doc:: include/crypto/hash.h

   :functions: crypto_alloc_ahash crypto_free_ahash crypto_ahash_init crypto_ahash_digestsize crypto_ahash_reqtfm crypto_ahash_reqsize crypto_ahash_setkey crypto_ahash_finup crypto_ahash_final crypto_ahash_digest crypto_ahash_export crypto_ahash_import

   :functions: crypto_alloc_ahash crypto_free_ahash crypto_ahash_init crypto_ahash_digestsize crypto_ahash_reqtfm crypto_ahash_reqsize crypto_ahash_statesize crypto_ahash_setkey crypto_ahash_finup crypto_ahash_final crypto_ahash_digest crypto_ahash_export crypto_ahash_import



Asynchronous Hash Request Handle

--------------------------------

include/crypto/hash.h

+12 −6
Original line number Diff line number Diff line
@@ -329,6 +329,16 @@ static inline unsigned int crypto_ahash_digestsize(struct crypto_ahash *tfm) 
	return crypto_hash_alg_common(tfm)->digestsize;

}



/**

 * crypto_ahash_statesize() - obtain size of the ahash state

 * @tfm: cipher handle

 *

 * Return the size of the ahash state. With the crypto_ahash_export()

 * function, the caller can export the state into a buffer whose size is

 * defined with this function.

 *

 * Return: size of the ahash state

 */

static inline unsigned int crypto_ahash_statesize(struct crypto_ahash *tfm)

{

	return crypto_hash_alg_common(tfm)->statesize;
@@ -369,11 +379,7 @@ static inline struct crypto_ahash *crypto_ahash_reqtfm( 
 * crypto_ahash_reqsize() - obtain size of the request data structure

 * @tfm: cipher handle

 *

 * Return the size of the ahash state size. With the crypto_ahash_export

 * function, the caller can export the state into a buffer whose size is

 * defined with this function.

 *

 * Return: size of the ahash state

 * Return: size of the request data

 */

static inline unsigned int crypto_ahash_reqsize(struct crypto_ahash *tfm)

{
@@ -453,7 +459,7 @@ int crypto_ahash_digest(struct ahash_request *req); 
 *

 * This function exports the hash state of the ahash_request handle into the

 * caller-allocated output buffer out which must have sufficient size (e.g. by

 * calling crypto_ahash_reqsize).

 * calling crypto_ahash_statesize()).

 *

 * Return: 0 if the export was successful; < 0 if an error occurred

 */