SmsMfaService

Class: SmsMfaService

Defined in: packages/auth/src/mfa/sms.service.ts:78

One-time codes sent by SMS second-factor authentication service

Enrollment input is { phone }; confirming the enrollment verifies the phone. Codes are sent through a pluggable SmsSender service (DebugSmsSender for tests, SnsSmsSender in @webda/aws) with the <Model>.<Attribute>.Challenge operation.

Webda Modda

SmsMfaService

Extends

SecondFactorService<SmsMfaParameters>

Constructors

Constructor

new SmsMfaService(name, params): SmsMfaService

Defined in: packages/core/lib/services/service.d.ts:72

Service

Parameters

name

string

The name of the service

params

SmsMfaParameters

The parameters block define in the configuration file

Returns

SmsMfaService

Inherited from

SecondFactorService.constructor

Properties

_compiledCapabilities

protected _compiledCapabilities: Record<string, any>

Defined in: packages/core/lib/services/iservice.d.ts:38

Capabilities detected at compile-time from @WebdaCapability-tagged interfaces.

Populated during Service.resolve by reading the service's entry in webda.module.json. Each key is a capability name (e.g., "request-filter"), and the value is an empty object {} by default. Override getCapabilities to provide capability-specific configuration or to conditionally disable capabilities.

See

getCapabilities

Inherited from

SecondFactorService._compiledCapabilities

[WEBDA_EVENTS]

[WEBDA_EVENTS]: object

Defined in: packages/core/lib/services/service.d.ts:50

Set the Webda events here

Inherited from

SecondFactorService.[WEBDA_EVENTS]

logger

protected logger: Logger

Defined in: packages/core/lib/services/service.d.ts:59

Logger with class context

Inherited from

SecondFactorService.logger

method

readonly method: "sms" = "sms"

Defined in: packages/auth/src/mfa/sms.service.ts:81

amr value and key in MFA.methods(), e.g. "totp", "sms"

Overrides

SecondFactorService.method

metrics?

protected optional metrics?: object

Defined in: packages/core/lib/services/service.d.ts:63

Get metrics

Inherited from

SecondFactorService.metrics

name

readonly name: string

Defined in: packages/core/lib/services/iservice.d.ts:18

Inherited from

SecondFactorService.name

parameters

readonly parameters: SmsMfaParameters

Defined in: packages/core/lib/services/iservice.d.ts:19

Inherited from

SecondFactorService.parameters

sender

protected sender: SmsSender

Defined in: packages/auth/src/mfa/sms.service.ts:84

Transport of the codes

createConfiguration?

static optional createConfiguration?: (params) => any

Defined in: packages/core/lib/services/iservice.d.ts:23

Create configuration set by the application on load

Parameters

params

any

Returns

any

Inherited from

SecondFactorService.createConfiguration

filterConfiguration?

static optional filterConfiguration?: (params) => any

Defined in: packages/core/lib/services/iservice.d.ts:27

Create configuration set by the application on load

Parameters

params

any

Returns

any

Inherited from

SecondFactorService.filterConfiguration

Parameters

static Parameters: typeof SmsMfaParameters = SmsMfaParameters

Defined in: packages/auth/src/mfa/sms.service.ts:79

Service parameters

Overrides

SecondFactorService.Parameters

Accessors

recoveryCodeCount

Get Signature

get recoveryCodeCount(): number

Defined in: packages/auth/src/mfa/secondfactor.service.ts:55

Returns

number

the recovery codes issued with the first enabled factor

Inherited from

SecondFactorService.recoveryCodeCount

throttle

Get Signature

get throttle(): ThrottleParameters

Defined in: packages/auth/src/mfa/secondfactor.service.ts:48

Returns

ThrottleParameters

the throttle of the attempts checked with this method

Inherited from

SecondFactorService.throttle

Methods

__clean()

abstract __clean(): Promise<void>

Defined in: packages/core/lib/services/service.d.ts:215

Clean the service data, can only be used in test mode

Returns

Promise<void>

Inherited from

SecondFactorService.__clean

addListener()

addListener<Key>(eventName, listener): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:80

Type Parameters

Key

Key extends never

Parameters

eventName

Key

the event name

listener

(event) => void | Promise<void>

the event listener

Returns

this

this for chaining

See

EventEmitter.addListener

Inherited from

SecondFactorService.addListener

addRoute()

protected addRoute(url, methods, executer, openapi?, override?): void

Defined in: packages/core/lib/services/service.d.ts:177

Add a route dynamicaly

Parameters

url

string

of the route can contains dynamic part like {uuid}

methods

HttpMethodType[]

the HTTP methods

executer

Function

Method to execute for this route

openapi?

OpenAPIWebdaDefinition

the OpenAPI specification

override?

boolean

whether to override existing

Returns

void

Inherited from

SecondFactorService.addRoute

authorizeClientEvent()

authorizeClientEvent(_event, _context): boolean

Defined in: packages/core/lib/services/service.d.ts:153

Authorize a public event subscription

Parameters

_event

string

the event name

_context

OperationContext

the execution context

Returns

boolean

true if the condition is met

Inherited from

SecondFactorService.authorizeClientEvent

challenge()

challenge(mfa, _owner): Promise<{ expiresIn: number; phone: string; }>

Defined in: packages/auth/src/mfa/sms.service.ts:136

Send a new code to the factor phone, replacing the previous one

Parameters

mfa

MFA

the MFA behavior

_owner

any

the object holding it

Returns

Promise<{ expiresIn: number; phone: string; }>

the masked phone and the code lifetime in seconds

check()

check(mfa, code): Promise<boolean>

Defined in: packages/auth/src/mfa/sms.service.ts:166

Check a code against the current one: unexpired, constant-time hash compare, single use. Confirming the enrollment verifies the phone: phoneVerifiedAt is set on owners declaring it

Parameters

mfa

MFA

the MFA behavior

code

string

submitted code

Returns

Promise<boolean>

true if valid

Overrides

SecondFactorService.check

checkResend()

protected checkResend(data?): void

Defined in: packages/auth/src/mfa/sms.service.ts:103

Refuse to send a code before the resend delay

Parameters

data?

SmsFactorData

current factor data

Returns

void

computeParameters()

computeParameters(): void

Defined in: packages/core/lib/services/service.d.ts:77

Used to compute or derivate input parameter to attribute

Returns

void

Deprecated

Inherited from

SecondFactorService.computeParameters

emit()

emit<Key>(event, data): Promise<void>

Defined in: packages/core/lib/services/service.d.ts:204

Emit the event with data and wait for Promise to finish if listener returned a Promise

Type Parameters

Key

Key extends never

Parameters

event

Key

the event name

data

object[Key]

the data to process

Returns

Promise<void>

Inherited from

SecondFactorService.emit

getCapabilities()

getCapabilities(): Record<string, any>

Defined in: packages/core/lib/services/iservice.d.ts:60

Return the capabilities of this service.

By default returns capabilities detected at compile-time from

Returns

Record<string, any>

the result

Webda Capability-tagged

interfaces in webda.module.json.

Override to disable capabilities based on configuration:

getCapabilities() {
  const caps = super.getCapabilities();
  if (!this.parameters.enabled) delete caps["request-filter"];
  return caps;
}

Inherited from

SecondFactorService.getCapabilities

getClientEvents()

getClientEvents(): string[]

Defined in: packages/core/lib/services/service.d.ts:144

Return the events that an external system can subscribe to

Returns

string[]

the list of results

Inherited from

SecondFactorService.getClientEvents

getMaxListeners()

getMaxListeners(): number

Defined in: packages/core/lib/events/asynceventemitter.d.ts:84

Returns

number

Inherited from

SecondFactorService.getMaxListeners

getMetric()

getMetric<T>(type, configuration): T

Defined in: packages/core/lib/services/service.d.ts:138

Add service name label

Type Parameters

T

T = Gauge<string> | Counter<string> | Histogram<string>

Parameters

type

CustomConstructor<T, [MetricConfiguration<T>]>

the type to look up

configuration

MetricConfiguration<T>

the configuration

Returns

T

the result

Inherited from

SecondFactorService.getMetric

getName()

getName(): string

Defined in: packages/core/lib/services/service.d.ts:209

Get service name

Returns

string

the result string

Inherited from

SecondFactorService.getName

getOpenApiReplacements()

getOpenApiReplacements(): any

Defined in: packages/core/lib/services/service.d.ts:182

Return variables for replacement in openapi

Returns

any

the result

Inherited from

SecondFactorService.getOpenApiReplacements

getOperationId()

getOperationId(id): string | undefined

Defined in: packages/core/lib/services/service.d.ts:167

If undefined is returned it cancel the operation registration

Parameters

id

string

the identifier

Returns

string | undefined

the result

Inherited from

SecondFactorService.getOperationId

getParameters()

getParameters(): SmsMfaParameters

Defined in: packages/core/lib/services/service.d.ts:82

Get the service parameters

Returns

SmsMfaParameters

the result

Inherited from

SecondFactorService.getParameters

getService()

getService<T>(name): ServicesMap[T]

Defined in: packages/core/lib/services/service.d.ts:131

Get a service by name

Type Parameters

T

T extends keyof ServicesMap

Parameters

name

T

the name to use

Returns

ServicesMap[T]

the result map

Deprecated

Use useService, might reconsider

Inherited from

SecondFactorService.getService

getState()

getState(): ServiceStates

Defined in: packages/core/lib/services/service.d.ts:55

Get the current state

Returns

ServiceStates

the result

Inherited from

SecondFactorService.getState

getUrl()

getUrl(url, _methods): string

Defined in: packages/core/lib/services/service.d.ts:161

Return the full path url based on parameters

Parameters

url

string

relative url to service

_methods

HttpMethodType[]

in case we need filtering (like Store)

Returns

string

absolute url or undefined if need to skip the Route

Inherited from

SecondFactorService.getUrl

init()

abstract init(): Promise<SmsMfaService>

Defined in: packages/core/lib/services/service.d.ts:198

Will be called after all the Services are created

Returns

Promise<SmsMfaService>

Inherited from

SecondFactorService.init

initMetrics()

initMetrics(): void

Defined in: packages/core/lib/services/service.d.ts:124

Init the metrics

Returns

void

Inherited from

SecondFactorService.initMetrics

initOperations()

initOperations(): void

Defined in: packages/core/lib/services/service.d.ts:186

Init the operations from

Returns

void

Operation

decorators on this service

Inherited from

SecondFactorService.initOperations

listeners()

listeners(eventName): Function[]

Defined in: packages/core/lib/events/asynceventemitter.d.ts:139

Get all listeners for an event

Parameters

eventName

never

the event name

Returns

Function[]

the list of results

Inherited from

SecondFactorService.listeners

loadCapabilities()

protected loadCapabilities(): void

Defined in: packages/core/lib/services/service.d.ts:120

Load capabilities from webda.module.json metadata into _compiledCapabilities.

Called during resolve after dependency injection. Reads the service's type name from parameters, looks it up in the application's module metadata (moddas or beans section), and populates _compiledCapabilities with an empty object for each declared capability name.

Fails silently if the application is not available (e.g., in unit tests where services are instantiated without a full application context).

Returns

void

Example

// If webda.module.json contains:
// { "moddas": { "MyApp/HawkService": { "capabilities": ["request-filter", "cors-filter"] } } }
// Then after resolve(), this.getCapabilities() returns:
// { "request-filter": {}, "cors-filter": {} }

See

getCapabilities

Inherited from

SecondFactorService.loadCapabilities

log()

log(level, ...args): void

Defined in: packages/core/lib/services/service.d.ts:226

Parameters

level

WorkerLogLevel

to log

args

...any[]

additional arguments

Returns

void

Inherited from

SecondFactorService.log

off()

off<Key>(eventName, listener): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:116

Type Parameters

Key

Key extends never

Parameters

eventName

Key

the event name

listener

(event) => void

the event listener

Returns

this

this for chaining

See

EventEmitter.off

Inherited from

SecondFactorService.off

on()

on<Key>(eventName, listener): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:102

Type Parameters

Key

Key extends never

Parameters

eventName

Key

the event name

listener

(event) => void

the event listener

Returns

this

this for chaining

See

EventEmitter.once

Inherited from

SecondFactorService.on

once()

once<Key>(eventName, listener): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:95

Type Parameters

Key

Key extends never

Parameters

eventName

Key

the event name

listener

(event) => void

the event listener

Returns

this

this for chaining

See

EventEmitter.once

Inherited from

SecondFactorService.once

removeAllListeners()

removeAllListeners<Key>(eventName?): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:122

Type Parameters

Key

Key extends never

Parameters

eventName?

Key

the event name

Returns

this

this for chaining

See

EventEmitter.removeAllListeners

Inherited from

SecondFactorService.removeAllListeners

removeListener()

removeListener<Key>(eventName, listener): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:109

Type Parameters

Key

Key extends never

Parameters

eventName

Key

the event name

listener

(event) => void

the event listener

Returns

this

this for chaining

See

EventEmitter.removeListener

Inherited from

SecondFactorService.removeListener

resolve()

resolve(): this

Defined in: packages/auth/src/mfa/sms.service.ts:90

Resolve the SMS sender service

Returns

this

this

Overrides

SecondFactorService.resolve

setMaxListeners()

setMaxListeners(n): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:88

Parameters

n

number

Returns

this

Inherited from

SecondFactorService.setMaxListeners

startEnrollment()

startEnrollment(mfa, owner, input?): Promise<any>

Defined in: packages/auth/src/mfa/sms.service.ts:118

Store the phone (pending until confirmed) then send it a code

Parameters

mfa

MFA

the MFA behavior

owner

any

the object holding it

input?

enrollment input

phone?

string

phone number, with its + country code

Returns

Promise<any>

the masked phone and the code lifetime

Overrides

SecondFactorService.startEnrollment

stop()

stop(): Promise<void>

Defined in: packages/core/lib/services/service.d.ts:86

Shutdown the current service if action need to be taken

Returns

Promise<void>

Inherited from

SecondFactorService.stop

toJSON()

toJSON(): string

Defined in: packages/core/lib/services/service.d.ts:191

Prevent service to be serialized

Returns

string

the result

Inherited from

SecondFactorService.toJSON

toString()

toString(): string

Defined in: packages/core/lib/services/service.d.ts:91

Return service representation

Returns

string

the result

Inherited from

SecondFactorService.toString

Class: SmsMfaService

Webda Modda​

Extends​

Constructors​

Constructor​

Parameters​

name​

params​

Returns​

Inherited from​

Properties​

_compiledCapabilities​

See​

Inherited from​

[WEBDA_EVENTS]​

Inherited from​

logger​

Inherited from​

method​

Overrides​

metrics?​

Inherited from​

name​

Inherited from​

parameters​

Inherited from​

sender​

createConfiguration?​

Parameters​

params​

Returns​

Inherited from​

filterConfiguration?​

Parameters​

params​

Returns​

Inherited from​

Parameters​

Overrides​

Accessors​

recoveryCodeCount​

Get Signature​

Returns​

Inherited from​

throttle​

Get Signature​

Returns​

Inherited from​

Methods​

__clean()​

Returns​

Inherited from​

addListener()​

Type Parameters​

Key​

Parameters​

eventName​

listener​

Returns​

See​

Inherited from​

addRoute()​

Parameters​

url​

methods​

executer​

openapi?​

override?​

Returns​

Inherited from​

authorizeClientEvent()​

Parameters​

_event​

_context​

Returns​

Inherited from​

challenge()​

Parameters​

mfa​

_owner​

Webda Modda

Extends

Constructors

Constructor

Parameters

name

params

Returns

Inherited from

Properties

_compiledCapabilities

See

Inherited from

[WEBDA_EVENTS]

Inherited from

logger

Inherited from

method

Overrides

metrics?

Inherited from

name

Inherited from

parameters

Inherited from

sender

createConfiguration?

Parameters

params

Returns

Inherited from

filterConfiguration?

Parameters

params

Returns

Inherited from

Parameters

Overrides

Accessors

recoveryCodeCount

Get Signature

Returns

Inherited from

throttle

Get Signature

Returns

Inherited from

Methods

__clean()

Returns

Inherited from

addListener()

Type Parameters

Key

Parameters

eventName

listener

Returns

See

Inherited from

addRoute()

Parameters

url

methods

executer

openapi?

override?

Returns

Inherited from

authorizeClientEvent()

Parameters

_event

_context

Returns

Inherited from

challenge()

Parameters

mfa

_owner

Returns