Skip to content
@guardcore

GuardModuleOptions

Defined in: packages/nestjs/src/guard-module.ts:21

Properties

Section titled “Properties”

agentHandler?

Section titled “agentHandler?”

optional agentHandler?: AgentHandlerProtocol

Defined in: packages/nestjs/src/guard-module.ts:23

config

Section titled “config”

config: object

Defined in: packages/nestjs/src/guard-module.ts:22

agentApiKey?

Section titled “agentApiKey?”

optional agentApiKey?: string | null

agentBackoffFactor?

Section titled “agentBackoffFactor?”

optional agentBackoffFactor?: number | null

agentBufferOverflowPolicy?

Section titled “agentBufferOverflowPolicy?”

optional agentBufferOverflowPolicy?: "drop" | "block" | "raise" | null

agentBufferSize?

Section titled “agentBufferSize?”

optional agentBufferSize?: number

agentCompressionEnabled?

Section titled “agentCompressionEnabled?”

optional agentCompressionEnabled?: boolean | null

agentCompressionThreshold?

Section titled “agentCompressionThreshold?”

optional agentCompressionThreshold?: number | null

agentEnableEvents?

Section titled “agentEnableEvents?”

optional agentEnableEvents?: boolean

agentEnableMetrics?

Section titled “agentEnableMetrics?”

optional agentEnableMetrics?: boolean

agentEndpoint?

Section titled “agentEndpoint?”

optional agentEndpoint?: string

agentFlushInterval?

Section titled “agentFlushInterval?”

optional agentFlushInterval?: number

agentGuardVersion?

Section titled “agentGuardVersion?”

optional agentGuardVersion?: string | null

agentHighWatermarkRatio?

Section titled “agentHighWatermarkRatio?”

optional agentHighWatermarkRatio?: number | null

agentInstallId?

Section titled “agentInstallId?”

optional agentInstallId?: string | null

agentMaxConcurrentFlushes?

Section titled “agentMaxConcurrentFlushes?”

optional agentMaxConcurrentFlushes?: number | null

agentMaxPayloadSize?

Section titled “agentMaxPayloadSize?”

optional agentMaxPayloadSize?: number | null

agentPayloadSigningSecret?

Section titled “agentPayloadSigningSecret?”

optional agentPayloadSigningSecret?: string | null

agentProjectEncryptionKey?

Section titled “agentProjectEncryptionKey?”

optional agentProjectEncryptionKey?: string | null

agentProjectId?

Section titled “agentProjectId?”

optional agentProjectId?: string | null

agentRetryAttempts?

Section titled “agentRetryAttempts?”

optional agentRetryAttempts?: number

agentSensitiveHeaders?

Section titled “agentSensitiveHeaders?”

optional agentSensitiveHeaders?: string[] | null

agentStatusInterval?

Section titled “agentStatusInterval?”

optional agentStatusInterval?: number

agentStrict?

Section titled “agentStrict?”

optional agentStrict?: boolean

agentTimeout?

Section titled “agentTimeout?”

optional agentTimeout?: number

authVerifier?

Section titled “authVerifier?”

optional authVerifier?: (request, credential) => unknown

Parameters
Section titled “Parameters”
request
Section titled “request”

GuardRequest

credential
Section titled “credential”

string

Returns
Section titled “Returns”

unknown

autoBanDuration?

Section titled “autoBanDuration?”

optional autoBanDuration?: number

autoBanThreshold?

Section titled “autoBanThreshold?”

optional autoBanThreshold?: number

behaviorMaxResponseBodyInspectBytes?

Section titled “behaviorMaxResponseBodyInspectBytes?”

optional behaviorMaxResponseBodyInspectBytes?: number

behaviorScanResponseBody?

Section titled “behaviorScanResponseBody?”

optional behaviorScanResponseBody?: boolean

blacklist?

Section titled “blacklist?”

optional blacklist?: string[]

blockCloudProviders?

Section titled “blockCloudProviders?”

optional blockCloudProviders?: ("AWS" | "GCP" | "Azure")[]

blockedCountries?

Section titled “blockedCountries?”

optional blockedCountries?: string[]

blockedUserAgents?

Section titled “blockedUserAgents?”

optional blockedUserAgents?: string[]

bodyReadMaxConcurrent?

Section titled “bodyReadMaxConcurrent?”

optional bodyReadMaxConcurrent?: number

bodyReadTimeout?

Section titled “bodyReadTimeout?”

optional bodyReadTimeout?: number

cloudIpRefreshInterval?

Section titled “cloudIpRefreshInterval?”

optional cloudIpRefreshInterval?: number

corsAllowCredentials?

Section titled “corsAllowCredentials?”

optional corsAllowCredentials?: boolean

corsAllowHeaders?

Section titled “corsAllowHeaders?”

optional corsAllowHeaders?: string[]

corsAllowMethods?

Section titled “corsAllowMethods?”

optional corsAllowMethods?: string[]

corsAllowOrigins?

Section titled “corsAllowOrigins?”

optional corsAllowOrigins?: string[]

corsExposeHeaders?

Section titled “corsExposeHeaders?”

optional corsExposeHeaders?: string[]

corsMaxAge?

Section titled “corsMaxAge?”

optional corsMaxAge?: number

customErrorResponses?

Section titled “customErrorResponses?”

optional customErrorResponses?: Record<PropertyKey, string>

customLogFile?

Section titled “customLogFile?”

optional customLogFile?: string | null

customRequestCheck?

Section titled “customRequestCheck?”

optional customRequestCheck?: (req) => Promise<GuardResponse | null>

Parameters
Section titled “Parameters”
req
Section titled “req”

GuardRequest

Returns
Section titled “Returns”

Promise<GuardResponse | null>

customResponseModifier?

Section titled “customResponseModifier?”

optional customResponseModifier?: (res) => Promise<GuardResponse>

Parameters
Section titled “Parameters”
res
Section titled “res”

GuardResponse

Returns
Section titled “Returns”

Promise<GuardResponse>

detectionAnomalyEmissionCooldown?

Section titled “detectionAnomalyEmissionCooldown?”

optional detectionAnomalyEmissionCooldown?: number

detectionAnomalyThreshold?

Section titled “detectionAnomalyThreshold?”

optional detectionAnomalyThreshold?: number

detectionBinaryMinRunLength?

Section titled “detectionBinaryMinRunLength?”

optional detectionBinaryMinRunLength?: number

detectionCompilerTimeout?

Section titled “detectionCompilerTimeout?”

optional detectionCompilerTimeout?: number

detectionMaxBodyInspectBytes?

Section titled “detectionMaxBodyInspectBytes?”

optional detectionMaxBodyInspectBytes?: number

detectionMaxContentLength?

Section titled “detectionMaxContentLength?”

optional detectionMaxContentLength?: number

detectionMaxJsonDepth?

Section titled “detectionMaxJsonDepth?”

optional detectionMaxJsonDepth?: number

detectionMaxScanChars?

Section titled “detectionMaxScanChars?”

optional detectionMaxScanChars?: number

detectionMaxScanValues?

Section titled “detectionMaxScanValues?”

optional detectionMaxScanValues?: number

detectionMaxTrackedPatterns?

Section titled “detectionMaxTrackedPatterns?”

optional detectionMaxTrackedPatterns?: number

detectionMinSamplesForAnomaly?

Section titled “detectionMinSamplesForAnomaly?”

optional detectionMinSamplesForAnomaly?: number

detectionMonitorHistorySize?

Section titled “detectionMonitorHistorySize?”

optional detectionMonitorHistorySize?: number

detectionPatternValidationCachePath?

Section titled “detectionPatternValidationCachePath?”

optional detectionPatternValidationCachePath?: string | null

detectionPreserveAttackPatterns?

Section titled “detectionPreserveAttackPatterns?”

optional detectionPreserveAttackPatterns?: boolean

detectionScanBody?

Section titled “detectionScanBody?”

optional detectionScanBody?: boolean

detectionScanWorkerPool?

Section titled “detectionScanWorkerPool?”

optional detectionScanWorkerPool?: boolean

detectionSemanticThreshold?

Section titled “detectionSemanticThreshold?”

optional detectionSemanticThreshold?: number

detectionSlowPatternThreshold?

Section titled “detectionSlowPatternThreshold?”

optional detectionSlowPatternThreshold?: number

detectionThreatScoreThreshold?

Section titled “detectionThreatScoreThreshold?”

optional detectionThreatScoreThreshold?: number

dynamicRuleInterval?

Section titled “dynamicRuleInterval?”

optional dynamicRuleInterval?: number

dynamicRulesCachePath?

Section titled “dynamicRulesCachePath?”

optional dynamicRulesCachePath?: string | null

emergencyMode?

Section titled “emergencyMode?”

optional emergencyMode?: boolean

emergencyWhitelist?

Section titled “emergencyWhitelist?”

optional emergencyWhitelist?: string[]

enableAgent?

Section titled “enableAgent?”

optional enableAgent?: boolean

enableCors?

Section titled “enableCors?”

optional enableCors?: boolean

enabledDetectionCategories?

Section titled “enabledDetectionCategories?”

optional enabledDetectionCategories?: string[]

enableDynamicRules?

Section titled “enableDynamicRules?”

optional enableDynamicRules?: boolean

enableEnrichment?

Section titled “enableEnrichment?”

optional enableEnrichment?: boolean

enableIpBanning?

Section titled “enableIpBanning?”

optional enableIpBanning?: boolean

enableLogfire?

Section titled “enableLogfire?”

optional enableLogfire?: boolean

enableOtel?

Section titled “enableOtel?”

optional enableOtel?: boolean

enablePenetrationDetection?

Section titled “enablePenetrationDetection?”

optional enablePenetrationDetection?: boolean

enableRateLimitAutoBan?

Section titled “enableRateLimitAutoBan?”

optional enableRateLimitAutoBan?: boolean

enableRateLimiting?

Section titled “enableRateLimiting?”

optional enableRateLimiting?: boolean

enableRedis?

Section titled “enableRedis?”

optional enableRedis?: boolean

endpointRateLimits?

Section titled “endpointRateLimits?”

optional endpointRateLimits?: Record<string, [number, number]>

enforceHttps?

Section titled “enforceHttps?”

optional enforceHttps?: boolean

excludedDetectionBodyFields?

Section titled “excludedDetectionBodyFields?”

optional excludedDetectionBodyFields?: string[]

excludedDetectionHeaders?

Section titled “excludedDetectionHeaders?”

optional excludedDetectionHeaders?: string[]

excludedDetectionParams?

Section titled “excludedDetectionParams?”

optional excludedDetectionParams?: string[]

excludePaths?

Section titled “excludePaths?”

optional excludePaths?: string[]

exemptIps?

Section titled “exemptIps?”

optional exemptIps?: string[]

failSecure?

Section titled “failSecure?”

optional failSecure?: boolean

geoIpDbMaxAge?

Section titled “geoIpDbMaxAge?”

optional geoIpDbMaxAge?: number

geoIpHandler?

Section titled “geoIpHandler?”

optional geoIpHandler?: GeoIPHandler

geoResolver?

Section titled “geoResolver?”

optional geoResolver?: (ip) => string | null

Parameters
Section titled “Parameters”
ip
Section titled “ip”

string

Returns
Section titled “Returns”

string | null

globalBehaviorRules?

Section titled “globalBehaviorRules?”

optional globalBehaviorRules?: object[]

ipinfoDbPath?

Section titled “ipinfoDbPath?”

optional ipinfoDbPath?: string

ipinfoToken?

Section titled “ipinfoToken?”

optional ipinfoToken?: string | null

lazyInit?

Section titled “lazyInit?”

optional lazyInit?: boolean

logCountryCheckLevel?

Section titled “logCountryCheckLevel?”

optional logCountryCheckLevel?: "INFO" | "DEBUG" | "WARNING" | "ERROR" | "CRITICAL" | null

logfireServiceName?

Section titled “logfireServiceName?”

optional logfireServiceName?: string

logFormat?

Section titled “logFormat?”

optional logFormat?: "text" | "json"

logger?

Section titled “logger?”

optional logger?: Logger

logRequestLevel?

Section titled “logRequestLevel?”

optional logRequestLevel?: "INFO" | "DEBUG" | "WARNING" | "ERROR" | "CRITICAL" | null

logSensitiveBodyFields?

Section titled “logSensitiveBodyFields?”

optional logSensitiveBodyFields?: string[]

logSensitiveHeaders?

Section titled “logSensitiveHeaders?”

optional logSensitiveHeaders?: string[]

logSensitiveParams?

Section titled “logSensitiveParams?”

optional logSensitiveParams?: string[]

logSuspiciousLevel?

Section titled “logSuspiciousLevel?”

optional logSuspiciousLevel?: "INFO" | "DEBUG" | "WARNING" | "ERROR" | "CRITICAL" | null

mutedCheckLogs?

Section titled “mutedCheckLogs?”

optional mutedCheckLogs?: string[]

mutedEventTypes?

Section titled “mutedEventTypes?”

optional mutedEventTypes?: string[]

mutedMetricTypes?

Section titled “mutedMetricTypes?”

optional mutedMetricTypes?: string[]

onBlock?

Section titled “onBlock?”

optional onBlock?: (request, payload) => unknown

Parameters
Section titled “Parameters”
request
Section titled “request”

GuardRequest

payload
Section titled “payload”

Record<string, unknown>

Returns
Section titled “Returns”

unknown

onError?

Section titled “onError?”

optional onError?: (stage, error, context) => void

Parameters
Section titled “Parameters”
stage
Section titled “stage”

string

error
Section titled “error”

unknown

context
Section titled “context”

Record<string, unknown>

Returns
Section titled “Returns”

void

otelExporterEndpoint?

Section titled “otelExporterEndpoint?”

optional otelExporterEndpoint?: string | null

otelResourceAttributes?

Section titled “otelResourceAttributes?”

optional otelResourceAttributes?: Record<string, string>

otelServiceName?

Section titled “otelServiceName?”

optional otelServiceName?: string

passiveMode?

Section titled “passiveMode?”

optional passiveMode?: boolean

rateLimit?

Section titled “rateLimit?”

optional rateLimit?: number

rateLimitWindow?

Section titled “rateLimitWindow?”

optional rateLimitWindow?: number

redisFailOpen?

Section titled “redisFailOpen?”

optional redisFailOpen?: boolean

redisHealthCheckInterval?

Section titled “redisHealthCheckInterval?”

optional redisHealthCheckInterval?: number

redisMaxConnections?

Section titled “redisMaxConnections?”

optional redisMaxConnections?: number | null

redisPrefix?

Section titled “redisPrefix?”

optional redisPrefix?: string

redisRetries?

Section titled “redisRetries?”

optional redisRetries?: number

redisSocketConnectTimeout?

Section titled “redisSocketConnectTimeout?”

optional redisSocketConnectTimeout?: number | null

redisSocketTimeout?

Section titled “redisSocketTimeout?”

optional redisSocketTimeout?: number | null

redisUrl?

Section titled “redisUrl?”

optional redisUrl?: string

routeResolutionStrict?

Section titled “routeResolutionStrict?”

optional routeResolutionStrict?: boolean

securityHeaders?

Section titled “securityHeaders?”

optional securityHeaders?: { contentTypeOptions?: string; csp?: Record<string, string[]> | null; custom?: Record<string, string> | null; enabled?: boolean; frameOptions?: "DENY" | "SAMEORIGIN"; hsts?: { includeSubdomains?: boolean; maxAge?: number; preload?: boolean; }; permissionsPolicy?: string; referrerPolicy?: string; xssProtection?: string; } | null

threatBanConfig?

Section titled “threatBanConfig?”

optional threatBanConfig?: Record<string, { duration: number; threshold: number; }>

trustedProxies?

Section titled “trustedProxies?”

optional trustedProxies?: string[]

trustedProxyDepth?

Section titled “trustedProxyDepth?”

optional trustedProxyDepth?: number

trustXForwardedProto?

Section titled “trustXForwardedProto?”

optional trustXForwardedProto?: boolean

whitelist?

Section titled “whitelist?”

optional whitelist?: string[] | null

whitelistCountries?

Section titled “whitelistCountries?”

optional whitelistCountries?: string[]

geoIpHandler?

Section titled “geoIpHandler?”

optional geoIpHandler?: GeoIPHandler

Defined in: packages/nestjs/src/guard-module.ts:24

guardDecorator?

Section titled “guardDecorator?”

optional guardDecorator?: unknown

Defined in: packages/nestjs/src/guard-module.ts:25

routeConfigs?

Section titled “routeConfigs?”

optional routeConfigs?: PathRouteConfigEntry[]

Defined in: packages/nestjs/src/guard-module.ts:31