From df106dc26211bd9f009cc26da13b19c1d8cb418c Mon Sep 17 00:00:00 2001 From: Joel Unzain Date: Thu, 10 Jun 2021 17:23:09 -0700 Subject: [PATCH] Unexport logger getter and setter (#219) * keep setter and getter unexported * add change note --- CHANGELOG.md | 1 + basculeLogging.go | 4 ++-- main.go | 8 ++++---- 3 files changed, 7 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 62d156f0..bb2d0cb0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). ## [Unreleased] +- Keep setter and getter unexported. [#219](https://github.com/xmidt-org/tr1d1um/pull/219) - Prevent Authorization header from getting logged. [#218](https://github.com/xmidt-org/tr1d1um/pull/218) diff --git a/basculeLogging.go b/basculeLogging.go index f83c8978..0ea0f422 100644 --- a/basculeLogging.go +++ b/basculeLogging.go @@ -22,7 +22,7 @@ func sanitizeHeaders(headers http.Header) (filtered http.Header) { return } -func SetLogger(logger log.Logger) func(delegate http.Handler) http.Handler { +func setLogger(logger log.Logger) func(delegate http.Handler) http.Handler { return func(delegate http.Handler) http.Handler { return http.HandlerFunc( func(w http.ResponseWriter, r *http.Request) { @@ -34,7 +34,7 @@ func SetLogger(logger log.Logger) func(delegate http.Handler) http.Handler { } } -func GetLogger(ctx context.Context) log.Logger { +func getLogger(ctx context.Context) log.Logger { logger := log.With(logging.GetLogger(ctx), "ts", log.DefaultTimestampUTC, "caller", log.DefaultCaller) return logger } diff --git a/main.go b/main.go index 0d6dd5ec..d9b3e978 100644 --- a/main.go +++ b/main.go @@ -174,7 +174,7 @@ func tr1d1um(arguments []string) (exitCode int) { } webhookConfig.Argus.HTTPClient = newHTTPClient(argusClientTimeout, tracing) - svc, stopWatch, err := ancla.Initialize(webhookConfig, GetLogger) + svc, stopWatch, err := ancla.Initialize(webhookConfig, getLogger) if err != nil { fmt.Fprintf(os.Stderr, "Failed to initialize webhook service: %s\n", err.Error()) return 1 @@ -450,7 +450,7 @@ func authenticationHandler(v *viper.Viper, logger log.Logger, registry xmetrics. logging.Debug(logger).Log(logging.MessageKey(), "Created list of allowed basic auths", "allowed", basicAllowed, "config", basicAuth) options := []basculehttp.COption{ - basculehttp.WithCLogger(GetLogger), + basculehttp.WithCLogger(getLogger), basculehttp.WithCErrorResponseFunc(listener.OnErrorResponse), basculehttp.WithParseURLFunc(basculehttp.CreateRemovePrefixURLFunc("/"+apiBase+"/", basculehttp.DefaultParseURLFunc)), } @@ -508,14 +508,14 @@ func authenticationHandler(v *viper.Viper, logger log.Logger, registry xmetrics. } authEnforcer := basculehttp.NewEnforcer( - basculehttp.WithELogger(GetLogger), + basculehttp.WithELogger(getLogger), basculehttp.WithRules("Basic", bascule.Validators{ bchecks.AllowAll(), }), basculehttp.WithRules("Bearer", bearerRules), basculehttp.WithEErrorResponseFunc(listener.OnErrorResponse), ) - constructors := []alice.Constructor{SetLogger(logger), authConstructor, authEnforcer, basculehttp.NewListenerDecorator(listener)} + constructors := []alice.Constructor{setLogger(logger), authConstructor, authEnforcer, basculehttp.NewListenerDecorator(listener)} chain := alice.New(constructors...) return &chain, nil