@entur/auth-provider

@entur/auth-provider

Authentication provider for Entur applications. Primarily aimed at easing transition between legacy keycloak and auth0 in internal and data provider applications.

Install

npm install --save @entur/auth-provider

Usage

import React from 'react'
import { render } from 'react-dom';

import AuthProvider, { useAuth } from '@entur/auth-provider';

// Provide either auth0Config, keycloakConfigUrl or both
const auth0Config = {}; //<-- see auth0 docs for required fields
const auth0ClaimsNamespace = ''; // <-- required for custom roles parsing
const keycloakConfigUrl = ''; // <-- where to find keycloak config

// defaultAuthMethod is optional, kc (keycloak) is default. User can override with query parameter:
// ?authMethod=kc|auth0
const defaultAuthMethod = 'auth0';

// If set to false, app will not automatically redirect to login page
// Note: Only works on auth0 - keycloak will always redirect automatically
const loginAutomatically = false;

const App = () => {
  const {
    isAuthenticated
  } = useAuth();

  return (
    <h1>
      {isAuthenticated ? 'Yay' : 'Oh no ...'}
    </h2>
  )
}

render(
  <AuthProvider
    auth0Config={auth0Config}
    auth0ClaimsNamespace={auth0ClaimsNamespace}
    keycloakConfigUrl={keycloakConfigUrl}
    defaultAuthMethod={defaultAuthMethod}
    loginAutomatically={loginAutomatically}
  >
    <App />
  <AuthProvider>
);

Release

First build:

npm run build

Then bump version:

npm version [major|minor|patch]

Then publish (use dry-run first to see what's included)

npm publish --dry-run

npm publish

Finally, push tags to GitHub

git push origin --tags

License

EUPL © entur/nrp