#AuthManager

#Genel Bakış

AuthManager, NocoBase'de farklı kullanıcı kimlik doğrulama türlerini kaydetmek için kullanılan kullanıcı kimlik doğrulama yönetim modülüdür.

#Temel Kullanım

const authManager = new AuthManager({
  // İstek başlığından (request header) mevcut kimlik doğrulayıcı tanımlayıcısını almak için kullanılır.
  authKey: 'X-Authenticator',
});

// AuthManager'ın kimlik doğrulayıcıları depolama ve alma yöntemlerini ayarlar.
authManager.setStorer({
  get: async (name: string) => {
    return db.getRepository('authenticators').find({ filter: { name } });
  },
});

// Bir kimlik doğrulama türü kaydeder.
authManager.registerTypes('basic', {
  auth: BasicAuth,
  title: 'Password',
});

// Kimlik doğrulama ara yazılımını (middleware) kullanır.
app.resourceManager.use(authManager.middleware());

#Kavramlar

• AuthType: Parola, SMS, OIDC, SAML gibi farklı kullanıcı kimlik doğrulama yöntemleridir.
• Authenticator: Bir kimlik doğrulama yönteminin varlığıdır. Gerçekte bir koleksiyon içinde saklanır ve belirli bir AuthType'ın yapılandırma kaydına karşılık gelir. Bir kimlik doğrulama yöntemi, birden fazla yapılandırmaya karşılık gelen ve farklı kullanıcı kimlik doğrulama yöntemleri sağlayan birden fazla kimlik doğrulayıcıya sahip olabilir.
• Authenticator name: Bir kimlik doğrulayıcının benzersiz tanımlayıcısıdır ve mevcut istek için kullanılacak kimlik doğrulama yöntemini belirlemek amacıyla kullanılır.

#Sınıf Metotları

#constructor()

constructor, bir AuthManager örneği oluşturur.

#İmza

• constructor(options: AuthManagerOptions)

#Tipler

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

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

#Detaylar

#AuthManagerOptions

#JwtOptions

#setStorer()

Kimlik doğrulayıcı verilerini depolama ve alma yöntemlerini ayarlar.

#İmza

• setStorer(storer: Storer)

#Tipler

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

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

#Detaylar

#Authenticator

#Storer

Storer, kimlik doğrulayıcı depolaması için bir arayüzdür ve tek bir metot içerir.

• get(name: string): Promise<Authenticator> - Tanımlayıcısına göre bir kimlik doğrulayıcıyı alır. NocoBase'de, gerçekte dönen tip AuthModel şeklindedir.

#registerTypes()

Bir kimlik doğrulama türü kaydeder.

#İmza

• registerTypes(authType: string, authConfig: AuthConfig)

#Tipler

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

type AuthConfig = {
  auth: AuthExtend<Auth>; // Kimlik doğrulama sınıfı.
  title?: string; // Kimlik doğrulama türünün görünen adı.
};

#Detaylar

#listTypes()

Kayıtlı kimlik doğrulama türlerinin listesini alır.

#İmza

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

#Detaylar

#get()

Bir kimlik doğrulayıcıyı alır.

#İmza

• get(name: string, ctx: Context)

#Detaylar

#middleware()

Kimlik doğrulama ara yazılımıdır (middleware). Mevcut kimlik doğrulayıcıyı alır ve kullanıcı kimlik doğrulamasını gerçekleştirir.