#AuthManager

#Panoramica

AuthManager è il modulo di gestione dell'autenticazione utente in NocoBase, utilizzato per registrare diversi tipi di autenticazione utente.

#Utilizzo di base

const authManager = new AuthManager({
  // Utilizzato per ottenere l'identificatore dell'autenticatore corrente dall'header della richiesta
  authKey: 'X-Authenticator',
});

// Imposta i metodi per AuthManager per archiviare e recuperare gli autenticatori
authManager.setStorer({
  get: async (name: string) => {
    return db.getRepository('authenticators').find({ filter: { name } });
  },
});

// Registra un tipo di autenticazione
authManager.registerTypes('basic', {
  auth: BasicAuth,
  title: 'Password',
});

// Utilizza il middleware di autenticazione
app.resourceManager.use(authManager.middleware());

#Spiegazione dei concetti

• Tipo di autenticazione (AuthType): Diversi metodi di autenticazione utente, come password, SMS, OIDC, SAML, ecc.
• Autenticatore (Authenticator): L'entità per un metodo di autenticazione, effettivamente memorizzata in una collezione, corrispondente a un record di configurazione di un certo tipo di autenticazione (AuthType). Un metodo di autenticazione può avere più autenticatori, corrispondenti a più configurazioni, fornendo diversi metodi di autenticazione utente.
• Identificatore dell'autenticatore (Authenticator name): L'identificatore univoco per un autenticatore, utilizzato per determinare il metodo di autenticazione per la richiesta corrente.

#Metodi di classe

#constructor()

Costruttore, crea un'istanza di AuthManager.

#Firma

• constructor(options: AuthManagerOptions)

#Tipi

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

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

#Dettagli

#AuthManagerOptions

#JwtOptions

#setStorer()

Imposta i metodi per l'archiviazione e il recupero dei dati dell'autenticatore.

#Firma

• setStorer(storer: Storer)

#Tipi

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

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

#Dettagli

#Authenticator

#Storer

Storer è l'interfaccia per l'archiviazione degli autenticatori, contenente un metodo.

• get(name: string): Promise<Authenticator> - Recupera un autenticatore tramite il suo identificatore. In NocoBase, il tipo restituito effettivo è AuthModel.

#registerTypes()

Registra un tipo di autenticazione.

#Firma

• registerTypes(authType: string, authConfig: AuthConfig)

#Tipi

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.
};

#Dettagli

#listTypes()

Recupera l'elenco dei tipi di autenticazione registrati.

#Firma

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

#Dettagli

#get()

Recupera un autenticatore.

#Firma

• get(name: string, ctx: Context)

#Dettagli

#middleware()

Middleware di autenticazione. Recupera l'autenticatore corrente ed esegue l'autenticazione dell'utente.