Project Name:

• Proposed name for the project: Certificate and Secret Management Service
• Proposed name for the repository : csm

...

• [csm] Team ONAP7, Thr. UTC 04:00 / Thr. China 12:00 / Wed Eastern 23:00 / Wed Pacific 20:00
• Slides presented at Beijing Developer Forum, Santa Clara. 

Project description:

This project proposal tries address two areas in the ONAP deployment structure from a security perspective.

1. Secure Communication between  servicesbetween microservices.
   • Current state and need
     

     • ONAP consists of multiple micro services which talk to each other.
       There are two types of communication. 

       1. REST API based communication.
       2. DMAPP DMAAP publish/subscriber based communication.

       Since the communication is mostly over HTTP, there is a need to protect services from:

       • Bad actors stealing the data on the wire.
       • Receiving messages from bad actors
   • Requirement:
     • Enable TLS 1TLS1.2+ for securing communication among the services. Java and Python libraries do support this functionality, but easy certificate provisioning is required for Mutual TLS.   This project aims to simplify PKI - certificate provisioning via a simple , and secure CA service , store that stores private keys (CA private key at CA and user certificate private keys) securely using hardware security.
2. Storage of sensitive information such as passwords.
   • Current state and gaps
     
     • Many services in ONAP use password based authentication. Eg: Database servers, publish/subscribe brokers etc.
     • Passwords are stored in plain text files in many services.
     • With multiple instances of these services, the attach surface area becomes very big.
     • Hence there is a need to ensure that attack surface related to password exposure is reduced.
   • Requirement:
     • Need for secure secret management. Services are expected to get the secret only on needed basis using secret reference and remove the secrets once they are used up. 

This project aims to provide solutions to the above needs by:

1. Provide certificate management service Certificate Management Service (CA Service)  to provision signed certificates required for Mutual TLS.
2. Provide certificate request agent Certificate Request Agent SDK
3. Provide hardware security plugin for storing private keys and for performing crypto operations that require private keys.
4. GUI/CLI for Certificate Management Service
5. Provide secret service Secret Management Service for adding/deleting/updating/reading secrets.
6. Provide secret client agent Secret Client Agent SDK 
7. GUI/CLI for Secret Management Service.

Scope:

...

Certificate Management Service

The proposed project will provide an Internal CA Broker a Certificate Management Service which will be used for certificate enrollment by micro services. The ultimate goal is to make sure that all micro services communicate securely between each other using the Interal CA for enrollment and then use TLS to establish secure communication channels between each other.

The CA Broker Certificate Management Service will support the following:

• RESTful API support for Certificate Request Operations by micro services
  • Generate Certificate
  • Revocation of Certificate
  • Usage report updates
  • Token Authentication
• An Admin interface
  • That will generate a self signed CA
  • Upload any admin generated CA Cert + Private Key pair
  • Usage usage reports on each key
  • Revoke certificates
  • Get CA Certificate in PEM/DER format
  • Token service to provide temporary tokens

...

• Generate RSA/ECDSA key pair using PKCS11
• Securely store the private key.
  • Store the private key using TPM if it is available
• PKCS10 CSR generation
• Communicates with the previously described CA Broker Certificate Management Service over REST API
• Periodically generates a usage report
• Certificate Renewal
• Discovery of Internal CA Broker Certificate Management Service

The below diagram illustrates Best Practices of Certificate Enrollment that is end-point initiated.

...

The below diagram details the architechture blocks used previously in detail:

Image Added

The below diagram the same architecture blocks as above with a Sidecar service:

...

Image Added

Use Case Sequence Diagrams

Image RemovedImage Added

Image Added

Secret Management Service

The project will also provide a Secret Management Service with the following features and capabilities:

• RESTful API support
• ADD
• UPDATE
• DELETE
• Token based authentication for above requests
username and password based authentication will also be supportedSupport multiple Secret domains
• Each domain can be used to multiple secrets
• Each domain is associated with various policies
• Each secret can have multiple key value pairs
• Certificate based authentication
• Authenticate users with AAF
• Token based authentication
• Securely store secrets using AES encryption
  • Use TPM/SGX for key storage if available
• RESTful API support for ADD, UPDATE, DELETE of secrets

The below diagram illustraces the Secret Service High Level Flow in an ONAP Context

...

The below diagram illustrates how a micro service will use the Secret Client Agent to talk to the Secret Service to store or retrieve passwords.

Image RemovedImage Added

SoftHSMv2 +TPM2-Plugin

This project provides SoftHSMv2 with an extended capabilities to leverage TPM2.0 hardware capabilities to generate RSA/ECC keypairs and import keys generated outside of TPM2.0 module. This is achieved by modifying SoftHSMv2, adding an adapter layer between SofhHSMv2 and TPM2-Plugin. 

Bullseys coverage tool is used to measure the codes coverage: 

Image Added

Architecture Alignment:

CSM is a common service across ONAP components.

Image Modified

Other Information:

• Seed code:
  TBD
  • Vault project: https://github.com/hashicorp/vault

  Key Project Facts:

  Primary Contact : Srinivasa Addepalli

  ...

  Release Components Name:

  Note: refer to existing project for details on how to fill out this table

  Components Name	Components Repository name	Maven Group ID	Components Description
  sms	aaf/sms	org.onap.aaf.sms	Secret Management Service that will contain the webservice as well as client code for managing and accessing secrets.
  sshsm	aaf/sshsm	org.onap.aaf.sshsm	A repository for softhsm modifications and hardware security plugin

  Resources committed to the Release:

  ...

  Role	First Name Last Name	Linux Foundation ID	Email Address	Location
  PTL	Kiran Kamineni	kirankamineni	kiran.k.kamineni@intel.com	Santa Clara, CA
  Committers	Kiran Kamineni	kirankamineni	kiran.k.kamineni@intel.com	Santa Clara, CA
  	Manjunath Ranganathaiah	Ning Sun	Girish Havaldar	giri	hg0071052@techmahindra.com	Bangalore, India
  Contributors	Vamshi Namilikonda	vamshi.nemalikonda	vn00480215@techmahindra.com	Pune, India
  	ContributorsManjunath Ranganathaiah	mrangana	manjunath.ranganathaiah@intel.com	Santa Clara, CA, USA
  	Ning Sun	ningsun	ning.sun@intel.com	Santa Clara, CA, USA