linux-kernel - Re: [PATCH 28/31] fs: ecryptfs: crypto: Supply some missing param descriptions and demote abuses

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]

Message-ID: <20210418171700.GA398325@elm>
Date:   Sun, 18 Apr 2021 12:17:00 -0500
From:   Tyler Hicks <code@...icks.com>
To:     Lee Jones <lee.jones@...aro.org>
Cc:     linux-kernel@...r.kernel.org, Eric Biggers <ebiggers@...gle.com>,
        "Michael A. Halcrow" <mahalcro@...ibm.com>,
        "Michael C. Thompson" <mcthomps@...ibm.com>,
        ecryptfs@...r.kernel.org
Subject: Re: [PATCH 28/31] fs: ecryptfs: crypto: Supply some missing param
 descriptions and demote abuses

On 2021-03-30 17:44:55, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
> 
>  fs/ecryptfs/crypto.c:29: warning: expecting prototype for eCryptfs(). Prototype was for DECRYPT() instead
>  fs/ecryptfs/crypto.c:360: warning: Function parameter or member 'crypt_stat' not described in 'lower_offset_for_page'
>  fs/ecryptfs/crypto.c:360: warning: Function parameter or member 'page' not described in 'lower_offset_for_page'
>  fs/ecryptfs/crypto.c:637: warning: Function parameter or member 'crypt_stat' not described in 'ecryptfs_compute_root_iv'
>  fs/ecryptfs/crypto.c:1386: warning: Function parameter or member 'ecryptfs_dentry' not described in 'ecryptfs_read_metadata'
>  fs/ecryptfs/crypto.c:1463: warning: Function parameter or member 'filename' not described in 'ecryptfs_encrypt_filename'
>  fs/ecryptfs/crypto.c:1463: warning: Function parameter or member 'mount_crypt_stat' not described in 'ecryptfs_encrypt_filename'
>  fs/ecryptfs/crypto.c:1897: warning: Function parameter or member 'encoded_name_size' not described in 'ecryptfs_encrypt_and_encode_filename'
>  fs/ecryptfs/crypto.c:1897: warning: Function parameter or member 'mount_crypt_stat' not described in 'ecryptfs_encrypt_and_encode_filename'
>  fs/ecryptfs/crypto.c:1897: warning: Function parameter or member 'name_size' not described in 'ecryptfs_encrypt_and_encode_filename'
>  fs/ecryptfs/crypto.c:1897: warning: Excess function parameter 'crypt_stat' description in 'ecryptfs_encrypt_and_encode_filename'
>  fs/ecryptfs/crypto.c:1897: warning: Excess function parameter 'length' description in 'ecryptfs_encrypt_and_encode_filename'
>  fs/ecryptfs/crypto.c:2006: warning: Function parameter or member 'sb' not described in 'ecryptfs_decode_and_decrypt_filename'
>  fs/ecryptfs/crypto.c:2006: warning: Excess function parameter 'ecryptfs_dir_dentry' description in 'ecryptfs_decode_and_decrypt_filename'
> 
> Cc: Tyler Hicks <code@...icks.com>
> Cc: Eric Biggers <ebiggers@...gle.com>
> Cc: "Michael A. Halcrow" <mahalcro@...ibm.com>
> Cc: "Michael C. Thompson" <mcthomps@...ibm.com>
> Cc: ecryptfs@...r.kernel.org
> Signed-off-by: Lee Jones <lee.jones@...aro.org>
> ---
>  fs/ecryptfs/crypto.c | 20 ++++++++++----------
>  1 file changed, 10 insertions(+), 10 deletions(-)
> 
> diff --git a/fs/ecryptfs/crypto.c b/fs/ecryptfs/crypto.c
> index 7671412b8f0b4..cdcbcf7b5b6c7 100644
> --- a/fs/ecryptfs/crypto.c
> +++ b/fs/ecryptfs/crypto.c
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-or-later
> -/**
> +/*
>   * eCryptfs: Linux filesystem encryption layer
>   *
>   * Copyright (C) 1997-2004 Erez Zadok
> @@ -350,7 +350,7 @@ static int crypt_scatterlist(struct ecryptfs_crypt_stat *crypt_stat,
>  	return rc;
>  }
>  
> -/**
> +/*
>   * lower_offset_for_page
>   *
>   * Convert an eCryptfs page index into a lower byte offset
> @@ -627,9 +627,8 @@ void ecryptfs_set_default_sizes(struct ecryptfs_crypt_stat *crypt_stat)
>  	}
>  }
>  
> -/**
> +/*
>   * ecryptfs_compute_root_iv
> - * @crypt_stats
>   *
>   * On error, sets the root IV to all 0's.
>   */
> @@ -1370,7 +1369,7 @@ int ecryptfs_read_and_validate_xattr_region(struct dentry *dentry,
>  	return rc;
>  }
>  
> -/**
> +/*
>   * ecryptfs_read_metadata
>   *
>   * Common entry point for reading file metadata. From here, we could
> @@ -1448,7 +1447,7 @@ int ecryptfs_read_metadata(struct dentry *ecryptfs_dentry)
>  	return rc;
>  }
>  
> -/**
> +/*
>   * ecryptfs_encrypt_filename - encrypt filename
>   *
>   * CBC-encrypts the filename. We do not want to encrypt the same
> @@ -1876,10 +1875,11 @@ ecryptfs_decode_from_filename(unsigned char *dst, size_t *dst_size,
>  
>  /**
>   * ecryptfs_encrypt_and_encode_filename - converts a plaintext file name to cipher text
> - * @crypt_stat: The crypt_stat struct associated with the file anem to encode
> + * @encoded_name: The encrypted name
> + * @encoded_name_size: Length of the encrypted name
> + * @mount_crypt_stat: The crypt_stat struct associated with the file anem to encode

s/anem/name/

I'll fix this up when applying.

Tyler

>   * @name: The plaintext name
> - * @length: The length of the plaintext
> - * @encoded_name: The encypted name
> + * @name_size: The length of the plaintext name
>   *
>   * Encrypts and encodes a filename into something that constitutes a
>   * valid filename for a filesystem, with printable characters.
> @@ -1991,7 +1991,7 @@ static bool is_dot_dotdot(const char *name, size_t name_size)
>   * ecryptfs_decode_and_decrypt_filename - converts the encoded cipher text name to decoded plaintext
>   * @plaintext_name: The plaintext name
>   * @plaintext_name_size: The plaintext name size
> - * @ecryptfs_dir_dentry: eCryptfs directory dentry
> + * @sb: Ecryptfs's super_block
>   * @name: The filename in cipher text
>   * @name_size: The cipher text name size
>   *
> -- 
> 2.27.0
>