From cfa94d79eaf91c563a459ede5902fc02dab18d58 Mon Sep 17 00:00:00 2001 From: tngan Date: Wed, 7 Oct 2015 15:33:33 +0800 Subject: [PATCH] Add demo to README.md --- README.md | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 9e284618..3fba1a6c 100644 --- a/README.md +++ b/README.md @@ -15,16 +15,31 @@ $ npm install express-saml2 ``` ###Get Started -```bash -$ git clone https://github.com/tngan/express-saml2.git -``` ```javascript var saml = require('express-saml2'); ``` - -###Wiki See full documentation [here](https://github.com/tngan/express-saml2/wiki) +###Demo + +In the `/examples` folder, there are three entities (1 IdP and 2 SPs). They are at port 3001, 4002 and 4003. + +Without using Single Sign On, users have to remember several pairs of username/password in order to log into different internal applications. + +normal-login + +SAML proposes two ways to initiate Single Sign On, they are respectively Service Provider Initiated SSO and Identity Provider Initiated SSO. In SP-initated SSO, the user attempts to access SP but their federated identity is authenticated by IdP, so they first have to log on IdP, then IdP sends back a SAML assertion response to SP, and finally SP creates a session to user in order to access the resources. + +spinit-sso + +In the approach of IdP-initated SSO, IdP provides links which refers to the resources in service providers. In this use case, users don't need to visit SP first. + +idpinit-sso + +IdP-initiated Single Logout is also provided and relied on relay state. IdP provides a link refers to the single logout endpoints in one of those participated service providers (SP1). The selected SP sends back a logout response to IdP with relay state which is the logout endpoint URL of next participated service provider (SP2), user finally log out IdP when all participated SP is logged out. + +idpinit-slo + ### Talks [An introduction to Single Sign On](http://www.slideshare.net/TonyNgan/an-introduction-of-single-sign-on) @@ -36,7 +51,3 @@ See full documentation [here](https://github.com/tngan/express-saml2/wiki) ### Copyright Copyright (C) 2015 Tony Ngan, released under the MIT License. - - -[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/tngan/express-saml2/trend.png)](https://bitdeli.com/free "Bitdeli Badge") -