From 17e499e11f9724f05c9f2ac0d2ba39a5e4295fe1 Mon Sep 17 00:00:00 2001 From: babolivier Date: Thu, 22 Jul 2021 10:58:46 +0000 Subject: deploy: d518b05a8667943bd0aa9ab1edc91eec0a8283fe --- develop/development/saml.html | 294 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 294 insertions(+) create mode 100644 develop/development/saml.html (limited to 'develop/development/saml.html') diff --git a/develop/development/saml.html b/develop/development/saml.html new file mode 100644 index 0000000000..4265b08c61 --- /dev/null +++ b/develop/development/saml.html @@ -0,0 +1,294 @@ + + + + + + SAML - Synapse + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + + + + + +
+
+ +
+ +
+ +

How to test SAML as a developer without a server

+

https://capriza.github.io/samling/samling.html (https://github.com/capriza/samling) is a great +resource for being able to tinker with the SAML options within Synapse without needing to +deploy and configure a complicated software stack.

+

To make Synapse (and therefore Riot) use it:

+
    +
  1. Use the samling.html URL above or deploy your own and visit the IdP Metadata tab.
    2. +
  2. Copy the XML to your clipboard.
    3. +
  3. On your Synapse server, create a new file samling.xml next to your homeserver.yaml with +the XML from step 2 as the contents.
    4. +
  4. Edit your homeserver.yaml to include: +
    saml2_config:
+  sp_config:
+    allow_unknown_attributes: true  # Works around a bug with AVA Hashes: https://github.com/IdentityPython/pysaml2/issues/388
+    metadata:
+      local: ["samling.xml"]   
+
    +
    5. +
  5. Ensure that your homeserver.yaml has a setting for public_baseurl: +
    public_baseurl: http://localhost:8080/
+
    +
    6. +
  6. Run apt-get install xmlsec1 and pip install --upgrade --force 'pysaml2>=4.5.0' to ensure +the dependencies are installed and ready to go.
    7. +
  7. Restart Synapse.
    8. +
+

Then in Riot:

+
    +
  1. Visit the login page with a Riot pointing at your homeserver.
    2. +
  2. Click the Single Sign-On button.
    3. +
  3. On the samling page, enter a Name Identifier and add a SAML Attribute for uid=your_localpart. +The response must also be signed.
    4. +
  4. Click "Next".
    5. +
  5. Click "Post Response" (change nothing).
    6. +
  6. You should be logged in.
    7. +
+

If you try and repeat this process, you may be automatically logged in using the information you +gave previously. To fix this, open your developer console (F12 or Ctrl+Shift+I) while on the +samling page and clear the site data. In Chrome, this will be a button on the Application tab.

+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file -- cgit 1.5.1