#AuthManager

#Přehled

AuthManager je modul pro správu uživatelské autentizace v NocoBase, který slouží k registraci různých typů uživatelské autentizace.

#Základní použití

const authManager = new AuthManager({
  // Slouží k získání identifikátoru aktuálního autentizátoru z hlavičky požadavku
  authKey: 'X-Authenticator',
});

// Nastaví metody pro ukládání a načítání autentizátorů pro AuthManager
authManager.setStorer({
  get: async (name: string) => {
    return db.getRepository('authenticators').find({ filter: { name } });
  },
});

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

// Použije autentizační middleware
app.resourceManager.use(authManager.middleware());

#Vysvětlení pojmů

• Typ autentizace (AuthType): Různé metody uživatelské autentizace, například heslo, SMS, OIDC, SAML atd.
• Autentizátor (Authenticator): Entita pro autentizační metodu, která je skutečně uložena v kolekci, odpovídající konfiguračnímu záznamu určitého AuthType. Jedna autentizační metoda může mít více autentizátorů, odpovídajících více konfiguracím, poskytujících různé metody uživatelské autentizace.
• Identifikátor autentizátoru (Authenticator name): Jedinečný identifikátor autentizátoru, který se používá k určení autentizační metody pro aktuální požadavek.

#Metody třídy

#constructor()

Konstruktor, který vytváří instanci AuthManager.

#Podpis

• constructor(options: AuthManagerOptions)

#Typy

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

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

#Podrobnosti

#AuthManagerOptions

#JwtOptions

#setStorer()

Nastaví metody pro ukládání a načítání dat autentizátoru.

#Podpis

• setStorer(storer: Storer)

#Typy

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

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

#Podrobnosti

#Authenticator

#Storer

Storer je rozhraní pro ukládání autentizátorů, které obsahuje jednu metodu.

• get(name: string): Promise<Authenticator> - Získá autentizátor podle jeho identifikátoru. V NocoBase je skutečný vrácený typ AuthModel.

#registerTypes()

Registruje typ autentizace.

#Podpis

• registerTypes(authType: string, authConfig: AuthConfig)

#Typy

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

type AuthConfig = {
  auth: AuthExtend<Auth>; // Třída autentizace.
  title?: string; // Zobrazovaný název typu autentizace.
};

#Podrobnosti

#listTypes()

Získá seznam registrovaných typů autentizace.

#Podpis

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

#Podrobnosti

#get()

Získá autentizátor.

#Podpis

• get(name: string, ctx: Context)

#Podrobnosti

#middleware()

Autentizační middleware. Získá aktuální autentizátor a provede uživatelskou autentizaci.