Class BaseScenario`Abstract`

when creating a scenario, you need to add a static scenarioName

Hierarchy (View Summary)

BaseScenario
- MaxMindEnricher

Implements

IScenario

Index

Constructors

Properties

extractIp? ipObjectCache

Accessors

ipObjectCache name scenarioName

Methods

_check check enrich getAddressObjectWithCache

Constructors

constructor

new BaseScenario(options?: IScenarioOptions): BaseScenario
Parameters
- Optionaloptions: IScenarioOptions
Returns BaseScenario
- Defined in baseScenarios/BaseScenario.ts:22

Properties

`Optional`extractIp

extractIp?: (req: IncomingMessage) => IIpExtractionResult | undefined

allow some scenario to extract ip from the request

`Static`ipObjectCache

ipObjectCache: LRUCache<string, AddressObject, unknown>

Accessors

`Protected`ipObjectCache

get ipObjectCache(): LRUCache<string, AddressObject, unknown>
Returns LRUCache<string, AddressObject, unknown>
- Defined in baseScenarios/BaseScenario.ts:14

name

get name(): string
name of the scenario

Returns string
Implementation of IScenario.name
- Defined in baseScenarios/BaseScenario.ts:45

`Static`scenarioName

get scenarioName(): string
Returns string
- Defined in baseScenarios/BaseScenario.ts:18

Methods

`Protected`_check

_check(
ip: AddressObject,
req: IncomingMessage,
): APITypes.Alert | APITypes.Alert[] | undefined
Implement this function in your scenario to use bucket and black-hole functionality
Parameters
- ip: AddressObject
- req: IncomingMessage
Returns APITypes.Alert | APITypes.Alert[] | undefined
- Defined in baseScenarios/BaseScenario.ts:60

check

check(
ip: AddressObject,
req: IncomingMessage,
): APITypes.Alert | APITypes.Alert[] | undefined
Parameters
- ip: AddressObject
- req: IncomingMessage
Returns APITypes.Alert | APITypes.Alert[] | undefined
Implementation of IScenario.check
- Defined in baseScenarios/BaseScenario.ts:64

enrich

enrich(alert: APITypes.Alert, req: IncomingMessage): APITypes.Alert | undefined
Parameters
- alert: APITypes.Alert
- req: IncomingMessage
Returns APITypes.Alert | undefined
Implementation of IScenario.enrich
- Defined in baseScenarios/BaseScenario.ts:69

`Protected`getAddressObjectWithCache

getAddressObjectWithCache(address?: string): AddressObject
Parameters
- Optionaladdress: string
Returns AddressObject
- Defined in baseScenarios/BaseScenario.ts:30