.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2020 NOKIA
+.. Copyright 2020-2021 NOKIA
+.. _release_notes:
+***************************************
+OOM Certification Service Release Notes
+***************************************
-Release Notes
-==============
-
-Version: 2.0.0
---------------
-
-:Release Date:
-
-**New Features**
-
- - The same functionality as in aaf-certservice 1.2.0
-
-**Bug Fixes**
+.. contents::
+ :depth: 2
+..
- N/A
-
-**Known Issues**
-
- N/A
-
-**Security Notes**
-
- N/A
+Version: 2.4.0
+==============
-*Fixed Security Issues*
+Abstract
+--------
- N/A
+This document provides the release notes for the Istanbul release.
-*Known Security Issues*
+Summary
+-------
- N/A
+Certificate update use case is now available. For details go to:
+:ref:`How to use instructions<how_to_use_certificate_update>`
-*Known Vulnerabilities in Used Modules*
+Release Data
+------------
- N/A
++--------------------------------------+---------------------------------------------------------------------------------------+
+| **Project** | OOM |
+| | |
++--------------------------------------+---------------------------------------------------------------------------------------+
+| **Docker images** | * onap/org.onap.oom.platform.cert-service.oom-certservice-api:2.4.0 |
+| | * onap/org.onap.oom.platform.cert-service.oom-certservice-post-processor:2.4.0 |
+| | * onap/org.onap.oom.platform.cert-service.oom-certservice-k8s-external-provider:2.4.0|
+| | |
++--------------------------------------+---------------------------------------------------------------------------------------+
+| **Release designation** | Istanbul |
+| | |
++--------------------------------------+---------------------------------------------------------------------------------------+
-**Upgrade Notes**
-**Deprecation Notes**
+New features
+------------
-**Other**
+- `OOM-2754 <https://jira.onap.org/browse/OOM-2754>`_ Implement certificate update in CMPv2 external issuer
-===========
+- `OOM-2753 <https://jira.onap.org/browse/OOM-2753>`_ Implement certificate update in CMPv2 CertService
-Version: 1.2.0
---------------
+- `OOM-2744 <https://jira.onap.org/browse/OOM-2744>`_ Remove CertService Client mechanism from ONAP
-:Release Date:
+- `OOM-2649 <https://jira.onap.org/browse/OOM-2649>`_ Update contrib/ejbca to 7.x
-**New Features**
+**Bug fixes**
- - Client creates subdirectories in given OUTPUT_PATH and place certificate into it.
+- `OOM-2771 <https://jira.onap.org/browse/OOM-2771>`_ Fix CertificateRequest resource was not found issue in CMPv2 external issuer
-**Bug Fixes**
-
- N/A
+- `OOM-2764 <https://jira.onap.org/browse/OOM-2764>`_ Fix sonar issues in CertService
**Known Issues**
- N/A
+If Cert-Manager was down for some time and did not trigger certificate update on time, then updating an outdated certificate may require manual actions.
+The required actions are described in :ref:`Troubleshooting section <troubleshooting>`
-**Security Notes**
+Deliverables
+------------
- N/A
+Software Deliverables
+~~~~~~~~~~~~~~~~~~~~~
+Docker images mentioned in Release Date section.
-*Fixed Security Issues*
+Documentation Deliverables
+~~~~~~~~~~~~~~~~~~~~~~~~~~
- N/A
+- :ref:`CMPv2 certificate provider description <cmpv2_cert_provider>`
-*Known Security Issues*
+Known Limitations, Issues and Workarounds
+-----------------------------------------
- N/A
+System Limitations
+~~~~~~~~~~~~~~~~~~
-*Known Vulnerabilities in Used Modules*
+Any known system limitations.
- N/A
-**Upgrade Notes**
+Known Vulnerabilities
+~~~~~~~~~~~~~~~~~~~~~
-**Deprecation Notes**
+Any known vulnerabilities.
-**Other**
-===========
+Workarounds
+~~~~~~~~~~~
-Version: 1.1.0
---------------
+Any known workarounds.
-:Release Date: 2020-06-29
-**New Features**
+Security Notes
+--------------
- - Added property to CertService Client to allow selection of output certificates type (One of: PEM, JKS, P12).
+**Fixed Security Issues**
-**Bug Fixes**
+None
- - Resolved issue where created PKCS12 certificates had jks extension.
+**Known Security Issues**
-**Known Issues**
+None
- N/A
-**Security Notes**
+Test Results
+------------
+Not applicable
- N/A
-*Fixed Security Issues*
+References
+----------
- N/A
+For more information on the ONAP Istanbul release, please see:
-*Known Security Issues*
+#. `ONAP Home Page`_
+#. `ONAP Documentation`_
+#. `ONAP Release Downloads`_
+#. `ONAP Wiki Page`_
- N/A
+Version: 2.3.3
+==============
-*Known Vulnerabilities in Used Modules*
+Abstract
+--------
- N/A
+This document provides the release notes for the Honolulu release.
-**Upgrade Notes**
+Summary
+-------
-**Deprecation Notes**
+Certification Service provides certificates signed by external CMPv2 server - such certificates are further called operators certificates. Operators certificates are meant to secure external ONAP traffic - traffic between network functions (xNFs) and ONAP.
-**Other**
+This project was moved from Application Authorization Framework (AAF), to check previous release notes see, `AAF CertService release notes <https://docs.onap.org/projects/onap-aaf-certservice/en/frankfurt/sections/release-notes.html>`_ .
-===========
-Version: 1.0.1
---------------
+Release Data
+------------
-:Release Date: 2020-05-22
++--------------------------------------+---------------------------------------------------------------------------------------+
+| **Project** | OOM |
+| | |
++--------------------------------------+---------------------------------------------------------------------------------------+
+| **Docker images** | * onap/org.onap.oom.platform.cert-service.oom-certservice-api:2.3.3 |
+| | * onap/org.onap.oom.platform.cert-service.oom-certservice-client:2.3.3 |
+| | * onap/org.onap.oom.platform.cert-service.oom-certservice-post-processor:2.3.3 |
+| | * onap/org.onap.oom.platform.cert-service.oom-certservice-k8s-external-provider:2.3.3|
+| | |
++--------------------------------------+---------------------------------------------------------------------------------------+
+| **Release designation** | Honolulu |
+| | |
++--------------------------------------+---------------------------------------------------------------------------------------+
-**New Features**
-The Frankfurt Release is the first release of the Certification Service.
+New features
+------------
+- `OOM-2560 <https://jira.onap.org/browse/OOM-2560>`_ Integrated CMPv2 certificate provider with Cert-Manager
-**Bug Fixes**
+ An CMPv2 certificate provider is a part of PKI infrastructure. It consumes CertificateRequest custom resource from Cert-Manager and calls CertService API to enroll certificate from CMPv2 server.
+ During ONAP deployment, the CMPv2 certificate provider is enabled when flags cmpv2Enabled, CMPv2CertManagerIntegration and platform.enabled equals true.
- - `AAF-1132 <https://jira.onap.org/browse/AAF-1132>`_ - CertService Client returns exit status 5 when TLS configuration fails
+ More information can be found on dedicated `wiki page <https://wiki.onap.org/display/DW/CertService+and+K8s+Cert-Manager+integration>`_
-**Known Issues**
+- `OOM-2632 <https://jira.onap.org/browse/OOM-2632>`_ Extended CertService API and clients to correctly support SANs parameters such as: e-mails, URIs and IP addresses.
- - PKCS12 certificates have jks extension
+**Bug fixes**
-**Security Notes**
+- `OOM-2656 <https://jira.onap.org/browse/OOM-2656>`_ Adjusted CertService API to RFC4210 - changed MAC protection algorithm and number of iteration for such algorithm.
- N/A
+- `OOM-2657 <https://jira.onap.org/browse/OOM-2657>`_ Enhanced CertServiceAPI response in order to include CMP server error messages.
-*Fixed Security Issues*
+- `OOM-2658 <https://jira.onap.org/browse/OOM-2658>`_ Fixed KeyUsage extension sent to CMPv2 server
- N/A
-
-*Known Security Issues*
-
- N/A
+**Known Issues**
-*Known Vulnerabilities in Used Modules*
+None
- N/A
+Deliverables
+------------
-**Upgrade Notes**
+Software Deliverables
+~~~~~~~~~~~~~~~~~~~~~
+Docker images mentioned in Release Date section.
-**Deprecation Notes**
+Documentation Deliverables
+~~~~~~~~~~~~~~~~~~~~~~~~~~
-**Other**
+- :ref:`CMPv2 certificate provider description <cmpv2_cert_provider>`
-===========
+Known Limitations, Issues and Workarounds
+-----------------------------------------
-Version: 1.0.0
---------------
+System Limitations
+------------------
-:Release Date: 2020-04-16
+Any known system limitations.
-**New Features**
-The Frankfurt Release is the first release of the Certification Service.
+Known Vulnerabilities
+---------------------
-**Bug Fixes**
+Any known vulnerabilities.
- - No new fixes were implemented for this release
-**Known Issues**
+Workarounds
+-----------
- - `AAF-1132 <https://jira.onap.org/browse/AAF-1132>`_ - CertService Client returns exit status 5 when TLS configuration fails
+Any known workarounds.
- - PKCS12 certificates have jks extension
-**Security Notes**
+Security Notes
+--------------
- N/A
+**Fixed Security Issues**
-*Fixed Security Issues*
+None
- N/A
+**Known Security Issues**
-*Known Security Issues*
+None
- N/A
-*Known Vulnerabilities in Used Modules*
+Test Results
+------------
+Not applicable
- N/A
-**Upgrade Notes**
+References
+----------
-**Deprecation Notes**
+For more information on the ONAP Honolulu release, please see:
-**Other**
+#. `ONAP Home Page`_
+#. `ONAP Documentation`_
+#. `ONAP Release Downloads`_
+#. `ONAP Wiki Page`_
-===========
-End of Release Notes
+.. _`ONAP Home Page`: https://www.onap.org
+.. _`ONAP Wiki Page`: https://wiki.onap.org
+.. _`ONAP Documentation`: https://docs.onap.org
+.. _`ONAP Release Downloads`: https://git.onap.org
Code Review / oom / platform / cert-service.git / blobdiff