server

Documentation

Index

• func CreateDefaultServer(config *schema.Configuration, providers middlewares.Providers) (server *fasthttp.Server, listener net.Listener, paths []string, isTLS bool, ...)
• func CreateMetricsServer(config *schema.Configuration, providers middlewares.Providers) (server *fasthttp.Server, listener net.Listener, paths []string, tls bool, ...)
• func ETagRootURL(next middlewares.RequestHandler) middlewares.RequestHandler
• func ServeTemplatedFile(t templates.Template, opts *TemplatedFileOptions) middlewares.RequestHandler
• func ServeTemplatedOpenAPI(t templates.Template, opts *TemplatedFileOptions) middlewares.RequestHandler
• type TemplatedFileCommonData
• type TemplatedFileOpenAPIData
• type TemplatedFileOptions
  • func NewTemplatedFileOptions(config *schema.Configuration) (opts *TemplatedFileOptions)
  • func (options *TemplatedFileOptions) CommonData(base, baseURL, domain, nonce, logoOverride, rememberMe string) TemplatedFileCommonData
  • func (options *TemplatedFileOptions) OpenAPIData(base, baseURL, domain, nonce string) TemplatedFileOpenAPIData

Functions

func CreateDefaultServer

func CreateDefaultServer(config *schema.Configuration, providers middlewares.Providers) (server *fasthttp.Server, listener net.Listener, paths []string, isTLS bool, err error)

CreateDefaultServer Create Authelia's internal web server with the given configuration and providers.

func CreateMetricsServer

func CreateMetricsServer(config *schema.Configuration, providers middlewares.Providers) (server *fasthttp.Server, listener net.Listener, paths []string, tls bool, err error)

CreateMetricsServer creates a metrics server.

func ETagRootURL

func ETagRootURL(next middlewares.RequestHandler) middlewares.RequestHandler

ETagRootURL dynamically matches the If-None-Match header and adds the ETag header.

func ServeTemplatedFile

func ServeTemplatedFile(t templates.Template, opts *TemplatedFileOptions) middlewares.RequestHandler

ServeTemplatedFile serves a templated version of a specified file, this is utilised to pass information between the backend and frontend and generate a nonce to support a restrictive CSP while using material-ui.

func ServeTemplatedOpenAPI

func ServeTemplatedOpenAPI(t templates.Template, opts *TemplatedFileOptions) middlewares.RequestHandler

ServeTemplatedOpenAPI serves templated OpenAPI related files.

Types

type TemplatedFileCommonData

type TemplatedFileCommonData struct {
	Base                   string
	BaseURL                string
	Domain                 string
	CSPNonce               string
	LogoOverride           string
	DuoSelfEnrollment      string
	RememberMe             string
	ResetPassword          string
	ResetPasswordCustomURL string
	PrivacyPolicyURL       string
	PrivacyPolicyAccept    string
	Session                string
	Theme                  string
}

TemplatedFileCommonData is a struct which is used for many templated files.

type TemplatedFileOpenAPIData

type TemplatedFileOpenAPIData struct {
	Base          string
	BaseURL       string
	Domain        string
	CSPNonce      string
	Session       string
	PasswordReset bool
	WebAuthn      bool
	TOTP          bool
	Duo           bool
	OpenIDConnect bool

	EndpointsAuthz map[string]schema.ServerEndpointsAuthz
}

TemplatedFileOpenAPIData is a struct which is used for the OpenAPI spec file.

type TemplatedFileOptions

type TemplatedFileOptions struct {
	AssetPath              string
	DuoSelfEnrollment      string
	RememberMe             string
	ResetPassword          string
	ResetPasswordCustomURL string
	PrivacyPolicyURL       string
	PrivacyPolicyAccept    string
	Session                string
	Theme                  string

	EndpointsPasswordReset bool
	EndpointsWebAuthn      bool
	EndpointsTOTP          bool
	EndpointsDuo           bool
	EndpointsOpenIDConnect bool

	EndpointsAuthz map[string]schema.ServerEndpointsAuthz
}

TemplatedFileOptions is a struct which is used for many templated files.

func NewTemplatedFileOptions

func NewTemplatedFileOptions(config *schema.Configuration) (opts *TemplatedFileOptions)

NewTemplatedFileOptions returns a new *TemplatedFileOptions.

func (*TemplatedFileOptions) CommonData

func (options *TemplatedFileOptions) CommonData(base, baseURL, domain, nonce, logoOverride, rememberMe string) TemplatedFileCommonData

CommonData returns a TemplatedFileCommonData with the dynamic options.

func (*TemplatedFileOptions) OpenAPIData

func (options *TemplatedFileOptions) OpenAPIData(base, baseURL, domain, nonce string) TemplatedFileOpenAPIData

OpenAPIData returns a TemplatedFileOpenAPIData with the dynamic options.