Wondering what’s next for npm?Check out our public roadmap! »

@oada/oada-id-client

1.0.8 • Public • Published

Build Status Coverage Status Dependency Status License

oada-id-client

JavaScript client library for OADA identity. Can be used both in NodeJS and in the browser.

Getting Started

Installation

The library is not yet published with npm, but it can be installed from the GitHub repo.

$ npm install OADA/oada-id-client-js

Browser Code Generation

The code to use in the browser can be generated with the following command:

$ npm run bundle

This will create the file dist/bundle.js.

Examples

Connect Style "Middleware" Wrapper Usage

Version of the library functions which wrap the core functionality for use as connect style "middleware". This can be used in a NodeJS server using a compatible web development framework, such as express.

For a working example of using this wrapper, see the on server example.

getIDToken(domain, options)

Middleware for generating an ID token request against an OADA identity provider.

Parameters

domain string of domain with which to log in the user. The value passed to the function can be overridden by a query or form parameter with a name of domain.

options object containing at least the following properties:

  • metadata object containg client metadata, or string of a software_statement JWT
  • privateKey
    • pem string or buffer containing your client's PEM encoded private RSA key
    • kid string containing the key ID parameter, for finding the corresponding public key where your client is registered
  • params Optional OpenID Connect parameters placed in params as string properties will be used (e.g. display, prompt, login_hint)

Usage Example

var options = {
    metadata: { /* See spec linked above */ },
    privateKey: {
        pem: fs.readFileSync('/path/to/key.pem'),
        kid: 'key_id_corresponding_to_pem',
    },
};
 
app.use('/getIdToken',
    oadaIdClient.getIDToken('some.oada-identity-provider.com', options));

getAccessToken(domain, options)

Middleware for generating an access token request against an OADA compliant API.

Parameters

domain string of domain from which to get an OADA API access token. The value passed to the function can be overridden by a query or form parameter with a name of domain.

options object containing at least the following properties:

  • metadata object containg client metadata, or string of a software_statement JWT
  • privateKey
    • pem string or buffer containing your client's PEM encoded private RSA key
    • kid string containing the key ID parameter, for finding the corresponding public key where your client is registered
  • scope space separated string of OAuth scopes for the request access token to have.
  • params Optional OpenID Connect parameters placed in params as string properties will be used (e.g. display, prompt, login_hint)

Usage Example

var options = {
    metadata: { /* See spec linked above */ },
    privateKey: {
        pem: fs.readFileSync('/path/to/key.pem'),
        kid: 'key_id_corresponding_to_pem',
    },
    scope: 'some.oada.defined.scope',
};
 
app.use('/getAccessToken',
    oadaIdClient.getAccessToken('some.oada-cloud-provider.com', options));

handleRedirect()

Middleware for handling redirects from getIDToken or getAccessToken middlewares. In most case you will apply this middleware in two locations, one to receive getIDToken redirects and another to receive getAccessToken redirects.

Usage Example

// Handle ID token redirects
app.use('/url/referenced/by/getIDToken/redirect_uri',
    oadaIdClient.handleRedirect());
app.use('/url/referenced/by/getIDToken/redirect_uri',
    function (req, res, next) {
        // ID token is in req.token
        console.dir(req.token);
    });
 
// Handle access token redirects
app.use('/url/referenced/by/getAccessToken/redirect_uri',
    oadaIdClient.handleRedirect());
app.use('/url/referenced/by/getAccessToken/redirect_uri',
    function (req, res, next) {
        // Access token is in req.token
        console.dir(req.token);
    });

Browser Wrapper Usage

Version of the library functions which wrap the core functionality for easy use in the browser.

For a working example of using this wrapper, see the in browser example.

getIDToken(domain, options, callback)

Asynchronous function for generating an ID token request against an OADA identity provider.

Parameters

domain string of domain with which to log in the user.

options object containing at least the following properties:

Optional OpenID Connect parameters placed in options as string properties will be used (e.g. display, prompt, login_hint).

callback function of the form function(err, idToken).

Usage Example

var options = {
    metadata: { /* See spec linked above */ }
};
 
var domain; // Set domain based on text box, dropdown, etc.
 
oadaIdClient.getIDToken(domain, options, function(err, idToken) {
    if (err) { return console.dir(err); } // Soemthing went wrong
 
    console.dir(idToken);
});

getAccessToken(domain, options, callback)

Asynchronous function for generating an access token request against an OADA compliant API.

Parameters

domain string of domain from which to get an OADA API access token. The value passed to the function can be overridden by a query or form parameter with a name of domain.

options object containing at least the following properties:

callback function of the form function(err, accessToken).

Usage Example

var options = {
    metadata: { /* See spec linked above */ },
    scope: 'some.oada.defined.scope',
};
 
var domain; // Set domain based on text box, dropdown, etc.
 
oadaIdClient.getAccessToken(domain, options, function(err, accessToken) {
    if (err) { return console.dir(err); } // Soemthing went wrong
 
    console.dir(accessToken);
});

handleRedirect()

Function for handling redirects generated by getIDToken or getAccessToken function. Simply needs to be called by the page served from the URL corresponding to redirect_uri.

Usage Example

<!-- Page served at redirect_uri for getIDToken and/or getAccessToken -->
<html>
<head>
    <script src="path/to/library/browser/code.js"></script> 
    <script>oadaIdClient.handleRedirect();</script> 
</head>
</html>

Base Library Usage

Not yet documented.

References

  1. OpenID Connect Core 1.0
  1. OAuth 2.0 Authorization Framework
  1. JSON Web Key (JWK) Draft 31
  1. OAuth 2.0 Dynamic Client Registration Protocol

Install

npm i @oada/oada-id-client

DownloadsWeekly Downloads

13

Version

1.0.8

License

Apache-2.0

Unpacked Size

2.65 MB

Total Files

39

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar