HawkService

@webda/hawk

Class: HawkService<T>

Defined in: packages/hawk/src/hawk.service.ts:77

Verify signature and sign server

Implementation of hawk protocol https://github.com/mozilla/hawk#readme

Webda Modda

Hawk

Extends

Service<T>

Type Parameters

T

T extends HawkServiceParameters = HawkServiceParameters

Implements

RequestFilter<WebContext>
CORSFilter<WebContext>

Constructors

Constructor

new HawkService<T>(name, params): HawkService<T>

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

Service

Parameters

name

string

The name of the service

params

T

The parameters block define in the configuration file

Returns

HawkService<T>

Inherited from

Service<T>.constructor

Properties

_compiledCapabilities

protected _compiledCapabilities: Record<string, any>

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

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

Service._compiledCapabilities

[WEBDA_EVENTS]

[WEBDA_EVENTS]: object

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

Set the Webda events here

Inherited from

Service.[WEBDA_EVENTS]

cryptoService

protected cryptoService: CryptoService

Defined in: packages/hawk/src/hawk.service.ts:86

CryptoService

logger

protected logger: Logger

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

Logger with class context

Inherited from

Service.logger

metrics?

protected optional metrics?: object

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

Get metrics

Inherited from

Service.metrics

model

model: ModelClass<ApiKey>

Defined in: packages/hawk/src/hawk.service.ts:90

Model to use for apikey

name

readonly name: string

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

Inherited from

Service.name

parameters

readonly parameters: T

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

Inherited from

Service.parameters

unsubscribers

protected unsubscribers: () => void[] = []

Defined in: packages/hawk/src/hawk.service.ts:94

Listeners to remove on stop

Returns

void

createConfiguration?

static optional createConfiguration?: (params) => any

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

Create configuration set by the application on load

Parameters

params

any

Returns

any

Inherited from

Service.createConfiguration

filterConfiguration?

static optional filterConfiguration?: (params) => any

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

Create configuration set by the application on load

Parameters

params

any

Returns

any

Inherited from

Service.filterConfiguration

Parameters

static Parameters: typeof ServiceParameters

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

Service parameters

Inherited from

Service.Parameters

RegistryEntry

static RegistryEntry: string = "HawkOrigins"

Defined in: packages/hawk/src/hawk.service.ts:81

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

Service.__clean

_redirect()

_redirect(context): Promise<void>

Defined in: packages/hawk/src/hawk.service.ts:207

Redirect with a CSRF

Parameters

context

WebContext

the request context

Returns

Promise<void>

the redirect

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

Service.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

Service.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

Service.authorizeClientEvent

checkOPTIONS()

checkOPTIONS(origin): Promise<boolean>

Defined in: packages/hawk/src/hawk.service.ts:250

Check if an origin is allowed by any key

Parameters

origin

string

the request origin

Returns

Promise<boolean>

true if allowed

checkRequest()

checkRequest(context): Promise<boolean>

Defined in: packages/hawk/src/hawk.service.ts:273

Stricly parse the request's attributes and then approve or reject

Parameters

context

WebContext

the request context

Returns

Promise<boolean>

true if the request is allowed

Implementation of

RequestFilter.checkRequest

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

Service.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

Service.emit

getApiKey()

getApiKey(id, _timestamp?): Promise<HawkCredentials>

Defined in: packages/hawk/src/hawk.service.ts:103

Retrieve the hawk credentials of an api key

Parameters

id

string

the api key id

_timestamp?

any = undefined

used to invalidate cache

Returns

Promise<HawkCredentials>

the hawk credentials

getCapabilities()

getCapabilities(): Record<string, any>

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

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

Service.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

Service.getClientEvents

getHawkRequest()

getHawkRequest(context): Promise<{ authorization: string; contentType: string; host: string; method: HttpMethodType; payload: string | Buffer<ArrayBufferLike>; port: number; url: string; }>

Defined in: packages/hawk/src/hawk.service.ts:112

Return information for hawk

Parameters

context

WebContext

the request context

Returns

Promise<{ authorization: string; contentType: string; host: string; method: HttpMethodType; payload: string | Buffer<ArrayBufferLike>; port: number; url: string; }>

the hawk request

getMaxListeners()

getMaxListeners(): number

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

Returns

number

Inherited from

Service.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

Service.getMetric

getName()

getName(): string

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

Get service name

Returns

string

the result string

Inherited from

Service.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

Service.getOpenApiReplacements

getOperationId()

getOperationId(id): string

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

the result

Inherited from

Service.getOperationId

getOrigins()

getOrigins(): Promise<any>

Defined in: packages/hawk/src/hawk.service.ts:233

Get the origins registry entry, creating it if needed

Returns

Promise<any>

the origins

getParameters()

getParameters(): T

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

Get the service parameters

Returns

T

the result

Inherited from

Service.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

Service.getService

getState()

getState(): ServiceStates

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

Get the current state

Returns

ServiceStates

the result

Inherited from

Service.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

Service.getUrl

init()

init(): Promise<HawkService<T>>

Defined in: packages/hawk/src/hawk.service.ts:129

Add the Request listeners

Returns

Promise<HawkService<T>>

this

Overrides

Service.init

initMetrics()

initMetrics(): void

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

Init the metrics

Returns

void

Inherited from

Service.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

Service.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

Service.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

Service.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

Service.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

Service.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

Service.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

Service.once

redirectWithCSRF()

redirectWithCSRF(context, url): Promise<void>

Defined in: packages/hawk/src/hawk.service.ts:216

Redirect to a website with CSRF

Parameters

context

WebContext

the request context

url

string

the url to redirect to

Returns

Promise<void>

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

Service.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

Service.removeListener

resolve()

resolve(): this

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

Resolve parameters and load metadata. @Route-declared routes are scanned and registered by Router.discoverRoutes(services) from Core.init() once every service has resolved — nothing to do per-service here.

Returns

this

the result

Inherited from

Service.resolve

setMaxListeners()

setMaxListeners(n): this

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

Parameters

n

number

Returns

this

Inherited from

Service.setMaxListeners

signResponse()

signResponse(context): void

Defined in: packages/hawk/src/hawk.service.ts:176

Add the hawk server signature to the response

Parameters

context

WebContext

the request context

Returns

void

stop()

stop(): Promise<void>

Defined in: packages/hawk/src/hawk.service.ts:166

Remove listeners

Returns

Promise<void>

Overrides

Service.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

Service.toJSON

toString()

toString(): string

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

Return service representation

Returns

string

the result

Inherited from

Service.toString

Class: HawkService<T>

Webda Modda​

Extends​

Type Parameters​

T​

Implements​

Constructors​

Constructor​

Parameters​

name​

params​

Returns​

Inherited from​

Properties​

_compiledCapabilities​

See​

Inherited from​

[WEBDA_EVENTS]​

Inherited from​

cryptoService​

logger​

Inherited from​

metrics?​

Inherited from​

model​

name​

Inherited from​

parameters​

Inherited from​

unsubscribers​

Returns​

createConfiguration?​

Parameters​

params​

Returns​

Inherited from​

filterConfiguration?​

Parameters​

params​

Returns​

Inherited from​

Parameters​

Inherited from​

RegistryEntry​

Methods​

__clean()​

Returns​

Inherited from​

_redirect()​

Parameters​

context​

Returns​

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​

checkOPTIONS()​

Parameters​

origin​

Returns​

Webda Modda

Extends

Type Parameters

T

Implements

Constructors

Constructor

Parameters

name

params

Returns

Inherited from

Properties

_compiledCapabilities

See

Inherited from

[WEBDA_EVENTS]

Inherited from

cryptoService

logger

Inherited from

metrics?

Inherited from

model

name

Inherited from

parameters

Inherited from

unsubscribers

Returns

createConfiguration?

Parameters

params

Returns

Inherited from

filterConfiguration?

Parameters

params

Returns

Inherited from

Parameters

Inherited from

RegistryEntry

Methods

__clean()

Returns

Inherited from

_redirect()

Parameters

context

Returns

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

checkOPTIONS()

Parameters

origin

Returns

checkRequest()