middleware

package
v1.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 22, 2025 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	AccessMiddleDisableKey = "middleware.access.disable"
	AccessMaxLengthKey     = "middleware.access.max-length"
	AccessMiddleOrder      = 10
)
View Source 
const (
	CROSMiddleDisableKey  = "middleware.cros.disable"
	CROSMiddleWildcardKey = "middleware.cros.wildcard"
	CROSMiddleExposedKey  = "middleware.cros.expose"
	CROSMiddleOrder       = 20
)
View Source 
const (
	ErrorlogMiddleDisableKey = "middleware.error-log.disable"
	ErrorlogMiddleOrder      = 30
)
View Source 
const (
	JwtKey              = "middleware.jwt"
	JwtDisableKey       = "middleware.jwt.disable"
	JwtCookiedomainKey  = "middleware.jwt.cookie-domain"
	JwtExpiresecondsKey = "middleware.jwt.expire-seconds"
	JwtSecretKey        = "middleware.jwt.secret"
	JwtExcludesKey      = "middleware.jwt.excludes"

	JwtMiddleOrder = 50
)
View Source 
const (
	JwtCookieKey         = "Authorization"
	JwtTokenContextKey   = "jwt"
	JwtSubjectContextKey = "subject"
)
View Source 
const (
	ServerPrefix                   = "server.prefix"
	ResourceMiddlePrefixKey        = "middleware.resource.prefix"
	ResourceMiddleExcludeKey       = "middleware.resource.exclude"
	ResourceMiddleIndexNotFoundKey = "middleware.resource.index-not-found"
	ResourceMiddleDisableKey       = "middleware.resource.disable"
	ResourceMiddleCompressKey      = "middleware.resource.compress"

	ResourceMiddleDefaultPrefix = "/resources"
	ResourceMiddleOrder         = 40

	ContextResourceKey = "ResourcesKey"
)
View Source 
const (
	RewriteMiddleDisableKey = "middleware.rewrite.disable"
	RewriteMiddleMatchKey   = "middleware.rewrite.match"
	RewriteMiddleRewriteKey = "middleware.rewrite.rewrite"
	RewriteMiddleOrder      = 5
)
View Source 
const (
	SessionKey         = "middleware.session"
	SessionDisableKey  = "middleware.session.disable"
	SessionTimeoutKey  = "middleware.session.timeout"
	SessionMiddleOrder = 50
	SessionCookieKey   = "siuid"
	SessionContextKey  = "session"
)

Variables

This section is empty.

Functions

func JwtSign added in v1.3.1 

func JwtSign(subject *Subject, secret string, expire time.Duration) (string, error)

func PermissionsHaveRole added in v1.3.1 

func PermissionsHaveRole(handler gin.HandlerFunc, needRoles ...string) gin.HandlerFunc

func Serve 

func Serve(prefix string, exclude string, indexNotFound bool, compress bool, fs ServeFileSystem) gin.HandlerFunc

Types

type Claims added in v1.3.1 

type Claims struct {
	*Subject
	jwt.RegisteredClaims
}

type CustomResponseWriter added in v1.2.2 

type CustomResponseWriter struct {
	gin.ResponseWriter
	// contains filtered or unexported fields
}

func (*CustomResponseWriter) Write added in v1.2.2 

func (w *CustomResponseWriter) Write(b []byte) (int, error)

func (*CustomResponseWriter) WriteString added in v1.2.2 

func (w *CustomResponseWriter) WriteString(s string) (int, error)

type GzipResponseWriter added in v1.2.7 

type GzipResponseWriter struct {
	gin.ResponseWriter
	// contains filtered or unexported fields
}

func (*GzipResponseWriter) Write added in v1.2.7 

func (w *GzipResponseWriter) Write(b []byte) (int, error)

func (*GzipResponseWriter) WriteString added in v1.2.7 

func (w *GzipResponseWriter) WriteString(s string) (int, error)

type LocalFileSystem 

type LocalFileSystem struct {
	http.FileSystem
	// contains filtered or unexported fields
}

func LocalFile 

func LocalFile(root string, indexes bool) *LocalFileSystem

func (*LocalFileSystem) Exists 

func (l *LocalFileSystem) Exists(prefix string, exclude string, filepath string) bool

func (*LocalFileSystem) Open 

func (l *LocalFileSystem) Open(name string) (http.File, error)

type MiddlewareAccess added in v1.1.3 

type MiddlewareAccess struct {
	Conf   config.TypedConfig `@siu:"name='environment',default='type'"`
	Logger interfaces.Logger  `@siu:"name='logger',default='type'"`
	// contains filtered or unexported fields
}

func (*MiddlewareAccess) Condition added in v1.1.3 

func (p *MiddlewareAccess) Condition() bool

func (*MiddlewareAccess) Function added in v1.1.3 

func (p *MiddlewareAccess) Function() gin.HandlerFunc

func (*MiddlewareAccess) Init added in v1.2.2 

func (p *MiddlewareAccess) Init()

func (*MiddlewareAccess) Order added in v1.1.3 

func (p *MiddlewareAccess) Order() int

type MiddlewareCROS 

type MiddlewareCROS struct {
	Conf config.TypedConfig `@siu:"name='environment',default='type'"`
	// contains filtered or unexported fields
}

func (*MiddlewareCROS) Condition 

func (p *MiddlewareCROS) Condition() bool

func (*MiddlewareCROS) Function 

func (p *MiddlewareCROS) Function() gin.HandlerFunc

func (*MiddlewareCROS) Init added in v1.1.3 

func (p *MiddlewareCROS) Init()

func (*MiddlewareCROS) Order 

func (p *MiddlewareCROS) Order() int

type MiddlewareErrorlog added in v1.2.0 

type MiddlewareErrorlog struct {
	Conf   config.TypedConfig `@siu:"name='environment',default='type'"`
	Logger interfaces.Logger  `@siu:"name='logger',default='type'"`
}

func (*MiddlewareErrorlog) Condition added in v1.2.0 

func (p *MiddlewareErrorlog) Condition() bool

func (*MiddlewareErrorlog) Function added in v1.2.0 

func (p *MiddlewareErrorlog) Function() gin.HandlerFunc

func (*MiddlewareErrorlog) Order added in v1.2.0 

func (p *MiddlewareErrorlog) Order() int

type MiddlewareJwt added in v1.3.1 

type MiddlewareJwt struct {
	Conf config.TypedConfig `@siu:"name='environment',default='type'"`
	// contains filtered or unexported fields
}

func (*MiddlewareJwt) ClearCookie added in v1.3.1 

func (p *MiddlewareJwt) ClearCookie(c *gin.Context)

func (*MiddlewareJwt) Condition added in v1.3.1 

func (p *MiddlewareJwt) Condition() bool

func (*MiddlewareJwt) Function added in v1.3.1 

func (p *MiddlewareJwt) Function() gin.HandlerFunc

func (*MiddlewareJwt) GetSubject added in v1.3.1 

func (p *MiddlewareJwt) GetSubject(c *gin.Context) *Subject

func (*MiddlewareJwt) Init added in v1.3.1 

func (p *MiddlewareJwt) Init()

func (*MiddlewareJwt) Order added in v1.3.1 

func (p *MiddlewareJwt) Order() int

func (*MiddlewareJwt) SetCookie added in v1.3.1 

func (p *MiddlewareJwt) SetCookie(c *gin.Context)

func (*MiddlewareJwt) SetSubjectCookie added in v1.3.1 

func (p *MiddlewareJwt) SetSubjectCookie(c *gin.Context, subject *Subject) error

func (*MiddlewareJwt) SetTokenCookie added in v1.3.1 

func (p *MiddlewareJwt) SetTokenCookie(c *gin.Context, token string)

func (*MiddlewareJwt) SignToken added in v1.3.1 

func (p *MiddlewareJwt) SignToken(c *gin.Context, subject *Subject) (string, error)

type MiddlewareResource 

type MiddlewareResource struct {
	Conf config.TypedConfig `@siu:"name='environment',default='type'"`
}

func (*MiddlewareResource) Condition 

func (p *MiddlewareResource) Condition() bool

func (*MiddlewareResource) Function 

func (p *MiddlewareResource) Function() gin.HandlerFunc

func (*MiddlewareResource) Order 

func (p *MiddlewareResource) Order() int

type MiddlewareRewrite added in v1.2.7 

type MiddlewareRewrite struct {
	Server *gin.Engine        `@siu:"name='server',default='type'"`
	Conf   config.TypedConfig `@siu:"name='environment',default='type'"`
	Logger interfaces.Logger  `@siu:"name='logger',default='type'"`
	// contains filtered or unexported fields
}

func (*MiddlewareRewrite) Condition added in v1.2.7 

func (p *MiddlewareRewrite) Condition() bool

func (*MiddlewareRewrite) Function added in v1.2.7 

func (p *MiddlewareRewrite) Function() gin.HandlerFunc

func (*MiddlewareRewrite) Init added in v1.2.7 

func (p *MiddlewareRewrite) Init()

func (*MiddlewareRewrite) Order added in v1.2.7 

func (p *MiddlewareRewrite) Order() int

type MiddlewareSession added in v1.2.7 

type MiddlewareSession struct {
	Conf   config.TypedConfig `@siu:"name='environment',default='type'"`
	Logger interfaces.Logger  `@siu:"name='logger',default='type'"`
	Redis  redis.Cmdable      `@siu:"name='redis',default='zero'"`
	// contains filtered or unexported fields
}

func (*MiddlewareSession) Condition added in v1.2.7 

func (p *MiddlewareSession) Condition() bool

func (*MiddlewareSession) Del added in v1.2.9 

func (p *MiddlewareSession) Del(key string)

func (*MiddlewareSession) Function added in v1.2.7 

func (p *MiddlewareSession) Function() gin.HandlerFunc

func (*MiddlewareSession) Get added in v1.2.7 

func (p *MiddlewareSession) Get(key string) (string, bool)

func (*MiddlewareSession) Init added in v1.2.7 

func (p *MiddlewareSession) Init()

func (*MiddlewareSession) Order added in v1.2.7 

func (p *MiddlewareSession) Order() int

func (*MiddlewareSession) Set added in v1.2.7 

func (p *MiddlewareSession) Set(key string, value string)

type ServeFileSystem 

type ServeFileSystem interface {
	http.FileSystem
	Exists(prefix string, exclude string, path string) bool
}

type Subject added in v1.3.1 

type Subject struct {
	Id     int64                  `json:"id"`
	Name   string                 `json:"name"`
	Roles  []string               `json:"roles"`
	Others map[string]interface{} `json:"others"`
}

func JwtVerify added in v1.3.1 

func JwtVerify(tokenString string, secret string) (*Subject, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.