diff --git a/README.md b/README.md index 650c39d422ab88af7b67ea328b0fcf48d0c9d41e..975b0204d5e465e2423bd3bffeaae05212be6eb5 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ #### Minimal SSO Intro: -- [SSO](https://lmddgtfy.net/?q=SSO): Single Sign On +- [SSO](https://duckduckgo.com/?q=sso): Single Sign On - SLO: Single Log Out - SP: Service Provider (your web app) - IDP: Identity Provider (e.g. Shibboleth) @@ -17,13 +17,14 @@ #### Necessary Stuff -- Binary dependencies: `sudo apt install libxml2-dev libxslt1-dev xmlsec1 libxmlsec1-dev pkg-config` +- Binary dependencies: `sudo apt install libxml2-dev libxslt1-dev xmlsec1 libxmlsec1-dev pkg-config` (debian example) - Python dependencies: see `requirements.txt` or `setup.py` - Add the app into `INSTALLED_APPS` -- Include the `ssoauth` `urls.py` into the project `urls.py` `urlpatterns`: +- `urlpatterns`: + - In `urls.py` of your project add `path("", include("ssoauth.urls"))` to `urlpatterns` - Without a path/prefix: youre done. - With a path/prefix: - - Reconsider it. It's highly recommended to include `ssoauth` **without** a prefix/path to avoid issues with apps like `contrib.admin` and `wagtail` that provide their own log in pages. + - Reconsider it. It better to include `ssoauth` **without** a prefix/path to avoid issues with apps like `django.contrib.admin` and `wagtail` that provide their own login pages at the default path. - If you really need to use a path/prefix, make sure to set a setting `LOGIN_URL = urls.reverse_lazy("sso-login")` @@ -40,11 +41,11 @@ Use this only if you want an actual SSO with SAML2. For extra details see the de import os, socket from django import urls -IDP_META_URL = "https://idp-test.it.hs-hannover.de/idp/shibboleth" -IDP_LOGOUT_URL = "https://idp-test.it.hs-hannover.de/idp/profile/Logout" +IDP_META_URL = "https://idp.hs-hannover.de/simplesaml/saml2/idp/metadata.php" +IDP_LOGOUT_URL = "https://idp.hs-hannover.de/simplesaml/module.php/saml/idp/singleLogout" -SP_KEY = "{project_settings}/cert/sp.key" -SP_CERT = "{project_settings}/cert/sp.pem" +SP_KEY = "{project_settings}/sso_cert/sp.key" +SP_CERT = "{project_settings}/sso_cert/sp.pem" SP_HOST = "localhost" SP_PORT = 8000