Documentation
¶
Overview ¶
Package authkitgin bridges AuthKit's net/http middleware to Gin. Mount registers AuthKit's routes directly on the engine; verification policy stays in verify. Handlers read the verified caller from c.Request.Context() (verify.ActorFromContext, verify.ClaimsFromContext) and write AuthKit errors with c.JSON(iam.ErrorResponse(err)).
Index ¶
- func Mount(router *gin.Engine, s Surface) error
- func Optional(a verify.Authenticator) gin.HandlerFunc
- func RequirePermission(a verify.Authority, perm iam.Perm) gin.HandlerFunc
- func RequirePermissionOn(a verify.Authority, ref iam.GroupRef, perm iam.Perm) gin.HandlerFunc
- func RequireSession(a verify.Authority) gin.HandlerFunc
- func Required(a verify.Authenticator) gin.HandlerFunc
- func Sensitive(a verify.Authority) gin.HandlerFunc
- func SetGroup(c *gin.Context, ref iam.GroupRef)
- func Use(mw ...func(http.Handler) http.Handler) gin.HandlerFunc
- type Surface
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Mount ¶ added in v0.128.0
Mount registers every AuthKit route natively on router, so each appears in router.Routes() (GET routes also as HEAD). Call it during setup, before serving requests. Every route is served by the surface's one handler, which keeps AuthKit's authentication, JSON guards, cookies and request context. Conflicting routes and unsupported patterns return an error before any route is registered; exclude host replacements with HTTPConfig.Exclude.
func Optional ¶ added in v0.78.0
func Optional(a verify.Authenticator) gin.HandlerFunc
Optional is verify.Optional in a gin chain.
func RequirePermission ¶ added in v0.72.0
RequirePermission is verify.RequirePermission in a gin chain, in the group SetGroup attached.
func RequirePermissionOn ¶ added in v0.147.0
RequirePermissionOn is verify.RequirePermissionOn in a gin chain.
func RequireSession ¶ added in v0.147.0
func RequireSession(a verify.Authority) gin.HandlerFunc
RequireSession is verify.RequireSession in a gin chain.
func Required ¶ added in v0.78.0
func Required(a verify.Authenticator) gin.HandlerFunc
Required is verify.Required in a gin chain: a is the *authkit.Client (or a *verify.Verifier).
api := r.Group("/api", authkitgin.Required(auth))
func Sensitive ¶ added in v0.147.0
func Sensitive(a verify.Authority) gin.HandlerFunc
Sensitive is verify.Sensitive in a gin chain.
Source Files