Class XForwardedForChecker

Hierarchy

CheckerScenario
- XForwardedForChecker

Index

Constructors

Properties

announceToLAPI currentOptions extractIpCache reverseProxiesRange ipObjectCache scenarioName scenarioVersion

Accessors

ipObjectCache name

Methods

_check check enrich extractIp extractIps extractIpsFromHeader generateAlert getAddressObjectWithCache getXForwardedForHeader

Constructors

constructor

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

Properties

`Readonly` announceToLAPI

announceToLAPI: true = true

announce current scenario to LAPI

`Private` `Readonly` currentOptions

currentOptions: IXForwardedForOptions

`Private` extractIpCache

extractIpCache: LRUCache<string, IExtractedIP[], unknown>

`Private` reverseProxiesRange

reverseProxiesRange: AddressObject[]

`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
Returns string
Inherited from CheckerScenario.name
- Defined in baseScenarios/BaseScenario.ts:45

Methods

`Protected` _check

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

check

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

enrich

enrich(alert, req): undefined | APITypes.Alert
Parameters
- alert: APITypes.Alert
- req: IncomingMessage
Returns undefined | APITypes.Alert
Inherited from CheckerScenario.enrich
- Defined in baseScenarios/BaseScenario.ts:69

extractIp

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

`Private` extractIps

extractIps(req): IExtractedIP[]
Parameters
- req: IncomingMessage
Returns IExtractedIP[]
- Defined in scenarios/XForwardedFor/XForwardedForChecker.ts:186

`Private` extractIpsFromHeader

extractIpsFromHeader(xForwardedHeaders): IExtractedIP[]
Parameters
- xForwardedHeaders: string | string[]
Returns IExtractedIP[]
- Defined in scenarios/XForwardedFor/XForwardedForChecker.ts:145

`Private` generateAlert

generateAlert(alert, ip): APITypes.Alert
Parameters
- alert: Omit<APITypes.Alert, "scenario_version" | "scenario_hash" | "capacity" | "leakspeed" | "simulated" | "events" | "source"> & Partial<Pick<APITypes.Alert, "capacity" | "leakspeed" | "simulated" | "events" | "source">>
- ip: string
Returns APITypes.Alert
- Defined in scenarios/XForwardedFor/XForwardedForChecker.ts:56

`Protected` getAddressObjectWithCache

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

`Private` getXForwardedForHeader

getXForwardedForHeader(headers): string[]
Parameters
- headers: IncomingHttpHeaders
Returns string[]
- Defined in scenarios/XForwardedFor/XForwardedForChecker.ts:171

Generated using TypeDoc