Skip to content

Latest commit

 

History

History
90 lines (60 loc) · 3.47 KB

README.md

File metadata and controls

90 lines (60 loc) · 3.47 KB

@open-pioneer/authentication

This package provides a central service to handle the current user's session. It cannot be used on its own, but requires an authentication plugin, that implements the actual authentication flow.

Usage

Retrieving the current authentication state

To inspect the current authentication state, inject a reference to the AuthService by referencing "authentication.AuthService".

The methods getAuthState() and getSessionInfo() return information about the current state:

const authService = ...; // injected

// Returns SessionInfo if the user is currently logged in, or undefined otherwise.
const sessionInfo = await authService.getSessionInfo();

// Like the above, but synchronous and includes intermediate states like "pending".
const state = authService.getAuthState();

// Don't forget to clean up event handles in the future
handle.destroy();

Enforcing authentication

To make sure that only users, that are logged in, can use an application, enforce the authentication flow by wrapping the application with the <ForceAuth /> component:

// AppUI.jsx
import { ForceAuth } from "@open-pioneer/authentication";

export function AppUI() {
    return (
        <ForceAuth>
            <TheRestOfYourApplication />
        </ForceAuth>
    );
}

ForceAuth renders its children (your application) if the user is authenticated. Otherwise, it renders the authentication plugin's fallback component (see below). It is updated if the authentication state changes.

Fallback

If the user is not logged in, a fallback is shown to the user. The fallback must be implemented in the authentication plugin. Depending on the implementation of the authentication plugin, a fallback can be a login prompt, or a simple message. Some plugins do not provide a visual fallback but an "effect" instead: an action to perform, such as a redirect to the authentication provider.

Rendering of the login fallback can be customized by passing custom properties (fallbackProps) or by supplying a custom render function (renderFallback), see the API documentation.

Triggering logout

To explicitly end the current session, call the AuthService's logout() method:

const authService = ...; // injected
authService.logout();

Implementing an authentication plugin

An authentication plugin (providing authentication.AuthPlugin) must be present in the application to support authentication. The plugin implements the actual authentication flow.

The plugin must implement the AuthPlugin TypeScript interface exported by this package:

  • Provide the current authentication state by implementing getAuthState(). When authenticated, a user's authentication state contains session information, such as the user's id, an optional display name and arbitrary additional attributes that can be defined by the plugin.

    The state should be implemented based on signals (@conterra/reactivity-core). This way, updates to the current state are transported automatically.

  • Return the login behavior value (a React component or a function to call) by implementing getLoginBehavior(). This could be a login dialog, a "forbidden" message ("fallback") or a function implementing a redirect ("effect").

  • Implement the logout() method: this method is called when the user attempts to end their session.

An example is available in this project's auth-sample.

License

Apache-2.0 (see LICENSE file)