#AuthManager

#Descripción general

AuthManager es el módulo de gestión de autenticación de usuarios en NocoBase. Su función principal es registrar diferentes tipos de autenticación de usuarios.

#Uso básico

const authManager = new AuthManager({
  // Se utiliza para obtener el identificador del autenticador actual del encabezado de la solicitud.
  authKey: 'X-Authenticator',
});

// Establece los métodos para que AuthManager almacene y recupere autenticadores.
authManager.setStorer({
  get: async (name: string) => {
    return db.getRepository('authenticators').find({ filter: { name } });
  },
});

// Registra un tipo de autenticación.
authManager.registerTypes('basic', {
  auth: BasicAuth,
  title: 'Password',
});

// Utiliza el middleware de autenticación.
app.resourceManager.use(authManager.middleware());

#Conceptos clave

• Tipo de autenticación (AuthType): Se refiere a los diferentes métodos de autenticación de usuarios, como contraseña, SMS, OIDC, SAML, etc.
• Autenticador (Authenticator): Es la entidad que representa un método de autenticación. Se almacena en una colección y corresponde a un registro de configuración de un AuthType específico. Un método de autenticación puede tener múltiples autenticadores, cada uno con su propia configuración, para ofrecer diferentes formas de autenticar a los usuarios.
• Identificador del autenticador (Authenticator name): Es el identificador único de un autenticador, utilizado para determinar el método de autenticación que se aplica a la solicitud actual.

#Métodos de la clase

#constructor()

Este constructor crea una instancia de AuthManager.

#Firma

• constructor(options: AuthManagerOptions)

#Tipos

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

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

#Detalles

#AuthManagerOptions

#JwtOptions

#setStorer()

Establece los métodos para almacenar y recuperar los datos del autenticador.

#Firma

• setStorer(storer: Storer)

#Tipos

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

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

#Detalles

#Authenticator

#Storer

Storer es la interfaz para el almacenamiento de autenticadores y contiene un método.

• get(name: string): Promise<Authenticator> - Obtiene un autenticador mediante su identificador. En NocoBase, el tipo de retorno real es AuthModel.

#registerTypes()

Registra un tipo de autenticación.

#Firma

• registerTypes(authType: string, authConfig: AuthConfig)

#Tipos

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

type AuthConfig = {
  auth: AuthExtend<Auth>; // La clase de autenticación.
  title?: string; // El nombre de visualización del tipo de autenticación.
};

#Detalles

#listTypes()

Obtiene la lista de tipos de autenticación registrados.

#Firma

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

#Detalles

#get()

Obtiene un autenticador.

#Firma

• get(name: string, ctx: Context)

#Detalles

#middleware()

Middleware de autenticación. Obtiene el autenticador actual y realiza la autenticación del usuario.