forked from saddam1999/MagicCFG
-
Notifications
You must be signed in to change notification settings - Fork 0
/
SSH.swift
269 lines (228 loc) · 9.36 KB
/
SSH.swift
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
//
// SSH.swift
// Shout
//
// Created by Jake Heiser on 3/4/18.
//
import Foundation
import Socket
/// Manages an SSH session
public class SSH {
public enum PtyType: String {
case vanilla
case vt100
case vt102
case vt220
case ansi
case xterm
}
/// Connects to a remote server and opens an SSH session
///
/// - Parameters:
/// - host: the host to connect to
/// - port: the port to connect to; default 22
/// - username: the username to login with
/// - authMethod: the authentication method to use while logging in
/// - execution: the block executed with the open, authenticated SSH session
/// - Throws: SSHError if the session fails at any point
public static func connect(host: String, port: Int32 = 22, username: String, authMethod: SSHAuthMethod, execution: (_ ssh: SSH) throws -> ()) throws {
let ssh = try SSH(host: host, port: port)
try ssh.authenticate(username: username, authMethod: authMethod)
try execution(ssh)
}
let session: Session
private let sock: Socket
public var ptyType: PtyType? = nil
/// Creates a new SSH session
///
/// - Parameters:
/// - host: the host to connect to
/// - port: the port to connect to; default 22
/// - Throws: SSHError if the SSH session couldn't be created
public init(host: String, port: Int32 = 22) throws {
self.sock = try Socket.create()
self.session = try Session()
session.blocking = 1
try sock.connect(to: host, port: port)
try session.handshake(over: sock)
}
/// Authenticate the session using a public/private key pair
///
/// - Parameters:
/// - username: the username to login with
/// - privateKey: the path to the private key
/// - publicKey: the path to the public key; defaults to private key path + ".pub"
/// - passphrase: the passphrase encrypting the key; defaults to nil
/// - Throws: SSHError if authentication fails
public func authenticate(username: String, privateKey: String, publicKey: String? = nil, passphrase: String? = nil) throws {
let key = SSHKey(privateKey: privateKey, publicKey: publicKey, passphrase: passphrase)
try authenticate(username: username, authMethod: key)
}
/// Authenticate the session using a password
///
/// - Parameters:
/// - username: the username to login with
/// - password: the user's password
/// - Throws: SSHError if authentication fails
public func authenticate(username: String, password: String) throws {
try authenticate(username: username, authMethod: SSHPassword(password))
}
/// Authenticate the session using the SSH agent
///
/// - Parameter username: the username to login with
/// - Throws: SSHError if authentication fails
public func authenticateByAgent(username: String) throws {
try authenticate(username: username, authMethod: SSHAgent())
}
/// Authenticate the session using the given authentication method
///
/// - Parameters:
/// - username: the username to login with
/// - authMethod: the authentication method to use
/// - Throws: SSHError if authentication fails
public func authenticate(username: String, authMethod: SSHAuthMethod) throws {
try authMethod.authenticate(ssh: self, username: username)
}
/// Execute a command on the remote server
///
/// - Parameters:
/// - command: the command to execute
/// - silent: whether or not to execute the command silently; defaults to false
/// - Returns: exit code of the command
/// - Throws: SSHError if the command couldn't be executed
@discardableResult
public func execute(_ command: String, silent: Bool = false) throws -> Int32 {
return try execute(command, output: { (output) in
if silent == false {
print(output, terminator: "")
fflush(stdout)
}
})
}
/// Execute a command on the remote server and capture the output
///
/// - Parameter command: the command to execute
/// - Returns: a tuple with the exit code of the command and the output of the command
/// - Throws: SSHError if the command couldn't be executed
public func capture(_ command: String) throws -> (status: Int32, output: String) {
var ongoing = ""
let status = try execute(command) { (output) in
ongoing += output
}
return (status, ongoing)
}
public func capture_data(_ command: String) throws -> (status: Int32, output: Data) {
var ongoing = Data()
let status = try execute_data(command) { (output) in
ongoing += output
}
return (status, ongoing)
}
/// Execute a command on the remote server
///
/// - Parameters:
/// - command: the command to execute
/// - output: block handler called every time a chunk of command output is received
/// - Returns: exit code of the command
/// - Throws: SSHError if the command couldn't be executed
public func execute_data(_ command: String, output: ((_ output: Data) -> ())) throws -> Int32 {
let channel = try session.openCommandChannel()
if let ptyType = ptyType {
try channel.requestPty(type: ptyType.rawValue)
}
try channel.exec(command: command)
var dataLeft = true
while dataLeft {
switch channel.readData() {
case .data(let data):
output(data)
case .done:
dataLeft = false
case .eagain:
break
case .error(let error):
throw error
}
}
try channel.close()
return channel.exitStatus()
}
public func execute(_ command: String, output: ((_ output: String) -> ())) throws -> Int32 {
let channel = try session.openCommandChannel()
if let ptyType = ptyType {
try channel.requestPty(type: ptyType.rawValue)
}
try channel.exec(command: command)
var dataLeft = true
while dataLeft {
switch channel.readData() {
case .data(let data):
guard let str = String(data: data, encoding: .ascii) else {
throw SSHError.genericError("SSH failed to create string using UTF8 encoding")
}
output(str)
case .done:
dataLeft = false
case .eagain:
break
case .error(let error):
throw error
}
}
try channel.close()
return channel.exitStatus()
}
/// Upload a file from the local device to the remote server
///
/// - Parameters:
/// - localURL: the path to the existing file on the local device
/// - remotePath: the location on the remote server whether the file should be uploaded to
/// - permissions: the file permissions to create the new file with; defaults to FilePermissions.default
/// - Throws: SSHError if local file can't be read or upload fails
@discardableResult
public func sendFile(localURL: URL, remotePath: String, permissions: FilePermissions = .default) throws -> Int32 {
guard let resources = try? localURL.resourceValues(forKeys: [.fileSizeKey]),
let fileSize = resources.fileSize,
let inputStream = InputStream(url: localURL) else {
throw SSHError.genericError("couldn't open file at \(localURL)")
}
let channel = try session.openSCPChannel(fileSize: Int64(fileSize), remotePath: remotePath, permissions: permissions)
inputStream.open()
defer { inputStream.close() }
let bufferSize = Int(Channel.packetDefaultSize)
var buffer = Data(capacity: bufferSize)
while inputStream.hasBytesAvailable {
let bytesRead: Int = try buffer.withUnsafeMutableBytes {
guard let pointer = $0.bindMemory(to: UInt8.self).baseAddress else {
throw SSHError.genericError("SSH write failed to bind buffer memory")
}
return inputStream.read(pointer, maxLength: bufferSize)
}
if bytesRead == 0 { break }
var bytesSent = 0
while bytesSent < bytesRead {
let chunk = bytesSent == 0 ? buffer : buffer.advanced(by: bytesSent)
switch channel.write(data: chunk, length: bytesRead - bytesSent) {
case .written(let count):
bytesSent += count
case .eagain:
break
case .error(let error):
throw error
}
}
}
try channel.sendEOF()
try channel.waitEOF()
try channel.close()
try channel.waitClosed()
return channel.exitStatus()
}
/// Open an SFTP session with the remote server
///
/// - Returns: the opened SFTP session
/// - Throws: SSHError if an SFTP session could not be opened
public func openSftp() throws -> SFTP {
return try session.openSftp()
}
}