Merge branch 'main' into jo/direct-tcpip-server

Author: Joannis

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: Joannis
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Reproducer Sample**
+Code that reproduces the issue. Omit credentials.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Client (please complete the following information):**
+ - OS: [e.g. iOS, macOS Sonoma, Ubuntu 23.04]
+ - Client: [e.g. openssh, Citadel]
+- Version of Citadel, if applicable:
+
+**Server (please complete the following information):**
+ - OS: [e.g. iOS, macOS Sonoma, Ubuntu 23.04]
+ - Server: [e.g. opensshd, Citadel]
+- Version of Citadel, if applicable:
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: Joannis
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context about the feature request here.

.github/workflows/test.yml

@@ -0,0 +1,39 @@
+name: test
+concurrency:
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: true
+on:
+    pull_request: { types: [opened, reopened, synchronize, ready_for_review] }
+    push: { branches: [main] }
+
+env:
+    LOG_LEVEL: info
+    SWIFT_DETERMINISTIC_HASHING: 1
+jobs:
+    test:
+        services:
+            ssh-server:
+                image: lscr.io/linuxserver/openssh-server:latest
+                ports:
+                    - 2222:2222
+                env:
+                    USER_NAME: citadel
+                    USER_PASSWORD: hunter2
+                    PASSWORD_ACCESS: true
+        runs-on: ubuntu-latest
+        container: 
+          image: swift:5.10-jammy
+          env:
+            SWIFT_DETERMINISTIC_HASHING: 1
+        steps:
+            - uses: actions/checkout@v4
+            - name: Resolve
+              run: swift package resolve
+            - name: Run tests
+              run: swift test
+              env:
+                SWIFT_DETERMINISTIC_HASHING: 1
+                SSH_HOST: ssh-server
+                SSH_PORT: 2222
+                SSH_USERNAME: citadel
+                SSH_PASSWORD: hunter2

Examples/ExampleClient/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+/.build
+/Packages
+xcuserdata/
+DerivedData/
+.swiftpm/configuration/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc

Examples/ExampleClient/.vscode/launch.json

@@ -0,0 +1,24 @@
+{
+  "configurations": [
+    {
+      "type": "lldb",
+      "request": "launch",
+      "sourceLanguages": ["swift"],
+      "args": [],
+      "cwd": "${workspaceFolder:ExampleClient}",
+      "name": "Debug ExampleClient",
+      "program": "${workspaceFolder:ExampleClient}/.build/debug/ExampleClient",
+      "preLaunchTask": "swift: Build Debug ExampleClient"
+    },
+    {
+      "type": "lldb",
+      "request": "launch",
+      "sourceLanguages": ["swift"],
+      "args": [],
+      "cwd": "${workspaceFolder:ExampleClient}",
+      "name": "Release ExampleClient",
+      "program": "${workspaceFolder:ExampleClient}/.build/release/ExampleClient",
+      "preLaunchTask": "swift: Build Release ExampleClient"
+    }
+  ]
+}

Examples/ExampleClient/ExampleServer.dockerfile

@@ -0,0 +1,13 @@
+FROM ubuntu:latest
+
+RUN apt update && apt install  openssh-server sudo -y
+
+RUN useradd -rm -d /home/ubuntu -s /bin/bash -g root -G sudo -u 1000 test 
+
+RUN  echo 'test:test' | chpasswd
+
+RUN service ssh start
+
+EXPOSE 22
+
+CMD ["/usr/sbin/sshd","-D"]

Examples/ExampleClient/Package.swift

@@ -0,0 +1,24 @@
+// swift-tools-version: 5.9
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "ExampleClient",
+    platforms: [
+        .macOS(.v12),  
+    ],
+    dependencies: [
+        .package(path: "../../"),
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package, defining a module or a test suite.
+        // Targets can depend on other targets in this package and products from dependencies.
+        .executableTarget(
+            name: "ExampleClient",
+            dependencies: [
+                .product(name: "Citadel", package: "Citadel"),
+            ]
+        ),
+    ]
+)

Examples/ExampleClient/README.md

@@ -0,0 +1,3 @@
+1. Build the dockerfile using `docker build --file ExampleServer.dockerfile --tag sshd-example .`
+2. Run the docker image using `docker run -p 2323:22 sshd-example`
+3. Run this Swift code to connect tom the server and run a command using `swift run`

Examples/ExampleClient/Sources/main.swift

@@ -0,0 +1,12 @@
+import Citadel
+
+let client = try await SSHClient.connect(
+    host: "localhost", 
+    port: 2323,
+    authenticationMethod: .passwordBased(username: "test", password: "test"),
+    hostKeyValidator: .acceptAnything(),
+    reconnect: .never
+)
+
+let result = try await client.executeCommand("echo 'Hello, World!'")
+print(String(buffer: result))

Examples/OpenSSH/Dockerfile

@@ -0,0 +1,12 @@
+
+FROM ubuntu:latest
+
+RUN apt update && apt install openssh-server sudo -y
+
+RUN echo "ubuntu:test" | chpasswd
+
+RUN service ssh start
+
+EXPOSE 22
+
+CMD ["/usr/sbin/sshd","-D"]