doc: add cryptodev gcm iv deprecation notice

Message ID 20190417074113.10896-1-arkadiuszx.kusztal@intel.com
State Accepted, archived
Delegated to: akhil goyal
Headers show
Series
  • doc: add cryptodev gcm iv deprecation notice
Related show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Arek Kusztal April 17, 2019, 7:41 a.m.
This patch adds deprecation notice of changing iv behaviour
when using Galois Counter Mode of operation. Right now IV of
all supported sizes can be used.

Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Trahe, Fiona April 17, 2019, 11:32 a.m. | #1
> -----Original Message-----
> From: Kusztal, ArkadiuszX
> Sent: Wednesday, April 17, 2019 8:41 AM
> To: dev@dpdk.org
> Cc: akhil.goyal@nxp.com; Trahe, Fiona <fiona.trahe@intel.com>; De Lara Guarch, Pablo
> <pablo.de.lara.guarch@intel.com>; Kusztal, ArkadiuszX <arkadiuszx.kusztal@intel.com>
> Subject: [PATCH] doc: add cryptodev gcm iv deprecation notice
> 
> This patch adds deprecation notice of changing iv behaviour
> when using Galois Counter Mode of operation. Right now IV of
> all supported sizes can be used.
[Fiona] nit - I would say "With this change..." rather than "Right now..."
Apart from this
Acked-by: Fiona Trahe <fiona.trahe@intel.com>


> 
> Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index ba39c2d..76eb166 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -87,3 +87,9 @@ Deprecation Notices
>  * cryptodev: the ``uint8_t *data`` member of ``key`` structure in the xforms
>    structure (``rte_crypto_cipher_xform``, ``rte_crypto_auth_xform``, and
>    ``rte_crypto_aead_xform``) will be changed to ``const uint8_t *data``.
> +
> +* cryptodev: support for using IV with all sizes is added, J0 still can
> +  be used but only when IV length in following structs ``rte_crypto_auth_xform``,
> +  ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or equal
> +  to one it means it represents IV, when is set to zero it means J0 is used
> +  directly, in this case 16 bytes of J0 need to be passed.
> --
> 2.1.0
De Lara Guarch, Pablo May 8, 2019, 8:23 a.m. | #2
> -----Original Message-----
> From: Kusztal, ArkadiuszX
> Sent: Wednesday, April 17, 2019 8:41 AM
> To: dev@dpdk.org
> Cc: akhil.goyal@nxp.com; Trahe, Fiona <fiona.trahe@intel.com>; De Lara
> Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Kusztal, ArkadiuszX
> <arkadiuszx.kusztal@intel.com>
> Subject: [PATCH] doc: add cryptodev gcm iv deprecation notice
> 
> This patch adds deprecation notice of changing iv behaviour when using
> Galois Counter Mode of operation. Right now IV of all supported sizes can
> be used.
> 
> Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>

Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>

Also, I am CC'ing Anoob, since he acked the patch that is actually making changes in the comments of the API,
so I assume he agrees with this patch (needed for the other patch).
Akhil Goyal May 9, 2019, 9:03 a.m. | #3
> -----Original Message-----
> From: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> Sent: Wednesday, May 8, 2019 1:53 PM
> To: Kusztal, ArkadiuszX <arkadiuszx.kusztal@intel.com>; dev@dpdk.org
> Cc: Akhil Goyal <akhil.goyal@nxp.com>; Trahe, Fiona <fiona.trahe@intel.com>;
> Anoob Joseph <anoobj@marvell.com>
> Subject: RE: [PATCH] doc: add cryptodev gcm iv deprecation notice
> 
> 
> 
> > -----Original Message-----
> > From: Kusztal, ArkadiuszX
> > Sent: Wednesday, April 17, 2019 8:41 AM
> > To: dev@dpdk.org
> > Cc: akhil.goyal@nxp.com; Trahe, Fiona <fiona.trahe@intel.com>; De Lara
> > Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Kusztal, ArkadiuszX
> > <arkadiuszx.kusztal@intel.com>
> > Subject: [PATCH] doc: add cryptodev gcm iv deprecation notice
> >
> > This patch adds deprecation notice of changing iv behaviour when using
> > Galois Counter Mode of operation. Right now IV of all supported sizes can
> > be used.
> >
> > Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>
> 
> Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
> 
> Also, I am CC'ing Anoob, since he acked the patch that is actually making
> changes in the comments of the API,
> so I assume he agrees with this patch (needed for the other patch).

Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
Anoob Joseph May 9, 2019, 11:31 a.m. | #4
> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Arek Kusztal
> Sent: Wednesday, April 17, 2019 1:11 PM
> To: dev@dpdk.org
> Cc: akhil.goyal@nxp.com; fiona.trahe@intel.com;
> pablo.de.lara.guarch@intel.com; Arek Kusztal
> <arkadiuszx.kusztal@intel.com>
> Subject: [dpdk-dev] [PATCH] doc: add cryptodev gcm iv deprecation notice
> 
> This patch adds deprecation notice of changing iv behaviour when using
> Galois Counter Mode of operation. Right now IV of all supported sizes can be
> used.
> 
> Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>

Acked-by: Anoob Joseph <anoobj@marvell.com>
Thomas Monjalon May 13, 2019, 9:25 p.m. | #5
> > This patch adds deprecation notice of changing iv behaviour
> > when using Galois Counter Mode of operation. Right now IV of
> > all supported sizes can be used.
> [Fiona] nit - I would say "With this change..." rather than "Right now..."
> Apart from this
> Acked-by: Fiona Trahe <fiona.trahe@intel.com>

Updated and applied, thanks

> > Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>
Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
Acked-by: Anoob Joseph <anoobj@marvell.com>

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index ba39c2d..76eb166 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -87,3 +87,9 @@  Deprecation Notices
 * cryptodev: the ``uint8_t *data`` member of ``key`` structure in the xforms
   structure (``rte_crypto_cipher_xform``, ``rte_crypto_auth_xform``, and
   ``rte_crypto_aead_xform``) will be changed to ``const uint8_t *data``.
+
+* cryptodev: support for using IV with all sizes is added, J0 still can
+  be used but only when IV length in following structs ``rte_crypto_auth_xform``,
+  ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or equal
+  to one it means it represents IV, when is set to zero it means J0 is used
+  directly, in this case 16 bytes of J0 need to be passed.