Maintainer	defanor <[email protected]>
Stability	unstable
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Network.LibSSH.Core

Contents

Types
The libssh SFTP API
The libssh API

Description

See the libssh topics for a reference.

Synopsis

data SSHKeyStruct
type SSHKey = Ptr SSHKeyStruct
data SSHSessionStruct
type SSHSession = Ptr SSHSessionStruct
data SSHChannelStruct
type SSHChannel = Ptr SSHChannelStruct
data SFTPSessionStruct
type SFTPSession = Ptr SFTPSessionStruct
data SFTPFileStruct
type SFTPFile = Ptr SFTPFileStruct
data SFTPDirStruct
type SFTPDir = Ptr SFTPDirStruct
data SFTPAttributesStruct
type SFTPAttributes = Ptr SFTPAttributesStruct
data SFTPStatvfsStruct
type SFTPStatsvfs = Ptr SFTPStatvfsStruct
type SSHAuthCallback = FunPtr (CString -> CString -> CSize -> CInt -> CInt -> Ptr CChar -> CInt)
type SSHOptionCode = CInt
sshOptionsHost :: SSHOptionCode
sshOptionsPort :: SSHOptionCode
sshOptionsPortStr :: SSHOptionCode
sshOptionsFd :: SSHOptionCode
sshOptionsBindaddr :: SSHOptionCode
sshOptionsUser :: SSHOptionCode
sshOptionsSSHDir :: SSHOptionCode
sshOptionsKnownhosts :: SSHOptionCode
sshOptionsIdentity :: SSHOptionCode
sshOptionsAddIdentity :: SSHOptionCode
sshOptionsTimeout :: SSHOptionCode
sshOptionsTimeoutUsec :: SSHOptionCode
type SSHAuthMethodCode = CInt
sshAuthMethodUnknown :: SSHAuthMethodCode
sshAuthMethodNone :: SSHAuthMethodCode
sshAuthMethodPassword :: SSHAuthMethodCode
sshAuthMethodPublickey :: SSHAuthMethodCode
sshAuthMethodHostbased :: SSHAuthMethodCode
sshAuthMethodInteractive :: SSHAuthMethodCode
sshAuthMethodGssapiMic :: SSHAuthMethodCode
type SSHKeyType = CInt
sshKeytypeUnknown :: SSHKeyType
sshKeytypeRsa :: SSHKeyType
sshKeytypeRsa1 :: SSHKeyType
sshKeytypeEcdsa :: SSHKeyType
sshKeytypeEd25519 :: SSHKeyType
sftp_new :: SSHSession -> IO SFTPSession
sftp_new_channel :: SSHSession -> SSHChannel -> IO SFTPSession
sftp_free :: SFTPSession -> IO ()
sftp_init :: SFTPSession -> IO CInt
sftp_get_error :: SFTPSession -> IO CInt
sftp_extensions_get_count :: SFTPSession -> IO CInt
sftp_extensions_get_name :: SFTPSession -> CUInt -> IO CString
sftp_extensions_get_data :: SFTPSession -> CUInt -> IO CString
sftp_extension_extension_supported :: SFTPSession -> CString -> CString -> IO CInt
sftp_opendir :: SFTPSession -> CString -> IO SFTPDir
sftp_readdir :: SFTPSession -> SFTPDir -> IO SFTPAttributes
sftp_dir_eof :: SFTPDir -> IO CInt
sftp_stat :: SFTPSession -> CString -> IO SFTPAttributes
sftp_lstat :: SFTPSession -> CString -> IO SFTPAttributes
sftp_fstat :: SFTPFile -> IO SFTPAttributes
sftp_attributes_free :: SFTPAttributes -> IO ()
sftp_closedir :: SFTPDir -> IO CInt
sftp_close :: SFTPFile -> IO CInt
sftp_open :: SFTPSession -> CString -> CInt -> CInt -> IO SFTPFile
sftp_file_set_nonblocking :: SFTPFile -> IO ()
sftp_file_set_blocking :: SFTPFile -> IO ()
sftp_read :: SFTPFile -> CString -> CSize -> IO CInt
sftp_async_read_begin :: SFTPFile -> CUInt -> IO CInt
sftp_async_read :: SFTPFile -> CString -> CUInt -> CUInt -> IO CInt
sftp_write :: SFTPFile -> CString -> CSize -> IO CInt
sftp_seek :: SFTPFile -> CUInt -> IO CInt
sftp_seek64 :: SFTPFile -> CULLong -> IO CInt
sftp_tell :: SFTPFile -> IO CUInt
sftp_tell64 :: SFTPFile -> IO CULLong
sftp_rewind :: SFTPFile -> IO ()
sftp_unlink :: SFTPSession -> CString -> IO CInt
sftp_rmdir :: SFTPSession -> CString -> IO CInt
sftp_mkdir :: SFTPSession -> CString -> CInt -> IO CInt
sftp_rename :: SFTPSession -> CString -> CString -> IO CInt
sftp_setstat :: SFTPSession -> CString -> SFTPAttributes -> IO CInt
sftp_chown :: SFTPSession -> CString -> CInt -> CInt -> IO CInt
sftp_chmod :: SFTPSession -> CString -> CInt -> IO CInt
sftp_symlink :: SFTPSession -> CString -> CString -> IO CInt
sftp_readlink :: SFTPSession -> CString -> IO CString
sftp_fsync :: SFTPFile -> IO CInt
ssh_init :: IO CInt
ssh_finalize :: IO CInt
ssh_set_agent_channel :: SSHSession -> SSHChannel -> IO CInt
ssh_set_agent_socket :: SSHSession -> CInt -> IO CInt
ssh_userauth_list :: SSHSession -> CString -> IO SSHAuthMethodCode
ssh_userauth_none :: SSHSession -> CString -> IO CInt
ssh_userauth_try_publickey :: SSHSession -> CString -> SSHKey -> IO CInt
ssh_userauth_publickey :: SSHSession -> CString -> SSHKey -> IO CInt
ssh_userauth_agent :: SSHSession -> CString -> IO CInt
ssh_userauth_publickey_auto :: SSHSession -> CString -> CString -> IO CInt
ssh_userauth_password :: SSHSession -> CString -> CString -> IO CInt
ssh_userauth_gssapi :: SSHSession -> IO CInt
ssh_channel_new :: SSHSession -> IO SSHChannel
ssh_channel_open_session :: SSHChannel -> IO CInt
ssh_channel_free :: SSHChannel -> IO ()
ssh_channel_send_eof :: SSHChannel -> IO CInt
ssh_channel_close :: SSHChannel -> IO CInt
ssh_channel_write :: SSHChannel -> CString -> CUInt -> IO CInt
ssh_channel_is_open :: SSHChannel -> IO CInt
ssh_channel_is_closed :: SSHChannel -> IO CInt
ssh_channel_is_eof :: SSHChannel -> IO CInt
ssh_channel_set_blocking :: SSHChannel -> CInt -> IO ()
ssh_channel_request_pty :: SSHChannel -> IO CInt
ssh_channel_request_shell :: SSHChannel -> IO CInt
ssh_channel_request_subsystem :: SSHChannel -> CString -> IO CInt
ssh_channel_request_sftp :: SSHChannel -> IO CInt
ssh_channel_request_auth_agent :: SSHChannel -> IO CInt
ssh_channel_request_exec :: SSHChannel -> CString -> IO CInt
ssh_channel_request_send_signal :: SSHChannel -> CString -> IO CInt
ssh_channel_request_send_break :: SSHChannel -> CUInt -> IO CInt
ssh_channel_read :: SSHChannel -> CString -> CUInt -> CInt -> IO CInt
ssh_channel_read_timeout :: SSHChannel -> CString -> CUInt -> CInt -> CInt -> IO CInt
ssh_channel_read_nonblocking :: SSHChannel -> CString -> CUInt -> CInt -> IO CInt
ssh_channel_poll :: SSHChannel -> CInt -> IO CInt
ssh_channel_poll_timeout :: SSHChannel -> CInt -> CInt -> IO CInt
ssh_channel_get_session :: SSHChannel -> IO SSHSession
ssh_channel_get_exit_status :: SSHChannel -> IO CInt
ssh_get_error :: Ptr () -> IO CString
ssh_get_error_code :: Ptr () -> IO CInt
ssh_set_log_level :: CInt -> IO CInt
ssh_get_log_level :: IO CInt
ssh_version :: CInt -> IO CString
ssh_key_new :: IO SSHKey
ssh_key_free :: SSHKey -> IO ()
ssh_key_type :: SSHKey -> IO SSHKeyType
ssh_key_type_from_name :: CString -> IO SSHKeyType
ssh_key_is_public :: SSHKey -> IO CInt
ssh_key_is_private :: SSHKey -> IO CInt
ssh_pki_import_privkey_base64 :: CString -> CString -> SSHAuthCallback -> Ptr () -> Ptr SSHKey -> IO CInt
ssh_pki_import_privkey_file :: CString -> CString -> SSHAuthCallback -> Ptr () -> Ptr SSHKey -> IO CInt
ssh_pki_import_pubkey_base64 :: CString -> SSHKeyType -> Ptr SSHKey -> IO CInt
ssh_pki_import_pubkey_file :: CString -> Ptr SSHKey -> IO CInt
ssh_pki_import_cert_base64 :: CString -> SSHKeyType -> Ptr SSHKey -> IO CInt
ssh_pki_import_cert_file :: CString -> Ptr SSHKey -> IO CInt
ssh_pki_generate :: SSHKeyType -> CInt -> Ptr SSHKey -> IO CInt
ssh_pki_export_privkey_to_pubkey :: SSHKey -> Ptr SSHKey -> IO CInt
ssh_service_request :: SSHSession -> CString -> IO CInt
ssh_connect :: SSHSession -> IO CInt
ssh_get_issue_banner :: SSHSession -> IO CString
ssh_get_openssh_version :: SSHSession -> IO CInt
ssh_copyright :: IO CString
ssh_disconnect :: SSHSession -> IO ()
ssh_options_copy :: SSHSession -> Ptr SSHSession -> IO CInt
ssh_options_set :: SSHSession -> SSHOptionCode -> Ptr () -> IO CInt
ssh_options_parse_config :: SSHSession -> CString -> IO CInt
ssh_new :: IO SSHSession
ssh_free :: SSHSession -> IO ()
ssh_silent_disconnect :: SSHSession -> IO ()
ssh_set_blocking :: SSHSession -> CInt -> IO ()
ssh_is_blocking :: SSHSession -> IO CInt
ssh_blocking_flush :: SSHSession -> CInt -> IO CInt
ssh_is_connected :: SSHSession -> IO CInt
ssh_get_status :: SSHSession -> IO CInt
ssh_get_poll_flags :: SSHSession -> IO CInt
ssh_get_disconnect_message :: SSHSession -> IO CString
ssh_get_version :: SSHSession -> IO CInt
ssh_send_ignore :: SSHSession -> CString -> IO CInt
ssh_send_debug :: SSHSession -> CString -> CInt -> IO CInt

Types

data SSHKeyStruct Source #

type SSHKey = Ptr SSHKeyStruct Source #

data SSHSessionStruct Source #

type SSHSession = Ptr SSHSessionStruct Source #

data SSHChannelStruct Source #

type SSHChannel = Ptr SSHChannelStruct Source #

data SFTPSessionStruct Source #

type SFTPSession = Ptr SFTPSessionStruct Source #

data SFTPFileStruct Source #

type SFTPFile = Ptr SFTPFileStruct Source #

data SFTPDirStruct Source #

type SFTPDir = Ptr SFTPDirStruct Source #

data SFTPAttributesStruct Source #

type SFTPAttributes = Ptr SFTPAttributesStruct Source #

data SFTPStatvfsStruct Source #

type SFTPStatsvfs = Ptr SFTPStatvfsStruct Source #

type SSHAuthCallback = FunPtr (CString -> CString -> CSize -> CInt -> CInt -> Ptr CChar -> CInt) Source #

Option codes

type SSHOptionCode = CInt Source #

sshOptionsHost :: SSHOptionCode Source #

sshOptionsPort :: SSHOptionCode Source #

sshOptionsPortStr :: SSHOptionCode Source #

sshOptionsFd :: SSHOptionCode Source #

sshOptionsBindaddr :: SSHOptionCode Source #

sshOptionsUser :: SSHOptionCode Source #

sshOptionsSSHDir :: SSHOptionCode Source #

sshOptionsKnownhosts :: SSHOptionCode Source #

sshOptionsIdentity :: SSHOptionCode Source #

sshOptionsAddIdentity :: SSHOptionCode Source #

sshOptionsTimeout :: SSHOptionCode Source #

sshOptionsTimeoutUsec :: SSHOptionCode Source #

Authentication method codes

type SSHAuthMethodCode = CInt Source #

sshAuthMethodUnknown :: SSHAuthMethodCode Source #

sshAuthMethodNone :: SSHAuthMethodCode Source #

sshAuthMethodPassword :: SSHAuthMethodCode Source #

sshAuthMethodPublickey :: SSHAuthMethodCode Source #

sshAuthMethodHostbased :: SSHAuthMethodCode Source #

sshAuthMethodInteractive :: SSHAuthMethodCode Source #

sshAuthMethodGssapiMic :: SSHAuthMethodCode Source #

Key types

type SSHKeyType = CInt Source #

sshKeytypeUnknown :: SSHKeyType Source #

sshKeytypeRsa :: SSHKeyType Source #

sshKeytypeRsa1 :: SSHKeyType Source #

sshKeytypeEcdsa :: SSHKeyType Source #

sshKeytypeEd25519 :: SSHKeyType Source #

The libssh SFTP API

sftp_new :: SSHSession -> IO SFTPSession Source #

sftp_new_channel :: SSHSession -> SSHChannel -> IO SFTPSession Source #

sftp_free :: SFTPSession -> IO () Source #

sftp_init :: SFTPSession -> IO CInt Source #

sftp_get_error :: SFTPSession -> IO CInt Source #

sftp_extensions_get_count :: SFTPSession -> IO CInt Source #

sftp_extensions_get_name :: SFTPSession -> CUInt -> IO CString Source #

sftp_extensions_get_data :: SFTPSession -> CUInt -> IO CString Source #

sftp_extension_extension_supported :: SFTPSession -> CString -> CString -> IO CInt Source #

sftp_opendir :: SFTPSession -> CString -> IO SFTPDir Source #

sftp_readdir :: SFTPSession -> SFTPDir -> IO SFTPAttributes Source #

sftp_dir_eof :: SFTPDir -> IO CInt Source #

sftp_stat :: SFTPSession -> CString -> IO SFTPAttributes Source #

sftp_lstat :: SFTPSession -> CString -> IO SFTPAttributes Source #

sftp_fstat :: SFTPFile -> IO SFTPAttributes Source #

sftp_attributes_free :: SFTPAttributes -> IO () Source #

sftp_closedir :: SFTPDir -> IO CInt Source #

sftp_close :: SFTPFile -> IO CInt Source #

sftp_open :: SFTPSession -> CString -> CInt -> CInt -> IO SFTPFile Source #

sftp_file_set_nonblocking :: SFTPFile -> IO () Source #

sftp_file_set_blocking :: SFTPFile -> IO () Source #

sftp_read :: SFTPFile -> CString -> CSize -> IO CInt Source #

sftp_async_read_begin :: SFTPFile -> CUInt -> IO CInt Source #

sftp_async_read :: SFTPFile -> CString -> CUInt -> CUInt -> IO CInt Source #

sftp_write :: SFTPFile -> CString -> CSize -> IO CInt Source #

sftp_seek :: SFTPFile -> CUInt -> IO CInt Source #

sftp_seek64 :: SFTPFile -> CULLong -> IO CInt Source #

sftp_tell :: SFTPFile -> IO CUInt Source #

sftp_tell64 :: SFTPFile -> IO CULLong Source #

sftp_rewind :: SFTPFile -> IO () Source #

sftp_unlink :: SFTPSession -> CString -> IO CInt Source #

sftp_rmdir :: SFTPSession -> CString -> IO CInt Source #

sftp_mkdir :: SFTPSession -> CString -> CInt -> IO CInt Source #

sftp_rename :: SFTPSession -> CString -> CString -> IO CInt Source #

sftp_setstat :: SFTPSession -> CString -> SFTPAttributes -> IO CInt Source #

sftp_chown :: SFTPSession -> CString -> CInt -> CInt -> IO CInt Source #

sftp_chmod :: SFTPSession -> CString -> CInt -> IO CInt Source #

sftp_symlink :: SFTPSession -> CString -> CString -> IO CInt Source #

sftp_readlink :: SFTPSession -> CString -> IO CString Source #

sftp_fsync :: SFTPFile -> IO CInt Source #

The libssh API

ssh_init :: IO CInt Source #

ssh_finalize :: IO CInt Source #

The SSH authentication functions

ssh_set_agent_channel :: SSHSession -> SSHChannel -> IO CInt Source #

ssh_set_agent_socket :: SSHSession -> CInt -> IO CInt Source #

ssh_userauth_list :: SSHSession -> CString -> IO SSHAuthMethodCode Source #

ssh_userauth_none :: SSHSession -> CString -> IO CInt Source #

ssh_userauth_try_publickey :: SSHSession -> CString -> SSHKey -> IO CInt Source #

ssh_userauth_publickey :: SSHSession -> CString -> SSHKey -> IO CInt Source #

ssh_userauth_agent :: SSHSession -> CString -> IO CInt Source #

ssh_userauth_publickey_auto :: SSHSession -> CString -> CString -> IO CInt Source #

ssh_userauth_password :: SSHSession -> CString -> CString -> IO CInt Source #

ssh_userauth_gssapi :: SSHSession -> IO CInt Source #

The SSH channel functions

ssh_channel_new :: SSHSession -> IO SSHChannel Source #

ssh_channel_open_session :: SSHChannel -> IO CInt Source #

ssh_channel_free :: SSHChannel -> IO () Source #

ssh_channel_send_eof :: SSHChannel -> IO CInt Source #

ssh_channel_close :: SSHChannel -> IO CInt Source #

ssh_channel_write :: SSHChannel -> CString -> CUInt -> IO CInt Source #

ssh_channel_is_open :: SSHChannel -> IO CInt Source #

ssh_channel_is_closed :: SSHChannel -> IO CInt Source #

ssh_channel_is_eof :: SSHChannel -> IO CInt Source #

ssh_channel_set_blocking :: SSHChannel -> CInt -> IO () Source #

ssh_channel_request_pty :: SSHChannel -> IO CInt Source #

ssh_channel_request_shell :: SSHChannel -> IO CInt Source #

ssh_channel_request_subsystem :: SSHChannel -> CString -> IO CInt Source #

ssh_channel_request_sftp :: SSHChannel -> IO CInt Source #

ssh_channel_request_auth_agent :: SSHChannel -> IO CInt Source #

ssh_channel_request_exec :: SSHChannel -> CString -> IO CInt Source #

ssh_channel_request_send_signal :: SSHChannel -> CString -> IO CInt Source #

ssh_channel_request_send_break :: SSHChannel -> CUInt -> IO CInt Source #

ssh_channel_read :: SSHChannel -> CString -> CUInt -> CInt -> IO CInt Source #

ssh_channel_read_timeout :: SSHChannel -> CString -> CUInt -> CInt -> CInt -> IO CInt Source #

ssh_channel_read_nonblocking :: SSHChannel -> CString -> CUInt -> CInt -> IO CInt Source #

ssh_channel_poll :: SSHChannel -> CInt -> IO CInt Source #

ssh_channel_poll_timeout :: SSHChannel -> CInt -> CInt -> IO CInt Source #

ssh_channel_get_session :: SSHChannel -> IO SSHSession Source #

ssh_channel_get_exit_status :: SSHChannel -> IO CInt Source #

The SSH error functions

ssh_get_error :: Ptr () -> IO CString Source #

ssh_get_error_code :: Ptr () -> IO CInt Source #

The SSH logging functions

ssh_set_log_level :: CInt -> IO CInt Source #

ssh_get_log_level :: IO CInt Source #

The SSH helper functions

ssh_version :: CInt -> IO CString Source #

The SSH Public Key Infrastructure

ssh_key_new :: IO SSHKey Source #

ssh_key_free :: SSHKey -> IO () Source #

ssh_key_type :: SSHKey -> IO SSHKeyType Source #

ssh_key_type_from_name :: CString -> IO SSHKeyType Source #

ssh_key_is_public :: SSHKey -> IO CInt Source #

ssh_key_is_private :: SSHKey -> IO CInt Source #

ssh_pki_import_privkey_base64 :: CString -> CString -> SSHAuthCallback -> Ptr () -> Ptr SSHKey -> IO CInt Source #

ssh_pki_import_privkey_file :: CString -> CString -> SSHAuthCallback -> Ptr () -> Ptr SSHKey -> IO CInt Source #

ssh_pki_import_pubkey_base64 :: CString -> SSHKeyType -> Ptr SSHKey -> IO CInt Source #

ssh_pki_import_pubkey_file :: CString -> Ptr SSHKey -> IO CInt Source #

ssh_pki_import_cert_base64 :: CString -> SSHKeyType -> Ptr SSHKey -> IO CInt Source #

ssh_pki_import_cert_file :: CString -> Ptr SSHKey -> IO CInt Source #

ssh_pki_generate :: SSHKeyType -> CInt -> Ptr SSHKey -> IO CInt Source #

ssh_pki_export_privkey_to_pubkey :: SSHKey -> Ptr SSHKey -> IO CInt Source #

The SSH session functions

ssh_service_request :: SSHSession -> CString -> IO CInt Source #

ssh_connect :: SSHSession -> IO CInt Source #

ssh_get_issue_banner :: SSHSession -> IO CString Source #

ssh_get_openssh_version :: SSHSession -> IO CInt Source #

ssh_copyright :: IO CString Source #

ssh_disconnect :: SSHSession -> IO () Source #

ssh_options_copy :: SSHSession -> Ptr SSHSession -> IO CInt Source #

ssh_options_set :: SSHSession -> SSHOptionCode -> Ptr () -> IO CInt Source #

ssh_options_parse_config :: SSHSession -> CString -> IO CInt Source #

ssh_new :: IO SSHSession Source #

ssh_free :: SSHSession -> IO () Source #

ssh_silent_disconnect :: SSHSession -> IO () Source #

ssh_set_blocking :: SSHSession -> CInt -> IO () Source #

ssh_is_blocking :: SSHSession -> IO CInt Source #

ssh_blocking_flush :: SSHSession -> CInt -> IO CInt Source #

ssh_is_connected :: SSHSession -> IO CInt Source #

ssh_get_status :: SSHSession -> IO CInt Source #

ssh_get_poll_flags :: SSHSession -> IO CInt Source #

ssh_get_disconnect_message :: SSHSession -> IO CString Source #

ssh_get_version :: SSHSession -> IO CInt Source #

ssh_send_ignore :: SSHSession -> CString -> IO CInt Source #

ssh_send_debug :: SSHSession -> CString -> CInt -> IO CInt Source #