Class SecurityContext`Abstract`

Base-class for a context that authenticates users and manages security.

Hierarchy

SecurityContext
- SessionSecurityContext
- TokenSecurityContext

Index

Constructors

Properties

authenticatedUser? bus logging name repository

Methods

authenticate authenticateOnce flush flushOnce getUser hasUser initialize persist resume user

Constructors

constructor

new SecurityContext(repository: AuthenticatableRepository, name: string): SecurityContext
Parameters
- repository: AuthenticatableRepository
  
  The repository where users are persisted.
- name: string
  
  The name of this context.
Returns SecurityContext
- Defined in src/auth/context/SecurityContext.ts:24

Properties

`Protected` `Optional` authenticatedUser

authenticatedUser?: Authenticatable

The currently authenticated user, if one exists.

`Protected` `Readonly` bus

bus: Bus<Event>

`Protected` `Readonly` logging

logging: Logging

`Readonly` name

name: string

The name of this context.

`Readonly` repository

repository: AuthenticatableRepository

The repository where users are persisted.

Methods

authenticate

authenticate(user: Authenticatable): Promise<void>
Authenticate the given user and persist the authentication.
Parameters
- user: Authenticatable
Returns Promise<void>
- Defined in src/auth/context/SecurityContext.ts:51

authenticateOnce

authenticateOnce(user: Authenticatable): Promise<void>
Authenticate the given user, without persisting the authentication. That is, when the lifecycle ends, the user will be unauthenticated implicitly.
Parameters
- user: Authenticatable
Returns Promise<void>
- Defined in src/auth/context/SecurityContext.ts:42

flush

flush(): Promise<void>
Unauthenticate the current user, if one exists, and persist the change.

Returns Promise<void>
- Defined in src/auth/context/SecurityContext.ts:71

flushOnce

flushOnce(): Promise<void>
Unauthenticate the current user, if one exists, but do not persist the change.

Returns Promise<void>
- Defined in src/auth/context/SecurityContext.ts:60

getUser

getUser(): Maybe<Authenticatable>
Get the currently authenticated user, if one exists.

Returns Maybe<Authenticatable>
- Defined in src/auth/context/SecurityContext.ts:98

hasUser

hasUser(): boolean
Returns true if there is a currently authenticated user.

Returns boolean
- Defined in src/auth/context/SecurityContext.ts:119

initialize

initialize(): Awaitable<void>
Called when the context is created. Can be used by child-classes to do setup work.

Returns Awaitable<void>
- Defined in src/auth/context/SecurityContext.ts:35

`Abstract` persist

persist(): Awaitable<void>
Write the current state of the security context to whatever storage medium the context's host provides.

Returns Awaitable<void>
- Defined in src/auth/context/SecurityContext.ts:93

`Abstract` resume

resume(): Awaitable<void>
Assuming a user is still authenticated in the context, try to look up and fill in the user.

If there is NO USER to be resumed, then the method should flush the user from this context.

Returns Awaitable<void>
- Defined in src/auth/context/SecurityContext.ts:87

user

user(): Authenticatable
Get the current user or throw an authorization error.

Returns Authenticatable
- Defined in src/auth/context/SecurityContext.ts:103