[dpdk-dev] [PATCH] crypto: fix heap use after free bug

[dpdk-dev] [PATCH] crypto: fix heap use after free bug

[Ciara Power]

The PMD destroy function was calling the release function, which frees
cryptodev->data, and then tries to free cryptodev->data->dev_private,
which causes the heap use after free issue.

A temporary pointer is set before the free of cryptodev->data,
which can then be used afterwards to free dev_private.
The free cannot be moved to before the release function is called,
as dev_private is used in the QAT close function while being released.

Fixes: 9e6edea41805 ("cryptodev: add APIs to assist PMD initialisation")
Cc: declan.doherty@intel.com
Cc: stable@dpdk.org

Reported-by: ZhihongX Peng <zhihongx.peng@intel.com>
Signed-off-by: Ciara Power <ciara.power@intel.com>

---
The same issue is found in crypto/octeontx,
which may need to be addressed by maintainers.
Cc: Anoob Joseph <anoobj@marvell.com>
---
 lib/cryptodev/rte_cryptodev_pmd.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/lib/cryptodev/rte_cryptodev_pmd.c b/lib/cryptodev/rte_cryptodev_pmd.c
index 0912004127..900acd7ba4 100644
--- a/lib/cryptodev/rte_cryptodev_pmd.c
+++ b/lib/cryptodev/rte_cryptodev_pmd.c
@@ -140,6 +140,7 @@ int
 rte_cryptodev_pmd_destroy(struct rte_cryptodev *cryptodev)
 {
 	int retval;
+	void *tmp_dev_private = cryptodev->data->dev_private;
 
 	CDEV_LOG_INFO("Closing crypto device %s", cryptodev->device->name);
 
@@ -149,7 +150,7 @@ rte_cryptodev_pmd_destroy(struct rte_cryptodev *cryptodev)
 		return retval;
 
 	if (rte_eal_process_type() == RTE_PROC_PRIMARY)
-		rte_free(cryptodev->data->dev_private);
+		rte_free(tmp_dev_private);
 
 
 	cryptodev->device = NULL;
-- 
2.25.1

Re: [dpdk-dev] [EXT] [PATCH] crypto: fix heap use after free bug

[Akhil Goyal]

> The PMD destroy function was calling the release function, which frees
> cryptodev->data, and then tries to free cryptodev->data->dev_private,
> which causes the heap use after free issue.
> 
> A temporary pointer is set before the free of cryptodev->data,
> which can then be used afterwards to free dev_private.
> The free cannot be moved to before the release function is called,
> as dev_private is used in the QAT close function while being released.
> 
> Fixes: 9e6edea41805 ("cryptodev: add APIs to assist PMD initialisation")
> Cc: declan.doherty@intel.com
> Cc: stable@dpdk.org
> 
> Reported-by: ZhihongX Peng <zhihongx.peng@intel.com>
> Signed-off-by: Ciara Power <ciara.power@intel.com>
> 
> ---
> The same issue is found in crypto/octeontx,
> which may need to be addressed by maintainers.
> Cc: Anoob Joseph <anoobj@marvell.com>
> ---
>  lib/cryptodev/rte_cryptodev_pmd.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/lib/cryptodev/rte_cryptodev_pmd.c
> b/lib/cryptodev/rte_cryptodev_pmd.c
> index 0912004127..900acd7ba4 100644
> --- a/lib/cryptodev/rte_cryptodev_pmd.c
> +++ b/lib/cryptodev/rte_cryptodev_pmd.c
> @@ -140,6 +140,7 @@ int
>  rte_cryptodev_pmd_destroy(struct rte_cryptodev *cryptodev)
>  {
>  	int retval;
> +	void *tmp_dev_private = cryptodev->data->dev_private;

Can we rename this pointer as dev_private?

> 
>  	CDEV_LOG_INFO("Closing crypto device %s", cryptodev->device-
> >name);
> 
> @@ -149,7 +150,7 @@ rte_cryptodev_pmd_destroy(struct rte_cryptodev
> *cryptodev)
>  		return retval;
> 
>  	if (rte_eal_process_type() == RTE_PROC_PRIMARY)
> -		rte_free(cryptodev->data->dev_private);
> +		rte_free(tmp_dev_private);
> 
> 
>  	cryptodev->device = NULL;
> --
> 2.25.1

Re: [dpdk-dev] [EXT] [PATCH] crypto: fix heap use after free bug

[Akhil Goyal]

Fixed title
Cryptodev: fix heap use after free
> > The PMD destroy function was calling the release function, which frees
> > cryptodev->data, and then tries to free cryptodev->data->dev_private,
> > which causes the heap use after free issue.
> >
> > A temporary pointer is set before the free of cryptodev->data,
> > which can then be used afterwards to free dev_private.
> > The free cannot be moved to before the release function is called,
> > as dev_private is used in the QAT close function while being released.
I believe all PMDs use dev_private for close.
Hence replaces QAT with PMD
> >
> > Fixes: 9e6edea41805 ("cryptodev: add APIs to assist PMD initialisation")
> > Cc: declan.doherty@intel.com
> > Cc: stable@dpdk.org
> >
> > Reported-by: ZhihongX Peng <zhihongx.peng@intel.com>
> > Signed-off-by: Ciara Power <ciara.power@intel.com>
> >
> > ---
> > The same issue is found in crypto/octeontx,
> > which may need to be addressed by maintainers.
> > Cc: Anoob Joseph <anoobj@marvell.com>
> > ---
> >  lib/cryptodev/rte_cryptodev_pmd.c | 3 ++-
> >  1 file changed, 2 insertions(+), 1 deletion(-)
> >
> > diff --git a/lib/cryptodev/rte_cryptodev_pmd.c
> > b/lib/cryptodev/rte_cryptodev_pmd.c
> > index 0912004127..900acd7ba4 100644
> > --- a/lib/cryptodev/rte_cryptodev_pmd.c
> > +++ b/lib/cryptodev/rte_cryptodev_pmd.c
> > @@ -140,6 +140,7 @@ int
> >  rte_cryptodev_pmd_destroy(struct rte_cryptodev *cryptodev)
> >  {
> >  	int retval;
> > +	void *tmp_dev_private = cryptodev->data->dev_private;
> 
> Can we rename this pointer as dev_private?

Renamed this while merging, as we have RC3 deadline today.
> 
> >
> >  	CDEV_LOG_INFO("Closing crypto device %s", cryptodev->device-
> > >name);
> >
> > @@ -149,7 +150,7 @@ rte_cryptodev_pmd_destroy(struct rte_cryptodev
> > *cryptodev)
> >  		return retval;
> >
> >  	if (rte_eal_process_type() == RTE_PROC_PRIMARY)
> > -		rte_free(cryptodev->data->dev_private);
> > +		rte_free(tmp_dev_private);
> >
> >
> >  	cryptodev->device = NULL;
> > --
> > 2.25.1

Re: [dpdk-dev] [EXT] [PATCH] crypto: fix heap use after free bug

[Akhil Goyal]

> Fixed title
> Cryptodev: fix heap use after free
> > > The PMD destroy function was calling the release function, which frees
> > > cryptodev->data, and then tries to free cryptodev->data->dev_private,
> > > which causes the heap use after free issue.
> > >
> > > A temporary pointer is set before the free of cryptodev->data,
> > > which can then be used afterwards to free dev_private.
> > > The free cannot be moved to before the release function is called,
> > > as dev_private is used in the QAT close function while being released.
> I believe all PMDs use dev_private for close.
> Hence replaces QAT with PMD
> > >
> > > Fixes: 9e6edea41805 ("cryptodev: add APIs to assist PMD initialisation")
> > > Cc: declan.doherty@intel.com
> > > Cc: stable@dpdk.org
> > >
> > > Reported-by: ZhihongX Peng <zhihongx.peng@intel.com>
> > > Signed-off-by: Ciara Power <ciara.power@intel.com>
> > >
> > > ---
> > > The same issue is found in crypto/octeontx,
> > > which may need to be addressed by maintainers.
> > > Cc: Anoob Joseph <anoobj@marvell.com>
> > > ---
> > >  lib/cryptodev/rte_cryptodev_pmd.c | 3 ++-
> > >  1 file changed, 2 insertions(+), 1 deletion(-)
> > >
> > > diff --git a/lib/cryptodev/rte_cryptodev_pmd.c
> > > b/lib/cryptodev/rte_cryptodev_pmd.c
> > > index 0912004127..900acd7ba4 100644
> > > --- a/lib/cryptodev/rte_cryptodev_pmd.c
> > > +++ b/lib/cryptodev/rte_cryptodev_pmd.c
> > > @@ -140,6 +140,7 @@ int
> > >  rte_cryptodev_pmd_destroy(struct rte_cryptodev *cryptodev)
> > >  {
> > >  	int retval;
> > > +	void *tmp_dev_private = cryptodev->data->dev_private;
> >
> > Can we rename this pointer as dev_private?
> 
> Renamed this while merging, as we have RC3 deadline today.
> >
> > >
> > >  	CDEV_LOG_INFO("Closing crypto device %s", cryptodev->device-
> > > >name);
> > >
> > > @@ -149,7 +150,7 @@ rte_cryptodev_pmd_destroy(struct rte_cryptodev
> > > *cryptodev)
> > >  		return retval;
> > >
> > >  	if (rte_eal_process_type() == RTE_PROC_PRIMARY)
> > > -		rte_free(cryptodev->data->dev_private);
> > > +		rte_free(tmp_dev_private);
> > >
> > >
> > >  	cryptodev->device = NULL;

Acked-by: Akhil Goyal <gakhil@marvell.com>
Applied to dpdk-next-crypto