feat: setup-gap-authz by erikburt · Pull Request #996 · smartcontractkit/.github

erikburt · 2025-04-14T18:19:25Z

No description provided.

+
+// handleHealthz is a simple health check endpoint
+func handleHealthz(w http.ResponseWriter, r *http.Request) {
+	log.Printf("Health check request: %s", r.URL.Path)


To fix the problem, we need to sanitize the user input before logging it. Specifically, we should remove any newline characters from the r.URL.Path to prevent log forgery. This can be done using the strings.ReplaceAll function to replace newline characters with an empty string. This ensures that the log entries are safe and cannot be manipulated by malicious users.

+
+// handleNotFound handles all other paths, logs the request path, and returns a 404
+func handleNotFound(w http.ResponseWriter, r *http.Request) {
+	log.Printf("Not found request: %s %s", r.Method, r.URL.Path)


To fix the problem, we need to sanitize the user input before logging it. Specifically, we should remove any newline characters from the r.URL.Path to prevent log forgery. This can be done using the strings.ReplaceAll function to replace newline characters with an empty string. This ensures that the log entry remains a single line and cannot be manipulated by a malicious user.

+	if re.MatchString(authority) {
+		// Replace the port with 443
+		newAuthority := regexp.MustCompile(":\\d+$").ReplaceAllString(authority, ":443")
+		log.Printf("Updated authority header from %s to %s", authority, newAuthority)


To fix the problem, we need to sanitize the authority header before logging it. This can be done by removing any newline characters from the authority value. We can use the strings.ReplaceAll function to replace \n and \r characters with an empty string. This ensures that the logged value does not contain any characters that could be used to forge log entries.

+	if re.MatchString(authority) {
+		// Replace the port with 443
+		newAuthority := regexp.MustCompile(":\\d+$").ReplaceAllString(authority, ":443")
+		log.Printf("Updated authority header from %s to %s", authority, newAuthority)


To fix the problem, we need to sanitize the user input before logging it. Specifically, we should remove any newline characters from the authority header to prevent log forgery. This can be done using the strings.ReplaceAll function to replace newline characters with an empty string. We should apply this sanitization in the ensurePort443 function before logging the newAuthority.

+
+// handleCheck processes auth requests from Envoy
+func handleCheck(w http.ResponseWriter, r *http.Request) {
+	log.Printf("Check: %s %s %s", r.Method, r.URL.Path, r.UserAgent())


To fix the problem, we need to sanitize the user input before logging it. Since the log entries are plain text, we should remove any line breaks from the user input to prevent log forgery. We can use the strings.ReplaceAll function to replace newline characters with an empty string. This ensures that the user input cannot introduce new log entries or otherwise manipulate the log format.

We will apply this sanitization to the r.URL.Path value before logging it on line 189. Additionally, we will sanitize the authority value before logging it on lines 197 and 199.

+
+// handleCheck processes auth requests from Envoy
+func handleCheck(w http.ResponseWriter, r *http.Request) {
+	log.Printf("Check: %s %s %s", r.Method, r.URL.Path, r.UserAgent())


To fix the problem, we need to sanitize the user agent string before logging it. This can be done by removing any newline characters from the user agent string to prevent log forgery. We can use the strings.ReplaceAll function to replace newline characters with an empty string. This ensures that the user agent string is safe to log.

The changes should be made in the handleCheck function where the user agent string is logged. Specifically, we need to sanitize the r.UserAgent() value before including it in the log entry.

+		authority = r.Host
+		log.Printf("No :authority header found, using Host header: %s", authority)
+	}
+	log.Printf("Received Authority header: %s", authority)


To fix the problem, we need to sanitize the authority value before logging it. This can be done by removing any newline characters from the authority string to prevent log forgery. We will use the strings.ReplaceAll function to replace newline characters with an empty string. This ensures that the log entries are safe and cannot be manipulated by malicious users.

+
+func addHeader(w http.ResponseWriter, headerName, headerValue string, logValue bool) {
+	if logValue {
+		log.Printf("Adding header: %s=%s", headerName, headerValue)


To fix the problem, we need to sanitize the user input before logging it. Specifically, we should remove any newline characters from the headerValue to prevent log forgery. This can be achieved using the strings.ReplaceAll function to replace newline characters with an empty string. We should apply this sanitization in the addHeader function where the logging occurs.

erikburt · 2025-04-16T17:01:49Z

Closing in favour of #997 .

erikburt self-assigned this Apr 14, 2025

erikburt force-pushed the feat/setup-gap-authz branch 7 times, most recently from 880c25b to a7e016a Compare April 14, 2025 18:47