Merge pull request #328 from roidelapluie/no-marshal-http-secret

Do not marshal secrets in URL's

Author: Julien Pivotto

config/http_config.go

@@ -110,11 +110,25 @@ func (u *URL) UnmarshalYAML(unmarshal func(interface{}) error) error {
 // MarshalYAML implements the yaml.Marshaler interface for URLs.
 func (u URL) MarshalYAML() (interface{}, error) {
 	if u.URL != nil {
-		return u.String(), nil
+		return u.Redacted(), nil
 	}
 	return nil, nil
 }
 
+// Redacted returns the URL but replaces any password with "xxxxx".
+func (u URL) Redacted() string {
+	if u.URL == nil {
+		return ""
+	}
+
+	ru := *u.URL
+	if _, ok := ru.User.Password(); ok {
+		// We can not use secretToken because it would be escaped.
+		ru.User = url.UserPassword(ru.User.Username(), "xxxxx")
+	}
+	return ru.String()
+}
+
 // UnmarshalJSON implements the json.Marshaler interface for URL.
 func (u *URL) UnmarshalJSON(data []byte) error {
 	var s string

config/http_config_test.go

@@ -1418,3 +1418,19 @@ func TestUnmarshalURL(t *testing.T) {
 		t.Fatalf("URL not properly unmarshaled in YAML, got '%s'", u.String())
 	}
 }
+
+func TestMarshalURLWithSecret(t *testing.T) {
+	var u URL
+	err := yaml.Unmarshal([]byte("http://foo:[email protected]"), &u)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	b, err := yaml.Marshal(u)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if strings.TrimSpace(string(b)) != "http://foo:[email protected]" {
+		t.Fatalf("URL not properly marshaled in YAML, got '%s'", string(b))
+	}
+}