const BackupApiKeyBase = "node-definition-backup:"

const BackupPolicyKeyBase = "node-policy-backup:"

// CoProcessDefaultKeyPrefix is used as a key prefix for this CP.
const CoProcessDefaultKeyPrefix = "coprocess-data:"

// EH_CoProcessHandler is used for event system, maintained here for backwards compatibility.
const EH_CoProcessHandler = event.CoProcessHandler

const JWKsAPIDef = "jwks_api_def_"

const ListDetailed = "detailed"

const LoopScheme = "tyk"

const (
	MessageStreamingOnlySupportedInEE = "streaming is supported only in Tyk Enterprise Edition"
)

const OIDPREFIX = "openid"

const RPCKeyPrefix = "rpc:"

const RestrictedFieldValidationFailedLogMsg = "Error during GraphQL request restricted fields validation: '%s'"

// const used by cache middleware
const SAFE_METHODS = "SAFE_METHODS"

const UnexpectedSigningMethod = "Unexpected signing method"

const XTykAPIExpires = "x-tyk-api-expires"

const (
	// EventQuotaExceeded is an alias maintained for backwards compatibility.
	EventQuotaExceeded	= event.QuotaExceeded
	// RateLimitExceeded is an alias maintained for backwards compatibility.
	EventRateLimitExceeded	= event.RateLimitExceeded
	// EventAuthFailure is an alias maintained for backwards compatibility.
	EventAuthFailure	= event.AuthFailure
	// EventUpstreamOAuthError is an alias maintained for backwards compatibility.
	UpstreamOAuthError	= event.UpstreamOAuthError
	// EventKeyExpired is an alias maintained for backwards compatibility.
	EventKeyExpired	= event.KeyExpired
	// EventVersionFailure is an alias maintained for backwards compatibility.
	EventVersionFailure	= event.VersionFailure
	// EventOrgQuotaExceeded is an alias maintained for backwards compatibility.
	EventOrgQuotaExceeded	= event.OrgQuotaExceeded
	// EventOrgRateLimitExceeded is an alias maintained for backwards compatibility.
	EventOrgRateLimitExceeded	= event.OrgRateLimitExceeded
	// EventTriggerExceeded is an alias maintained for backwards compatibility.
	EventTriggerExceeded	= event.TriggerExceeded
	// EventBreakerTriggered is an alias maintained for backwards compatibility.
	EventBreakerTriggered	= event.BreakerTriggered
	// EventBreakerTripped is an alias maintained for backwards compatibility.
	EventBreakerTripped	= event.BreakerTripped
	// EventBreakerReset is an alias maintained for backwards compatibility.
	EventBreakerReset	= event.BreakerReset
	// EventHOSTDOWN is an alias maintained for backwards compatibility.
	EventHOSTDOWN	= event.HostDown
	// EventHOSTUP is an alias maintained for backwards compatibility.
	EventHOSTUP	= event.HostUp
	// EventTokenCreated is an alias maintained for backwards compatibility.
	EventTokenCreated	= event.TokenCreated
	// EventTokenUpdated is an alias maintained for backwards compatibility.
	EventTokenUpdated	= event.TokenUpdated
	// EventTokenDeleted is an alias maintained for backwards compatibility.
	EventTokenDeleted	= event.TokenDeleted
)

// Statuses of the request, all are false-y except StatusOk and StatusOkAndIgnore
const (
	VersionNotFound			RequestStatus	= "Version information not found"
	VersionDoesNotExist		RequestStatus	= "This API version does not seem to exist"
	VersionWhiteListStatusNotFound	RequestStatus	= "WhiteListStatus for path not found"
	VersionExpired			RequestStatus	= "Api Version has expired, please check documentation or contact administrator"
	APIExpired			RequestStatus	= "API has expired, please check documentation or contact administrator"
	EndPointNotAllowed		RequestStatus	= "Requested endpoint is forbidden"
	StatusOkAndIgnore		RequestStatus	= "Everything OK, passing and not filtering"
	StatusOk			RequestStatus	= "Everything OK, passing"
	StatusCached			RequestStatus	= "Cached path"
	StatusTransform			RequestStatus	= "Transformed path"
	StatusTransformResponse		RequestStatus	= "Transformed response"
	StatusTransformJQ		RequestStatus	= "Transformed path with JQ"
	StatusTransformJQResponse	RequestStatus	= "Transformed response with JQ"
	StatusHeaderInjected		RequestStatus	= "Header injected"
	StatusMethodTransformed		RequestStatus	= "Method Transformed"
	StatusHeaderInjectedResponse	RequestStatus	= "Header injected on response"
	StatusRedirectFlowByReply	RequestStatus	= "Exceptional action requested, redirecting flow!"
	StatusHardTimeout		RequestStatus	= "Hard Timeout enforced on path"
	StatusCircuitBreaker		RequestStatus	= "Circuit breaker enforced"
	StatusURLRewrite		RequestStatus	= "URL Rewritten"
	StatusVirtualPath		RequestStatus	= "Virtual Endpoint"
	StatusRequestSizeControlled	RequestStatus	= "Request Size Limited"
	StatusRequestTracked		RequestStatus	= "Request Tracked"
	StatusRequestNotTracked		RequestStatus	= "Request Not Tracked"
	StatusValidateJSON		RequestStatus	= "Validate JSON"
	StatusValidateRequest		RequestStatus	= "Validate Request"
	StatusInternal			RequestStatus	= "Internal path"
	StatusGoPlugin			RequestStatus	= "Go plugin"
	StatusPersistGraphQL		RequestStatus	= "Persist GraphQL"
	StatusRateLimit			RequestStatus	= "Rate Limited"
)

const (
	recordsBufferFlushInterval		= 200 * time.Millisecond
	recordsBufferForcedFlushInterval	= 1 * time.Second
)

const (
	playgroundJSTemplateName	= "playground.js"
	playgroundHTMLTemplateName	= "index.html"
)

const (
	Throttle		HealthPrefix	= "Throttle"
	QuotaViolation		HealthPrefix	= "QuotaViolation"
	KeyFailure		HealthPrefix	= "KeyFailure"
	RequestLog		HealthPrefix	= "Request"
	BlockedRequestLog	HealthPrefix	= "BlockedRequest"
)

const (
	prefixEnv	= "env://"
	prefixSecrets	= "secrets://"
	prefixConsul	= "consul://"
	prefixVault	= "vault://"
	prefixKeys	= "tyk-apis"
	vaultSecretPath	= "secret/data/"
)

// Constants for heartBeatStopSentinel indicators.
//
// Go 1.17 adds atomic.Value.Swap which is great, but 1.19
// adds atomic.Bool and other types. This is a go <1.13 cludge.
const (
	// HeartBeatStarted Zero value - the handlers started
	HeartBeatStarted	= 0

	// HeartBeatStopped value - the handlers invoked shutdown
	HeartBeatStopped	= 1
)

const (
	WH_GET		WebHookRequestMethod	= "GET"
	WH_PUT		WebHookRequestMethod	= "PUT"
	WH_POST		WebHookRequestMethod	= "POST"
	WH_DELETE	WebHookRequestMethod	= "DELETE"
	WH_PATCH	WebHookRequestMethod	= "PATCH"
)

const (
	// EH_WebHook is an alias maintained for backwards compatibility.
	// it is the handler to register a webhook event.
	EH_WebHook	= event.WebHookHandler
	// EH_JSVMHandler is aliased for backwards compatibility.
	EH_JSVMHandler	= event.JSVMHandler
	// EH_LogHandler is an alias maintained for backwards compatibility.
	// It is used to register log handler on an event.
	EH_LogHandler	= event.LogHandler
)

// Notification codes for new and refresh codes
const (
	newAccessToken		OAuthNotificationType	= "new"
	refreshAccessToken	OAuthNotificationType	= "refresh"
)

const (
	defaultTemplateName	= "error"
	defaultTemplateFormat	= "json"
	defaultContentType	= header.ApplicationJSON

	MsgAuthFieldMissing				= "Authorization field missing"
	MsgApiAccessDisallowed				= "Access to this API has been disallowed"
	MsgBearerMailformed				= "Bearer token malformed"
	MsgKeyNotAuthorized				= "Key not authorised"
	MsgOauthClientRevoked				= "Key not authorised. OAuth client access was revoked"
	MsgKeyNotAuthorizedUnexpectedSigningMethod	= "Key not authorized: Unexpected signing method"
	MsgCertificateExpired				= "Certificate has expired"
)

const (
	keyDataDeveloperID	= "tyk_developer_id"
	keyDataDeveloperEmail	= "tyk_developer_email"
)

const (
	Pass		= model.Pass
	Fail		= model.Fail
	Warn		= model.Warn
	Datastore	= model.Datastore
	System		= model.System
)

const (
	defaultTimeout			= 10
	defaultSampletTriggerLimit	= 3
)

const (
	// Zero value - the service is open and ready to use
	OPEN	= 0

	// Closed value - the service shouldn't be used
	CLOSED	= 1
)

const (
	UnHealthyHostMetaDataTargetKey	= "target_url"
	UnHealthyHostMetaDataAPIKey	= "api_id"
	UnHealthyHostMetaDataHostKey	= "host_name"
	PollerCacheKey			= "PollerActiveInstanceID"
	PoolerHostSentinelKeyPrefix	= "PollerCheckerInstance:"

	UptimeAnalytics_KEYNAME	= "tyk-uptime-analytics"
)

const (
	statsdCmdKindEvent	statsdCmdKind	= iota
	statsdCmdKindEventErr
	statsdCmdKindTiming
	statsdCmdKindGauge
	statsdCmdKindComplete
	statsdCmdKindFlush
	statsdCmdKindDrain
	statsdCmdKindStop
)

const (
	handlerPathGraphQLProxyUpstream		= "/graphql-proxy-upstream"
	handlerPathGraphQLProxyUpstreamError	= "/graphql-proxy-upstream-error"
	handlerPathRestDataSource		= "/rest-data-source"
	handlerPathRestDataSourceV3		= "/rest-data-source-v2"
	handlerPathGraphQLDataSource		= "/graphql-data-source"
	handlerPathHeadersRestDataSource	= "/rest-headers-data-source"
	handlerSubgraphAccounts			= "/subgraph-accounts"
	handlerSubgraphAccountsModified		= "/subgraph-accounts-modified"
	handlerSubgraphReviews			= "/subgraph-reviews"

	// We need a static port so that the urls can be used in static
	// test data, and to prevent the requests from being randomized
	// for checksums. Port 16500 should be obscure and unused.
	testHttpListen	= "127.0.0.1:16500"
	// Accepts any http requests on /, only allows GET on /get, etc.
	// All return a JSON with request info.
	TestHttpAny			= "http://" + testHttpListen
	TestHttpGet			= TestHttpAny + "/get"
	testHttpPost			= TestHttpAny + "/post"
	testGraphQLProxyUpstream	= TestHttpAny + handlerPathGraphQLProxyUpstream
	testGraphQLProxyUpstreamError	= TestHttpAny + handlerPathGraphQLProxyUpstreamError
	testGraphQLDataSource		= TestHttpAny + handlerPathGraphQLDataSource
	testRESTDataSource		= TestHttpAny + handlerPathRestDataSource
	testRESTDataSourceV3		= TestHttpAny + handlerPathRestDataSourceV3
	testRESTHeadersDataSource	= TestHttpAny + handlerPathHeadersRestDataSource
	testSubgraphAccounts		= TestHttpAny + handlerSubgraphAccounts
	testSubgraphAccountsModified	= TestHttpAny + handlerSubgraphAccountsModified
	testSubgraphReviews		= TestHttpAny + handlerSubgraphReviews
	testHttpJWK			= TestHttpAny + "/jwk.json"
	testHttpJWKLegacy		= TestHttpAny + "/jwk-legacy.json"
	testHttpBundles			= TestHttpAny + "/bundles/"
	testReloadGroup			= TestHttpAny + "/groupReload"

	// Nothing should be listening on port 16501 - useful for
	// testing TCP and HTTP failures.
	testHttpFailure		= "127.0.0.1:16501"
	testHttpFailureAny	= "http://" + testHttpFailure
	MockOrgID		= "507f1f77bcf86cd799439011"
	NonCanonicalHeaderKey	= "X-CertificateOuid"
)

const (
	sessionFailNone	sessionFailReason	= iota
	sessionFailRateLimit
	sessionFailQuota
	sessionFailInternalServerError
)

const (
	// QuotaKeyPrefix serves as a standard prefix for generating quota keys.
	QuotaKeyPrefix	= "quota-"

	// RateLimitKeyPrefix serves as a standard prefix for generating rate limiter keys.
	RateLimitKeyPrefix	= rate.LimiterKeyPrefix

	// SentinelRateLimitKeyPostfix is appended to the rate limiting key to combine into a sentinel key.
	SentinelRateLimitKeyPostfix	= ".BLOCKED"
)

const (
	accessToken	= "access_token"
	refreshToken	= "refresh_token"
)

const (
	ErrOAuthAuthorizationFieldMissing	= "oauth.auth_field_missing"
	ErrOAuthAuthorizationFieldMalformed	= "oauth.auth_field_malformed"
	ErrOAuthKeyNotFound			= "oauth.key_not_found"
	ErrOAuthClientDeleted			= "oauth.client_deleted"
)

const (
	mwStatusRespond			= middleware.StatusRespond
	DEFAULT_ORG_SESSION_EXPIRATION	= int64(604800)
)

// These enums fix the prefix to use when storing various OAuth keys and data, since we
// delegate everything to the osin framework
const (
	prefixAuth		= "oauth-authorize."
	prefixClient		= "oauth-clientid."
	prefixAccess		= "oauth-access."
	prefixRefresh		= "oauth-refresh."
	prefixClientset		= "oauth-clientset."
	prefixClientIndexList	= "oauth-client-index."
	prefixClientTokens	= "oauth-client-tokens."
)

const (
	LDAPStorageEngine	apidef.StorageEngineCode	= "ldap"
	RPCStorageEngine	apidef.StorageEngineCode	= "rpc"
)

// Enums representing the various statuses for a VersionInfo Path match during a
// proxy request
const (
	_	URLStatus	= iota
	Ignored
	WhiteList
	BlackList
	MockResponse
	Cached
	Transformed
	TransformedJQ
	HeaderInjected
	HeaderInjectedResponse
	TransformedResponse
	TransformedJQResponse
	HardTimeout
	CircuitBreaker
	URLRewrite
	VirtualPath
	RequestSizeLimit
	MethodTransformed
	RequestTracked
	RequestNotTracked
	ValidateJSONRequest
	Internal
	GoPlugin
	PersistGraphQL
	RateLimit
)

const (
	defaultSignatureErrorCode	= http.StatusUnauthorized
	defaultSignatureErrorMessage	= "Request signature verification failed"
)

const (
	ErrAuthAuthorizationFieldMissing	= "auth.auth_field_missing"
	ErrAuthKeyNotFound			= "auth.key_not_found"
	ErrAuthCertNotFound			= "auth.cert_not_found"
	ErrAuthCertExpired			= "auth.cert_expired"
	ErrAuthKeyIsInvalid			= "auth.key_is_invalid"

	MsgNonExistentKey	= "Attempted access with non-existent key."
	MsgNonExistentCert	= "Attempted access with non-existent cert."
	MsgInvalidKey		= "Attempted access with invalid key."
)

const (
	ResetQuota		string	= "resetQuota"
	CertificateRemoved	string	= "CertificateRemoved"
	CertificateAdded	string	= "CertificateAdded"
	OAuthRevokeToken	string	= "oAuthRevokeToken"
	OAuthRevokeAccessToken	string	= "oAuthRevokeAccessToken"
	OAuthRevokeRefreshToken	string	= "oAuthRevokeRefreshToken"
	OAuthRevokeAllTokens	string	= "revoke_all_tokens"
	OauthClientAdded	string	= "OauthClientAdded"
	OauthClientRemoved	string	= "OauthClientRemoved"
	OauthClientUpdated	string	= "OauthClientUpdated"
)

const (
	ComplexityFailReasonNone	ComplexityFailReason	= iota
	ComplexityFailReasonInternalError
	ComplexityFailReasonDepthLimitExceeded
)

const (
	GranularAccessFailReasonNone	GranularAccessFailReason	= iota
	GranularAccessFailReasonInternalError
	GranularAccessFailReasonValidationError
)

const (
	metaLabel		= "$tyk_meta."
	contextLabel		= "$tyk_context."
	consulLabel		= "$secret_consul."
	vaultLabel		= "$secret_vault."
	envLabel		= "$secret_env."
	secretsConfLabel	= "$secret_conf."
	triggerKeyPrefix	= "trigger"
	triggerKeySep		= "-"
)

const (
	checkIdleMemConnInterval	= 5 * time.Minute
	maxIdleMemConnDuration		= time.Minute
	inMemNetworkName		= "in-mem-network"
	inMemNetworkType		= "memu"
)

const (
	KID		= "kid"
	SUB		= "sub"
	HMACSign	= "hmac"
	RSASign		= "rsa"
	ECDSASign	= "ecdsa"
)

const (
	upstreamCacheHeader	= "x-tyk-cache-action-set"
	upstreamCacheTTLHeader	= "x-tyk-cache-action-set-ttl"
)

const (
	RedisPubSubChannel	= "tyk.cluster.notifications"

	NoticeApiUpdated		NotificationCommand	= "ApiUpdated"
	NoticeApiRemoved		NotificationCommand	= "ApiRemoved"
	NoticeApiAdded			NotificationCommand	= "ApiAdded"
	NoticeGroupReload		NotificationCommand	= "GroupReload"
	NoticePolicyChanged		NotificationCommand	= "PolicyChanged"
	NoticeConfigUpdate		NotificationCommand	= "NoticeConfigUpdated"
	NoticeDashboardZeroConf		NotificationCommand	= "NoticeDashboardZeroConf"
	NoticeDashboardConfigRequest	NotificationCommand	= "NoticeDashboardConfigRequest"
	NoticeGatewayConfigResponse	NotificationCommand	= "NoticeGatewayConfigResponse"
	NoticeGatewayDRLNotification	NotificationCommand	= "NoticeGatewayDRLNotification"
	KeySpaceUpdateNotification	NotificationCommand	= "KeySpaceUpdateNotification"
	OAuthPurgeLapsedTokens		NotificationCommand	= "OAuthPurgeLapsedTokens"
	// NoticeDeleteAPICache is the command with which event is emitted from dashboard to invalidate cache for an API.
	NoticeDeleteAPICache	NotificationCommand	= "DeleteAPICache"
	NoticeUserKeyReset	NotificationCommand	= "UserKeyReset"
)

const acceptCode = "X-Tyk-Accept-Example-Code"

const acceptContentType = "Accept"

const acceptExampleName = "X-Tyk-Accept-Example-Name"

const altHeaderSpec = "x-aux-date"

const analyticsKeyName = "tyk-system-analytics"

const appName = "tyk-gateway"

const arrayName = "tyk_array"

const (
	cachedResponseHeader = "x-tyk-cached-response"
)

const (
	// Check OAuth client deleted interval in seconds.
	checkOAuthClientDeletedInterval = 1
)

const cmdChanBuffSize = 8192	// random-ass-guess

const coreJS = `
var TykJS = {
	TykMiddleware: {
		MiddlewareComponentMeta: function(configuration) {
			this.configuration = configuration
		}
	},
	TykEventHandlers: {
		EventHandlerComponentMeta: function() {}
	}
}

TykJS.TykMiddleware.MiddlewareComponentMeta.prototype.ProcessRequest = function(request, session, config) {
	log("Process Request Not Implemented")
	return request
}

TykJS.TykMiddleware.MiddlewareComponentMeta.prototype.DoProcessRequest = function(request, session, config) {
	request.Body = b64dec(request.Body)
	var processed_request = this.ProcessRequest(request, session, config)

	if (!processed_request) {
		log("Middleware didn't return request object!")
		return
	}

	// Reset the headers object
	processed_request.Request.Headers = {}
	processed_request.Request.Body = b64enc(processed_request.Request.Body)

	return JSON.stringify(processed_request)
}

// The user-level middleware component
TykJS.TykMiddleware.NewMiddleware = function(configuration) {
	TykJS.TykMiddleware.MiddlewareComponentMeta.call(this, configuration)
}

// Set up object inheritance
TykJS.TykMiddleware.NewMiddleware.prototype = Object.create(TykJS.TykMiddleware.MiddlewareComponentMeta.prototype)
TykJS.TykMiddleware.NewMiddleware.prototype.constructor = TykJS.TykMiddleware.NewMiddleware

TykJS.TykMiddleware.NewMiddleware.prototype.NewProcessRequest = function(callback) {
	this.ProcessRequest = callback
}

TykJS.TykMiddleware.NewMiddleware.prototype.ReturnData = function(request, session) {
	return {Request: request, SessionMeta: session}
}

TykJS.TykMiddleware.NewMiddleware.prototype.ReturnAuthData = function(request, session) {
	return {Request: request, Session: session}
}

// Event Handler implementation

TykJS.TykEventHandlers.EventHandlerComponentMeta.prototype.DoProcessEvent = function(event, context) {
	// call the handler
	log("Calling built - in handle")
	this.Handle(event, context)
	return
}

TykJS.TykEventHandlers.EventHandlerComponentMeta.prototype.Handle = function(request, context) {
	log("Handler not implemented!")
	return request
}

// The user-level event handler component
TykJS.TykEventHandlers.NewEventHandler = function() {
	TykJS.TykEventHandlers.EventHandlerComponentMeta.call(this)
}

// Set up object inheritance for events
TykJS.TykEventHandlers.NewEventHandler.prototype = Object.create(TykJS.TykEventHandlers.EventHandlerComponentMeta.prototype)
TykJS.TykEventHandlers.NewEventHandler.prototype.constructor = TykJS.TykEventHandlers.NewEventHandler

TykJS.TykEventHandlers.NewEventHandler.prototype.NewHandler = function(callback) {
	this.Handle = callback
};`

const dateHeaderSpec = "Date"

const defaultBasicAuthTTL int64 = 60

const defaultJSVMTimeout = 5

// Check for recursion
const defaultLoopLevelLimit = 5

const defaultProxyTimeout float64 = 30

const jsonContentType = "application/json"

const jwkTestJson = `{
    "keys": [
        {
            "use": "sig",
            "kty": "RSA",
            "kid": "12345",
            "alg": "RS256",
            "n": "yqZ4rwKF8qCExS7kpY4cnJa_37FMkJNkalZ3OuslLB0oRL8T4c94kdF4aeNzSFkSe2n99IBI6Ssl79vbfMZb-t06L0Q94k-_P37x7-_RJZiff4y1VGjrnrnMI2iu9l4iBBRYzNmG6eblroEMMWlgk5tysHgxB59CSNIcD9gqk1hx4n_FgOmvKsfQgWHNlPSDTRcWGWGhB2_XgNVYG2pOlQxAPqLhBHeqGTXBbPfGF9cHzixpsPr6GtbzPwhsQ_8bPxoJ7hdfn-rzztks3d6-HWURcyNTLRe0mjXjjee9Z6-gZ-H-fS4pnP9tqT7IgU6ePUWTpjoiPtLexgsAa_ctjQ",
            "e": "AQAB"
        }
    ]
}`

const jwkTestJsonLegacy = `{
    "keys": [{
        "alg": "RS256",
        "kty": "RSA",
        "use": "sig",
        "x5c": ["Ci0tLS0tQkVHSU4gUFVCTElDIEtFWS0tLS0tCk1JSUJJakFOQmdrcWhraUc5dzBCQVFFRkFBT0NBUThBTUlJQkNnS0NBUUVBeXFaNHJ3S0Y4cUNFeFM3a3BZNGMKbkphLzM3Rk1rSk5rYWxaM091c2xMQjBvUkw4VDRjOTRrZEY0YWVOelNGa1NlMm45OUlCSTZTc2w3OXZiZk1aYgordDA2TDBROTRrKy9QMzd4NysvUkpaaWZmNHkxVkdqcm5ybk1JMml1OWw0aUJCUll6Tm1HNmVibHJvRU1NV2xnCms1dHlzSGd4QjU5Q1NOSWNEOWdxazFoeDRuL0ZnT212S3NmUWdXSE5sUFNEVFJjV0dXR2hCMi9YZ05WWUcycE8KbFF4QVBxTGhCSGVxR1RYQmJQZkdGOWNIeml4cHNQcjZHdGJ6UHdoc1EvOGJQeG9KN2hkZm4rcnp6dGtzM2Q2KwpIV1VSY3lOVExSZTBtalhqamVlOVo2K2daK0grZlM0cG5QOXRxVDdJZ1U2ZVBVV1Rwam9pUHRMZXhnc0FhL2N0CmpRSURBUUFCCi0tLS0tRU5EIFBVQkxJQyBLRVktLS0tLQo="],
        "n": "xofiG8gsnv9-I_g-5OWTLhaZtgAGq1QEsBCPK9lmLqhuonHe8lT-nK1DM49f6J9QgaOjZ3DB50QkhBysnIFNcXFyzaYIPMoccvuHLPgdBawX4WYKm5gficD0WB0XnTt4sqTI5usFpuop9vvW44BwVGhRqMT7c11gA8TSWMBxDI4A5ARc4MuQtfm64oN-JQodSztArwb9wcmH8WrBvSUkR4pyi9MT8W27gqJ2e2Xn8jgGnswNQWOyCTN84PawOYaN-2ORHeIea1g-URln1bofcHN73vZCIrVbE6iA2D7Ybh22AVrCfunekEDEe2GZfLZLejiZiBWG7enJhcrQIzAQGw",
        "e": "AQAB",
        "kid": "12345",
        "x5t": "12345"
    }]
}`

const jwtECDSAPrivateKey = `-----BEGIN PRIVATE KEY-----
MHcCAQEEIFjaz7TJpBOHmQttPypGRh3rqaXvRpsWE/EWUiLzc6veoAoGCCqGSM49
AwEHoUQDQgAEDmKdIVHH9D5xkUiMJvo4T9H8yU+QYOIBlX5DYpJFtEvzTs4SsXYC
tFsPk7c31tOpMuS8aQiLsXR82VMLqQBf1w==
-----END PRIVATE KEY-----`

const jwtECDSAPublicKey = `-----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEDmKdIVHH9D5xkUiMJvo4T9H8yU+Q
YOIBlX5DYpJFtEvzTs4SsXYCtFsPk7c31tOpMuS8aQiLsXR82VMLqQBf1w==
-----END PUBLIC KEY-----`

// openssl genrsa -out app.rsa
const jwtRSAPrivKey = `
-----BEGIN RSA PRIVATE KEY-----
MIIEpQIBAAKCAQEAyqZ4rwKF8qCExS7kpY4cnJa/37FMkJNkalZ3OuslLB0oRL8T
4c94kdF4aeNzSFkSe2n99IBI6Ssl79vbfMZb+t06L0Q94k+/P37x7+/RJZiff4y1
VGjrnrnMI2iu9l4iBBRYzNmG6eblroEMMWlgk5tysHgxB59CSNIcD9gqk1hx4n/F
gOmvKsfQgWHNlPSDTRcWGWGhB2/XgNVYG2pOlQxAPqLhBHeqGTXBbPfGF9cHzixp
sPr6GtbzPwhsQ/8bPxoJ7hdfn+rzztks3d6+HWURcyNTLRe0mjXjjee9Z6+gZ+H+
fS4pnP9tqT7IgU6ePUWTpjoiPtLexgsAa/ctjQIDAQABAoIBAECWvnBJRZgHQUn3
oDiECup9wbnyMI0D7UVXObk1qSteP69pl1SpY6xWLyLQs7WjbhiXt7FuEc7/SaAh
Wttx/W7/g8P85Bx1fmcmdsYakXaCJpPorQKyTibQ4ReIDfvIFN9n/MWNr0ptpVbx
GonFJFrneK52IGplgCLllLwYEbnULYcJc6E25Ro8U2gQjF2r43PDa07YiDrmB/GV
QQW4HTo+CA9rdK0bP8GpXgc0wpmBhx/t/YdnDg6qhzyUMk9As7JrAzYPjHO0cRun
vhA/aG/mdMmRumY75nj7wB5U5DgstsN2ER75Pjr1xe1knftIyNm15AShCPfLaLGo
dA2IpwECgYEA5E8h6ssa7QroCGwp/N0wSJW41hFYGygbOEg6yPWTJkqmMZVduD8X
/KFqJK4LcIbFQuR28+hWJpHm/RF1AMRhbbWkAj6h02gv5izFwDiFKev5paky4Evg
G8WfUOmSZ1D+fVxwaoG0OaRZpCovUTxYig3xrI659DMeKqpQ7e8l9ekCgYEA4zql
l4P4Dn0ydr+TI/s4NHIQHkaLQAVk3OWwyKowijXd8LCtuZRA1NKSpqQ4ZXi0B17o
9zzF5jEUjws3qWv4PKWdxJu3y+h/etsg7wxUeNizbY2ooUGeMbk0tWxJihbgaI7E
XxLIT50F3Ky4EJ2cUL9GmJ+gLCw0KIaVbkiyYAUCgYEA0WyVHB76r/2VIkS1rzHm
HG7ageKfAyoi7dmzsqsxM6q+EDWHJn8Zra8TAlp0O+AkClwvkUTJ4c9sJy9gODfr
dwtrSnPRVW74oRbovo4Z+H5xHbi65mwzQsZggYP/u63cA3pL1Cbt/wH3CFN52/aS
8PAhg7vYb1yEi3Z3jgoUtCECgYEAhSPX4u9waQzyhKG7lVmdlR1AVH0BGoIOl1/+
NZWC23i0klLzd8lmM00uoHWYldwjoC38UuFJE5eudCIeeybITMC9sHWNO+z+xP2g
TnDrDePrPkXCiLnp9ziNqb/JVyAQXTNJ3Gsk84EN7j9Fmna/IJDyzHq7XyaHaTdy
VyxBWAECgYEA4jYS07bPx5UMhKiMJDqUmDfLNFD97XwPoJIkOdn6ezqeOSmlmo7t
jxHLbCmsDOAsCU/0BlLXg9wMU7n5QKSlfTVGok/PU0rq2FUXQwyKGnellrqODwFQ
YGivtXBGXk1hlVYlje1RB+W6RQuDAegI5h8vl8pYJS9JQH0wjatsDaE=
-----END RSA PRIVATE KEY-----
`

const jwtSecret = "9879879878787878"

const letters = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"

// identifies that field value was hidden before output to the log
const logHiddenValue = "<hidden>"

const mascot = `
.                   ╲╲╲╲╲╲
.                   ╲╲╲╲╲╲╲╲╲
.            *******╲╲╲╲╲╲╲╲╲╲╲
.           **********╲╲╲╲╲╲╲╲╲╲
.        ***************╲╲╲╲╲╲╲╲╲╲
.      ******************╲╲╲╲╲╲╲╲╲
.     ********************╲╲╲╲╲╲╲╲╲
.    ***********************╲╲╲╲╲╲╲╲
.   *************************** ╲╲╲╲╲╲
.   ****************************    ╲╲╲
.   *****      *******      ****     _______      _        _
.   ******      *****      *****    |__   __|    | |      (_)
.   ****************************       | | _   _ | | __    _   ___
.   *****************************      | || | | || |/ /   | | / _ \
.   ******************************     | || |_| ||   <  _ | || (_) |
.  ********************************    |_| \__, ||_|\_\(_)|_| \___/
. *********************************         __/ |
. ***  ************* *********  ****       |___/
.       *********************
.         *****************
.          ******* ******
.            ***** *****
.           ****** ******
`

const mascotHeaderKeyFormat = "X-Mascot-%03d"

const maxUdpBytes = 1440	// 1500(Ethernet MTU) - 60(Max UDP header size

const oAuthClientNotFound = "OAuth client not found"

const (
	oAuthClientTokensKeyPattern = "oauth-data.*oauth-client-tokens.*"
)

const oAuthNotPropagatedErr = "OAuth client list isn't available or hasn't been propagated yet."

const oauthClientIdEmpty = "client_id is required"

const oauthClientSecretEmpty = "client_secret is required"

const oauthClientSecretWrong = "client secret is wrong"

const oauthTokenEmpty = "token is required"

const (
	rateLimitEndpoint = "/tyk/rate-limits/"
)

const sampleAPI = `{
    "api_id": "test",
	"org_id": "default",
    "use_keyless": true,
    "definition": {
        "location": "header",
        "key": "version"
    },
    "auth": {
        "auth_header_name": "authorization"
	},
    "version_data": {
		"default_version": "Default",
        "not_versioned": true,
        "versions": {
            "v1": {
            	"name": "v1",
            	"use_extended_paths": true
           	}
        }
    },
    "proxy": {
        "listen_path": "/sample",
        "target_url": "` + TestHttpAny + `"
    },
	"graphql": {
      "enabled": false,
      "execution_mode": "executionEngine",
	  "version": "",
      "schema": "` + testComposedSchema + `",
      "type_field_configurations": [
        ` + testGraphQLDataSourceConfiguration + `,
        ` + testRESTDataSourceConfiguration + `
      ],
	  "engine": {
		"field_configs": [
			{
				"type_name": "Query",
				"field_name": "people",
				"disable_default_mapping": true,
				"path": [""]
			},
			{
				"type_name": "Query",
				"field_name": "headers",
				"disable_default_mapping": true,
				"path": [""]
			}
		],
		"data_sources": [
		    ` + testRESTDataSourceConfigurationV2 + `,
			` + testGraphQLDataSourceConfigurationV2 + `,
			` + testRESTHeadersDataSourceConfigurationV2 + `
		]
	},
      "playground": {
        "enabled": false,
        "path": "/playground"
      }
    }
}`

const testComposedSchema = "type Query {countries: [Country] headers: [Header]} " +
	"extend type Query {people: [Person]}" +
	"type Person {name: String country: Country} " +
	"type Country {code: String name: String} " +
	"type Header {name:String value: String}"

const testComposedSchemaNotExtended = "type Query {countries: [Country] headers: [Header] people: [Person]} " +
	"type Person {name: String country: Country} " +
	"type Country {code: String name: String} " +
	"type Header {name:String value: String}"

const testGraphQLDataSourceConfiguration = `
{
  "type_name": "Query",
  "field_name": "countries",
  "mapping": {
	"disabled": false,
	"path": "countries"
  },
  "data_source": {
	"kind": "GraphQLDataSource",
	"data_source_config": {
	  "url": "` + testGraphQLDataSource + `",
	  "method": "POST"
	}
  }
}
`

const testGraphQLDataSourceConfigurationV2 = `
{
	"kind": "GraphQL",
	"name": "countries",
	"internal": true,
	"root_fields": [
		{ "type": "Query", "fields": ["countries"] }
	],
	"config": {
		"url": "` + testGraphQLDataSource + `",
		"method": "POST"
	}
}`

const testRESTDataSourceConfiguration = `
{
 "type_name": "Query",
 "field_name": "people",
  "mapping": {
	"disabled": false,
	"path": ""
  },
  "data_source": {
    "kind": "HTTPJSONDataSource",
	"data_source_config": {
	  "url": "` + testRESTDataSource + `",
	  "method": "GET",
	  "body": "",
	  "headers": [],
	  "default_type_name": "People",
	  "status_code_type_name_mappings": [
		{
		  "status_code": 200,
		  "type_name": ""
		}
	  ]
	}
  }
}`

const testRESTDataSourceConfigurationV2 = `
{
	"kind": "REST",
	"name": "people",
	"internal": true,
	"root_fields": [
		{ "type": "Query", "fields": ["people"] }
	],
	"config": {
		"url": "` + testRESTDataSource + `",
		"method": "GET",
		"headers": {},
		"query": [],
		"body": ""
	}
}`

const testRESTDataSourceConfigurationV3 = `
{
	"kind": "REST",
	"name": "people",
	"internal": true,
	"root_fields": [
		{ "type": "Query", "fields": ["people"] }
	],
	"config": {
		"url": "` + testRESTDataSourceV3 + `",
		"method": "GET",
		"headers": {},
		"query": [],
		"body": ""
	}
}`

const testRESTHeadersDataSourceConfigurationV2 = `
{
	"kind": "REST",
	"name": "headers",
	"internal": true,
	"root_fields": [
		{ "type": "Query", "fields": ["headers"] }
	],
	"config": {
		"url": "` + testRESTHeadersDataSource + `",
		"method": "GET",
		"headers": {
			"static": "barbaz",
			"injected": "{{ .request.headers.injected }}",
			"context": "$tyk_context.headers_From_Request",
			"does-exist-already": "ds-does-exist-already"
		},
		"query": [],
		"body": ""
	}
}`

var (
	// ErrEventHandlerDisabled is returned when the event handler is disabled.
	ErrEventHandlerDisabled = errors.New("event handler disabled")
)

var (
	ErrPoliciesFetchFailed = errors.New("fetch policies request login failure")
)

var (
	ErrRequestMalformed = errors.New("request malformed")
)

var GatewayFireSystemEvent func(name apidef.TykEvent, meta interface{})

var GetJWK = getJWK

var JWKCache cache.Repository = cache.New(240, 30)

var LoopHostRE = regexp.MustCompile("tyk://([^/]+)")

var NonAlphaNumRE = regexp.MustCompile("[^A-Za-z0-9]+")

var TykErrors = make(map[string]config.TykError)

var (
	grpcConnection	*grpc.ClientConn
	grpcClient	coprocess.DispatcherClient
)

var (
	GlobalRate		= ratecounter.NewRateCounter(1 * time.Second)
	orgSessionExpiryCache	singleflight.Group
)

var (
	globalMu	sync.Mutex

	log		= logger.Get()
	mainLog		= log.WithField("prefix", "main")
	pubSubLog	= log.WithField("prefix", "pub-sub")
	rawLog		= logger.GetRaw()

	memProfFile	*os.File

	// confPaths is the series of paths to try to use as config files. The
	// first one to exist will be used. If none exists, a default config
	// will be written to the first path in the list.
	//
	// When --conf=foo is used, this will be replaced by []string{"foo"}.
	confPaths	= []string{
		"tyk.conf",
		// TODO: add ~/.config/tyk/tyk.conf here?
		"/etc/tyk/tyk.conf",
	}

	ErrSyncResourceNotKnown	= errors.New("unknown resource to sync")
)

var (
	// List of common OAuth Client ID claims used by IDPs:
	oauthClientIDClaims	= []string{
		"clientId",	// Keycloak
		"cid",		// OKTA
		"client_id",	// Gluu
	}

	ErrNoSuitableUserIDClaimFound	= errors.New("no suitable claims for user ID were found")
	ErrEmptyUserIDInSubClaim	= errors.New("found an empty user ID in sub claim")
)

var (
	ProxyingRequestFailedErr	= errors.New("there was a problem proxying the request")
	GraphQLDepthLimitExceededErr	= errors.New("depth limit exceeded")
)

var (
	externalOAuthJWKCache		cache.Repository	= cache.New(240, 30)
	externalOAuthIntrospectionCache	*introspectionCache
	ErrTokenValidationFailed	= errors.New("error happened during the access token validation")
	ErrKIDNotAString		= errors.New("kid is not a string")
	ErrNoMatchingKIDFound		= errors.New("no matching KID could be found")
)

var (
	bundleBackoffMultiplier	float64	= 2
	bundleMaxBackoffRetries	uint64	= 4
)

var (
	supportedDrivers	= []apidef.MiddlewareDriver{apidef.PythonDriver, apidef.LuaDriver, apidef.GrpcDriver}
	loadedDrivers		= map[apidef.MiddlewareDriver]coprocess.Dispatcher{}
)

var (
	VERSION	= build.Version
	Commit	= build.Commit
)

var (
	ctxData	= httpctx.NewValue[map[string]any](ctx.ContextData)

	ctxGetData	= ctxData.Get
	ctxSetData	= ctxData.Set

	setContext	= core.SetContext

	// how is type safety avoided: exhibit A, old school generics
	setCtxValue	= func(h *http.Request, key, value any) {
		ctxvalue := httpctx.NewValue[any](key)
		h = ctxvalue.Set(h, value)
	}

	EncodeRequestToEvent	= event.EncodeRequestToEvent
)

var (
	onceStartAllHostsDown	sync.Once

	allHostsDownURL	string
)

var applicationGCStats = debug.GCStats{}

var basicAuthCache = cache.New(60, 3600)

var cacheGroup singleflight.Group

var certLog = log.WithField("prefix", "certs")

var cipherSuites = map[string]uint16{
	"TLS_RSA_WITH_RC4_128_SHA":			0x0005,
	"TLS_RSA_WITH_3DES_EDE_CBC_SHA":		0x000a,
	"TLS_RSA_WITH_AES_128_CBC_SHA":			0x002f,
	"TLS_RSA_WITH_AES_256_CBC_SHA":			0x0035,
	"TLS_RSA_WITH_AES_128_CBC_SHA256":		0x003c,
	"TLS_RSA_WITH_AES_128_GCM_SHA256":		0x009c,
	"TLS_RSA_WITH_AES_256_GCM_SHA384":		0x009d,
	"TLS_ECDHE_ECDSA_WITH_RC4_128_SHA":		0xc007,
	"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA":		0xc009,
	"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA":		0xc00a,
	"TLS_ECDHE_RSA_WITH_RC4_128_SHA":		0xc011,
	"TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA":		0xc012,
	"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA":		0xc013,
	"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA":		0xc014,
	"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256":	0xc023,
	"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256":	0xc027,
	"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256":	0xc02f,
	"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256":	0xc02b,
	"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384":	0xc030,
	"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384":	0xc02c,
	"TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305":		0xcca8,
	"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305":	0xcca9,
}

var consulMatch = regexp.MustCompile(`\$secret_consul.([A-Za-z0-9\/\-\.]+)`)

var contextMatch = regexp.MustCompile(`\$tyk_context.([A-Za-z0-9_\-\.]+)`)

var corsHeaders = []string{
	"Access-Control-Allow-Origin",
	"Access-Control-Expose-Headers",
	"Access-Control-Max-Age",
	"Access-Control-Allow-Credentials",
	"Access-Control-Allow-Methods",
	"Access-Control-Allow-Headers"}

var createOauthClientSecret = func() string {
	secret := uuid.New()
	return base64.StdEncoding.EncodeToString([]byte(secret))
}

var dashClient *http.Client

var dashLog = log.WithField("prefix", "dashboard")

var defaultStatsDOptions = StatsDSinkOptions{SanitizationFunc: sanitizeKey}

var defaultUserAgent = "Tyk/" + VERSION

var defaultWorkerPoolSize = runtime.NumCPU()

var (
	dispatcherFuncs = map[string]interface{}{
		"Login": func(clientAddr, userKey string) bool {
			return false
		},
		"LoginWithGroup": func(clientAddr string, groupData *model.GroupLoginRequest) bool {
			return false
		},
		"GetKey": func(keyName string) (string, error) {
			return "", nil
		},
		"SetKey": func(ibd *model.InboundData) error {
			return nil
		},
		"GetExp": func(keyName string) (int64, error) {
			return 0, nil
		},
		"GetKeys": func(keyName string) ([]string, error) {
			return nil, nil
		},
		"DeleteKey": func(keyName string) (bool, error) {
			return true, nil
		},
		"DeleteRawKey": func(keyName string) (bool, error) {
			return true, nil
		},
		"GetKeysAndValues": func(searchString string) (*model.KeysValuesPair, error) {
			return nil, nil
		},
		"GetKeysAndValuesWithFilter": func(searchString string) (*model.KeysValuesPair, error) {
			return nil, nil
		},
		"DeleteKeys": func(keys []string) (bool, error) {
			return true, nil
		},
		"DeleteRawKeys": func(keys []string) (bool, error) {
			return true, nil
		},
		"Decrement": func(keyName string) error {
			return nil
		},
		"IncrememntWithExpire": func(ibd *model.InboundData) (int64, error) {
			return 0, nil
		},
		"AppendToSet": func(ibd *model.InboundData) error {
			return nil
		},
		"SetRollingWindow": func(ibd *model.InboundData) (int, error) {
			return 0, nil
		},
		"GetApiDefinitions": func(dr *model.DefRequest) (string, error) {
			return "", nil
		},
		"GetPolicies": func(orgId string) (string, error) {
			return "", nil
		},
		"PurgeAnalyticsData": func(data string) error {
			return nil
		},
		"CheckReload": func(clientAddr, orgId string) (bool, error) {
			return false, nil
		},
		"GetKeySpaceUpdate": func(clientAddr, orgId string) ([]string, error) {
			return nil, nil
		},
		"GetGroupKeySpaceUpdate": func(clientAddr string, groupData *model.GroupKeySpaceRequest) ([]string, error) {
			return nil, nil
		},
		"Ping": func() bool {
			return false
		},
		"Disconnect": func(clientAddr string, groupData *model.GroupLoginRequest) error {
			return nil
		},
	}
)

var dollarMatch = regexp.MustCompile(`\$\d+`)

var envRegex = regexp.MustCompile(`env://([^"]+)`)

var envValueMatch = regexp.MustCompile(`\$secret_env.([A-Za-z0-9_\-\.]+)`)

var errCustomBodyResponse = errors.New("errCustomBodyResponse")

var errUnauthorized = errors.New("Unauthorized")

var getIpAddress = netutil.GetIpAddress

var hopHeaders = []string{
	"Connection",
	"Proxy-Connection",	// non-standard but still sent by libcurl and rejected by e.g. google
	"Keep-Alive",
	"Proxy-Authenticate",
	"Proxy-Authorization",
	"Te",		// canonicalized version of "TE"
	"Trailer",	// not Trailers per URL above; http://www.rfc-editor.org/errata_search.php?eid=4522
	"Transfer-Encoding",
	"Upgrade",
}

var httpScheme = regexp.MustCompile(`^(?i)https?://`)

var idleConnTimeout = 90

var instrument = health.NewStream()

var instrumentationEnabled bool

var memConnClient = &http.Client{
	Transport: &http.Transport{
		DialContext: func(ctx context.Context, _, addr string) (net.Conn, error) {
			provider, err := getMemConnProvider(addr)
			if err != nil {
				return nil, err
			}
			return provider.DialContext(ctx, inMemNetworkType, inMemNetworkName)
		},
	},
}

var memConnProviders = &struct {
	mtx	sync.RWMutex
	m	map[string]*memConnProvider
}{
	m: make(map[string]*memConnProvider),
}

var metaMatch = regexp.MustCompile(`\$tyk_meta.([A-Za-z0-9_\-\.]+)`)

var oneMascot sync.Once

var orgActiveMap sync.Map

var orgChanMap = orgChanMapMu{channels: map[string](chan bool){}}

var playgroundTemplate *texttemplate.Template

var redisInsecureWarn sync.Once

var sdMu sync.RWMutex

var secretsConfMatch = regexp.MustCompile(`\$secret_conf.([A-Za-z0-9[.\-\_]+)`)

HTTP request bodies are theoretically allowed for all methods except TRACE,
however they are not commonly used except in PUT, POST and PATCH. Because of this,
they may not be supported properly by some client frameworks, and you should not allow
request bodies for GET, DELETE, TRACE, OPTIONS and HEAD methods.

var skippedMethods = map[string]struct{}{
	http.MethodGet:		{},
	http.MethodDelete:	{},
	http.MethodTrace:	{},
	http.MethodOptions:	{},
	http.MethodHead:	{},
}

var supportedAlgorithms = []string{"hmac-sha1", "hmac-sha256", "hmac-sha384", "hmac-sha512", "rsa-sha256"}

var tlsConfigCache = cache.New(60, 3600)

var tlsConfigMu sync.Mutex

var vaultMatch = regexp.MustCompile(`\$secret_vault.([A-Za-z0-9\/\-\.]+)`)

This type doesn't have documentation.

Field name	Field type	Comment
Certs	[]*certs.CertificateBasics	No comment on field.

type APIAllCertificateBasics struct {
	Certs []*certs.CertificateBasics `json:"certs"`
}

This type doesn't have documentation.

Field name	Field type	Comment
CertIDs	[]string	No comment on field.

type APIAllCertificates struct {
	CertIDs []string `json:"certs"`
}

This type doesn't have documentation.

Field name	Field type	Comment
CertID	string	No comment on field.
Status	string	No comment on field.
Message	string	No comment on field.

type APICertificateStatusMessage struct {
	CertID	string	`json:"id"`
	Status	string	`json:"status"`
	Message	string	`json:"message"`
}

APIDefinitionLoader will load an Api definition from a storage system.

Field name	Field type	Comment
Gw	*Gateway	No comment on field.

type APIDefinitionLoader struct {
	Gw *Gateway `json:"-"`
}

APIError is generic error object returned if there is something wrong with the request

Field name	Field type	Comment
Message	htmltemplate.HTML	No comment on field.

type APIError struct {
	Message htmltemplate.HTML
}

APISpec represents a path specification for an API, to avoid enumerating multiple nested lists, a single flattened URL list is checked for matching paths and then it's status evaluated if found.

Field name	Field type	Comment
	*apidef.APIDefinition	No comment on field.
OAS	oas.OAS	No comment on field.
	sync.RWMutex	No comment on field.
Checksum	string	No comment on field.
RxPaths	map[string][]URLSpec	No comment on field.
WhiteListEnabled	map[string]bool	No comment on field.
target	*url.URL	No comment on field.
AuthManager	SessionHandler	No comment on field.
OAuthManager	OAuthManagerInterface	No comment on field.
OrgSessionManager	SessionHandler	No comment on field.
EventPaths	map[apidef.TykEvent][]config.TykEventHandler	No comment on field.
Health	HealthChecker	No comment on field.
JSVM	JSVM	No comment on field.
ResponseChain	[]TykResponseHandler	No comment on field.
RoundRobin	RoundRobin	No comment on field.
URLRewriteEnabled	bool	No comment on field.
CircuitBreakerEnabled	bool	No comment on field.
EnforcedTimeoutEnabled	bool	No comment on field.
LastGoodHostList	*apidef.HostList	No comment on field.
HasRun	bool	No comment on field.
ServiceRefreshInProgress	bool	No comment on field.
HTTPTransport	*TykRoundTripper	No comment on field.
HTTPTransportCreated	time.Time	No comment on field.
WSTransport	http.RoundTripper	No comment on field.
WSTransportCreated	time.Time	No comment on field.
GlobalConfig	config.Config	No comment on field.
OrgHasNoSession	bool	No comment on field.
AnalyticsPluginConfig	*GoAnalyticsPlugin	No comment on field.
middlewareChain	*ChainObject	No comment on field.
unloadHooks	[]func()	No comment on field.
network	analytics.NetworkStats	No comment on field.
GraphEngine	graphengine.Engine	No comment on field.
HasMock	bool	No comment on field.
HasValidateRequest	bool	No comment on field.
OASRouter	routers.Router	No comment on field.

type APISpec struct {
	*apidef.APIDefinition
	OAS	oas.OAS

	sync.RWMutex

	Checksum		string
	RxPaths			map[string][]URLSpec
	WhiteListEnabled	map[string]bool
	target			*url.URL
	AuthManager		SessionHandler
	OAuthManager		OAuthManagerInterface

	OrgSessionManager		SessionHandler
	EventPaths			map[apidef.TykEvent][]config.TykEventHandler
	Health				HealthChecker
	JSVM				JSVM
	ResponseChain			[]TykResponseHandler
	RoundRobin			RoundRobin
	URLRewriteEnabled		bool
	CircuitBreakerEnabled		bool
	EnforcedTimeoutEnabled		bool
	LastGoodHostList		*apidef.HostList
	HasRun				bool
	ServiceRefreshInProgress	bool
	HTTPTransport			*TykRoundTripper
	HTTPTransportCreated		time.Time
	WSTransport			http.RoundTripper
	WSTransportCreated		time.Time
	GlobalConfig			config.Config
	OrgHasNoSession			bool
	AnalyticsPluginConfig		*GoAnalyticsPlugin

	middlewareChain	*ChainObject
	unloadHooks	[]func()

	network	analytics.NetworkStats

	GraphEngine	graphengine.Engine

	HasMock			bool
	HasValidateRequest	bool
	OASRouter		routers.Router
}

AccessRightsCheck is a middleware that will check if the key bing used to access the API has permission to access the specific version. If no permission data is in the user.SessionState, then it is assumed that the user can go through.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type AccessRightsCheck struct {
	*BaseMiddleware
}

KeyExists will check if the key being used to access the API is in the request data, and then if the key is in the storage engine

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type AuthKey struct {
	*BaseMiddleware
}

BaseExtractor is the base structure for an ID extractor, it implements the IdExtractor interface. Other extractors may override some of its methods.

Field name	Field type	Comment
Config	*apidef.MiddlewareIdExtractor	No comment on field.
IDExtractorConfig	apidef.IDExtractorConfig	No comment on field.
	*BaseMiddleware	No comment on field.
Spec	*APISpec	No comment on field.

type BaseExtractor struct {
	Config			*apidef.MiddlewareIdExtractor
	IDExtractorConfig	apidef.IDExtractorConfig
	*BaseMiddleware

	Spec	*APISpec
}

BaseMiddleware wraps up the ApiSpec and Proxy objects to be included in a middleware handler, this can probably be handled better.

Field name	Field type	Comment
Spec	*APISpec	No comment on field.
Proxy	ReturningHttpHandler	No comment on field.
Gw	*Gateway	No comment on field.
loggerMu	sync.Mutex	No comment on field.
logger	*logrus.Entry	No comment on field.

type BaseMiddleware struct {
	Spec	*APISpec
	Proxy	ReturningHttpHandler
	Gw	*Gateway	`json:"-"`

	loggerMu	sync.Mutex
	logger		*logrus.Entry
}

This type doesn't have documentation.

Field name	Field type	Comment
Spec	*APISpec	No comment on field.
Gw	*Gateway	No comment on field.

type BaseTykResponseHandler struct {
	Spec	*APISpec	`json:"-"`
	Gw	*Gateway	`json:"-"`
}

BasicAuthKeyIsValid uses a username instead of

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.
bodyUserRegexp	*regexp.Regexp	No comment on field.
bodyPasswordRegexp	*regexp.Regexp	No comment on field.

type BasicAuthKeyIsValid struct {
	*BaseMiddleware

	bodyUserRegexp		*regexp.Regexp
	bodyPasswordRegexp	*regexp.Regexp
}

BatchReplyUnit encodes a request suitable for replying to a batch request

Field name	Field type	Comment
RelativeURL	string	No comment on field.
Code	int	No comment on field.
Headers	http.Header	No comment on field.
Body	string	No comment on field.

type BatchReplyUnit struct {
	RelativeURL	string		`json:"relative_url"`
	Code		int		`json:"code"`
	Headers		http.Header	`json:"headers"`
	Body		string		`json:"body"`
}

BatchRequestHandler handles batch requests on /tyk/batch for any API Definition that has the feature enabled

Field name	Field type	Comment
Gw	*Gateway	No comment on field.
API	*APISpec	No comment on field.

type BatchRequestHandler struct {
	Gw	*Gateway	`json:"-"`
	API	*APISpec
}

BatchRequestStructure defines a batch request order

Field name	Field type	Comment
Requests	[]RequestDefinition	No comment on field.
SuppressParallelExecution	bool	No comment on field.

type BatchRequestStructure struct {
	Requests			[]RequestDefinition	`json:"requests"`
	SuppressParallelExecution	bool			`json:"suppress_parallel_execution"`
}

Bundle is the basic bundle data structure, it holds the bundle name and the data.

Field name	Field type	Comment
Name	string	No comment on field.
Data	[]byte	No comment on field.
Path	string	No comment on field.
Spec	*APISpec	No comment on field.
Manifest	apidef.BundleManifest	No comment on field.
Gw	*Gateway	No comment on field.

type Bundle struct {
	Name		string
	Data		[]byte
	Path		string
	Spec		*APISpec
	Manifest	apidef.BundleManifest
	Gw		*Gateway	`json:"-"`
}

BundleGetter is used for downloading bundle data, see HttpBundleGetter for reference.

Field name	Field type	Comment
type	any	No comment on field.

type BundleGetter interface {
	Get() ([]byte, error)
}

BundleSaver is an interface used by bundle saver structures.

Field name	Field type	Comment
type	any	No comment on field.

type BundleSaver interface {
	Save(*Bundle, string, *APISpec) error
}

CertificateCheckMW is used if domain was not detected or multiple APIs bind on the same domain. In this case authentification check happens not on TLS side but on HTTP level using this middleware

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type CertificateCheckMW struct {
	*BaseMiddleware
}

This type doesn't have documentation.

Field name	Field type	Comment
ThisHandler	http.Handler	No comment on field.
RateLimitChain	http.Handler	No comment on field.
Open	bool	No comment on field.
Skip	bool	No comment on field.

type ChainObject struct {
	ThisHandler	http.Handler
	RateLimitChain	http.Handler
	Open		bool
	Skip		bool
}

This type doesn't have documentation.

Field name	Field type	Comment
methodName	string	No comment on field.
Spec	*APISpec	No comment on field.
SpecJSON	json.RawMessage	No comment on field.

type CoProcessEventHandler struct {
	methodName	string
	Spec		*APISpec
	SpecJSON	json.RawMessage
}

This type doesn't have documentation.

Field name	Field type	Comment
Event	config.EventMessage	No comment on field.
Handler	string	No comment on field.
SpecJSON	*json.RawMessage	No comment on field.

type CoProcessEventWrapper struct {
	Event		config.EventMessage	`json:"message"`
	Handler		string			`json:"handler_name"`
	SpecJSON	*json.RawMessage	`json:"spec"`
}

CoProcessMiddleware is the basic CP middleware struct.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.
HookType	coprocess.HookType	No comment on field.
HookName	string	No comment on field.
MiddlewareDriver	apidef.MiddlewareDriver	No comment on field.
RawBodyOnly	bool	No comment on field.
successHandler	*SuccessHandler	No comment on field.

type CoProcessMiddleware struct {
	*BaseMiddleware

	HookType		coprocess.HookType
	HookName		string
	MiddlewareDriver	apidef.MiddlewareDriver
	RawBodyOnly		bool

	successHandler	*SuccessHandler
}

CoProcessor represents a CoProcess during the request.

Field name	Field type	Comment
Middleware	*CoProcessMiddleware	No comment on field.

type CoProcessor struct {
	Middleware *CoProcessMiddleware
}

This type doesn't have documentation.

Field name	Field type	Comment
type	int	No comment on field.

type ComplexityFailReason int

This type doesn't have documentation.

Field name	Field type	Comment
Configuration	config.Config	No comment on field.
ForHostname	string	No comment on field.
ForNodeID	string	No comment on field.
TimeStamp	int64	No comment on field.

type ConfigPayload struct {
	Configuration	config.Config
	ForHostname	string
	ForNodeID	string
	TimeStamp	int64
}

This type doesn't have documentation.

Field name	Field type	Comment
	BaseTykResponseHandler	No comment on field.
mw	*CoProcessMiddleware	No comment on field.

type CustomMiddlewareResponseHook struct {
	BaseTykResponseHandler
	mw	*CoProcessMiddleware
}

This type doesn't have documentation.

Field name	Field type	Comment
APIName	string	No comment on field.
APIID	string	No comment on field.
Versions	[]string	No comment on field.
AllowedURLs	[]user.AccessSpec	No comment on field.
RestrictedTypes	[]graphql.Type	No comment on field.
AllowedTypes	[]graphql.Type	No comment on field.
DisableIntrospection	bool	No comment on field.
FieldAccessRights	[]user.FieldAccessDefinition	No comment on field.
Limit	*user.APILimit	No comment on field.
Endpoints	user.Endpoints	Endpoints contains endpoint rate limit settings.

type DBAccessDefinition struct {
	APIName			string				`json:"api_name"`
	APIID			string				`json:"api_id"`
	Versions		[]string			`json:"versions"`
	AllowedURLs		[]user.AccessSpec		`bson:"allowed_urls" json:"allowed_urls"`	// mapped string MUST be a valid regex
	RestrictedTypes		[]graphql.Type			`json:"restricted_types"`
	AllowedTypes		[]graphql.Type			`json:"allowed_types"`
	DisableIntrospection	bool				`json:"disable_introspection"`
	FieldAccessRights	[]user.FieldAccessDefinition	`json:"field_access_rights"`
	Limit			*user.APILimit			`json:"limit"`

	// Endpoints contains endpoint rate limit settings.
	Endpoints	user.Endpoints	`json:"endpoints,omitempty"`
}

This type doesn't have documentation.

Field name	Field type	Comment
	user.Policy	No comment on field.
AccessRights	map[string]DBAccessDefinition	No comment on field.

type DBPolicy struct {
	user.Policy
	AccessRights	map[string]DBAccessDefinition	`bson:"access_rights" json:"access_rights"`
}

This type doesn't have documentation.

Field name	Field type	Comment
type	any	No comment on field.

type DashboardServiceSender interface {
	Init() error
	Register() error
	DeRegister() error
	StartBeating() error
	StopBeating()
	Ping() error
	NotifyDashboardOfEvent(interface{}) error
}

This type doesn't have documentation.

Field name	Field type	Comment
Gw	*Gateway	No comment on field.
storage	storage.Handler	No comment on field.
APIID	string	No comment on field.

type DefaultHealthChecker struct {
	Gw	*Gateway	`json:"-"`
	storage	storage.Handler
	APIID	string
}

This type doesn't have documentation.

Field name	Field type	Comment
Gw	*Gateway	No comment on field.

type DefaultKeyGenerator struct {
	Gw *Gateway `json:"-"`
}

This type doesn't have documentation.

Field name	Field type	Comment
store	storage.Handler	No comment on field.
orgID	string	No comment on field.
Gw	*Gateway	No comment on field.

type DefaultSessionManager struct {
	store	storage.Handler
	orgID	string
	Gw	*Gateway	`json:"-"`
}

This type doesn't have documentation.

Field name	Field type	Comment
SH	SuccessHandler	No comment on field.
Gw	*Gateway	No comment on field.

type DummyProxyHandler struct {
	SH	SuccessHandler
	Gw	*Gateway	`json:"-"`
}

DynamicMiddleware is a generic middleware that will execute JS code before continuing

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.
MiddlewareClassName	string	No comment on field.
Pre	bool	No comment on field.
UseSession	bool	No comment on field.
Auth	bool	No comment on field.

type DynamicMiddleware struct {
	*BaseMiddleware

	MiddlewareClassName	string
	Pre			bool
	UseSession		bool
	Auth			bool
}

This type doesn't have documentation.

Field name	Field type	Comment
Method	string	No comment on field.
CacheKeyRegex	string	No comment on field.
CacheOnlyResponseCodes	[]int	No comment on field.
Timeout	int64	No comment on field.

type EndPointCacheMeta struct {
	Method			string
	CacheKeyRegex		string
	CacheOnlyResponseCodes	[]int
	Timeout			int64
}

ErrorHandler is invoked whenever there is an issue with a proxied request, most middleware will invoke the ErrorHandler if something is wrong with the request and halt the request processing through the chain

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type ErrorHandler struct {
	*BaseMiddleware
}

EventCurcuitBreakerMeta is the event status for a circuit breaker tripping

Field name	Field type	Comment
	EventMetaDefault	No comment on field.
Path	string	No comment on field.
APIID	string	No comment on field.
CircuitEvent	circuit.BreakerEvent	No comment on field.

type EventCurcuitBreakerMeta struct {
	EventMetaDefault
	Path		string
	APIID		string
	CircuitEvent	circuit.BreakerEvent
}

This type doesn't have documentation.

Field name	Field type	Comment
	EventMetaDefault	No comment on field.
HostInfo	HostHealthReport	No comment on field.

type EventHostStatusMeta struct {
	EventMetaDefault
	HostInfo	HostHealthReport
}

EventKeyFailureMeta is the metadata structure for any failure related to a key, such as quota or auth failures.

Field name	Field type	Comment
	EventMetaDefault	No comment on field.
Path	string	No comment on field.
Origin	string	No comment on field.
Key	string	No comment on field.

type EventKeyFailureMeta struct {
	EventMetaDefault
	Path	string
	Origin	string
	Key	string
}

This type doesn't have documentation.

Field name	Field type	Comment
type	model.EventMetaDefault	No comment on field.

type EventMetaDefault = model.EventMetaDefault

This type doesn't have documentation.

Field name	Field type	Comment
	EventMetaDefault	No comment on field.
Org	string	No comment on field.
Key	string	No comment on field.

type EventTokenMeta struct {
	EventMetaDefault
	Org	string
	Key	string
}

This type doesn't have documentation.

Field name	Field type	Comment
	EventMetaDefault	No comment on field.
OrgID	string	No comment on field.
Key	string	No comment on field.
TriggerLimit	int64	No comment on field.
UsagePercentage	int64	No comment on field.

type EventTriggerExceededMeta struct {
	EventMetaDefault
	OrgID		string	`json:"org_id"`
	Key		string	`json:"key"`
	TriggerLimit	int64	`json:"trigger_limit"`
	UsagePercentage	int64	`json:"usage_percentage"`
}

EventVersionFailureMeta is the metadata structure for an auth failure (EventKeyExpired)

Field name	Field type	Comment
	EventMetaDefault	No comment on field.
Path	string	No comment on field.
Origin	string	No comment on field.
Key	string	No comment on field.
Reason	string	No comment on field.

type EventVersionFailureMeta struct {
	EventMetaDefault
	Path	string
	Origin	string
	Key	string
	Reason	string
}

This type doesn't have documentation.

Field name	Field type	Comment
	apidef.CircuitBreakerMeta	No comment on field.
CB	*circuit.Breaker	No comment on field.

type ExtendedCircuitBreakerMeta struct {
	apidef.CircuitBreakerMeta
	CB	*circuit.Breaker	`json:"-"`
}

This type doesn't have documentation.

Field name	Field type	Comment
type	any	No comment on field.

type ExtendedOsinClientInterface interface {
	osin.Client
	GetDescription() string
}

This type doesn't have documentation.

Field name	Field type	Comment
type	any	No comment on field.

type ExtendedOsinStorageInterface interface {
	osin.Storage

	// Create OAuth clients
	SetClient(id string, orgID string, client osin.Client, ignorePrefix bool) error

	// Custom getter to handle prefixing issues in Redis
	GetClientNoPrefix(id string) (osin.Client, error)

	GetClientTokens(id string) ([]OAuthClientToken, error)
	GetPaginatedClientTokens(id string, page int) ([]OAuthClientToken, int, error)

	GetExtendedClient(id string) (ExtendedOsinClientInterface, error)

	// Custom getter to handle prefixing issues in Redis
	GetExtendedClientNoPrefix(id string) (ExtendedOsinClientInterface, error)

	GetClients(filter string, orgID string, ignorePrefix bool) ([]ExtendedOsinClientInterface, error)

	DeleteClient(id string, orgID string, ignorePrefix bool) error

	// GetUser retrieves a Basic Access user token type from the key store
	GetUser(string) (*user.SessionState, error)

	// SetUser updates a Basic Access user token type in the key store
	SetUser(string, *user.SessionState, int64) error
}

This type doesn't have documentation.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type ExternalOAuthMiddleware struct {
	*BaseMiddleware
}

FileBundleGetter is a BundleGetter for testing.

Field name	Field type	Comment
URL	string	No comment on field.
InsecureSkipVerify	bool	No comment on field.

type FileBundleGetter struct {
	URL			string
	InsecureSkipVerify	bool
}

GRPCDispatcher implements a coprocess.Dispatcher

Field name	Field type	Comment
	coprocess.Dispatcher	No comment on field.

type GRPCDispatcher struct {
	coprocess.Dispatcher
}

This type doesn't have documentation.

Field name	Field type	Comment
DefaultProxyMux	*proxyMux	No comment on field.
config	atomic.Value	No comment on field.
configMu	sync.Mutex	No comment on field.
ctx	context.Context	No comment on field.
nodeIDMu	sync.Mutex	No comment on field.
nodeID	string	No comment on field.
drlOnce	sync.Once	No comment on field.
DRLManager	*drl.DRL	No comment on field.
reloadMu	sync.Mutex	No comment on field.
Analytics	RedisAnalyticsHandler	No comment on field.
GlobalEventsJSVM	JSVM	No comment on field.
MainNotifier	RedisNotifier	No comment on field.
DefaultOrgStore	DefaultSessionManager	No comment on field.
DefaultQuotaStore	DefaultSessionManager	No comment on field.
GlobalSessionManager	SessionHandler	No comment on field.
MonitoringHandler	config.TykEventHandler	No comment on field.
RPCListener	RPCStorageHandler	No comment on field.
DashService	DashboardServiceSender	No comment on field.
CertificateManager	certs.CertificateManager	No comment on field.
GlobalHostChecker	*HostCheckerManager	No comment on field.
ConnectionWatcher	*httputil.ConnectionWatcher	No comment on field.
HostCheckTicker	chan struct{}	No comment on field.
HostCheckerClient	*http.Client	No comment on field.
TracerProvider	otel.TracerProvider	No comment on field.
NewRelicApplication	*newrelic.Application	No comment on field.
keyGen	DefaultKeyGenerator	No comment on field.
SessionLimiter	SessionLimiter	No comment on field.
SessionMonitor	Monitor	No comment on field.
RPCGlobalCache	cache.Repository	RPCGlobalCache stores keys
RPCCertCache	cache.Repository	RPCCertCache stores certificates
SessionCache	cache.Repository	key session memory cache
ExpiryCache	cache.Repository	org session memory cache
UtilCache	cache.Repository	memory cache to store arbitrary items
ServiceCache	cache.Repository	ServiceCache is the service discovery cache
ServiceNonce	string	Nonce to use when interacting with the dashboard service
ServiceNonceMutex	sync.RWMutex	No comment on field.
apisMu	sync.RWMutex	No comment on field.
apiSpecs	[]*APISpec	No comment on field.
apisByID	map[string]*APISpec	No comment on field.
apisHandlesByID	*sync.Map	No comment on field.
policiesMu	sync.RWMutex	No comment on field.
policiesByID	map[string]user.Policy	No comment on field.
dnsCacheManager	dnscache.IDnsCacheManager	No comment on field.
consulKVStore	kv.Store	No comment on field.
vaultKVStore	kv.Store	No comment on field.
signatureVerifier	atomic.Pointer[goverify.Verifier]	signatureVerifier is used to verify signatures with config.PublicKeyPath.
RedisPurgeOnce	sync.Once	No comment on field.
RpcPurgeOnce	sync.Once	No comment on field.
OnConnect	func()	OnConnect this is a callback which is called whenever we transition redis Disconnected to connected
SessionID	string	SessionID is the unique session id which is used while connecting to dashboard to prevent multiple node allocation.
runningTestsMu	sync.RWMutex	No comment on field.
testMode	bool	No comment on field.
reloadQueue	chan func()	reloadQueue is used by reloadURLStructure to queue a reload. It's not buffered, as reloadQueueLoop should pick these up immediately.
requeueLock	sync.Mutex	No comment on field.
requeue	[]func()	This is a list of callbacks to execute on the next reload. It is protected by requeueLock for concurrent use.
ReloadTestCase	*ReloadMachinery	ReloadTestCase use this when in any test for gateway reloads
TestBundles	map[string]map[string]string	map[bundleName]map[fileName]fileContent used for tests
TestBundleMu	sync.Mutex	No comment on field.
templates	*htmltemplate.Template	No comment on field.
templatesRaw	*texttemplate.Template	No comment on field.
StorageConnectionHandler	*storage.ConnectionHandler	RedisController keeps track of redis connection and singleton
hostDetails	model.HostDetails	No comment on field.
healthCheckInfo	atomic.Value	No comment on field.
dialCtxFn	test.DialContext	No comment on field.

type Gateway struct {
	DefaultProxyMux	*proxyMux
	config		atomic.Value
	configMu	sync.Mutex

	ctx	context.Context

	nodeIDMu	sync.Mutex
	nodeID		string

	drlOnce		sync.Once
	DRLManager	*drl.DRL
	reloadMu	sync.Mutex

	Analytics		RedisAnalyticsHandler
	GlobalEventsJSVM	JSVM
	MainNotifier		RedisNotifier
	DefaultOrgStore		DefaultSessionManager
	DefaultQuotaStore	DefaultSessionManager
	GlobalSessionManager	SessionHandler
	MonitoringHandler	config.TykEventHandler
	RPCListener		RPCStorageHandler
	DashService		DashboardServiceSender
	CertificateManager	certs.CertificateManager
	GlobalHostChecker	*HostCheckerManager
	ConnectionWatcher	*httputil.ConnectionWatcher
	HostCheckTicker		chan struct{}
	HostCheckerClient	*http.Client
	TracerProvider		otel.TracerProvider
	NewRelicApplication	*newrelic.Application

	keyGen	DefaultKeyGenerator

	SessionLimiter	SessionLimiter
	SessionMonitor	Monitor

	// RPCGlobalCache stores keys
	RPCGlobalCache	cache.Repository
	// RPCCertCache stores certificates
	RPCCertCache	cache.Repository
	// key session memory cache
	SessionCache	cache.Repository
	// org session memory cache
	ExpiryCache	cache.Repository
	// memory cache to store arbitrary items
	UtilCache	cache.Repository
	// ServiceCache is the service discovery cache
	ServiceCache	cache.Repository

	// Nonce to use when interacting with the dashboard service
	ServiceNonce		string
	ServiceNonceMutex	sync.RWMutex

	apisMu		sync.RWMutex
	apiSpecs	[]*APISpec
	apisByID	map[string]*APISpec
	apisHandlesByID	*sync.Map

	policiesMu	sync.RWMutex
	policiesByID	map[string]user.Policy

	dnsCacheManager	dnscache.IDnsCacheManager

	consulKVStore	kv.Store
	vaultKVStore	kv.Store

	// signatureVerifier is used to verify signatures with config.PublicKeyPath.
	signatureVerifier	atomic.Pointer[goverify.Verifier]

	RedisPurgeOnce	sync.Once
	RpcPurgeOnce	sync.Once

	// OnConnect this is a callback which is called whenever we transition redis Disconnected to connected
	OnConnect	func()

	// SessionID is the unique session id which is used while connecting to dashboard to prevent multiple node allocation.
	SessionID	string

	runningTestsMu	sync.RWMutex
	testMode	bool

	// reloadQueue is used by reloadURLStructure to queue a reload. It's not
	// buffered, as reloadQueueLoop should pick these up immediately.
	reloadQueue	chan func()

	requeueLock	sync.Mutex

	// This is a list of callbacks to execute on the next reload. It is protected by
	// requeueLock for concurrent use.
	requeue	[]func()

	// ReloadTestCase use this when in any test for gateway reloads
	ReloadTestCase	*ReloadMachinery

	// map[bundleName]map[fileName]fileContent used for tests
	TestBundles	map[string]map[string]string
	TestBundleMu	sync.Mutex

	templates	*htmltemplate.Template
	templatesRaw	*texttemplate.Template

	// RedisController keeps track of redis connection and singleton
	StorageConnectionHandler	*storage.ConnectionHandler
	hostDetails			model.HostDetails

	healthCheckInfo	atomic.Value

	dialCtxFn	test.DialContext
}

This type doesn't have documentation.

Field name	Field type	Comment
FromHostname	string	No comment on field.
FromNodeID	string	No comment on field.
TimeStamp	int64	No comment on field.

type GetConfigPayload struct {
	FromHostname	string
	FromNodeID	string
	TimeStamp	int64
}

This type doesn't have documentation.

Field name	Field type	Comment
Path	string	No comment on field.
FuncName	string	No comment on field.
handler	func(record *analytics.AnalyticsRecord)	No comment on field.
logger	*logrus.Entry	No comment on field.

type GoAnalyticsPlugin struct {
	Path		string	// path to .so file
	FuncName	string	// function symbol to look up
	handler		func(record *analytics.AnalyticsRecord)
	logger		*logrus.Entry
}

GoPluginMiddleware is a generic middleware that will execute Go-plugin code before continuing

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.
Path	string	No comment on field.
SymbolName	string	No comment on field.
handler	http.HandlerFunc	No comment on field.
logger	*logrus.Entry	No comment on field.
successHandler	*SuccessHandler	No comment on field.
Meta	apidef.GoPluginMeta	No comment on field.
APILevel	bool	No comment on field.

type GoPluginMiddleware struct {
	*BaseMiddleware

	Path		string	// path to .so file
	SymbolName	string	// function symbol to look up
	handler		http.HandlerFunc
	logger		*logrus.Entry
	successHandler	*SuccessHandler	// to record analytics
	Meta		apidef.GoPluginMeta
	APILevel	bool
}

This type doesn't have documentation.

Field name	Field type	Comment
type	int	No comment on field.

type GranularAccessFailReason int

GranularAccessMiddleware will check if a URL is specifically enabled for the key

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type GranularAccessMiddleware struct {
	*BaseMiddleware
}

This type doesn't have documentation.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type GraphQLComplexityMiddleware struct {
	*BaseMiddleware
}

This type doesn't have documentation.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type GraphQLGranularAccessMiddleware struct {
	*BaseMiddleware
}

This type doesn't have documentation.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type GraphQLMiddleware struct {
	*BaseMiddleware
}

This type doesn't have documentation.

Field name	Field type	Comment
Query	string	No comment on field.
Variables	json.RawMessage	No comment on field.

type GraphQLRequest struct {
	Query		string		`json:"query"`
	Variables	json.RawMessage	`json:"variables"`
}

This type doesn't have documentation.

Field name	Field type	Comment
logger	*logrus.Entry	No comment on field.

type GraphqlComplexityChecker struct {
	logger *logrus.Entry
}

This type doesn't have documentation.

type GraphqlGranularAccessChecker struct{}

This type doesn't have documentation.

Field name	Field type	Comment
failReason	GranularAccessFailReason	No comment on field.
validationResult	*graphql.RequestFieldsValidationResult	No comment on field.
internalErr	error	No comment on field.

type GraphqlGranularAccessResult struct {
	failReason		GranularAccessFailReason
	validationResult	*graphql.RequestFieldsValidationResult
	internalErr		error
}

This type doesn't have documentation.

Field name	Field type	Comment
KeyID	string	No comment on field.
Algorthm	string	No comment on field.
Headers	[]string	No comment on field.
Signature	string	No comment on field.

type HMACFieldValues struct {
	KeyID		string
	Algorthm	string
	Headers		[]string
	Signature	string
}

HTTPBundleGetter is a simple HTTP BundleGetter.

Field name	Field type	Comment
URL	string	No comment on field.
InsecureSkipVerify	bool	No comment on field.

type HTTPBundleGetter struct {
	URL			string
	InsecureSkipVerify	bool
}

This type doesn't have documentation.

Field name	Field type	Comment
RegistrationEndpoint	string	No comment on field.
DeRegistrationEndpoint	string	No comment on field.
HeartBeatEndpoint	string	No comment on field.
KeyQuotaTriggerEndpoint	string	No comment on field.
Secret	string	No comment on field.
heartBeatStopSentinel	int32	No comment on field.
Gw	*Gateway	No comment on field.

type HTTPDashboardHandler struct {
	RegistrationEndpoint	string
	DeRegistrationEndpoint	string
	HeartBeatEndpoint	string
	KeyQuotaTriggerEndpoint	string

	Secret	string

	heartBeatStopSentinel	int32

	Gw	*Gateway	`json:"-"`
}

HTTPSignatureValidationMiddleware will check if the request has a signature, and if the request is allowed through

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.
lowercasePattern	*regexp.Regexp	No comment on field.

type HTTPSignatureValidationMiddleware struct {
	*BaseMiddleware

	lowercasePattern	*regexp.Regexp
}

This type doesn't have documentation.

Field name	Field type	Comment
	BaseTykResponseHandler	No comment on field.
config	HeaderInjectorOptions	No comment on field.

type HeaderInjector struct {
	BaseTykResponseHandler
	config	HeaderInjectorOptions
}

This type doesn't have documentation.

Field name	Field type	Comment
AddHeaders	map[string]string	No comment on field.
RemoveHeaders	[]string	No comment on field.

type HeaderInjectorOptions struct {
	AddHeaders	map[string]string	`mapstructure:"add_headers" bson:"add_headers" json:"add_headers"`
	RemoveHeaders	[]string		`mapstructure:"remove_headers" bson:"remove_headers" json:"remove_headers"`
}

This type doesn't have documentation.

Field name	Field type	Comment
	BaseTykResponseHandler	No comment on field.
config	HeaderTransformOptions	No comment on field.

type HeaderTransform struct {
	BaseTykResponseHandler
	config	HeaderTransformOptions
}

This type doesn't have documentation.

Field name	Field type	Comment
RevProxyTransform	RevProxyTransform	No comment on field.

type HeaderTransformOptions struct {
	RevProxyTransform RevProxyTransform `mapstructure:"rev_proxy_header_cleanup" bson:"rev_proxy_header_cleanup" json:"rev_proxy_header_cleanup"`
}

This type doesn't have documentation.

Field name	Field type	Comment
ThrottledRequestsPS	float64	No comment on field.
QuotaViolationsPS	float64	No comment on field.
KeyFailuresPS	float64	No comment on field.
AvgUpstreamLatency	float64	No comment on field.
AvgRequestsPS	float64	No comment on field.

type HealthCheckValues struct {
	ThrottledRequestsPS	float64	`bson:"throttle_reqests_per_second,omitempty" json:"throttle_reqests_per_second"`
	QuotaViolationsPS	float64	`bson:"quota_violations_per_second,omitempty" json:"quota_violations_per_second"`
	KeyFailuresPS		float64	`bson:"key_failures_per_second,omitempty" json:"key_failures_per_second"`
	AvgUpstreamLatency	float64	`bson:"average_upstream_latency,omitempty" json:"average_upstream_latency"`
	AvgRequestsPS		float64	`bson:"average_requests_per_second,omitempty" json:"average_requests_per_second"`
}

This type doesn't have documentation.

Field name	Field type	Comment
type	any	No comment on field.

type HealthChecker interface {
	Init(storage.Handler)
	ApiHealthValues() (HealthCheckValues, error)
	StoreCounterVal(HealthPrefix, string)
}

This type doesn't have documentation.

Field name	Field type	Comment
type	string	No comment on field.

type HealthPrefix string

HostCheckCallBacks defines call backs which will be invoked on different states of the health check

Field name	Field type	Comment
Up	func(context.Context, HostHealthReport)	Up is a callback invoked when the host checker identifies a host to be up.
Ping	func(context.Context, HostHealthReport)	Ping when provided this callback will be invoked on every every call to a remote host.
Fail	func(context.Context, HostHealthReport)	Fail is invoked when the host checker decides a host is not healthy.

type HostCheckCallBacks struct {
	// Up is a callback invoked when the host checker identifies a host to be up.
	Up	func(context.Context, HostHealthReport)

	// Ping when provided this callback will be invoked on every every call to a
	// remote host.
	Ping	func(context.Context, HostHealthReport)

	// Fail is invoked when the host checker decides a host is not healthy.
	Fail	func(context.Context, HostHealthReport)
}

This type doesn't have documentation.

Field name	Field type	Comment
Gw	*Gateway	No comment on field.
Id	string	No comment on field.
store	storage.Handler	No comment on field.
checkerMu	sync.Mutex	No comment on field.
checker	*HostUptimeChecker	No comment on field.
stopLoop	bool	No comment on field.
pollerStarted	bool	No comment on field.
unhealthyHostList	*sync.Map	No comment on field.
currentHostList	map[string]HostData	No comment on field.
resetsInitiated	map[string]bool	No comment on field.

type HostCheckerManager struct {
	Gw			*Gateway	`json:"-"`
	Id			string
	store			storage.Handler
	checkerMu		sync.Mutex
	checker			*HostUptimeChecker
	stopLoop		bool
	pollerStarted		bool
	unhealthyHostList	*sync.Map
	currentHostList		map[string]HostData
	resetsInitiated		map[string]bool
}

This type doesn't have documentation.

Field name	Field type	Comment
CheckURL	string	No comment on field.
Protocol	string	No comment on field.
Timeout	time.Duration	No comment on field.
EnableProxyProtocol	bool	No comment on field.
Commands	[]apidef.CheckCommand	No comment on field.
Method	string	No comment on field.
Headers	map[string]string	No comment on field.
Body	string	No comment on field.
MetaData	map[string]string	No comment on field.

type HostData struct {
	CheckURL		string
	Protocol		string
	Timeout			time.Duration
	EnableProxyProtocol	bool
	Commands		[]apidef.CheckCommand
	Method			string
	Headers			map[string]string
	Body			string
	MetaData		map[string]string
}

This type doesn't have documentation.

Field name	Field type	Comment
	HostData	No comment on field.
ResponseCode	int	No comment on field.
Latency	float64	No comment on field.
IsTCPError	bool	No comment on field.

type HostHealthReport struct {
	HostData
	ResponseCode	int
	Latency		float64
	IsTCPError	bool
}

This type doesn't have documentation.

Field name	Field type	Comment
count	int	No comment on field.
reachedLimit	bool	No comment on field.

type HostSample struct {
	count		int
	reachedLimit	bool
}

This type doesn't have documentation.

Field name	Field type	Comment
cb	HostCheckCallBacks	No comment on field.
workerPoolSize	int	No comment on field.
sampleTriggerLimit	int	No comment on field.
checkTimeout	int	No comment on field.
HostList	map[string]HostData	No comment on field.
unHealthyList	map[string]bool	No comment on field.
pool	*tunny.Pool	No comment on field.
errorChan	chan HostHealthReport	No comment on field.
okChan	chan HostHealthReport	No comment on field.
samples	*sync.Map	No comment on field.
stopLoop	bool	No comment on field.
muStopLoop	sync.RWMutex	No comment on field.
resetListMu	sync.Mutex	No comment on field.
doResetList	bool	No comment on field.
newList	map[string]HostData	No comment on field.
Gw	*Gateway	No comment on field.
isClosed	int32	No comment on field.

type HostUptimeChecker struct {
	cb			HostCheckCallBacks
	workerPoolSize		int
	sampleTriggerLimit	int
	checkTimeout		int
	HostList		map[string]HostData
	unHealthyList		map[string]bool
	pool			*tunny.Pool

	errorChan	chan HostHealthReport
	okChan		chan HostHealthReport
	samples		*sync.Map
	stopLoop	bool
	muStopLoop	sync.RWMutex

	resetListMu	sync.Mutex
	doResetList	bool
	newList		map[string]HostData
	Gw		*Gateway	`json:"-"`

	isClosed	int32
}

IPBlackListMiddleware lets you define a list of IPs to block from upstream

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type IPBlackListMiddleware struct {
	*BaseMiddleware
}

IPWhiteListMiddleware lets you define a list of IPs to allow upstream

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type IPWhiteListMiddleware struct {
	*BaseMiddleware
}

IdExtractor is the base interface for an ID extractor.

Field name	Field type	Comment
type	any	No comment on field.

type IdExtractor interface {
	ExtractAndCheck(*http.Request) (string, ReturnOverrides)
	GenerateSessionID(string, *BaseMiddleware) string
}

This type doesn't have documentation.

Field name	Field type	Comment
Type	string	No comment on field.
Message	string	No comment on field.
OrgID	string	No comment on field.
Timestamp	time.Time	No comment on field.

type InterfaceNotification struct {
	Type		string
	Message		string
	OrgID		string
	Timestamp	time.Time
}

This type doesn't have documentation.

Field name	Field type	Comment
Spec	*APISpec	No comment on field.
VM	*otto.Otto	No comment on field.
Timeout	time.Duration	No comment on field.
Log	*logrus.Entry	No comment on field.
RawLog	*logrus.Logger	No comment on field.
Gw	*Gateway	No comment on field.

type JSVM struct {
	Spec	*APISpec
	VM	*otto.Otto	`json:"-"`
	Timeout	time.Duration
	Log	*logrus.Entry	`json:"-"`	// logger used by the JS code
	RawLog	*logrus.Logger	`json:"-"`	// logger used by `rawlog` func to avoid formatting
	Gw	*Gateway	`json:"-"`
}

This type doesn't have documentation.

Field name	Field type	Comment
APIID	string	No comment on field.
OrgID	string	No comment on field.

type JSVMContextGlobal struct {
	APIID	string
	OrgID	string
}

JSVMEventHandler is a scriptable event handler

Field name	Field type	Comment
conf	apidef.JSVMEventHandlerConf	No comment on field.
Spec	*APISpec	No comment on field.
SpecJSON	string	No comment on field.
Gw	*Gateway	No comment on field.

type JSVMEventHandler struct {
	conf		apidef.JSVMEventHandlerConf
	Spec		*APISpec
	SpecJSON	string
	Gw		*Gateway	`json:"-"`
}

This type doesn't have documentation.

Field name	Field type	Comment
Alg	string	No comment on field.
Kty	string	No comment on field.
Use	string	No comment on field.
X5c	[]string	No comment on field.
N	string	No comment on field.
E	string	No comment on field.
KID	string	No comment on field.
X5t	string	No comment on field.

type JWK struct {
	Alg	string		`json:"alg"`
	Kty	string		`json:"kty"`
	Use	string		`json:"use"`
	X5c	[]string	`json:"x5c"`
	N	string		`json:"n"`
	E	string		`json:"e"`
	KID	string		`json:"kid"`
	X5t	string		`json:"x5t"`
}

This type doesn't have documentation.

Field name	Field type	Comment
Keys	[]JWK	No comment on field.

type JWKs struct {
	Keys []JWK `json:"keys"`
}

This type doesn't have documentation.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type JWTMiddleware struct {
	*BaseMiddleware
}

KeyExpired middleware will check if the requesting key is expired or not. It makes use of the authManager to do so.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type KeyExpired struct {
	*BaseMiddleware
}

LDAPStorageHandler implements storage.Handler, this is a read-only implementation to access keys from an LDAP service

Field name	Field type	Comment
LDAPServer	string	No comment on field.
LDAPPort	uint16	No comment on field.
BaseDN	string	No comment on field.
Attributes	[]string	No comment on field.
SessionAttributeName	string	No comment on field.
SearchString	string	No comment on field.
store	*ldap.LDAPConnection	No comment on field.

type LDAPStorageHandler struct {
	LDAPServer		string
	LDAPPort		uint16
	BaseDN			string
	Attributes		[]string
	SessionAttributeName	string
	SearchString		string
	store			*ldap.LDAPConnection
}

LogEventMessage is an interface that provides a method for formatting log events into a string with a given prefix.

Field name	Field type	Comment
type	any	No comment on field.

type LogEventMessage interface {
	LogMessage(prefix string) string
}

LogMessageEventHandler is a sample Event Handler

Field name	Field type	Comment
conf	apidef.LogEventHandlerConf	No comment on field.
logger	*logrus.Logger	No comment on field.
Gw	*Gateway	No comment on field.

type LogMessageEventHandler struct {
	conf	apidef.LogEventHandlerConf
	logger	*logrus.Logger
	Gw	*Gateway	`json:"-"`
}

This type doesn't have documentation.

type MethodNotAllowedHandler struct{}

This type doesn't have documentation.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type MiddlewareContextVars struct {
	*BaseMiddleware
}

MiniRequestObject is marshalled to JSON string and passed into JSON middleware

Field name	Field type	Comment
Headers	map[string][]string	No comment on field.
SetHeaders	map[string]string	No comment on field.
DeleteHeaders	[]string	No comment on field.
Body	[]byte	No comment on field.
URL	string	No comment on field.
Params	map[string][]string	No comment on field.
AddParams	map[string]string	No comment on field.
ExtendedParams	map[string][]string	No comment on field.
DeleteParams	[]string	No comment on field.
ReturnOverrides	ReturnOverrides	No comment on field.
IgnoreBody	bool	No comment on field.
Method	string	No comment on field.
RequestURI	string	No comment on field.
Scheme	string	No comment on field.

type MiniRequestObject struct {
	Headers		map[string][]string
	SetHeaders	map[string]string
	DeleteHeaders	[]string
	Body		[]byte
	URL		string
	Params		map[string][]string
	AddParams	map[string]string
	ExtendedParams	map[string][]string
	DeleteParams	[]string
	ReturnOverrides	ReturnOverrides
	IgnoreBody	bool
	Method		string
	RequestURI	string
	Scheme		string
}

MockErrorReader is a mock io.Reader that returns an error on Read

Field name	Field type	Comment
ReturnError	error	No comment on field.

type MockErrorReader struct {
	ReturnError error
}

This type doesn't have documentation.

Field name	Field type	Comment
Reader	io.Reader	No comment on field.
CloseError	error	No comment on field.
CloseCalled	bool	No comment on field.

type MockReadCloser struct {
	Reader		io.Reader
	CloseError	error
	CloseCalled	bool
}

This type doesn't have documentation.

Field name	Field type	Comment
Gw	*Gateway	No comment on field.

type Monitor struct {
	Gw *Gateway `json:"-"`
}

This type doesn't have documentation.

Field name	Field type	Comment
versionProxies	map[string]*ReverseProxy	No comment on field.
specReference	*APISpec	No comment on field.
defaultProxy	*ReverseProxy	No comment on field.

type MultiTargetProxy struct {
	versionProxies	map[string]*ReverseProxy
	specReference	*APISpec
	defaultProxy	*ReverseProxy
}

NewClientRequest is an outward facing JSON object translated from osin OAuthClients

swagger:model NewClientRequest

Field name	Field type	Comment
ClientID	string	No comment on field.
ClientRedirectURI	string	No comment on field.
APIID	string	No comment on field.
PolicyID	string	No comment on field.
ClientSecret	string	No comment on field.
MetaData	any	No comment on field.
Description	string	No comment on field.

type NewClientRequest struct {
	ClientID		string		`json:"client_id"`
	ClientRedirectURI	string		`json:"redirect_uri"`
	APIID			string		`json:"api_id,omitempty"`
	PolicyID		string		`json:"policy_id,omitempty"`
	ClientSecret		string		`json:"secret"`
	MetaData		interface{}	`json:"meta_data"`
	Description		string		`json:"description"`
}

NewOAuthNotification is a notification sent to a web-hook when an access request or a refresh request comes in.

Field name	Field type	Comment
AuthCode	string	No comment on field.
NewOAuthToken	string	No comment on field.
RefreshToken	string	No comment on field.
OldRefreshToken	string	No comment on field.
NotificationType	OAuthNotificationType	No comment on field.

type NewOAuthNotification struct {
	AuthCode		string			`json:"auth_code"`
	NewOAuthToken		string			`json:"new_oauth_token"`
	RefreshToken		string			`json:"refresh_token"`
	OldRefreshToken		string			`json:"old_refresh_token"`
	NotificationType	OAuthNotificationType	`json:"notification_type"`
}

This type doesn't have documentation.

Field name	Field type	Comment
Status	string	No comment on field.
Message	map[string]string	No comment on field.
Nonce	string	No comment on field.

type NodeResponseOK struct {
	Status	string
	Message	map[string]string
	Nonce	string
}

Notification is a type that encodes a message published to a pub sub channel (shared between implementations)

Field name	Field type	Comment
Command	NotificationCommand	No comment on field.
Payload	string	No comment on field.
Signature	string	No comment on field.
SignatureAlgo	crypto.Hash	No comment on field.
Gw	*Gateway	No comment on field.

type Notification struct {
	Command		NotificationCommand	`json:"command"`
	Payload		string			`json:"payload"`
	Signature	string			`json:"signature"`
	SignatureAlgo	crypto.Hash		`json:"algorithm"`
	Gw		*Gateway		`json:"-"`
}

This type doesn't have documentation.

Field name	Field type	Comment
type	string	No comment on field.

type NotificationCommand string

This type doesn't have documentation.

Field name	Field type	Comment
Status	string	No comment on field.
Message	string	No comment on field.
Schema	json.RawMessage	No comment on field.

type OASSchemaResponse struct {
	Status	string		`json:"status"`
	Message	string		`json:"message"`
	Schema	json.RawMessage	`json:"schema,omitempty"`
}

OAuthClient is a representation within an APISpec of a client

Field name	Field type	Comment
ClientID	string	No comment on field.
ClientSecret	string	No comment on field.
ClientRedirectURI	string	No comment on field.
MetaData	any	No comment on field.
PolicyID	string	No comment on field.
Description	string	No comment on field.

type OAuthClient struct {
	ClientID		string		`json:"id"`
	ClientSecret		string		`json:"secret"`
	ClientRedirectURI	string		`json:"redirecturi"`
	MetaData		interface{}	`json:"meta_data,omitempty"`
	PolicyID		string		`json:"policyid"`
	Description		string		`json:"description"`
}

swagger:model

Field name	Field type	Comment
Token	string	No comment on field.
Expires	int64	No comment on field.

type OAuthClientToken struct {
	Token	string	`json:"code"`
	Expires	int64	`json:"expires"`
}

OAuthHandlers are the HTTP Handlers that manage the Tyk OAuth flow

Field name	Field type	Comment
Manager	OAuthManager	No comment on field.

type OAuthHandlers struct {
	Manager OAuthManager
}

OAuthManager handles and wraps osin OAuth2 functions to handle authorise and access requests

Field name	Field type	Comment
API	*APISpec	No comment on field.
OsinServer	*TykOsinServer	No comment on field.
Gw	*Gateway	No comment on field.

type OAuthManager struct {
	API		*APISpec
	OsinServer	*TykOsinServer
	Gw		*Gateway	`json:"-"`
}

This type doesn't have documentation.

Field name	Field type	Comment
type	any	No comment on field.

type OAuthManagerInterface interface {
	Storage() ExtendedOsinStorageInterface
}

OAuthNotificationType const to reduce risk of collisions

Field name	Field type	Comment
type	string	No comment on field.

type OAuthNotificationType string

Oauth2KeyExists will check if the key being used to access the API is in the request data, and then if the key is in the storage engine

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type Oauth2KeyExists struct {
	*BaseMiddleware
}

This type doesn't have documentation.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.
providerConfiguration	*openid.Configuration	No comment on field.
provider_client_policymap	map[string]map[string]string	No comment on field.
lock	sync.RWMutex	No comment on field.

type OpenIDMW struct {
	*BaseMiddleware

	providerConfiguration		*openid.Configuration
	provider_client_policymap	map[string]map[string]string
	lock				sync.RWMutex
}

This type doesn't have documentation.

Field name	Field type	Comment
	*oas.Operation	No comment on field.
route	*routers.Route	No comment on field.
pathParams	map[string]string	No comment on field.

type Operation struct {
	*oas.Operation
	route		*routers.Route
	pathParams	map[string]string
}

RateLimitAndQuotaCheck will check the incoming request and key whether it is within it's quota and within it's rate limit, it makes use of the SessionLimiter object to do this

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.
sessionlimiter	SessionLimiter	No comment on field.
mon	Monitor	No comment on field.

type OrganizationMonitor struct {
	*BaseMiddleware

	sessionlimiter	SessionLimiter
	mon		Monitor
}

PersistGraphQLOperationMiddleware lets you convert any HTTP request into a GraphQL Operation

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type PersistGraphQLOperationMiddleware struct {
	*BaseMiddleware
}

This type doesn't have documentation.

Field name	Field type	Comment
Policy	string	No comment on field.
ApplyPolicies	[]string	No comment on field.

type PolicyUpdateObj struct {
	Policy		string		`json:"policy"`
	ApplyPolicies	[]string	`json:"apply_policies"`
}

This type doesn't have documentation.

Field name	Field type	Comment
Response	*http.Response	No comment on field.
UpstreamLatency	time.Duration	UpstreamLatency the time it takes to do roundtrip to upstream. Total time taken for the gateway to receive response from upstream host.

type ProxyResponse struct {
	Response	*http.Response
	// UpstreamLatency the time it takes to do roundtrip to upstream. Total time
	// taken for the gateway to receive response from upstream host.
	UpstreamLatency	time.Duration
}

This type doesn't have documentation.

Field name	Field type	Comment
Quota	struct { QuotaMax int64 `json:"quota_max"` QuotaRemaining int64 `json:"quota_remaining"` QuotaRenews int64 `json:"quota_renews"` }	No comment on field.
RateLimit	struct { Rate float64 `json:"requests"` Per float64 `json:"per_unit"` }	No comment on field.

type PublicSession struct {
	Quota	struct {
		QuotaMax	int64	`json:"quota_max"`
		QuotaRemaining	int64	`json:"quota_remaining"`
		QuotaRenews	int64	`json:"quota_renews"`
	}	`json:"quota"`
	RateLimit	struct {
		Rate	float64	`json:"requests"`
		Per	float64	`json:"per_unit"`
	}	`json:"rate_limit"`
}

Purger is an interface that will define how the in-memory store will be purged of analytics data to prevent it growing too large

Field name	Field type	Comment
type	any	No comment on field.

type Purger interface {
	PurgeCache()
	PurgeLoop(<-chan time.Time)
}

This type doesn't have documentation.

Field name	Field type	Comment
type	any	No comment on field.

type RPCDataLoader interface {
	Connect() bool
	GetApiDefinitions(orgId string, tags []string) string
	GetPolicies(orgId string) string
}

RPCStorageHandler is a storage manager that uses the redis database.

Field name	Field type	Comment
KeyPrefix	string	No comment on field.
HashKeys	bool	No comment on field.
SuppressRegister	bool	No comment on field.
DoReload	func()	No comment on field.
Gw	*Gateway	No comment on field.

type RPCStorageHandler struct {
	KeyPrefix		string
	HashKeys		bool
	SuppressRegister	bool
	DoReload		func()
	Gw			*Gateway	`json:"-"`
}

This type doesn't have documentation.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type RateCheckMW struct {
	*BaseMiddleware
}

RateLimitAndQuotaCheck will check the incomming request and key whether it is within it's quota and within it's rate limit, it makes use of the SessionLimiter object to do this

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type RateLimitAndQuotaCheck struct {
	*BaseMiddleware
}

RateLimitAndQuotaCheck will check the incoming request and key whether it is within it's quota and within it's rate limit, it makes use of the SessionLimiter object to do this

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.
keyName	string	No comment on field.
apiSess	*user.SessionState	No comment on field.

type RateLimitForAPI struct {
	*BaseMiddleware

	keyName	string
	apiSess	*user.SessionState
}

RedisAnalyticsHandler will record analytics data to a redis back end as defined in the Config object

Field name	Field type	Comment
Store	storage.AnalyticsHandler	No comment on field.
GeoIPDB	*maxminddb.Reader	No comment on field.
globalConf	config.Config	No comment on field.
recordsChan	chan *analytics.AnalyticsRecord	No comment on field.
workerBufferSize	uint64	No comment on field.
shouldStop	uint32	No comment on field.
poolWg	sync.WaitGroup	No comment on field.
enableMultipleAnalyticsKeys	bool	No comment on field.
Clean	Purger	No comment on field.
Gw	*Gateway	No comment on field.
mu	sync.Mutex	No comment on field.
analyticsSerializer	serializer.AnalyticsSerializer	No comment on field.
mockEnabled	bool	testing purposes
mockRecordHit	func(record *analytics.AnalyticsRecord)	No comment on field.

type RedisAnalyticsHandler struct {
	Store				storage.AnalyticsHandler
	GeoIPDB				*maxminddb.Reader
	globalConf			config.Config
	recordsChan			chan *analytics.AnalyticsRecord
	workerBufferSize		uint64
	shouldStop			uint32
	poolWg				sync.WaitGroup
	enableMultipleAnalyticsKeys	bool
	Clean				Purger
	Gw				*Gateway	`json:"-"`
	mu				sync.Mutex
	analyticsSerializer		serializer.AnalyticsSerializer

	// testing purposes
	mockEnabled	bool
	mockRecordHit	func(record *analytics.AnalyticsRecord)
}

RedisCacheMiddleware is a caching middleware that will pull data from Redis instead of the upstream proxy

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.
store	storage.Handler	No comment on field.
sh	SuccessHandler	No comment on field.

type RedisCacheMiddleware struct {
	*BaseMiddleware

	store	storage.Handler
	sh	SuccessHandler
}

RedisNotifier will use redis pub/sub channels to send notifications

Field name	Field type	Comment
store	*storage.RedisCluster	No comment on field.
channel	string	No comment on field.
	*Gateway	No comment on field.

type RedisNotifier struct {
	store	*storage.RedisCluster
	channel	string
	*Gateway
}

TODO: Refactor this to move prefix handling into a checker method, then it can be an unexported setting in the struct. RedisOsinStorageInterface implements osin.Storage interface to use Tyk's own storage mechanism

Field name	Field type	Comment
store	storage.Handler	No comment on field.
sessionManager	SessionHandler	No comment on field.
redisStore	storage.Handler	No comment on field.
orgID	string	No comment on field.
Gw	*Gateway	No comment on field.

type RedisOsinStorageInterface struct {
	store		storage.Handler
	sessionManager	SessionHandler
	redisStore	storage.Handler
	orgID		string
	Gw		*Gateway	`json:"-"`
}

This type doesn't have documentation.

Field name	Field type	Comment
Store	storage.Handler	No comment on field.
Gw	*Gateway	No comment on field.

type RedisPurger struct {
	Store	storage.Handler
	Gw	*Gateway	`json:"-"`
}

This type doesn't have documentation.

Field name	Field type	Comment
	BaseExtractor	No comment on field.
compiledExpr	*regexp.Regexp	No comment on field.

type RegexExtractor struct {
	BaseExtractor
	compiledExpr	*regexp.Regexp
}

ReloadMachinery is a helper struct to use when writing tests that do manual gateway reloads

Field name	Field type	Comment
run	bool	No comment on field.
count	int	No comment on field.
cycles	int	No comment on field.
mu	sync.RWMutex	No comment on field.
reloadTick	chan time.Time	to simulate time ticks for tests that do reloads
stop	chan struct{}	No comment on field.
started	bool	No comment on field.

type ReloadMachinery struct {
	run	bool
	count	int
	cycles	int
	mu	sync.RWMutex

	// to simulate time ticks for tests that do reloads
	reloadTick	chan time.Time
	stop		chan struct{}
	started		bool
}

RequestDefinition defines a batch request

Field name	Field type	Comment
Method	string	No comment on field.
Headers	map[string]string	No comment on field.
Body	string	No comment on field.
RelativeURL	string	No comment on field.

type RequestDefinition struct {
	Method		string			`json:"method"`
	Headers		map[string]string	`json:"headers"`
	Body		string			`json:"body"`
	RelativeURL	string			`json:"relative_url"`
}

RequestObject is marshalled to JSON string and passed into JSON middleware

Field name	Field type	Comment
Headers	map[string][]string	No comment on field.
Body	string	No comment on field.
URL	string	No comment on field.
Params	map[string][]string	No comment on field.
Scheme	string	No comment on field.

type RequestObject struct {
	Headers	map[string][]string
	Body	string
	URL	string
	Params	map[string][]string
	Scheme	string
}

This type doesn't have documentation.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type RequestSigning struct {
	*BaseMiddleware
}

RequestSizeLimitMiddleware is a middleware that will enforce a limit on the request body size. The request has already been copied to memory when this middleware is called. Therefore, this middleware can't protect the gateway itself from large requests.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type RequestSizeLimitMiddleware struct {
	*BaseMiddleware
}

RequestStatus is a custom type to avoid collisions

Field name	Field type	Comment
type	string	No comment on field.

type RequestStatus string

ResponseCacheMiddleware is a caching middleware that will pull data from Redis instead of the upstream proxy

Field name	Field type	Comment
	BaseTykResponseHandler	No comment on field.
store	storage.Handler	No comment on field.

type ResponseCacheMiddleware struct {
	BaseTykResponseHandler
	store	storage.Handler
}

This type doesn't have documentation.

Field name	Field type	Comment
	BaseTykResponseHandler	No comment on field.
Path	string	No comment on field.
SymbolName	string	No comment on field.
logger	*logrus.Entry	No comment on field.
ResHandler	func(rw http.ResponseWriter, res *http.Response, req *http.Request)	No comment on field.

type ResponseGoPluginMiddleware struct {
	BaseTykResponseHandler
	Path		string	// path to .so file
	SymbolName	string	// function symbol to look up
	logger		*logrus.Entry
	ResHandler	func(rw http.ResponseWriter, res *http.Response, req *http.Request)
}

This type doesn't have documentation.

Field name	Field type	Comment
Body	string	No comment on field.
Headers	map[string]string	No comment on field.
Code	int	No comment on field.

type ResponseObject struct {
	Body	string
	Headers	map[string]string
	Code	int
}

This type doesn't have documentation.

Field name	Field type	Comment
	BaseTykResponseHandler	No comment on field.

type ResponseTransformJQMiddleware struct {
	BaseTykResponseHandler
}

This type doesn't have documentation.

Field name	Field type	Comment
	BaseTykResponseHandler	No comment on field.

type ResponseTransformMiddleware struct {
	BaseTykResponseHandler
}

This type doesn't have documentation.

Field name	Field type	Comment
FromHostname	string	No comment on field.
FromNodeID	string	No comment on field.
Configuration	map[string]any	No comment on field.
TimeStamp	int64	No comment on field.

type ReturnConfigPayload struct {
	FromHostname	string
	FromNodeID	string
	Configuration	map[string]interface{}
	TimeStamp	int64
}

Lets the user override and return a response from middleware

Field name	Field type	Comment
ResponseCode	int	No comment on field.
ResponseError	string	No comment on field.
ResponseBody	string	No comment on field.
ResponseHeaders	map[string]string	No comment on field.
OverrideError	bool	No comment on field.

type ReturnOverrides struct {
	ResponseCode	int
	ResponseError	string
	ResponseBody	string
	ResponseHeaders	map[string]string
	OverrideError	bool
}

This type doesn't have documentation.

Field name	Field type	Comment
type	any	No comment on field.

type ReturningHttpHandler interface {
	ServeHTTP(http.ResponseWriter, *http.Request) ProxyResponse
	ServeHTTPForCache(http.ResponseWriter, *http.Request) ProxyResponse
	CopyResponse(io.Writer, io.Reader, time.Duration)
}

This type doesn't have documentation.

Field name	Field type	Comment
Headers	[]string	No comment on field.
Target_host	string	No comment on field.

type RevProxyTransform struct {
	Headers		[]string	// List of HTTP headers to be modified
	Target_host	string		// Target host for reverse proxy
}

ReverseProxy is an HTTP Handler that takes an incoming request and sends it to another server, proxying the response back to the client.

Field name	Field type	Comment
Director	func(*http.Request)	Director must be a function which modifies the request into a new request to be sent using Transport. Its response is then copied back to the original client unmodified.
Transport	http.RoundTripper	The transport used to perform proxy requests. If nil, http.DefaultTransport is used.
FlushInterval	time.Duration	FlushInterval specifies the flush interval to flush to the client while copying the response body. If zero, no periodic flushing is done.
TLSClientConfig	*tls.Config	TLSClientConfig specifies the TLS configuration to use for 'wss'. If nil, the default configuration is used.
wsUpgrader	websocket.Upgrader	wsUpgrader takes care of upgrading the incoming connection to a websocket connection.
TykAPISpec	*APISpec	No comment on field.
ErrorHandler	ErrorHandler	No comment on field.
logger	*logrus.Entry	No comment on field.
sp	sync.Pool	No comment on field.
Gw	*Gateway	No comment on field.

type ReverseProxy struct {
	// Director must be a function which modifies
	// the request into a new request to be sent
	// using Transport. Its response is then copied
	// back to the original client unmodified.
	Director	func(*http.Request)

	// The transport used to perform proxy requests.
	// If nil, http.DefaultTransport is used.
	Transport	http.RoundTripper

	// FlushInterval specifies the flush interval
	// to flush to the client while copying the
	// response body.
	// If zero, no periodic flushing is done.
	FlushInterval	time.Duration

	// TLSClientConfig specifies the TLS configuration to use for 'wss'.
	// If nil, the default configuration is used.
	TLSClientConfig	*tls.Config

	// wsUpgrader takes care of upgrading the incoming connection
	// to a websocket connection.
	wsUpgrader	websocket.Upgrader

	TykAPISpec	*APISpec
	ErrorHandler	ErrorHandler

	logger	*logrus.Entry
	sp	sync.Pool
	Gw	*Gateway	`json:"-"`
}

This type doesn't have documentation.

Field name	Field type	Comment
pos	uint32	No comment on field.

type RoundRobin struct {
	pos uint32
}

This type doesn't have documentation.

Field name	Field type	Comment
info	map[string]HealthCheckItem	No comment on field.
mux	sync.Mutex	No comment on field.

type SafeHealthCheck struct {
	info	map[string]HealthCheckItem
	mux	sync.Mutex
}

This type doesn't have documentation.

Field name	Field type	Comment
spec	*apidef.ServiceDiscoveryConfiguration	No comment on field.
isNested	bool	No comment on field.
isTargetList	bool	No comment on field.
endpointReturnsList	bool	No comment on field.
portSeperate	bool	No comment on field.
dataPath	string	No comment on field.
parentPath	string	No comment on field.
portPath	string	No comment on field.
targetPath	string	No comment on field.

type ServiceDiscovery struct {
	spec			*apidef.ServiceDiscoveryConfiguration
	isNested		bool
	isTargetList		bool
	endpointReturnsList	bool
	portSeperate		bool
	dataPath		string
	parentPath		string
	portPath		string
	targetPath		string
}

SessionHandler handles all update/create/access session functions and deals exclusively with user.SessionState objects, not identity

Field name	Field type	Comment
type	any	No comment on field.

type SessionHandler interface {
	Init(store storage.Handler)
	Store() storage.Handler
	UpdateSession(keyName string, session *user.SessionState, resetTTLTo int64, hashed bool) error
	RemoveSession(orgID string, keyName string, hashed bool) bool
	SessionDetail(orgID string, keyName string, hashed bool) (user.SessionState, bool)
	KeyExpired(newSession *user.SessionState) bool
	Sessions(filter string) []string
	ResetQuota(string, *user.SessionState, bool)
	Stop()
}

SessionLimiter is the rate limiter for the API, use ForwardMessage() to check if a message should pass through or not

Field name	Field type	Comment
ctx	context.Context	No comment on field.
drlManager	*drl.DRL	No comment on field.
config	*config.Config	No comment on field.
bucketStore	model.BucketStorage	No comment on field.
limiterStorage	redis.UniversalClient	No comment on field.
smoothing	*rate.Smoothing	No comment on field.

type SessionLimiter struct {
	ctx		context.Context
	drlManager	*drl.DRL
	config		*config.Config
	bucketStore	model.BucketStorage
	limiterStorage	redis.UniversalClient
	smoothing	*rate.Smoothing
}

This type doesn't have documentation.

Field name	Field type	Comment
SlaveOptions	config.SlaveOptionsConfig	No comment on field.
Redis	config.StorageOptionsConf	No comment on field.

type SlaveDataCenter struct {
	SlaveOptions	config.SlaveOptionsConfig
	Redis		config.StorageOptionsConf
}

This type doesn't have documentation.

Field name	Field type	Comment
options	StatsDSinkOptions	No comment on field.
cmdChan	chan statsdEmitCmd	No comment on field.
drainDoneChan	chan struct{}	No comment on field.
stopDoneChan	chan struct{}	No comment on field.
flushPeriod	time.Duration	No comment on field.
udpBuf	bytes.Buffer	No comment on field.
timingBuf	[]byte	No comment on field.
udpConn	*net.UDPConn	No comment on field.
udpAddr	*net.UDPAddr	No comment on field.
prefixBuffers	map[eventKey]prefixBuffer	map of {job,event,suffix} to a re-usable buffer prefixed with the key. Since each timing/gauge has a unique component (the time), we'll truncate to the prefix, write the timing, and write the statsD suffix (eg, "|ms\n"). Then copy that to the UDP buffer.

type StatsDSink struct {
	options	StatsDSinkOptions

	cmdChan		chan statsdEmitCmd
	drainDoneChan	chan struct{}
	stopDoneChan	chan struct{}

	flushPeriod	time.Duration

	udpBuf		bytes.Buffer
	timingBuf	[]byte

	udpConn	*net.UDPConn
	udpAddr	*net.UDPAddr

	// map of {job,event,suffix} to a re-usable buffer prefixed with the key.
	// Since each timing/gauge has a unique component (the time), we'll truncate to the prefix, write the timing,
	// and write the statsD suffix (eg, "|ms\n"). Then copy that to the UDP buffer.
	prefixBuffers	map[eventKey]prefixBuffer
}

This type doesn't have documentation.

Field name	Field type	Comment
Prefix	string	Prefix is something like "metroid" Events emitted to StatsD would be metroid.myevent.wat Eg, don't include a trailing dot in the prefix. It can be "", that's fine.
SanitizationFunc	StatsDSinkSanitizationFunc	SanitizationFunc sanitizes jobs and events before sending them to statsd
SkipNestedEvents	bool	SkipNestedEvents will skip {events,timers,gauges} from sending the job.event version and will only send the event version.
SkipTopLevelEvents	bool	SkipTopLevelEvents will skip {events,timers,gauges} from sending the event version and will only send the job.event version.

type StatsDSinkOptions struct {
	// Prefix is something like "metroid"
	// Events emitted to StatsD would be metroid.myevent.wat
	// Eg, don't include a trailing dot in the prefix.
	// It can be "", that's fine.
	Prefix	string

	// SanitizationFunc sanitizes jobs and events before sending them to statsd
	SanitizationFunc	StatsDSinkSanitizationFunc

	// SkipNestedEvents will skip {events,timers,gauges} from sending the job.event version
	// and will only send the event version.
	SkipNestedEvents	bool

	// SkipTopLevelEvents will skip {events,timers,gauges} from sending the event version
	// and will only send the job.event version.
	SkipTopLevelEvents	bool
}

This type doesn't have documentation.

Field name	Field type	Comment
type	func(*bytes.Buffer, string)	No comment on field.

type StatsDSinkSanitizationFunc func(*bytes.Buffer, string)

This type doesn't have documentation.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type StripAuth struct {
	*BaseMiddleware
}

SuccessHandler represents the final ServeHTTP() request for a proxied API request

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type SuccessHandler struct {
	*BaseMiddleware
}

TemplateExecutor is an interface used to switch between text/templates and html/template. It only switch to text/template (templatesRaw) when contentType is XML related

Field name	Field type	Comment
type	any	No comment on field.

type TemplateExecutor interface {
	Execute(wr io.Writer, data interface{}) error
}

This type doesn't have documentation.

Field name	Field type	Comment
URL	string	No comment on field.
testRunner	*test.HTTPTestRunner	No comment on field.
GlobalConfig	config.Config	GlobalConfig deprecate this and instead use GW.getConfig()
config	TestConfig	No comment on field.
Gw	*Gateway	No comment on field.
HttpHandler	*http.Server	No comment on field.
TestServerRouter	*mux.Router	No comment on field.
MockHandle	*test.DnsMockHandle	No comment on field.
ctx	context.Context	No comment on field.
cancel	context.CancelFunc	No comment on field.
dynamicHandlers	map[string]http.HandlerFunc	No comment on field.

type Test struct {
	URL		string
	testRunner	*test.HTTPTestRunner
	// GlobalConfig deprecate this and instead use GW.getConfig()
	GlobalConfig		config.Config
	config			TestConfig
	Gw			*Gateway	`json:"-"`
	HttpHandler		*http.Server
	TestServerRouter	*mux.Router
	MockHandle		*test.DnsMockHandle

	ctx	context.Context
	cancel	context.CancelFunc

	dynamicHandlers	map[string]http.HandlerFunc
}

This type doesn't have documentation.

Field name	Field type	Comment
SeparateControlAPI	bool	No comment on field.
Delay	time.Duration	No comment on field.
HotReload	bool	No comment on field.
overrideDefaults	bool	No comment on field.
CoprocessConfig	config.CoProcessConfig	No comment on field.
EnableTestDNSMock	bool	No comment on field.

type TestConfig struct {
	SeparateControlAPI	bool
	Delay			time.Duration
	HotReload		bool
	overrideDefaults	bool
	CoprocessConfig		config.CoProcessConfig
	EnableTestDNSMock	bool
}

This type doesn't have documentation.

Field name	Field type	Comment
Method	string	No comment on field.
URI	string	No comment on field.
Path	string	No comment on field.
Url	string	No comment on field.
Body	string	No comment on field.
Headers	map[string]string	No comment on field.
Form	map[string]string	No comment on field.

type TestHttpResponse struct {
	Method	string
	URI	string
	Path	string
	Url	string
	Body	string
	Headers	map[string]string
	Form	map[string]string
}

This type doesn't have documentation.

Field name	Field type	Comment
	TykMiddleware	No comment on field.

type TraceMiddleware struct {
	TykMiddleware
}

TrackEndpointMiddleware sets context variables to enable or disable whether Tyk should record analytitcs for a specific path.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type TrackEndpointMiddleware struct {
	*BaseMiddleware
}

TransformMiddleware is a middleware that will apply a template to a request body to transform it's contents ready for an upstream API

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type TransformHeaders struct {
	*BaseMiddleware
}

This type doesn't have documentation.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type TransformJQMiddleware struct {
	*BaseMiddleware
}

This type doesn't have documentation.

Field name	Field type	Comment
	apidef.TransformJQMeta	No comment on field.

type TransformJQSpec struct {
	apidef.TransformJQMeta
}

TransformMiddleware is a middleware that will apply a template to a request body to transform it's contents ready for an upstream API

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type TransformMethod struct {
	*BaseMiddleware
}

TransformMiddleware is a middleware that will apply a template to a request body to transform it's contents ready for an upstream API

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type TransformMiddleware struct {
	*BaseMiddleware
}

This type doesn't have documentation.

Field name	Field type	Comment
	apidef.TemplateMeta	No comment on field.
Template	*texttemplate.Template	No comment on field.

type TransformSpec struct {
	apidef.TemplateMeta
	Template	*texttemplate.Template
}

This type doesn't have documentation.

Field name	Field type	Comment
type	any	No comment on field.

type TykGoPluginResponseHandler interface {
	TykResponseHandler
	HandleGoPluginResponse(http.ResponseWriter, *http.Response, *http.Request) error
}

This type doesn't have documentation.

Field name	Field type	Comment
Method	string	No comment on field.
Body	string	No comment on field.
Headers	map[string]string	No comment on field.
Domain	string	No comment on field.
Resource	string	No comment on field.
FormData	map[string]string	No comment on field.

type TykJSHttpRequest struct {
	Method		string
	Body		string
	Headers		map[string]string
	Domain		string
	Resource	string
	FormData	map[string]string
}

This type doesn't have documentation.

Field name	Field type	Comment
Code	int	No comment on field.
Body	string	No comment on field.
Headers	map[string][]string	No comment on field.
CodeComp	int	Make this compatible with BatchReplyUnit
BodyComp	string	No comment on field.
HeadersComp	map[string][]string	No comment on field.

type TykJSHttpResponse struct {
	Code	int
	Body	string
	Headers	map[string][]string

	// Make this compatible with BatchReplyUnit
	CodeComp	int			`json:"code"`
	BodyComp	string			`json:"body"`
	HeadersComp	map[string][]string	`json:"headers"`
}

This type doesn't have documentation.

Field name	Field type	Comment
type	any	No comment on field.

type TykMiddleware interface {
	Base() *BaseMiddleware
	GetSpec() *APISpec

	Init()
	Logger() *logrus.Entry
	Config() (interface{}, error)
	ProcessRequest(w http.ResponseWriter, r *http.Request, conf interface{}) (error, int)	// Handles request
	EnabledForSpec() bool
	Name() string

	Unload()
}

TykOsinServer subclasses osin.Server so we can add the SetClient method without wrecking the lbrary

Field name	Field type	Comment
	osin.Server	No comment on field.
Config	*osin.ServerConfig	No comment on field.
Storage	ExtendedOsinStorageInterface	No comment on field.
AuthorizeTokenGen	osin.AuthorizeTokenGen	No comment on field.
AccessTokenGen	osin.AccessTokenGen	No comment on field.

type TykOsinServer struct {
	osin.Server
	Config			*osin.ServerConfig
	Storage			ExtendedOsinStorageInterface
	AuthorizeTokenGen	osin.AuthorizeTokenGen
	AccessTokenGen		osin.AccessTokenGen
}

This type doesn't have documentation.

Field name	Field type	Comment
type	any	No comment on field.

type TykResponseHandler interface {
	Enabled() bool
	Init(interface{}, *APISpec) error
	Name() string
	HandleResponse(http.ResponseWriter, *http.Response, *http.Request, *user.SessionState) error
	HandleError(http.ResponseWriter, *http.Request)
	Base() *BaseTykResponseHandler
}

This type doesn't have documentation.

Field name	Field type	Comment
transport	*http.Transport	No comment on field.
h2ctransport	*http2.Transport	No comment on field.
logger	*logrus.Entry	No comment on field.
Gw	*Gateway	No comment on field.

type TykRoundTripper struct {
	transport	*http.Transport
	h2ctransport	*http2.Transport
	logger		*logrus.Entry
	Gw		*Gateway	`json:"-"`
}

URLRewriteMiddleware Will rewrite an inbund URL to a matching outbound one, it can also handle dynamic variable substitution

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type URLRewriteMiddleware struct {
	*BaseMiddleware
}

URLSpec represents a flattened specification for URLs, used to check if a proxy URL path is on any of the white, black or ignored lists. This is generated as part of the configuration init

Field name	Field type	Comment
spec	*regexp.Regexp	No comment on field.
Status	URLStatus	No comment on field.
MethodActions	map[string]apidef.EndpointMethodMeta	No comment on field.
Whitelist	apidef.EndPointMeta	No comment on field.
Blacklist	apidef.EndPointMeta	No comment on field.
Ignored	apidef.EndPointMeta	No comment on field.
MockResponse	apidef.MockResponseMeta	No comment on field.
CacheConfig	EndPointCacheMeta	No comment on field.
TransformAction	TransformSpec	No comment on field.
TransformResponseAction	TransformSpec	No comment on field.
TransformJQAction	TransformJQSpec	No comment on field.
TransformJQResponseAction	TransformJQSpec	No comment on field.
InjectHeaders	apidef.HeaderInjectionMeta	No comment on field.
InjectHeadersResponse	apidef.HeaderInjectionMeta	No comment on field.
HardTimeout	apidef.HardTimeoutMeta	No comment on field.
CircuitBreaker	ExtendedCircuitBreakerMeta	No comment on field.
URLRewrite	*apidef.URLRewriteMeta	No comment on field.
VirtualPathSpec	apidef.VirtualMeta	No comment on field.
RequestSize	apidef.RequestSizeMeta	No comment on field.
MethodTransform	apidef.MethodTransformMeta	No comment on field.
TrackEndpoint	apidef.TrackEndpointMeta	No comment on field.
DoNotTrackEndpoint	apidef.TrackEndpointMeta	No comment on field.
ValidatePathMeta	apidef.ValidatePathMeta	No comment on field.
Internal	apidef.InternalMeta	No comment on field.
GoPluginMeta	GoPluginMiddleware	No comment on field.
PersistGraphQL	apidef.PersistGraphQLMeta	No comment on field.
RateLimit	apidef.RateLimitMeta	No comment on field.
IgnoreCase	bool	No comment on field.

type URLSpec struct {
	spec	*regexp.Regexp

	Status				URLStatus
	MethodActions			map[string]apidef.EndpointMethodMeta
	Whitelist			apidef.EndPointMeta
	Blacklist			apidef.EndPointMeta
	Ignored				apidef.EndPointMeta
	MockResponse			apidef.MockResponseMeta
	CacheConfig			EndPointCacheMeta
	TransformAction			TransformSpec
	TransformResponseAction		TransformSpec
	TransformJQAction		TransformJQSpec
	TransformJQResponseAction	TransformJQSpec
	InjectHeaders			apidef.HeaderInjectionMeta
	InjectHeadersResponse		apidef.HeaderInjectionMeta
	HardTimeout			apidef.HardTimeoutMeta
	CircuitBreaker			ExtendedCircuitBreakerMeta
	URLRewrite			*apidef.URLRewriteMeta
	VirtualPathSpec			apidef.VirtualMeta
	RequestSize			apidef.RequestSizeMeta
	MethodTransform			apidef.MethodTransformMeta
	TrackEndpoint			apidef.TrackEndpointMeta
	DoNotTrackEndpoint		apidef.TrackEndpointMeta
	ValidatePathMeta		apidef.ValidatePathMeta
	Internal			apidef.InternalMeta
	GoPluginMeta			GoPluginMiddleware
	PersistGraphQL			apidef.PersistGraphQLMeta
	RateLimit			apidef.RateLimitMeta

	IgnoreCase	bool
}

URLStatus is a custom enum type to avoid collisions

Field name	Field type	Comment
type	int	No comment on field.

type URLStatus int

This type doesn't have documentation.

Field name	Field type	Comment
URL	string	No comment on field.
RequestTime	int64	No comment on field.
ResponseCode	int	No comment on field.
TCPError	bool	No comment on field.
ServerError	bool	No comment on field.
Day	int	No comment on field.
Month	time.Month	No comment on field.
Year	int	No comment on field.
Hour	int	No comment on field.
Minute	int	No comment on field.
TimeStamp	time.Time	No comment on field.
ExpireAt	time.Time	No comment on field.
APIID	string	No comment on field.
OrgID	string	No comment on field.

type UptimeReportData struct {
	URL		string
	RequestTime	int64
	ResponseCode	int
	TCPError	bool
	ServerError	bool
	Day		int
	Month		time.Month
	Year		int
	Hour		int
	Minute		int
	TimeStamp	time.Time
	ExpireAt	time.Time	`bson:"expireAt" json:"expireAt"`
	APIID		string
	OrgID		string
}

This type doesn't have documentation.

Field name	Field type	Comment
Response	ResponseObject	No comment on field.
SessionMeta	map[string]any	No comment on field.

type VMResponseObject struct {
	Response	ResponseObject
	SessionMeta	map[string]interface{}
}

This type doesn't have documentation.

Field name	Field type	Comment
Request	MiniRequestObject	No comment on field.
SessionMeta	map[string]string	No comment on field.
Session	user.SessionState	No comment on field.
AuthValue	string	No comment on field.

type VMReturnObject struct {
	Request		MiniRequestObject
	SessionMeta	map[string]string
	Session		user.SessionState
	AuthValue	string
}

This type doesn't have documentation.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type ValidateJSON struct {
	*BaseMiddleware
}

This type doesn't have documentation.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type ValidateRequest struct {
	*BaseMiddleware
}

This type doesn't have documentation.

Field name	Field type	Comment
	BaseExtractor	No comment on field.

type ValueExtractor struct {
	BaseExtractor
}

VersionCheck will check whether the version of the requested API the request is accessing has any restrictions on URL endpoints

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.
sh	SuccessHandler	No comment on field.

type VersionCheck struct {
	*BaseMiddleware

	sh	SuccessHandler
}

This type doesn't have documentation.

Field name	Field type	Comment
ID	string	No comment on field.
Name	string	No comment on field.
VersionName	string	No comment on field.
Internal	bool	No comment on field.
ExpirationDate	string	No comment on field.
IsDefaultVersion	bool	No comment on field.

type VersionMeta struct {
	ID			string	`json:"id"`
	Name			string	`json:"name"`
	VersionName		string	`json:"versionName"`
	Internal		bool	`json:"internal"`
	ExpirationDate		string	`json:"expirationDate"`
	IsDefaultVersion	bool	`json:"isDefaultVersion"`
}

This type doesn't have documentation.

Field name	Field type	Comment
Status	string	No comment on field.
Metas	[]VersionMeta	No comment on field.

type VersionMetas struct {
	Status	string		`json:"status"`
	Metas	[]VersionMeta	`json:"apis"`
}

This type doesn't have documentation.

Field name	Field type	Comment
getApiDef	func(string) (*apidef.APIDefinition, error)	No comment on field.

type VersionsHandler struct {
	getApiDef func(string) (*apidef.APIDefinition, error)
}

DynamicMiddleware is a generic middleware that will execute JS code before continuing

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.
sh	SuccessHandler	No comment on field.

type VirtualEndpoint struct {
	*BaseMiddleware

	sh	SuccessHandler
}

WebHookHandler is an event handler that triggers web hooks

Field name	Field type	Comment
conf	apidef.WebHookHandlerConf	No comment on field.
template	*htmltemplate.Template	No comment on field.
store	storage.Handler	No comment on field.
contentType	string	No comment on field.
dashboardService	DashboardServiceSender	No comment on field.
Gw	*Gateway	No comment on field.

type WebHookHandler struct {
	conf		apidef.WebHookHandlerConf
	template	*htmltemplate.Template	// non-nil if Init is run without error
	store		storage.Handler

	contentType		string
	dashboardService	DashboardServiceSender
	Gw			*Gateway
}

This type doesn't have documentation.

Field name	Field type	Comment
type	string	No comment on field.

type WebHookRequestMethod string

This type doesn't have documentation.

Field name	Field type	Comment
	BaseExtractor	No comment on field.
path	*xmlpath.Path	No comment on field.

type XPathExtractor struct {
	BaseExtractor
	path	*xmlpath.Path
}

ZipBundleSaver is a BundleSaver for ZIP files.

type ZipBundleSaver struct{}

This type doesn't have documentation.

Field name	Field type	Comment
type	model.HealthCheckItem	No comment on field.
type	model.HealthCheckStatus	No comment on field.
type	model.HealthCheckResponse	No comment on field.

type (
	HealthCheckItem		= model.HealthCheckItem
	HealthCheckStatus	= model.HealthCheckStatus
	HealthCheckResponse	= model.HealthCheckResponse
)

accessTokenGen is a modified authorization token generator that uses the same method used to generate tokens for Tyk authHandler

Field name	Field type	Comment
Gw	*Gateway	No comment on field.

type accessTokenGen struct {
	Gw *Gateway `json:"-"`
}

apiAllKeys represents a list of keys in the memory store swagger:model

Field name	Field type	Comment
APIKeys	[]string	No comment on field.

type apiAllKeys struct {
	APIKeys []string `json:"keys"`
}

apiModifyKeySuccess represents when a Key modification was successful

swagger:model apiModifyKeySuccess

Field name	Field type	Comment
Key	string	in:body
Status	string	No comment on field.
Action	string	No comment on field.
KeyHash	string	No comment on field.

type apiModifyKeySuccess struct {
	// in:body
	Key	string	`json:"key"`
	Status	string	`json:"status"`
	Action	string	`json:"action"`
	KeyHash	string	`json:"key_hash,omitempty"`
}

apiStatusMessage represents an API status message

swagger:model apiStatusMessage

Field name	Field type	Comment
Status	string	No comment on field.
Message	string	Response details

type apiStatusMessage struct {
	Status	string	`json:"status"`
	// Response details
	Message	string	`json:"message"`
}

cacheOptions exists to transfer options from this middleware down the chain to the cache writer

Field name	Field type	Comment
key	string	No comment on field.
cacheOnlyResponseCodes	[]int	No comment on field.
timeout	int64	No comment on field.

type cacheOptions struct {
	key			string
	cacheOnlyResponseCodes	[]int
	timeout			int64
}

customResponseWriter is a wrapper around standard http.ResponseWriter plus it tracks if response was sent and what status code was sent

Field name	Field type	Comment
	http.ResponseWriter	No comment on field.
responseSent	bool	No comment on field.
statusCodeSent	int	No comment on field.
copyData	bool	No comment on field.
data	[]byte	No comment on field.
dataLength	int64	No comment on field.

type customResponseWriter struct {
	http.ResponseWriter
	responseSent	bool
	statusCodeSent	int
	copyData	bool
	data		[]byte
	dataLength	int64
}

This type doesn't have documentation.

Field name	Field type	Comment
DashboardConfig	struct { Hostname string Port int UseTLS bool }	No comment on field.
TimeStamp	int64	No comment on field.

type dashboardConfigPayload struct {
	DashboardConfig	struct {
		Hostname	string
		Port		int
		UseTLS		bool
	}
	TimeStamp	int64
}

This type doesn't have documentation.

Field name	Field type	Comment
type	func(network string, address string) (net.Conn, error)	No comment on field.

type dialFn func(network string, address string) (net.Conn, error)

This type doesn't have documentation.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type dummyStreamingMiddleware struct {
	*BaseMiddleware
}

This type doesn't have documentation.

Field name	Field type	Comment
job	string	No comment on field.
event	string	No comment on field.
suffix	string	No comment on field.

type eventKey struct {
	job	string
	event	string
	suffix	string
}

This type doesn't have documentation.

Field name	Field type	Comment
prefix	string	No comment on field.
handler	http.Handler	No comment on field.

type explicitRouteHandler struct {
	prefix	string
	handler	http.Handler
}

This type doesn't have documentation.

Field name	Field type	Comment
redisStore	storage.Handler	No comment on field.

type generalStores struct {
	redisStore, redisOrgStore, healthStore, rpcAuthStore, rpcOrgStore storage.Handler
}

h2cWrapper tracks handleWrapper for swapping w.router on reloads.

Field name	Field type	Comment
w	*handleWrapper	No comment on field.
h	http.Handler	No comment on field.

type h2cWrapper struct {
	w	*handleWrapper
	h	http.Handler
}

handleWrapper's only purpose is to allow router to be dynamically replaced

Field name	Field type	Comment
router	http.Handler	No comment on field.
maxContentLength	int64	No comment on field.
maxRequestBodySize	int64	No comment on field.

type handleWrapper struct {
	router	http.Handler	// *mux.Router

	maxContentLength	int64
	maxRequestBodySize	int64
}

Taken from https://medium.com/@mlowicki/http-s-proxy-in-golang-in-less-than-100-lines-of-code-6a51c2f2c38c

Field name	Field type	Comment
proto	string	No comment on field.
URL	string	No comment on field.
server	*http.Server	No comment on field.
listener	net.Listener	No comment on field.

type httpProxyHandler struct {
	proto		string
	URL		string
	server		*http.Server
	listener	net.Listener
}

This type doesn't have documentation.

Field name	Field type	Comment
	*storage.RedisCluster	No comment on field.

type introspectionCache struct {
	*storage.RedisCluster
}

This type doesn't have documentation.

Field name	Field type	Comment
dst	writeFlusher	No comment on field.
latency	time.Duration	No comment on field.
mu	sync.Mutex	No comment on field.
t	*time.Timer	No comment on field.
flushPending	bool	No comment on field.

type maxLatencyWriter struct {
	dst	writeFlusher
	latency	time.Duration	// non-zero; negative means to flush immediately

	mu		sync.Mutex	// protects t, flushPending, and dst.Flush
	t		*time.Timer
	flushPending	bool
}

This type doesn't have documentation.

Field name	Field type	Comment
listener	net.Listener	No comment on field.
provider	*memconn.Provider	No comment on field.
expireAt	time.Time	No comment on field.

type memConnProvider struct {
	listener	net.Listener
	provider	*memconn.Provider
	expireAt	time.Time
}

This type doesn't have documentation.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type noopUpstreamBasicAuth struct {
	*BaseMiddleware
}

This type doesn't have documentation.

Field name	Field type	Comment
	*BaseMiddleware	No comment on field.

type noopUpstreamOAuth struct {
	*BaseMiddleware
}

nopCloser is just like ioutil's, but here to let us re-read the same buffer inside by moving position to the start every time we done with reading

Field name	Field type	Comment
	io.ReadSeeker	No comment on field.

type nopCloser struct {
	io.ReadSeeker
}

nopCloserBuffer is like nopCloser above but uses pointer receiver for seeking within an internal bytes.Buffer reference.

Field name	Field type	Comment
reader	io.ReadCloser	No comment on field.
once	sync.Once	No comment on field.
buf	bytes.Buffer	No comment on field.
position	int64	No comment on field.

type nopCloserBuffer struct {
	reader		io.ReadCloser
	once		sync.Once
	buf		bytes.Buffer
	position	int64
}

This type doesn't have documentation.

Field name	Field type	Comment
	sync.Mutex	No comment on field.
channels	map[string](chan bool)	No comment on field.

type orgChanMapMu struct {
	sync.Mutex
	channels	map[string](chan bool)
}

This type doesn't have documentation.

Field name	Field type	Comment
Pagination	paginationStatus	No comment on field.
Tokens	[]OAuthClientToken	No comment on field.

type paginatedOAuthClientTokens struct {
	Pagination	paginationStatus
	Tokens		[]OAuthClientToken
}

paginationStatus provides more information about a paginated data set

Field name	Field type	Comment
PageNum	int	No comment on field.
PageTotal	int	No comment on field.
PageSize	int	No comment on field.

type paginationStatus struct {
	PageNum		int	`json:"page_num"`
	PageTotal	int	`json:"page_total"`
	PageSize	int	`json:"page_size"`
}

This type doesn't have documentation.

Field name	Field type	Comment
m	*GraphQLMiddleware	No comment on field.

type postReceiveHttpHook struct {
	m *GraphQLMiddleware
}

This type doesn't have documentation.

Field name	Field type	Comment
m	*GraphQLMiddleware	No comment on field.

type preSendHttpHook struct {
	m *GraphQLMiddleware
}

This type doesn't have documentation.

Field name	Field type	Comment
	*bytes.Buffer	No comment on field.
prefixLen	int	No comment on field.

type prefixBuffer struct {
	*bytes.Buffer
	prefixLen	int
}

This type doesn't have documentation.

Field name	Field type	Comment
listener	net.Listener	No comment on field.
port	int	No comment on field.
protocol	string	No comment on field.
useProxyProtocol	bool	No comment on field.
router	*mux.Router	No comment on field.
httpServer	*http.Server	No comment on field.
tcpProxy	*tcp.Proxy	No comment on field.
started	bool	No comment on field.

type proxy struct {
	listener		net.Listener
	port			int
	protocol		string
	useProxyProtocol	bool
	router			*mux.Router
	httpServer		*http.Server
	tcpProxy		*tcp.Proxy
	started			bool
}

This type doesn't have documentation.

Field name	Field type	Comment
	sync.RWMutex	No comment on field.
proxies	[]*proxy	No comment on field.
again	again.Again	No comment on field.
track404Logs	bool	No comment on field.

type proxyMux struct {
	sync.RWMutex
	proxies		[]*proxy
	again		again.Again
	track404Logs	bool
}

This type doesn't have documentation.

Field name	Field type	Comment
notifier	RedisNotifier	No comment on field.
formatter	logrus.Formatter	No comment on field.

type redisChannelHook struct {
	notifier	RedisNotifier
	formatter	logrus.Formatter
}

This type doesn't have documentation.

Field name	Field type	Comment
type	uint	No comment on field.

type sessionFailReason uint

This type doesn't have documentation.

Field name	Field type	Comment
type	int	No comment on field.

type statsdCmdKind int

This type doesn't have documentation.

Field name	Field type	Comment
Kind	statsdCmdKind	No comment on field.
Job	string	No comment on field.
Event	string	No comment on field.
Nanos	int64	No comment on field.
Value	float64	No comment on field.
Status	health.CompletionStatus	No comment on field.

type statsdEmitCmd struct {
	Kind	statsdCmdKind
	Job	string
	Event	string
	Nanos	int64
	Value	float64
	Status	health.CompletionStatus
}

parameterBodies swagger:response parameterBodies

Field name	Field type	Comment
APIStatusMessage	apiStatusMessage	in: body
APIModifyKeySuccess	apiModifyKeySuccess	in: body
NewClientRequest	NewClientRequest	in: body
APIDefinition	apidef.APIDefinition	in: body
SessionState	user.SessionState	in: body
APIAllKeys	apiAllKeys	in:body
OAuthClientToken	OAuthClientToken	in: body

type swaggerParameterBodies struct {
	// in: body
	APIStatusMessage	apiStatusMessage
	// in: body
	APIModifyKeySuccess	apiModifyKeySuccess
	// in: body
	NewClientRequest	NewClientRequest
	// in: body
	APIDefinition	apidef.APIDefinition
	// in: body
	SessionState	user.SessionState
	// in:body
	APIAllKeys	apiAllKeys
	// in: body
	OAuthClientToken	OAuthClientToken
}

switchProtocolCopier exists so goroutines proxying data back and forth have nice names in stacks.

Field name	Field type	Comment
user	io.ReadWriter	No comment on field.

type switchProtocolCopier struct {
	user, backend io.ReadWriter
}

This type doesn't have documentation.

Field name	Field type	Comment
Msg	string	No comment on field.

type testMessageAdapter struct {
	Msg string
}