corteza/app/options/auth.cue

package options

import (
	"github.com/cortezaproject/corteza-server/codegen/schema"
)

auth: schema.#optionsGroup & {
	handle: "auth"

	imports: [
		"\"time\"",
	]

	options: {
		log_enabled: {
			type:        "bool"
			description: "Enable extra logging for authentication flows"
		}
		password_security: {
			type:          "bool"
			defaultGoExpr: "true"
			description: """
				Password security allows you to disable constraints to which passwords must conform to.

				[CAUTION]
				====
				Disabling password security can be useful for development environments as it removes the need for complex passwords.
				Password security *should be enabled* on production environments to avoid security incidents
				====
				"""
		}
		secret: {
			defaultGoExpr: "getSecretFromEnv(\"jwt secret\")"
			description: """
				Secret used for signing JWT tokens.

				[IMPORTANT]
				====
				If secret is not set, system auto-generates one from DB_DSN and HOSTNAME environment variables.
				Generated secret will change if you change any of these variables.
				====
				"""
			env: "AUTH_JWT_SECRET"
		}
		access_token_lifetime: {
			type:        "time.Duration"
			description: "Access token lifetime"
			env:         "AUTH_OAUTH2_ACCESS_TOKEN_LIFETIME"

			defaultGoExpr: "time.Hour * 2"
			defaultValue:  "2h"
		}
		refresh_token_lifetime: {
			type:        "time.Duration"
			description: "Refresh token lifetime"
			env:         "AUTH_OAUTH2_REFRESH_TOKEN_LIFETIME"

			defaultGoExpr: "time.Hour * 24 * 3"
			defaultValue:  "72h"
		}
		expiry: {
			type:        "time.Duration"
			description: "Expiration time for the auth JWT tokens."
			env:         "AUTH_JWT_EXPIRY"

			defaultGoExpr: "time.Hour * 24 * 30"
			defaultValue:  "720h"
		}
		external_redirect_URL: {
			description: """
				Redirect URL to be sent with OAuth2 authentication request to provider

				`provider` placeholder is replaced with the actual value when used.
				"""
			defaultGoExpr: "fullURL(\"/auth/external/{provider}/callback\")"
		}
		external_cookie_secret: {
			description: """
				Secret used for securing cookies

				[IMPORTANT]
				====
				If secret is not set, system auto-generates one from DB_DSN and HOSTNAME environment variables.
				Generated secret will change if you change any of these variables.
				====
				"""

			defaultGoExpr: "getSecretFromEnv(\"external cookie secret\")"
		}
		base_URL: {
			description: """
				Frontend base URL. Must be an absolute URL, with the domain.
				This is used for some redirects and links in auth emails.
				"""

			defaultGoExpr: "fullURL(\"/auth\")"
		}
		session_cookie_name: {
			description:  "Session cookie name"
			defaultValue: "session"
		}
		session_cookie_path: {
			description:   "Session cookie path"
			defaultGoExpr: "pathPrefix(\"/auth\")"
		}
		session_cookie_domain: {
			defaultGoExpr: "guessHostname()"
			description:   "Session cookie domain"
		}
		session_cookie_secure: {
			type:          "bool"
			defaultGoExpr: "isSecure()"
			description:   "Defaults to true when HTTPS is used. Corteza will try to guess the this setting by"
		}
		session_lifetime: {
			type:          "time.Duration"
			description:   "How long do we keep the temporary session"
			defaultGoExpr: "24 * time.Hour"
			defaultValue:  "24h"
		}
		session_perm_lifetime: {
			type:          "time.Duration"
			description:   "How long do we keep the permanent session"
			defaultGoExpr: "360 * 24 * time.Hour"
			defaultValue:  "8640h"
		}
		garbage_collector_interval: {
			type:          "time.Duration"
			description:   "How often are expired sessions and tokens purged from the database"
			defaultGoExpr: "15 * time.Minute"
			defaultValue:  "15min"
		}
		request_rate_limit: {
			type: "int"
			description: """
				How many requests from a cerain IP address are allowed in a time window.
				Set to zero to disable
				"""
			defaultGoExpr: "60"
			defaultValue:  "60"
		}
		request_rate_window_length: {
			type:          "time.Duration"
			defaultGoExpr: "time.Minute"
			defaultValue:  "1m"
			description:   "How many requests from a cerain IP address are allowed in a time window"
		}
		csrf_secret: {
			defaultGoExpr: "getSecretFromEnv(\"csrf secret\")"
			description: """
				Secret used for securing CSRF protection

				[IMPORTANT]
				====
				If secret is not set, system auto-generates one from DB_DSN and HOSTNAME environment variables.
				Generated secret will change if you change any of these variables.
				====
				"""
		}
		csrf_enabled: {
			type:          "bool"
			defaultGoExpr: "true"
			description:   "Enable CSRF protection"
		}
		csrf_field_name: {
			defaultValue: "same-site-authenticity-token"
			description:  "Form field name used for CSRF protection"
		}
		csrf_cookie_name: {
			defaultValue: "same-site-authenticity-token"
			description:  "Cookie name used for CSRF protection"
		}
		default_client: {
			defaultValue: "corteza-webapp"
			description: """
				Handle for OAuth2 client used for automatic redirect from /auth/oauth2/go endpoint.

				This simplifies configuration for OAuth2 flow for Corteza Web applications as it removes
				the need to suply redirection URL and client ID (oauth2/go endpoint does that internally)

				"""
		}
		assets_path: {
			description: """
				Path to js, css, images and template source files

				When corteza starts, if path exists it tries to load template files from it.

				When empty path is set (default value), embedded files are used.
				"""
		}
		development_mode: {
			type: "bool"
			description: """
				When enabled, corteza reloads template before every execution.
				Enable this for debugging or when developing auth templates.

				Should be disabled in production where templates do not change between server restarts.
				"""
		}
	}
	title: "Authentication"
}