Documentation
¶
Index ¶
- Constants
- Variables
- func AccessControl(allowOrigin string) gin.HandlerFunc
- func AccountRequired() gin.HandlerFunc
- func AcquireOrganization(moduleName string) gin.HandlerFunc
- func AcquireUser(moduleName string) gin.HandlerFunc
- func AddHost() gin.HandlerFunc
- func AppEngine() gin.HandlerFunc
- func BasicAuth() gin.HandlerFunc
- func CheckLogin() gin.HandlerFunc
- func DetectOverrides() gin.HandlerFunc
- func DetectTest(query *url.Values) bool
- func DetectVerbose(query *url.Values) bool
- func ErrorHTML(c *gin.Context, stack string, err error)
- func ErrorHTMLDev(c *gin.Context, stack string, err error)
- func ErrorHandler() gin.HandlerFunc
- func ErrorHandlerJSON() gin.HandlerFunc
- func ErrorJSON(c *gin.Context, stack string, err error)
- func ErrorJSONDev(c *gin.Context, stack string, err error)
- func ErrorLogger() gin.HandlerFunc
- func ErrorLoggerT(typ gin.ErrorType) gin.HandlerFunc
- func GetAccessToken(c *gin.Context) string
- func GetAppEngine(c *gin.Context) context.Context
- func GetCurrentUser(c *gin.Context) *user.User
- func GetNamespace(c *gin.Context) context.Context
- func GetOrganization(c *gin.Context) *organization.Organization
- func GetPermissions(c *gin.Context) bit.Field
- func GetToken(c *gin.Context) *accesstoken.AccessToken
- func GetUser(c *gin.Context) *user.User
- func IsValidMethodOverride(method string) bool
- func LiveReload() gin.HandlerFunc
- func Log(c *gin.Context)
- func Logger() gin.HandlerFunc
- func LoginRequired(moduleName string) gin.HandlerFunc
- func LogoutRequired(moduleName string) gin.HandlerFunc
- func MethodOverride() gin.HandlerFunc
- func Namespace() gin.HandlerFunc
- func NotFoundHandler() gin.HandlerFunc
- func OverrideRequestMethod(c *gin.Context, method string) error
- func ParseToken(c *gin.Context)
- func Static(urlRoot string) gin.HandlerFunc
- func TokenPermits(masks ...bit.Mask) gin.HandlerFunc
- func TokenRequired(masks ...bit.Mask) gin.HandlerFunc
- func UnavailableHandler() gin.HandlerFunc
- type ErrorDisplayer
Constants ¶
View Source
const HeaderMethodOverride = "X-HTTP-Method-Override"
HeaderMethodOverride is a commonly used Http header to override the method.
View Source
const ParamMethodOverride = "_method"
ParamMethodOverride is a commonly used HTML form parameter to override the method.
Variables ¶
View Source
var ErrInvalidOverrideMethod = errors.New("invalid override method")
ErrInvalidOverrideMethod is returned when an invalid http method was given to OverrideRequestMethod.
View Source
var HttpMethods = []string{"PUT", "PATCH", "DELETE"}
Functions ¶
func AccessControl ¶
func AccessControl(allowOrigin string) gin.HandlerFunc
func AccountRequired ¶
func AccountRequired() gin.HandlerFunc
func AcquireOrganization ¶
func AcquireOrganization(moduleName string) gin.HandlerFunc
func AcquireUser ¶
func AcquireUser(moduleName string) gin.HandlerFunc
func AddHost ¶
func AddHost() gin.HandlerFunc
Automatically get the Host header so we can decide what to do with a given request.
func AppEngine ¶
func AppEngine() gin.HandlerFunc
Automatically get request context (standard Go context from http.Request).
func BasicAuth ¶
func BasicAuth() gin.HandlerFunc
func CheckLogin ¶
func CheckLogin() gin.HandlerFunc
Updates session with login information, does not require it
func DetectOverrides ¶
func DetectOverrides() gin.HandlerFunc
Check query for special config override params and update session.
func DetectTest ¶
func DetectVerbose ¶
Try and detect verbose flag set on request, we only log DEBUG level in production if verbose=1 is added as a query param.
func ErrorHandlerJSON ¶
func ErrorHandlerJSON() gin.HandlerFunc
func ErrorLogger ¶
func ErrorLogger() gin.HandlerFunc
func ErrorLoggerT ¶
func ErrorLoggerT(typ gin.ErrorType) gin.HandlerFunc
func GetAccessToken ¶
func GetOrganization ¶
func GetOrganization(c *gin.Context) *organization.Organization
func GetToken ¶
func GetToken(c *gin.Context) *accesstoken.AccessToken
func IsValidMethodOverride ¶
func LiveReload ¶
func LiveReload() gin.HandlerFunc
func Logger ¶
func Logger() gin.HandlerFunc
func LoginRequired ¶
func LoginRequired(moduleName string) gin.HandlerFunc
Require login to view route
func LogoutRequired ¶
func LogoutRequired(moduleName string) gin.HandlerFunc
Required to be logged out to view
func MethodOverride ¶
func MethodOverride() gin.HandlerFunc
func Namespace ¶
func Namespace() gin.HandlerFunc
Automatically use namespace of organization set in context.
func OverrideRequestMethod ¶
OverrideRequestMethod overrides the http request's method with the specified method.
func ParseToken ¶
func Static ¶
func Static(urlRoot string) gin.HandlerFunc
func TokenPermits ¶
func TokenPermits(masks ...bit.Mask) gin.HandlerFunc
Permissions required to access route
func TokenRequired ¶
func TokenRequired(masks ...bit.Mask) gin.HandlerFunc
Parses token, default permissions check
Types ¶
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package iammiddleware provides Gin middleware for validating Hanzo IAM (hanzo.id) JWT tokens.
|
Package iammiddleware provides Gin middleware for validating Hanzo IAM (hanzo.id) JWT tokens. |
Click to show internal directories.
Click to hide internal directories.