https://github.com/gaetanzanella/swift-ssh-client
High-level SSH client interfaces using SwiftNIO SSH
https://github.com/gaetanzanella/swift-ssh-client
ios macos sftp-client ssh swift-nio
Last synced: about 2 months ago
JSON representation
High-level SSH client interfaces using SwiftNIO SSH
- Host: GitHub
- URL: https://github.com/gaetanzanella/swift-ssh-client
- Owner: gaetanzanella
- License: mit
- Created: 2022-11-19T14:46:05.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-16T20:00:48.000Z (over 2 years ago)
- Last Synced: 2025-06-25T15:51:36.572Z (12 months ago)
- Topics: ios, macos, sftp-client, ssh, swift-nio
- Language: Swift
- Homepage:
- Size: 152 KB
- Stars: 24
- Watchers: 2
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: License.txt
Awesome Lists containing this project
README
# Swift SSH Client
This project provides high-level SSH client interfaces using [SwiftNIO SSH](https://github.com/apple/swift-nio-ssh).
## Requirements
`Swift SSH Client` is compatible with iOS 13.0+ and macOS 10.5+.
## Getting started
SSH is a multiplexed protocol: each SSH connection is subdivided into multiple bidirectional communication channels.
`Swift SSH Client` reflects this pattern. The first step is to set a connection up:
```swift
let connection = SSHConnection(
host: "my_host",
port: my_port,
authentication: SSHAuthentication(
username: "my_username",
method: .password(.init("my_password")),
hostKeyValidation: .acceptAll()
)
)
try await connection.start()
```
Once connected, you can start executing concrete SSH operations on child communication channels.
As `SSH Client` means to be a high level interface, you do not directly interact with them.
Instead you use interfaces dedicated to your use case.
- SSH commands
```swift
let response = try await connection.execute("echo Hello\n")
// Handle response
for try await chunk in connection.stream("echo World\n") {
// Handle chunk
}
```
- SSH shell
```swift
let shell = try await connection.requestShell()
for try await chunk in shell.data {
// Handle chunk
}
```
- SFTP client
```swift
let sftpClient = try await connection.requestSFTPClient()
// directories
try await sftpClient.createDirectory(at: "./new")
try await sftpClient.removeDirectory(at: "./new")
// files
let file = try await client.openFile(at: "./new/file.txt", flags: .create)
try await file.write("Hello World!".data(using: .utf8)!)
try await file.close()
// and more
```
You keep track of the connection state, using the dedicated `stateUpdateHandler` property:
```swift
connection.stateUpdateHandle = { state in
switch state {
case .idle, .failed:
// Handle disconnection
case .ready:
// Handle connection start
}
}
```
As `SSHConnection` represents the overall SSH connection, if it ends, all the SSH operations or clients linked to it will end accordingly.
## Beta version
Consider the `0.1` version as a beta version. From patch to patch, the project API can change a lot.
## License
`Swift SSH Client` is available under the MIT license. See the `LICENSE.txt` file for more info.