Skip to content
@guardcore

GuardMiddlewareOptions

Defined in: hono/src/middleware.ts:15

Properties

Section titled “Properties”

agentHandler?

Section titled “agentHandler?”

optional agentHandler?: AgentHandlerProtocol

Defined in: hono/src/middleware.ts:17

config

Section titled “config”

config: object

Defined in: hono/src/middleware.ts:16

agentApiKey?

Section titled “agentApiKey?”

optional agentApiKey?: string | null

agentBufferSize?

Section titled “agentBufferSize?”

optional agentBufferSize?: number

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

agentProjectId?

Section titled “agentProjectId?”

optional agentProjectId?: string | null

agentRetryAttempts?

Section titled “agentRetryAttempts?”

optional agentRetryAttempts?: number

agentTimeout?

Section titled “agentTimeout?”

optional agentTimeout?: number

autoBanDuration?

Section titled “autoBanDuration?”

optional autoBanDuration?: number

autoBanThreshold?

Section titled “autoBanThreshold?”

optional autoBanThreshold?: number

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[]

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>

detectionAnomalyThreshold?

Section titled “detectionAnomalyThreshold?”

optional detectionAnomalyThreshold?: number

detectionCompilerTimeout?

Section titled “detectionCompilerTimeout?”

optional detectionCompilerTimeout?: number

detectionMaxContentLength?

Section titled “detectionMaxContentLength?”

optional detectionMaxContentLength?: number

detectionMaxTrackedPatterns?

Section titled “detectionMaxTrackedPatterns?”

optional detectionMaxTrackedPatterns?: number

detectionMonitorHistorySize?

Section titled “detectionMonitorHistorySize?”

optional detectionMonitorHistorySize?: number

detectionPreserveAttackPatterns?

Section titled “detectionPreserveAttackPatterns?”

optional detectionPreserveAttackPatterns?: boolean

detectionSemanticThreshold?

Section titled “detectionSemanticThreshold?”

optional detectionSemanticThreshold?: number

detectionSlowPatternThreshold?

Section titled “detectionSlowPatternThreshold?”

optional detectionSlowPatternThreshold?: number

dynamicRuleInterval?

Section titled “dynamicRuleInterval?”

optional dynamicRuleInterval?: number

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

enableDynamicRules?

Section titled “enableDynamicRules?”

optional enableDynamicRules?: boolean

enableIpBanning?

Section titled “enableIpBanning?”

optional enableIpBanning?: boolean

enablePenetrationDetection?

Section titled “enablePenetrationDetection?”

optional enablePenetrationDetection?: 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

excludePaths?

Section titled “excludePaths?”

optional excludePaths?: string[]

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

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

logSuspiciousLevel?

Section titled “logSuspiciousLevel?”

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

passiveMode?

Section titled “passiveMode?”

optional passiveMode?: boolean

rateLimit?

Section titled “rateLimit?”

optional rateLimit?: number

rateLimitWindow?

Section titled “rateLimitWindow?”

optional rateLimitWindow?: number

redisPrefix?

Section titled “redisPrefix?”

optional redisPrefix?: string

redisUrl?

Section titled “redisUrl?”

optional redisUrl?: string

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

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: hono/src/middleware.ts:18

guardDecorator?

Section titled “guardDecorator?”

optional guardDecorator?: unknown

Defined in: hono/src/middleware.ts:19