diff --git a/pkg/middlewares/authorization.go b/pkg/middlewares/authorization.go index f24d6639..407c16ff 100644 --- a/pkg/middlewares/authorization.go +++ b/pkg/middlewares/authorization.go @@ -10,6 +10,7 @@ import ( "github.com/mayswind/lab/pkg/utils" ) +// JWTAuthorization verifies whether current request is valid by jwt token func JWTAuthorization(c *core.Context) { claims, err := getTokenClaims(c) @@ -34,6 +35,7 @@ func JWTAuthorization(c *core.Context) { c.Next() } +// JWTTwoFactorAuthorization verifies whether current request is valid by 2fa passcode func JWTTwoFactorAuthorization(c *core.Context) { claims, err := getTokenClaims(c) diff --git a/pkg/middlewares/recovery.go b/pkg/middlewares/recovery.go index af091f88..38922fd0 100644 --- a/pkg/middlewares/recovery.go +++ b/pkg/middlewares/recovery.go @@ -19,6 +19,7 @@ var ( slash = []byte("/") ) +// Recovery logs error message when error occurs func Recovery(c *core.Context) { defer func() { if err := recover(); err != nil { diff --git a/pkg/middlewares/request_id.go b/pkg/middlewares/request_id.go index 48253bb9..38ceedad 100644 --- a/pkg/middlewares/request_id.go +++ b/pkg/middlewares/request_id.go @@ -8,6 +8,7 @@ import ( const requestIdHeader = "X-Request-ID" +// RequestId generates a new request id and add it to context and response header func RequestId(config *settings.Config) core.MiddlewareHandlerFunc { return func(c *core.Context) { if requestid.Container.Current == nil { diff --git a/pkg/middlewares/request_log.go b/pkg/middlewares/request_log.go index 40654cb9..dd99719a 100644 --- a/pkg/middlewares/request_log.go +++ b/pkg/middlewares/request_log.go @@ -7,6 +7,7 @@ import ( "github.com/mayswind/lab/pkg/log" ) +// RequestLog logs the http request log func RequestLog(c *core.Context) { start := time.Now() path := c.Request.URL.Path diff --git a/pkg/middlewares/server_settings_cookie.go b/pkg/middlewares/server_settings_cookie.go index bf2c1ec7..43dc1534 100644 --- a/pkg/middlewares/server_settings_cookie.go +++ b/pkg/middlewares/server_settings_cookie.go @@ -10,6 +10,7 @@ import ( const settingsCookieName = "ACP_SETTINGS" +// ServerSettingsCookie adds server settings to cookies in response func ServerSettingsCookie(config *settings.Config) core.MiddlewareHandlerFunc { return func(c *core.Context) { settingsArr := []string{