sessionworker.hh

#ifndef RSM_RSMCORE_SESSIONWORKER_HH_
#define RSM_RSMCORE_SESSIONWORKER_HH_

#include <QObject>

#include "rsmcore/declspec.hh"

namespace rsm
{
class SessionWorkerImpl;
class RSM_PUBLIC SessionWorker : public QObject
{
  Q_OBJECT
 private:
  // Private implementation
  SessionWorkerImpl* p;

 public:
  enum class Verbosity
  {
    None,
    Warning,
    Protocal,
    Packet,
    Functions
  };

  /**
   * Basic Constructor
   */
  SessionWorker(QObject* parent = nullptr);
  /**
   * Contructs with host name
   */
  SessionWorker(QString host, QObject* parent = nullptr);
  ~SessionWorker();

 public slots:

  /**
   * Set the remote host to connect to
   */
  void setHost(QString host);
  /**
   * Set the Log verbosity
   */
  void setLogVerbosity(Verbosity level);
  /**
   * Set the ssh port number
   */
  void setPort(int port);
  /**
   * Set the user
   * Defaults to system user
   */
  void setUser(QString name);
  /**
   * Perform hand-shake to connect to host.
   */
  void connect();
  /**
   * Disconnect ssh session
   */
  void disconnect();
  /**
   * Perform known host verification.
   * Checks known_host file to validate remote host SHA
   * Can emit hostUnknown(QString host_hash).
   * Can emit hostPublicKeyChanged(QString host_hash).
   * Can emit hostPublicKeyUnavailable().
   * Can emit knownHostError().
   */
  void verifyKnownHost();
  /**
   * Performs a request to accept/save the host's public key,
   * updating the known_hosts
   */
  void acceptHostPublicKeyUpdate();
  /**
   * Attempts to authenticate using public key or password.
   * Can emit authenticationError(QString message).
   * Can emit authenticationSucceeded() upon acceptance of public key.
   * Can emit passworedRequested().
   */
  void authenticate();
  /**
   * Attempts to authenticate with username and password.
   * Can emit authenticationError(QString message).
   * Can emit authenticationSuccessed() upon acceptance of password.
   * Can emit loginBannerIssued(QString message) give availability.
   */
  void authenticateWithPassword(QString pswd);

  /**
   * Requests remote execution of command
   * @param command - QString command to execute
   */
  void requestExec(QString command);

 signals:
  void getServerPublicKeyFailed();
  void hostUnknown(QString host_hash);
  void hostPublicKeyChanged(QString host_hash);
  void hostPublicKeyUnavailable();
  void knownHostError(QString message);
  void updateKnownHostsFailed();
  void authenticationError(QString message);
  void authenticationSucceeded();
  void passwordRequested();
  void loginBannerIssued(QString message);
  void execOutputReady();

};  // class SessionWorker
}  // namespace rsm
#endif /* RSM_RSMCORE_SESSIONWORKER_HH_*/