session.cc 18.1 KB
Newer Older
1
2
3
4
5

#include "rsmcore/session.hh"
#include "radixbug/bug.hh"

#include <libssh/libssh.h>
6
#include <libssh/sftp.h>
7

8
#include <fcntl.h>
9
10
11
12
13
14
15
16
#include <cassert>
#include <sstream>

#include <QByteArray>
#include <QString>

namespace rsm
{
17
void assert_ssh_session(ssh_session session, const char* error_message)
18
19
20
{
  if (session == nullptr)
  {
21
    throw std::runtime_error(error_message);
22
23
  }
}
24
void assert_ssh_channel(ssh_channel channel, const char* error_message)
25
26
27
{
  if (channel == nullptr)
  {
28
    throw std::runtime_error(error_message);
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
  }
}

class ChannelImpl
{
 public:
  ssh_channel channel = nullptr;
  explicit ChannelImpl(ssh_session session)
  {
    channel = ssh_channel_new(session);
  }
  ~ChannelImpl()
  {
    if (channel != nullptr)
    {
      ssh_channel_close(channel);
      ssh_channel_free(channel);
    }
  }
};  // class ChannelImpl

Channel::Channel()
{
  radix_tagged_line("Channel::Channel()");
  p = nullptr;
}
Channel::~Channel()
{
  radix_tagged_line("Channel::~Channel()");
  if (p != nullptr) delete p;
}

bool Channel::open()
{
  assert_ssh_channel(p->channel, "open() -- Channel is not allocated.");
  int rc = ssh_channel_open_session(p->channel);
  return (rc > -1);
}

bool Channel::isOpen() const
{
  // Perhaps we should just return false
  assert_ssh_channel(p->channel, "isOpen() -- Channel is not allocated.");
  int rc = ssh_channel_is_open(p->channel);
  return (rc != 0);
}

void Channel::close()
{
  if (p->channel != nullptr)
  {
    ssh_channel_close(p->channel);
    ssh_channel_free(p->channel);
    p->channel = nullptr;
  }
}

bool Channel::exec(QString command)
{
  assert_ssh_channel(p->channel, "exec() -- Channel is not allocated.");
  int rc = ssh_channel_request_exec(p->channel, command.toStdString().c_str());
  return !(rc < 0);
}

QString Channel::readExecOut()
{
  assert_ssh_channel(p->channel, "readExecOut() -- Channel is not allocated.");
  char buffer[256];
  int nbytes = ssh_channel_read(p->channel, buffer, sizeof(buffer), 0);
98
  if (nbytes > 0)
99
  {
100
101
102
    buffer[nbytes] = '\0';
    QString result = buffer;
    return result;
103
  }
104
  return QString("");
105
106
107
108
109
110
}
QString Channel::readExecErr()
{
  assert_ssh_channel(p->channel, "readExecErr() -- Channel is not allocated.");
  char buffer[256];
  int nbytes = ssh_channel_read(p->channel, buffer, sizeof(buffer), 1);
111
  if (nbytes > 0)
112
  {
113
114
115
    buffer[nbytes] = '\0';
    QString result = buffer;
    return result;
116
  }
117
  return QString("");
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
// ----------------------------------------------------------------------------
class SFTPSessionImpl
{
 public:
  sftp_session sftpSession = nullptr;
  int errorCode            = SSH_OK;
  const char* errorMsg     = nullptr;
  explicit SFTPSessionImpl(ssh_session sshSession)
  {
    sftpSession = sftp_new(sshSession);
    if (nullptr == sftpSession)
    {
      errorCode = SSH_ERROR;
      errorMsg  = ssh_get_error(sshSession);
      return;
    }
    // SSH_OK, SSH_ERROR, etc; see libssh.h
    int rc = sftp_init(sftpSession);
    if (rc != SSH_OK)
    {
      errorCode = sftp_get_error(sftpSession);
      sftp_free(sftpSession);
      sftpSession = nullptr;
    }
  }

  ~SFTPSessionImpl()
  {
    if (sftpSession != nullptr) sftp_free(sftpSession);
  }
};  // class SFTPSessionImpl

SFTPSession::SFTPSession()
{
  radix_tagged_line("SFTPSession::SFTPSession()");
  p = nullptr;
}

SFTPSession::~SFTPSession()
{
  radix_tagged_line("SFTPSession::~SFTPSession()");
  if (p != nullptr) delete p;
}

bool SFTPSession::mkdir(QString dirName)
{
  // S_IRWXU: create dir with read/write/exec by owner only
  int rc = sftp_mkdir(p->sftpSession, dirName.toStdString().c_str(), S_IRWXU);
  if (rc != SSH_OK)
  {
    if (sftp_get_error(p->sftpSession) != SSH_FX_FILE_ALREADY_EXISTS)
    {
      p->errorCode = SSH_ERROR;
      p->errorMsg  = ssh_get_error(p->sftpSession);
      return false;
    }
  }
  return true;
}

bool SFTPSession::rmdir(QString dirName)
{
  int rc = sftp_rmdir(p->sftpSession, dirName.toStdString().c_str());
  if (rc != SSH_OK)
  {
    if (sftp_get_error(p->sftpSession) != SSH_FX_FILE_ALREADY_EXISTS)
    {
      p->errorCode = SSH_ERROR;
      p->errorMsg  = ssh_get_error(p->sftpSession);
      return false;
    }
  }
  return true;
}

SFTPFile SFTPSession::openFile(QString filename, int accessType)
{
  return SFTPFile(*this, filename.toStdString().c_str(), accessType);
}

SFTPDir SFTPSession::openDir(QString dirName)
{
  return SFTPDir(*this, dirName.toStdString().c_str());
}

QString SFTPSession::error() { return p->errorMsg; }

QString SFTPSession::canonicalize(QString path)
{
  char* str =
      sftp_canonicalize_path(p->sftpSession, path.toStdString().c_str());
211
212
213
214
215
216
217
218
  if (nullptr == str)
  {
    ssh_string_free_char(str);
    return "";
  }
  QString retVal = QString(str);
  ssh_string_free_char(str);
  return retVal;
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
}

// ----------------------------------------------------------------------------
class SFTPFileImpl
{
 public:
  sftp_file file = nullptr;

  explicit SFTPFileImpl(sftp_session sftpSession, QString filename,
                        int accessType)
  {
    file = sftp_open(sftpSession, filename.toStdString().c_str(), accessType,
                     S_IRWXU);
  }

  ~SFTPFileImpl()
  {
    if (file != nullptr) sftp_close(file);
  }
};  // class SFTPFileImpl

SFTPFile::SFTPFile(SFTPSession& sftpSession, QString filename, int accessType)
{
  p = new SFTPFileImpl(sftpSession.p->sftpSession, filename, accessType);
}

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
SFTPFile::~SFTPFile()
{
  radix_tagged_line("SFTPFile::~SFTPFile()");
  if (p != nullptr) delete p;
}

bool SFTPFile::isOpen() { return (p->file != nullptr); }

// returns number of bytes written on success
// on error, returns < 0 and ssh and sftp session errors are set
ssize_t SFTPFile::write(QString str)
{
  const char* buf  = str.toStdString().c_str();
  size_t count     = strlen(buf);
  ssize_t nwritten = sftp_write(p->file, buf, count);
  return nwritten;
}

// returns empty string and closes file on error; isOpen() can be used to verify
// success
QString SFTPFile::read(size_t nBytes)
{
  char* buf          = new char[nBytes + 1];
  buf[nBytes]        = '\0';
  ssize_t nBytesRead = sftp_read(p->file, buf, nBytes);
  if (nBytesRead < 0)
  {
    close();
    return QString();
  }
  QString str(buf);
  delete[] buf;
  return str;
}

bool SFTPFile::close()
{
  int rc = sftp_close(p->file);
  if (SSH_NO_ERROR == rc)
  {
    p->file = nullptr;
    return true;
  }
  return false;
}

bool SFTPFile::seek(size_t offset)
{
  int rc = sftp_seek64(p->file, offset);
  if (rc < 0) return false;
  return true;
}

// returns < 0 on error
ssize_t SFTPFile::tell()
{
  ssize_t result = static_cast<ssize_t>(sftp_tell64(p->file));
  return result;
}

305
306
307
308
// ----------------------------------------------------------------------------
class SFTPDirImpl
{
 public:
309
310
  sftp_dir dir      = nullptr;
  sftp_session sftp = nullptr;
311
312
313

  explicit SFTPDirImpl(sftp_session sftpSession, QString dirName)
  {
314
315
    dir  = sftp_opendir(sftpSession, dirName.toStdString().c_str());
    sftp = sftpSession;
316
317
318
319
320
321
322
323
324
325
326
327
328
  }

  ~SFTPDirImpl()
  {
    if (dir != nullptr) sftp_closedir(dir);
  }
};  // class SFTPDirImpl

SFTPDir::SFTPDir(SFTPSession sftpSession, QString dirName)
{
  p = new SFTPDirImpl(sftpSession.p->sftpSession, dirName);
}

329
330
331
332
333
334
335
336
337
338
339
340
341
342
SFTPDir::~SFTPDir()
{
  radix_tagged_line("SFTPDir::~SFTPDir()");
  if (p != nullptr) delete p;
}

bool SFTPDir::isOpen() { return (p->dir != nullptr); }

bool SFTPDir::hasNext() { return (0 == sftp_dir_eof(p->dir)); }

// returns SFTPAttributes structure on success or nullptr on failure
// caller is responsible for deleting returned SFTPAttributes structure
SFTPAttributes* SFTPDir::next()
{
343
  sftp_attributes sftpResult = sftp_readdir(p->sftp, p->dir);
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
  if (nullptr == sftpResult) return nullptr;

  SFTPAttributes* retVal = new SFTPAttributes;

  retVal->name                = QString(sftpResult->name);
  retVal->longname            = QString(sftpResult->longname);
  retVal->flags               = sftpResult->flags;
  retVal->type                = sftpResult->type;
  retVal->size                = sftpResult->size;
  retVal->uid                 = sftpResult->uid;
  retVal->gid                 = sftpResult->gid;
  retVal->owner               = QString(sftpResult->owner);
  retVal->group               = QString(sftpResult->group);
  retVal->permissions         = sftpResult->permissions;
  retVal->atime64             = sftpResult->atime64;
  retVal->atime               = sftpResult->atime;
  retVal->atime_nseconds      = sftpResult->atime_nseconds;
  retVal->createtime          = sftpResult->createtime;
  retVal->createtime_nseconds = sftpResult->createtime_nseconds;
  retVal->mtime64             = sftpResult->mtime64;
  retVal->mtime               = sftpResult->mtime;
  retVal->mtime_nseconds      = sftpResult->mtime_nseconds;
  retVal->acl                 = QString(ssh_string_get_char(sftpResult->acl));
  retVal->extended_count      = sftpResult->extended_count;
  retVal->extended_type =
      QString(ssh_string_get_char(sftpResult->extended_type));
  retVal->extended_data =
      QString(ssh_string_get_char(sftpResult->extended_data));

  return retVal;
}

bool SFTPDir::close()
{
  int rc = sftp_closedir(p->dir);
  if (SSH_NO_ERROR == rc)
  {
381
382
    p->dir  = nullptr;
    p->sftp = nullptr;
383
384
385
386
387
    return true;
  }
  return false;
}

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
class SessionImpl
{
 public:
  ssh_session session = nullptr;
  SessionImpl()
  {
    session = ssh_new();
    assert_ssh_session(session, "Failed to allocate new ssh session.");
  }
  ~SessionImpl()
  {
    if (session != nullptr)
    {
      ssh_free(session);
      ssh_finalize();
    }
  }
};  // class SessionImpl

Session::Session() { p = new SessionImpl(); }

Session::Session(QString host)
{
  p = new SessionImpl();
  setHost(host);
}

Session::~Session()
{
  if (p != nullptr) delete p;
}

void Session::setHost(QString host)
{
  assert_ssh_session(p->session, "setHost() -- Session is not allocated.");
  ssh_options_set(p->session, SSH_OPTIONS_HOST, host.toStdString().c_str());
}

427
QString Session::host() const
428
429
430
431
432
433
434
{
  // This may not be necessary
  assert_ssh_session(p->session, "host() -- Session is not allocated.");
  char* host_name;
  int rv = ssh_options_get(p->session, SSH_OPTIONS_HOST, &host_name);
  if (rv == SSH_OK)
  {
435
    QString host = host_name;
436
437
438
439
440
    delete host_name;
    return host;
  }
  else
  {
441
    return QString("");
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
  }
}
void Session::setLogVerbosity(SessionVerbosity level)
{
  assert_ssh_session(p->session,
                     "setLogVerbosity() -- Session is not allocated.");
  int verbosity = static_cast<int>(level);
  ssh_options_set(p->session, SSH_OPTIONS_LOG_VERBOSITY, &verbosity);
}
void Session::setPort(int port)
{
  assert_ssh_session(p->session, "setPort() -- Session is not allocated.");
  ssh_options_set(p->session, SSH_OPTIONS_PORT, &port);
}
void Session::setUser(QString name)
{
  assert_ssh_session(p->session, "setName() -- Session is not allocated.");
  ssh_options_set(p->session, SSH_OPTIONS_USER, name.toStdString().c_str());
}

462
QString Session::user() const
463
464
465
466
467
468
469
{
  // This may not be necessary
  assert_ssh_session(p->session, "user() -- Session is not allocated.");
  char* user_name;
  int rv = ssh_options_get(p->session, SSH_OPTIONS_USER, &user_name);
  if (rv == SSH_OK)
  {
470
    QString user = user_name;
471
472
473
474
475
    delete user_name;
    return user;
  }
  else
  {
476
    return QString("");
477
478
479
480
481
482
483
484
485
486
487
488
489
490
  }
}

void Session::setProxyCommand(QString command)
{
  assert_ssh_session(p->session,
                     "setProxyCommand() -- Session is not allocated.");
  ssh_options_set(p->session, SSH_OPTIONS_PROXYCOMMAND,
                  command.toStdString().c_str());
}
bool Session::connect()
{
  assert_ssh_session(p->session, "connect() -- Session is not allocated.");
  radix_tagged_line("connect()");
491
  if (isConnected())
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
  {
    radix_tagged_line("session already connected. disconnectinng.");
    ssh_disconnect(p->session);
  }
  {
    radix_tagged_line("Attempting connection.");
    // attempt a connection
    int rc = ssh_connect(p->session);
    return (rc == SSH_OK);
  }
}

bool Session::isConnected() const
{
  assert_ssh_session(p->session, "isConnected() -- Session is not allocated.");
507
  return (ssh_is_connected(p->session) == 1);
508
509
}

510
QString Session::getError() const
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
{
  assert_ssh_session(p->session, "getError() -- Session is not allocated.");
  return ssh_get_error(p->session);
}
bool Session::disconnect()
{
  assert_ssh_session(p->session, "disconnect() -- Session is not allocated.");
  radix_tagged_line("disconnect()");
  if (ssh_is_connected(p->session) != 0)
  {
    radix_tagged_line("Disconnecting session.");
    ssh_disconnect(p->session);
    // copy options in preparation for deletion
    ssh_session new_session = ssh_new();
    ssh_options_copy(p->session, &new_session);
    ssh_free(p->session);
    p->session = new_session;
  }
  return true;
}

QString Session::getHexa() const
{
  assert_ssh_session(p->session, "getHexa() -- Session is not allocated.");
  unsigned char* hash       = nullptr;
  ssh_key server_public_key = nullptr;
  char* hexa;
  size_t hlen;
  QString qhexa;
  int rc = ssh_get_server_publickey(p->session, &server_public_key);
  if (rc < 0)
  {
    return QString();
  }

  // Probably should remove hardwired HASH_SHA1
  rc = ssh_get_publickey_hash(server_public_key, SSH_PUBLICKEY_HASH_SHA1, &hash,
                              &hlen);
  ssh_key_free(server_public_key);
  if (rc < 0)
  {
    return QString();
  }

  hexa  = ssh_get_hexa(hash, hlen);
  qhexa = hexa;
  ssh_clean_pubkey_hash(&hash);
  ssh_string_free_char(hexa);
  return qhexa;
}

SessionHostState Session::verifyKnownHost() const
{
  assert_ssh_session(p->session,
                     "verifyKnownHost() -- Session is not allocated.");
  enum ssh_known_hosts_e state;
  unsigned char* hash       = nullptr;
  ssh_key server_public_key = nullptr;
  size_t hlen;
  QString qhexa;

  radix_tagged_line("verifyKnownHost()");
  int rc = ssh_get_server_publickey(p->session, &server_public_key);
  if (rc < 0)
  {
    return SessionHostState::ERROR;
  }

  rc = ssh_get_publickey_hash(server_public_key, SSH_PUBLICKEY_HASH_SHA1, &hash,
                              &hlen);
  ssh_clean_pubkey_hash(&hash);
  ssh_key_free(server_public_key);
  if (rc < 0)
  {
    return SessionHostState::ERROR;
  }

  state = ssh_session_is_known_server(p->session);
  return static_cast<SessionHostState>(state);
}

bool Session::updateKnownHosts()
{
  assert_ssh_session(p->session,
                     "updateKnownHosts() -- Session is not allocated.");
  radix_tagged_line("updateKnownHosts()");
  int rc = ssh_session_update_known_hosts(p->session);
  return (rc == SSH_OK);
}

int Session::authenticationMethodList() const
{
  assert_ssh_session(p->session,
                     "authenticationMethodList() -- Session is not allocated.");

606
607
608
609
610
611
  // required method to be called before auth list is called
  int rc = ssh_userauth_none(p->session, nullptr);
  if (rc == SSH_AUTH_ERROR)
  {
    return SSH_AUTH_METHOD_UNKNOWN;
  }
612
613
614
615
616
617
618
  // get acceptable methods
  int method = ssh_userauth_list(p->session, nullptr);
  return method;
}

SessionAuthState Session::authenticateWithPublicKey()
{
619
620
  assert_ssh_session(
      p->session, "authenticateWithPublicKey() -- Session is not allocated.");
621
622
623
624
  int rc = ssh_userauth_publickey_auto(p->session, nullptr, nullptr);
  return static_cast<SessionAuthState>(rc);
}

625
626
627
628
629
630
631
632
SessionAuthState Session::authenticateInteractively()
{
  assert_ssh_session(
      p->session, "authenticateInteractively() -- Session is not allocated.");
  int rc = ssh_userauth_kbdint(p->session, nullptr, nullptr);
  return static_cast<SessionAuthState>(rc);
}

633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
QString Session::keyboardInteractiveName() const
{
  assert_ssh_session(p->session,
                     "keyboardInteractiveName() -- Session is not allocated.");
  QString name = ssh_userauth_kbdint_getname(p->session);
  return name;
}

QString Session::keyboardInteractiveInstruction() const
{
  assert_ssh_session(
      p->session,
      "keyboardInteractiveInstruction() -- Session is not allocated.");
  QString instruction = ssh_userauth_kbdint_getinstruction(p->session);
  return instruction;
}

QStringList Session::keyboardInteractivePrompts() const
{
  int num_prompts = ssh_userauth_kbdint_getnprompts(p->session);
  // build list of prompts
  QStringList prompts;
  char echo;
  for (int i = 0; i < num_prompts; ++i)
  {
    QString prompt = ssh_userauth_kbdint_getprompt(
        p->session, static_cast<unsigned int>(i), &echo);
    radix_tagged_line(i << ". " << prompt.toStdString());
    if (prompt.isEmpty()) break;
    prompts << prompt;
  }
  return prompts;
}

SessionAuthState Session::authenticateWithPassword(QString pswd)
{
  assert_ssh_session(p->session,
                     "authenticateWithPassword() -- Session is not allocated.");
  radix_tagged_line("Authenticate with password.");
  int rc =
      ssh_userauth_password(p->session, nullptr, pswd.toStdString().c_str());
  return static_cast<SessionAuthState>(rc);
}

QString Session::loginIssueBanner() const
{
  char* banner = ssh_get_issue_banner(p->session);
  if (banner)
  {
    QString qbanner = banner;
    delete banner;
    return qbanner;
  }
  return QString("");
}

SessionAuthState Session::authenticatePrompts(QStringList responses)
{
  int err;
  radix_tagged_line("authenticatePrompts()");
  for (int i = 0; i < responses.size(); ++i)
  {
    radix_tagged_line("Setting response " << i);
    const char* answer = responses.at(i).toStdString().c_str();
    err                = ssh_userauth_kbdint_setanswer(p->session,
                                        static_cast<unsigned int>(i), answer);
    if (err < 0)
    {
      ssh_disconnect(p->session);
      return SessionAuthState::ERROR;
    }
  }
  // check status
  err = ssh_userauth_kbdint(p->session, nullptr, nullptr);

  SessionAuthState state = static_cast<SessionAuthState>(err);
  if (state == SessionAuthState::DENIED)
  {
    ssh_disconnect(p->session);
  }
  return state;
}

Channel Session::newChannel()
{
  assert_ssh_session(p->session, "newChannel() -- Session is not allocated.");
  Channel channel;
  channel.p = new ChannelImpl(p->session);
  return channel;
}

724
725
726
727
728
729
730
731
732
SFTPSession Session::newSFTPSession()
{
  assert_ssh_session(p->session,
                     "newSFTPSession() -- SSH Session is not allocated.");
  SFTPSession sftpSession;
  sftpSession.p = new SFTPSessionImpl(p->session);
  return sftpSession;
}

733
}  // namespace rsm