不要在日志中打印秘密

时间:2017-11-27 10:07:05

标签: arrays string logging go substring

我正在使用Zap记录器,我想限制记录的信息。例如,我有以下代码片段

func (m *mountCommand) Execute(args []string) error {

    filelogger.Info("First log", zap.Strings("input args", args))

日志输出如下

    {"level":"info","ts":"2017-11-16T10:04:40.225Z","msg":"First log","input args":["/var/lib/kubelet/pods/74785895-cab5-11e7-88ed-ce1c8b57856c/volumes/xyz-xandndnd",
    "{\"kubernetes.io/secret/access-key\":\"Qdfnnfbbdnsjnxni8ehh=\",\"kubernetes.io/secret/secret-key\":\"GGHNHwsffUIJMNBNBVV==\",
\"parallel-count\":\"5\",\"region\":\"iam-standard\"}"]}

由于数据的敏感性,我如何防止将访问密钥和密钥值添加到日志中。

我在Go中尝试了很多字符串操作函数,这样我就可以在使用zap对象之前删除这些内容。似乎没有简单的函数可以直接简单地完成它。

1 个答案:

答案 0 :(得分:2)

您当前的args是以下string的一部分:

/var/lib/kubelet/pods/74785895-cab5-11e7-88ed-ce1c8b57856c/volumes/xyz-xandndnd
{"kubernetes.io/secret/access-key":"Qdfnnfbbdnsjnxni8ehh=","kubernetes.io/secret/secret-key":"GGHNHwsffUIJMNBNBVV==","parallel-count":"5","region":"iam-standard"}

包含安全敏感数据的输入参数位于索引1,它是一个JSON文本。

你不应该"字符串操纵"一个JSON文本。首先,您应该将其解组为Go值,然后对其进行操作,然后将其编组回来。

这是如何做到的:

// Make a copy of args:
args2 := append([]string{}, args...)

// Unmarshal:
var m map[string]interface{}
if err := json.Unmarshal([]byte(args2[1]), &m); err != nil {
    panic(err)
}

// Modify:
m["kubernetes.io/secret/access-key"] = "XXX"
m["kubernetes.io/secret/secret-key"] = "YYY"

// Marshal:
s2, err := json.Marshal(m)
if err != nil {
    panic(err)
}
args2[1] = string(s2)

// Verify:
fmt.Println(args2[1])

// Now use args2 to log
filelogger.Info("First log", zap.Strings("(masked) input args", args2))

"验证:"显然不需要,只是让我们看到结果。 Go Playground上的输出:

{"kubernetes.io/secret/access-key":"XXX","kubernetes.io/secret/secret-key":"YYY","parallel-count":"5","region":"iam-standard"}

在您的解决方案中,您还应添加切片索引检查以避免运行时出现紧急情况。