Automation adds aaf-sms-architecture.rst
[aaf/sms.git] / docs / architecture.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 .. _architecture:
5
6 Architecture
7 ------------
8
9 This project aims at the Storage of sensitive information such as passwords, username, and tokens.
10
11 **Current state and gaps**
12
13 Many services in ONAP use password based authentication. Eg: Database servers, publish/subscribe brokers etc.
14 Passwords are stored in plain text files in many services.
15 With multiple instances of these services, the attack surface area becomes very big.
16 Hence there is a need to ensure that attack surface related to password exposure is reduced.
17
18 **Requirement:**
19
20 Need for Secure Secret Management.
21 Services are expected to get the secret only on needed basis using secret reference and remove the secrets once they are used up.
22
23 **Secret Service High Level Flow Diagram**
24
25 .. image:: sms_high_level.png
26    :width: 900px
27    :height: 400px
28    :alt: SMS Flow Diagram