diff --git a/docs/docs/downloads.md b/docs/docs/downloads.md deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/docs/other/adfs_sso_guide.md b/docs/docs/other/adfs_sso_guide.md new file mode 100644 index 00000000..0767dafe --- /dev/null +++ b/docs/docs/other/adfs_sso_guide.md @@ -0,0 +1,72 @@ +# ADFS SSO Guide + +## Assumptions + +The following guide was built under the assumptions that: + +1. ADFS 4.0 running on Server 2016 using Active Directory +2. Main ADFS setup already completed / working. SSL certs installed and port forwarded as expected. + +The guide was built to deal specifically with adding mesh as a Relying Party. I’m far from an ADFS expert and some configurations may not be needed. Most of this was built by reading the code and taking guesses as to the needed values. + +As with anything SSO, you need 2 pieces – the IDP setup (in this case ADFS) and the SP setup (in this case Mesh). +Mesh Setup: +Add the following to your mesh config file in the domains part: + +![](images/adfs_sso2022-05-16-23-24-54.png) + +Callback URL: Should be the FQDN for your Mesh Server, ending with /auth-saml-callback + +Entity ID: This is how ADFS IDs which party the request goes to. You can set this to whatever you want, but you will need this value later on when working in ADFS. + +IDP URL: This is the URL to ADFS. Ends with /adfs/ls unless you did something very weird in ADFS. + +Cert: You will need to export the token signing cert from ADFS, then convert it to PEM format. This cert can be found in ADFS -> Service -> Certificates. You can use this openssl command to convert it from CRT to PEM format: openssl x509 -in mycert.crt -out mycert.pem -outform PEM + +Save the config and restart the mesh server. + +ADFS setup (in pictures): + +Relying Party Trust -> New Relying Party Trust + +![](images/adfs_sso2022-05-16-23-25-48.png) + +![](images/adfs_sso2022-05-16-23-26-01.png) + +![](images/adfs_sso2022-05-16-23-26-47.png) + +![](images/adfs_sso2022-05-16-23-26-56.png) + +![](images/adfs_sso2022-05-16-23-27-03.png) + +![](images/adfs_sso2022-05-16-23-27-09.png) + +![](images/adfs_sso2022-05-16-23-27-16.png) + +![](images/adfs_sso2022-05-16-23-27-22.png) + +![](images/adfs_sso2022-05-16-23-27-28.png) + +Edit the new “Relying Party Trust” Properties: + +![](images/adfs_sso2022-05-16-23-27-41.png) + +![](images/adfs_sso2022-05-16-23-27-51.png) + +Then it’s time to add Claims… + +![](images/adfs_sso2022-05-16-23-28-09.png) + +![](images/adfs_sso2022-05-16-23-28-15.png) + +![](images/adfs_sso2022-05-16-23-28-21.png) + +For the outgoing claim type, where it says firstname, lastname, and email, manually type it in as shown. All other fields should be selected from the dropdown. + +Add another rule: + +![](images/adfs_sso2022-05-16-23-28-41.png) + +![](images/adfs_sso2022-05-16-23-28-48.png) + +For all fields, select from the dropdowns diff --git a/docs/docs/other/images/adfs_sso2022-05-16-23-24-54.png b/docs/docs/other/images/adfs_sso2022-05-16-23-24-54.png new file mode 100644 index 00000000..55b434b6 Binary files /dev/null and b/docs/docs/other/images/adfs_sso2022-05-16-23-24-54.png differ diff --git a/docs/docs/other/images/adfs_sso2022-05-16-23-25-48.png b/docs/docs/other/images/adfs_sso2022-05-16-23-25-48.png new file mode 100644 index 00000000..7300847c Binary files /dev/null and b/docs/docs/other/images/adfs_sso2022-05-16-23-25-48.png differ diff --git a/docs/docs/other/images/adfs_sso2022-05-16-23-26-01.png b/docs/docs/other/images/adfs_sso2022-05-16-23-26-01.png new file mode 100644 index 00000000..1e2917cb Binary files /dev/null and b/docs/docs/other/images/adfs_sso2022-05-16-23-26-01.png differ diff --git a/docs/docs/other/images/adfs_sso2022-05-16-23-26-47.png b/docs/docs/other/images/adfs_sso2022-05-16-23-26-47.png new file mode 100644 index 00000000..d0429080 Binary files /dev/null and b/docs/docs/other/images/adfs_sso2022-05-16-23-26-47.png differ diff --git a/docs/docs/other/images/adfs_sso2022-05-16-23-26-56.png b/docs/docs/other/images/adfs_sso2022-05-16-23-26-56.png new file mode 100644 index 00000000..822a0dc0 Binary files /dev/null and b/docs/docs/other/images/adfs_sso2022-05-16-23-26-56.png differ diff --git a/docs/docs/other/images/adfs_sso2022-05-16-23-27-03.png b/docs/docs/other/images/adfs_sso2022-05-16-23-27-03.png new file mode 100644 index 00000000..745ecfc0 Binary files /dev/null and b/docs/docs/other/images/adfs_sso2022-05-16-23-27-03.png differ diff --git a/docs/docs/other/images/adfs_sso2022-05-16-23-27-09.png b/docs/docs/other/images/adfs_sso2022-05-16-23-27-09.png new file mode 100644 index 00000000..90b7a09a Binary files /dev/null and b/docs/docs/other/images/adfs_sso2022-05-16-23-27-09.png differ diff --git a/docs/docs/other/images/adfs_sso2022-05-16-23-27-16.png b/docs/docs/other/images/adfs_sso2022-05-16-23-27-16.png new file mode 100644 index 00000000..385f72a8 Binary files /dev/null and b/docs/docs/other/images/adfs_sso2022-05-16-23-27-16.png differ diff --git a/docs/docs/other/images/adfs_sso2022-05-16-23-27-22.png b/docs/docs/other/images/adfs_sso2022-05-16-23-27-22.png new file mode 100644 index 00000000..e0c5615d Binary files /dev/null and b/docs/docs/other/images/adfs_sso2022-05-16-23-27-22.png differ diff --git a/docs/docs/other/images/adfs_sso2022-05-16-23-27-28.png b/docs/docs/other/images/adfs_sso2022-05-16-23-27-28.png new file mode 100644 index 00000000..d85957a5 Binary files /dev/null and b/docs/docs/other/images/adfs_sso2022-05-16-23-27-28.png differ diff --git a/docs/docs/other/images/adfs_sso2022-05-16-23-27-41.png b/docs/docs/other/images/adfs_sso2022-05-16-23-27-41.png new file mode 100644 index 00000000..ef104675 Binary files /dev/null and b/docs/docs/other/images/adfs_sso2022-05-16-23-27-41.png differ diff --git a/docs/docs/other/images/adfs_sso2022-05-16-23-27-51.png b/docs/docs/other/images/adfs_sso2022-05-16-23-27-51.png new file mode 100644 index 00000000..63b36028 Binary files /dev/null and b/docs/docs/other/images/adfs_sso2022-05-16-23-27-51.png differ diff --git a/docs/docs/other/images/adfs_sso2022-05-16-23-28-09.png b/docs/docs/other/images/adfs_sso2022-05-16-23-28-09.png new file mode 100644 index 00000000..87cfd7b3 Binary files /dev/null and b/docs/docs/other/images/adfs_sso2022-05-16-23-28-09.png differ diff --git a/docs/docs/other/images/adfs_sso2022-05-16-23-28-15.png b/docs/docs/other/images/adfs_sso2022-05-16-23-28-15.png new file mode 100644 index 00000000..15c0cc66 Binary files /dev/null and b/docs/docs/other/images/adfs_sso2022-05-16-23-28-15.png differ diff --git a/docs/docs/other/images/adfs_sso2022-05-16-23-28-21.png b/docs/docs/other/images/adfs_sso2022-05-16-23-28-21.png new file mode 100644 index 00000000..7ee9e9aa Binary files /dev/null and b/docs/docs/other/images/adfs_sso2022-05-16-23-28-21.png differ diff --git a/docs/docs/other/images/adfs_sso2022-05-16-23-28-41.png b/docs/docs/other/images/adfs_sso2022-05-16-23-28-41.png new file mode 100644 index 00000000..87cfd7b3 Binary files /dev/null and b/docs/docs/other/images/adfs_sso2022-05-16-23-28-41.png differ diff --git a/docs/docs/other/images/adfs_sso2022-05-16-23-28-48.png b/docs/docs/other/images/adfs_sso2022-05-16-23-28-48.png new file mode 100644 index 00000000..77e13157 Binary files /dev/null and b/docs/docs/other/images/adfs_sso2022-05-16-23-28-48.png differ diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index a915431f..c8f71e25 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -26,6 +26,9 @@ nav: - Intel AMT: - intelamt/index.md + - Other: + - other/adfs_sso_guide.md + site_description: "A remote monitoring and management tool" site_author: "Ylianst" site_url: "https://git.meshcentral.com/"