gin

package module

Go to main page

Versions in this module

v1

v1.8.1

Jun 6, 2022

Changes in this version

type Engine

+ ContextWithFallback bool

v1.8.0

May 28, 2022

Changes in this version

+ const ContextKey

+ const MIMETOML

type Context

+ func (c *Context) AddParam(key, value string)

+ func (c *Context) BindTOML(obj interface{}) error

+ func (c *Context) ShouldBindTOML(obj interface{}) error

+ func (c *Context) TOML(code int, obj interface{})

type Engine

+ UseH2C bool

+ func (engine *Engine) Handler() http.Handler

type IRoutes

+ StaticFileFS func(string, string, http.FileSystem) IRoutes

type Negotiate

+ TOMLData any

type RouterGroup

+ func (group *RouterGroup) StaticFileFS(relativePath, filepath string, fs http.FileSystem) IRoutes

v1.7.7

Nov 24, 2021

Changes in this version

+ const PlatformCloudflare

+ const PlatformGoogleAppEngine

v1.7.6

Aug 3, 2021

v1.7.5

Nov 20, 2021

Changes in this version

type Engine

+ TrustedPlatform string

+ func (engine *Engine) SetTrustedProxies(trustedProxies []string) error

v1.7.4

Aug 3, 2021

v1.7.3

Aug 3, 2021

v1.7.2

May 21, 2021

v1.7.1

Apr 8, 2021

v1.7.0

Apr 8, 2021

Changes in this version

type Context

+ func (c *Context) GetUint(key string) (ui uint)

+ func (c *Context) GetUint64(key string) (ui64 uint64)

+ func (c *Context) RemoteIP() (net.IP, bool)

type Engine

+ RemoteIPHeaders []string

+ TrustedProxies []string

type Error

+ func (msg *Error) Unwrap() error

type HandlerFunc

+ func CustomRecovery(handle RecoveryFunc) HandlerFunc

+ func CustomRecoveryWithWriter(out io.Writer, handle RecoveryFunc) HandlerFunc

+ type RecoveryFunc func(c *Context, err interface{})

v1.6.3

May 3, 2020

v1.6.2

Mar 27, 2020 GO-2021-0052

GO-2021-0052: Due to improper HTTP header santization, a malicious user can spoof their source IP address by setting the X-Forwarded-For header. This may allow a user to bypass IP based restrictions, or obfuscate their true source.

Changes in this version

type Context

+ func (c *Context) SetSameSite(samesite http.SameSite)

v1.6.1

Mar 23, 2020 GO-2021-0052

GO-2021-0052: Due to improper HTTP header santization, a malicious user can spoof their source IP address by setting the X-Forwarded-For header. This may allow a user to bypass IP based restrictions, or obfuscate their true source.

v1.6.0

Mar 22, 2020 GO-2021-0052

GO-2021-0052: Due to improper HTTP header santization, a malicious user can spoof their source IP address by setting the X-Forwarded-For header. This may allow a user to bypass IP based restrictions, or obfuscate their true source.

Changes in this version

type Context

+ KeysMutex *sync.RWMutex

+ func (c *Context) FileFromFS(filepath string, fs http.FileSystem)

type Engine

+ RemoveExtraSlash bool

type Negotiate

+ YAMLData interface{}

v1.5.0

Nov 24, 2019 GO-2020-0001GO-2021-0052

GO-2020-0001: The default Formatter for the Logger middleware (LoggerConfig.Formatter), which is included in the Default engine, allows attackers to inject arbitrary log entries by manipulating the request path.

GO-2021-0052: Due to improper HTTP header santization, a malicious user can spoof their source IP address by setting the X-Forwarded-For header. This may allow a user to bypass IP based restrictions, or obfuscate their true source.

Changes in this version

+ func EnableJsonDecoderDisallowUnknownFields()

type Context

+ func (c *Context) BindHeader(obj interface{}) error

+ func (c *Context) FullPath() string

+ func (c *Context) ShouldBindHeader(obj interface{}) error

type Engine

+ func (engine *Engine) RunListener(listener net.Listener) (err error)

v1.4.0

May 7, 2019 GO-2020-0001GO-2021-0052

GO-2020-0001: The default Formatter for the Logger middleware (LoggerConfig.Formatter), which is included in the Default engine, allows attackers to inject arbitrary log entries by manipulating the request path.

GO-2021-0052: Due to improper HTTP header santization, a malicious user can spoof their source IP address by setting the X-Forwarded-For header. This may allow a user to bypass IP based restrictions, or obfuscate their true source.

Changes in this version

+ const EnvGinMode

+ const MIMEYAML

+ var DebugPrintRouteFunc func(httpMethod, absolutePath, handlerName string, nuHandlers int)

+ func ForceConsoleColor()

type Context

+ func (c *Context) BindUri(obj interface{}) error

+ func (c *Context) BindXML(obj interface{}) error

+ func (c *Context) BindYAML(obj interface{}) error

+ func (c *Context) FileAttachment(filepath, filename string)

+ func (c *Context) HandlerNames() []string

+ func (c *Context) ProtoBuf(code int, obj interface{})

+ func (c *Context) PureJSON(code int, obj interface{})

+ func (c *Context) ShouldBindUri(obj interface{}) error

+ func (c *Context) ShouldBindXML(obj interface{}) error

+ func (c *Context) ShouldBindYAML(obj interface{}) error

type Engine

+ func (engine *Engine) RunFd(fd int) (err error)

type HandlerFunc

+ func LoggerWithConfig(conf LoggerConfig) HandlerFunc

+ func LoggerWithFormatter(f LogFormatter) HandlerFunc

+ type LogFormatter func(params LogFormatterParams) string

+ type LogFormatterParams struct

+ BodySize int

+ ClientIP string

+ ErrorMessage string

+ Keys map[string]interface{}

+ Latency time.Duration

+ Method string

+ Path string

+ Request *http.Request

+ StatusCode int

+ TimeStamp time.Time

+ func (p *LogFormatterParams) IsOutputColor() bool

+ func (p *LogFormatterParams) MethodColor() string

+ func (p *LogFormatterParams) ResetColor() string

+ func (p *LogFormatterParams) StatusCodeColor() string

+ type LoggerConfig struct

+ Formatter LogFormatter

+ Output io.Writer

+ SkipPaths []string

type RouteInfo

+ HandlerFunc HandlerFunc

v1.3.0

Aug 14, 2018 GO-2020-0001GO-2021-0052

GO-2020-0001: The default Formatter for the Logger middleware (LoggerConfig.Formatter), which is included in the Default engine, allows attackers to inject arbitrary log entries by manipulating the request path.

GO-2021-0052: Due to improper HTTP header santization, a malicious user can spoof their source IP address by setting the X-Forwarded-For header. This may allow a user to bypass IP based restrictions, or obfuscate their true source.

Changes in this version

+ const BodyBytesKey

+ func CreateTestContext(w http.ResponseWriter) (c *Context, r *Engine)

+ func DisableConsoleColor()

+ func EnableJsonDecoderUseNumber()

type Context

+ func (c *Context) AbortWithStatusJSON(code int, jsonObj interface{})

+ func (c *Context) AsciiJSON(code int, obj interface{})

+ func (c *Context) BindQuery(obj interface{}) error

+ func (c *Context) DataFromReader(code int, contentLength int64, contentType string, reader io.Reader, ...)

+ func (c *Context) FormFile(name string) (*multipart.FileHeader, error)

+ func (c *Context) GetBool(key string) (b bool)

+ func (c *Context) GetDuration(key string) (d time.Duration)

+ func (c *Context) GetFloat64(key string) (f64 float64)

+ func (c *Context) GetHeader(key string) string

+ func (c *Context) GetInt(key string) (i int)

+ func (c *Context) GetInt64(key string) (i64 int64)

+ func (c *Context) GetPostFormMap(key string) (map[string]string, bool)

+ func (c *Context) GetQueryMap(key string) (map[string]string, bool)

+ func (c *Context) GetRawData() ([]byte, error)

+ func (c *Context) GetString(key string) (s string)

+ func (c *Context) GetStringMap(key string) (sm map[string]interface{})

+ func (c *Context) GetStringMapString(key string) (sms map[string]string)

+ func (c *Context) GetStringMapStringSlice(key string) (smss map[string][]string)

+ func (c *Context) GetStringSlice(key string) (ss []string)

+ func (c *Context) GetTime(key string) (t time.Time)

+ func (c *Context) Handler() HandlerFunc

+ func (c *Context) IsWebsocket() bool

+ func (c *Context) JSONP(code int, obj interface{})

+ func (c *Context) MultipartForm() (*multipart.Form, error)

+ func (c *Context) MustBindWith(obj interface{}, b binding.Binding) (err error)

+ func (c *Context) PostFormMap(key string) map[string]string

+ func (c *Context) QueryMap(key string) map[string]string

+ func (c *Context) SaveUploadedFile(file *multipart.FileHeader, dst string) error

+ func (c *Context) SecureJSON(code int, obj interface{})

+ func (c *Context) ShouldBind(obj interface{}) error

+ func (c *Context) ShouldBindBodyWith(obj interface{}, bb binding.BindingBody) (err error)

+ func (c *Context) ShouldBindJSON(obj interface{}) error

+ func (c *Context) ShouldBindQuery(obj interface{}) error

+ func (c *Context) ShouldBindWith(obj interface{}, b binding.Binding) error

type Engine

+ AppEngine bool

+ FuncMap template.FuncMap

+ MaxMultipartMemory int64

+ UnescapePathValues bool

+ UseRawPath bool

+ func (engine *Engine) Delims(left, right string) *Engine

+ func (engine *Engine) HandleContext(c *Context)

+ func (engine *Engine) SecureJsonPrefix(prefix string) *Engine

+ func (engine *Engine) SetFuncMap(funcMap template.FuncMap)

type ResponseWriter

+ Pusher func() http.Pusher

v1.1.4

Dec 4, 2016 GO-2020-0001GO-2021-0052

GO-2020-0001: The default Formatter for the Logger middleware (LoggerConfig.Formatter), which is included in the Default engine, allows attackers to inject arbitrary log entries by manipulating the request path.

GO-2021-0052: Due to improper HTTP header santization, a malicious user can spoof their source IP address by setting the X-Forwarded-For header. This may allow a user to bypass IP based restrictions, or obfuscate their true source.

v1.1.3

Dec 3, 2016 GO-2020-0001GO-2021-0052

GO-2020-0001: The default Formatter for the Logger middleware (LoggerConfig.Formatter), which is included in the Default engine, allows attackers to inject arbitrary log entries by manipulating the request path.

GO-2021-0052: Due to improper HTTP header santization, a malicious user can spoof their source IP address by setting the X-Forwarded-For header. This may allow a user to bypass IP based restrictions, or obfuscate their true source.

v1.1.2

Dec 3, 2016 GO-2020-0001GO-2021-0052

GO-2020-0001: The default Formatter for the Logger middleware (LoggerConfig.Formatter), which is included in the Default engine, allows attackers to inject arbitrary log entries by manipulating the request path.

GO-2021-0052: Due to improper HTTP header santization, a malicious user can spoof their source IP address by setting the X-Forwarded-For header. This may allow a user to bypass IP based restrictions, or obfuscate their true source.

v1.1.1

Dec 3, 2016 GO-2020-0001GO-2021-0052

GO-2020-0001: The default Formatter for the Logger middleware (LoggerConfig.Formatter), which is included in the Default engine, allows attackers to inject arbitrary log entries by manipulating the request path.

GO-2021-0052: Due to improper HTTP header santization, a malicious user can spoof their source IP address by setting the X-Forwarded-For header. This may allow a user to bypass IP based restrictions, or obfuscate their true source.

Changes in this version

+ const AuthUserKey

+ const BindKey

+ const DebugMode

+ const ENV_GIN_MODE

+ const MIMEHTML

+ const MIMEJSON

+ const MIMEMultipartPOSTForm

+ const MIMEPOSTForm

+ const MIMEPlain

+ const MIMEXML

+ const MIMEXML2