docs/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2018 Intel Corporation, Inc
   4
   5 SMS-Secret Management Service
   6 ==================================
   7
   8 .. toctree::
   9    :maxdepth: 1
  10
  11    installation
  12    usage
  13    apiswagger
  14
  15
  16 Introduction
  17 ------------
  18
  19 This project aims at the Storage of sensitive information such as passwords.
  20
  21 **Current state and gaps**
  22
  23 Many services in ONAP use password based authentication. Eg: Database servers, publish/subscribe brokers etc.
  24 Passwords are stored in plain text files in many services.
  25 With multiple instances of these services, the attach surface area becomes very big.
  26 Hence there is a need to ensure that attack surface related to password exposure is reduced.
  27
  28 **Requirement:**
  29
  30 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.
  31
  32 **Secret Service High Level Flow Diagram**
  33
  34 .. image:: sms_high_level.png
  35    :width: 4555550px
  36    :height: 300px
  37    :alt: SMS Flow Diagram