chore: configure codeql vulnerability scanning (#170)

Author: Kenneth Rosario

.github/workflows/codeql.yml

@@ -0,0 +1,46 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "master" ]
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+        languages: go
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:go"

funcframework/events.go

@@ -217,7 +217,7 @@ func encodeData(d interface{}) ([]byte, error) {
 // associated with the given CloudEvent service. See ceServiceToResourceRe for the regexp
 // mapping. For example,
 //
-//   "projects/_/buckets/some-bucket/objects/folder/test.txt"
+//	"projects/_/buckets/some-bucket/objects/folder/test.txt"
 //
 // would be split to create the strings "projects/_/buckets/some-bucket"
 // and "objects/folder/test.txt". This function returns the resource string, the

internal/events/pubsub/pubsub.go

@@ -4,6 +4,7 @@ package pubsub
 import (
 	"fmt"
 	"regexp"
+	"strings"
 	"time"
 
 	"cloud.google.com/go/functions/metadata"
@@ -50,8 +51,11 @@ func ExtractTopicFromRequestPath(path string) (string, error) {
 	re := regexp.MustCompile(`(projects\/[^/?]+\/topics\/[^/?]+)/*`)
 	matches := re.FindStringSubmatch(path)
 	if matches == nil {
+		// Prevent log injection by removing newline characters in path
+		replacer := strings.NewReplacer("\n", "", "\r", "")
+		escapedPath := replacer.Replace(path)
 		return "", fmt.Errorf("failed to extract Pub/Sub topic name from the URL request path: %q, configure your subscription's push endpoint to use the following path pattern: 'projects/PROJECT_NAME/topics/TOPIC_NAME'",
-			path)
+			escapedPath)
 	}
 
 	// Index 0 is the entire input string matched, index 1 is the first submatch