Bluemix Helper for adding oAuth SSO support to your application
npm install bluemix-helper-ssohttps:///auth/sso/callback where https://myapp.mybluemix.net/auth/sso/callback This SSO Service configuration step is now complete. The next section will cover how to add authentication to the application code.
You can check out the sample app in the /example directory.
The following example code shows demonstrates how the steps needed to easily add authentication to your Bluemix application:
1. Create the app express object
2. Use the bluemix-helper-config library to easily detect if SSO service is bound to your application
3. Invoke the bluemix-helper-sso library using the express app object and an option object with the following parameters:
* ssoService: Json Object representing the SSO Service returned by the bluemix-helper-config library
* ssoServiceName: (alternative to ssoService) pass the name of the sso service that will be query by the bluemix-helper-sso library
* relaxedUrls: (Optional) Array of urls that will not be authenticated. e.g: /img will match any url starting with /img. Note: "/" is a special case. Because it's the root, it will only match the root url (as to avoid relaxing the entire app)
``javascript`
var express = require('express'); //expressjs
var bluemixHelperConfig = require('bluemix-helper-config'); //helper config to locate sso service
var bluemixHelperSSO = require('bluemix-helper-sso'); //Helper SSO
...
var app = express();
//Locate the sso service by using regular expression (The name doesn't have to match exactly)
var ssoService = bluemixHelperConfig.vcapServices.getService( "sso" );
if ( ssoService) {
//Add SSO authentication to the app
bluemixHelperSSO(app, {
ssoService:ssoService,
relaxedUrls:[
"/js", "/img", "/css", "/bower_components", "templates"
]
});
}
...
Note: when running locally, you will need to tell the bluemix-helper-sso about the host and port, so it can properly compute the callback url. This is done using the global object of bluemix-helper-config module as follow:
`javascript `
...
var global = bluemixHelperConfig.global;
...
var port = process.env.VCAP_APP_PORT || 8082;
if (!process.env.VCAP_APP_HOST){
//Need to set the host and port for this app as we are running locally
global.appHost = "http://127.0.0.1";
global.appPort = port;
}
By default, bluemix-helper-sso is using an in-memory session store to manage to the session ids. Optionally, you can also configure it to use your own session store, by passing a configuration object in the sessionConfig field. The following code example shows how to use redis as the session store:
`javascript``
...
var ssoService = bluemixHelperConfig.vcapServices.getService( "pipes-sso" );
if ( ssoService ){
//Add SSO authentication to the app
bluemixHelperSSO(app, {
ssoService: ssoService,
relaxedUrls:[
"/js", "/img", "/css", "/bower_components", "templates"
],
createSessionStore: function( session ){
//Use redis service to create the store if available
var redisService = bluemixHelperConfig.vcapServices.getService("pipes-redis");
if ( redisService ){
var redisStore = require('connect-redis')(session);
return new redisStore({
host: redisService.credentials.hostname,
port: redisService.credentials.port,
pass: redisService.credentials.password
});
}
return null;
}
});
}
...