Merge pull request #83 from heroku/cd-log-shuttle-credential-no-leak

credential leak remediation

cleanurl.go

@@ -0,0 +1,19 @@
+package shuttle
+
+import "net/url"
+
+// extractCredentials extracts and scrubs basic auth credentials from a URL to
+// ensure that they never get logged.
+func extractCredentials(uri string) (cleanURL *url.URL, username string, password string, err error) {
+	cleanURL, err = url.Parse(uri)
+	if err != nil {
+		return
+	}
+
+	if cleanURL.User != nil {
+		username = cleanURL.User.Username()
+		password, _ = cleanURL.User.Password()
+	}
+	cleanURL.User = nil
+	return cleanURL, username, password, nil
+}

http_outlet_test.go

@@ -40,6 +40,26 @@ func (ts *testEOFHelper) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 	ts.Headers = r.Header
 }
 
+func TestCreds(t *testing.T) {
+	config := newTestConfig()
+	config.LogsURL = "http://foo:bar@localhost/"
+	b := NewBatch(1)
+	b.Add(LogLineOne)
+	b.Add(LogLineTwo)
+	br := NewLogplexBatchFormatter(b, noErrData, &config)
+	r, err := br.Request()
+	if err != nil {
+		t.Fatalf("unexpected error constructing request %q", err)
+	}
+	if r.URL.User != nil {
+		t.Error("expected r.URL.User to be nil, but wasn't")
+	}
+
+	if u, p, ok := r.BasicAuth(); !ok && u != "foo" && p != "bar" {
+		t.Errorf("expected BasicAuth to be foo, bar, true, but got %s, %s, %t", u, p, ok)
+	}
+}
+
 func TestOutletEOFRetry(t *testing.T) {
 	logLineText := "Hello"
 	th := &testEOFHelper{maxCloses: 1}

logplex_formatter.go

@@ -76,13 +76,23 @@ func NewLogplexBatchFormatter(b Batch, eData []errData, config *Config) HTTPForm
 // Request returns a properly constructed *http.Request, complete with headers
 // and ContentLength set.
 func (bf *LogplexBatchFormatter) Request() (*http.Request, error) {
-	req, err := http.NewRequest("POST", bf.stringURL, bf)
+	u, user, pass, err := extractCredentials(bf.stringURL)
 	if err != nil {
 		return nil, err
 	}
 
+	req, err := http.NewRequest("POST", u.String(), bf)
+	if err != nil {
+		return nil, err
+	}
+
+	// Assign headers before we potentially BasicAuth
 	req.Header = bf.headers
 
+	if user != "" || pass != "" {
+		req.SetBasicAuth(user, pass)
+	}
+
 	return req, nil
 }