The highest tagged major version is
Documentation
¶
Overview ¶
Package webutil provides functions for making developing a website easier.
Index ¶
- func AdminAPIListenAndServe(ctx context.Context, healthy ...func() error)
- func AuthTemplateFunctions(r *http.Request) template.FuncMap
- func DevAuthMiddleware(roles ...string) func(http.Handler) http.Handler
- func ListenAndServeWithContext(ctx context.Context, addr string, handler http.Handler) error
- func NewAuthMiddleware(ctx context.Context, config AuthConfig) (func(http.Handler) http.Handler, error)
- func SessionFromContext(ctx context.Context) (*sessions.Session, error)
- func SessionFromRequest(r *http.Request) (*sessions.Session, error)
- func SessionMiddleware(secret SessionSecret, opts ...SessionMiddlewareOption) func(http.Handler) http.Handler
- func SessionSecretSourceRedis(ctx context.Context, client RedisSessioner, prefix string) ([]byte, error)
- func SessionSecretSourceVolatile() []byte
- type AuthConfig
- type AuthInfo
- type AuthSecrets
- type RedisSessioner
- type Response
- type ResponseHandlerFunc
- type SessionMiddlewareOption
- type SessionSecret
- type TemplateFuncMap
- type View
- func (v *View) Error(status int, err error) http.HandlerFunc
- func (v *View) Errorf(status int, text string, a ...interface{}) http.HandlerFunc
- func (v *View) HTML(status int, filename string, data any) http.HandlerFunc
- func (v *View) JSON(status int, data any) http.HandlerFunc
- func (v *View) Redirect(status int, location string, args ...interface{}) http.HandlerFunc
- type ViewHandler
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AdminAPIListenAndServe ¶
func AuthTemplateFunctions ¶
AuthTemplateFunctions returns auth related template functions. These can then directly be used in the templates without having to add the auth info manually to the template data.
Function `func AuthIsAuthenticated() bool` returns true, if the user is logged in.
Function `func AuthInfo() *AuthInfo` returns the AuthInfo, if the user is logged and `nil` otherwise.
Example:
{{ if AuthIsAuthenticated }}
<span class="navbar-text">Hello, <em>{{ AuthInfo.Name }}</em>!</span>
{{ else }}
<a class="nav-link" href="/auth/login">Login</span></a>
{{ end }}
func DevAuthMiddleware ¶
DevAuthMiddleware is a dummy auth middleware that does not any actual authentication. It is supposed to be used for local development. The roles parameter defines which roles can be selected in the dummy login form.
func ListenAndServeWithContext ¶
ListenAndServeWithContext does the same as http.ListenAndServe with the difference that is properly utilises the context. This means it does a graceful shutdown when the context is done and a context cancellation gets propagated down to the actual request context.
func NewAuthMiddleware ¶
func SessionFromContext ¶
SessionFromContext extracts the Session store from the given context. The session store is injected into the request via the SessionMiddleware. Therefore it is required to use this middleware to be able to get the store.
func SessionFromRequest ¶
SessionFromRequest returns the results of SessionFromContext for the context of the given request.
func SessionMiddleware ¶
func SessionMiddleware(secret SessionSecret, opts ...SessionMiddlewareOption) func(http.Handler) http.Handler
SessionMiddleware inizializes the session store and injects it into the context of the requests.
func SessionSecretSourceRedis ¶
func SessionSecretSourceRedis(ctx context.Context, client RedisSessioner, prefix string) ([]byte, error)
SessionSecretSourceRedis stores the session secrets in Redis. If the key does not exist yet, it will create a new one.
func SessionSecretSourceVolatile ¶
func SessionSecretSourceVolatile() []byte
SessionSecretSourceVolatile creates a session secret that is stored in memory only. This implies, that all session data is lost after an application restart and an application cannot have more than one replicas.
Types ¶
type AuthConfig ¶
type AuthConfig struct {
Secrets AuthSecrets
ConfigURL string
BaseURL string
SigningAlgs []string
}
func (*AuthConfig) Bind ¶
func (c *AuthConfig) Bind(cmd *cobra.Command)
type AuthInfo ¶
type AuthInfo struct {
Username string `json:"preferred_username"`
Name string `json:"name"`
RealmAccess struct {
Roles []string `json:"roles"`
} `json:"realm_access"`
}
func AuthInfoFromContext ¶
AuthInfoFromContext extracts the AuthInfo from the given context. The AuthInfo is injected into the request via the AuthMiddleware. Therefore it is required to use this middleware to be able to get the AuthInfo.
func AuthInfoFromRequest ¶
AuthInfoFromRequest extracts the AuthInfo from the context within the given request. The AuthInfo is injected into the request via the AuthMiddleware. Therefore it is required to use this middleware to be able to get the AuthInfo.
type AuthSecrets ¶
type RedisSessioner ¶
type Response ¶
type Response = http.HandlerFunc
type SessionMiddlewareOption ¶
type SessionMiddlewareOption func(c *sessionMiddlewareConfig)
func SessionMiddlewareCookieDomain ¶
func SessionMiddlewareCookieDomain(domain string) SessionMiddlewareOption
func SessionMiddlewareCookieUnsecure ¶
func SessionMiddlewareCookieUnsecure() SessionMiddlewareOption
type SessionSecret ¶
type SessionSecret []byte
type TemplateFuncMap ¶
func SimpleTemplateFuncMap ¶
func SimpleTemplateFuncMap(name string, fn interface{}) TemplateFuncMap
func SimpleTemplateFuncMaps ¶
func SimpleTemplateFuncMaps(fm template.FuncMap) TemplateFuncMap
type View ¶
type View struct {
// contains filtered or unexported fields
}
type ViewHandler ¶
type ViewHandler struct {
FS fs.FS
FuncMaps []TemplateFuncMap
}
func NewViewHandler ¶
func NewViewHandler(fs fs.FS, fms ...TemplateFuncMap) *ViewHandler
func (*ViewHandler) Wrap ¶
func (h *ViewHandler) Wrap(fn ResponseHandlerFunc) http.HandlerFunc
Source Files