2022-03-28 06:30:17

by Xiaomeng Tong

[permalink] [raw]
Subject: [PATCH] nfs: callback_proc: fix an incorrect NULL check on list iterator

The bug is here:
if (!server ||
server->pnfs_curr_ld->id != dev->cbd_layout_type) {

The list iterator value 'server' will *always* be set and non-NULL
by list_for_each_entry_rcu, so it is incorrect to assume that the
iterator value will be NULL if the list is empty or no element is
found (In fact, it will be a bogus pointer to an invalid struct
object containing the HEAD, which is used for above check at next
outer loop). Otherwise it may bypass the check in theory (iif
server->pnfs_curr_ld->id == dev->cbd_layout_type, 'server' now is
a bogus pointer) and lead to invalid memory access passing the check.

To fix the bug, use a new variable 'iter' as the list iterator,
while use the original variable 'server' as a dedicated pointer to
point to the found element.

Cc: [email protected]
Fixes: 1be5683b03a76 ("pnfs: CB_NOTIFY_DEVICEID")
Signed-off-by: Xiaomeng Tong <[email protected]>
---
fs/nfs/callback_proc.c | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/fs/nfs/callback_proc.c b/fs/nfs/callback_proc.c
index c343666d9a42..84779785dc8d 100644
--- a/fs/nfs/callback_proc.c
+++ b/fs/nfs/callback_proc.c
@@ -361,7 +361,7 @@ __be32 nfs4_callback_devicenotify(void *argp, void *resp,
uint32_t i;
__be32 res = 0;
struct nfs_client *clp = cps->clp;
- struct nfs_server *server = NULL;
+ struct nfs_server *server = NULL, *iter;

if (!clp) {
res = cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION);
@@ -374,10 +374,11 @@ __be32 nfs4_callback_devicenotify(void *argp, void *resp,
if (!server ||
server->pnfs_curr_ld->id != dev->cbd_layout_type) {
rcu_read_lock();
- list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
- if (server->pnfs_curr_ld &&
- server->pnfs_curr_ld->id == dev->cbd_layout_type) {
+ list_for_each_entry_rcu(iter, &clp->cl_superblocks, client_link)
+ if (iter->pnfs_curr_ld &&
+ iter->pnfs_curr_ld->id == dev->cbd_layout_type) {
rcu_read_unlock();
+ server = iter;
goto found;
}
rcu_read_unlock();
--
2.17.1


2022-03-28 14:52:28

by Greg Kroah-Hartman

[permalink] [raw]
Subject: Re: [PATCH] nfs: callback_proc: fix an incorrect NULL check on list iterator

On Mon, Mar 28, 2022 at 01:24:57PM +0000, Trond Myklebust wrote:
> On Mon, 2022-03-28 at 09:43 +0800, Xiaomeng Tong wrote:
> > On Sun, 27 Mar 2022 15:20:42 +0000, Trond Myklebust wrote:
> > > On Sun, 2022-03-27 at 16:02 +0800, Xiaomeng Tong wrote:
> > > > The bug is here:
> > > > ??????? if (!server ||
> > > > ??????? server->pnfs_curr_ld->id != dev->cbd_layout_type) {
> > > >
> > > > The list iterator value 'server' will *always* be set and non-
> > > > NULL
> > > > by list_for_each_entry_rcu, so it is incorrect to assume that the
> > > > iterator value will be NULL if the list is empty or no element is
> > > > found (In fact, it will be a bogus pointer to an invalid struct
> > > > object containing the HEAD, which is used for above check at next
> > > > outer loop). Otherwise it may bypass the check in theory (iif
> > > > server->pnfs_curr_ld->id == dev->cbd_layout_type, 'server' now is
> > > > a bogus pointer) and lead to invalid memory access passing the
> > > > check.
> > > >
> > > > To fix the bug, use a new variable 'iter' as the list iterator,
> > > > while use the original variable 'server' as a dedicated pointer
> > > > to
> > > > point to the found element.
> > > >
> > > > Cc: [email protected]
> > > > Fixes: 1be5683b03a76 ("pnfs: CB_NOTIFY_DEVICEID")
> > > > Signed-off-by: Xiaomeng Tong <[email protected]>
> > > > ---
> > > > ?fs/nfs/callback_proc.c | 9 +++++----
> > > > ?1 file changed, 5 insertions(+), 4 deletions(-)
> > > >
> > > > diff --git a/fs/nfs/callback_proc.c b/fs/nfs/callback_proc.c
> > > > index c343666d9a42..84779785dc8d 100644
> > > > --- a/fs/nfs/callback_proc.c
> > > > +++ b/fs/nfs/callback_proc.c
> > > > @@ -361,7 +361,7 @@ __be32 nfs4_callback_devicenotify(void *argp,
> > > > void *resp,
> > > > ??????? uint32_t i;
> > > > ??????? __be32 res = 0;
> > > > ??????? struct nfs_client *clp = cps->clp;
> > > > -?????? struct nfs_server *server = NULL;
> > > > +?????? struct nfs_server *server = NULL, *iter;
> > > > ?
> > > > ??????? if (!clp) {
> > > > ??????????????? res = cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION);
> > > > @@ -374,10 +374,11 @@ __be32 nfs4_callback_devicenotify(void
> > > > *argp,
> > > > void *resp,
> > > > ??????????????? if (!server ||
> > > > ??????????????????? server->pnfs_curr_ld->id != dev-
> > > > >cbd_layout_type)
> > > > {
> > > > ??????????????????????? rcu_read_lock();
> > > > -?????????????????????? list_for_each_entry_rcu(server, &clp-
> > > > > cl_superblocks, client_link)
> > > > -?????????????????????????????? if (server->pnfs_curr_ld &&
> > > > -?????????????????????????????????? server->pnfs_curr_ld->id ==
> > > > dev-
> > > > > cbd_layout_type) {
> > > > +?????????????????????? list_for_each_entry_rcu(iter, &clp-
> > > > > cl_superblocks, client_link)
> > > > +?????????????????????????????? if (iter->pnfs_curr_ld &&
> > > > +?????????????????????????????????? iter->pnfs_curr_ld->id ==
> > > > dev-
> > > > > cbd_layout_type) {
> > > > ??????????????????????????????????????? rcu_read_unlock();
> > > > +?????????????????????????????????????? server = iter;
> > >
> > > Hmm... We're not holding any locks on the super block for 'iter'
> > > here,
> > > so nothing is preventing it from going away while we're.
> > >
> >
> > ok, i am not a 'rcu lock' expert, i will make it hold the
> > rcu_read_lock()
> > if necessary.
> >
> > > Given that we really only want a pointer to the struct
> > > pnfs_layoutdriver_type anyway, why not just convert the code to
> > > save a
> > > pointer to that (and do it while holding the rcu_read_lock())?
> > >
> >
> > Maybe it's not that simple. If you only save a pointer to that and
> > still
> > use 'server' as the list iterator of list_for_each_entry_rcu, there
> > could
> > be problem.
> >
> > I.e., if no element found in list_for_each_entry_rcu in the first
> > outer
> > 'for' loop, and now 'server' is a bogus pointer to an invalid struct,
> > and
> > continue to go into the second outer 'for' loop, and the check below
> > will
> > lead to invalid memory access (server->pnfs_curr_ld->id), even can
> > potentialy
> > be bypassed with crafted data to make the condition false and
> > mistakely run
> > nfs4_delete_deviceid(server->pnfs_curr_ld, clp, &dev->cbd_dev_id);
> > with bogus
> > 'server'.
> >
> > if (!server ||
> > ??? server->pnfs_curr_ld->id != dev->cbd_layout_type) {
> >
> > > The struct pnfs_layoutdriver is always expected to be a statically
> > > allocated structure, so it won't go away as long as the pNFS driver
> > > module remains loaded.
> >
>
>
> Let's just do the following.
>
> 8<-----------------------------------------------
> From 7c9d845f0612e5bcd23456a2ec43be8ac43458f1 Mon Sep 17 00:00:00 2001
> From: Trond Myklebust <[email protected]>
> Date: Mon, 28 Mar 2022 08:36:34 -0400
> Subject: [PATCH] NFSv4/pNFS: Fix another issue with a list iterator pointing
> to the head
>
> In nfs4_callback_devicenotify(), if we don't find a matching entry for
> the deviceid, we're left with a pointer to 'struct nfs_server' that
> actually points to the list of super blocks associated with our struct
> nfs_client.
> Furthermore, even if we have a valid pointer, nothing pins the super
> block, and so the struct nfs_server could end up getting freed while
> we're using it.
>
> Since all we want is a pointer to the struct pnfs_layoutdriver_type,
> let's skip all the iteration over super blocks, and just use APIs to
> find the layout driver directly.
>
> Reported-by: Xiaomeng Tong <[email protected]>
> Fixes: 1be5683b03a7 ("pnfs: CB_NOTIFY_DEVICEID")
> Signed-off-by: Trond Myklebust <[email protected]>
> ---
> fs/nfs/callback_proc.c | 27 +++++++++------------------
> fs/nfs/pnfs.c | 11 +++++++++++
> fs/nfs/pnfs.h | 2 ++
> 3 files changed, 22 insertions(+), 18 deletions(-)

<formletter>

This is not the correct way to submit patches for inclusion in the
stable kernel tree. Please read:
https://www.kernel.org/doc/html/latest/process/stable-kernel-rules.html
for how to do this properly.

</formletter>

2022-03-28 15:10:19

by Xiaomeng Tong

[permalink] [raw]
Subject: Re: [PATCH] nfs: callback_proc: fix an incorrect NULL check on list iterator

On Sun, 27 Mar 2022 15:20:42 +0000, Trond Myklebust wrote:
> On Sun, 2022-03-27 at 16:02 +0800, Xiaomeng Tong wrote:
> > The bug is here:
> > if (!server ||
> > server->pnfs_curr_ld->id != dev->cbd_layout_type) {
> >
> > The list iterator value 'server' will *always* be set and non-NULL
> > by list_for_each_entry_rcu, so it is incorrect to assume that the
> > iterator value will be NULL if the list is empty or no element is
> > found (In fact, it will be a bogus pointer to an invalid struct
> > object containing the HEAD, which is used for above check at next
> > outer loop). Otherwise it may bypass the check in theory (iif
> > server->pnfs_curr_ld->id == dev->cbd_layout_type, 'server' now is
> > a bogus pointer) and lead to invalid memory access passing the check.
> >
> > To fix the bug, use a new variable 'iter' as the list iterator,
> > while use the original variable 'server' as a dedicated pointer to
> > point to the found element.
> >
> > Cc: [email protected]
> > Fixes: 1be5683b03a76 ("pnfs: CB_NOTIFY_DEVICEID")
> > Signed-off-by: Xiaomeng Tong <[email protected]>
> > ---
> > fs/nfs/callback_proc.c | 9 +++++----
> > 1 file changed, 5 insertions(+), 4 deletions(-)
> >
> > diff --git a/fs/nfs/callback_proc.c b/fs/nfs/callback_proc.c
> > index c343666d9a42..84779785dc8d 100644
> > --- a/fs/nfs/callback_proc.c
> > +++ b/fs/nfs/callback_proc.c
> > @@ -361,7 +361,7 @@ __be32 nfs4_callback_devicenotify(void *argp,
> > void *resp,
> > uint32_t i;
> > __be32 res = 0;
> > struct nfs_client *clp = cps->clp;
> > - struct nfs_server *server = NULL;
> > + struct nfs_server *server = NULL, *iter;
> >
> > if (!clp) {
> > res = cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION);
> > @@ -374,10 +374,11 @@ __be32 nfs4_callback_devicenotify(void *argp,
> > void *resp,
> > if (!server ||
> > server->pnfs_curr_ld->id != dev->cbd_layout_type)
> > {
> > rcu_read_lock();
> > - list_for_each_entry_rcu(server, &clp-
> > >cl_superblocks, client_link)
> > - if (server->pnfs_curr_ld &&
> > - server->pnfs_curr_ld->id == dev-
> > >cbd_layout_type) {
> > + list_for_each_entry_rcu(iter, &clp-
> > >cl_superblocks, client_link)
> > + if (iter->pnfs_curr_ld &&
> > + iter->pnfs_curr_ld->id == dev-
> > >cbd_layout_type) {
> > rcu_read_unlock();
> > + server = iter;
>
> Hmm... We're not holding any locks on the super block for 'iter' here,
> so nothing is preventing it from going away while we're.
>

ok, i am not a 'rcu lock' expert, i will make it hold the rcu_read_lock()
if necessary.

> Given that we really only want a pointer to the struct
> pnfs_layoutdriver_type anyway, why not just convert the code to save a
> pointer to that (and do it while holding the rcu_read_lock())?
>

Maybe it's not that simple. If you only save a pointer to that and still
use 'server' as the list iterator of list_for_each_entry_rcu, there could
be problem.

I.e., if no element found in list_for_each_entry_rcu in the first outer
'for' loop, and now 'server' is a bogus pointer to an invalid struct, and
continue to go into the second outer 'for' loop, and the check below will
lead to invalid memory access (server->pnfs_curr_ld->id), even can potentialy
be bypassed with crafted data to make the condition false and mistakely run
nfs4_delete_deviceid(server->pnfs_curr_ld, clp, &dev->cbd_dev_id); with bogus
'server'.

if (!server ||
server->pnfs_curr_ld->id != dev->cbd_layout_type) {

> The struct pnfs_layoutdriver is always expected to be a statically
> allocated structure, so it won't go away as long as the pNFS driver
> module remains loaded.
>

--
Xiaomeng Tong