Skip to main content

CertificateProviderParameters

@webda/auth

Class: CertificateProviderParameters

Defined in: packages/auth/src/certificate/certificate.service.ts:28

CertificateProvider parameters

Extends​

  • ServiceParameters

Constructors​

Constructor​

new CertificateProviderParameters(): CertificateProviderParameters

Returns​

CertificateProviderParameters

Inherited from​

ServiceParameters.constructor

Properties​

allowedIssuers?​

optional allowedIssuers?: string[]

Defined in: packages/auth/src/certificate/certificate.service.ts:44

Only certificates whose issuer common name or distinguished name ("O=Webda, CN=ca") is listed are accepted, undefined accepts every issuer trusted by the TLS layer

allowedSubjects?​

optional allowedSubjects?: string[]

Defined in: packages/auth/src/certificate/certificate.service.ts:49

Only certificates whose subject distinguished name ("O=Webda, CN=alice") matches one of these regular expressions are accepted, undefined accepts every subject

autoRegister​

autoRegister: boolean

Defined in: packages/auth/src/certificate/certificate.service.ts:55

Register a user on the first request of an unknown certificate; otherwise the certificate has to be linked to a logged user with Auth.Certificate.Link

Default​

false

cacheTtl​

cacheTtl: number

Defined in: packages/auth/src/certificate/certificate.service.ts:65

How long a certificate resolved to a user is remembered, in milliseconds (0 disables the cache)

Default​

60000

identityField​

identityField: CertificateIdentityField

Defined in: packages/auth/src/certificate/certificate.service.ts:39

Certificate field used as ident uid: the SHA-256 fingerprint pins one certificate, the other fields survive a certificate renewal

Default​

"fingerprint256"

mode​

mode: "login" | "factor"

Defined in: packages/auth/src/certificate/certificate.service.ts:33

factor only adds mtls to a session already authenticated as the certificate's linked user.

Default​

"login"

roles?​

optional roles?: Record<string, string[]>

Defined in: packages/auth/src/certificate/certificate.service.ts:60

Roles of the certificate sessions by subject attribute: { "OU=admins": ["admin"] } gives the role admin to certificates having an OU admins

type​

type: string

Defined in: packages/core/lib/services/serviceparameters.d.ts:9

Type of the service

Inherited from​

ServiceParameters.type

Methods​

load()​

load(params?): this

Defined in: packages/auth/src/certificate/certificate.service.ts:71

Parameters​

params?​

any = {}

raw parameters

Returns​

this

this

Overrides​

ServiceParameters.load

update()​

update(params, delta): this

Defined in: packages/core/lib/application/parameters.d.ts:21

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update

with()​

with(callback): this

Defined in: packages/core/lib/application/parameters.d.ts:27

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with