[sshd] Add GatewayPorts option (#1464)

add gatewayports option to sshd

Author: lzhou-lilly

src/sshd/README.md

@@ -15,6 +15,7 @@ Adds a SSH server into a container so that you can use an external terminal, sft
 
 | Options Id | Description | Type | Default Value |
 |-----|-----|-----|-----|
+| gatewayPorts | Enable other hosts in the same network to connect to the forwarded ports | string | no
 | version | Currently unused. | string | latest |
 
 ## Usage

src/sshd/devcontainer-feature.json

@@ -1,6 +1,6 @@
 {
     "id": "sshd",
-    "version": "1.0.10",
+    "version": "1.1.0",
     "name": "SSH server",
     "documentationURL": "https://github.com/devcontainers/features/tree/main/src/sshd",
     "description": "Adds a SSH server into a container so that you can use an external terminal, sftp, or SSHFS to interact with it.",
@@ -12,6 +12,16 @@
             ],
             "default": "latest",
             "description": "Currently unused."
+        },
+        "gatewayPorts": {
+            "type": "string",
+            "enum": [
+                "no",
+                "yes",
+                "clientspecified"
+            ],
+            "default": "no",
+            "description": "Enable other hosts in the same network to connect to the forwarded ports"
         }
     },
     "entrypoint": "/usr/local/share/ssh-init.sh",

src/sshd/install.sh

@@ -13,6 +13,7 @@ SSHD_PORT="${SSHD_PORT:-"2222"}"
 USERNAME="${USERNAME:-"${_REMOTE_USER:-"automatic"}"}"
 START_SSHD="${START_SSHD:-"false"}"
 NEW_PASSWORD="${NEW_PASSWORD:-"skip"}"
+GATEWAY_PORTS="${GATEWAYPORTS:-"no"}" 
 
 set -e
 
@@ -89,6 +90,7 @@ mkdir -p /var/run/sshd
 sed -i 's/session\s*required\s*pam_loginuid\.so/session optional pam_loginuid.so/g' /etc/pam.d/sshd
 sed -i 's/#*PermitRootLogin prohibit-password/PermitRootLogin yes/g' /etc/ssh/sshd_config
 sed -i -E "s/#*\s*Port\s+.+/Port ${SSHD_PORT}/g" /etc/ssh/sshd_config
+sed -i "s/#GatewayPorts no/GatewayPorts ${GATEWAY_PORTS}/g" /etc/ssh/sshd_config
 # Need to UsePAM so /etc/environment is processed
 sed -i -E "s/#?\s*UsePAM\s+.+/UsePAM yes/g" /etc/ssh/sshd_config
 

test/sshd/scenarios.json

@@ -0,0 +1,18 @@
+{
+    "sshd_with_default_gateway_ports": {
+        "image": "ubuntu:noble",
+        "features": {
+            "sshd": {
+                "gatewayPorts": "no"
+            }
+        }
+    },
+    "sshd_with_pinned_gateway_ports_clientspecified": {
+        "image": "ubuntu:noble",
+        "features": {
+            "sshd": {
+                "gatewayPorts": "clientspecified"
+            }
+        }
+    }                                                           
+}

test/sshd/sshd_with_default_gateway_ports.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+# Definition specific tests
+check "correct default GatewayPorts" grep "GatewayPorts no" /etc/ssh/sshd_config
+
+# Report result
+reportResults

test/sshd/sshd_with_pinned_gateway_ports_clientspecified.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+# Definition specific tests
+check "correct default GatewayPorts" grep "GatewayPorts clientspecified" /etc/ssh/sshd_config
+
+# Report result
+reportResults