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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
|
#region Disclaimer / License
// Copyright (C) 2015, The Duplicati Team
// http://www.duplicati.com, info@duplicati.com
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
#endregion
using Duplicati.Library.Common.IO;
using Duplicati.Library.Interface;
using Renci.SshNet;
using Renci.SshNet.Common;
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
namespace Duplicati.Library.Backend
{
public class SSHv2 : IStreamingBackend, IRenameEnabledBackend
{
private const string SSH_KEYFILE_OPTION = "ssh-keyfile";
private const string SSH_KEYFILE_INLINE = "ssh-key";
private const string SSH_FINGERPRINT_OPTION = "ssh-fingerprint";
private const string SSH_FINGERPRINT_ACCEPT_ANY_OPTION = "ssh-accept-any-fingerprints";
public const string KEYFILE_URI = "sshkey://";
private const string SSH_TIMEOUT_OPTION = "ssh-operation-timeout";
private const string SSH_KEEPALIVE_OPTION = "ssh-keepalive";
readonly Dictionary<string, string> m_options;
private readonly string m_server;
private readonly string m_path;
private readonly string m_username;
private readonly string m_password;
private readonly string m_fingerprint;
private readonly bool m_fingerprintallowall;
private readonly TimeSpan m_operationtimeout;
private readonly TimeSpan m_keepaliveinterval;
private readonly int m_port = 22;
private SftpClient m_con;
public SSHv2()
{
}
public SSHv2(string url, Dictionary<string, string> options)
: this()
{
m_options = options;
var uri = new Utility.Uri(url);
uri.RequireHost();
if (options.ContainsKey("auth-username"))
m_username = options["auth-username"];
if (options.ContainsKey("auth-password"))
m_password = options["auth-password"];
if (options.ContainsKey(SSH_FINGERPRINT_OPTION))
m_fingerprint = options[SSH_FINGERPRINT_OPTION];
if (!string.IsNullOrEmpty(uri.Username))
m_username = uri.Username;
if (!string.IsNullOrEmpty(uri.Password))
m_password = uri.Password;
m_fingerprintallowall = Utility.Utility.ParseBoolOption(options, SSH_FINGERPRINT_ACCEPT_ANY_OPTION);
m_path = uri.Path;
if (!string.IsNullOrWhiteSpace(m_path))
{
m_path = Util.AppendDirSeparator(m_path, "/");
}
if (!m_path.StartsWith("/", StringComparison.Ordinal))
m_path = "/" + m_path;
m_server = uri.Host;
if (uri.Port > 0)
m_port = uri.Port;
string timeoutstr;
options.TryGetValue(SSH_TIMEOUT_OPTION, out timeoutstr);
if (!string.IsNullOrWhiteSpace(timeoutstr))
m_operationtimeout = Library.Utility.Timeparser.ParseTimeSpan(timeoutstr);
options.TryGetValue(SSH_KEEPALIVE_OPTION, out timeoutstr);
if (!string.IsNullOrWhiteSpace(timeoutstr))
m_keepaliveinterval = Library.Utility.Timeparser.ParseTimeSpan(timeoutstr);
}
#region IBackend Members
public void Test()
{
this.TestList();
}
public void CreateFolder()
{
CreateConnection();
// Since the SftpClient.CreateDirectory method does not create all the parent directories
// as needed, this has to be done manually.
string partialPath = String.Empty;
foreach (string part in m_path.Split('/').Where(x => !String.IsNullOrEmpty(x)))
{
partialPath += $"/{part}";
if (this.m_con.Exists(partialPath))
{
if (!this.m_con.GetAttributes(partialPath).IsDirectory)
{
throw new ArgumentException($"The path {partialPath} already exists and is not a directory.");
}
}
else
{
this.m_con.CreateDirectory(partialPath);
}
}
}
public string DisplayName => Strings.SSHv2Backend.DisplayName;
public string ProtocolKey => "ssh";
public Task PutAsync(string remotename, string filename, CancellationToken cancelToken)
{
using (System.IO.FileStream fs = System.IO.File.Open(filename, System.IO.FileMode.Open,
System.IO.FileAccess.Read, System.IO.FileShare.Read))
return PutAsync(remotename, fs, cancelToken);
}
public void Get(string remotename, string filename)
{
using (System.IO.FileStream fs = System.IO.File.Open(filename, System.IO.FileMode.Create,
System.IO.FileAccess.Write, System.IO.FileShare.None))
Get(remotename, fs);
}
public void Delete(string remotename)
{
try
{
CreateConnection();
ChangeDirectory(m_path);
m_con.DeleteFile(remotename);
}
catch (SftpPathNotFoundException ex)
{
throw new FileMissingException(ex);
}
}
public IList<ICommandLineArgument> SupportedCommands
{
get
{
return new List<ICommandLineArgument>(new ICommandLineArgument[]
{
new CommandLineArgument("auth-password", CommandLineArgument.ArgumentType.Password,
Strings.SSHv2Backend.DescriptionAuthPasswordShort,
Strings.SSHv2Backend.DescriptionAuthPasswordLong),
new CommandLineArgument("auth-username", CommandLineArgument.ArgumentType.String,
Strings.SSHv2Backend.DescriptionAuthUsernameShort,
Strings.SSHv2Backend.DescriptionAuthUsernameLong),
new CommandLineArgument(SSH_FINGERPRINT_OPTION, CommandLineArgument.ArgumentType.String,
Strings.SSHv2Backend.DescriptionFingerprintShort,
Strings.SSHv2Backend.DescriptionFingerprintLong),
new CommandLineArgument(SSH_FINGERPRINT_ACCEPT_ANY_OPTION, CommandLineArgument.ArgumentType.Boolean,
Strings.SSHv2Backend.DescriptionAnyFingerprintShort,
Strings.SSHv2Backend.DescriptionAnyFingerprintLong),
new CommandLineArgument(SSH_KEYFILE_OPTION, CommandLineArgument.ArgumentType.Path,
Strings.SSHv2Backend.DescriptionSshkeyfileShort,
Strings.SSHv2Backend.DescriptionSshkeyfileLong),
new CommandLineArgument(SSH_KEYFILE_INLINE, CommandLineArgument.ArgumentType.Password,
Strings.SSHv2Backend.DescriptionSshkeyShort,
Strings.SSHv2Backend.DescriptionSshkeyLong(KEYFILE_URI)),
new CommandLineArgument(SSH_TIMEOUT_OPTION, CommandLineArgument.ArgumentType.Timespan,
Strings.SSHv2Backend.DescriptionSshtimeoutShort, Strings.SSHv2Backend.DescriptionSshtimeoutLong,
"0"),
new CommandLineArgument(SSH_KEEPALIVE_OPTION, CommandLineArgument.ArgumentType.Timespan,
Strings.SSHv2Backend.DescriptionSshkeepaliveShort,
Strings.SSHv2Backend.DescriptionSshkeepaliveLong, "0"),
});
}
}
public string Description => Strings.SSHv2Backend.Description;
#endregion
#region IDisposable Members
public void Dispose()
{
if (m_con != null)
{
try
{
m_con.Dispose();
}
catch (System.Net.Sockets.SocketException)
{
//If the operating system sometimes close socket before disposal of connection following exception is thrown
//System.Net.Sockets.SocketException (0x80004005): An existing connection was forcibly closed by the remote host
}
finally
{
m_con = null;
}
}
}
#endregion
#region IStreamingBackend Implementation
public Task PutAsync(string remotename, System.IO.Stream stream, CancellationToken cancelToken)
{
CreateConnection();
ChangeDirectory(m_path);
m_con.UploadFile(stream, remotename);
return Task.FromResult(true);
}
public void Get(string remotename, System.IO.Stream stream)
{
CreateConnection();
ChangeDirectory(m_path);
m_con.DownloadFile(remotename, stream);
}
#endregion
#region IRenameEnabledBackend Implementation
public void Rename(string source, string target)
{
CreateConnection();
ChangeDirectory(m_path);
m_con.RenameFile(source, target);
}
#endregion
#region Implementation
private void CreateConnection()
{
if (m_con != null && m_con.IsConnected)
return;
if (m_con != null && !m_con.IsConnected)
{
this.TryConnect(m_con);
return;
}
SftpClient con;
m_options.TryGetValue(SSH_KEYFILE_OPTION, out var keyFile);
if (string.IsNullOrWhiteSpace(keyFile))
{
m_options.TryGetValue(SSH_KEYFILE_INLINE, out keyFile);
}
if (!string.IsNullOrWhiteSpace(keyFile))
{
con = new SftpClient(m_server, m_port, m_username, ValidateKeyFile(keyFile, m_password));
}
else
{
con = new SftpClient(m_server, m_port, m_username, m_password ?? string.Empty);
}
con.HostKeyReceived += (sender, e) =>
{
e.CanTrust = false;
if (m_fingerprintallowall)
{
e.CanTrust = true;
return;
}
var hostFingerprint =
$"{e.HostKeyName} {e.KeyLength.ToString()} {BitConverter.ToString(e.FingerPrint).Replace('-', ':')}";
if (string.IsNullOrEmpty(m_fingerprint))
throw new Library.Utility.HostKeyException(
Strings.SSHv2Backend.FingerprintNotSpecifiedManagedError(
hostFingerprint.ToLower(CultureInfo.InvariantCulture), SSH_FINGERPRINT_OPTION,
SSH_FINGERPRINT_ACCEPT_ANY_OPTION),
hostFingerprint, m_fingerprint);
if (!string.Equals(hostFingerprint, m_fingerprint, StringComparison.OrdinalIgnoreCase))
throw new Library.Utility.HostKeyException(
Strings.SSHv2Backend.FingerprintNotMatchManagedError(
hostFingerprint.ToLower(CultureInfo.InvariantCulture)),
hostFingerprint, m_fingerprint);
e.CanTrust = true;
};
if (m_operationtimeout.Ticks != 0)
con.OperationTimeout = m_operationtimeout;
if (m_keepaliveinterval.Ticks != 0)
con.KeepAliveInterval = m_keepaliveinterval;
this.TryConnect(con);
m_con = con;
}
private void TryConnect(SftpClient client)
{
try
{
client.Connect();
}
catch (NotImplementedException)
{
// SSH.NET relies on the System.Security.Cryptography.ECDsaCng class for
// ECDSA algorithms, which is not implemented in Mono (as of 6.12.0.144).
// This prevents clients from connecting if one of the ECDSA algorithms is
// chosen as the host key algorithm. In the event that this causes a
// connection failure, we will prevent the client from advertising support
// for ECDSA algorithms and make another connection attempt.
//
// See https://github.com/mono/mono/blob/mono-6.12.0.144/mcs/class/referencesource/System.Core/System/Security/Cryptography/ECDsaCng.cs
if (Utility.Utility.IsMono)
{
List<string> ecdsaKeys = client.ConnectionInfo.HostKeyAlgorithms.Keys.Where(x => x.StartsWith("ecdsa")).ToList();
foreach (string key in ecdsaKeys)
{
client.ConnectionInfo.HostKeyAlgorithms.Remove(key);
}
client.Connect();
}
else
{
throw;
}
}
}
private void ChangeDirectory(string path)
{
if (string.IsNullOrEmpty(path))
return;
var workingDir = Util.AppendDirSeparator(m_con.WorkingDirectory, "/");
if (workingDir == path)
return;
try
{
m_con.ChangeDirectory(path);
}
catch (Exception ex)
{
throw new Interface.FolderMissingException(
Strings.SSHv2Backend.FolderNotFoundManagedError(path, ex.Message), ex);
}
}
public IEnumerable<IFileEntry> List()
{
string path = ".";
CreateConnection();
ChangeDirectory(m_path);
foreach (var ls in m_con.ListDirectory(path))
{
if (ls.Name.ToString() == "." || ls.Name.ToString() == "..") continue;
yield return new FileEntry(ls.Name, ls.Length,
ls.LastAccessTime, ls.LastWriteTime) {IsFolder = ls.Attributes.IsDirectory};
}
}
private static Renci.SshNet.PrivateKeyFile ValidateKeyFile(string filename, string password)
{
try
{
if (!filename.StartsWith(KEYFILE_URI, StringComparison.OrdinalIgnoreCase))
{
return String.IsNullOrEmpty(password)
? new PrivateKeyFile(filename)
: new PrivateKeyFile(filename, password);
}
using (var ms = new System.IO.MemoryStream())
using (var sr = new System.IO.StreamWriter(ms))
{
sr.Write(Utility.Uri.UrlDecode(filename.Substring(KEYFILE_URI.Length)));
sr.Flush();
ms.Position = 0;
return String.IsNullOrEmpty(password) ? new PrivateKeyFile(ms) : new PrivateKeyFile(ms, password);
}
}
catch (Exception ex)
{
throw new UserInformationException(
"Failed to parse the keyfile, check the key format and passphrase. " +
$"Error message was {ex.Message}",
"SSHFailedToParseKeyFile", ex);
}
}
#endregion
internal SftpClient Client
{
get { return m_con; }
}
public string[] DNSName
{
get { return new[] {m_server}; }
}
}
}
|