CSHARP-734: SOCKS5 Proxy Support

build.cake

@@ -218,6 +218,10 @@ Task("TestLoadBalanced")
 Task("TestLoadBalancedNetStandard21").IsDependentOn("TestLoadBalanced");
 Task("TestLoadBalancedNet60").IsDependentOn("TestLoadBalanced");
 
+Task("TestSocks5ProxyNet472").IsDependentOn("TestSocks5Proxy");
+Task("TestSocks5ProxyNetStandard21").IsDependentOn("TestSocks5Proxy");
+Task("TestSocks5ProxyNet60").IsDependentOn("TestSocks5Proxy");
+
 Task("TestCsfleWithMockedKms")
     .IsDependentOn("TestLibMongoCrypt")
     .DoesForEach(
@@ -263,6 +267,13 @@ Task("TestX509")
 
 Task("TestX509Net60").IsDependentOn("TestX509");
 
+Task("TestSocks5Proxy")
+    .IsDependentOn("Build")
+    .DoesForEach(
+        items: GetFiles("./**/*.Tests.csproj"),
+        action: (BuildConfig buildConfig, Path testProject) =>
+            RunTests(buildConfig, testProject, filter: "Category=\"Socks5Proxy\""));
+
 Task("Package")
     .IsDependentOn("PackageNugetPackages");
 

evergreen/cleanup-test-resources.sh

@@ -13,5 +13,29 @@ else
   ps -ax | grep mongocryptd
   pkill -f 'mongocryptd' || echo 'mongocryptd was already killed or not launched'
   # check that it's actually killed
-  ps -ax | grep mongocryptd 
+  ps -ax | grep mongocryptd
 fi
+
+# The proxy server processes have almost certainly already been killed by the evergreen process cleaning though.
+# This is just to be sure it already happened and delete the file containing the saved PIDs.
+
+echo "Attempting to kill proxy servers if present and deleting PID file."
+PID_FILE="socks5_pids.txt"
+
+if [[ ! -f "$PID_FILE" ]]; then
+  echo "No PID file found ($PID_FILE)"
+  exit 0
+fi
+
+cat "$PID_FILE" | while read -r pid; do
+  if [[ -n "$pid" ]]; then
+    if [[ "$OS" =~ Windows|windows ]]; then
+      powershell -NoProfile -Command "Stop-Process -Id $pid -Force" 2>$null || \
+        echo "PID $pid already gone"
+    else
+      kill "$pid" 2>/dev/null || echo "PID $pid already gone"
+    fi
+  fi
+done
+
+rm -f "$PID_FILE"

evergreen/evergreen.yml

@@ -1069,6 +1069,44 @@ functions:
           TARGET="TestX509" \
             evergreen/run-tests.sh
 
+  setup-socks5-proxy:
+    - command: shell.exec
+      params:
+        background: true
+        script: |
+          ${PREPARE_SHELL}
+          MONGODB_URI="${MONGODB_URI}"
+          # Read the MongoDB URI connection string and extract an arbitrary member's host:port
+          HOST_PORT=$(echo "$MONGODB_URI" | sed 's|mongodb://||' | cut -d',' -f1)
+
+          MAP_ARG="localhost:12345 to $HOST_PORT"
+          python3 $DRIVERS_TOOLS/.evergreen/socks5srv.py --map "$MAP_ARG" --port 1080 --auth username:p4ssw0rd & PROXY_PID1=$!
+          python3 $DRIVERS_TOOLS/.evergreen/socks5srv.py --map "$MAP_ARG" --port 1081 & PROXY_PID2=$!
+
+          echo "$PROXY_PID1" > socks5_pids.txt
+          echo "$PROXY_PID2" >> socks5_pids.txt
+
+          echo "Started proxies with PIDs: $PROXY_PID1, $PROXY_PID2"
+
+  run-socks5-proxy-tests:
+    - command: shell.exec
+      type: test
+      params:
+        working_dir: "mongo-csharp-driver"
+        shell: "bash"
+        script: |
+          export SOCKS5_PROXY_SERVERS_ENABLED=true
+          ${PREPARE_SHELL}
+          OS=${OS} \
+            evergreen/add-ca-certs.sh
+          SSL=${SSL} \
+          MONGODB_URI="${MONGODB_URI}" \
+          TOPOLOGY=${TOPOLOGY} \
+          OS=${OS} \
+          FRAMEWORK=${FRAMEWORK} \
+          TARGET="TestSocks5Proxy" \
+            evergreen/run-tests.sh
+
 pre:
   - func: fetch-source
   - func: prepare-resources
@@ -1237,6 +1275,30 @@ tasks:
           vars:
             FRAMEWORK: net60
 
+    - name: test-socks5-proxy-net472
+      commands:
+        - func: bootstrap-mongo-orchestration
+        - func: setup-socks5-proxy
+        - func: run-socks5-proxy-tests
+          vars:
+            FRAMEWORK: net472
+
+    - name: test-socks5-proxy-netstandard21
+      commands:
+        - func: bootstrap-mongo-orchestration
+        - func: setup-socks5-proxy
+        - func: run-socks5-proxy-tests
+          vars:
+            FRAMEWORK: netstandard21
+
+    - name: test-socks5-proxy-net60
+      commands:
+        - func: bootstrap-mongo-orchestration
+        - func: setup-socks5-proxy
+        - func: run-socks5-proxy-tests
+          vars:
+            FRAMEWORK: net60
+
     - name: plain-auth-tests
       commands:
         - func: run-plain-auth-tests
@@ -2531,6 +2593,29 @@ buildvariants:
   tasks:
     - name: atlas-search-index-helpers-task-group
 
+# Socks5 Proxy tests
+- matrix_name: "socks5-proxy-tests-linux"
+  matrix_spec: { os: "ubuntu-2004", ssl: ["nossl", "ssl"], version: ["latest"], topology: ["replicaset"] }
+  display_name: "Socks5 Proxy ${version} ${os} ${ssl}"
+  tasks:
+    - name: test-socks5-proxy-netstandard21
+    - name: test-socks5-proxy-net60
+
+- matrix_name: "socks5-proxy-tests-windows"
+  matrix_spec: { os: "windows-64", ssl: ["nossl", "ssl"], version: ["latest"], topology: ["replicaset"] }
+  display_name: "Socks5 Proxy ${version} ${os} ${ssl}"
+  tasks:
+    - name: test-socks5-proxy-net472
+    - name: test-socks5-proxy-netstandard21
+    - name: test-socks5-proxy-net60
+
+- matrix_name: "socks5-proxy-tests-macos"
+  matrix_spec: { os: "macos-14", ssl: ["nossl", "ssl"], version: ["latest"], topology: ["replicaset"] }
+  display_name: "Socks5 Proxy ${version} ${os} ${ssl}"
+  tasks:
+    - name: test-socks5-proxy-netstandard21
+    - name: test-socks5-proxy-net60
+
 # CSFLE tests
 - matrix_name: "csfle-with-mocked-kms-tests-windows"
   matrix_spec: { os: "windows-64", ssl: "nossl", version: ["4.2", "4.4", "5.0", "6.0", "7.0", "8.0", "rapid", "latest"], topology: ["replicaset"] }

specifications/uri-options/tests/proxy-options.json

@@ -0,0 +1,139 @@
+{
+  "tests": [
+    {
+      "description": "proxyPort without proxyHost",
+      "uri": "mongodb://localhost/?proxyPort=1080",
+      "valid": false,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": null
+    },
+    {
+      "description": "proxyUsername without proxyHost",
+      "uri": "mongodb://localhost/?proxyUsername=abc",
+      "valid": false,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": null
+    },
+    {
+      "description": "proxyPassword without proxyHost",
+      "uri": "mongodb://localhost/?proxyPassword=def",
+      "valid": false,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": null
+    },
+    {
+      "description": "all other proxy options without proxyHost",
+      "uri": "mongodb://localhost/?proxyPort=1080&proxyUsername=abc&proxyPassword=def",
+      "valid": false,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": null
+    },
+    {
+      "description": "proxyUsername without proxyPassword",
+      "uri": "mongodb://localhost/?proxyHost=localhost&proxyUsername=abc",
+      "valid": false,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": null
+    },
+    {
+      "description": "proxyPassword without proxyUsername",
+      "uri": "mongodb://localhost/?proxyHost=localhost&proxyPassword=def",
+      "valid": false,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": null
+    },
+    {
+      "description": "multiple proxyHost parameters",
+      "uri": "mongodb://localhost/?proxyHost=localhost&proxyHost=localhost2",
+      "valid": false,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": null
+    },
+    {
+      "description": "multiple proxyPort parameters",
+      "uri": "mongodb://localhost/?proxyHost=localhost&proxyPort=1234&proxyPort=12345",
+      "valid": false,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": null
+    },
+    {
+      "description": "multiple proxyUsername parameters",
+      "uri": "mongodb://localhost/?proxyHost=localhost&proxyUsername=abc&proxyUsername=def&proxyPassword=123",
+      "valid": false,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": null
+    },
+    {
+      "description": "multiple proxyPassword parameters",
+      "uri": "mongodb://localhost/?proxyHost=localhost&proxyUsername=abc&proxyPassword=123&proxyPassword=456",
+      "valid": false,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": null
+    },
+    {
+      "description": "only host present",
+      "uri": "mongodb://localhost/?proxyHost=localhost",
+      "valid": true,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": {}
+    },
+    {
+      "description": "host and default port present",
+      "uri": "mongodb://localhost/?proxyHost=localhost&proxyPort=1080",
+      "valid": true,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": {}
+    },
+    {
+      "description": "host and non-default port present",
+      "uri": "mongodb://localhost/?proxyHost=localhost&proxyPort=12345",
+      "valid": true,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": {}
+    },
+    {
+      "description": "replicaset, host and non-default port present",
+      "uri": "mongodb://rs1,rs2,rs3/?proxyHost=localhost&proxyPort=12345",
+      "valid": true,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": {}
+    },
+    {
+      "description": "all options present",
+      "uri": "mongodb://rs1,rs2,rs3/?proxyHost=localhost&proxyPort=12345&proxyUsername=asdf&proxyPassword=qwerty",
+      "valid": true,
+      "warning": false,
+      "hosts": null,
+      "auth": null,
+      "options": {}
+    }
+  ]
+}