Name: uaa-singular
Owner: Cloud Foundry
Description: Singular Login for Web Applications
Created: 2016-10-15 00:51:26.0
Updated: 2018-05-24 01:32:38.0
Pushed: 2018-05-24 01:32:36.0
Homepage: null
Size: 260
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
Singular is a Javascript module that enables web applications to easily identify a user via their authenticated browser session at the UAA identity server. Singular has no external client-side dependencies, and the latest version of Singular will work with UAA 4.10.0 and later.
Singular is licensed under the Apache License, Version 2.0.
Singular should work with any web browser which supports Javascript localStorage, postMessage, and DOMContentLoaded, which includes these versions of major desktop browsers.
| 
| 
| 
| 
| 
| 
|
|:————————————————————————————:|:—————————————————————————————:|:——————————————————————————————————:|:———————————————————————————:|:————————————————————————————:|:————————————————————————————:|
| 41+ ? | 17+ ? | 11+ ? | 28+ ? | 9+ ? | 12.0+ ? |
Singular requires a configured OAuth client in the UAA which requires at least the following properties. For more information about creating clients in the UAA, see the API documentation.
| Property | Value |
|————————-:|:————-|
| authorized_grant_types | implicit |
| scope | ["openid"] |
| autoapprove | ["openid"] |
| redirect_uri | [ "http://<singular-domain>/PATH/TO/SINGULAR/postauth.html","http://<singular-domain>/PATH/TO/SINGULAR/postaccess.html" ] |
For the example index.html, you will also need to add http://<singular-domain>/index.html to the redirect_uri configuration. /PATH/TO/SINGULAR/ should be updated to reflect the path to your singularLocation, which is the static assets directory where singular.js and associated html files are served from your app.
Alternatively, you can provide http://<singular-domain>/** as the redirect_uri if you believe you will not have any concerns about redirecting users to any path location within your domain.
| Singular Version | UAA Version | UAA-Release Version | |——————|————-|———————| | v1.0.X | 3.8.0 + | v20 + | | v1.2.X | 4.10.0 + | v55 + | | v1.3.X | 4.10.0 + | v55 + |
The uaa-singular package can be downloaded with the command: npm install uaa-singular
This will create the node_modules directory in your current directory (if one doesn't exist yet) and will download the package to that directory.
To enable Singular login on a page, include the main script in the header:
<script type="application/javascript" src="node_modules/uaa-singular/singular/singular.js"></script>
Then use the Singular.init method to configure and start the authentication. The call to Singular.init can occur anywhere in the DOM.
ipt type="application/javascript">
ngular.init({
// Static assets directory where singular.js and associated html files are served from your app
singularLocation: './node_modules/uaa-singular/singular/',
clientId: 'exampleClient',
uaaLocation: 'https://login.example.com',
onIdentityChange: function (identity) {
// perform custom login behavior
},
onLogout: function () {
// perform logout behavior
}
;
ript>
It is possible to obtain an access token using sungular library.
Use Singular.access function to do that. This function returns a promise
tokenPromise = Singular.access('resource.read,someotherscope');
tokenPromise
.then(function(token){
console.log("Access token with resource.read and someotherscope scopes: " + token )
})
.catch(function(error){
console.log("Error: " + error )
})
Make sure client has scopes resource.read and someotherscope.
Define all custom behavior for the application in onIdentityChange. The argument passed to this callback will either be an object containing the identity claims of the logged-in user, or null indicating a logout. The application should treat this identity idempotently, as this callback may be invoked many times in the lifetime of the page as users log in and out of the UAA. The properties available for configuration in Singular can all be passed as fields in the argument of init.
| Property | Description | Default |
|——————-:|:———————————————————————————————————————————————————————————————————————————-:|:——————————-|
| singularLocation | location where singular.js and associated html files are served from your app | by defaults detects the location of the singular.js script - this will not work and must be set explicitly if you webpack your Javascript into a single file |
| onIdentityChange | a function of one argument which is used as a handler for any changes in the currently logged-in user | |
| onLogout | a function that specifies the actions to take upon ending the user's session | |
| clientId | the ID of an implicit-grant OAuth client on the UAA server | "client" |
| checkInterval | milliseconds between subsequent checks for session changes | 1000 |
| uaaLocation | the location of the UAA server with no ending slash, as a URI including the protocol | "http://localhost:8080/uaa" |
| storageKey | the key to use in the local browser storage for storing the identity claims of the current user, which need be reconfigured only in the case that the default value conflicts with an existing storage key used by the application | "singularUserIdentityClaims" |
| authTimeout | milliseconds to wait for an identity token to be retrieved before treating it as an error and logging the user out | 20000 |
Included in this repository is an /example directory which showcases a minimal use of Singular. Before running the example, you must alter the index.html file. Inside of the call to Singular.init, you must provide the location of a running UAA and the client_id of an OAuth client on that server. The OAuth client must meet these requirements. Once you have made these configurations, run:
example
install
run start-uaa-singular-app
Once started, the application will display the username of the currently logged-in user. If no user is logged in, it will present a link to the login page. Logging into and out of the UAA in another tab or window should update the page appropriately.