#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): طرق مصادقة المستخدم المختلفة، مثل: كلمة المرور، الرسائل القصيرة، 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;
};

#التفاصيل

#خيارات AuthManager (AuthManagerOptions)

#خيارات JWT (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>; // فئة المصادقة.
  title?: string; // الاسم المعروض لنوع المصادقة.
};

#التفاصيل

#الدالة listTypes()

تُرجع قائمة بأنواع المصادقة المسجلة.

#التوقيع

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

#التفاصيل

#الدالة get()

تُرجع مُصادِقًا.

#التوقيع

• get(name: string, ctx: Context)

#التفاصيل

#الدالة middleware()

وسيط المصادقة. يحصل على المُصادِق الحالي ويُجري مصادقة المستخدم.