config

Documentation

Index

• type Config

Types

type Config

type Config struct {
	// Env is the environment of the authorizer instance
	Env string
	// SkipTestEndpointSSRFValidation relaxes SSRF checks for the admin TestEndpoint GraphQL
	// mutation (e.g. to hit localhost in tests). Must remain false in production; integration
	// tests enable it together with Env=test.
	SkipTestEndpointSSRFValidation bool
	// OrganizationLogo is the logo of the organization
	OrganizationLogo string
	// OrganizationName is the name of the organization
	OrganizationName string
	// AdminSecret is the secret for the admin
	AdminSecret string
	// AllowedOrigins is the list of allowed origins
	AllowedOrigins []string

	// EnableLoginPage is the flag to enable login page
	EnableLoginPage bool
	// EnablePlayground is the flag to enable playground
	EnablePlayground bool
	// EnableGraphQLIntrospection is the flag to enable GraphQL introspection
	EnableGraphQLIntrospection bool
	// EnableHSTS opts in to the Strict-Transport-Security response header.
	// Off by default because operators not behind TLS would lock themselves
	// out for a year. Enable in production behind TLS.
	EnableHSTS bool
	// DisableCSP turns off the default Content-Security-Policy header.
	// Off by default — CSP is on by default. Provided as an escape hatch
	// for dashboards that load assets in ways the default policy blocks.
	DisableCSP bool
	// GraphQLMaxComplexity caps the total complexity score of a single GraphQL
	// operation. Operations exceeding this limit are rejected before execution.
	GraphQLMaxComplexity int
	// GraphQLMaxDepth caps the maximum nesting depth of a GraphQL selection set.
	GraphQLMaxDepth int
	// GraphQLMaxAliases caps the total number of aliased fields per operation.
	// Defends against alias-amplification denial-of-service attacks.
	GraphQLMaxAliases int
	// GraphQLMaxBodyBytes caps the size of the request body accepted by the
	// GraphQL endpoint to prevent oversized-payload denial of service.
	GraphQLMaxBodyBytes int64

	// Database Configurations
	// DatabaseType is the type of database to use
	DatabaseType string
	// DatabaseURL is the URL of the database
	DatabaseURL string
	// DatabaseName is the name of the database
	DatabaseName string
	// DatabaseUsername is the username for the database
	DatabaseUsername string
	// DatabasePassword is the password for the database
	DatabasePassword string
	// DatabaseHost is the host for the database
	DatabaseHost string
	// DatabasePort is the port for the database
	DatabasePort int
	// DatabaseCert is the certificate for the database
	DatabaseCert string
	// DatabaseCACert is the CA certificate for the database
	DatabaseCACert string
	// DatabaseCertKey is the certificate key for the database
	DatabaseCertKey string

	// CouchBase flags
	// CouchBaseBucket is the bucket for the database
	// Used only for CouchBase database
	CouchBaseBucket string
	// CouchBaseRamQuota is the RAM quota for the database
	// Used only for CouchBase database
	CouchBaseRamQuota string
	// CouchBaseScope is the scope for the database
	// Used only for CouchBase database
	CouchBaseScope string
	// CouchBaseWaitTimeout is the timeout in seconds for Couchbase WaitUntilReady operations
	// Used only for CouchBase database
	CouchBaseWaitTimeout int

	// AWS flags
	// AWSRegion is the region for the database
	// Used only for AWS database
	AWSRegion string
	// AWSAccessKeyID is the access key ID for the database
	// Used only for AWS database
	AWSAccessKeyID string
	// AWSSecretAccessKey is the secret access key for the database
	// Used only for AWS database
	AWSSecretAccessKey string

	// Email Configurations
	// SMTPHost is the host for the SMTP server
	SMTPHost string
	// SMTPPort is the port for the SMTP server
	SMTPPort int
	// SMTPUsername is the username for the SMTP server
	SMTPUsername string
	// SMTPPassword is the password for the SMTP server
	SMTPPassword string
	// SMTPSenderEmail is the sender email for the SMTP server
	SMTPSenderEmail string
	// SMTPSenderName is the sender name for the SMTP server
	SMTPSenderName string
	// SMTPLocalName is the local name for the SMTP server
	SMTPLocalName string
	// SkipTLSVerification is the flag to skip TLS verification
	SMTPSkipTLSVerification bool

	// Memory Store Configurations
	// RedisURL is the URL of the redis server
	RedisURL string

	// Auth Configurations
	// DefaultRoles is the default roles for the user
	// It is a comma separated string
	// TODO: check derived keys
	DefaultRoles []string
	// Roles is the list of all the roles of the user
	// It is a comma separated string
	Roles []string
	// ProtectedRoles is the list of all the protected roles
	// For this roles, sign-up is disabled
	// It is a comma separated string
	ProtectedRoles []string
	// EnableStrongPassword is the flag to enable strong password
	EnableStrongPassword bool
	// EnableTOTPLogin boolean to enable TOTP login
	EnableTOTPLogin bool
	// EnableBasicAuthentication boolean to enable basic authentication
	EnableBasicAuthentication bool
	// EnableMagicLinkLogin boolean to enable magic link login
	EnableMagicLinkLogin bool
	// EnableEmailVerification boolean to enable email verification
	EnableEmailVerification bool
	// EnableMobileBasicAuthentication boolean to enable mobile basic authentication
	EnableMobileBasicAuthentication bool
	// EnablePhoneVerification boolean to enable phone verification
	EnablePhoneVerification bool
	// EnableMFA boolean to enable MFA
	EnableMFA bool
	// EnableEmailOTP boolean to enable email OTP
	EnableEmailOTP bool
	// EnableSMSOTP boolean to enable SMS OTP
	EnableSMSOTP bool
	// EnableSignup boolean to enable signup
	EnableSignup bool
	// IsEmailServiceEnabled is derived from SMTP configurations
	IsEmailServiceEnabled bool
	// IsSMSServiceEnabled is derived from Twilio configurations
	IsSMSServiceEnabled bool
	// EnforceMFA is the flag to enforce MFA
	EnforceMFA bool

	// URLs
	// ResetPasswordURL is the URL for reset password
	ResetPasswordURL string

	// JWT Configurations
	// JWTType is the type of JWT to use
	JWTType string
	// JWTSecret is the secret for the JWT
	JWTSecret string
	// JWTPublicKey is the public key for the JWT
	JWTPublicKey string
	// JWTPrivateKey is the private key for the JWT
	JWTPrivateKey string
	// JWTSecondaryType is the algorithm of an optional secondary JWT
	// key used for manual key rotation. When set along with the other
	// JWT secondary fields, the JWKS endpoint will publish both keys
	// and token validation will accept tokens signed with either key.
	// New tokens are always signed with the primary key (JWTType).
	// Leave empty to disable multi-key mode (default).
	JWTSecondaryType string
	// JWTSecondarySecret is the secret for the secondary JWT key.
	// Used only when JWTSecondaryType is an HMAC algorithm. HMAC keys
	// are never exposed via the JWKS endpoint.
	JWTSecondarySecret string
	// JWTSecondaryPublicKey is the public key for the secondary JWT
	// key. Used when JWTSecondaryType is RSA or ECDSA.
	JWTSecondaryPublicKey string
	// JWTSecondaryPrivateKey is the private key for the secondary JWT
	// key. Currently unused at the signing stage (the primary key is
	// always used to sign); kept for symmetry and for future
	// primary/secondary swap automation.
	JWTSecondaryPrivateKey string
	// JWTRoleClaim is the role claim for the JWT
	JWTRoleClaim string
	// RefreshTokenExpiresIn is the refresh token lifetime in seconds.
	// Defaults to 30 days (2592000 seconds) when zero or unset.
	RefreshTokenExpiresIn int64
	// CustomAccessTokenScript is the custom access token script
	CustomAccessTokenScript string

	// OAuth Configurations
	// ClientID is the client ID for the authorizer
	ClientID string
	// ClientSecret is the secret for the authorizer
	ClientSecret string
	// Default Authorize response mode
	DefaultAuthorizeResponseMode string
	// Default Authorize response type
	DefaultAuthorizeResponseType string

	// Twilio Configurations
	// TwilioAPISecret is the API secret for Twilio
	TwilioAPISecret string
	// TwilioAPIKey is the API key for Twilio
	TwilioAPIKey string
	// TwilioSender is the sender for Twilio
	TwilioSender string
	// TwilioAccountSID is the account SID for Twilio
	TwilioAccountSID string

	// OAuth providers that authorizer supports
	// GoogleClientID is the client ID for Google OAuth
	GoogleClientID string
	// GoogleClientSecret is the client secret for Google OAuth
	GoogleClientSecret string
	// Scopes is the list of scopes for Google OAuth
	GoogleScopes []string

	// GithubClientID is the client ID for Github OAuth
	GithubClientID string
	// GithubClientSecret is the client secret for Github OAuth
	GithubClientSecret string
	// GithubScopes is the list of scopes for Github OAuth
	GithubScopes []string

	// FacebookClientID is the client ID for Facebook OAuth
	FacebookClientID string
	// FacebookClientSecret is the client secret for Facebook OAuth
	FacebookClientSecret string
	// FacebookScopes is the list of scopes for Facebook OAuth
	FacebookScopes []string

	// LinkedinClientID is the client ID for Linkedin OAuth
	LinkedinClientID string
	// LinkedinClientSecret is the client secret for Linkedin OAuth
	LinkedinClientSecret string
	// LinkedinScopes is the list of scopes for Linkedin OAuth
	LinkedinScopes []string

	// TwitterClientID is the client ID for Twitter OAuth
	TwitterClientID string
	// TwitterClientSecret is the client secret for Twitter OAuth
	TwitterClientSecret string
	// TwitterScopes is the list of scopes for Twitter OAuth
	TwitterScopes []string

	// MicrosoftClientID is the client ID for Microsoft OAuth
	MicrosoftClientID string
	// MicrosoftClientSecret is the client secret for Microsoft OAuth
	MicrosoftClientSecret string
	// MicrosoftTenantID is the tenant ID for Microsoft OAuth
	MicrosoftTenantID string
	// MicrosoftScopes is the list of scopes for Microsoft OAuth
	MicrosoftScopes []string

	// AppleClientID is the client ID for Apple OAuth
	AppleClientID string
	// AppleClientSecret is the client secret for Apple OAuth
	AppleClientSecret string
	// AppleScopes is the list of scopes for Apple OAuth
	AppleScopes []string

	// DiscordClientID is the client ID for Discord OAuth
	DiscordClientID string
	// DiscordClientSecret is the client secret for Discord OAuth
	DiscordClientSecret string
	// DiscordScopes is the list of scopes for Discord OAuth
	DiscordScopes []string

	// TwitchClientID is the client ID for Twitch OAuth
	TwitchClientID string
	// TwitchClientSecret is the client secret for Twitch OAuth
	TwitchClientSecret string
	// TwitchScopes is the list of scopes for Twitch OAuth
	TwitchScopes []string

	// RobloxClientID is the client ID for Roblox OAuth
	RobloxClientID string
	// RobloxClientSecret is the client secret for Roblox OAuth
	RobloxClientSecret string
	// RobloxScopes is the list of scopes for Roblox OAuth
	RobloxScopes []string

	// IsAppCookieSecure is the flag to set secure(http only) cookie
	AppCookieSecure bool
	// AppCookieSameSite controls the SameSite attribute for session cookies.
	// Valid values: "none" (default), "lax", "strict".
	// "none" preserves backward compatibility for cross-domain SDK setups
	// (requires AppCookieSecure=true). Use "lax" or "strict" for same-origin deployments.
	AppCookieSameSite string
	// IsAdminCookieSecure is the flag to set secure(http only) cookie
	AdminCookieSecure bool
	// DisableAdminHeaderAuth is the flag to disable admin authentication via header
	DisableAdminHeaderAuth bool
	// Rate Limiting
	// RateLimitRPS is the maximum requests per second per IP
	RateLimitRPS int
	// RateLimitBurst is the maximum burst size per IP
	RateLimitBurst int
	// RateLimitFailClosed rejects requests when the rate limit backend errors (default: fail-open).
	RateLimitFailClosed bool
	// TrustedProxies is the list of CIDRs allowed to set X-Forwarded-For
	// and similar proxy headers. Empty (the default) means no proxies are
	// trusted and gin will use RemoteAddr directly. Operators behind a
	// reverse proxy MUST set this explicitly or rate limiting and audit
	// logs will key on the proxy IP, not the real client IP.
	TrustedProxies []string

	// BackchannelLogoutURI is the URL to which the server POSTs a
	// signed logout_token when a user logs out successfully. When
	// empty (default), back-channel logout notifications are disabled.
	// See OIDC Back-Channel Logout 1.0 §2.5 for the protocol.
	BackchannelLogoutURI string
}

Config defines the configuration for the authorizer instance