Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

respect logger settings for auth headers #422

Merged
merged 1 commit into from
Sep 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions cmd/config-boltdb.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ services:
region: ""
login:
loginWith:
username: false
username: true
phone: true
email: false
federated: false
Expand All @@ -83,6 +83,9 @@ logger:
# logs format (json, text)
format: json
# exclude body for HTTP requests that can contain sensitive data
logSensitiveData: false
logSensitiveData: true
common:
level: debug
api:
level: debug
httpDetailing: dump
3 changes: 3 additions & 0 deletions web/admin/router.go
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ func NewRouter(settings RouterSettings) (model.Router, error) {
settings.LoggerSettings.DumpRequest,
settings.LoggerSettings.Format,
settings.LoggerSettings.Admin,
settings.LoggerSettings.LogSensitiveData,
settings.Cors)

ar.initRoutes()
Expand All @@ -70,6 +71,7 @@ func buildMiddleware(
dumpRequest bool,
format string,
logParams model.LoggerParams,
logSensitiveData bool,
corsHandler *cors.Cors,
) *negroni.Negroni {
var handlers []negroni.Handler
Expand All @@ -79,6 +81,7 @@ func buildMiddleware(
format,
logParams,
model.HTTPLogDetailing(dumpRequest, logParams.HTTPDetailing),
!logSensitiveData,
"/login",
)
handlers = append(handlers, lm)
Expand Down
1 change: 1 addition & 0 deletions web/api/routes.go
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ func buildBaseMiddleware(
format,
logParams,
model.HTTPLogDetailing(dumpRequest, logParams.HTTPDetailing),
!logSensitiveData,
exclude...)

result := negroni.New(
Expand Down
1 change: 1 addition & 0 deletions web/management/routes.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ func (ar *Router) initRoutes(loggerSettings model.LoggerSettings) {
loggerSettings.Format,
loggerSettings.Management,
model.HTTPLogDetailing(loggerSettings.DumpRequest, loggerSettings.Management.HTTPDetailing),
!loggerSettings.LogSensitiveData,
)

ar.router.Use(middleware.RequestID)
Expand Down
48 changes: 46 additions & 2 deletions web/middleware/logger.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@ func NegroniHTTPLogger(
format string,
logParams model.LoggerParams,
httpDetailing model.HTTPDetailing,
excludeAuth bool,
exclude ...string,
) negroni.Handler {
logger := HTTPLogger(component, format, logParams, httpDetailing, exclude...)
logger := HTTPLogger(component, format, logParams, httpDetailing, excludeAuth, exclude...)

return negroni.HandlerFunc(func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc) {
logger(next).ServeHTTP(w, r)
Expand All @@ -35,6 +36,7 @@ func HTTPLogger(
format string,
logParams model.LoggerParams,
httpDetailing model.HTTPDetailing,
excludeAuth bool,
exclude ...string,
) func(http.Handler) http.Handler {
if httpDetailing == model.HTTPLogNone ||
Expand All @@ -52,7 +54,7 @@ func HTTPLogger(
logging.FieldComponent, component,
"method", r.Method,
"url", r.URL.String(),
"headers", r.Header,
"headers", redactHeaders(r.Header, excludeAuth),
"body", string(body))
}

Expand Down Expand Up @@ -101,3 +103,45 @@ func HTTPLogger(
hl := httplog.LoggerWithFormatterAndName(component, httplog.DefaultLogFormatterWithRequestHeadersAndBody)
return hl
}

func redactHeaders(headers http.Header, excludeAuth bool) http.Header {
if !excludeAuth {
return headers
}

result := make(http.Header, len(headers))

for k, vv := range headers {
if strings.EqualFold(k, "Authorization") {
cc := make([]string, len(vv))
for i, v := range vv {
cc[i] = redactAuthValue(v)
}
result[k] = cc
} else {
result[k] = vv
}

}

return result
}

func redactAuthValue(v string) string {
expectedPrefix := "bearer"

actualPrefix := ""
if len(v) >= len(expectedPrefix) {
actualPrefix = v[:len(expectedPrefix)]
}

if strings.EqualFold(actualPrefix, expectedPrefix) {
if len(v) <= len(expectedPrefix)+1 {
return actualPrefix + " <empty>"
}

return actualPrefix + " <redacted>"
}

return "<redacted>"
}
3 changes: 3 additions & 0 deletions web/spa/router.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ func NewRouter(setting SPASettings, middlewares []negroni.Handler) (model.Router
setting.LoggerSettings.DumpRequest,
setting.LoggerSettings.Format,
setting.LoggerSettings.SPA,
!setting.LoggerSettings.LogSensitiveData,
middlewares,
)

Expand All @@ -50,13 +51,15 @@ func buildMiddleware(
dumpRequest bool,
format string,
logParams model.LoggerParams,
logSensitiveData bool,
middlewares []negroni.Handler,
) *negroni.Negroni {
lm := middleware.NegroniHTTPLogger(
settingName,
format,
logParams,
model.HTTPLogDetailing(dumpRequest, logParams.HTTPDetailing),
!logSensitiveData,
)

handlers := []negroni.Handler{
Expand Down
Loading