#AuthManager

#Огляд

AuthManager — це модуль керування автентифікацією користувачів у NocoBase, який використовується для реєстрації різних типів автентифікації користувачів.

#Базове використання

const authManager = new AuthManager({
  // Використовується для отримання ідентифікатора поточного автентифікатора із заголовка запиту
  authKey: 'X-Authenticator',
});

// Встановлює методи для AuthManager для зберігання та отримання автентифікаторів
authManager.setStorer({
  get: async (name: string) => {
    return db.getRepository('authenticators').find({ filter: { name } });
  },
});

// Реєструє тип автентифікації
authManager.registerTypes('basic', {
  auth: BasicAuth,
  title: 'Password',
});

// Використовує проміжне ПЗ для автентифікації
app.resourceManager.use(authManager.middleware());

#Концепції

• Тип автентифікації (AuthType): Різні методи автентифікації користувачів, наприклад: пароль, SMS, OIDC, SAML тощо.
• Автентифікатор (Authenticator): Сутність методу автентифікації, яка фактично зберігається в колекції, відповідає запису конфігурації певного AuthType. Один метод автентифікації може мати кілька автентифікаторів, що відповідають різним конфігураціям, надаючи різні методи автентифікації користувачів.
• Ідентифікатор автентифікатора (Authenticator name): Унікальний ідентифікатор для автентифікатора, використовується для визначення методу автентифікації для поточного запиту.

#Методи класу

#constructor()

Конструктор, створює екземпляр AuthManager.

#Підпис

• constructor(options: AuthManagerOptions)

#Типи

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

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

#Деталі

#AuthManagerOptions

#JwtOptions

#setStorer()

Встановлює методи для зберігання та отримання даних автентифікатора.

#Підпис

• setStorer(storer: Storer)

#Типи

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

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

#Деталі

#Authenticator

#Storer

Storer — це інтерфейс для зберігання автентифікаторів, що містить один метод.

• get(name: string): Promise<Authenticator> - Отримує автентифікатор за його ідентифікатором. У NocoBase фактичний тип, що повертається, — це AuthModel.

#registerTypes()

Реєструє тип автентифікації.

#Підпис

• registerTypes(authType: string, authConfig: AuthConfig)

#Типи

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

#Деталі

#listTypes()

Отримує список зареєстрованих типів автентифікації.

#Підпис

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

#Деталі

#get()

Отримує автентифікатор.

#Підпис

• get(name: string, ctx: Context)

#Деталі

#middleware()

Проміжне ПЗ для автентифікації. Отримує поточний автентифікатор та виконує автентифікацію користувача.