Skip to main content

Password

@webda/core


Class: Password

Defined in: packages/core/src/models/password.model.ts:55

Password credential of a user: bcrypt hash and change timestamp

Webda Behavior​

Webda/Password

Constructors​

Constructor​

new Password(): Password

Returns​

Password

Properties​

__hash?​

optional __hash?: string

Defined in: packages/core/src/models/password.model.ts:57

bcrypt hash, never output


changedAt?​

optional changedAt?: number

Defined in: packages/core/src/models/password.model.ts:59

Last change, ms since epoch

Methods​

change()​

change(current, next): Promise<void>

Defined in: packages/core/src/models/password.model.ts:121

Change the password of the owning user

Parameters​

current​

string

current password

next​

string

new password

Returns​

Promise<void>


getUser()​

protected getUser(): User

Defined in: packages/core/src/models/password.model.ts:65

Owning user (set by behavior hydration)

Returns​

User

the user or undefined when detached


hasPassword()​

hasPassword(): boolean

Defined in: packages/core/src/models/password.model.ts:72

Returns​

boolean

true when a password is set


set()​

set(plain): Promise<void>

Defined in: packages/core/src/models/password.model.ts:97

Validate against the policy and store a new hash (does not save the user)

Parameters​

plain​

string

new password

Returns​

Promise<void>


setHash()​

setHash(hash, changedAt?): void

Defined in: packages/core/src/models/password.model.ts:110

Store an existing hash (migration)

Parameters​

hash​

string

bcrypt hash

changedAt?​

number = ...

change timestamp

Returns​

void


verify()​

verify(plain): Promise<boolean>

Defined in: packages/core/src/models/password.model.ts:81

Compare a candidate with the stored hash

Parameters​

plain​

string

candidate password

Returns​

Promise<boolean>

true when it matches