Skip to contentSkip to conversation

doc: release note for the IPsec library

PATCH Superseded Bernard Iremonger 3 participants 12 messages Jul 25, 2019 – Jul 26, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: release note for the IPsec library

Update release notes for changes to the IPsec library.

---
 doc/guides/rel_notes/release_19_08.rst | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)
doc/guides/rel_notes/release_19_08.rst +15 -1
index c9bd3ce..020a8ed 100644
@@ -224,6 +224,20 @@ New Features
 
   Added multiple cores feature to compression perf tool application.
 
+* **Updated the IPsec library.**
+
+  Added missing functionality for IPsec RFC's (4301, 403, 7321) compliance.
+
+  * Added support for transport mode with IPv6 extension headers.
+
+  * Added support for SA lifetime (soft/hard limit bytes/time).
+
+  * Expanded IV generation code to make it complain with particular algorithm
+    requirements (CBC, GCM, etc.).
+
+  * Added support for RFC 4301, section 5.1.2. Header Construction for Tunnel
+    Mode.
+
 
 Removed Items
 -------------
@@ -384,7 +398,7 @@ The libraries prepended with a plus sign were incremented in this version.
      librte_gso.so.1
      librte_hash.so.2
      librte_ip_frag.so.1
-     librte_ipsec.so.1
+   + librte_ipsec.so.1
      librte_jobstats.so.1
      librte_kni.so.2
      librte_kvargs.so.1
Signature · 1 line
2.7.4
#1 lore raw

PATCH v2 1/1 doc: release note for the IPsec library

Update release notes for changes to the IPsec library.

---
changes in v2:
revised content.

 doc/guides/rel_notes/release_19_08.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
doc/guides/rel_notes/release_19_08.rst +8 -0
index c9bd3ce..35b633e 100644
@@ -224,6 +224,14 @@ New Features
 
   Added multiple cores feature to compression perf tool application.
 
+* **Updated the IPsec library.**
+
+  Added missing functionality to ``librte_ipsec``.
+
+  * Added support for transport mode with IPv6 extension headers.
+
+  * Added support for packets that consist of multiple segments.
+
 
 Removed Items
 -------------
Signature · 1 line
2.7.4
#2 lore raw

PATCH v3 1/1 doc: release note for the IPsec library

Update release notes for changes to the IPsec library.

---
changes in v3:
revised content

 doc/guides/rel_notes/release_19_08.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
doc/guides/rel_notes/release_19_08.rst +8 -0
index c9bd3ce..7737ebe 100644
@@ -224,6 +224,14 @@ New Features
 
   Added multiple cores feature to compression perf tool application.
 
+* **Updated the IPsec library.**
+
+  Added the following functionality to ``librte_ipsec``.
+
+  * Added support for transport mode with IPv6 extension headers.
+
+  * Added support for packets that consist of multiple segments.
+
 
 Removed Items
 -------------
Signature · 1 line
2.7.4
Acked-by on v3 1/1
#3 lore raw
Quoted 30 lines

-----Original Message-----
From: Iremonger, Bernard
Sent: Thursday, July 25, 2019 3:39 PM
To: [email protected]; Ananyev, Konstantin <[email protected]>; [email protected]; Mcnamara, John <[email protected]>
Cc: Iremonger, Bernard <[email protected]>
Subject: [PATCH v3] doc: release note for the IPsec library

Update release notes for changes to the IPsec library.

---
changes in v3:
revised content

 doc/guides/rel_notes/release_19_08.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
doc/guides/rel_notes/release_19_08.rst +2 -0
index c9bd3ce..7737ebe 100644
@@ -224,6 +224,14 @@ New Features
 
   Added multiple cores feature to compression perf tool application.
 
+* **Updated the IPsec library.**
+

doc/guides/rel_notes/release_19_08.rst New Features

Quoted 10 lines
doc/guides/rel_notes/release_19_08.rst +6 -1
+  Added the following functionality to ``librte_ipsec``.
+
+  * Added support for transport mode with IPv6 extension headers.
+
+  * Added support for packets that consist of multiple segments.
+
 
 Removed Items
 -------------
--
Quoted 1 line

2.7.4

#4 lore raw
In reply to Bernard Iremonger

Hi Bernard,

Quoted 19 lines

Update release notes for changes to the IPsec library.

---
changes in v3:
revised content

 doc/guides/rel_notes/release_19_08.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
doc/guides/rel_notes/release_19_08.rst +0 -0
index c9bd3ce..7737ebe 100644
@@ -224,6 +224,14 @@ New Features
 
   Added multiple cores feature to compression perf tool application.

doc/guides/rel_notes/release_19_08.rst New Features · line 235

Quoted 10 lines
doc/guides/rel_notes/release_19_08.rst +8 -0
 
+* **Updated the IPsec library.**
+
+  Added the following functionality to ``librte_ipsec``.
+
+  * Added support for transport mode with IPv6 extension headers.
+
+  * Added support for packets that consist of multiple segments.
+
 

Ipsec library changes are already there in the release note. Could you please consolidate all changes in ipsec lib in a single bullet.

Also the ipsec-secgw application changes can also be there in that single bullet. As the features are same for ipsec lib and ipsec application.

So I would say, we can combine the two commits in a single bullet already there in the release note for header reconstruction.
http://patches.dpdk.org/patch/57122/
http://patches.dpdk.org/patch/57124/

-Akhil

#5 lore raw

Hi Akhil,

Quoted 46 lines

-----Original Message-----
From: Akhil Goyal [mailto:[email protected]]
Sent: Friday, July 26, 2019 11:27 AM
To: Iremonger, Bernard <[email protected]>; [email protected]; Ananyev, Konstantin <[email protected]>; Mcnamara, John <[email protected]>
Subject: RE: [PATCH v3] doc: release note for the IPsec library

Hi Bernard,

Quoted 19 lines

Update release notes for changes to the IPsec library.

---
changes in v3:
revised content

 doc/guides/rel_notes/release_19_08.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
doc/guides/rel_notes/release_19_08.rst +0 -0
index c9bd3ce..7737ebe 100644
@@ -224,6 +224,14 @@ New Features
 
   Added multiple cores feature to compression perf tool application.

doc/guides/rel_notes/release_19_08.rst New Features · line 235

Quoted 10 lines
doc/guides/rel_notes/release_19_08.rst +8 -0
 
+* **Updated the IPsec library.**
+
+  Added the following functionality to ``librte_ipsec``.
+
+  * Added support for transport mode with IPv6 extension headers.
+
+  * Added support for packets that consist of multiple segments.
+
 

Ipsec library changes are already there in the release note. Could you please consolidate all changes in ipsec lib in a single bullet.

Also the ipsec-secgw application changes can also be there in that single bullet. As the features are same for ipsec lib and ipsec application.

Quoted 7 lines

So I would say, we can combine the two commits in a single bullet already there in the release note for header reconstruction.
http://patches.dpdk.org/patch/57122/
http://patches.dpdk.org/patch/57124/

-Akhil

I will update existing bullet with info in patches 57122 and 57124.

Regards,

Bernard.

#6 lore raw

PATCH v4 1/1 doc: release note for the IPsec library and application

In reply to Bernard Iremonger

Update release notes for changes to the IPsec library.
Update release notes for changes to the IPsec Security Gateway application

---
 doc/guides/rel_notes/release_19_08.rst | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)
doc/guides/rel_notes/release_19_08.rst +13 -4
index c9bd3ce..48319be 100644
@@ -200,11 +200,20 @@ New Features
   handshake between two separate hosts and can share local memory for peer
   host to directly access.
 
-* **Updated IPSec library Header Reconstruction.**
+* **Updated IPSec library and IPsec Security Gateway application.**
 
-  Updated the IPSec library with ECN and DSCP field header reconstruction
-  feature followed by RFC4301. The IPSec-secgw sample application is also
-  updated to support this feature by default.
+  Added the following functionality to ``librte_ipsec`` and ``ipsec-secgw``
+
+  * Updated ``librte_ipsec`` with ECN and DSCP field header reconstruction
+    feature followed by RFC4301.
+
+  * Added support for transport mode with IPv6 extension headers to
+    ``librte_ipsec``.
+
+  * Added support for packets that consist of multiple segments to
+    ``librte_ipsec``.
+
+  * Updated the ``ipsec-secgw`` sample application to support these features.
 
 * **Updated telemetry library for global metrics support.**
 
Signature · 1 line
2.7.4
#7 lore raw

Re: [dpdk-dev] [PATCH v4] doc: release note for the IPsec library and application

Quoted 4 lines

Update release notes for changes to the IPsec library.
Update release notes for changes to the IPsec Security Gateway application

Description and the release note updates use redundant words which can be avoided. It could be something like

"Update release notes for recently supported features in ipsec lib and application."

Quoted 12 lines
---
 doc/guides/rel_notes/release_19_08.rst | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)
doc/guides/rel_notes/release_19_08.rst +0 -0
index c9bd3ce..48319be 100644

doc/guides/rel_notes/release_19_08.rst New Features · line 205

Quoted 10 lines
doc/guides/rel_notes/release_19_08.rst +2 -4
@@ -200,11 +200,20 @@ New Features
   handshake between two separate hosts and can share local memory for peer
   host to directly access.
 
-* **Updated IPSec library Header Reconstruction.**
+* **Updated IPSec library and IPsec Security Gateway application.**
 
-  Updated the IPSec library with ECN and DSCP field header reconstruction
-  feature followed by RFC4301. The IPSec-secgw sample application is also
-  updated to support this feature by default.
+  Added the following functionality to ``librte_ipsec`` and ``ipsec-secgw``

Added following features to ``librte_ipsec``. Corresponding changes are also added in ``ipsec-secgw`` sample application.

doc/guides/rel_notes/release_19_08.rst New Features · line 208

Quoted 3 lines
doc/guides/rel_notes/release_19_08.rst +3 -0
+
+  * Updated ``librte_ipsec`` with ECN and DSCP field header reconstruction
+    feature followed by RFC4301.

* ECN and DSCP field header reconstruction as per RFC4301

doc/guides/rel_notes/release_19_08.rst New Features · line 211

Quoted 3 lines
doc/guides/rel_notes/release_19_08.rst +3 -0
+
+  * Added support for transport mode with IPv6 extension headers to
+    ``librte_ipsec``.

* Transport mode with IPv6 extension headers

doc/guides/rel_notes/release_19_08.rst New Features · line 214

Quoted 3 lines
doc/guides/rel_notes/release_19_08.rst +3 -0
+
+  * Added support for packets that consist of multiple segments to
+    ``librte_ipsec``.

* Support packets with multiple segments.

doc/guides/rel_notes/release_19_08.rst New Features · line 216

Quoted 3 lines
doc/guides/rel_notes/release_19_08.rst +2 -0
+
 
+  * Updated the ``ipsec-secgw`` sample application to support these features.

This bullet can be removed.

doc/guides/rel_notes/release_19_08.rst New Features · line 219

Quoted 3 lines
doc/guides/rel_notes/release_19_08.rst +0 -0
 * **Updated telemetry library for global metrics support.**
 

-Akhil

#8 lore raw

Re: [dpdk-dev] [PATCH v4] doc: release note for the IPsec library and application

Hi Akhil,

Quoted 12 lines

-----Original Message-----
From: Akhil Goyal [mailto:[email protected]]
Sent: Friday, July 26, 2019 1:36 PM
To: Iremonger, Bernard <[email protected]>; [email protected]; Ananyev, Konstantin <[email protected]>; Mcnamara, John <[email protected]>; Zhang, Roy Fan <[email protected]>
Subject: RE: [PATCH v4] doc: release note for the IPsec library and application

Quoted 3 lines

Update release notes for changes to the IPsec library. Update release notes for changes to the IPsec Security Gateway

Quoted 8 lines

application

Description and the release note updates use redundant words which can be avoided.
It could be something like

"Update release notes for recently supported features in ipsec lib and application."

Ok, will change.

Quoted 18 lines

doc/guides/rel_notes/release_19_08.rst New Features · line 200

Quoted 12 lines
---
 doc/guides/rel_notes/release_19_08.rst | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)
doc/guides/rel_notes/release_19_08.rst +0 -0
index c9bd3ce..48319be 100644
@@ -200,11 +200,20 @@ New Features
   handshake between two separate hosts and can share local memory for

peer

Quoted 5 lines
doc/guides/rel_notes/release_19_08.rst +1 -1
   host to directly access.
 
-* **Updated IPSec library Header Reconstruction.**
+* **Updated IPSec library and IPsec Security Gateway application.**
 
Quoted 7 lines

doc/guides/rel_notes/release_19_08.rst New Features · line 205

Quoted 4 lines
doc/guides/rel_notes/release_19_08.rst +1 -3
-  Updated the IPSec library with ECN and DSCP field header reconstruction
-  feature followed by RFC4301. The IPSec-secgw sample application is also
-  updated to support this feature by default.
+  Added the following functionality to ``librte_ipsec`` and ``ipsec-secgw``

Added following features to ``librte_ipsec``. Corresponding changes are also added in ``ipsec-secgw`` sample application.

Ok, will change.

Quoted 11 lines

doc/guides/rel_notes/release_19_08.rst New Features · line 208

Quoted 3 lines
doc/guides/rel_notes/release_19_08.rst +3 -0
+
+  * Updated ``librte_ipsec`` with ECN and DSCP field header reconstruction
+    feature followed by RFC4301.

* ECN and DSCP field header reconstruction as per RFC4301

doc/guides/rel_notes/release_19_08.rst New Features · line 211

Quoted 3 lines
doc/guides/rel_notes/release_19_08.rst +3 -0
+
+  * Added support for transport mode with IPv6 extension headers to
+    ``librte_ipsec``.

* Transport mode with IPv6 extension headers

Ok, will change

Quoted 6 lines

doc/guides/rel_notes/release_19_08.rst New Features · line 214

Quoted 3 lines
doc/guides/rel_notes/release_19_08.rst +3 -0
+
+  * Added support for packets that consist of multiple segments to
+    ``librte_ipsec``.

* Support packets with multiple segments.

Ok, will change.

Quoted 6 lines

doc/guides/rel_notes/release_19_08.rst New Features

Quoted 3 lines
doc/guides/rel_notes/release_19_08.rst +2 -0
+
 
+  * Updated the ``ipsec-secgw`` sample application to support these

features.

This bullet can be removed.

Ok, will remove.

Quoted 5 lines

doc/guides/rel_notes/release_19_08.rst New Features · line 219

Quoted 3 lines
doc/guides/rel_notes/release_19_08.rst +0 -0
 * **Updated telemetry library for global metrics support.**
 

-Akhil

Regards,

Bernard.

#9 lore raw

PATCH v5 1/1 doc: release note for the IPsec library and application

In reply to Bernard Iremonger

Update release notes for recently supported features in IPsec library and IPsec Security Gateway application.

---
 doc/guides/rel_notes/release_19_08.rst | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)
doc/guides/rel_notes/release_19_08.rst +9 -4
index c9bd3ce..0457ab2 100644
@@ -200,11 +200,16 @@ New Features
   handshake between two separate hosts and can share local memory for peer
   host to directly access.
 
-* **Updated IPSec library Header Reconstruction.**
+* **Updated IPSec library and IPsec Security Gateway application.**
 
-  Updated the IPSec library with ECN and DSCP field header reconstruction
-  feature followed by RFC4301. The IPSec-secgw sample application is also
-  updated to support this feature by default.
+  Added the following features to ``librte_ipsec``. Corresponding changes are
+  also added in ``ipsec-secgw`` sample application
+
+  * ECN and DSCP field header reconstruction as per RFC4301.
+
+  * Transport mode with IPv6 extension headers.
+
+  * Support packets with multiple segments.
 
 * **Updated telemetry library for global metrics support.**
 
Signature · 1 line
2.7.4
Acked-by on v5 1/1
#10 lore raw

Re: [dpdk-dev] [PATCH v5] doc: release note for the IPsec library and application

Quoted 10 lines

Update release notes for recently supported features in IPsec library and IPsec Security Gateway application.

---
 doc/guides/rel_notes/release_19_08.rst | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)
Applied
#11 lore raw

Re: [dpdk-dev] [PATCH v5] doc: release note for the IPsec library and application

Quoted 11 lines
Quoted 10 lines

Update release notes for recently supported features in IPsec library and IPsec Security Gateway application.

---
 doc/guides/rel_notes/release_19_08.rst | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

Applied to dpdk-next-crypto

Thanks.