Safe Haskell	None
Language	Haskell2010

Network.SSH.Client.LibSSH2.Foreign

Contents

Types
Session functions
Known hosts functions
Authentication
Channel functions
SFTP functions
SSH Agent functions
Debug

Synopsis

data KnownHosts
data KnownHostResult
- = MATCH
- | MISMATCH
- | NOTFOUND
- | FAILURE
data KnownHostType
- = TYPE_MASK
- | TYPE_PLAIN
- | TYPE_SHA1
- | TYPE_CUSTOM
- | KEYENC_MASK
- | KEYENC_RAW
- | KEYENC_BASE64
- | KEY_MASK
- | KEY_SHIFT
- | KEY_RSA1
- | KEY_SSHRSA
- | KEY_SSHDSS
data KnownHost = KnownHost {
- khMagic :: CUInt
- khNode :: Ptr ()
- khName :: String
- khKey :: String
- khTypeMask :: [KnownHostType]
}
initialize :: Bool -> IO ()
exit :: IO ()
initSession :: IO Session
freeSession :: Session -> IO ()
disconnectSession :: Session -> String -> IO ()
handshake :: Session -> Socket -> IO ()
setBlocking :: Session -> Bool -> IO ()
initKnownHosts :: Session -> IO KnownHosts
freeKnownHosts :: KnownHosts -> IO ()
knownHostsReadFile :: KnownHosts -> FilePath -> IO Int
getHostKey :: Session -> IO (String, Size, CInt)
checkKnownHost :: KnownHosts -> String -> Int -> String -> [KnownHostType] -> IO KnownHostResult
publicKeyAuthFile :: Session -> String -> String -> String -> String -> IO ()
usernamePasswordAuth :: Session -> String -> String -> IO ()
openChannelSession :: Session -> IO Channel
closeChannel :: Channel -> IO ()
freeChannel :: Channel -> IO ()
channelSendEOF :: Channel -> IO ()
channelWaitEOF :: Channel -> IO ()
channelIsEOF :: Channel -> IO Bool
readChannel :: Channel -> Size -> IO ByteString
writeChannel :: Channel -> ByteString -> IO ()
writeChannelFromHandle :: Channel -> Handle -> IO Integer
readChannelToHandle :: Channel -> Handle -> Offset -> IO Integer
channelProcess :: Channel -> String -> String -> IO ()
channelExecute :: Channel -> String -> IO ()
channelShell :: Channel -> IO ()
requestPTY :: Channel -> String -> IO ()
requestPTYEx :: Channel -> String -> String -> Int -> Int -> Int -> Int -> IO Int
directTcpIpEx :: Session -> String -> Int -> String -> Int -> IO Channel
channelExitStatus :: Channel -> IO Int
channelExitSignal :: Channel -> IO (Int, String, Maybe String, Maybe String)
scpSendChannel :: Session -> String -> Int -> Int64 -> POSIXTime -> POSIXTime -> IO Channel
scpReceiveChannel :: Session -> FilePath -> IO (Channel, Offset)
pollChannelRead :: Channel -> IO Bool
sftpInit :: Session -> IO Sftp
sftpShutdown :: Sftp -> IO ()
sftpOpenDir :: Sftp -> String -> IO SftpHandle
sftpReadDir :: SftpHandle -> IO (Maybe (ByteString, SftpAttributes))
sftpCloseHandle :: SftpHandle -> IO ()
sftpOpenFile :: Sftp -> String -> Int -> [SftpFileTransferFlags] -> IO SftpHandle
sftpRenameFile :: Sftp -> FilePath -> FilePath -> IO ()
sftpRenameFileEx :: Sftp -> FilePath -> FilePath -> [RenameFlag] -> IO ()
sftpWriteFileFromHandler :: SftpHandle -> Handle -> IO Integer
sftpReadFileToHandler :: SftpHandle -> Handle -> Int -> IO Int
sftpFstat :: SftpHandle -> IO SftpAttributes
sftpDeleteFile :: Sftp -> FilePath -> IO ()
data RenameFlag
- = RENAME_OVERWRITE
- | RENAME_ATOMIC
- | RENAME_NATIVE
data SftpFileTransferFlags
- = FXF_READ
- | FXF_WRITE
- | FXF_APPEND
- | FXF_CREAT
- | FXF_TRUNC
- | FXF_EXCL
data SftpAttributes = SftpAttributes {
- saFlags :: CULong
- saFileSize :: CULLong
- saUid :: CULong
- saGid :: CULong
- saPermissions :: CULong
- saAtime :: CULong
- saMtime :: CULong
}
data Agent
data AgentPublicKey
agentInit :: Session -> IO Agent
agentConnect :: Agent -> IO ()
agentDisconnect :: Agent -> IO ()
agentListIdentities :: Agent -> IO ()
agentGetIdentity :: Agent -> Maybe AgentPublicKey -> IO (Maybe AgentPublicKey)
agentGetIdentities :: Agent -> IO [AgentPublicKey]
agentFree :: Agent -> IO ()
agentPublicKeyComment :: AgentPublicKey -> IO ByteString
agentPublicKeyBlob :: AgentPublicKey -> IO ByteString
agentUserAuth :: Agent -> String -> AgentPublicKey -> IO ()
agentAuthenticate :: String -> Agent -> IO ()
data TraceFlag
- = T_TRANS
- | T_KEX
- | T_AUTH
- | T_CONN
- | T_SCP
- | T_SFTP
- | T_ERROR
- | T_PUBLICKEY
- | T_SOCKET
setTraceMode :: Session -> [TraceFlag] -> IO ()

Types

data KnownHosts Source #

Instances

Instances details

Eq KnownHosts Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Types Methods (==) :: KnownHosts -> KnownHosts -> Bool # (/=) :: KnownHosts -> KnownHosts -> Bool #
Data KnownHosts Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> KnownHosts -> c KnownHosts # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c KnownHosts # toConstr :: KnownHosts -> Constr # dataTypeOf :: KnownHosts -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c KnownHosts) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c KnownHosts) # gmapT :: (forall b. Data b => b -> b) -> KnownHosts -> KnownHosts # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> KnownHosts -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> KnownHosts -> r # gmapQ :: (forall d. Data d => d -> u) -> KnownHosts -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> KnownHosts -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> KnownHosts -> m KnownHosts # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> KnownHosts -> m KnownHosts # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> KnownHosts -> m KnownHosts #
Show KnownHosts Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Types Methods showsPrec :: Int -> KnownHosts -> ShowS # show :: KnownHosts -> String # showList :: [KnownHosts] -> ShowS #
ToPointer KnownHosts Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Types Methods toPointer :: KnownHosts -> Ptr () Source #

data KnownHostResult Source #

Constructors

MATCH
MISMATCH
NOTFOUND
FAILURE

Instances

Instances details

Enum KnownHostResult Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Foreign Methods succ :: KnownHostResult -> KnownHostResult # pred :: KnownHostResult -> KnownHostResult # toEnum :: Int -> KnownHostResult # fromEnum :: KnownHostResult -> Int # enumFrom :: KnownHostResult -> [KnownHostResult] # enumFromThen :: KnownHostResult -> KnownHostResult -> [KnownHostResult] # enumFromTo :: KnownHostResult -> KnownHostResult -> [KnownHostResult] # enumFromThenTo :: KnownHostResult -> KnownHostResult -> KnownHostResult -> [KnownHostResult] #
Eq KnownHostResult Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Foreign Methods (==) :: KnownHostResult -> KnownHostResult -> Bool # (/=) :: KnownHostResult -> KnownHostResult -> Bool #
Ord KnownHostResult Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Foreign Methods compare :: KnownHostResult -> KnownHostResult -> Ordering # (<) :: KnownHostResult -> KnownHostResult -> Bool # (<=) :: KnownHostResult -> KnownHostResult -> Bool # (>) :: KnownHostResult -> KnownHostResult -> Bool # (>=) :: KnownHostResult -> KnownHostResult -> Bool # max :: KnownHostResult -> KnownHostResult -> KnownHostResult # min :: KnownHostResult -> KnownHostResult -> KnownHostResult #
Show KnownHostResult Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Foreign Methods showsPrec :: Int -> KnownHostResult -> ShowS # show :: KnownHostResult -> String # showList :: [KnownHostResult] -> ShowS #

data KnownHostType Source #

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

Instances details

Eq KnownHostType Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Foreign Methods (==) :: KnownHostType -> KnownHostType -> Bool # (/=) :: KnownHostType -> KnownHostType -> Bool #
Show KnownHostType Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Foreign Methods showsPrec :: Int -> KnownHostType -> ShowS # show :: KnownHostType -> String # showList :: [KnownHostType] -> ShowS #

data KnownHost Source #

Constructors

KnownHost
Fields khMagic :: CUInt khNode :: Ptr () khName :: String khKey :: String khTypeMask :: [KnownHostType]

Instances

Instances details

Eq KnownHost Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Foreign Methods (==) :: KnownHost -> KnownHost -> Bool # (/=) :: KnownHost -> KnownHost -> Bool #
Show KnownHost Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Foreign Methods showsPrec :: Int -> KnownHost -> ShowS # show :: KnownHost -> String # showList :: [KnownHost] -> ShowS #

Session functions

initialize :: Bool -> IO () Source #

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

exit :: IO () Source #

Deinitialize libssh2.

initSession :: IO Session Source #

Create Session object

freeSession :: Session -> IO () Source #

Free Session object's memory

disconnectSession Source #

Arguments

:: Session
-> String	Goodbye message
-> IO ()

Disconnect session (but do not free memory)

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

Run SSH handshake on network socket.

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

Known hosts functions

initKnownHosts :: Session -> IO KnownHosts Source #

Create KnownHosts object for given session.

freeKnownHosts :: KnownHosts -> IO () Source #

Free KnownHosts object's memory

knownHostsReadFile Source #

Arguments

:: KnownHosts
-> FilePath	Path to known_hosts file
-> IO Int

Read known hosts from file

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

Get remote host public key

checkKnownHost Source #

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 Source #

Arguments

:: Session	Session
-> String	Username
-> String	Path to public key
-> String	Path to private key
-> String	Passphrase
-> IO ()

Perform public key authentication.

usernamePasswordAuth Source #

Arguments

:: Session	Session
-> String	Username
-> String	Password
-> IO ()

Perform username/password authentication.

Channel functions

openChannelSession :: Session -> IO Channel Source #

Open a channel for session.

closeChannel :: Channel -> IO () Source #

Close channel (but do not free memory)

freeChannel :: Channel -> IO () Source #

Free channel object's memory

channelSendEOF :: Channel -> IO () Source #

channelWaitEOF :: Channel -> IO () Source #

channelIsEOF :: Channel -> IO Bool Source #

readChannel Source #

Arguments

:: Channel
-> Size	Amount of data to read
-> IO ByteString

Read data from channel.

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

Write data to channel.

writeChannelFromHandle :: Channel -> Handle -> IO Integer Source #

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

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

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

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

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

Execute command

channelShell :: Channel -> IO () Source #

Execute shell command

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

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

directTcpIpEx :: Session -> String -> Int -> String -> Int -> IO Channel Source #

channelExitStatus :: Channel -> IO Int Source #

Get channel exit status

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

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 Source #

Create SCP file send channel.

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

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

pollChannelRead :: Channel -> IO Bool Source #

SFTP functions

sftpInit :: Session -> IO Sftp Source #

sftpShutdown :: Sftp -> IO () Source #

sftpOpenDir :: Sftp -> String -> IO SftpHandle Source #

Open directory file handler

sftpReadDir :: SftpHandle -> IO (Maybe (ByteString, SftpAttributes)) Source #

Read directory from file handler

sftpCloseHandle :: SftpHandle -> IO () Source #

Close file handle

sftpOpenFile :: Sftp -> String -> Int -> [SftpFileTransferFlags] -> IO SftpHandle Source #

Open regular file handler

sftpRenameFile Source #

Arguments

:: Sftp	Opened sftp session
-> FilePath	Old file name
-> FilePath	New file name
-> IO ()

Rename a file on the sftp server

sftpRenameFileEx Source #

Arguments

:: Sftp	Opened sftp session
-> FilePath	Old file name
-> FilePath	New file name
-> [RenameFlag]	Rename flags
-> IO ()

Rename a file on the sftp server

sftpWriteFileFromHandler :: SftpHandle -> Handle -> IO Integer Source #

Upload file to the sftp server

sftpReadFileToHandler :: SftpHandle -> Handle -> Int -> IO Int Source #

Download file from the sftp server

sftpFstat :: SftpHandle -> IO SftpAttributes Source #

Get sftp attributes from the sftp handler

sftpDeleteFile Source #

Arguments

:: Sftp	Opened sftp session
-> FilePath	Path to the file to be deleted
-> IO ()

Delete file from SFTP server

data RenameFlag Source #

Constructors

RENAME_OVERWRITE
RENAME_ATOMIC
RENAME_NATIVE

Instances

Instances details

Eq RenameFlag Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Foreign Methods (==) :: RenameFlag -> RenameFlag -> Bool # (/=) :: RenameFlag -> RenameFlag -> Bool #
Show RenameFlag Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Foreign Methods showsPrec :: Int -> RenameFlag -> ShowS # show :: RenameFlag -> String # showList :: [RenameFlag] -> ShowS #

data SftpFileTransferFlags Source #

Sftp support

Constructors

FXF_READ
FXF_WRITE
FXF_APPEND
FXF_CREAT
FXF_TRUNC
FXF_EXCL

Instances

Instances details

Eq SftpFileTransferFlags Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Foreign Methods (==) :: SftpFileTransferFlags -> SftpFileTransferFlags -> Bool # (/=) :: SftpFileTransferFlags -> SftpFileTransferFlags -> Bool #
Show SftpFileTransferFlags Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Foreign Methods showsPrec :: Int -> SftpFileTransferFlags -> ShowS # show :: SftpFileTransferFlags -> String # showList :: [SftpFileTransferFlags] -> ShowS #

data SftpAttributes Source #

Constructors

SftpAttributes
Fields saFlags :: CULong saFileSize :: CULLong saUid :: CULong saGid :: CULong saPermissions :: CULong saAtime :: CULong saMtime :: CULong

Instances

Instances details

Eq SftpAttributes Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Foreign Methods (==) :: SftpAttributes -> SftpAttributes -> Bool # (/=) :: SftpAttributes -> SftpAttributes -> Bool #
Show SftpAttributes Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Foreign Methods showsPrec :: Int -> SftpAttributes -> ShowS # show :: SftpAttributes -> String # showList :: [SftpAttributes] -> ShowS #

SSH Agent functions

data Agent Source #

Instances

Instances details

Show Agent Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Types Methods showsPrec :: Int -> Agent -> ShowS # show :: Agent -> String # showList :: [Agent] -> ShowS #
ToPointer Agent Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Types Methods toPointer :: Agent -> Ptr () Source #

data AgentPublicKey Source #

Instances

Instances details

Eq AgentPublicKey Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Types Methods (==) :: AgentPublicKey -> AgentPublicKey -> Bool # (/=) :: AgentPublicKey -> AgentPublicKey -> Bool #
Data AgentPublicKey Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AgentPublicKey -> c AgentPublicKey # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AgentPublicKey # toConstr :: AgentPublicKey -> Constr # dataTypeOf :: AgentPublicKey -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AgentPublicKey) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AgentPublicKey) # gmapT :: (forall b. Data b => b -> b) -> AgentPublicKey -> AgentPublicKey # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AgentPublicKey -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AgentPublicKey -> r # gmapQ :: (forall d. Data d => d -> u) -> AgentPublicKey -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AgentPublicKey -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AgentPublicKey -> m AgentPublicKey # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AgentPublicKey -> m AgentPublicKey # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AgentPublicKey -> m AgentPublicKey #
Show AgentPublicKey Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Types Methods showsPrec :: Int -> AgentPublicKey -> ShowS # show :: AgentPublicKey -> String # showList :: [AgentPublicKey] -> ShowS #

agentInit :: Session -> IO Agent Source #

Agent support

Initialize a new ssh agent handle.

agentConnect :: Agent -> IO () Source #

Attempt to establish a connection to an ssh agent process. | The environment variable SSH_AUTH_SOCK is used to determine where to connect on unix.

agentDisconnect :: Agent -> IO () Source #

Cleans up a connection to an ssh agent.

agentListIdentities :: Agent -> IO () Source #

Get or update the list of known identities. Must be called at least once.

agentGetIdentity Source #

Arguments

:: Agent	Agent handle.
-> Maybe AgentPublicKey	Previous key returned.
-> IO (Maybe AgentPublicKey)

Copies one identity from the agent to the local process.

agentGetIdentities :: Agent -> IO [AgentPublicKey] Source #

Copies all the keys from the agent to the local process.

agentFree :: Agent -> IO () Source #

agentPublicKeyComment :: AgentPublicKey -> IO ByteString Source #

Return the comment from the given agent public key.

agentPublicKeyBlob :: AgentPublicKey -> IO ByteString Source #

Return the bytes of the given agent public key.

agentUserAuth Source #

Arguments

:: Agent	Agent handle.
-> String	Username to authenticate with.
-> AgentPublicKey	Public key to use from the agent.
-> IO ()

Perform agent based public key authentication. You almost certainly want @agentAuthenticate instead of this, since this only does one round of authentication with the agent.

agentAuthenticate Source #

Arguments

:: String	Remote user name.
-> Agent	Connection to an agent.
-> IO ()

Authenticate with an ssh agent. Takes a user and an agent and tries each key from the agent in succession. Throws AUTHENTICATION_FAILED if it's unable to authenticate. If you call this, you need to call @agentListIdentities at least once.

Debug

data TraceFlag Source #

Constructors

T_TRANS
T_KEX
T_AUTH
T_CONN
T_SCP
T_SFTP
T_ERROR
T_PUBLICKEY
T_SOCKET

Instances

Instances details

Eq TraceFlag Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Foreign Methods (==) :: TraceFlag -> TraceFlag -> Bool # (/=) :: TraceFlag -> TraceFlag -> Bool #
Show TraceFlag Source #
Instance details Defined in Network.SSH.Client.LibSSH2.Foreign Methods showsPrec :: Int -> TraceFlag -> ShowS # show :: TraceFlag -> String # showList :: [TraceFlag] -> ShowS #

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