Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   "Fabio M. De Francesco" <fmdefrancesco@gmail.com>
To:     Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        linux-staging@lists.linux.dev, linux-kernel@vger.kernel.org,
        outreachy@lists.linux.dev, Rebecca Mckeever <remckee0@gmail.com>
Subject: Re: [PATCH] staging: rtl8192u: change get_key functions to return 0 instead of -1
Date:   Wed, 20 Apr 2022 16:52:36 +0200
Message-ID: <3183776.G96rZvMJ2N@leap>
In-Reply-To: <Yl/7QPKXer7YtXOs@bertie>
References: <Yl/7QPKXer7YtXOs@bertie>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Content-Type: text/plain; charset="utf-8"
Precedence: bulk

On mercoled=C3=AC 20 aprile 2022 14:23:28 CEST Rebecca Mckeever wrote:
> Currently, these three get_key functions return -1 when the provided len
> value is less a specific key length value, which can result in buffer
> overflow depending on how the returned value is used. These functions are
> used in three places in ieee80211/ieee80211_wx.c:
>=20
>   ieee80211_wx_get_encode() :
>     The behavior of this function will be unchanged.
>=20
>   ieee80211_wx_get_encode_ext() :
>     The result of the get_key function is written to ext->key_len,
>     resulting in a buffer overflow if the result is negative.
>=20
>   ieee80211_wx_set_encode() :
>     The behavior of this function will change. When len is less than the
>     key length value, it will set a default key of all 0.
>=20
> Suggested-by: Dan Carpenter <dan.carpenter@oracle.com>
> Signed-off-by: Rebecca Mckeever <remckee0@gmail.com>
> ---
>  drivers/staging/rtl8192u/ieee80211/ieee80211_crypt_ccmp.c | 2 +-
>  drivers/staging/rtl8192u/ieee80211/ieee80211_crypt_tkip.c | 2 +-
>  drivers/staging/rtl8192u/ieee80211/ieee80211_crypt_wep.c  | 2 +-
>  3 files changed, 3 insertions(+), 3 deletions(-)

I was not able to find the message where Dan suggested this solution.=20
However it looks that we actually have problems in those callers when they=
=20
get '-1' as the return code.

I didn't look at the code with much attention but I think that returning=20
'0' to signal errors is not so good.

If I'm not missing something from the context, I'd rather return '-EINVAL'=
=20
and change the callers to check for this specific error that would signal=20
we have "len less than a specific len value". If so, act in accordance to=20
the returned -EINVAL.

=46or example, in a caller you may test:

if (ext->key_len =3D=3D -EINVAL || <some other test, if required>)
        <error path>
<success path>

Just my thoughts, but, as I said, I haven't checked carefully neither the=20
callers nor the called functions. Maybe that returning '0' is the better=20
solution, but it usually means that we have no errors.=20

However, I'm 100% sure that, if Dan suggested this specific solution, there=
=20
must be good reasons behind. If so, your changes are good :)

Thanks,

=46abio M. De Francesco

>=20
> diff --git a/drivers/staging/rtl8192u/ieee80211/ieee80211_crypt_ccmp.c b/
drivers/staging/rtl8192u/ieee80211/ieee80211_crypt_ccmp.c
> index 101c28265e91..f17d07dad56d 100644
> --- a/drivers/staging/rtl8192u/ieee80211/ieee80211_crypt_ccmp.c
> +++ b/drivers/staging/rtl8192u/ieee80211/ieee80211_crypt_ccmp.c
> @@ -362,7 +362,7 @@ static int ieee80211_ccmp_get_key(void *key, int len,=
=20
u8 *seq, void *priv)
>  	struct ieee80211_ccmp_data *data =3D priv;
> =20
>  	if (len < CCMP_TK_LEN)
> -		return -1;
> +		return 0;
> =20
>  	if (!data->key_set)
>  		return 0;
> diff --git a/drivers/staging/rtl8192u/ieee80211/ieee80211_crypt_tkip.c b/
drivers/staging/rtl8192u/ieee80211/ieee80211_crypt_tkip.c
> index 689d8843f538..7b120b8cb982 100644
> --- a/drivers/staging/rtl8192u/ieee80211/ieee80211_crypt_tkip.c
> +++ b/drivers/staging/rtl8192u/ieee80211/ieee80211_crypt_tkip.c
> @@ -637,7 +637,7 @@ static int ieee80211_tkip_get_key(void *key, int len,=
=20
u8 *seq, void *priv)
>  	struct ieee80211_tkip_data *tkey =3D priv;
> =20
>  	if (len < TKIP_KEY_LEN)
> -		return -1;
> +		return 0;
> =20
>  	if (!tkey->key_set)
>  		return 0;
> diff --git a/drivers/staging/rtl8192u/ieee80211/ieee80211_crypt_wep.c b/
drivers/staging/rtl8192u/ieee80211/ieee80211_crypt_wep.c
> index 8a51ea1dd6e5..a2cdf3bfd1a4 100644
> --- a/drivers/staging/rtl8192u/ieee80211/ieee80211_crypt_wep.c
> +++ b/drivers/staging/rtl8192u/ieee80211/ieee80211_crypt_wep.c
> @@ -201,7 +201,7 @@ static int prism2_wep_get_key(void *key, int len, u8=
=20
*seq, void *priv)
>  	struct prism2_wep_data *wep =3D priv;
> =20
>  	if (len < wep->key_len)
> -		return -1;
> +		return 0;
> =20
>  	memcpy(key, wep->key, wep->key_len);
> =20
> --=20
> 2.32.0
>=20
>=20
>=20