Merge pull request #135 from ydb-platform/token-secret

v3.11.6: token representation + `log.Secret` helper for mask token

Author: asmyasnikov

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.11.6
+* Changed `trace.GetCredentialsDoneInfo` token representation from bool to string
+* Added `log.Secret` helper for mask token
+
 ## 3.11.5
 * Replaced meta in `proxyConnection.Invoke` and `proxyConnection.NewStream`
 

internal/meta/meta.go

@@ -116,7 +116,7 @@ func (m *meta) meta(ctx context.Context) (_ metadata.MD, err error) {
 	t := trace.ContextDriver(ctx).Compose(m.trace)
 	getCredentialsDone := trace.DriverOnGetCredentials(t, &ctx)
 	defer func() {
-		getCredentialsDone(token != "", err)
+		getCredentialsDone(token, err)
 	}()
 	token, err = m.credentials.Token(ctx)
 	if err != nil {

internal/meta/version.go

@@ -1,5 +1,5 @@
 package meta
 
 const (
-	Version = "ydb-go-sdk/3.11.5"
+	Version = "ydb-go-sdk/3.11.6"
 )

log/driver.go

@@ -453,14 +453,14 @@ func Driver(log Logger, details trace.Details) (t trace.Driver) {
 			start := time.Now()
 			return func(info trace.GetCredentialsDoneInfo) {
 				if info.Error == nil {
-					log.Tracef(`get done {latency:"%s",ok:%t}`,
+					log.Tracef(`get done {latency:"%s",token:"%s"}`,
 						time.Since(start),
-						info.TokenOk,
+						Secret(info.Token),
 					)
 				} else {
-					log.Errorf(`get failed {latency:"%s",ok:%t,error:"%s"}`,
+					log.Errorf(`get failed {latency:"%s",token:"%s",error:"%s"}`,
 						time.Since(start),
-						info.TokenOk,
+						Secret(info.Token),
 						info.Error,
 					)
 				}

log/secret.go

@@ -0,0 +1,20 @@
+package log
+
+import (
+	"bytes"
+	"fmt"
+	"hash/crc32"
+)
+
+func Secret(secret string) string {
+	var mask bytes.Buffer
+	if len(secret) > 16 {
+		mask.WriteString(secret[:4])
+		mask.WriteString("****")
+		mask.WriteString(secret[len(secret)-4:])
+	} else {
+		mask.WriteString("****")
+	}
+	mask.WriteString(fmt.Sprintf("(CRC-32c: %08X)", crc32.Checksum([]byte(secret), crc32.IEEETable)))
+	return mask.String()
+}

trace/driver.go

@@ -280,8 +280,8 @@ type (
 		Context *context.Context
 	}
 	GetCredentialsDoneInfo struct {
-		TokenOk bool
-		Error   error
+		Token string
+		Error error
 	}
 	InitStartInfo struct {
 		// Context make available context in trace callback function.