Network.SSH.Client.SimpleSSH

Data types

data SimpleSSHError

Constructors

Connect

Init

Handshake

KnownhostsInit

KnownhostsHostkey

KnownhostsCheck

Authentication

ChannelOpen

ChannelExec

Read

FileOpen

Write

Unknown

Instances

Eq SimpleSSHError

Methods

(==) :: SimpleSSHError -> SimpleSSHError -> Bool

(/=) :: SimpleSSHError -> SimpleSSHError -> Bool

Show SimpleSSHError

Methods

showsPrec :: Int -> SimpleSSHError -> ShowS

show :: SimpleSSHError -> String

showList :: [SimpleSSHError] -> ShowS

type SimpleSSH a = ExceptT SimpleSSHError IO a

data Session

data Result

The result of a command execution.

Constructors

Result

Fields

• resultOut :: ByteString

  The process' stdout

• resultErr :: ByteString

  The process' stderr

• resultExit :: ResultExit

  The process' exit code or signal

Instances

Eq Result

Methods

(==) :: Result -> Result -> Bool

(/=) :: Result -> Result -> Bool

Show Result

Methods

showsPrec :: Int -> Result -> ShowS

show :: Result -> String

showList :: [Result] -> ShowS

data ResultExit

Exit code or signal of a process.

Constructors

ExitSuccess

ExitFailure Integer

ExitSignal ByteString

Instances

Eq ResultExit

Methods

(==) :: ResultExit -> ResultExit -> Bool

(/=) :: ResultExit -> ResultExit -> Bool

Show ResultExit

Methods

showsPrec :: Int -> ResultExit -> ShowS

show :: ResultExit -> String

showList :: [ResultExit] -> ShowS

Main functions

runSimpleSSH :: SimpleSSH a -> IO (Either SimpleSSHError a)

withSessionPassword

Arguments

:: String

Hostname

-> Integer

Port

-> String

Path to known_hosts

-> String

Username

-> String

Password

-> (Session -> SimpleSSH a)

Monadic action on the session

-> SimpleSSH a

Open a connection, authenticate, execute some action and close the connection.

It is the safe way of using SimpleSSH. This function is to be used to authenticate with a pair username / password, otherwise see withSessionKey.

withSessionKey

Arguments

:: String

Hostname

-> Integer

port

-> String

Path to known_hosts

-> String

Username

-> String

Path to public key

-> String

Path to private key

-> String

Passphrase

-> (Session -> SimpleSSH a)

Monadic action on the session

-> SimpleSSH a

Open a connection, authenticate, execute some action and close the connection.

It is the safe way of using SimpleSSH. This function is to be used to authenticate with a key, otherwise see withSessionPassword.

execCommand

Arguments

:: Session

Session to use

-> String

Command

-> SimpleSSH Result

Send a command to the server.

One should be authenticated before sending commands on a Session.

sendFile

Arguments

:: Session

Session to use

-> Integer

File mode (e.g. 0o777, note the octal notation)

-> String

Source path

-> String

Target path

-> SimpleSSH Integer

Send a file to the server and returns the number of bytes transferred.

One should be authenticated before sending files on a 'Session.

Lower-level functions

openSession

Arguments

:: String

Hostname

-> Integer

Port

-> String

Path to the known hosts (e.g. ~.sshknown_hosts)

-> SimpleSSH Session

Open a SSH session. The next step is to authenticate.

authenticateWithPassword

Arguments

:: Session

Session to use

-> String

Username

-> String

Password

-> SimpleSSH Session

Authenticate with a public key for a given username.

Leave the passphrase empty if not needed.

Authenticate a session with a pair username / password.

authenticateWithKey

Arguments

:: Session

Session to use

-> String

Username

-> FilePath

Path to the public key (e.g. ~.sshid_rsa.pub)

-> FilePath

Path to the private key (e.g. ~.sshid_rsa)

-> String

Passphrase

-> SimpleSSH Session

closeSession :: Session -> SimpleSSH ()

Close a session.