Documentation ¶
Index ¶
- Variables
- func AuthMiddleware() gin.HandlerFunc
- func CORSMiddleware() gin.HandlerFunc
- func GetBearer(auth []string) (jwt string, ok bool)
- func LogMiddleware(logger loggerEntryWithFields, timeFormat string, utc bool) gin.HandlerFunc
- func OptionalAuthMiddleware() gin.HandlerFunc
- func OptionalUserMiddleware() gin.HandlerFunc
- func RequirePathParam(param string) gin.HandlerFunc
- func RequireStringPathParam(param string) gin.HandlerFunc
- func ServiceKeyMiddleware(si factory.Servicer) gin.HandlerFunc
- func SetAuth(authenticator auth.Authenticator) gin.HandlerFunc
- func Start() error
- func UserHandler(c *gin.Context) error
- func UserMiddleware() gin.HandlerFunc
- type AuthenticatedUser
Constants ¶
This section is empty.
Variables ¶
var DisableVerification = false
DisableVerification won't pass through invalid JWT in production mode.
Functions ¶
func AuthMiddleware ¶
func AuthMiddleware() gin.HandlerFunc
AuthMiddleware verifies JWT with authenticator.
func LogMiddleware ¶
func LogMiddleware(logger loggerEntryWithFields, timeFormat string, utc bool) gin.HandlerFunc
LogMiddleware returns a gin.HandlerFunc (middleware) that logs requests using logrus.
Requests with errors are logged using logrus.Error(). Requests without errors are logged using logrus.Info().
It receives:
- A time package format string (e.g. time.RFC3339).
- A boolean stating whether to use UTC time zone or local.
func OptionalAuthMiddleware ¶
func OptionalAuthMiddleware() gin.HandlerFunc
OptionalAuthMiddleware does optional JWT verification.
func OptionalUserMiddleware ¶
func OptionalUserMiddleware() gin.HandlerFunc
OptionalUserMiddleware 認証していればユーザー情報を取得する
func RequirePathParam ¶
func RequirePathParam(param string) gin.HandlerFunc
RequirePathParam parses PathParameter as uint64 by given param and then sets it to gin Context.
func RequireStringPathParam ¶
func RequireStringPathParam(param string) gin.HandlerFunc
RequireStringPathParam parses PathParameter as string by given param and then sets it to gin Context.
func ServiceKeyMiddleware ¶
func ServiceKeyMiddleware(si factory.Servicer) gin.HandlerFunc
ServiceKeyMiddleware provides the service factory
func SetAuth ¶
func SetAuth(authenticator auth.Authenticator) gin.HandlerFunc
SetAuth passes an authenticator.
Types ¶
type AuthenticatedUser ¶
AuthenticatedUser verified user information