/kde/autobuild/kdebase/kioslave/sftp/ksshprocess.h

/***************************************************************************
                          ksshprocess.h  -  description
                             -------------------
    begin                : Tue Jul 31 2001
    copyright            : (C) 2001 by Lucas Fisher
    email                : ljfisher@purdue.edu
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef KSSHPROCESS_H
#define KSSHPROCESS_H

#include <sys/types.h>
#include <sys/wait.h>
#include <signal.h>
#include <unistd.h>

#include <tqvaluelist.h>

#include <kdebug.h>

#include "process.h"

#define KSSHPROC 7120

class KSshProcess {
public:
    class SshOpt {
    public:
        Q_UINT32 opt;
        TQString  str;
        Q_INT32  num;
        bool     boolean;
    };

    typedef TQValueList<SshOpt> SshOptList;
    typedef TQValueListIterator<SshOpt> SshOptListIterator;
    typedef TQValueListConstIterator<SshOpt> SshOptListConstIterator;

    enum SshVersion {
        OPENSSH_3_6,
        OPENSSH,
        SSH,
        SSH_VER_MAX,
        UNKNOWN_VER
    };  

    // we cannot do this like UDSAtomType (ORing the type with the name) because
    // we have too many options for ssh and not enough bits.
    enum SshOptType {
        SSH_SUBSYSTEM,
        SSH_PORT,
        SSH_HOST,
        SSH_USERNAME,
        SSH_PASSWD,
        SSH_PROTOCOL,
        SSH_FORWARDX11,
        SSH_FORWARDAGENT,
        SSH_ESCAPE_CHAR,
        SSH_COMMAND,
        SSH_VERBOSE,
        SSH_OPTION,
        SSH_OTHER,
        SSH_OPT_MAX // always last
    }; // that's all for now

    enum SshError {
        ERR_UNKNOWN_VERSION,
        ERR_CANNOT_LAUNCH,
        ERR_INTERACT,
        ERR_CMD_SUBSYS_CONFLICT,
        ERR_NEED_PASSWD,
        ERR_NEED_PASSPHRASE,
        ERR_NEED_USERNAME,
        ERR_TIMED_OUT,
        ERR_INTERNAL,
        ERR_DISCONNECTED,
        ERR_NO_OPTIONS,
        ERR_NEW_HOST_KEY,
        ERR_DIFF_HOST_KEY,
        ERR_HOST_KEY_REJECTED,
        ERR_INVALID_OPT,
        ERR_ACCEPTED_KEY,
        ERR_AUTH_FAILED,
        ERR_AUTH_FAILED_NEW_KEY,
        ERR_AUTH_FAILED_DIFF_KEY,
        ERR_CLOSED_BY_REMOTE_HOST,
        ERR_UNKNOWN,
        ERR_INVALID_STATE,
        ERR_MAX
    };

    KSshProcess();

    KSshProcess(TQString pathToSsh);
    ~KSshProcess();

     bool setSshPath(TQString pathToSsh);

    SshVersion version();

    //TQString versionStr();

    int error(TQString& msg);

    int error() { return mError; }

    TQString errorMsg() { return mErrorMsg; }

    void kill(int signal = SIGKILL);

    int pid() { return ssh.pid(); }
    
    bool connected() { return mConnected; }

    bool running() { return mRunning; }
    
    void printArgs();

    bool setOptions(const SshOptList& opts);

    bool connect();


    void disconnect();
    
    void acceptHostKey(bool accept);

    void setPassword(TQString password);
     
    int stdioFd() { return ssh.stdioFd(); }

    int stderrFd() { return ssh.stderrFd(); }

    int pty() { return ssh.fd(); }
private:
    TQString mSshPath;
    
    SshVersion mVersion;

    TQString mPassword;
    
    TQString mUsername;
    
    TQString mHost;

    bool mAcceptHostKey;
    
    bool mConnected;
    
    bool mRunning;

    TQString mKeyFingerprint;

    TQString mKnownHostsFile;

    int mConnectState;
    
    int mPort;

    SshError mError;

    TQString mErrorMsg;
    
    MyPtyProcess ssh;

    QCStringList mArgs;
    void init();

    static void SIGCHLD_handler(int signo);
    void installSignalHandlers();
    void removeSignalHandlers();

    TQString getLine();
    
    static TQRegExp versionStrs[];
    static const char * const passwordPrompt[];
    static const char * const passphrasePrompt[];
    static const char * const authSuccessMsg[];
    static const char * const authFailedMsg[];
    static TQRegExp hostKeyMissingMsg[];
    static const char * const hostKeyChangedMsg[];
    static const char * const continuePrompt[];
    static const char * const hostKeyAcceptedMsg[];
    static const char * const tryAgainMsg[];
    static TQRegExp hostKeyVerifyFailedMsg[];
    static const char * const connectionClosedMsg[];
    static const char * const changeHostKeyOnDiskPrompt[];
    static TQRegExp keyFingerprintMsg[];
    static TQRegExp knownHostsFileMsg[];
};
#endif

---