Class XForwardedForChecker

Hierarchy

CheckerScenario
- XForwardedForChecker

Index

Constructors

Properties

announceToLAPI ipObjectCache scenarioName scenarioVersion

Accessors

ipObjectCache name

Methods

_check check enrich extractIp getAddressObjectWithCache

Constructors

constructor

new XForwardedForChecker(options?: IScenarioOptions): XForwardedForChecker
Parameters
- Optionaloptions: IScenarioOptions
Returns XForwardedForChecker
Overrides CheckerScenario.constructor
- Defined in scenarios/XForwardedFor/XForwardedForChecker.ts:41

Properties

`Readonly`announceToLAPI

announceToLAPI: true

announce current scenario to LAPI

`Static`ipObjectCache

ipObjectCache: LRUCache<string, AddressObject, unknown>

`Static` `Readonly`scenarioName

scenarioName: "thib3113/x-forwarded-for" = 'thib3113/x-forwarded-for'

`Static` `Readonly`scenarioVersion

scenarioVersion: "0.0.1" = '0.0.1'

Accessors

`Protected`ipObjectCache

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

name

get name(): string
name of the scenario

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

Methods

`Protected`_check

_check(
ip: AddressObject,
req: IncomingMessage,
): APITypes.Alert | APITypes.Alert[] | undefined
Parameters
- ip: AddressObject
- req: IncomingMessage
Returns APITypes.Alert | APITypes.Alert[] | undefined
Overrides CheckerScenario._check
- Defined in scenarios/XForwardedFor/XForwardedForChecker.ts:82

check

check(
ip: AddressObject,
req: IncomingMessage,
): APITypes.Alert | APITypes.Alert[] | undefined
Parameters
- ip: AddressObject
- req: IncomingMessage
Returns APITypes.Alert | APITypes.Alert[] | undefined
Inherited from CheckerScenario.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
Inherited from CheckerScenario.enrich
- Defined in baseScenarios/BaseScenario.ts:69

extractIp

extractIp(req: IncomingMessage): IIpExtractionResult | undefined
Parameters
- req: IncomingMessage
Returns IIpExtractionResult | undefined
Overrides CheckerScenario.extractIp
- Defined in scenarios/XForwardedFor/XForwardedForChecker.ts:267

`Protected`getAddressObjectWithCache

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