diff --git a/docs/.images/diagrams/README.md b/docs/.images/diagrams/README.md index 5edebda..ff15c48 100644 --- a/docs/.images/diagrams/README.md +++ b/docs/.images/diagrams/README.md @@ -1,13 +1,16 @@ # UDS Identity Config Diagrams -## How to Customize -To customize the diagram, download the svg and in [draw.io](https://draw.io) create a new diagram and load in the svg. +## Making Changes to Diagrams for UDS Core -To download the [svg from github](https://github.com/defenseunicorns/uds-identity-config/tree/main/docs/.images), select one of the svg files, then select the download button in the top right of the `Preview` view. +Utilize the drawio file to make changes across all diagrams. Make sure that changes are exported in the svg format and put into this directory if being used in the docs as well as any changes to the drawio file. -Alternatively you can also download the svg from the [uds.defenseunicorns.com](https://uds.defenseunicorns.com) docsite by right clicking and selecting the `Save image as` option. +## How to Customize For Outside Use +Utilize the drawio file included in this directory to access all of the diagrams in one place. + +To customize a specific diagram, download the svg and in [draw.io](https://draw.io) create a new diagram and load in the svg. -It doesn't matter which svg you download, they all contain the metadata for the other layers mentioned above (you may need to enable the layers pop up in [draw.io](https://draw.io) to change your layer). +To download the [svg from github](https://github.com/defenseunicorns/uds-identity-config/tree/main/docs/.images/diagrams), select one of the svg files, then select the download button in the top right of the `Preview` view. +Alternatively you can also download the svg from the [uds.defenseunicorns.com](https://uds.defenseunicorns.com) docsite by right clicking and selecting the `Save image as` option. -#### If you have suggestions for the diagrams, we welcome issues or pull requests contributions to [uds-core](https://github.com/defenseunicorns/uds-identity-config). +#### If you have suggestions for the diagrams, we welcome issues or pull requests contributions to [uds-identity-config](https://github.com/defenseunicorns/uds-identity-config). diff --git a/docs/.images/diagrams/uds-core-auth-flow-diagrams.drawio b/docs/.images/diagrams/uds-core-auth-flow-diagrams.drawio new file mode 100644 index 0000000..546cae0 --- /dev/null +++ b/docs/.images/diagrams/uds-core-auth-flow-diagrams.drawio @@ -0,0 +1,945 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/.images/diagrams/uds-core-auth-flows-basic.svg b/docs/.images/diagrams/uds-core-auth-flows-basic.svg index a2a9217..a0f462f 100644 --- a/docs/.images/diagrams/uds-core-auth-flows-basic.svg +++ b/docs/.images/diagrams/uds-core-auth-flows-basic.svg @@ -1,3 +1,3 @@ -
Username Form
Reset Password Email sent
No
Yes
MFA Setup ?
Setup MFA
Enter MFA
Username/Password + SSO + x509
Username / Password Registration Form
MFA
Username / Password Login Form
No
Yes
MFA Setup ?
Setup MFA
Enter MFA
SSO Button
SSO Button
Redirect to IDP
Redirect to IDP
x509 Button
  Registration  
  Authentication  
  Access Granted  
  Access Granted  
  Reset Password  
  Password Reset  
 \ No newline at end of file +
Username Form
Reset Password Email sent
No
Yes
MFA Setup ?
Setup MFA
Enter MFA
Username/Password + SSO + x509
Username / Password Registration Form
MFA
Username / Password Login Form
No
Yes
MFA Setup ?
Setup MFA
Enter MFA
SSO Button
SSO Button
Redirect to IDP
Redirect to IDP
x509 Button
  Registration  
  Authentication  
  Access Granted  
  Access Granted  
  Reset Password  
  Password Reset  
 \ No newline at end of file diff --git a/docs/.images/diagrams/uds-core-auth-flows-complex.svg b/docs/.images/diagrams/uds-core-auth-flows-complex.svg index 8e06a13..cf63fff 100644 --- a/docs/.images/diagrams/uds-core-auth-flows-complex.svg +++ b/docs/.images/diagrams/uds-core-auth-flows-complex.svg @@ -1,4 +1,3 @@ - -
Disabled
SSO + x509
Username / Password Registration Form
x509 Button
SSO Button
Redirect to IDP
SSO Button
Redirect to IDP
Username/Password + SSO
Username / Password Registration Form
MFA
Username / Password Login Form
No
Yes
MFA Setup ?
Setup MFA
Enter MFA
SSO Button
SSO Button
Redirect to IDP
Redirect to IDP
Username Form
Reset Password Email sent
No
Yes
MFA Setup ?
Setup MFA
Enter MFA
Username Form
Reset Password Email sent
No
Yes
MFA Setup ?
Setup MFA
Enter MFA
Username/Password + x509
Username / Password Registration Form
MFA
Username / Password Login Form
No
Yes
MFA Setup ?
Setup MFA
Enter MFA
x509 Button
  Registration  
  Authentication  
  Access Granted  
  Access Granted  
  Reset Password  
  Password Reset  
 \ No newline at end of file +
Disabled
SSO + x509
Username / Password Registration Form
x509 Button
SSO Button
Redirect to IDP
SSO Button
Redirect to IDP
Username/Password + SSO
Username / Password Registration Form
MFA
Username / Password Login Form
No
Yes
MFA Setup ?
Setup MFA
Enter MFA
SSO Button
SSO Button
Redirect to IDP
Redirect to IDP
Username Form
Reset Password Email sent
No
Yes
MFA Setup ?
Setup MFA
Enter MFA
Username Form
Reset Password Email sent
No
Yes
MFA Setup ?
Setup MFA
Enter MFA
Username/Password + x509
Username / Password Registration Form
MFA
Username / Password Login Form
No
Yes
MFA Setup ?
Setup MFA
Enter MFA
x509 Button
  Registration  
  Authentication  
  Access Granted  
  Access Granted  
  Reset Password  
  Password Reset  
 \ No newline at end of file diff --git a/docs/.images/diagrams/uds-core-auth-flows-options.svg b/docs/.images/diagrams/uds-core-auth-flows-options.svg index ed4cf57..516e418 100644 --- a/docs/.images/diagrams/uds-core-auth-flows-options.svg +++ b/docs/.images/diagrams/uds-core-auth-flows-options.svg @@ -1,3 +1,3 @@ -
Username/Password
Username / Password Registration Form
MFA
Username / Password Login Form
No
Yes
MFA Setup ?
Setup MFA
Enter MFA
Username Form
Reset Password Email sent
No
Yes
MFA Setup ?
Setup MFA
Enter MFA
SSO
SSO Button
SSO Button
Redirect to IDP
Redirect to IDP
Disabled
x509
Username / Password Registration Form
x509 Button
Disabled
  Registration  
  Access Granted  
  Authentication  
  Access Granted  
  Reset Password  
  Password Reset  
 \ No newline at end of file +
Username/Password
Username / Password Registration Form
MFA
Username / Password Login Form
No
Yes
MFA Setup ?
Setup MFA
Enter MFA
Username Form
Reset Password Email sent
No
Yes
MFA Setup ?
Setup MFA
Enter MFA
SSO
SSO Button
SSO Button
Redirect to IDP
Redirect to IDP
Disabled
x509
Username / Password Registration Form
x509 Button
Disabled
  Registration  
  Access Granted  
  Authentication  
  Access Granted  
  Reset Password  
  Password Reset  
 \ No newline at end of file diff --git a/docs/reference/UDS Core/IdAM/authentication-flows.md b/docs/reference/UDS Core/IdAM/authentication-flows.md index 7062753..126a290 100644 --- a/docs/reference/UDS Core/IdAM/authentication-flows.md +++ b/docs/reference/UDS Core/IdAM/authentication-flows.md @@ -28,19 +28,19 @@ UDS Core comes equipped with a robust authentication framework that supports mul --- -![Authentication Flow Options](https://github.com/defenseunicorns/uds-identity-config/blob/customization-doc-updates/docs/.images/diagrams/uds-core-auth-flows-options.svg?raw=true) +![Authentication Flow Options](https://github.com/defenseunicorns/uds-identity-config/blob/main/docs/.images/diagrams/uds-core-auth-flows-options.svg?raw=true) ## Authentication Flows in UDS Core UDS Core is shipped with a basic authentication flow that includes all three options out of the box. The following diagram shows the basic authentication flows that are deployed with standard UDS Core: -![UDS Core Authentication Flow](https://github.com/defenseunicorns/uds-identity-config/blob/customization-doc-updates/docs/.images/diagrams/uds-core-auth-flows-basic.svg?raw=true) +![UDS Core Authentication Flow](https://github.com/defenseunicorns/uds-identity-config/blob/main/docs/.images/diagrams/uds-core-auth-flows-basic.svg?raw=true) ### Customizing Authentication Flows Different operational environments may necessitate distinct authentication flows to comply with specific security policies, regulatory demands, or demographic requirements. UDS Core facilitates the customization of these flows, allowing for tailored security measures and user interfaces. The diagram below illustrates various combinations of the three authentication methods that can be adapted to meet unique operational needs: -![Complex Authentication Flows](https://github.com/defenseunicorns/uds-identity-config/blob/customization-doc-updates/docs/.images/diagrams/uds-core-auth-flows-complex.svg?raw=true) +![Complex Authentication Flows](https://github.com/defenseunicorns/uds-identity-config/blob/main/docs/.images/diagrams/uds-core-auth-flows-complex.svg?raw=true) These customizations not only ensure appropriate security configurations by enabling or disabling specific flows but also maintain a seamless user experience by adjusting the Keycloak theme accordingly.