Class AllowListEnricher

Hierarchy

EnricherScenario
- AllowListEnricher

Index

Constructors

Properties

extractIp? ipObjectCache scenarioName

Accessors

ipObjectCache name

Methods

_check check enrich getAddressObjectWithCache

Constructors

constructor

new AllowListEnricher(options?: IScenarioOptions): AllowListEnricher
Parameters
- Optionaloptions: IScenarioOptions
Returns AllowListEnricher
Overrides EnricherScenario.constructor
- Defined in scenarios/AllowList/AllowListEnricher.ts:20

Properties

`Optional`extractIp

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

`Static`ipObjectCache

ipObjectCache: LRUCache<string, AddressObject, unknown>

`Static`scenarioName

scenarioName: string = 'allow-list'

Accessors

`Protected`ipObjectCache

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

name

get name(): string
name of the scenario

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

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
Inherited from EnricherScenario._check
- 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
Inherited from EnricherScenario.check
- Defined in baseScenarios/BaseScenario.ts:64

enrich

enrich(alert: APITypes.Alert): APITypes.Alert | undefined
Parameters
- alert: APITypes.Alert
Returns APITypes.Alert | undefined
Overrides EnricherScenario.enrich
- Defined in scenarios/AllowList/AllowListEnricher.ts:29

`Protected`getAddressObjectWithCache

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