#AuthManager

#Przegląd

AuthManager to moduł zarządzania uwierzytelnianiem użytkowników w NocoBase, służący do rejestrowania różnych typów uwierzytelniania.

#Podstawowe użycie

const authManager = new AuthManager({
  // Służy do pobierania identyfikatora bieżącego uwierzytelniacza z nagłówka żądania
  authKey: 'X-Authenticator',
});

// Ustawia metody dla AuthManagera do przechowywania i pobierania uwierzytelniaczy
authManager.setStorer({
  get: async (name: string) => {
    return db.getRepository('authenticators').find({ filter: { name } });
  },
});

// Rejestruje typ uwierzytelniania
authManager.registerTypes('basic', {
  auth: BasicAuth,
  title: 'Password',
});

// Używa oprogramowania pośredniczącego do uwierzytelniania
app.resourceManager.use(authManager.middleware());

#Koncepcje

• Typ uwierzytelniania (AuthType): Różne metody uwierzytelniania użytkowników, takie jak: hasło, SMS, OIDC, SAML itp.
• Uwierzytelniacz (Authenticator): Encja metody uwierzytelniania, faktycznie przechowywana w kolekcji, odpowiadająca rekordowi konfiguracji określonego typu uwierzytelniania (AuthType). Jedna metoda uwierzytelniania może mieć wiele uwierzytelniaczy, odpowiadających wielu konfiguracjom, zapewniających różne metody uwierzytelniania użytkowników.
• Identyfikator uwierzytelniacza (Authenticator name): Unikalny identyfikator uwierzytelniacza, używany do określenia metody uwierzytelniania dla bieżącego żądania.

#Metody klasy

#constructor()

Konstruktor, tworzy instancję AuthManager.

#Sygnatura

• constructor(options: AuthManagerOptions)

#Typy

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

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

#Szczegóły

#AuthManagerOptions

#JwtOptions

#setStorer()

Ustawia metody przechowywania i pobierania danych uwierzytelniacza.

#Sygnatura

• setStorer(storer: Storer)

#Typy

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

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

#Szczegóły

#Authenticator

#Storer

Storer to interfejs do przechowywania uwierzytelniaczy, zawierający jedną metodę.

• get(name: string): Promise<Authenticator> - Pobiera uwierzytelniacz na podstawie jego identyfikatora. W NocoBase rzeczywisty zwracany typ to AuthModel.

#registerTypes()

Rejestruje typ uwierzytelniania.

#Sygnatura

• registerTypes(authType: string, authConfig: AuthConfig)

#Typy

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

#Szczegóły

#listTypes()

Pobiera listę zarejestrowanych typów uwierzytelniania.

#Sygnatura

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

#Szczegóły

#get()

Pobiera uwierzytelniacz.

#Sygnatura

• get(name: string, ctx: Context)

#Szczegóły

#middleware()

Oprogramowanie pośredniczące do uwierzytelniania. Pobiera bieżący uwierzytelniacz i wykonuje uwierzytelnianie użytkownika.