Class MaxMindEnricher

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

Hierarchy (view full)

BaseScenario
- MaxMindEnricher

Index

Constructors

Properties

extractIp? loaded ipObjectCache scenarioName

Accessors

ipObjectCache name

Methods

_check check enrich getAddressObjectWithCache load

Constructors

constructor

new MaxMindEnricher(options?): MaxMindEnricher
Parameters
- Optionaloptions: IScenarioOptions
Returns MaxMindEnricher
Overrides BaseScenario.constructor
- Defined in scenarios/MaxMind/MaxMindEnricher.ts:39

Properties

`Optional`extractIp

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

allow some scenario to extract ip from the request

loaded

loaded: boolean = false

`Static`ipObjectCache

ipObjectCache: LRUCache<string, AddressObject, unknown>

`Static`scenarioName

scenarioName: string = 'maxmind'

Accessors

`Protected`ipObjectCache

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

name

get name(): string
name of the scenario

Returns string
Inherited from BaseScenario.name
- Defined in baseScenarios/BaseScenario.ts:45

Methods

`Protected`_check

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

check

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

enrich

enrich(alert): undefined | APITypes.Alert
Parameters
- alert: APITypes.Alert
Returns undefined | APITypes.Alert
Overrides BaseScenario.enrich
- Defined in scenarios/MaxMind/MaxMindEnricher.ts:81

`Protected`getAddressObjectWithCache

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

load

load(): Promise<void>
Returns Promise<void>
- Defined in scenarios/MaxMind/MaxMindEnricher.ts:77