AuthManager

Overview

AuthManager is the user authentication management module in NocoBase, used to register different user authentication types.

Basic Usage

const authManager = new AuthManager({
  // Used to get the current authenticator identifier from the request header
  authKey: 'X-Authenticator',
});

// Set the methods for AuthManager to store and retrieve authenticators
authManager.setStorer({
  get: async (name: string) => {
    return db.getRepository('authenticators').find({ filter: { name } });
  },
});

// Register an authentication type
authManager.registerTypes('basic', {
  auth: BasicAuth,
  title: 'Password',
});

// Use the authentication middleware
app.resourceManager.use(authManager.middleware());

Concepts

• AuthType: Different user authentication methods, such as password, SMS, OIDC, SAML, etc.
• Authenticator: The entity for an authentication method, actually stored in a collection, corresponding to a configuration record of a certain AuthType. One authentication method can have multiple authenticators, corresponding to multiple configurations, providing different user authentication methods.
• Authenticator name: The unique identifier for an authenticator, used to determine the authentication method for the current request.

Class Methods

constructor()

Constructor, creates an AuthManager instance.

Signature

• constructor(options: AuthManagerOptions)

Types

export interface JwtOptions {
  secret: string;
  expiresIn?: string;
}

export type AuthManagerOptions = {
  authKey: string;
  default?: string;
  jwt?: JwtOptions;
};

Details

AuthManagerOptions

JwtOptions

setStorer()

Sets the methods for storing and retrieving authenticator data.

Signature

• setStorer(storer: Storer)

Types

export interface Authenticator = {
  authType: string;
  options: Record<string, any>;
  [key: string]: any;
};

export interface Storer {
  get: (name: string) => Promise<Authenticator>;
}

Details

Authenticator

Storer

Storer is the interface for authenticator storage, containing one method.

• get(name: string): Promise<Authenticator> - Gets an authenticator by its identifier. In NocoBase, the actual returned type is AuthModel.

registerTypes()

Registers an authentication type.

Signature

• registerTypes(authType: string, authConfig: AuthConfig)

Types

export type AuthExtend<T extends Auth> = new (config: Config) => T;

type AuthConfig = {
  auth: AuthExtend<Auth>; // The authentication class.
  title?: string; // The display name of the authentication type.
};

Details

listTypes()

Gets the list of registered authentication types.

Signature

• listTypes(): { name: string; title: string }[]

Details

get()

Gets an authenticator.

Signature

• get(name: string, ctx: Context)

Details

middleware()

Authentication middleware. Gets the current authenticator and performs user authentication.