Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathSsh2Client.cpp
More file actions
612 lines (538 loc) · 19.1 KB
/
Copy pathSsh2Client.cpp
File metadata and controls
612 lines (538 loc) · 19.1 KB
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
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
/*
MIT License
Copyright (c) 2020 Mikhail Milovidov
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
#include "Ssh2Client.h"
#include "Ssh2Channel.h"
#include "Ssh2Debug.h"
#include "Ssh2LocalPortForwarding.h"
#include "Ssh2Process.h"
#include "Ssh2Scp.h"
#include <libssh2.h>
#include <QtCore/QTimer>
#include <QtNetwork/QHostAddress>
using namespace qlibssh2;
namespace
{
std::atomic<size_t> ssh2_initializations_count(0);
void initializeSsh2()
{
if (ssh2_initializations_count == 0)
libssh2_init(0);
ssh2_initializations_count++;
};
void freeSsh2()
{
if (ssh2_initializations_count == 1)
libssh2_exit();
if (ssh2_initializations_count > 0)
ssh2_initializations_count--;
};
ssize_t libssh_recv(int socket, void* buffer, size_t length, int flags, void** abstract)
{
Q_UNUSED(socket);
Q_UNUSED(flags);
QTcpSocket* const tcp_socket = reinterpret_cast<QTcpSocket*>(*abstract);
char* const data = reinterpret_cast<char*>(buffer);
ssize_t result = tcp_socket->read(data, length);
if (result == 0)
result = -EAGAIN;
return result;
}
ssize_t libssh_send(int socket, const void* buffer, size_t length, int flags, void** abstract)
{
Q_UNUSED(socket);
Q_UNUSED(flags);
QTcpSocket* const tcp_socket = reinterpret_cast<QTcpSocket*>(*abstract);
const char* const data = reinterpret_cast<const char*>(buffer);
ssize_t result = tcp_socket->write(data, length);
if (result == 0)
result = -EAGAIN;
return result;
}
} // namespace
Ssh2Client::Ssh2Client(Ssh2Settings ssh2_settings,
QObject* parent)
: QTcpSocket(parent)
, ssh2_settings_(std::move(ssh2_settings))
, ssh2_state_(SessionStates::NotEstableshed)
, ssh2_auth_method_(Ssh2AuthMethods::NoAuth)
, last_error_(ssh2_success)
, ssh2_session_(nullptr)
, known_hosts_(nullptr)
{
connect(this, &QTcpSocket::connected, this, &Ssh2Client::onTcpConnected);
connect(this, &QTcpSocket::disconnected, this, &Ssh2Client::onTcpDisconnected);
connect(this, &QTcpSocket::readyRead, this, &Ssh2Client::onReadyRead);
connect(this, &QTcpSocket::stateChanged, this, &Ssh2Client::onSocketStateChanged);
initializeSsh2();
}
Ssh2Client::~Ssh2Client()
{
closeSession();
if (state() == ConnectedState)
waitForDisconnected();
freeSsh2();
}
void Ssh2Client::connectToHost(const QString& hostName, qint16 port)
{
auto splitted = hostName.split(QLatin1Char{'@'});
if (splitted.count() == 2) {
ssh2_settings_.user = splitted.at(0);
return QTcpSocket::connectToHost(splitted.at(1), port);
}
QTcpSocket::connectToHost(hostName, port);
}
void Ssh2Client::connectToHost(const QString& userName, const QString& hostName, quint16 port)
{
ssh2_settings_.user = userName;
QTcpSocket::connectToHost(hostName, port);
}
Ssh2Client::SessionStates Ssh2Client::sessionState() const
{
return ssh2_state_;
}
void Ssh2Client::closeChannels()
{
for (Ssh2Channel* ssh2_channel : getChannels()) {
ssh2_channel->close();
}
}
void Ssh2Client::closeSession()
{
if (ssh2_state_ != FailedToEstablish)
setSsh2SessionState(Closed);
}
void Ssh2Client::checkConnection()
{
if (state() != QAbstractSocket::ConnectedState) {
setSsh2SessionState(FailedToEstablish, Ssh2Error::ConnectionTimeoutError);
}
}
void Ssh2Client::disconnectFromHost()
{
if (state() == QAbstractSocket::UnconnectedState)
return;
switch (ssh2_state_) {
case Established: {
if (openChannelsCount() > 0) {
setSsh2SessionState(Closing);
} else {
setSsh2SessionState(Closed);
}
} break;
case Closing:
destroySsh2Objects();
break;
default:;
}
QAbstractSocket::disconnectFromHost();
}
void Ssh2Client::onTcpConnected()
{
std::error_code error_code = createSsh2Objects();
if (!error_code)
error_code = startSshSession();
if (!checkSsh2Error(error_code))
setSsh2SessionState(FailedToEstablish, error_code);
}
void Ssh2Client::onTcpDisconnected()
{
if (ssh2_state_ != Closed)
setSsh2SessionState(Aborted, Ssh2Error::TcpConnectionRefused);
}
std::error_code Ssh2Client::startSshSession()
{
std::error_code error_code = ssh2_success;
const qintptr socket_descriptor = socketDescriptor();
if (socket_descriptor == -1) {
setSsh2SessionState(SessionStates::FailedToEstablish, Ssh2Error::SessionStartupError);
return error_code;
}
int ssh2_method_result = libssh2_session_startup(ssh2_session_,
socket_descriptor);
switch (ssh2_method_result) {
case LIBSSH2_ERROR_EAGAIN:
setSsh2SessionState(SessionStates::StartingSession);
error_code = Ssh2Error::TryAgain;
break;
case 0:
error_code = checkKnownHosts();
if (!error_code)
error_code = getAvailableAuthMethods();
break;
default:
error_code = Ssh2Error::SessionStartupError;
}
if (!checkSsh2Error(error_code)) {
debugSsh2Error(ssh2_method_result);
}
return error_code;
}
void Ssh2Client::onReadyRead()
{
std::error_code error_code = ssh2_success;
switch (ssh2_state_) {
case SessionStates::StartingSession:
error_code = startSshSession();
break;
case SessionStates::GetAuthMethods:
error_code = getAvailableAuthMethods();
break;
case SessionStates::Authentication:
error_code = authenticate();
break;
case SessionStates::Established:
[[fallthrough]];
case SessionStates::Closing:
for (Ssh2Channel* ssh2_channel : getChannels()) {
ssh2_channel->checkIncomingData();
}
break;
default:;
}
if (ssh2_state_ != SessionStates::Established && !checkSsh2Error(error_code)) {
setSsh2SessionState(SessionStates::FailedToEstablish, error_code);
}
}
void Ssh2Client::onChannelStateChanged(int state)
{
switch (static_cast<Ssh2Channel::ChannelStates>(state)) {
case Ssh2Channel::Closed:
case Ssh2Channel::Opened:
case Ssh2Channel::FailedToOpen:
emit openChannelsCountChanged(openChannelsCount());
break;
default:;
}
if (ssh2_state_ == Closing && openChannelsCount() == 0)
setSsh2SessionState(Closed);
}
void Ssh2Client::onSocketStateChanged(const QAbstractSocket::SocketState& state)
{
switch (state) {
case QAbstractSocket::UnconnectedState:
if (ssh2_state_ != NotEstableshed) {
setSsh2SessionState(FailedToEstablish, Ssh2Error::TcpConnectionError);
}
break;
case QAbstractSocket::ConnectingState:
QTimer::singleShot(ssh2_settings_.timeout, this, &Ssh2Client::checkConnection);
break;
default:;
}
}
void Ssh2Client::addChannel(Ssh2Channel* channel)
{
disconnect(channel);
emit channelsCountChanged(channelsCount());
connect(channel, &Ssh2Channel::channelStateChanged, this, &Ssh2Client::onChannelStateChanged);
connect(channel, &Ssh2Channel::destroyed, [this](QObject*) {
emit channelsCountChanged(channelsCount());
});
}
QList<Ssh2Channel*> Ssh2Client::getChannels() const
{
return findChildren<Ssh2Channel*>();
}
void Ssh2Client::destroySsh2Objects()
{
for (Ssh2Channel* channel : getChannels())
delete channel;
if (known_hosts_)
libssh2_knownhost_free(known_hosts_);
if (ssh2_session_) {
libssh2_session_disconnect(ssh2_session_, "disconnect");
libssh2_session_free(ssh2_session_);
}
known_hosts_ = nullptr;
ssh2_session_ = nullptr;
ssh2_available_auth_methods_.clear();
ssh2_auth_method_ = Ssh2AuthMethods::NoAuth;
if (state() == QTcpSocket::ConnectedState)
QTcpSocket::disconnectFromHost();
}
std::error_code Ssh2Client::createSsh2Objects()
{
if (ssh2_session_ && known_hosts_)
return ssh2_success;
ssh2_session_ = libssh2_session_init_ex(nullptr, nullptr, nullptr, reinterpret_cast<void*>(this));
if (ssh2_session_ == nullptr)
return Ssh2Error::UnexpectedError;
libssh2_session_callback_set(ssh2_session_, LIBSSH2_CALLBACK_RECV, reinterpret_cast<void*>(&libssh_recv));
libssh2_session_callback_set(ssh2_session_, LIBSSH2_CALLBACK_SEND, reinterpret_cast<void*>(&libssh_send));
known_hosts_ = libssh2_knownhost_init(ssh2_session_);
if (known_hosts_ == nullptr)
return Ssh2Error::UnexpectedError;
if (ssh2_settings_.isKeyAuth()) {
const int ssh2_method_result = libssh2_knownhost_readfile(
known_hosts_,
qPrintable(ssh2_settings_.known_hosts),
LIBSSH2_KNOWNHOST_FILE_OPENSSH);
if (ssh2_method_result < 0)
return Ssh2Error::ErrorReadKnownHosts;
}
libssh2_session_set_blocking(ssh2_session_, 0);
return ssh2_success;
}
std::error_code Ssh2Client::checkKnownHosts() const
{
if (ssh2_settings_.isPasswordAuth())
return ssh2_success;
size_t length;
int type;
const char* fingerprint = libssh2_session_hostkey(ssh2_session_, &length, &type);
if (fingerprint == nullptr)
return Ssh2Error::HostKeyInvalidError;
std::error_code result = ssh2_success;
if (fingerprint) {
struct libssh2_knownhost* host = nullptr;
const int check = libssh2_knownhost_check(known_hosts_,
qPrintable(peerAddress().toString()),
fingerprint,
length,
LIBSSH2_KNOWNHOST_TYPE_PLAIN | LIBSSH2_KNOWNHOST_KEYENC_RAW,
&host);
switch (check) {
case LIBSSH2_KNOWNHOST_CHECK_MATCH:
result = ssh2_success;
break;
case LIBSSH2_KNOWNHOST_CHECK_FAILURE:
result = Ssh2Error::HostKeyInvalidError;
break;
case LIBSSH2_KNOWNHOST_CHECK_MISMATCH:
result = Ssh2Error::HostKeyMismatchError;
break;
case LIBSSH2_KNOWNHOST_CHECK_NOTFOUND:
if (ssh2_settings_.autoAppendToKnownHosts) {
result = appendToKnownHosts(ssh2_settings_.autoAppendKnownHostComment);
} else {
result = Ssh2Error::HostKeyUnknownError;
}
break;
}
}
return result;
}
std::error_code Ssh2Client::getAvailableAuthMethods()
{
std::error_code result = ssh2_success;
int ssh2_method_result = 0;
const char* available_list = libssh2_userauth_list(ssh2_session_,
qPrintable(ssh2_settings_.user),
ssh2_settings_.user.length());
if (available_list == nullptr) {
ssh2_method_result = libssh2_session_last_error(ssh2_session_, nullptr, nullptr, 0);
if (ssh2_method_result == LIBSSH2_ERROR_EAGAIN) {
setSsh2SessionState(SessionStates::GetAuthMethods);
return Ssh2Error::TryAgain;
}
}
if (available_list != nullptr) {
foreach (QByteArray method, QByteArray(available_list).split(',')) {
if (method == "publickey") {
ssh2_available_auth_methods_ << Ssh2AuthMethods::PublicKeyAuthentication;
} else if (method == "password") {
ssh2_available_auth_methods_ << Ssh2AuthMethods::PasswordAuthentication;
}
}
ssh2_auth_method_ = getAuthenticationMethod(ssh2_available_auth_methods_);
result = authenticate();
} else if (ssh2_method_result != 0) {
result = Ssh2Error::UnexpectedError;
debugSsh2Error(ssh2_method_result);
}
return result;
}
Ssh2Client::Ssh2AuthMethods Ssh2Client::getAuthenticationMethod(const QList<Ssh2AuthMethods>& available_auth_methods) const
{
Ssh2AuthMethods result = Ssh2AuthMethods::NoAuth;
if (available_auth_methods.isEmpty())
result = Ssh2AuthMethods::NoAuth;
else if (available_auth_methods.contains(Ssh2AuthMethods::PasswordAuthentication) && ssh2_settings_.isPasswordAuth()) {
result = Ssh2AuthMethods::PasswordAuthentication;
} else if (available_auth_methods.contains(Ssh2AuthMethods::PublicKeyAuthentication) && ssh2_settings_.isKeyAuth()) {
result = Ssh2AuthMethods::PublicKeyAuthentication;
}
return result;
}
std::error_code Ssh2Client::authenticate()
{
std::error_code result = ssh2_success;
int ssh2_method_result = 0;
switch (ssh2_auth_method_) {
case Ssh2AuthMethods::NoAuth:
ssh2_method_result = libssh2_userauth_authenticated(ssh2_session_);
break;
case Ssh2AuthMethods::PublicKeyAuthentication:
ssh2_method_result = libssh2_userauth_publickey_fromfile(
ssh2_session_,
qPrintable(ssh2_settings_.user),
nullptr,
qPrintable(ssh2_settings_.key),
qPrintable(ssh2_settings_.keyphrase));
break;
case Ssh2AuthMethods::PasswordAuthentication:
ssh2_method_result = libssh2_userauth_password(
ssh2_session_,
qPrintable(ssh2_settings_.user),
qPrintable(ssh2_settings_.passphrase));
break;
}
switch (ssh2_method_result) {
case LIBSSH2_ERROR_EAGAIN:
setSsh2SessionState(SessionStates::Authentication);
result = Ssh2Error::TryAgain;
break;
case 0:
result = ssh2_success;
setSsh2SessionState(SessionStates::Established);
break;
default: {
debugSsh2Error(ssh2_method_result);
result = Ssh2Error::AuthenticationError;
}
}
return result;
}
std::error_code Ssh2Client::setLastError(const std::error_code& error_code)
{
if (last_error_ != error_code && error_code != Ssh2Error::TryAgain) {
last_error_ = error_code;
emit ssh2Error(last_error_);
}
return error_code;
}
LIBSSH2_SESSION* Ssh2Client::ssh2Session() const
{
return ssh2_session_;
}
QPointer<Ssh2Process> Ssh2Client::createProcess(const QString& command)
{
Ssh2Process* ssh2_process = new Ssh2Process(command, this);
addChannel(ssh2_process);
return ssh2_process;
}
QPointer<Ssh2Scp> Ssh2Client::scpSend(const QString& localFilePath, const QString& destinationPath)
{
auto* ssh2_scp = new Ssh2Scp(localFilePath, destinationPath, Ssh2Scp::Send, this);
addChannel(ssh2_scp);
return ssh2_scp;
}
QPointer<Ssh2Scp> Ssh2Client::scpReceive(const QString& remoteFilePath, const QString& destinationPath)
{
auto* ssh2_scp = new Ssh2Scp(remoteFilePath, destinationPath, Ssh2Scp::Receive, this);
addChannel(ssh2_scp);
return ssh2_scp;
}
QPointer<Ssh2LocalPortForwarding> Ssh2Client::localPortForwarding(quint16 localListenPort, const QHostAddress& remoteHost, quint16 remoteListenPort)
{
return localPortForwarding(QHostAddress::LocalHost, localListenPort,
remoteHost, remoteListenPort);
}
QPointer<Ssh2LocalPortForwarding> Ssh2Client::localPortForwarding(const QHostAddress &localListenHost, quint16 localListenPort,
const QHostAddress& remoteHost, quint16 remoteListenPort)
{
auto* ssh2_local_port_forwarding = new Ssh2LocalPortForwarding(localListenHost, localListenPort,
remoteHost, remoteListenPort, this);
addChannel(ssh2_local_port_forwarding);
return ssh2_local_port_forwarding;
}
int Ssh2Client::channelsCount() const
{
return getChannels().size();
}
int Ssh2Client::openChannelsCount() const
{
int result = 0;
for (Ssh2Channel* channel : getChannels()) {
if (channel->isOpen())
result++;
}
return result;
}
std::error_code Ssh2Client::appendToKnownHosts(const QLatin1String& comment) const
{
size_t hostKeyLength{0};
int hostKeyType{0};
auto* hostKey = libssh2_session_hostkey(ssh2_session_, &hostKeyLength, &hostKeyType);
if (!hostKey)
return Ssh2Error::HostKeyInvalidError;
int knownHostKeyType{0};
switch (hostKeyType) {
case LIBSSH2_HOSTKEY_TYPE_UNKNOWN:
return Ssh2Error::HostKeyUnknownError;
case LIBSSH2_HOSTKEY_TYPE_RSA:
knownHostKeyType = LIBSSH2_KNOWNHOST_KEY_RSA1;
break;
case LIBSSH2_HOSTKEY_TYPE_DSS:
knownHostKeyType = LIBSSH2_KNOWNHOST_KEY_SSHDSS;
break;
case LIBSSH2_HOSTKEY_TYPE_ECDSA_256:
knownHostKeyType = LIBSSH2_KNOWNHOST_KEY_ECDSA_256;
break;
case LIBSSH2_HOSTKEY_TYPE_ECDSA_384:
knownHostKeyType = LIBSSH2_KNOWNHOST_KEY_ECDSA_384;
break;
case LIBSSH2_HOSTKEY_TYPE_ECDSA_521:
knownHostKeyType = LIBSSH2_KNOWNHOST_KEY_ECDSA_521;
break;
case LIBSSH2_HOSTKEY_TYPE_ED25519:
knownHostKeyType = LIBSSH2_KNOWNHOST_KEY_ED25519;
break;
}
if (libssh2_knownhost_addc(known_hosts_, peerName().toLocal8Bit().data(), nullptr,
hostKey, hostKeyLength,
comment.data(), comment.size(),
LIBSSH2_KNOWNHOST_TYPE_PLAIN | LIBSSH2_KNOWNHOST_KEYENC_RAW | knownHostKeyType,
nullptr)) {
return Ssh2Error::HostKeyAppendError;
}
if (libssh2_knownhost_writefile(known_hosts_, ssh2_settings_.known_hosts.toLatin1().data(),
LIBSSH2_KNOWNHOST_FILE_OPENSSH)) {
return Ssh2Error::ErrorWriteKnownHosts;
}
return ssh2_success;
}
void Ssh2Client::setSsh2SessionState(const Ssh2Client::SessionStates& new_state)
{
if (ssh2_state_ != new_state) {
switch (new_state) {
case Closing:
closeChannels();
break;
case FailedToEstablish:
[[fallthrough]];
case Closed:
[[fallthrough]];
case Aborted:
destroySsh2Objects();
break;
default:;
}
ssh2_state_ = new_state;
emit sessionStateChanged(new_state);
}
}
const std::error_code& Ssh2Client::setSsh2SessionState(const SessionStates& new_state,
const std::error_code& error_code)
{
setLastError(error_code);
setSsh2SessionState(new_state);
return error_code;
}
You can’t perform that action at this time.