#AuthManager

#Tổng quan

AuthManager là module quản lý xác thực người dùng trong NocoBase, dùng để đăng ký các kiểu xác thực người dùng khác nhau.

#Cách dùng cơ bản

const authManager = new AuthManager({
  // Dùng để lấy định danh authenticator hiện tại từ request header
  authKey: 'X-Authenticator',
});

// Đặt phương thức lưu trữ và lấy authenticator của AuthManager
authManager.setStorer({
  get: async (name: string) => {
    return db.getRepository('authenticators').find({ filter: { name } });
  },
});

// Đăng ký một kiểu xác thực
authManager.registerTypes('basic', {
  auth: BasicAuth,
  title: 'Password',
});

// Sử dụng middleware xác thực
app.resourceManager.use(authManager.middleware());

#Giải thích khái niệm

• Kiểu xác thực (AuthType): Các phương thức xác thực người dùng khác nhau, ví dụ: mật khẩu, SMS, OIDC, SAML, v.v.
• Authenticator (Authenticator): Thực thể của phương thức xác thực, được lưu trong bảng dữ liệu, tương ứng với một bản ghi cấu hình của một kiểu xác thực (AuthType). Một phương thức xác thực có thể có nhiều authenticator, tương ứng với nhiều cấu hình, cung cấp các phương thức xác thực người dùng khác nhau.
• Định danh authenticator (Authenticator name): Định danh duy nhất của authenticator, dùng để xác định phương thức xác thực được sử dụng cho request hiện tại.

#Phương thức của lớp

#constructor()

Constructor, tạo một instance AuthManager.

#Chữ ký

• constructor(options: AuthManagerOptions)

#Kiểu

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

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

#Thông tin chi tiết

#AuthManagerOptions

#JwtOptions

#setStorer()

Đặt phương thức lưu trữ và lấy dữ liệu authenticator.

#Chữ ký

• setStorer(storer: Storer)

#Kiểu

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

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

#Thông tin chi tiết

#Authenticator

#Storer

Storer là interface lưu trữ authenticator, gồm một phương thức.

• get(name: string): Promise<Authenticator> - Lấy authenticator theo định danh. Trong NocoBase kiểu thực tế trả về là AuthModel.

#registerTypes()

Đăng ký kiểu xác thực.

#Chữ ký

• registerTypes(authType: string, authConfig: AuthConfig)

#Kiểu

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

#Thông tin chi tiết

#listTypes()

Lấy danh sách các kiểu xác thực đã đăng ký.

#Chữ ký

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

#Thông tin chi tiết

#get()

Lấy authenticator.

#Chữ ký

• get(name: string, ctx: Context)

#Thông tin chi tiết

#middleware()

Middleware xác thực. Lấy authenticator hiện tại và thực hiện xác thực người dùng.