Network.SSH.Internal

Documentation

data HostKeyAlgorithm

Constructors

SshEd25519

Instances

Eq HostKeyAlgorithm

Defined in Network.SSH.Algorithms

Methods

(==) :: HostKeyAlgorithm -> HostKeyAlgorithm -> Bool

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

Show HostKeyAlgorithm

Defined in Network.SSH.Algorithms

Methods

showsPrec :: Int -> HostKeyAlgorithm -> ShowS

show :: HostKeyAlgorithm -> String

showList :: [HostKeyAlgorithm] -> ShowS

HasName HostKeyAlgorithm

Defined in Network.SSH.Algorithms

Methods

name :: HostKeyAlgorithm -> Name

data KeyExchangeAlgorithm

Constructors

Curve25519Sha256AtLibsshDotOrg

Instances

Eq KeyExchangeAlgorithm

Defined in Network.SSH.Algorithms

Methods

(==) :: KeyExchangeAlgorithm -> KeyExchangeAlgorithm -> Bool

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

Show KeyExchangeAlgorithm

Defined in Network.SSH.Algorithms

Methods

showsPrec :: Int -> KeyExchangeAlgorithm -> ShowS

show :: KeyExchangeAlgorithm -> String

showList :: [KeyExchangeAlgorithm] -> ShowS

HasName KeyExchangeAlgorithm

Defined in Network.SSH.Algorithms

Methods

name :: KeyExchangeAlgorithm -> Name

data EncryptionAlgorithm

Constructors

Chacha20Poly1305AtOpensshDotCom

Instances

Eq EncryptionAlgorithm

Defined in Network.SSH.Algorithms

Methods

(==) :: EncryptionAlgorithm -> EncryptionAlgorithm -> Bool

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

Show EncryptionAlgorithm

Defined in Network.SSH.Algorithms

Methods

showsPrec :: Int -> EncryptionAlgorithm -> ShowS

show :: EncryptionAlgorithm -> String

showList :: [EncryptionAlgorithm] -> ShowS

HasName EncryptionAlgorithm

Defined in Network.SSH.Algorithms

Methods

name :: EncryptionAlgorithm -> Name

data CompressionAlgorithm

Constructors

None

Instances

Eq CompressionAlgorithm

Defined in Network.SSH.Algorithms

Methods

(==) :: CompressionAlgorithm -> CompressionAlgorithm -> Bool

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

Show CompressionAlgorithm

Defined in Network.SSH.Algorithms

Methods

showsPrec :: Int -> CompressionAlgorithm -> ShowS

show :: CompressionAlgorithm -> String

showList :: [CompressionAlgorithm] -> ShowS

HasName CompressionAlgorithm

Defined in Network.SSH.Algorithms

Methods

name :: CompressionAlgorithm -> Name

type Get = Get

class Encoding a where

Methods

put :: forall b. Builder b => a -> b

get :: Get a

Instances

Encoding PublicKey

Defined in Network.SSH.Message

Methods

put :: Builder b => PublicKey -> b

get :: Get PublicKey

Encoding PublicKey

Defined in Network.SSH.Message

Methods

put :: Builder b => PublicKey -> b

get :: Get PublicKey

Encoding Signature

Defined in Network.SSH.Message

Methods

put :: Builder b => Signature -> b

get :: Get Signature

Encoding DisconnectReason

Defined in Network.SSH.Message

Methods

put :: Builder b => DisconnectReason -> b

get :: Get DisconnectReason

Encoding PublicKey

Defined in Network.SSH.Message

Methods

put :: Builder b => PublicKey -> b

get :: Get PublicKey

Encoding ChannelId

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelId -> b

get :: Get ChannelId

Encoding ChannelType

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelType -> b

get :: Get ChannelType

Encoding SessionId

Defined in Network.SSH.Message

Methods

put :: Builder b => SessionId -> b

get :: Get SessionId

Encoding Version

Defined in Network.SSH.Message

Methods

put :: Builder b => Version -> b

get :: Get Version

Encoding Cookie

Defined in Network.SSH.Message

Methods

put :: Builder b => Cookie -> b

get :: Get Cookie

Encoding PtySettings

Defined in Network.SSH.Message

Methods

put :: Builder b => PtySettings -> b

get :: Get PtySettings

Encoding Signature

Defined in Network.SSH.Message

Methods

put :: Builder b => Signature -> b

get :: Get Signature

Encoding AuthMethod

Defined in Network.SSH.Message

Methods

put :: Builder b => AuthMethod -> b

get :: Get AuthMethod

Encoding ChannelFailure

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelFailure -> b

get :: Get ChannelFailure

Encoding ChannelSuccess

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelSuccess -> b

get :: Get ChannelSuccess

Encoding ChannelRequestExitSignal

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelRequestExitSignal -> b

get :: Get ChannelRequestExitSignal

Encoding ChannelRequestExitStatus

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelRequestExitStatus -> b

get :: Get ChannelRequestExitStatus

Encoding ChannelRequestSignal

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelRequestSignal -> b

get :: Get ChannelRequestSignal

Encoding ChannelRequestExec

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelRequestExec -> b

get :: Get ChannelRequestExec

Encoding ChannelRequestShell

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelRequestShell -> b

get :: Get ChannelRequestShell

Encoding ChannelRequestWindowChange

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelRequestWindowChange -> b

get :: Get ChannelRequestWindowChange

Encoding ChannelRequestPty

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelRequestPty -> b

get :: Get ChannelRequestPty

Encoding ChannelRequestEnv

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelRequestEnv -> b

get :: Get ChannelRequestEnv

Encoding ChannelRequest

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelRequest -> b

get :: Get ChannelRequest

Encoding ChannelClose

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelClose -> b

get :: Get ChannelClose

Encoding ChannelEof

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelEof -> b

get :: Get ChannelEof

Encoding ChannelExtendedData

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelExtendedData -> b

get :: Get ChannelExtendedData

Encoding ChannelData

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelData -> b

get :: Get ChannelData

Encoding ChannelWindowAdjust

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelWindowAdjust -> b

get :: Get ChannelWindowAdjust

Encoding ChannelOpenFailureReason

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelOpenFailureReason -> b

get :: Get ChannelOpenFailureReason

Encoding ChannelOpenFailure

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelOpenFailure -> b

get :: Get ChannelOpenFailure

Encoding ChannelOpenConfirmation

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelOpenConfirmation -> b

get :: Get ChannelOpenConfirmation

Encoding ChannelOpen

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelOpen -> b

get :: Get ChannelOpen

Encoding UserAuthPublicKeyOk

Defined in Network.SSH.Message

Methods

put :: Builder b => UserAuthPublicKeyOk -> b

get :: Get UserAuthPublicKeyOk

Encoding UserAuthBanner

Defined in Network.SSH.Message

Methods

put :: Builder b => UserAuthBanner -> b

get :: Get UserAuthBanner

Encoding UserAuthSuccess

Defined in Network.SSH.Message

Methods

put :: Builder b => UserAuthSuccess -> b

get :: Get UserAuthSuccess

Encoding UserAuthFailure

Defined in Network.SSH.Message

Methods

put :: Builder b => UserAuthFailure -> b

get :: Get UserAuthFailure

Encoding UserAuthRequest

Defined in Network.SSH.Message

Methods

put :: Builder b => UserAuthRequest -> b

get :: Get UserAuthRequest

Encoding KexEcdhReply

Defined in Network.SSH.Message

Methods

put :: Builder b => KexEcdhReply -> b

get :: Get KexEcdhReply

Encoding KexEcdhInit

Defined in Network.SSH.Message

Methods

put :: Builder b => KexEcdhInit -> b

get :: Get KexEcdhInit

Encoding KexNewKeys

Defined in Network.SSH.Message

Methods

put :: Builder b => KexNewKeys -> b

get :: Get KexNewKeys

Encoding KexInit

Defined in Network.SSH.Message

Methods

put :: Builder b => KexInit -> b

get :: Get KexInit

Encoding ServiceAccept

Defined in Network.SSH.Message

Methods

put :: Builder b => ServiceAccept -> b

get :: Get ServiceAccept

Encoding ServiceRequest

Defined in Network.SSH.Message

Methods

put :: Builder b => ServiceRequest -> b

get :: Get ServiceRequest

Encoding Debug

Defined in Network.SSH.Message

Methods

put :: Builder b => Debug -> b

get :: Get Debug

Encoding Unimplemented

Defined in Network.SSH.Message

Methods

put :: Builder b => Unimplemented -> b

get :: Get Unimplemented

Encoding Ignore

Defined in Network.SSH.Message

Methods

put :: Builder b => Ignore -> b

get :: Get Ignore

Encoding Disconnected

Defined in Network.SSH.Message

Methods

put :: Builder b => Disconnected -> b

get :: Get Disconnected

Encoding Message

Defined in Network.SSH.Message

Methods

put :: Builder b => Message -> b

get :: Get Message

Encoding ConnectionMsg

Defined in Network.SSH.Server.Service.Connection

Methods

put :: Builder b => ConnectionMsg -> b

get :: Get ConnectionMsg

runPut :: ByteArrayBuilder -> ByteString

runGet :: (MonadFail m, Encoding a) => ByteString -> m a

putExitCode :: Builder b => ExitCode -> b

getExitCode :: Get ExitCode

getFramed :: Get a -> Get a

putWord8 :: Builder b => Word8 -> b

getWord8 :: Get Word8

expectWord8 :: Word8 -> Get ()

getWord32 :: Get Word32

putBytes :: Builder b => ByteArrayAccess ba => ba -> b

getBytes :: ByteArray ba => Word32 -> Get ba

lenByteString :: ByteString -> Word32

putByteString :: Builder b => ByteString -> b

getByteString :: Word32 -> Get ByteString

getRemainingByteString :: Get ByteString

putString :: (Builder b, ByteArrayAccess ba) => ba -> b

putShortString :: Builder b => ShortByteString -> b

getShortString :: Get ShortByteString

getString :: ByteArray ba => Get ba

getName :: Get Name

putName :: Builder b => Name -> b

putBool :: Builder b => Bool -> b

getBool :: Get Bool

getTrue :: Get ()

getFalse :: Get ()

putAsMPInt :: (Builder b, ByteArrayAccess ba) => ba -> b

data Disconnect

Constructors

Disconnect DisconnectParty DisconnectReason DisconnectMessage

Instances

Eq Disconnect

Defined in Network.SSH.Exception

Methods

(==) :: Disconnect -> Disconnect -> Bool

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

Ord Disconnect

Defined in Network.SSH.Exception

Methods

compare :: Disconnect -> Disconnect -> Ordering

(<) :: Disconnect -> Disconnect -> Bool

(<=) :: Disconnect -> Disconnect -> Bool

(>) :: Disconnect -> Disconnect -> Bool

(>=) :: Disconnect -> Disconnect -> Bool

max :: Disconnect -> Disconnect -> Disconnect

min :: Disconnect -> Disconnect -> Disconnect

Show Disconnect

Defined in Network.SSH.Exception

Methods

showsPrec :: Int -> Disconnect -> ShowS

show :: Disconnect -> String

showList :: [Disconnect] -> ShowS

Exception Disconnect

Defined in Network.SSH.Exception

Methods

toException :: Disconnect -> SomeException

fromException :: SomeException -> Maybe Disconnect

displayException :: Disconnect -> String

data DisconnectParty

Constructors

Local

Remote

Instances

Eq DisconnectParty

Defined in Network.SSH.Exception

Methods

(==) :: DisconnectParty -> DisconnectParty -> Bool

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

Ord DisconnectParty

Defined in Network.SSH.Exception

Methods

compare :: DisconnectParty -> DisconnectParty -> Ordering

(<) :: DisconnectParty -> DisconnectParty -> Bool

(<=) :: DisconnectParty -> DisconnectParty -> Bool

(>) :: DisconnectParty -> DisconnectParty -> Bool

(>=) :: DisconnectParty -> DisconnectParty -> Bool

max :: DisconnectParty -> DisconnectParty -> DisconnectParty

min :: DisconnectParty -> DisconnectParty -> DisconnectParty

Show DisconnectParty

Defined in Network.SSH.Exception

Methods

showsPrec :: Int -> DisconnectParty -> ShowS

show :: DisconnectParty -> String

showList :: [DisconnectParty] -> ShowS

data DisconnectReason

Constructors

DisconnectHostNotAllowedToConnect

DisconnectProtocolError

DisconnectKeyExchangeFailed

DisconnectReserved

DisconnectMacError

DisconnectCompressionError

DisconnectServiceNotAvailable

DisconnectProtocolVersionNotSupported

DisconnectHostKeyNotVerifiable

DisconnectConnectionLost

DisconnectByApplication

DisconnectTooManyConnection

DisconnectAuthCancelledByUser

DisconnectNoMoreAuthMethodsAvailable

DisconnectIllegalUsername

DisconnectOtherReason Word32

Instances

Eq DisconnectReason

Defined in Network.SSH.Exception

Methods

(==) :: DisconnectReason -> DisconnectReason -> Bool

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

Ord DisconnectReason

Defined in Network.SSH.Exception

Methods

compare :: DisconnectReason -> DisconnectReason -> Ordering

(<) :: DisconnectReason -> DisconnectReason -> Bool

(<=) :: DisconnectReason -> DisconnectReason -> Bool

(>) :: DisconnectReason -> DisconnectReason -> Bool

(>=) :: DisconnectReason -> DisconnectReason -> Bool

max :: DisconnectReason -> DisconnectReason -> DisconnectReason

min :: DisconnectReason -> DisconnectReason -> DisconnectReason

Show DisconnectReason

Defined in Network.SSH.Exception

Methods

showsPrec :: Int -> DisconnectReason -> ShowS

show :: DisconnectReason -> String

showList :: [DisconnectReason] -> ShowS

Encoding DisconnectReason

Defined in Network.SSH.Message

Methods

put :: Builder b => DisconnectReason -> b

get :: Get DisconnectReason

newtype DisconnectMessage

Constructors

DisconnectMessage ByteString

Instances

Eq DisconnectMessage

Defined in Network.SSH.Exception

Methods

(==) :: DisconnectMessage -> DisconnectMessage -> Bool

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

Ord DisconnectMessage

Defined in Network.SSH.Exception

Methods

compare :: DisconnectMessage -> DisconnectMessage -> Ordering

(<) :: DisconnectMessage -> DisconnectMessage -> Bool

(<=) :: DisconnectMessage -> DisconnectMessage -> Bool

(>) :: DisconnectMessage -> DisconnectMessage -> Bool

(>=) :: DisconnectMessage -> DisconnectMessage -> Bool

max :: DisconnectMessage -> DisconnectMessage -> DisconnectMessage

min :: DisconnectMessage -> DisconnectMessage -> DisconnectMessage

Show DisconnectMessage

Defined in Network.SSH.Exception

Methods

showsPrec :: Int -> DisconnectMessage -> ShowS

show :: DisconnectMessage -> String

showList :: [DisconnectMessage] -> ShowS

IsString DisconnectMessage

Defined in Network.SSH.Exception

Methods

fromString :: String -> DisconnectMessage

Semigroup DisconnectMessage

Defined in Network.SSH.Exception

Methods

(<>) :: DisconnectMessage -> DisconnectMessage -> DisconnectMessage

sconcat :: NonEmpty DisconnectMessage -> DisconnectMessage

stimes :: Integral b => b -> DisconnectMessage -> DisconnectMessage

Monoid DisconnectMessage

Defined in Network.SSH.Exception

Methods

mempty :: DisconnectMessage

mappend :: DisconnectMessage -> DisconnectMessage -> DisconnectMessage

mconcat :: [DisconnectMessage] -> DisconnectMessage

exceptionProtocolVersionNotSupported :: Disconnect

exceptionConnectionLost :: Disconnect

exceptionKexInvalidTransition :: Disconnect

exceptionKexInvalidSignature :: Disconnect

exceptionKexNoSignature :: Disconnect

exceptionKexNoCommonKexAlgorithm :: Disconnect

exceptionKexNoCommonEncryptionAlgorithm :: Disconnect

exceptionMacError :: Disconnect

exceptionInvalidPacket :: Disconnect

exceptionPacketLengthExceeded :: Disconnect

exceptionAuthenticationTimeout :: Disconnect

exceptionAuthenticationLimitExceeded :: Disconnect

exceptionServiceNotAvailable :: Disconnect

exceptionInvalidChannelId :: Disconnect

exceptionInvalidChannelRequest :: Disconnect

exceptionWindowSizeOverflow :: Disconnect

exceptionWindowSizeUnderrun :: Disconnect

exceptionPacketSizeExceeded :: Disconnect

exceptionDataAfterEof :: Disconnect

exceptionAlreadyExecuting :: Disconnect

exceptionUnexpectedMessage :: ByteString -> Disconnect

data KeyPair

Constructors

KeyPairEd25519 PublicKey SecretKey

Instances

Eq KeyPair

Defined in Network.SSH.Key

Methods

(==) :: KeyPair -> KeyPair -> Bool

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

Show KeyPair

Defined in Network.SSH.Key

Methods

showsPrec :: Int -> KeyPair -> ShowS

show :: KeyPair -> String

showList :: [KeyPair] -> ShowS

AuthAgent KeyPair

Defined in Network.SSH.AuthAgent

Methods

getPublicKeys :: KeyPair -> IO [PublicKey]

getSignature :: ByteArrayAccess hash => KeyPair -> PublicKey -> hash -> IO (Maybe Signature)

newKeyPair :: IO KeyPair

data PublicKey

Constructors

PublicKeyEd25519 PublicKey

PublicKeyRSA PublicKey

PublicKeyOther Name

Instances

Eq PublicKey

Defined in Network.SSH.Key

Methods

(==) :: PublicKey -> PublicKey -> Bool

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

Show PublicKey

Defined in Network.SSH.Key

Methods

showsPrec :: Int -> PublicKey -> ShowS

show :: PublicKey -> String

showList :: [PublicKey] -> ShowS

HasName PublicKey

Defined in Network.SSH.Key

Methods

name :: PublicKey -> Name

Encoding PublicKey

Defined in Network.SSH.Message

Methods

put :: Builder b => PublicKey -> b

get :: Get PublicKey

decodePrivateKeyFile :: (MonadFail m, ByteArray input, ByteArrayAccess passphrase, ByteArray comment) => passphrase -> input -> m [(KeyPair, comment)]

toPublicKey :: KeyPair -> PublicKey

Message

data Message

Constructors

MsgDisconnect Disconnected

MsgIgnore Ignore

MsgUnimplemented Unimplemented

MsgDebug Debug

MsgServiceRequest ServiceRequest

MsgServiceAccept ServiceAccept

MsgKexInit KexInit

MsgKexNewKeys KexNewKeys

MsgKexEcdhInit KexEcdhInit

MsgKexEcdhReply KexEcdhReply

MsgUserAuthRequest UserAuthRequest

MsgUserAuthFailure UserAuthFailure

MsgUserAuthSuccess UserAuthSuccess

MsgUserAuthBanner UserAuthBanner

MsgUserAuthPublicKeyOk UserAuthPublicKeyOk

MsgChannelOpen ChannelOpen

MsgChannelOpenConfirmation ChannelOpenConfirmation

MsgChannelOpenFailure ChannelOpenFailure

MsgChannelWindowAdjust ChannelWindowAdjust

MsgChannelData ChannelData

MsgChannelExtendedData ChannelExtendedData

MsgChannelEof ChannelEof

MsgChannelClose ChannelClose

MsgChannelRequest ChannelRequest

MsgChannelSuccess ChannelSuccess

MsgChannelFailure ChannelFailure

MsgUnknown Word8

Instances

Eq Message

Defined in Network.SSH.Message

Methods

(==) :: Message -> Message -> Bool

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

Show Message

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> Message -> ShowS

show :: Message -> String

showList :: [Message] -> ShowS

Encoding Message

Defined in Network.SSH.Message

Methods

put :: Builder b => Message -> b

get :: Get Message

class MessageStream a where

Methods

sendMessage :: forall msg. Encoding msg => a -> msg -> IO ()

receiveMessage :: forall msg. Encoding msg => a -> IO msg

Instances

MessageStream Transport

Defined in Network.SSH.Transport

Methods

sendMessage :: Encoding msg => Transport -> msg -> IO ()

receiveMessage :: Encoding msg => Transport -> IO msg

Disconnected (1)

data Disconnected

Constructors

Disconnected

Fields

• disconnectedReason :: DisconnectReason
• disconnectedDescription :: ShortByteString
• disconnectedLanguageTag :: ShortByteString

Instances

Eq Disconnected

Defined in Network.SSH.Message

Methods

(==) :: Disconnected -> Disconnected -> Bool

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

Show Disconnected

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> Disconnected -> ShowS

show :: Disconnected -> String

showList :: [Disconnected] -> ShowS

Encoding Disconnected

Defined in Network.SSH.Message

Methods

put :: Builder b => Disconnected -> b

get :: Get Disconnected

data DisconnectReason

Constructors

DisconnectHostNotAllowedToConnect

DisconnectProtocolError

DisconnectKeyExchangeFailed

DisconnectReserved

DisconnectMacError

DisconnectCompressionError

DisconnectServiceNotAvailable

DisconnectProtocolVersionNotSupported

DisconnectHostKeyNotVerifiable

DisconnectConnectionLost

DisconnectByApplication

DisconnectTooManyConnection

DisconnectAuthCancelledByUser

DisconnectNoMoreAuthMethodsAvailable

DisconnectIllegalUsername

DisconnectOtherReason Word32

Instances

Eq DisconnectReason

Defined in Network.SSH.Exception

Methods

(==) :: DisconnectReason -> DisconnectReason -> Bool

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

Ord DisconnectReason

Defined in Network.SSH.Exception

Methods

compare :: DisconnectReason -> DisconnectReason -> Ordering

(<) :: DisconnectReason -> DisconnectReason -> Bool

(<=) :: DisconnectReason -> DisconnectReason -> Bool

(>) :: DisconnectReason -> DisconnectReason -> Bool

(>=) :: DisconnectReason -> DisconnectReason -> Bool

max :: DisconnectReason -> DisconnectReason -> DisconnectReason

min :: DisconnectReason -> DisconnectReason -> DisconnectReason

Show DisconnectReason

Defined in Network.SSH.Exception

Methods

showsPrec :: Int -> DisconnectReason -> ShowS

show :: DisconnectReason -> String

showList :: [DisconnectReason] -> ShowS

Encoding DisconnectReason

Defined in Network.SSH.Message

Methods

put :: Builder b => DisconnectReason -> b

get :: Get DisconnectReason

Ignore (2)

data Ignore

Constructors

Ignore

Instances

Eq Ignore

Defined in Network.SSH.Message

Methods

(==) :: Ignore -> Ignore -> Bool

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

Show Ignore

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> Ignore -> ShowS

show :: Ignore -> String

showList :: [Ignore] -> ShowS

Encoding Ignore

Defined in Network.SSH.Message

Methods

put :: Builder b => Ignore -> b

get :: Get Ignore

Unimplemented (3)

data Unimplemented

Constructors

Unimplemented Word32

Instances

Eq Unimplemented

Defined in Network.SSH.Message

Methods

(==) :: Unimplemented -> Unimplemented -> Bool

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

Show Unimplemented

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> Unimplemented -> ShowS

show :: Unimplemented -> String

showList :: [Unimplemented] -> ShowS

Encoding Unimplemented

Defined in Network.SSH.Message

Methods

put :: Builder b => Unimplemented -> b

get :: Get Unimplemented

Debug (4)

data Debug

Constructors

Debug

Fields

• debugAlwaysDisplay :: Bool
• debugMessage :: ShortByteString
• debugLanguageTag :: ShortByteString

Instances

Eq Debug

Defined in Network.SSH.Message

Methods

(==) :: Debug -> Debug -> Bool

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

Show Debug

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> Debug -> ShowS

show :: Debug -> String

showList :: [Debug] -> ShowS

Encoding Debug

Defined in Network.SSH.Message

Methods

put :: Builder b => Debug -> b

get :: Get Debug

ServiceRequest (5)

data ServiceRequest

Constructors

ServiceRequest ServiceName

Instances

Eq ServiceRequest

Defined in Network.SSH.Message

Methods

(==) :: ServiceRequest -> ServiceRequest -> Bool

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

Show ServiceRequest

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ServiceRequest -> ShowS

show :: ServiceRequest -> String

showList :: [ServiceRequest] -> ShowS

Encoding ServiceRequest

Defined in Network.SSH.Message

Methods

put :: Builder b => ServiceRequest -> b

get :: Get ServiceRequest

ServiceAccept (6)

data ServiceAccept

Constructors

ServiceAccept ServiceName

Instances

Eq ServiceAccept

Defined in Network.SSH.Message

Methods

(==) :: ServiceAccept -> ServiceAccept -> Bool

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

Show ServiceAccept

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ServiceAccept -> ShowS

show :: ServiceAccept -> String

showList :: [ServiceAccept] -> ShowS

Encoding ServiceAccept

Defined in Network.SSH.Message

Methods

put :: Builder b => ServiceAccept -> b

get :: Get ServiceAccept

KexInit (20)

data KexInit

Constructors

KexInit

Fields

• kexCookie :: Cookie
• kexKexAlgorithms :: [Name]
• kexServerHostKeyAlgorithms :: [Name]
• kexEncryptionAlgorithmsClientToServer :: [Name]
• kexEncryptionAlgorithmsServerToClient :: [Name]
• kexMacAlgorithmsClientToServer :: [Name]
• kexMacAlgorithmsServerToClient :: [Name]
• kexCompressionAlgorithmsClientToServer :: [Name]
• kexCompressionAlgorithmsServerToClient :: [Name]
• kexLanguagesClientToServer :: [Name]
• kexLanguagesServerToClient :: [Name]
• kexFirstPacketFollows :: Bool

Instances

Eq KexInit

Defined in Network.SSH.Message

Methods

(==) :: KexInit -> KexInit -> Bool

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

Show KexInit

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> KexInit -> ShowS

show :: KexInit -> String

showList :: [KexInit] -> ShowS

Encoding KexInit

Defined in Network.SSH.Message

Methods

put :: Builder b => KexInit -> b

get :: Get KexInit

KexNewKeys (21)

data KexNewKeys

Constructors

KexNewKeys

Instances

Eq KexNewKeys

Defined in Network.SSH.Message

Methods

(==) :: KexNewKeys -> KexNewKeys -> Bool

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

Show KexNewKeys

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> KexNewKeys -> ShowS

show :: KexNewKeys -> String

showList :: [KexNewKeys] -> ShowS

Encoding KexNewKeys

Defined in Network.SSH.Message

Methods

put :: Builder b => KexNewKeys -> b

get :: Get KexNewKeys

KexEcdhInit (30)

data KexEcdhInit

Constructors

KexEcdhInit

Fields

• kexClientEphemeralKey :: PublicKey

Instances

Eq KexEcdhInit

Defined in Network.SSH.Message

Methods

(==) :: KexEcdhInit -> KexEcdhInit -> Bool

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

Show KexEcdhInit

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> KexEcdhInit -> ShowS

show :: KexEcdhInit -> String

showList :: [KexEcdhInit] -> ShowS

Encoding KexEcdhInit

Defined in Network.SSH.Message

Methods

put :: Builder b => KexEcdhInit -> b

get :: Get KexEcdhInit

KexEcdhReply (31)

data KexEcdhReply

Constructors

KexEcdhReply

Fields

• kexServerHostKey :: PublicKey
• kexServerEphemeralKey :: PublicKey
• kexHashSignature :: Signature

Instances

Eq KexEcdhReply

Defined in Network.SSH.Message

Methods

(==) :: KexEcdhReply -> KexEcdhReply -> Bool

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

Show KexEcdhReply

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> KexEcdhReply -> ShowS

show :: KexEcdhReply -> String

showList :: [KexEcdhReply] -> ShowS

Encoding KexEcdhReply

Defined in Network.SSH.Message

Methods

put :: Builder b => KexEcdhReply -> b

get :: Get KexEcdhReply

UserAuthRequest (50)

data UserAuthRequest

Constructors

UserAuthRequest UserName ServiceName AuthMethod

Instances

Eq UserAuthRequest

Defined in Network.SSH.Message

Methods

(==) :: UserAuthRequest -> UserAuthRequest -> Bool

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

Show UserAuthRequest

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> UserAuthRequest -> ShowS

show :: UserAuthRequest -> String

showList :: [UserAuthRequest] -> ShowS

Encoding UserAuthRequest

Defined in Network.SSH.Message

Methods

put :: Builder b => UserAuthRequest -> b

get :: Get UserAuthRequest

UserAuthFailure (51)

data UserAuthFailure

Constructors

UserAuthFailure [Name] Bool

Instances

Eq UserAuthFailure

Defined in Network.SSH.Message

Methods

(==) :: UserAuthFailure -> UserAuthFailure -> Bool

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

Show UserAuthFailure

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> UserAuthFailure -> ShowS

show :: UserAuthFailure -> String

showList :: [UserAuthFailure] -> ShowS

Encoding UserAuthFailure

Defined in Network.SSH.Message

Methods

put :: Builder b => UserAuthFailure -> b

get :: Get UserAuthFailure

UserAuthSuccess (52)

data UserAuthSuccess

Constructors

UserAuthSuccess

Instances

Eq UserAuthSuccess

Defined in Network.SSH.Message

Methods

(==) :: UserAuthSuccess -> UserAuthSuccess -> Bool

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

Show UserAuthSuccess

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> UserAuthSuccess -> ShowS

show :: UserAuthSuccess -> String

showList :: [UserAuthSuccess] -> ShowS

Encoding UserAuthSuccess

Defined in Network.SSH.Message

Methods

put :: Builder b => UserAuthSuccess -> b

get :: Get UserAuthSuccess

UserAuthBanner (53)

data UserAuthBanner

Constructors

UserAuthBanner ShortByteString ShortByteString

Instances

Eq UserAuthBanner

Defined in Network.SSH.Message

Methods

(==) :: UserAuthBanner -> UserAuthBanner -> Bool

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

Show UserAuthBanner

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> UserAuthBanner -> ShowS

show :: UserAuthBanner -> String

showList :: [UserAuthBanner] -> ShowS

Encoding UserAuthBanner

Defined in Network.SSH.Message

Methods

put :: Builder b => UserAuthBanner -> b

get :: Get UserAuthBanner

UserAuthPublicKeyOk (60)

data UserAuthPublicKeyOk

Constructors

UserAuthPublicKeyOk PublicKey

Instances

Eq UserAuthPublicKeyOk

Defined in Network.SSH.Message

Methods

(==) :: UserAuthPublicKeyOk -> UserAuthPublicKeyOk -> Bool

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

Show UserAuthPublicKeyOk

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> UserAuthPublicKeyOk -> ShowS

show :: UserAuthPublicKeyOk -> String

showList :: [UserAuthPublicKeyOk] -> ShowS

Encoding UserAuthPublicKeyOk

Defined in Network.SSH.Message

Methods

put :: Builder b => UserAuthPublicKeyOk -> b

get :: Get UserAuthPublicKeyOk

ChannelOpen (90)

data ChannelOpen

Constructors

ChannelOpen ChannelId ChannelWindowSize ChannelPacketSize ChannelOpenType

Instances

Eq ChannelOpen

Defined in Network.SSH.Message

Methods

(==) :: ChannelOpen -> ChannelOpen -> Bool

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

Show ChannelOpen

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelOpen -> ShowS

show :: ChannelOpen -> String

showList :: [ChannelOpen] -> ShowS

Encoding ChannelOpen

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelOpen -> b

get :: Get ChannelOpen

data ChannelOpenType

Constructors

ChannelOpenSession

ChannelOpenDirectTcpIp

Fields

• coDestinationAddress :: ShortByteString
• coDestinationPort :: Word32
• coSourceAddress :: ShortByteString
• coSourcePort :: Word32

ChannelOpenOther ChannelType

Instances

Eq ChannelOpenType

Defined in Network.SSH.Message

Methods

(==) :: ChannelOpenType -> ChannelOpenType -> Bool

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

Show ChannelOpenType

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelOpenType -> ShowS

show :: ChannelOpenType -> String

showList :: [ChannelOpenType] -> ShowS

ChannelOpenConfirmation (91)

data ChannelOpenConfirmation

Constructors

ChannelOpenConfirmation ChannelId ChannelId ChannelWindowSize ChannelPacketSize

Instances

Eq ChannelOpenConfirmation

Defined in Network.SSH.Message

Methods

(==) :: ChannelOpenConfirmation -> ChannelOpenConfirmation -> Bool

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

Show ChannelOpenConfirmation

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelOpenConfirmation -> ShowS

show :: ChannelOpenConfirmation -> String

showList :: [ChannelOpenConfirmation] -> ShowS

Encoding ChannelOpenConfirmation

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelOpenConfirmation -> b

get :: Get ChannelOpenConfirmation

ChannelOpenFailure (92)

data ChannelOpenFailure

Constructors

ChannelOpenFailure ChannelId ChannelOpenFailureReason ShortByteString ShortByteString

Instances

Eq ChannelOpenFailure

Defined in Network.SSH.Message

Methods

(==) :: ChannelOpenFailure -> ChannelOpenFailure -> Bool

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

Show ChannelOpenFailure

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelOpenFailure -> ShowS

show :: ChannelOpenFailure -> String

showList :: [ChannelOpenFailure] -> ShowS

Encoding ChannelOpenFailure

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelOpenFailure -> b

get :: Get ChannelOpenFailure

data ChannelOpenFailureReason

Constructors

ChannelOpenAdministrativelyProhibited

ChannelOpenConnectFailed

ChannelOpenUnknownChannelType

ChannelOpenResourceShortage

ChannelOpenOtherFailure Word32

Instances

Eq ChannelOpenFailureReason

Defined in Network.SSH.Message

Methods

(==) :: ChannelOpenFailureReason -> ChannelOpenFailureReason -> Bool

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

Show ChannelOpenFailureReason

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelOpenFailureReason -> ShowS

show :: ChannelOpenFailureReason -> String

showList :: [ChannelOpenFailureReason] -> ShowS

Encoding ChannelOpenFailureReason

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelOpenFailureReason -> b

get :: Get ChannelOpenFailureReason

ChannelWindowAdjust (93)

data ChannelWindowAdjust

Constructors

ChannelWindowAdjust ChannelId ChannelWindowSize

Instances

Eq ChannelWindowAdjust

Defined in Network.SSH.Message

Methods

(==) :: ChannelWindowAdjust -> ChannelWindowAdjust -> Bool

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

Show ChannelWindowAdjust

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelWindowAdjust -> ShowS

show :: ChannelWindowAdjust -> String

showList :: [ChannelWindowAdjust] -> ShowS

Encoding ChannelWindowAdjust

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelWindowAdjust -> b

get :: Get ChannelWindowAdjust

ChannelData (94)

data ChannelData

Constructors

ChannelData ChannelId ShortByteString

Instances

Eq ChannelData

Defined in Network.SSH.Message

Methods

(==) :: ChannelData -> ChannelData -> Bool

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

Show ChannelData

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelData -> ShowS

show :: ChannelData -> String

showList :: [ChannelData] -> ShowS

Encoding ChannelData

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelData -> b

get :: Get ChannelData

ChannelExtendedData (95)

data ChannelExtendedData

Constructors

ChannelExtendedData ChannelId Word32 ShortByteString

Instances

Eq ChannelExtendedData

Defined in Network.SSH.Message

Methods

(==) :: ChannelExtendedData -> ChannelExtendedData -> Bool

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

Show ChannelExtendedData

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelExtendedData -> ShowS

show :: ChannelExtendedData -> String

showList :: [ChannelExtendedData] -> ShowS

Encoding ChannelExtendedData

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelExtendedData -> b

get :: Get ChannelExtendedData

ChannelEof (96)

data ChannelEof

Constructors

ChannelEof ChannelId

Instances

Eq ChannelEof

Defined in Network.SSH.Message

Methods

(==) :: ChannelEof -> ChannelEof -> Bool

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

Show ChannelEof

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelEof -> ShowS

show :: ChannelEof -> String

showList :: [ChannelEof] -> ShowS

Encoding ChannelEof

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelEof -> b

get :: Get ChannelEof

ChannelClose (97)

data ChannelClose

Constructors

ChannelClose ChannelId

Instances

Eq ChannelClose

Defined in Network.SSH.Message

Methods

(==) :: ChannelClose -> ChannelClose -> Bool

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

Show ChannelClose

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelClose -> ShowS

show :: ChannelClose -> String

showList :: [ChannelClose] -> ShowS

Encoding ChannelClose

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelClose -> b

get :: Get ChannelClose

ChannelRequest (98)

data ChannelRequest

Constructors

ChannelRequest

Fields

• crChannel :: ChannelId
• crType :: ShortByteString
• crWantReply :: Bool
• crData :: ByteString

Instances

Eq ChannelRequest

Defined in Network.SSH.Message

Methods

(==) :: ChannelRequest -> ChannelRequest -> Bool

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

Show ChannelRequest

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelRequest -> ShowS

show :: ChannelRequest -> String

showList :: [ChannelRequest] -> ShowS

Encoding ChannelRequest

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelRequest -> b

get :: Get ChannelRequest

data ChannelRequestEnv

Constructors

ChannelRequestEnv

Fields

• crVariableName :: ShortByteString
• crVariableValue :: ShortByteString

Instances

Eq ChannelRequestEnv

Defined in Network.SSH.Message

Methods

(==) :: ChannelRequestEnv -> ChannelRequestEnv -> Bool

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

Show ChannelRequestEnv

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelRequestEnv -> ShowS

show :: ChannelRequestEnv -> String

showList :: [ChannelRequestEnv] -> ShowS

Encoding ChannelRequestEnv

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelRequestEnv -> b

get :: Get ChannelRequestEnv

data ChannelRequestPty

Constructors

ChannelRequestPty

Fields

• crPtySettings :: PtySettings

Instances

Eq ChannelRequestPty

Defined in Network.SSH.Message

Methods

(==) :: ChannelRequestPty -> ChannelRequestPty -> Bool

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

Show ChannelRequestPty

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelRequestPty -> ShowS

show :: ChannelRequestPty -> String

showList :: [ChannelRequestPty] -> ShowS

Encoding ChannelRequestPty

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelRequestPty -> b

get :: Get ChannelRequestPty

data ChannelRequestWindowChange

Constructors

ChannelRequestWindowChange

Fields

• crWidth :: Word32
• crHeight :: Word32
• crWidthPixels :: Word32
• crHeightPixels :: Word32

Instances

Eq ChannelRequestWindowChange

Defined in Network.SSH.Message

Methods

(==) :: ChannelRequestWindowChange -> ChannelRequestWindowChange -> Bool

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

Show ChannelRequestWindowChange

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelRequestWindowChange -> ShowS

show :: ChannelRequestWindowChange -> String

showList :: [ChannelRequestWindowChange] -> ShowS

Encoding ChannelRequestWindowChange

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelRequestWindowChange -> b

get :: Get ChannelRequestWindowChange

data ChannelRequestShell

Constructors

ChannelRequestShell

Instances

Eq ChannelRequestShell

Defined in Network.SSH.Message

Methods

(==) :: ChannelRequestShell -> ChannelRequestShell -> Bool

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

Show ChannelRequestShell

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelRequestShell -> ShowS

show :: ChannelRequestShell -> String

showList :: [ChannelRequestShell] -> ShowS

Encoding ChannelRequestShell

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelRequestShell -> b

get :: Get ChannelRequestShell

data ChannelRequestExec

Constructors

ChannelRequestExec

Fields

• crCommand :: ShortByteString

Instances

Eq ChannelRequestExec

Defined in Network.SSH.Message

Methods

(==) :: ChannelRequestExec -> ChannelRequestExec -> Bool

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

Show ChannelRequestExec

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelRequestExec -> ShowS

show :: ChannelRequestExec -> String

showList :: [ChannelRequestExec] -> ShowS

Encoding ChannelRequestExec

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelRequestExec -> b

get :: Get ChannelRequestExec

data ChannelRequestSignal

Constructors

ChannelRequestSignal

Fields

• crSignal :: ShortByteString

Instances

Eq ChannelRequestSignal

Defined in Network.SSH.Message

Methods

(==) :: ChannelRequestSignal -> ChannelRequestSignal -> Bool

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

Show ChannelRequestSignal

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelRequestSignal -> ShowS

show :: ChannelRequestSignal -> String

showList :: [ChannelRequestSignal] -> ShowS

Encoding ChannelRequestSignal

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelRequestSignal -> b

get :: Get ChannelRequestSignal

data ChannelRequestExitStatus

Constructors

ChannelRequestExitStatus

Fields

• crExitStatus :: ExitCode

Instances

Eq ChannelRequestExitStatus

Defined in Network.SSH.Message

Methods

(==) :: ChannelRequestExitStatus -> ChannelRequestExitStatus -> Bool

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

Show ChannelRequestExitStatus

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelRequestExitStatus -> ShowS

show :: ChannelRequestExitStatus -> String

showList :: [ChannelRequestExitStatus] -> ShowS

Encoding ChannelRequestExitStatus

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelRequestExitStatus -> b

get :: Get ChannelRequestExitStatus

data ChannelRequestExitSignal

Constructors

ChannelRequestExitSignal

Fields

• crSignalName :: ShortByteString
• crCodeDumped :: Bool
• crErrorMessage :: ShortByteString
• crLanguageTag :: ShortByteString

Instances

Eq ChannelRequestExitSignal

Defined in Network.SSH.Message

Methods

(==) :: ChannelRequestExitSignal -> ChannelRequestExitSignal -> Bool

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

Show ChannelRequestExitSignal

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelRequestExitSignal -> ShowS

show :: ChannelRequestExitSignal -> String

showList :: [ChannelRequestExitSignal] -> ShowS

Encoding ChannelRequestExitSignal

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelRequestExitSignal -> b

get :: Get ChannelRequestExitSignal

ChannelSuccess (99)

data ChannelSuccess

Constructors

ChannelSuccess ChannelId

Instances

Eq ChannelSuccess

Defined in Network.SSH.Message

Methods

(==) :: ChannelSuccess -> ChannelSuccess -> Bool

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

Show ChannelSuccess

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelSuccess -> ShowS

show :: ChannelSuccess -> String

showList :: [ChannelSuccess] -> ShowS

Encoding ChannelSuccess

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelSuccess -> b

get :: Get ChannelSuccess

ChannelFailure (100)

data ChannelFailure

Constructors

ChannelFailure ChannelId

Instances

Eq ChannelFailure

Defined in Network.SSH.Message

Methods

(==) :: ChannelFailure -> ChannelFailure -> Bool

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

Show ChannelFailure

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelFailure -> ShowS

show :: ChannelFailure -> String

showList :: [ChannelFailure] -> ShowS

Encoding ChannelFailure

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelFailure -> b

get :: Get ChannelFailure

Misc

data AuthMethod

Constructors

AuthNone

AuthHostBased

AuthPassword Password

AuthPublicKey PublicKey (Maybe Signature)

AuthOther Name

Instances

Eq AuthMethod

Defined in Network.SSH.Message

Methods

(==) :: AuthMethod -> AuthMethod -> Bool

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

Show AuthMethod

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> AuthMethod -> ShowS

show :: AuthMethod -> String

showList :: [AuthMethod] -> ShowS

HasName AuthMethod

Defined in Network.SSH.Message

Methods

name :: AuthMethod -> Name

Encoding AuthMethod

Defined in Network.SSH.Message

Methods

put :: Builder b => AuthMethod -> b

get :: Get AuthMethod

newtype ChannelId

Constructors

ChannelId Word32

Instances

Eq ChannelId

Defined in Network.SSH.Message

Methods

(==) :: ChannelId -> ChannelId -> Bool

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

Ord ChannelId

Defined in Network.SSH.Message

Methods

compare :: ChannelId -> ChannelId -> Ordering

(<) :: ChannelId -> ChannelId -> Bool

(<=) :: ChannelId -> ChannelId -> Bool

(>) :: ChannelId -> ChannelId -> Bool

(>=) :: ChannelId -> ChannelId -> Bool

max :: ChannelId -> ChannelId -> ChannelId

min :: ChannelId -> ChannelId -> ChannelId

Show ChannelId

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelId -> ShowS

show :: ChannelId -> String

showList :: [ChannelId] -> ShowS

Encoding ChannelId

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelId -> b

get :: Get ChannelId

newtype ChannelType

Constructors

ChannelType ShortByteString

Instances

Eq ChannelType

Defined in Network.SSH.Message

Methods

(==) :: ChannelType -> ChannelType -> Bool

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

Ord ChannelType

Defined in Network.SSH.Message

Methods

compare :: ChannelType -> ChannelType -> Ordering

(<) :: ChannelType -> ChannelType -> Bool

(<=) :: ChannelType -> ChannelType -> Bool

(>) :: ChannelType -> ChannelType -> Bool

(>=) :: ChannelType -> ChannelType -> Bool

max :: ChannelType -> ChannelType -> ChannelType

min :: ChannelType -> ChannelType -> ChannelType

Show ChannelType

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> ChannelType -> ShowS

show :: ChannelType -> String

showList :: [ChannelType] -> ShowS

Encoding ChannelType

Defined in Network.SSH.Message

Methods

put :: Builder b => ChannelType -> b

get :: Get ChannelType

type ChannelPacketSize = Word32

type ChannelWindowSize = Word32

data Cookie

Instances

Eq Cookie

Defined in Network.SSH.Message

Methods

(==) :: Cookie -> Cookie -> Bool

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

Ord Cookie

Defined in Network.SSH.Message

Methods

compare :: Cookie -> Cookie -> Ordering

(<) :: Cookie -> Cookie -> Bool

(<=) :: Cookie -> Cookie -> Bool

(>) :: Cookie -> Cookie -> Bool

(>=) :: Cookie -> Cookie -> Bool

max :: Cookie -> Cookie -> Cookie

min :: Cookie -> Cookie -> Cookie

Show Cookie

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> Cookie -> ShowS

show :: Cookie -> String

showList :: [Cookie] -> ShowS

Encoding Cookie

Defined in Network.SSH.Message

Methods

put :: Builder b => Cookie -> b

get :: Get Cookie

newCookie :: MonadRandom m => m Cookie

nilCookie :: Cookie

newtype Password

Constructors

Password ShortByteString

Instances

Eq Password

Defined in Network.SSH.Message

Methods

(==) :: Password -> Password -> Bool

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

Ord Password

Defined in Network.SSH.Message

Methods

compare :: Password -> Password -> Ordering

(<) :: Password -> Password -> Bool

(<=) :: Password -> Password -> Bool

(>) :: Password -> Password -> Bool

(>=) :: Password -> Password -> Bool

max :: Password -> Password -> Password

min :: Password -> Password -> Password

Show Password

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> Password -> ShowS

show :: Password -> String

showList :: [Password] -> ShowS

data PtySettings

Constructors

PtySettings

Fields

• ptyEnv :: ShortByteString
• ptyWidthCols :: Word32
• ptyHeightRows :: Word32
• ptyWidthPixels :: Word32
• ptyHeightPixels :: Word32
• ptyModes :: ShortByteString

Instances

Eq PtySettings

Defined in Network.SSH.Message

Methods

(==) :: PtySettings -> PtySettings -> Bool

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

Show PtySettings

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> PtySettings -> ShowS

show :: PtySettings -> String

showList :: [PtySettings] -> ShowS

Encoding PtySettings

Defined in Network.SSH.Message

Methods

put :: Builder b => PtySettings -> b

get :: Get PtySettings

data PublicKey

Constructors

PublicKeyEd25519 PublicKey

PublicKeyRSA PublicKey

PublicKeyOther Name

Instances

Eq PublicKey

Defined in Network.SSH.Key

Methods

(==) :: PublicKey -> PublicKey -> Bool

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

Show PublicKey

Defined in Network.SSH.Key

Methods

showsPrec :: Int -> PublicKey -> ShowS

show :: PublicKey -> String

showList :: [PublicKey] -> ShowS

HasName PublicKey

Defined in Network.SSH.Key

Methods

name :: PublicKey -> Name

Encoding PublicKey

Defined in Network.SSH.Message

Methods

put :: Builder b => PublicKey -> b

get :: Get PublicKey

newtype SessionId

Constructors

SessionId ShortByteString

Instances

Eq SessionId

Defined in Network.SSH.Message

Methods

(==) :: SessionId -> SessionId -> Bool

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

Ord SessionId

Defined in Network.SSH.Message

Methods

compare :: SessionId -> SessionId -> Ordering

(<) :: SessionId -> SessionId -> Bool

(<=) :: SessionId -> SessionId -> Bool

(>) :: SessionId -> SessionId -> Bool

(>=) :: SessionId -> SessionId -> Bool

max :: SessionId -> SessionId -> SessionId

min :: SessionId -> SessionId -> SessionId

Show SessionId

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> SessionId -> ShowS

show :: SessionId -> String

showList :: [SessionId] -> ShowS

Encoding SessionId

Defined in Network.SSH.Message

Methods

put :: Builder b => SessionId -> b

get :: Get SessionId

data Signature

Constructors

SignatureEd25519 Signature

SignatureRSA ByteString

SignatureOther Name

Instances

Eq Signature

Defined in Network.SSH.Message

Methods

(==) :: Signature -> Signature -> Bool

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

Show Signature

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> Signature -> ShowS

show :: Signature -> String

showList :: [Signature] -> ShowS

HasName Signature

Defined in Network.SSH.Message

Methods

name :: Signature -> Name

Encoding Signature

Defined in Network.SSH.Message

Methods

put :: Builder b => Signature -> b

get :: Get Signature

newtype Version

Constructors

Version ShortByteString

Instances

Eq Version

Defined in Network.SSH.Message

Methods

(==) :: Version -> Version -> Bool

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

Ord Version

Defined in Network.SSH.Message

Methods

compare :: Version -> Version -> Ordering

(<) :: Version -> Version -> Bool

(<=) :: Version -> Version -> Bool

(>) :: Version -> Version -> Bool

(>=) :: Version -> Version -> Bool

max :: Version -> Version -> Version

min :: Version -> Version -> Version

Show Version

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> Version -> ShowS

show :: Version -> String

showList :: [Version] -> ShowS

Encoding Version

Defined in Network.SSH.Message

Methods

put :: Builder b => Version -> b

get :: Get Version

type ServiceName = Name

type UserName = Name

newtype Name

Constructors

Name ShortByteString

Instances

Eq Name

Defined in Network.SSH.Name

Methods

(==) :: Name -> Name -> Bool

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

Ord Name

Defined in Network.SSH.Name

Methods

compare :: Name -> Name -> Ordering

(<) :: Name -> Name -> Bool

(<=) :: Name -> Name -> Bool

(>) :: Name -> Name -> Bool

(>=) :: Name -> Name -> Bool

max :: Name -> Name -> Name

min :: Name -> Name -> Name

Show Name

Defined in Network.SSH.Name

Methods

showsPrec :: Int -> Name -> ShowS

show :: Name -> String

showList :: [Name] -> ShowS

IsString Name

Defined in Network.SSH.Name

Methods

fromString :: String -> Name

class HasName a where

Methods

name :: a -> Name

Instances

HasName PublicKey

Defined in Network.SSH.Key

Methods

name :: PublicKey -> Name

HasName Signature

Defined in Network.SSH.Message

Methods

name :: Signature -> Name

HasName AuthMethod

Defined in Network.SSH.Message

Methods

name :: AuthMethod -> Name

HasName CompressionAlgorithm

Defined in Network.SSH.Algorithms

Methods

name :: CompressionAlgorithm -> Name

HasName EncryptionAlgorithm

Defined in Network.SSH.Algorithms

Methods

name :: EncryptionAlgorithm -> Name

HasName KeyExchangeAlgorithm

Defined in Network.SSH.Algorithms

Methods

name :: KeyExchangeAlgorithm -> Name

HasName HostKeyAlgorithm

Defined in Network.SSH.Algorithms

Methods

name :: HostKeyAlgorithm -> Name

data Connection identity

data ConnectionConfig identity

Constructors

ConnectionConfig

Fields

• onSessionRequest :: identity -> SessionRequest -> IO (Maybe SessionHandler)

  This callback will be executed for every session request.

  Return a SessionHandler or Nothing to reject the request (default).

• onDirectTcpIpRequest :: identity -> DirectTcpIpRequest -> IO (Maybe DirectTcpIpHandler)

  This callback will be executed for every direct-tcpip request.

  Return a DirectTcpIpHandler or Nothing to reject the request (default).

• channelMaxCount :: Word16

  The maximum number of channels that may be active simultaneously (default: 256).

  Any requests that would exceed the limit will be rejected. Setting the limit to high values might expose the server to denial of service issues!

• channelMaxQueueSize :: Word32

  The maximum size of the internal buffers in bytes (also limits the maximum window size, default: 32 kB)

  Increasing this value might help with performance issues (if connection delay is in a bad ration with the available bandwidth the window resizing might cause unncessary throttling).

• channelMaxPacketSize :: Word32

  The maximum size of inbound channel data payload (default: 32 kB)

  Values that are larger than channelMaxQueueSize or the maximum message size (35000 bytes) will be automatically adjusted to the maximum possible value.

Instances

Default (ConnectionConfig identity)

Defined in Network.SSH.Server.Service.Connection

Methods

def :: ConnectionConfig identity

data SessionRequest

Information associated with the session request.

Might be exteded in the future.

Constructors

SessionRequest

Instances

Eq SessionRequest

Defined in Network.SSH.Server.Service.Connection

Methods

(==) :: SessionRequest -> SessionRequest -> Bool

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

Ord SessionRequest

Defined in Network.SSH.Server.Service.Connection

Methods

compare :: SessionRequest -> SessionRequest -> Ordering

(<) :: SessionRequest -> SessionRequest -> Bool

(<=) :: SessionRequest -> SessionRequest -> Bool

(>) :: SessionRequest -> SessionRequest -> Bool

(>=) :: SessionRequest -> SessionRequest -> Bool

max :: SessionRequest -> SessionRequest -> SessionRequest

min :: SessionRequest -> SessionRequest -> SessionRequest

Show SessionRequest

Defined in Network.SSH.Server.Service.Connection

Methods

showsPrec :: Int -> SessionRequest -> ShowS

show :: SessionRequest -> String

showList :: [SessionRequest] -> ShowS

newtype SessionHandler

The session handler contains the application logic that serves a client's shell or exec request.

• The Command parameter will be present if this is an exec request and absent for shell requests.
• The TermInfo parameter will be present if the client requested a pty.
• The Environment parameter contains the set of all env requests the client issued before the actual shell or exec request.
• stdin, stdout and stderr are streams. The former can only be read from while the latter can only be written to. After the handler has gracefully terminated, the implementation assures that all bytes will be sent before sending an eof and actually closing the channel. has gracefully terminated. The client will then receive an eof and close.
• A SIGILL exit signal will be sent if the handler terminates with an exception. Otherwise the client will receive the returned exit code.

handler :: SessionHandler
handler = SessionHandler $ \env mterm mcmd stdin stdout stderr -> case mcmd of
    Just "echo" -> do
        bs <- receive stdin 1024
        sendAll stdout bs
        pure ExitSuccess
    Nothing ->
        pure (ExitFailure 1)

Constructors

SessionHandler (forall stdin stdout stderr. (InputStream stdin, OutputStream stdout, OutputStream stderr) => Environment -> Maybe TermInfo -> Maybe Command -> stdin -> stdout -> stderr -> IO ExitCode)

newtype Environment

The Environment is list of key-value pairs.

Environment [ ("LC_ALL", "en_US.UTF-8") ]

Constructors

Environment [(ByteString, ByteString)]

Instances

Eq Environment

Defined in Network.SSH.Server.Service.Connection

Methods

(==) :: Environment -> Environment -> Bool

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

Ord Environment

Defined in Network.SSH.Server.Service.Connection

Methods

compare :: Environment -> Environment -> Ordering

(<) :: Environment -> Environment -> Bool

(<=) :: Environment -> Environment -> Bool

(>) :: Environment -> Environment -> Bool

(>=) :: Environment -> Environment -> Bool

max :: Environment -> Environment -> Environment

min :: Environment -> Environment -> Environment

Show Environment

Defined in Network.SSH.Server.Service.Connection

Methods

showsPrec :: Int -> Environment -> ShowS

show :: Environment -> String

showList :: [Environment] -> ShowS

data TermInfo

The TermInfo describes the client's terminal settings if it requested a pty.

NOTE: This will follow in a future release. You may access the constructor through the Internal module, but should not rely on it yet.

Constructors

TermInfo PtySettings

newtype Command

The Command is what the client wants to execute when making an exec request (shell requests don't have a command).

Constructors

Command ByteString

Instances

Eq Command

Defined in Network.SSH.Server.Service.Connection

Methods

(==) :: Command -> Command -> Bool

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

Ord Command

Defined in Network.SSH.Server.Service.Connection

Methods

compare :: Command -> Command -> Ordering

(<) :: Command -> Command -> Bool

(<=) :: Command -> Command -> Bool

(>) :: Command -> Command -> Bool

(>=) :: Command -> Command -> Bool

max :: Command -> Command -> Command

min :: Command -> Command -> Command

Show Command

Defined in Network.SSH.Server.Service.Connection

Methods

showsPrec :: Int -> Command -> ShowS

show :: Command -> String

showList :: [Command] -> ShowS

IsString Command

Defined in Network.SSH.Server.Service.Connection

Methods

fromString :: String -> Command

data DirectTcpIpRequest

When the client makes a DirectTcpIpRequest it requests a TCP port forwarding.

Constructors

DirectTcpIpRequest

Fields

• dstAddress :: ByteString

  The destination address.

• dstPort :: Word32

  The destination port.

• srcAddress :: ByteString

  The source address (usually the IP the client will bind the local listening socket to).

• srcPort :: Word32

  The source port (usually the port the client will bind the local listening socket).

Instances

Eq DirectTcpIpRequest

Defined in Network.SSH.Server.Service.Connection

Methods

(==) :: DirectTcpIpRequest -> DirectTcpIpRequest -> Bool

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

Ord DirectTcpIpRequest

Defined in Network.SSH.Server.Service.Connection

Methods

compare :: DirectTcpIpRequest -> DirectTcpIpRequest -> Ordering

(<) :: DirectTcpIpRequest -> DirectTcpIpRequest -> Bool

(<=) :: DirectTcpIpRequest -> DirectTcpIpRequest -> Bool

(>) :: DirectTcpIpRequest -> DirectTcpIpRequest -> Bool

(>=) :: DirectTcpIpRequest -> DirectTcpIpRequest -> Bool

max :: DirectTcpIpRequest -> DirectTcpIpRequest -> DirectTcpIpRequest

min :: DirectTcpIpRequest -> DirectTcpIpRequest -> DirectTcpIpRequest

Show DirectTcpIpRequest

Defined in Network.SSH.Server.Service.Connection

Methods

showsPrec :: Int -> DirectTcpIpRequest -> ShowS

show :: DirectTcpIpRequest -> String

showList :: [DirectTcpIpRequest] -> ShowS

newtype DirectTcpIpHandler

The DirectTcpIpHandler contains the application logic that handles port forwarding requests.

There is of course no need to actually do a real forwarding - this mechanism might also be used to give access to process internal services like integrated web servers etc.

• When the handler exits gracefully, the implementation assures that all bytes will be sent to the client before terminating the stream with an eof and actually closing the channel.

Constructors

DirectTcpIpHandler (forall stream. DuplexStream stream => stream -> IO ())

data ConnectionMsg

Constructors

ConnectionChannelOpen ChannelOpen

ConnectionChannelClose ChannelClose

ConnectionChannelEof ChannelEof

ConnectionChannelData ChannelData

ConnectionChannelRequest ChannelRequest

ConnectionChannelWindowAdjust ChannelWindowAdjust

Instances

Eq ConnectionMsg

Defined in Network.SSH.Server.Service.Connection

Methods

(==) :: ConnectionMsg -> ConnectionMsg -> Bool

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

Show ConnectionMsg

Defined in Network.SSH.Server.Service.Connection

Methods

showsPrec :: Int -> ConnectionMsg -> ShowS

show :: ConnectionMsg -> String

showList :: [ConnectionMsg] -> ShowS

Encoding ConnectionMsg

Defined in Network.SSH.Server.Service.Connection

Methods

put :: Builder b => ConnectionMsg -> b

get :: Get ConnectionMsg

serveConnection :: forall stream identity. MessageStream stream => ConnectionConfig identity -> stream -> identity -> IO ()

data UserAuthConfig identity

Configuration for the user authentication layer.

After a successful key exchange the client will usually request the user-auth service to authenticate against. In this implementation, the user-auth service is the only service available after key exchange and the client must request the connection layer through the authentication layer. Except for transport messages, all other message types will result in a disconnect as long as user authentication is in progress (looking at you, libssh ;-)

Constructors

UserAuthConfig

Fields

• onAuthRequest :: UserName -> ServiceName -> PublicKey -> IO (Maybe identity)

  This handler will be called for each authentication attempt.

  1. The client might try several methods and keys: Just return Nothing for every request that is not sufficient to determine the user's identity.
  2. When access shall be granted, return Just. The identity may contain whatever is desired; it may be just the UserName.
  3. When the client uses public key authentication, the transport layer has already determined that the client is in posession of the corresponding private key (by requesting and validating a signature).
  4. The default rejects all authentication attempts unconditionally.
• userAuthMaxTime :: Word16

  Timeout for user authentication in seconds (default is 60).

  1. A SSH_DISCONNECT_BY_APPLICATION will be sent to the client when the timeout occurs before successful authentication.
• userAuthMaxAttempts :: Word16

  A limit for the number of failed attempts per connection (default is 20).

  1. A SSH_DISCONNECT_BY_APPLICATION will be sent to the client when limit has been exceeded.

Instances

Default (UserAuthConfig identity)

Defined in Network.SSH.Server.Service.UserAuth

Methods

def :: UserAuthConfig identity

withAuthentication :: forall identity stream a. MessageStream stream => UserAuthConfig identity -> stream -> SessionId -> (ServiceName -> Maybe (identity -> IO a)) -> IO a

verifyAuthSignature :: SessionId -> UserName -> ServiceName -> PublicKey -> Signature -> Bool

class (InputStream stream, OutputStream stream) => DuplexStream stream

A DuplexStream is an abstraction over all things that behave like file handles or sockets.

Instances

DuplexStream TStreamingQueue

Defined in Network.SSH.TStreamingQueue

class OutputStream stream where

An OutputStream is something that chunks of bytes can be written to.

Minimal complete definition

send

Methods

send :: stream -> ByteString -> IO Int

Send a chunk of bytes into the stream.

1. This method shall block until at least one byte could be sent or the connection got closed.
2. Returns the number of bytes sent or 0 if the other side closed the connection. The return value must be checked when using a loop for sending or the program will get stuck in endless recursion!

sendUnsafe :: stream -> MemView -> IO Int

Like send, but allows for more efficiency with less memory allocations when working with builders and re-usable buffers.

Instances

OutputStream TStreamingQueue

Defined in Network.SSH.TStreamingQueue

Methods

send :: TStreamingQueue -> ByteString -> IO Int

sendUnsafe :: TStreamingQueue -> MemView -> IO Int

class InputStream stream where

An InputStream is something that bytes can be read from.

Minimal complete definition

peek, receive

Methods

peek :: stream -> Int -> IO ByteString

Like receive, but does not actually remove anything from the input buffer.

1. Use with care! There are very few legitimate use cases for this.

receive :: stream -> Int -> IO ByteString

Receive a chunk of bytes from the stream.

1. This method shall block until at least one byte becomes available or the connection got closed.
2. As with sockets, the chunk boundaries are not guaranteed to be preserved during transmission although this will be most often the case. Never rely on this behaviour!
3. The second parameter determines how many bytes to receive at most, but the ByteString returned might be shorter.
4. Returns a chunk which is guaranteed to be shorter or equal than the given limit. It is empty when the connection got closed and all subsequent attempts to read shall return the empty string. This must be checked when collecting chunks in a loop or the program will get stuck in endless recursion!

receiveUnsafe :: stream -> MemView -> IO Int

Like receive, but allows for more efficiency with less memory allocations when working with builders and re-usable buffers.

Instances

InputStream TStreamingQueue

Defined in Network.SSH.TStreamingQueue

Methods

peek :: TStreamingQueue -> Int -> IO ByteString

receive :: TStreamingQueue -> Int -> IO ByteString

receiveUnsafe :: TStreamingQueue -> MemView -> IO Int

sendAll :: OutputStream stream => stream -> ByteString -> IO ()

Try to send the complete ByteString.

• Blocks until either the ByteString has been sent or throws an exception when the connection got terminated while sending it.

receiveAll :: InputStream stream => stream -> Int -> IO ByteString

Try to receive a ByteString of the designated length in bytes.

• Blocks until either the complete ByteString has been received or throws an exception when the connection got terminated before enough bytes arrived.

data Transport

Instances

MessageStream Transport

Defined in Network.SSH.Transport

Methods

sendMessage :: Encoding msg => Transport -> msg -> IO ()

receiveMessage :: Encoding msg => Transport -> IO msg

data TransportConfig

Constructors

TransportConfig

Fields

• serverHostKeyAlgorithms :: NonEmpty HostKeyAlgorithm
• kexAlgorithms :: NonEmpty KeyExchangeAlgorithm
• encryptionAlgorithms :: NonEmpty EncryptionAlgorithm
• maxTimeBeforeRekey :: Word64
• maxDataBeforeRekey :: Word64
• onSend :: ByteString -> IO ()
• onReceive :: ByteString -> IO ()

Instances

Default TransportConfig

Defined in Network.SSH.Transport

Methods

def :: TransportConfig

data Disconnected

Constructors

Disconnected

Fields

• disconnectedReason :: DisconnectReason
• disconnectedDescription :: ShortByteString
• disconnectedLanguageTag :: ShortByteString

Instances

Eq Disconnected

Defined in Network.SSH.Message

Methods

(==) :: Disconnected -> Disconnected -> Bool

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

Show Disconnected

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> Disconnected -> ShowS

show :: Disconnected -> String

showList :: [Disconnected] -> ShowS

Encoding Disconnected

Defined in Network.SSH.Message

Methods

put :: Builder b => Disconnected -> b

get :: Get Disconnected

withTransport :: (DuplexStream stream, AuthAgent agent) => TransportConfig -> Maybe agent -> stream -> (Transport -> SessionId -> IO a) -> IO (Either Disconnect a)

plainEncryptionContext :: OutputStream stream => stream -> EncryptionContext

plainDecryptionContext :: InputStream stream => stream -> DecryptionContext

newChaCha20Poly1305EncryptionContext :: (OutputStream stream, ByteArrayAccess key) => stream -> key -> key -> IO EncryptionContext

newChaCha20Poly1305DecryptionContext :: InputStream stream => ByteArrayAccess key => stream -> key -> key -> IO DecryptionContext

data TStreamingQueue

Constructors

TStreamingQueue

Fields

• qCapacity :: Word32
• qWindow :: TVar Word32
• qSize :: TVar Word32
• qEof :: TVar Bool
• qHead :: TMVar ShortByteString
• qTail :: TChan ShortByteString

Instances

InputStream TStreamingQueue

Defined in Network.SSH.TStreamingQueue

Methods

peek :: TStreamingQueue -> Int -> IO ByteString

receive :: TStreamingQueue -> Int -> IO ByteString

receiveUnsafe :: TStreamingQueue -> MemView -> IO Int

OutputStream TStreamingQueue

Defined in Network.SSH.TStreamingQueue

Methods

send :: TStreamingQueue -> ByteString -> IO Int

sendUnsafe :: TStreamingQueue -> MemView -> IO Int

DuplexStream TStreamingQueue

Defined in Network.SSH.TStreamingQueue

newTStreamingQueue :: Word32 -> TVar Word32 -> STM TStreamingQueue

capacity :: TStreamingQueue -> Word32

getSize :: TStreamingQueue -> STM Word32

getFree :: TStreamingQueue -> STM Word32

getWindowSpace :: TStreamingQueue -> STM Word32

addWindowSpace :: TStreamingQueue -> Word32 -> STM ()

askWindowSpaceAdjustRecommended :: TStreamingQueue -> STM Bool

fillWindowSpace :: TStreamingQueue -> STM Word32

terminate :: TStreamingQueue -> STM ()

enqueue :: TStreamingQueue -> ByteString -> STM Word32

dequeue :: TStreamingQueue -> Word32 -> STM ByteString

dequeueShort :: TStreamingQueue -> Word32 -> STM ShortByteString

lookAhead :: TStreamingQueue -> Word32 -> STM ByteString