Network.SSH.Client.LibSSH2.Foreign

Types

data KnownHosts

Instances

Eq KnownHosts

Data KnownHosts

Show KnownHosts

Typeable KnownHosts

ToPointer KnownHosts

data KnownHostResult

Constructors

MATCH

MISMATCH

NOTFOUND

FAILURE

Instances

Enum KnownHostResult

Eq KnownHostResult

Ord KnownHostResult

Show KnownHostResult

data KnownHostType

Constructors

TYPE_MASK

TYPE_PLAIN

TYPE_SHA1

TYPE_CUSTOM

KEYENC_MASK

KEYENC_RAW

KEYENC_BASE64

KEY_MASK

KEY_SHIFT

KEY_RSA1

KEY_SSHRSA

KEY_SSHDSS

Instances

Eq KnownHostType

Show KnownHostType

data KnownHost

Constructors

KnownHost

Fields

khMagic :: CUInt

khNode :: Ptr ()

khName :: String

khKey :: String

khTypeMask :: [KnownHostType]

Instances

Eq KnownHost

Show KnownHost

Session functions

initialize :: Bool -> IO ()

Initialize libssh2. Pass True to enable encryption or False to disable it.

exit :: IO ()

Deinitialize libssh2.

initSession :: IO Session

Create Session object

freeSession :: Session -> IO ()

Free Session object's memory

disconnectSession

Arguments

:: Session

-> String

Goodbye message

-> IO ()

Disconnect session (but do not free memory)

handshake :: Session -> Socket -> IO ()

Run SSH handshake on network socket.

setBlocking :: Session -> Bool -> IO ()

Known hosts functions

initKnownHosts :: Session -> IO KnownHosts

Create KnownHosts object for given session.

freeKnownHosts :: KnownHosts -> IO ()

Free KnownHosts object's memory

knownHostsReadFile

Arguments

:: KnownHosts

-> FilePath

Path to known_hosts file

-> IO Int

Read known hosts from file

getHostKey :: Session -> IO (String, Size, CInt)

Get remote host public key

checkKnownHost

Arguments

:: KnownHosts

-> String

Host name

-> Int

Port number (usually 22)

-> String

Host public key

-> [KnownHostType]

Host flags (see libssh2 documentation)

-> IO KnownHostResult

Check host data against known hosts.

Authentication

publicKeyAuthFile

Arguments

:: Session

Session

-> String

Username

-> String

Path to public key

-> String

Path to private key

-> String

Passphrase

-> IO ()

Perform public key authentication.

Channel functions

openChannelSession :: Session -> IO Channel

Open a channel for session.

closeChannel :: Channel -> IO ()

Close channel (but do not free memory)

freeChannel :: Channel -> IO ()

Free channel object's memory

channelSendEOF :: Channel -> IO ()

channelWaitEOF :: Channel -> IO ()

channelIsEOF :: Channel -> IO Bool

readChannel

Arguments

:: Channel

-> Size

Amount of data to read

-> IO ByteString

Read data from channel.

writeChannel :: Channel -> ByteString -> IO ()

Write data to channel.

writeChannelFromHandle :: Channel -> Handle -> IO Integer

Write all data to channel from handle. Returns amount of transferred data.

readChannelToHandle :: Channel -> Handle -> Offset -> IO Integer

Read all data from channel to handle. Returns amount of transferred data.

channelProcess :: Channel -> String -> String -> IO ()

channelExecute :: Channel -> String -> IO ()

Execute command

channelShell :: Channel -> IO ()

Execute shell command

requestPTY :: Channel -> String -> IO ()

requestPTYEx :: Channel -> String -> String -> Int -> Int -> Int -> Int -> IO Int

channelExitStatus :: Channel -> IO Int

Get channel exit status

channelExitSignal :: Channel -> IO (Int, String, Maybe String, Maybe String)

Get channel exit signal. Returns: (possibly error code, exit signal name, possibly error message, possibly language code).

scpSendChannel :: Session -> String -> Int -> Int64 -> POSIXTime -> POSIXTime -> IO Channel

Create SCP file send channel.

scpReceiveChannel :: Session -> FilePath -> IO (Channel, Offset)

Create SCP file receive channel. TODO: receive struct stat also.

Debug

data TraceFlag

Constructors

T_TRANS

T_KEX

T_AUTH

T_CONN

T_SCP

T_SFTP

T_ERROR

T_PUBLICKEY

T_SOCKET

Instances

Eq TraceFlag

Show TraceFlag

setTraceMode :: Session -> [TraceFlag] -> IO ()