diff options
| author |   Aleksandra Maciaga <aleksandra.maciaga@nokia.com> | 2020-05-06 15:19:19 +0200 |
|---|---|---|
| committer |   Bartosz Gardziejewski <bartosz.gardziejewski@nokia.com> | 2020-05-08 10:09:56 +0200 |
| commit | 0c3c68ba16c8c1953247776e48072ff7668a7b02 (patch) | |
| tree | d6f43bbd8aaa5e281db2da446cdf5a584c28eaf2 /docs/sections/introduction.rst | |
| parent | 2639149f7f97ebf1c703b23d1aed17dad628bd64 (diff) | |
Update CertService Introduction Documentation
Issue-ID: AAF-1091
Signed-off-by: Aleksandra Maciaga <aleksandra.maciaga@nokia.com>
Change-Id: Ica4596e08648b49782316be48769395223a15397
Diffstat (limited to 'docs/sections/introduction.rst')
| -rw-r--r-- | docs/sections/introduction.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/sections/introduction.rst b/docs/sections/introduction.rst new file mode 100644 index 00000000..0b7e8d1b --- /dev/null +++ b/docs/sections/introduction.rst @@ -0,0 +1,33 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2020 NOKIA +.. _introduction: + + +Introduction +============ + +Overview +-------- +The micro-service called CertService is designed for requesting certificates signed by external Certificate Authority (CA) using CMP over HTTP protocol. It uses CMPv2 client to send and receive CMPv2 messages. + +CertService's client is also provided so other ONAP components (aka end components) can easily get certificate from CertService. End component is an ONAP component (e.g. DCAE collector or controller) which requires certificate from CMPv2 server to protect external traffic and uses CertService's client to get it. + +CertService's client communicates with CertService via REST API over HTTPS, while CertService with CMPv2 server via CMP over HTTP. + +To proof that CertService works Open Source CMPv2 server (EJBCA) is deployed and used in E2E tests. + +It is planned that Network Functions (aka xNFs) will get certificates from the same CMPv2 server and the same CA hierarchy, but will use own means to get such certificates. Cause xNFs and ONAP will get certificates signed by the same root CA and will trust such root CA, both parties will automatically trust each other and can communicate with each other. + + +Context View +------------ + +.. image:: resources/cmpv2_context_view.png + :width: 533px + :height: 315px + :alt: CMPV2 Context View + + +In Frankfurt release only `Initialization Request <https://tools.ietf.org/html/rfc4210#section-5.3.1>`_ with `ImplicitConfirm <https://tools.ietf.org/html/rfc4210#section-5.1.1.1>`_ is supported. +Request sent to CMPv2 server is authenticated by secret value (initial authentication key) and reference value (used to identify the secret value) as described in `RFC-4210 <https://tools.ietf.org/html/rfc4210#section-4.2.1.2>`_. |