From 1a101ab7676e7827423f39a22808418dc29e913f Mon Sep 17 00:00:00 2001 From: Instrumental Date: Thu, 19 Sep 2019 09:23:53 -0500 Subject: [PATCH] Update Documentation El Alto Issue-ID: AAF-854 Change-Id: I4bde6629fa9b4656f20ad69853baf98e503e50c8 Signed-off-by: Instrumental --- docs/sections/architecture/aaf_architecture.rst | 11 +++++++++++ docs/sections/architecture/security.rst | 4 ++++ docs/sections/release-notes.rst | 2 +- 3 files changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/sections/architecture/aaf_architecture.rst b/docs/sections/architecture/aaf_architecture.rst index 50d20eec..5513be8a 100644 --- a/docs/sections/architecture/aaf_architecture.rst +++ b/docs/sections/architecture/aaf_architecture.rst @@ -64,6 +64,17 @@ Enjoy stretching your mind AAF can support models of either side. In the meantime, enjoy the use of your mind to comtemplate things beyond tickets and this will help drive what you need to ask for in terms of Identities for your Apps. +Components +========== + +The running components of AAF include the following: + - "service" - RESTful HTTP/S - The main API Service for Authentication, Authorization and Management + - "locate" - RESTful HTTP/S - Provides Scaleble, Cross-Deployment Global location, inside or outside a container, of Registered Components (at minimum, AAF Components). Locate also provide Configuration information for Generated Configurations. + - "oauth" - RESTful HTTP/S - OAuth 2 implementation. Provides "token" and "introspection" methods, where Authorization data is included. + - "gui" - Browser HTTP/S - Management GUI, where user interactions occur, including a Web-based CMD-Line interface, API Docs, Approval pages, etc. + - "cm" - RESTful HTTP/S - Certificate Manager API, see more details below. + - "fs" - HTTP ONLY - File Server. This Component MUST NOT be HTTP/S, because it Provides HTTP Accessed RCLs as part of the TLS process. Other public information may be presented as well (such as Certificates, which are by definition Public) + Certificate Manager =================== diff --git a/docs/sections/architecture/security.rst b/docs/sections/architecture/security.rst index d1809935..ebfd63ba 100644 --- a/docs/sections/architecture/security.rst +++ b/docs/sections/architecture/security.rst @@ -33,6 +33,10 @@ Whenever two processing entities exist that need to communicate securely, it is Encryption is provided by HTTP/S with the TLS 1.2+ protocol. Lesser protocols can also be added, but it is highly recommended that the protocol go no lower than TLS 1.1 +ALL components of AAF are accessible only by HTTP/S (service, locate, oauth, gui, certman), EXCEPT the component "FS". + +FS *must* be HTTP, because it is responsible for being accessible DURING the TLS process for recent RCLs. (Revocation lists). Since it is part of the TLS process, it cannot be TLS itself. + .. image:: images/SecurityArchBasic_TLS.svg :width: 70% :align: center diff --git a/docs/sections/release-notes.rst b/docs/sections/release-notes.rst index 72198931..ed91732c 100644 --- a/docs/sections/release-notes.rst +++ b/docs/sections/release-notes.rst @@ -5,7 +5,7 @@ Release Notes ============= -Version: 2.1.15 (El Alto, Early Drop, 5.0.0) +Version: 2.1.15 (El Alto, 5.0.1) --------------------------------------------- :Release Date: 2019-08-12 -- 2.16.6