linux-kernel - Re: [PATCH 2/2] crypto: skcipher - remove excess kerneldoc members

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date: Sat, 23 Dec 2023 09:45:41 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Vegard Nossum <vegard.nossum@...cle.com>,
 Herbert Xu <herbert@...dor.apana.org.au>
Cc: "David S. Miller" <davem@...emloft.net>, linux-crypto@...r.kernel.org,
 linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 Jonathan Corbet <corbet@....net>
Subject: Re: [PATCH 2/2] crypto: skcipher - remove excess kerneldoc members



On 12/23/23 00:34, Vegard Nossum wrote:
> Commit 31865c4c4db2 ("crypto: skcipher - Add lskcipher") moved some
> fields from 'struct skcipher_alg' into SKCIPHER_ALG_COMMON but didn't
> remove the corresponding kerneldoc members, which results in these
> warnings when running 'make htmldocs':
> 
>   ./include/crypto/skcipher.h:182: warning: Excess struct member 'min_keysize' description in 'skcipher_alg'
>   ./include/crypto/skcipher.h:182: warning: Excess struct member 'max_keysize' description in 'skcipher_alg'
>   ./include/crypto/skcipher.h:182: warning: Excess struct member 'ivsize' description in 'skcipher_alg'
>   ./include/crypto/skcipher.h:182: warning: Excess struct member 'chunksize' description in 'skcipher_alg'
>   ./include/crypto/skcipher.h:182: warning: Excess struct member 'stat' description in 'skcipher_alg'
>   ./include/crypto/skcipher.h:182: warning: Excess struct member 'base' description in 'skcipher_alg'
> 
> SKCIPHER_ALG_COMMON already has the documentation for all these fields.
> 
> Fixes: 31865c4c4db2 ("crypto: skcipher - Add lskcipher")
> Cc: Randy Dunlap <rdunlap@...radead.org>
> Cc: Jonathan Corbet <corbet@....net>
> Signed-off-by: Vegard Nossum <vegard.nossum@...cle.com>

Reviewed-by: Randy Dunlap <rdunlap@...radead.org>
Tested-by: Randy Dunlap <rdunlap@...radead.org>

Thanks.

> ---
>  include/crypto/skcipher.h | 16 ----------------
>  1 file changed, 16 deletions(-)
> 
> diff --git a/include/crypto/skcipher.h b/include/crypto/skcipher.h
> index ea18af48346b..8831fcf8f1da 100644
> --- a/include/crypto/skcipher.h
> +++ b/include/crypto/skcipher.h
> @@ -108,16 +108,6 @@ struct skcipher_alg_common SKCIPHER_ALG_COMMON;
>  
>  /**
>   * struct skcipher_alg - symmetric key cipher definition
> - * @min_keysize: Minimum key size supported by the transformation. This is the
> - *		 smallest key length supported by this transformation algorithm.
> - *		 This must be set to one of the pre-defined values as this is
> - *		 not hardware specific. Possible values for this field can be
> - *		 found via git grep "_MIN_KEY_SIZE" include/crypto/
> - * @max_keysize: Maximum key size supported by the transformation. This is the
> - *		 largest key length supported by this transformation algorithm.
> - *		 This must be set to one of the pre-defined values as this is
> - *		 not hardware specific. Possible values for this field can be
> - *		 found via git grep "_MAX_KEY_SIZE" include/crypto/
>   * @setkey: Set key for the transformation. This function is used to either
>   *	    program a supplied key into the hardware or store the key in the
>   *	    transformation context for programming it later. Note that this
> @@ -152,15 +142,9 @@ struct skcipher_alg_common SKCIPHER_ALG_COMMON;
>   * @exit: Deinitialize the cryptographic transformation object. This is a
>   *	  counterpart to @init, used to remove various changes set in
>   *	  @init.
> - * @ivsize: IV size applicable for transformation. The consumer must provide an
> - *	    IV of exactly that size to perform the encrypt or decrypt operation.
> - * @chunksize: Equal to the block size except for stream ciphers such as
> - *	       CTR where it is set to the underlying block size.
>   * @walksize: Equal to the chunk size except in cases where the algorithm is
>   * 	      considerably more efficient if it can operate on multiple chunks
>   * 	      in parallel. Should be a multiple of chunksize.
> - * @stat: Statistics for cipher algorithm
> - * @base: Definition of a generic crypto algorithm.
>   * @co: see struct skcipher_alg_common
>   *
>   * All fields except @ivsize are mandatory and must be filled.

-- 
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html