ginkit

package module

Go to main page

Versions in this module

v0

v0.14.0

Oct 28, 2024

v0.13.0

Oct 27, 2024

v0.12.0

Oct 26, 2024

v0.11.0

Oct 26, 2024

v0.10.0

Jan 13, 2024

Changes in this version

type Engine

+ func (e *Engine) OAuthMW(path string, authServerURL string, config oauth2.Config) gin.HandlerFunc

v0.9.0

Feb 25, 2023

v0.8.0

Feb 25, 2023

Changes in this version

type Engine

+ func (e *Engine) SAMLSetup(config *SAMLGroupConfig) *samlsp.Middleware

v0.7.0

Feb 25, 2023

v0.6.0

Feb 22, 2023

v0.5.0

Feb 20, 2023

Changes in this version

+ func JWTAuthCachedMiddleware(jwksURL, boundIssuer, jwtheader, claimid string) func(c *gin.Context)

+ func JWTAuthMiddleware(jwksURL, boundIssuer, jwtheader, claimid string) func(c *gin.Context)

+ func RequireAuthMiddleware(jwksURL, boundIssuer, jwtheader, claimid string) func(c *gin.Context)

type Engine

+ func (e *Engine) JWTAuthGroup(path, jwksURL, boundIssuer, jwtheader, claimid string) *RouterGroup

v0.4.0

Feb 16, 2023

Changes in this version

+ func AddRequestHeader(header, key string) func(*gin.Context)

+ func BasicAuthMiddleware(accounts gin.Accounts) func(c *gin.Context)

+ func CertTemplate() (*x509.Certificate, error)

+ func CreateCert(template, parent *x509.Certificate, pub interface{}, parentPriv interface{}) (cert *x509.Certificate, certPEM []byte, err error)

+ func GenerateCertificates() ([]tls.Certificate, error)

+ func GinRunSelfSignedSSL(r *gin.Engine, addr string) (err error)

+ func LogoutRoute(c *gin.Context)

+ func MetricsMiddleware(metric string, keys ...any) func(c *gin.Context)

+ func Proxy(target string) func(*gin.Context)

+ func RBACMiddleware(config *RBACConfig) func(c *gin.Context)

+ func RBACTokenParamMiddleware(model, policy any, tokenHeader string, params []string) func(c *gin.Context)

+ func RBACTokenPathMiddleware(model, policy any, tokenHeader string) func(c *gin.Context)

+ func RemoveHeaders(headers ...string) func(*gin.Context)

+ func ReturnData(c *gin.Context, status int, data any)

+ func SAMLMiddleware(samlSP *samlsp.Middleware) func(c *gin.Context)

+ func SAMLtoParamsMapMiddleware(params map[string]string) func(c *gin.Context)

+ func SAMLtoParamsMiddleware(params ...string) func(c *gin.Context)

+ func SimpleTokenAuthMiddleware(token, header string) func(c *gin.Context)

+ func SimpleTokenAuthOptionalMiddleware(token, header string) func(c *gin.Context)

+ func WrapBytes(b []byte) func(*gin.Context)

+ func WrapDataFunc(f func() (any, error)) func(*gin.Context)

+ func WrapDataFuncContext(f func(*gin.Context) (any, error)) func(*gin.Context)

+ func WrapDataFuncParams(f func(Params) (any, error)) func(*gin.Context)

+ func WrapErrorFunc(f func() error) func(*gin.Context)

+ func WrapGinH(d gin.H) func(*gin.Context)

+ func WrapH(d H) func(*gin.Context)

+ func WrapString(s string) func(*gin.Context)

+ type Engine struct

+ func Default() (r *Engine)

+ func New() *Engine

+ func NewDefault() (r *Engine)

+ func NewDefaultWithSessions(sessionType, name, secret string) (r *Engine)

+ func (e *Engine) AddHealthCheckFunc(f func() error) *Engine

+ func (e *Engine) AddTemplateFunc(k string, v interface{}) *Engine

+ func (e *Engine) Any(relativePath string, f ...any)

+ func (e *Engine) DELETE(relativePath string, f ...any)

+ func (e *Engine) GET(relativePath string, f ...any)

+ func (e *Engine) HEAD(relativePath string, f ...any)

+ func (e *Engine) HTML(template string, f any) func(*gin.Context)

+ func (e *Engine) HTMLWithError(template, errorTemplate string, f any) func(*gin.Context)

+ func (e *Engine) Handle(httpMethod, relativePath string, funcs ...any)

+ func (e *Engine) HealthCheckRoute(c *gin.Context)

+ func (e *Engine) NoRoute(funcs ...any)

+ func (e *Engine) NoRouteHTML(template string, f any)

+ func (e *Engine) NoRouteProxy(target string)

+ func (e *Engine) NoRouteRedirect(location string)

+ func (e *Engine) OAuthGroup(path string, authServerURL string, config oauth2.Config) *gin.RouterGroup

+ func (e *Engine) OPTIONS(relativePath string, f ...any)

+ func (e *Engine) PATCH(relativePath string, f ...any)

+ func (e *Engine) POST(relativePath string, f ...any)

+ func (e *Engine) PUT(relativePath string, f ...any)

+ func (e *Engine) RBACGroup(path string, config *RBACConfig) *gin.RouterGroup

+ func (e *Engine) RBACTokenParamGroup(path string, model, policy any, tokenHeader string, params []string) *gin.RouterGroup

+ func (e *Engine) RBACTokenPathGroup(path string, model, policy any, tokenHeader string) *gin.RouterGroup

+ func (e *Engine) Redirect(location string) gin.HandlerFunc

+ func (e *Engine) Router() *gin.Engine

+ func (e *Engine) Run(addr ...string) error

+ func (e *Engine) RunSSLSelfSigned(addr string) error

+ func (e *Engine) SAMLGroup(path string, config *SAMLGroupConfig) *gin.RouterGroup

+ func (e *Engine) SAMLInit(config *SAMLGroupConfig) *samlsp.Middleware

+ func (e *Engine) SetVersion(version string) *Engine

+ func (e *Engine) SimpleTokenAuthGroup(path, token, header string) *RouterGroup

+ func (e *Engine) Static(assets string) *Engine

+ func (e *Engine) Templates(views string, partials []string) *Engine

+ type H map[string]any

+ type Param struct

+ Key string

+ Value string

+ type Params []Param

+ func NewParams(p gin.Params) Params

+ func (ps Params) Get(name string) (string, bool)

+ type RBACConfig struct

+ Model any

+ Params []any

+ Policy any

+ type RouterGroup struct

+ func (r *RouterGroup) Any(relativePath string, funcs ...any)

+ func (r *RouterGroup) DELETE(relativePath string, funcs ...any)

+ func (r *RouterGroup) GET(relativePath string, funcs ...any)

+ func (r *RouterGroup) HEAD(relativePath string, funcs ...any)

+ func (r *RouterGroup) Handle(httpMethod, relativePath string, funcs ...any)

+ func (r *RouterGroup) OPTIONS(relativePath string, funcs ...any)

+ func (r *RouterGroup) PATCH(relativePath string, funcs ...any)

+ func (r *RouterGroup) POST(relativePath string, funcs ...any)

+ func (r *RouterGroup) PUT(relativePath string, funcs ...any)

+ type SAMLGroupConfig struct

+ AllowSkip bool

+ CertFile string

+ EntityID string

+ KeyFile string

+ MetaDataFile string

+ MetaDataURL string

+ ParamMap map[string]string

+ RootURL string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL