Asgardeo Auth NodeJS SDK

🚧 This project is a work in progress. Please do not use this yet!

Table of Content

Introduction
Install
Getting Started
APIs
Data Storage
Develop
Contribute
License

Introduction

Asgardeo Auth NodeJS SDK provides the core methods that are needed to implement OIDC authentication in JavaScript/TypeScript based server side apps. This SDK can be used to build RESTful APIs with Javascript/Typescript based frameworks such as ExpressJS.

Prerequisite

Create an organization in Asgardeo if you don't already have one. The organization name you choose will be referred to as <org_name> throughout this documentation.

Install

Install the library from the npm registry.

npm install @asgardeo/auth-nodejs-sdk

Getting Started

// The SDK provides a client that can be used to carry out the authentication.
const { AsgardeoAuth } = require('@asgardeo/auth-nodejs-sdk');

// Create a config object containing the necessary configurations.
const config = {
    signInRedirectURL: "http://localhost:3000/sign-in",
    signOutRedirectURL: "http://localhost:3000/login",
    clientID: "client ID",
    serverOrigin: "https://api.asgardeo.io/t/<org_name>"
};

// Instantiate the AsgardeoAuthClient and pass the config object as an argument into the constructor.
const authClient = new AsgardeoAuth(config);

//If you are using ExpressJS, you may try something like this.
app.get("/login", (req, res) => {
    const redirectCallback = (url) => {
        if (url) {
            res.redirect(url);
            return;
        }
    }
    authClient.signIn(redirectCallback, req.query.code, req.query.session_state).then(response => {
        if (response.session) {
            //If the user is already authenticated, it will return the access token.
            //Set the cookie to maintain the session
            res.cookie('ASGARDEO_SESSION_ID', response.session, { maxAge: 900000, httpOnly: true, sameSite: true });
            res.status(200).send(response);
        }
    })catch((error) => {
        console.error(error);
    });
});

APIs

The SDK provides a client class called AsgardeoAuth that provides you with the necessary methods to implement authentication. You can instantiate the class and use the object to access the provided methods.

constructor

new AsgardeoAuth(config:AuthClientConfig<T>, store?: Store);

Arguments

config: AuthClientConfig<T>

This contains the configuration information needed to implement authentication such as the client ID, server origin etc. Additional configuration information that is needed to be stored can be passed by extending the type of this argument using the generic type parameter. For example, if you want the config to have an attribute called foo, you can create an interface called Bar in TypeScript and then pass that interface as the generic type to AuthClientConfig interface. To learn more about what attributes can be passed into this object, refer to the AuthClientConfig<T> section.
```
interface Bar {
    foo: string
}

const auth = new AsgardeoAuthClient(config: AuthClientConfig<Bar>);
}
```
Example
```
const config = {
    signInRedirectURL: "http://localhost:3000/sign-in",
    signOutRedirectURL: "http://localhost:3000/login",
    clientID: "client ID",
    serverOrigin: "https://api.asgardeo.io/t/<org_name>"
};
```
store: Store

This is the object of interface Store that is used by the SDK to store all the necessary data used ranging from the configuration data to the access token. By default, the SDK is packed with a built-in Memory Cache Store. If needed, you can implement the Store to create a class with your own implementation logic and pass an instance of the class as the second argument. This way, you will be able to get the data stored in your preferred place. To know more about implementing the Store interface, refer to the Data Storage section.

Description

This creates an instance of the AsgardeoAuthClient class and returns it.

Example
```
class NodeStore implements Store {
    public async setData(key: string, value: string): void {
        yourCustomStorage.setItem(key, value);
    }

    public async getData(key: string): string {
        return yourCustomStorage.getItem(key);
    }

    public async removeData(key: string): void {
        yourCustomStorage.removeItem(key);
    }
}

const store = new NodeStore();

const auth = new AsgardeoAuthClient(config: AuthClientConfig<Bar>, store: store);
```

signIn

signIn(authURLCallback: AuthURLCallback, authorizationCode?: string, sessionState?: string): Promise<URLResponse | NodeTokenResponse>

Arguments

authURLCallback: AuthURLCallback

This is the callback function which is used to redirect the user to the authorization URL.
authorizationCode: string (optional)

This is the authorization code obtained from Asgardeo after a user signs in.
sessionState: string (optional)

This is the session state obtained from Asgardeo after a user signs in.

Returns

A Promise that resolves with a Promise that resolves with the NodeTokenResponse object.

Description

This method first checks if the authorizationCode or sessionState is available in the arguments. If they exists, It will request the access token for the respective authorization code and returns a promise that will be resolved with the NodeTokenResponse object. If not, it will obtain the authorization URL and callback the authURLCallback function with the authorization URL. The user can be redirected to this URL to authenticate themselves and authorize the client.

Note: Make sure you call the same signIn() method in the signInRedirectURL path to request the access token successfully.

Example (Express JS)

authClient.signIn(req.query.code, req.query.session_state).then(response => {
        //URL property will available if the user has not been authenticated already
        if (response.hasOwnProperty('url')) {
            res.redirect(response.url)
        } else {
            //Set the cookie
            res.cookie('ASGARDEO_SESSION_ID', response.session, { maxAge: 900000, httpOnly: true, SameSite: true });
            res.status(200).send(response)
        }
    });

signOut

signOut(sessionId: string): Promise<string>

Returns

signOutURL: Promise<string>

The user should be redirected to this URL in order to sign out of the server.

Description

This clears the authentication data from the store, generates the sign-out URL and returns it. This should be used only if you want to sign out the user from the Asgardeo as well.

Example

Note: Make sure to invalidate the cookie ID when sending the response to the client

// This should be within an async function.
const signOutURL = await authClient.signOut("a2a2972c-51cd-5e9d-a9ae-058fae9f7927");
//If you are using Express JS you may try this to invalidate the cookie
 res.cookie('ASGARDEO_SESSION_ID',null, { maxAge: 0 });
 res.redirect(signOutURL);

getIDToken

getIDToken(sessionId: string): Promise<string>

Returns

idToken: Promise<string> A Promise that resolves with the ID Token.

Description

This method returns the id token.

Example

const idToken = await authClient.getIDToken("a2a2972c-51cd-5e9d-a9ae-058fae9f7927");

isAuthenticated

isAuthenticated(sessionId: string): Promise<boolean>

Returns

isAuth: boolean A boolean value that indicates of the user is authenticated or not.

Description

This method returns a boolean value indicating if the user is authenticated or not.

Example

// This should be within an async function.
const isAuth = await authClient.isAuthenticated("a2a2972c-51cd-5e9d-a9ae-058fae9f7927");

Data Storage

Since the SDK was developed with the view of being able to support various frameworks such as ExpressJS, Fastify and Next JS, the SDK allows developers to use their preferred mode of storage. To that end, the SDK allows you to pass a store object when instantiating the AsgardeoAuthClient. This store object contains methods that can be used to store, retrieve and delete data. The SDK provides a Store interface that you can implement to create your own Store class. You can refer to the Store section to learn mire about the Store interface.

There are three methods that are to be implemented by the developer. They are

setData
getData
removeData

The setData method is used to store data. The getData method is used to retrieve data. The removeData method is used to delete data. The SDK converts the data to be stored into a JSON string internally and then calls the setData method to store the data. The data is represented as a key-value pairs in the SDK. The SDK uses four keys internally and you can learn about them by referring to the Data Layer section. So, every JSON stringified data value is supposed to be stored against the passed key in the data store. A sample implementation of the Store class using the browser session storage is given here.

class NodeStore implements Store {
    public setData(key: string, value: string): void {
        sessionStorage.setItem(key, value);
    }

    public getData(key: string): string {
        return sessionStorage.getItem(key);
    }

    public removeData(key: string): void {
        sessionStorage.removeItem(key);
    }
}

Models

AuthClientConfig<T>

This model has the following attributes.

Attribute	Required/Optional	Type	Default Value	Description
`signInRedirectURL`	Required	`string`	""	The URL to redirect to after the user authorizes the client app. eg: `https//localhost:3000/sign-in`
`signOutRedirectURL`	Optional	`string`	The `signInRedirectURL` URL will be used if this value is not provided.	The URL to redirect to after the user
`clientHost`	Optional	`string`	The origin of the client app obtained using `window.origin`	The hostname of the client app. eg: `https://localhost:3000`
`clientID`	Required	`string`	""	The client ID of the OIDC application hosted in the Asgardeo.
`clientSecret`	Optional	`string`	""	The client secret of the OIDC application
`enablePKCE`	Optional	`boolean`	`true`	Specifies if a PKCE should be sent with the request for the authorization code.
`prompt`	Optional	`string`	""	Specifies the prompt type of an OIDC request
`responseMode`	Optional	`ResponseMode`	`"query"`	Specifies the response mode. The value can either be `query` or `form_post`
`scope`	Optional	`string[]`	`["openid"]`	Specifies the requested scopes.
`serverOrigin`	Required	`string`	""	The origin of the Identity Provider. eg: `https://api.asgardeo.io/t/<org_name>`
`endpoints`	Optional	`OIDCEndpoints`	OIDC Endpoints Default Values	The OIDC endpoint URLs. The SDK will try to obtain the endpoint URLS
`overrideWellEndpointConfig`	Optional	`boolean`	`false`	If this option is set to `true`, then the `endpoints` object will override endpoints obtained
`wellKnownEndpoint`	Optional	`string`	`"/oauth2/token/.well-known/openid-configuration"`	The URL of the `.well-known` endpoint.
`validateIDToken`	Optional	`boolean`	`true`	Allows you to enable/disable JWT ID token validation after obtaining the ID token.
`clockTolerance`	Optional	`number`	`60`	Allows you to configure the leeway when validating the id_token.
`sendCookiesInRequests`	Optional	`boolean`	`true`	Specifies if cookies should be sent in the requests.

The AuthClientConfig<T> can be extended by passing an interface as the generic type. For example, if you want to add an attribute called foo to the config object, you can create an interface called Bar and pass that as the generic type into the AuthClientConfig<T> interface.

interface Bar {
    foo: string
}

const config: AuthClientConfig<Bar> ={
    ...
}

Store

Method	Required/Optional	Arguments	Returns	Description
`setData`	Required	key: `string`, value: `string`	`Promise<void>`	This method saves the passed value to the store. The data to be saved is JSON stringified so will be passed by the SDK as a string.
`getData`	Required	key: `string`\|`string`	This method retrieves the data from the store and returns a Promise that resolves with it. Since the SDK stores the data as a JSON string, the returned value will be a string.
`removeData`	Required	key: `string`	`Promise<void>`	Removes the data with the specified key from the store.

NodeTokenResponse

Method	Type	Description
`accessToken`	`string`	The access token.
`idToken`	`string`	The id token.
`expiresIn`	`string`	The expiry time in seconds.
`scope`	`string`	The scope of the token.
`refreshToken`	`string`	The refresh token.
`tokenType`	`string`	The token type.
`session`	`string`	The session ID.

AuthURLCallback

(url: string): void;

Description

This method is used to handle the callback from the signIn method. You may use this function to get the authorization URL and redirect the user to authorize the application.

Example

//You may use this in Express JS
const urlCallbackHandler = (url: string): void => {
    res.redirect(url);
}

Develop

Prerequisites

Node.js (version 10 or above).
npm package manager.

Installing Dependencies

The repository is a mono repository. The SDK repository is found in the lib directory. You can install the dependencies by running the following command at the root.

npm run build

Contribute

Please read Contributing to the Code Base for details on our code of conduct, and the process for submitting pull requests to us.

Reporting issues

We encourage you to report issues, improvements, and feature requests creating Github Issues.

Important: And please be advised that security issues must be reported to security@wso2com, not as GitHub issues, in order to reach the proper audience. We strongly advise following the WSO2 Security Vulnerability Reporting Guidelines when reporting the security issues.

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.

DimalChandrasiri/asgardeo-auth-node-sdk

Asgardeo Auth NodeJS SDK

Table of Content

Introduction

Prerequisite

Install

Getting Started

APIs

constructor

Arguments

Example

Description

Example

signIn

Arguments

Returns

Description

Example (Express JS)

signOut

Returns

Description

Example

getIDToken

Returns

Description

Example

isAuthenticated

Returns

Description

Example

Data Storage

Models

AuthClientConfig<T>

Store

NodeTokenResponse

AuthURLCallback

Description

Example

Develop

Prerequisites

Installing Dependencies

Contribute

Reporting issues

License