jin-frame / providers/security/BasicAuthProvider / BasicAuthProvider

Class: BasicAuthProvider

Defined in: packages/jin-frame/src/providers/security/BasicAuthProvider.ts:9

Basic Authentication security provider that implements HTTP Basic Auth. Supports both username/password pairs and pre-encoded Basic auth strings.

Implements

• SecurityProvider

Constructors

Constructor

new BasicAuthProvider(name): BasicAuthProvider

Defined in: packages/jin-frame/src/providers/security/BasicAuthProvider.ts:20

Creates a new Basic Authentication provider

Parameters

name

string = 'basic'

Name of this security provider instance

Returns

BasicAuthProvider

Properties

name

readonly name: string

Defined in: packages/jin-frame/src/providers/security/BasicAuthProvider.ts:14

Name of this security provider instance

Implementation of

SecurityProvider.name

---

type

readonly type: "http"

Defined in: packages/jin-frame/src/providers/security/BasicAuthProvider.ts:11

Type identifier for this security provider

Implementation of

SecurityProvider.type

Methods

createContext()

createContext(authorization?, dynamicKey?): SecurityContext

Defined in: packages/jin-frame/src/providers/security/BasicAuthProvider.ts:31

Creates security context with Basic Authentication

Parameters

authorization?

AuthorizationData

Authorization data containing username/password or Basic auth string

dynamicKey?

string

Optional dynamic Basic auth string that overrides the authorization data

Returns

SecurityContext

Security context with Basic auth applied to headers or auth property

Implementation of

SecurityProvider.createContext