remix-auth-openid

OpenID Connect Strategy

This is a strategy for Remix Auth to authenticate users using OpenID Connect(OIDC). Unlike the existing OIDC strategy for Remix Auth, this strategy faithfully follow the OIDC protocol based on node-openid-client. For example, it checks ID token signature, nonce value and other parameters to prevent impersonate attacks.

Get Started

Install

npm i remix-auth-openid

Construct a strategy

To use this strategy, you need to create a strategy object by calling init method. The init method takes a configuration object and a callback function, which defined by remix auth strategy. The configuration parameters heavily rely on node-openid-client.

interface User extends OIDCStrategyBaseUser {
    name?: string;
}

const strategy = await OIDCStrategy.init<User>({
    issuer: "http://localhost:8080/realms/master",
    client_id: "<YOUR CLIENT ID>",
    client_secret: "YOUR CLIENT SECRET",
    redirect_uris: ["http://localhost:3000/callback"],
    scopes: ["openid", "profile"],
}, async ({tokens, request}): Promise<User> => {

    if (!tokens.id_token) {
        throw new Error("No id_token in response");
    }

    if (!tokens.access_token) {
        throw new Error("No access_token in response");
    }

   // You need to return User object
    return {
        ...tokens.claims(),
        accessToken: tokens.access_token,
        idToken: tokens.id_token,
        refreshToken: tokens.refresh_token,
        expiredAt: new Date().getTime() / 1000 + (tokens.expires_in ?? 0),
    }
})

authenticator.use(strategy, "your-oidc-provider-name");

Token refresh

This strategy supports token refresh. You can refresh tokens by calling refresh method. If the refresh token is expired, you will be redirected to the failureRedirect URL.

const strategy = await OIDCStrategy.init<User>({...})

const user = await authenticator.isAuthenticated(request, {
   failureRedirect: "/login",
})

const tokens = await strategy.refresh(user.refreshToken ?? "", {failureRedirect: "/login"});

Logout

When to logout, you can use front or backchannel logout by calling 'frontChannelLogout' or 'backChannelLogout' method of strategy based on OpenID Connect RP Initiated Logout 1.0. Then you should call 'logout' method of authenticator to clear the session and redirect to the logout URL.

front channel logout

const user = await authenticator.isAuthenticated(request);
await authenticator.logout(request)
await strategy.frontChannelLogout(user.idToken ?? "");

back channel logout

const user = await authenticator.isAuthenticated(request);
try {
    await strategy.backChannelLogout(user.idToken ?? "");
    await authenticator.logout(request, {redirectTo: redirectTo})
} catch (e) {
    console.error(e);
}

Starter Example

Example code is available in the Remix Auth OpenID Connect Starter Example.