Safe Haskell	None
Language	Haskell2010

Network.SSH.Internal

Contents

Message
Misc

Synopsis

data HostKeyAlgorithm = SshEd25519
data KeyExchangeAlgorithm = Curve25519Sha256AtLibsshDotOrg
data EncryptionAlgorithm = Chacha20Poly1305AtOpensshDotCom
data CompressionAlgorithm = None
type Get = Get
class Encoding a where
- put :: forall b. Builder b => a -> b
- get :: Get a
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 = Disconnect DisconnectParty DisconnectReason DisconnectMessage
data DisconnectParty
- = Local
- | Remote
data DisconnectReason
- = DisconnectHostNotAllowedToConnect
- | DisconnectProtocolError
- | DisconnectKeyExchangeFailed
- | DisconnectReserved
- | DisconnectMacError
- | DisconnectCompressionError
- | DisconnectServiceNotAvailable
- | DisconnectProtocolVersionNotSupported
- | DisconnectHostKeyNotVerifiable
- | DisconnectConnectionLost
- | DisconnectByApplication
- | DisconnectTooManyConnection
- | DisconnectAuthCancelledByUser
- | DisconnectNoMoreAuthMethodsAvailable
- | DisconnectIllegalUsername
- | DisconnectOtherReason Word32
newtype DisconnectMessage = DisconnectMessage ByteString
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 = KeyPairEd25519 PublicKey SecretKey
newKeyPair :: IO KeyPair
data PublicKey
- = PublicKeyEd25519 PublicKey
- | PublicKeyRSA PublicKey
- | PublicKeyOther Name
decodePrivateKeyFile :: (MonadFail m, ByteArray input, ByteArrayAccess passphrase, ByteArray comment) => passphrase -> input -> m [(KeyPair, comment)]
toPublicKey :: KeyPair -> PublicKey
data Message
- = 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
class MessageStream a where
- sendMessage :: forall msg. Encoding msg => a -> msg -> IO ()
- receiveMessage :: forall msg. Encoding msg => a -> IO msg
data Disconnected = Disconnected {
- disconnectedReason :: DisconnectReason
- disconnectedDescription :: ShortByteString
- disconnectedLanguageTag :: ShortByteString
}
data DisconnectReason
- = DisconnectHostNotAllowedToConnect
- | DisconnectProtocolError
- | DisconnectKeyExchangeFailed
- | DisconnectReserved
- | DisconnectMacError
- | DisconnectCompressionError
- | DisconnectServiceNotAvailable
- | DisconnectProtocolVersionNotSupported
- | DisconnectHostKeyNotVerifiable
- | DisconnectConnectionLost
- | DisconnectByApplication
- | DisconnectTooManyConnection
- | DisconnectAuthCancelledByUser
- | DisconnectNoMoreAuthMethodsAvailable
- | DisconnectIllegalUsername
- | DisconnectOtherReason Word32
data Ignore = Ignore
data Unimplemented = Unimplemented Word32
data Debug = Debug {
- debugAlwaysDisplay :: Bool
- debugMessage :: ShortByteString
- debugLanguageTag :: ShortByteString
}
data ServiceRequest = ServiceRequest ServiceName
data ServiceAccept = ServiceAccept ServiceName
data KexInit = KexInit {
- kexCookie :: Cookie
- kexKexAlgorithms :: [Name]
- kexServerHostKeyAlgorithms :: [Name]
- kexEncryptionAlgorithmsClientToServer :: [Name]
- kexEncryptionAlgorithmsServerToClient :: [Name]
- kexMacAlgorithmsClientToServer :: [Name]
- kexMacAlgorithmsServerToClient :: [Name]
- kexCompressionAlgorithmsClientToServer :: [Name]
- kexCompressionAlgorithmsServerToClient :: [Name]
- kexLanguagesClientToServer :: [Name]
- kexLanguagesServerToClient :: [Name]
- kexFirstPacketFollows :: Bool
}
data KexNewKeys = KexNewKeys
data KexEcdhInit = KexEcdhInit {
- kexClientEphemeralKey :: PublicKey
}
data KexEcdhReply = KexEcdhReply {
- kexServerHostKey :: PublicKey
- kexServerEphemeralKey :: PublicKey
- kexHashSignature :: Signature
}
data UserAuthRequest = UserAuthRequest UserName ServiceName AuthMethod
data UserAuthFailure = UserAuthFailure [Name] Bool
data UserAuthSuccess = UserAuthSuccess
data UserAuthBanner = UserAuthBanner ShortByteString ShortByteString
data UserAuthPublicKeyOk = UserAuthPublicKeyOk PublicKey
data ChannelOpen = ChannelOpen ChannelId ChannelWindowSize ChannelPacketSize ChannelOpenType
data ChannelOpenType
- = ChannelOpenSession
- | ChannelOpenDirectTcpIp {
  - coDestinationAddress :: ShortByteString
  - coDestinationPort :: Word32
  - coSourceAddress :: ShortByteString
  - coSourcePort :: Word32
  }
- | ChannelOpenOther ChannelType
data ChannelOpenConfirmation = ChannelOpenConfirmation ChannelId ChannelId ChannelWindowSize ChannelPacketSize
data ChannelOpenFailure = ChannelOpenFailure ChannelId ChannelOpenFailureReason ShortByteString ShortByteString
data ChannelOpenFailureReason
- = ChannelOpenAdministrativelyProhibited
- | ChannelOpenConnectFailed
- | ChannelOpenUnknownChannelType
- | ChannelOpenResourceShortage
- | ChannelOpenOtherFailure Word32
data ChannelWindowAdjust = ChannelWindowAdjust ChannelId ChannelWindowSize
data ChannelData = ChannelData ChannelId ShortByteString
data ChannelExtendedData = ChannelExtendedData ChannelId Word32 ShortByteString
data ChannelEof = ChannelEof ChannelId
data ChannelClose = ChannelClose ChannelId
data ChannelRequest = ChannelRequest {
- crChannel :: ChannelId
- crType :: ShortByteString
- crWantReply :: Bool
- crData :: ByteString
}
data ChannelRequestEnv = ChannelRequestEnv {
- crVariableName :: ShortByteString
- crVariableValue :: ShortByteString
}
data ChannelRequestPty = ChannelRequestPty {
- crPtySettings :: PtySettings
}
data ChannelRequestWindowChange = ChannelRequestWindowChange {
- crWidth :: Word32
- crHeight :: Word32
- crWidthPixels :: Word32
- crHeightPixels :: Word32
}
data ChannelRequestShell = ChannelRequestShell
data ChannelRequestExec = ChannelRequestExec {
- crCommand :: ShortByteString
}
data ChannelRequestSignal = ChannelRequestSignal {
- crSignal :: ShortByteString
}
data ChannelRequestExitStatus = ChannelRequestExitStatus {
- crExitStatus :: ExitCode
}
data ChannelRequestExitSignal = ChannelRequestExitSignal {
- crSignalName :: ShortByteString
- crCodeDumped :: Bool
- crErrorMessage :: ShortByteString
- crLanguageTag :: ShortByteString
}
data ChannelSuccess = ChannelSuccess ChannelId
data ChannelFailure = ChannelFailure ChannelId
data AuthMethod
- = AuthNone
- | AuthHostBased
- | AuthPassword Password
- | AuthPublicKey PublicKey (Maybe Signature)
- | AuthOther Name
newtype ChannelId = ChannelId Word32
newtype ChannelType = ChannelType ShortByteString
type ChannelPacketSize = Word32
type ChannelWindowSize = Word32
data Cookie
newCookie :: MonadRandom m => m Cookie
nilCookie :: Cookie
newtype Password = Password ShortByteString
data PtySettings = PtySettings {
- ptyEnv :: ShortByteString
- ptyWidthCols :: Word32
- ptyHeightRows :: Word32
- ptyWidthPixels :: Word32
- ptyHeightPixels :: Word32
- ptyModes :: ShortByteString
}
data PublicKey
- = PublicKeyEd25519 PublicKey
- | PublicKeyRSA PublicKey
- | PublicKeyOther Name
newtype SessionId = SessionId ShortByteString
data Signature
- = SignatureEd25519 Signature
- | SignatureRSA ByteString
- | SignatureOther Name
newtype Version = Version ShortByteString
type ServiceName = Name
type UserName = Name
newtype Name = Name ShortByteString
class HasName a where
- name :: a -> Name
data Connection identity
data ConnectionConfig identity = ConnectionConfig {
- onSessionRequest :: identity -> SessionRequest -> IO (Maybe SessionHandler)
- onDirectTcpIpRequest :: identity -> DirectTcpIpRequest -> IO (Maybe DirectTcpIpHandler)
- channelMaxCount :: Word16
- channelMaxQueueSize :: Word32
- channelMaxPacketSize :: Word32
}
data SessionRequest = SessionRequest
newtype SessionHandler = SessionHandler (forall stdin stdout stderr. (InputStream stdin, OutputStream stdout, OutputStream stderr) => Environment -> Maybe TermInfo -> Maybe Command -> stdin -> stdout -> stderr -> IO ExitCode)
newtype Environment = Environment [(ByteString, ByteString)]
data TermInfo = TermInfo PtySettings
newtype Command = Command ByteString
data DirectTcpIpRequest = DirectTcpIpRequest {
- dstAddress :: ByteString
- dstPort :: Word32
- srcAddress :: ByteString
- srcPort :: Word32
}
newtype DirectTcpIpHandler = DirectTcpIpHandler (forall stream. DuplexStream stream => stream -> IO ())
data ConnectionMsg
- = ConnectionChannelOpen ChannelOpen
- | ConnectionChannelClose ChannelClose
- | ConnectionChannelEof ChannelEof
- | ConnectionChannelData ChannelData
- | ConnectionChannelRequest ChannelRequest
- | ConnectionChannelWindowAdjust ChannelWindowAdjust
serveConnection :: forall stream identity. MessageStream stream => ConnectionConfig identity -> stream -> identity -> IO ()
data UserAuthConfig identity = UserAuthConfig {
- onAuthRequest :: UserName -> ServiceName -> PublicKey -> IO (Maybe identity)
- userAuthMaxTime :: Word16
- userAuthMaxAttempts :: Word16
}
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
class OutputStream stream where
- send :: stream -> ByteString -> IO Int
- sendUnsafe :: stream -> MemView -> IO Int
class InputStream stream where
- peek :: stream -> Int -> IO ByteString
- receive :: stream -> Int -> IO ByteString
- receiveUnsafe :: stream -> MemView -> IO Int
sendAll :: OutputStream stream => stream -> ByteString -> IO ()
receiveAll :: InputStream stream => stream -> Int -> IO ByteString
data Transport
data TransportConfig = TransportConfig {
- serverHostKeyAlgorithms :: NonEmpty HostKeyAlgorithm
- kexAlgorithms :: NonEmpty KeyExchangeAlgorithm
- encryptionAlgorithms :: NonEmpty EncryptionAlgorithm
- maxTimeBeforeRekey :: Word64
- maxDataBeforeRekey :: Word64
- onSend :: ByteString -> IO ()
- onReceive :: ByteString -> IO ()
}
data Disconnected = Disconnected {
- disconnectedReason :: DisconnectReason
- disconnectedDescription :: ShortByteString
- disconnectedLanguageTag :: ShortByteString
}
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 = TStreamingQueue {
- qCapacity :: Word32
- qWindow :: TVar Word32
- qSize :: TVar Word32
- qEof :: TVar Bool
- qHead :: TMVar ShortByteString
- qTail :: TChan ShortByteString
}
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

Documentation

data HostKeyAlgorithm Source #

Constructors

SshEd25519

Instances

Eq HostKeyAlgorithm Source #
Instance details Defined in Network.SSH.Algorithms Methods (==) :: HostKeyAlgorithm -> HostKeyAlgorithm -> Bool # (/=) :: HostKeyAlgorithm -> HostKeyAlgorithm -> Bool #
Show HostKeyAlgorithm Source #
Instance details Defined in Network.SSH.Algorithms Methods showsPrec :: Int -> HostKeyAlgorithm -> ShowS # show :: HostKeyAlgorithm -> String # showList :: [HostKeyAlgorithm] -> ShowS #
HasName HostKeyAlgorithm Source #
Instance details Defined in Network.SSH.Algorithms Methods name :: HostKeyAlgorithm -> Name Source #

data KeyExchangeAlgorithm Source #

Constructors

Curve25519Sha256AtLibsshDotOrg

Instances

Eq KeyExchangeAlgorithm Source #
Instance details Defined in Network.SSH.Algorithms Methods (==) :: KeyExchangeAlgorithm -> KeyExchangeAlgorithm -> Bool # (/=) :: KeyExchangeAlgorithm -> KeyExchangeAlgorithm -> Bool #
Show KeyExchangeAlgorithm Source #
Instance details Defined in Network.SSH.Algorithms Methods showsPrec :: Int -> KeyExchangeAlgorithm -> ShowS # show :: KeyExchangeAlgorithm -> String # showList :: [KeyExchangeAlgorithm] -> ShowS #
HasName KeyExchangeAlgorithm Source #
Instance details Defined in Network.SSH.Algorithms Methods name :: KeyExchangeAlgorithm -> Name Source #

data EncryptionAlgorithm Source #

Constructors

Chacha20Poly1305AtOpensshDotCom

Instances

Eq EncryptionAlgorithm Source #
Instance details Defined in Network.SSH.Algorithms Methods (==) :: EncryptionAlgorithm -> EncryptionAlgorithm -> Bool # (/=) :: EncryptionAlgorithm -> EncryptionAlgorithm -> Bool #
Show EncryptionAlgorithm Source #
Instance details Defined in Network.SSH.Algorithms Methods showsPrec :: Int -> EncryptionAlgorithm -> ShowS # show :: EncryptionAlgorithm -> String # showList :: [EncryptionAlgorithm] -> ShowS #
HasName EncryptionAlgorithm Source #
Instance details Defined in Network.SSH.Algorithms Methods name :: EncryptionAlgorithm -> Name Source #

data CompressionAlgorithm Source #

Constructors

None

Instances

Eq CompressionAlgorithm Source #
Instance details Defined in Network.SSH.Algorithms Methods (==) :: CompressionAlgorithm -> CompressionAlgorithm -> Bool # (/=) :: CompressionAlgorithm -> CompressionAlgorithm -> Bool #
Show CompressionAlgorithm Source #
Instance details Defined in Network.SSH.Algorithms Methods showsPrec :: Int -> CompressionAlgorithm -> ShowS # show :: CompressionAlgorithm -> String # showList :: [CompressionAlgorithm] -> ShowS #
HasName CompressionAlgorithm Source #
Instance details Defined in Network.SSH.Algorithms Methods name :: CompressionAlgorithm -> Name Source #

type Get = Get Source #

class Encoding a where Source #

Methods

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

get :: Get a Source #

Instances

Encoding PublicKey Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => PublicKey -> b Source # get :: Get PublicKey Source #
Encoding PublicKey Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => PublicKey -> b Source # get :: Get PublicKey Source #
Encoding Signature Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => Signature -> b Source # get :: Get Signature Source #
Encoding DisconnectReason Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => DisconnectReason -> b Source # get :: Get DisconnectReason Source #
Encoding PublicKey Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => PublicKey -> b Source # get :: Get PublicKey Source #
Encoding ChannelId Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelId -> b Source # get :: Get ChannelId Source #
Encoding ChannelType Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelType -> b Source # get :: Get ChannelType Source #
Encoding SessionId Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => SessionId -> b Source # get :: Get SessionId Source #
Encoding Version Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => Version -> b Source # get :: Get Version Source #
Encoding Cookie Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => Cookie -> b Source # get :: Get Cookie Source #
Encoding PtySettings Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => PtySettings -> b Source # get :: Get PtySettings Source #
Encoding Signature Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => Signature -> b Source # get :: Get Signature Source #
Encoding AuthMethod Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => AuthMethod -> b Source # get :: Get AuthMethod Source #
Encoding ChannelFailure Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelFailure -> b Source # get :: Get ChannelFailure Source #
Encoding ChannelSuccess Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelSuccess -> b Source # get :: Get ChannelSuccess Source #
Encoding ChannelRequestExitSignal Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelRequestExitSignal -> b Source # get :: Get ChannelRequestExitSignal Source #
Encoding ChannelRequestExitStatus Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelRequestExitStatus -> b Source # get :: Get ChannelRequestExitStatus Source #
Encoding ChannelRequestSignal Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelRequestSignal -> b Source # get :: Get ChannelRequestSignal Source #
Encoding ChannelRequestExec Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelRequestExec -> b Source # get :: Get ChannelRequestExec Source #
Encoding ChannelRequestShell Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelRequestShell -> b Source # get :: Get ChannelRequestShell Source #
Encoding ChannelRequestWindowChange Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelRequestWindowChange -> b Source # get :: Get ChannelRequestWindowChange Source #
Encoding ChannelRequestPty Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelRequestPty -> b Source # get :: Get ChannelRequestPty Source #
Encoding ChannelRequestEnv Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelRequestEnv -> b Source # get :: Get ChannelRequestEnv Source #
Encoding ChannelRequest Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelRequest -> b Source # get :: Get ChannelRequest Source #
Encoding ChannelClose Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelClose -> b Source # get :: Get ChannelClose Source #
Encoding ChannelEof Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelEof -> b Source # get :: Get ChannelEof Source #
Encoding ChannelExtendedData Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelExtendedData -> b Source # get :: Get ChannelExtendedData Source #
Encoding ChannelData Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelData -> b Source # get :: Get ChannelData Source #
Encoding ChannelWindowAdjust Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelWindowAdjust -> b Source # get :: Get ChannelWindowAdjust Source #
Encoding ChannelOpenFailureReason Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelOpenFailureReason -> b Source # get :: Get ChannelOpenFailureReason Source #
Encoding ChannelOpenFailure Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelOpenFailure -> b Source # get :: Get ChannelOpenFailure Source #
Encoding ChannelOpenConfirmation Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelOpenConfirmation -> b Source # get :: Get ChannelOpenConfirmation Source #
Encoding ChannelOpen Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelOpen -> b Source # get :: Get ChannelOpen Source #
Encoding UserAuthPublicKeyOk Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => UserAuthPublicKeyOk -> b Source # get :: Get UserAuthPublicKeyOk Source #
Encoding UserAuthBanner Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => UserAuthBanner -> b Source # get :: Get UserAuthBanner Source #
Encoding UserAuthSuccess Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => UserAuthSuccess -> b Source # get :: Get UserAuthSuccess Source #
Encoding UserAuthFailure Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => UserAuthFailure -> b Source # get :: Get UserAuthFailure Source #
Encoding UserAuthRequest Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => UserAuthRequest -> b Source # get :: Get UserAuthRequest Source #
Encoding KexEcdhReply Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => KexEcdhReply -> b Source # get :: Get KexEcdhReply Source #
Encoding KexEcdhInit Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => KexEcdhInit -> b Source # get :: Get KexEcdhInit Source #
Encoding KexNewKeys Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => KexNewKeys -> b Source # get :: Get KexNewKeys Source #
Encoding KexInit Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => KexInit -> b Source # get :: Get KexInit Source #
Encoding ServiceAccept Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ServiceAccept -> b Source # get :: Get ServiceAccept Source #
Encoding ServiceRequest Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ServiceRequest -> b Source # get :: Get ServiceRequest Source #
Encoding Debug Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => Debug -> b Source # get :: Get Debug Source #
Encoding Unimplemented Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => Unimplemented -> b Source # get :: Get Unimplemented Source #
Encoding Ignore Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => Ignore -> b Source # get :: Get Ignore Source #
Encoding Disconnected Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => Disconnected -> b Source # get :: Get Disconnected Source #
Encoding Message Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => Message -> b Source # get :: Get Message Source #
Encoding ConnectionMsg Source #
Instance details Defined in Network.SSH.Server.Service.Connection Methods put :: Builder b => ConnectionMsg -> b Source # get :: Get ConnectionMsg Source #

runPut :: ByteArrayBuilder -> ByteString Source #

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

putExitCode :: Builder b => ExitCode -> b Source #

getExitCode :: Get ExitCode Source #

getFramed :: Get a -> Get a Source #

putWord8 :: Builder b => Word8 -> b Source #

getWord8 :: Get Word8 Source #

expectWord8 :: Word8 -> Get () Source #

getWord32 :: Get Word32 Source #

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

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

lenByteString :: ByteString -> Word32 Source #

putByteString :: Builder b => ByteString -> b Source #

getByteString :: Word32 -> Get ByteString Source #

getRemainingByteString :: Get ByteString Source #

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

putShortString :: Builder b => ShortByteString -> b Source #

getShortString :: Get ShortByteString Source #

getString :: ByteArray ba => Get ba Source #

getName :: Get Name Source #

putName :: Builder b => Name -> b Source #

putBool :: Builder b => Bool -> b Source #

getBool :: Get Bool Source #

getTrue :: Get () Source #

getFalse :: Get () Source #

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

data Disconnect Source #

Constructors

Disconnect DisconnectParty DisconnectReason DisconnectMessage

Instances

Eq Disconnect Source #
Instance details Defined in Network.SSH.Exception Methods (==) :: Disconnect -> Disconnect -> Bool # (/=) :: Disconnect -> Disconnect -> Bool #
Ord Disconnect Source #
Instance details 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 Source #
Instance details Defined in Network.SSH.Exception Methods showsPrec :: Int -> Disconnect -> ShowS # show :: Disconnect -> String # showList :: [Disconnect] -> ShowS #
Exception Disconnect Source #
Instance details Defined in Network.SSH.Exception Methods toException :: Disconnect -> SomeException # fromException :: SomeException -> Maybe Disconnect # displayException :: Disconnect -> String #

data DisconnectParty Source #

Constructors

Local
Remote

Instances

Eq DisconnectParty Source #
Instance details Defined in Network.SSH.Exception Methods (==) :: DisconnectParty -> DisconnectParty -> Bool # (/=) :: DisconnectParty -> DisconnectParty -> Bool #
Ord DisconnectParty Source #
Instance details 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 Source #
Instance details Defined in Network.SSH.Exception Methods showsPrec :: Int -> DisconnectParty -> ShowS # show :: DisconnectParty -> String # showList :: [DisconnectParty] -> ShowS #

data DisconnectReason Source #

Constructors

DisconnectHostNotAllowedToConnect
DisconnectProtocolError
DisconnectKeyExchangeFailed
DisconnectReserved
DisconnectMacError
DisconnectCompressionError
DisconnectServiceNotAvailable
DisconnectProtocolVersionNotSupported
DisconnectHostKeyNotVerifiable
DisconnectConnectionLost
DisconnectByApplication
DisconnectTooManyConnection
DisconnectAuthCancelledByUser
DisconnectNoMoreAuthMethodsAvailable
DisconnectIllegalUsername
DisconnectOtherReason Word32

Instances

Eq DisconnectReason Source #
Instance details Defined in Network.SSH.Exception Methods (==) :: DisconnectReason -> DisconnectReason -> Bool # (/=) :: DisconnectReason -> DisconnectReason -> Bool #
Ord DisconnectReason Source #
Instance details 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 Source #
Instance details Defined in Network.SSH.Exception Methods showsPrec :: Int -> DisconnectReason -> ShowS # show :: DisconnectReason -> String # showList :: [DisconnectReason] -> ShowS #
Encoding DisconnectReason Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => DisconnectReason -> b Source # get :: Get DisconnectReason Source #

newtype DisconnectMessage Source #

Constructors

DisconnectMessage ByteString

Instances

Eq DisconnectMessage Source #
Instance details Defined in Network.SSH.Exception Methods (==) :: DisconnectMessage -> DisconnectMessage -> Bool # (/=) :: DisconnectMessage -> DisconnectMessage -> Bool #
Ord DisconnectMessage Source #
Instance details 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 Source #
Instance details Defined in Network.SSH.Exception Methods showsPrec :: Int -> DisconnectMessage -> ShowS # show :: DisconnectMessage -> String # showList :: [DisconnectMessage] -> ShowS #
IsString DisconnectMessage Source #
Instance details Defined in Network.SSH.Exception Methods fromString :: String -> DisconnectMessage #
Semigroup DisconnectMessage Source #
Instance details Defined in Network.SSH.Exception Methods (<>) :: DisconnectMessage -> DisconnectMessage -> DisconnectMessage # sconcat :: NonEmpty DisconnectMessage -> DisconnectMessage # stimes :: Integral b => b -> DisconnectMessage -> DisconnectMessage #
Monoid DisconnectMessage Source #
Instance details Defined in Network.SSH.Exception Methods mempty :: DisconnectMessage # mappend :: DisconnectMessage -> DisconnectMessage -> DisconnectMessage # mconcat :: [DisconnectMessage] -> DisconnectMessage #

exceptionProtocolVersionNotSupported :: Disconnect Source #

exceptionConnectionLost :: Disconnect Source #

exceptionKexInvalidTransition :: Disconnect Source #

exceptionKexInvalidSignature :: Disconnect Source #

exceptionKexNoSignature :: Disconnect Source #

exceptionKexNoCommonKexAlgorithm :: Disconnect Source #

exceptionKexNoCommonEncryptionAlgorithm :: Disconnect Source #

exceptionMacError :: Disconnect Source #

exceptionInvalidPacket :: Disconnect Source #

exceptionPacketLengthExceeded :: Disconnect Source #

exceptionAuthenticationTimeout :: Disconnect Source #

exceptionAuthenticationLimitExceeded :: Disconnect Source #

exceptionServiceNotAvailable :: Disconnect Source #

exceptionInvalidChannelId :: Disconnect Source #

exceptionInvalidChannelRequest :: Disconnect Source #

exceptionWindowSizeOverflow :: Disconnect Source #

exceptionWindowSizeUnderrun :: Disconnect Source #

exceptionPacketSizeExceeded :: Disconnect Source #

exceptionDataAfterEof :: Disconnect Source #

exceptionAlreadyExecuting :: Disconnect Source #

exceptionUnexpectedMessage :: ByteString -> Disconnect Source #

data KeyPair Source #

Constructors

KeyPairEd25519 PublicKey SecretKey

Instances

Eq KeyPair Source #
Instance details Defined in Network.SSH.Key Methods (==) :: KeyPair -> KeyPair -> Bool # (/=) :: KeyPair -> KeyPair -> Bool #
Show KeyPair Source #
Instance details Defined in Network.SSH.Key Methods showsPrec :: Int -> KeyPair -> ShowS # show :: KeyPair -> String # showList :: [KeyPair] -> ShowS #
AuthAgent KeyPair Source #
Instance details Defined in Network.SSH.AuthAgent Methods getPublicKeys :: KeyPair -> IO [PublicKey] Source # getSignature :: ByteArrayAccess hash => KeyPair -> PublicKey -> hash -> IO (Maybe Signature) Source #

newKeyPair :: IO KeyPair Source #

data PublicKey Source #

Constructors

PublicKeyEd25519 PublicKey
PublicKeyRSA PublicKey
PublicKeyOther Name

Instances

Eq PublicKey Source #
Instance details Defined in Network.SSH.Key Methods (==) :: PublicKey -> PublicKey -> Bool # (/=) :: PublicKey -> PublicKey -> Bool #
Show PublicKey Source #
Instance details Defined in Network.SSH.Key Methods showsPrec :: Int -> PublicKey -> ShowS # show :: PublicKey -> String # showList :: [PublicKey] -> ShowS #
HasName PublicKey Source #
Instance details Defined in Network.SSH.Key Methods name :: PublicKey -> Name Source #
Encoding PublicKey Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => PublicKey -> b Source # get :: Get PublicKey Source #

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

toPublicKey :: KeyPair -> PublicKey Source #

Message

data Message Source #

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 Source #
Instance details Defined in Network.SSH.Message Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #
Show Message Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
Encoding Message Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => Message -> b Source # get :: Get Message Source #

class MessageStream a where Source #

Methods

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

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

Instances

MessageStream Transport Source #
Instance details Defined in Network.SSH.Transport Methods sendMessage :: Encoding msg => Transport -> msg -> IO () Source # receiveMessage :: Encoding msg => Transport -> IO msg Source #

Disconnected (1)

data Disconnected Source #

Constructors

Disconnected
Fields disconnectedReason :: DisconnectReason disconnectedDescription :: ShortByteString disconnectedLanguageTag :: ShortByteString

Instances

Eq Disconnected Source #
Instance details Defined in Network.SSH.Message Methods (==) :: Disconnected -> Disconnected -> Bool # (/=) :: Disconnected -> Disconnected -> Bool #
Show Disconnected Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> Disconnected -> ShowS # show :: Disconnected -> String # showList :: [Disconnected] -> ShowS #
Encoding Disconnected Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => Disconnected -> b Source # get :: Get Disconnected Source #

data DisconnectReason Source #

Constructors

DisconnectHostNotAllowedToConnect
DisconnectProtocolError
DisconnectKeyExchangeFailed
DisconnectReserved
DisconnectMacError
DisconnectCompressionError
DisconnectServiceNotAvailable
DisconnectProtocolVersionNotSupported
DisconnectHostKeyNotVerifiable
DisconnectConnectionLost
DisconnectByApplication
DisconnectTooManyConnection
DisconnectAuthCancelledByUser
DisconnectNoMoreAuthMethodsAvailable
DisconnectIllegalUsername
DisconnectOtherReason Word32

Instances

Eq DisconnectReason Source #
Instance details Defined in Network.SSH.Exception Methods (==) :: DisconnectReason -> DisconnectReason -> Bool # (/=) :: DisconnectReason -> DisconnectReason -> Bool #
Ord DisconnectReason Source #
Instance details 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 Source #
Instance details Defined in Network.SSH.Exception Methods showsPrec :: Int -> DisconnectReason -> ShowS # show :: DisconnectReason -> String # showList :: [DisconnectReason] -> ShowS #
Encoding DisconnectReason Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => DisconnectReason -> b Source # get :: Get DisconnectReason Source #

Ignore (2)

data Ignore Source #

Constructors

Ignore

Instances

Eq Ignore Source #
Instance details Defined in Network.SSH.Message Methods (==) :: Ignore -> Ignore -> Bool # (/=) :: Ignore -> Ignore -> Bool #
Show Ignore Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> Ignore -> ShowS # show :: Ignore -> String # showList :: [Ignore] -> ShowS #
Encoding Ignore Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => Ignore -> b Source # get :: Get Ignore Source #

Unimplemented (3)

data Unimplemented Source #

Constructors

Unimplemented Word32

Instances

Eq Unimplemented Source #
Instance details Defined in Network.SSH.Message Methods (==) :: Unimplemented -> Unimplemented -> Bool # (/=) :: Unimplemented -> Unimplemented -> Bool #
Show Unimplemented Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> Unimplemented -> ShowS # show :: Unimplemented -> String # showList :: [Unimplemented] -> ShowS #
Encoding Unimplemented Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => Unimplemented -> b Source # get :: Get Unimplemented Source #

Debug (4)

data Debug Source #

Constructors

Debug
Fields debugAlwaysDisplay :: Bool debugMessage :: ShortByteString debugLanguageTag :: ShortByteString

Instances

Eq Debug Source #
Instance details Defined in Network.SSH.Message Methods (==) :: Debug -> Debug -> Bool # (/=) :: Debug -> Debug -> Bool #
Show Debug Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> Debug -> ShowS # show :: Debug -> String # showList :: [Debug] -> ShowS #
Encoding Debug Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => Debug -> b Source # get :: Get Debug Source #

ServiceRequest (5)

data ServiceRequest Source #

Constructors

ServiceRequest ServiceName

Instances

Eq ServiceRequest Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ServiceRequest -> ServiceRequest -> Bool # (/=) :: ServiceRequest -> ServiceRequest -> Bool #
Show ServiceRequest Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ServiceRequest -> ShowS # show :: ServiceRequest -> String # showList :: [ServiceRequest] -> ShowS #
Encoding ServiceRequest Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ServiceRequest -> b Source # get :: Get ServiceRequest Source #

ServiceAccept (6)

data ServiceAccept Source #

Constructors

ServiceAccept ServiceName

Instances

Eq ServiceAccept Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ServiceAccept -> ServiceAccept -> Bool # (/=) :: ServiceAccept -> ServiceAccept -> Bool #
Show ServiceAccept Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ServiceAccept -> ShowS # show :: ServiceAccept -> String # showList :: [ServiceAccept] -> ShowS #
Encoding ServiceAccept Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ServiceAccept -> b Source # get :: Get ServiceAccept Source #

KexInit (20)

data KexInit Source #

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 Source #
Instance details Defined in Network.SSH.Message Methods (==) :: KexInit -> KexInit -> Bool # (/=) :: KexInit -> KexInit -> Bool #
Show KexInit Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> KexInit -> ShowS # show :: KexInit -> String # showList :: [KexInit] -> ShowS #
Encoding KexInit Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => KexInit -> b Source # get :: Get KexInit Source #

KexNewKeys (21)

data KexNewKeys Source #

Constructors

KexNewKeys

Instances

Eq KexNewKeys Source #
Instance details Defined in Network.SSH.Message Methods (==) :: KexNewKeys -> KexNewKeys -> Bool # (/=) :: KexNewKeys -> KexNewKeys -> Bool #
Show KexNewKeys Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> KexNewKeys -> ShowS # show :: KexNewKeys -> String # showList :: [KexNewKeys] -> ShowS #
Encoding KexNewKeys Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => KexNewKeys -> b Source # get :: Get KexNewKeys Source #

KexEcdhInit (30)

data KexEcdhInit Source #

Constructors

KexEcdhInit
Fields kexClientEphemeralKey :: PublicKey

Instances

Eq KexEcdhInit Source #
Instance details Defined in Network.SSH.Message Methods (==) :: KexEcdhInit -> KexEcdhInit -> Bool # (/=) :: KexEcdhInit -> KexEcdhInit -> Bool #
Show KexEcdhInit Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> KexEcdhInit -> ShowS # show :: KexEcdhInit -> String # showList :: [KexEcdhInit] -> ShowS #
Encoding KexEcdhInit Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => KexEcdhInit -> b Source # get :: Get KexEcdhInit Source #

KexEcdhReply (31)

data KexEcdhReply Source #

Constructors

KexEcdhReply
Fields kexServerHostKey :: PublicKey kexServerEphemeralKey :: PublicKey kexHashSignature :: Signature

Instances

Eq KexEcdhReply Source #
Instance details Defined in Network.SSH.Message Methods (==) :: KexEcdhReply -> KexEcdhReply -> Bool # (/=) :: KexEcdhReply -> KexEcdhReply -> Bool #
Show KexEcdhReply Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> KexEcdhReply -> ShowS # show :: KexEcdhReply -> String # showList :: [KexEcdhReply] -> ShowS #
Encoding KexEcdhReply Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => KexEcdhReply -> b Source # get :: Get KexEcdhReply Source #

UserAuthRequest (50)

data UserAuthRequest Source #

Constructors

UserAuthRequest UserName ServiceName AuthMethod

Instances

Eq UserAuthRequest Source #
Instance details Defined in Network.SSH.Message Methods (==) :: UserAuthRequest -> UserAuthRequest -> Bool # (/=) :: UserAuthRequest -> UserAuthRequest -> Bool #
Show UserAuthRequest Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> UserAuthRequest -> ShowS # show :: UserAuthRequest -> String # showList :: [UserAuthRequest] -> ShowS #
Encoding UserAuthRequest Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => UserAuthRequest -> b Source # get :: Get UserAuthRequest Source #

UserAuthFailure (51)

data UserAuthFailure Source #

Constructors

UserAuthFailure [Name] Bool

Instances

Eq UserAuthFailure Source #
Instance details Defined in Network.SSH.Message Methods (==) :: UserAuthFailure -> UserAuthFailure -> Bool # (/=) :: UserAuthFailure -> UserAuthFailure -> Bool #
Show UserAuthFailure Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> UserAuthFailure -> ShowS # show :: UserAuthFailure -> String # showList :: [UserAuthFailure] -> ShowS #
Encoding UserAuthFailure Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => UserAuthFailure -> b Source # get :: Get UserAuthFailure Source #

UserAuthSuccess (52)

data UserAuthSuccess Source #

Constructors

UserAuthSuccess

Instances

Eq UserAuthSuccess Source #
Instance details Defined in Network.SSH.Message Methods (==) :: UserAuthSuccess -> UserAuthSuccess -> Bool # (/=) :: UserAuthSuccess -> UserAuthSuccess -> Bool #
Show UserAuthSuccess Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> UserAuthSuccess -> ShowS # show :: UserAuthSuccess -> String # showList :: [UserAuthSuccess] -> ShowS #
Encoding UserAuthSuccess Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => UserAuthSuccess -> b Source # get :: Get UserAuthSuccess Source #

UserAuthBanner (53)

data UserAuthBanner Source #

Constructors

UserAuthBanner ShortByteString ShortByteString

Instances

Eq UserAuthBanner Source #
Instance details Defined in Network.SSH.Message Methods (==) :: UserAuthBanner -> UserAuthBanner -> Bool # (/=) :: UserAuthBanner -> UserAuthBanner -> Bool #
Show UserAuthBanner Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> UserAuthBanner -> ShowS # show :: UserAuthBanner -> String # showList :: [UserAuthBanner] -> ShowS #
Encoding UserAuthBanner Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => UserAuthBanner -> b Source # get :: Get UserAuthBanner Source #

UserAuthPublicKeyOk (60)

data UserAuthPublicKeyOk Source #

Constructors

UserAuthPublicKeyOk PublicKey

Instances

Eq UserAuthPublicKeyOk Source #
Instance details Defined in Network.SSH.Message Methods (==) :: UserAuthPublicKeyOk -> UserAuthPublicKeyOk -> Bool # (/=) :: UserAuthPublicKeyOk -> UserAuthPublicKeyOk -> Bool #
Show UserAuthPublicKeyOk Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> UserAuthPublicKeyOk -> ShowS # show :: UserAuthPublicKeyOk -> String # showList :: [UserAuthPublicKeyOk] -> ShowS #
Encoding UserAuthPublicKeyOk Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => UserAuthPublicKeyOk -> b Source # get :: Get UserAuthPublicKeyOk Source #

ChannelOpen (90)

data ChannelOpen Source #

Constructors

ChannelOpen ChannelId ChannelWindowSize ChannelPacketSize ChannelOpenType

Instances

Eq ChannelOpen Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelOpen -> ChannelOpen -> Bool # (/=) :: ChannelOpen -> ChannelOpen -> Bool #
Show ChannelOpen Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelOpen -> ShowS # show :: ChannelOpen -> String # showList :: [ChannelOpen] -> ShowS #
Encoding ChannelOpen Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelOpen -> b Source # get :: Get ChannelOpen Source #

data ChannelOpenType Source #

Constructors

ChannelOpenSession
ChannelOpenDirectTcpIp
Fields coDestinationAddress :: ShortByteString coDestinationPort :: Word32 coSourceAddress :: ShortByteString coSourcePort :: Word32
ChannelOpenOther ChannelType

Instances

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

ChannelOpenConfirmation (91)

data ChannelOpenConfirmation Source #

Constructors

ChannelOpenConfirmation ChannelId ChannelId ChannelWindowSize ChannelPacketSize

Instances

Eq ChannelOpenConfirmation Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelOpenConfirmation -> ChannelOpenConfirmation -> Bool # (/=) :: ChannelOpenConfirmation -> ChannelOpenConfirmation -> Bool #
Show ChannelOpenConfirmation Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelOpenConfirmation -> ShowS # show :: ChannelOpenConfirmation -> String # showList :: [ChannelOpenConfirmation] -> ShowS #
Encoding ChannelOpenConfirmation Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelOpenConfirmation -> b Source # get :: Get ChannelOpenConfirmation Source #

ChannelOpenFailure (92)

data ChannelOpenFailure Source #

Constructors

ChannelOpenFailure ChannelId ChannelOpenFailureReason ShortByteString ShortByteString

Instances

Eq ChannelOpenFailure Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelOpenFailure -> ChannelOpenFailure -> Bool # (/=) :: ChannelOpenFailure -> ChannelOpenFailure -> Bool #
Show ChannelOpenFailure Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelOpenFailure -> ShowS # show :: ChannelOpenFailure -> String # showList :: [ChannelOpenFailure] -> ShowS #
Encoding ChannelOpenFailure Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelOpenFailure -> b Source # get :: Get ChannelOpenFailure Source #

data ChannelOpenFailureReason Source #

Constructors

ChannelOpenAdministrativelyProhibited
ChannelOpenConnectFailed
ChannelOpenUnknownChannelType
ChannelOpenResourceShortage
ChannelOpenOtherFailure Word32

Instances

Eq ChannelOpenFailureReason Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelOpenFailureReason -> ChannelOpenFailureReason -> Bool # (/=) :: ChannelOpenFailureReason -> ChannelOpenFailureReason -> Bool #
Show ChannelOpenFailureReason Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelOpenFailureReason -> ShowS # show :: ChannelOpenFailureReason -> String # showList :: [ChannelOpenFailureReason] -> ShowS #
Encoding ChannelOpenFailureReason Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelOpenFailureReason -> b Source # get :: Get ChannelOpenFailureReason Source #

ChannelWindowAdjust (93)

data ChannelWindowAdjust Source #

Constructors

ChannelWindowAdjust ChannelId ChannelWindowSize

Instances

Eq ChannelWindowAdjust Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelWindowAdjust -> ChannelWindowAdjust -> Bool # (/=) :: ChannelWindowAdjust -> ChannelWindowAdjust -> Bool #
Show ChannelWindowAdjust Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelWindowAdjust -> ShowS # show :: ChannelWindowAdjust -> String # showList :: [ChannelWindowAdjust] -> ShowS #
Encoding ChannelWindowAdjust Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelWindowAdjust -> b Source # get :: Get ChannelWindowAdjust Source #

ChannelData (94)

data ChannelData Source #

Constructors

ChannelData ChannelId ShortByteString

Instances

Eq ChannelData Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelData -> ChannelData -> Bool # (/=) :: ChannelData -> ChannelData -> Bool #
Show ChannelData Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelData -> ShowS # show :: ChannelData -> String # showList :: [ChannelData] -> ShowS #
Encoding ChannelData Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelData -> b Source # get :: Get ChannelData Source #

ChannelExtendedData (95)

data ChannelExtendedData Source #

Constructors

ChannelExtendedData ChannelId Word32 ShortByteString

Instances

Eq ChannelExtendedData Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelExtendedData -> ChannelExtendedData -> Bool # (/=) :: ChannelExtendedData -> ChannelExtendedData -> Bool #
Show ChannelExtendedData Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelExtendedData -> ShowS # show :: ChannelExtendedData -> String # showList :: [ChannelExtendedData] -> ShowS #
Encoding ChannelExtendedData Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelExtendedData -> b Source # get :: Get ChannelExtendedData Source #

ChannelEof (96)

data ChannelEof Source #

Constructors

ChannelEof ChannelId

Instances

Eq ChannelEof Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelEof -> ChannelEof -> Bool # (/=) :: ChannelEof -> ChannelEof -> Bool #
Show ChannelEof Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelEof -> ShowS # show :: ChannelEof -> String # showList :: [ChannelEof] -> ShowS #
Encoding ChannelEof Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelEof -> b Source # get :: Get ChannelEof Source #

ChannelClose (97)

data ChannelClose Source #

Constructors

ChannelClose ChannelId

Instances

Eq ChannelClose Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelClose -> ChannelClose -> Bool # (/=) :: ChannelClose -> ChannelClose -> Bool #
Show ChannelClose Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelClose -> ShowS # show :: ChannelClose -> String # showList :: [ChannelClose] -> ShowS #
Encoding ChannelClose Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelClose -> b Source # get :: Get ChannelClose Source #

ChannelRequest (98)

data ChannelRequest Source #

Constructors

ChannelRequest
Fields crChannel :: ChannelId crType :: ShortByteString crWantReply :: Bool crData :: ByteString

Instances

Eq ChannelRequest Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelRequest -> ChannelRequest -> Bool # (/=) :: ChannelRequest -> ChannelRequest -> Bool #
Show ChannelRequest Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelRequest -> ShowS # show :: ChannelRequest -> String # showList :: [ChannelRequest] -> ShowS #
Encoding ChannelRequest Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelRequest -> b Source # get :: Get ChannelRequest Source #

data ChannelRequestEnv Source #

Constructors

ChannelRequestEnv
Fields crVariableName :: ShortByteString crVariableValue :: ShortByteString

Instances

Eq ChannelRequestEnv Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelRequestEnv -> ChannelRequestEnv -> Bool # (/=) :: ChannelRequestEnv -> ChannelRequestEnv -> Bool #
Show ChannelRequestEnv Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelRequestEnv -> ShowS # show :: ChannelRequestEnv -> String # showList :: [ChannelRequestEnv] -> ShowS #
Encoding ChannelRequestEnv Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelRequestEnv -> b Source # get :: Get ChannelRequestEnv Source #

data ChannelRequestPty Source #

Constructors

ChannelRequestPty
Fields crPtySettings :: PtySettings

Instances

Eq ChannelRequestPty Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelRequestPty -> ChannelRequestPty -> Bool # (/=) :: ChannelRequestPty -> ChannelRequestPty -> Bool #
Show ChannelRequestPty Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelRequestPty -> ShowS # show :: ChannelRequestPty -> String # showList :: [ChannelRequestPty] -> ShowS #
Encoding ChannelRequestPty Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelRequestPty -> b Source # get :: Get ChannelRequestPty Source #

data ChannelRequestWindowChange Source #

Constructors

ChannelRequestWindowChange
Fields crWidth :: Word32 crHeight :: Word32 crWidthPixels :: Word32 crHeightPixels :: Word32

Instances

Eq ChannelRequestWindowChange Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelRequestWindowChange -> ChannelRequestWindowChange -> Bool # (/=) :: ChannelRequestWindowChange -> ChannelRequestWindowChange -> Bool #
Show ChannelRequestWindowChange Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelRequestWindowChange -> ShowS # show :: ChannelRequestWindowChange -> String # showList :: [ChannelRequestWindowChange] -> ShowS #
Encoding ChannelRequestWindowChange Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelRequestWindowChange -> b Source # get :: Get ChannelRequestWindowChange Source #

data ChannelRequestShell Source #

Constructors

ChannelRequestShell

Instances

Eq ChannelRequestShell Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelRequestShell -> ChannelRequestShell -> Bool # (/=) :: ChannelRequestShell -> ChannelRequestShell -> Bool #
Show ChannelRequestShell Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelRequestShell -> ShowS # show :: ChannelRequestShell -> String # showList :: [ChannelRequestShell] -> ShowS #
Encoding ChannelRequestShell Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelRequestShell -> b Source # get :: Get ChannelRequestShell Source #

data ChannelRequestExec Source #

Constructors

ChannelRequestExec
Fields crCommand :: ShortByteString

Instances

Eq ChannelRequestExec Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelRequestExec -> ChannelRequestExec -> Bool # (/=) :: ChannelRequestExec -> ChannelRequestExec -> Bool #
Show ChannelRequestExec Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelRequestExec -> ShowS # show :: ChannelRequestExec -> String # showList :: [ChannelRequestExec] -> ShowS #
Encoding ChannelRequestExec Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelRequestExec -> b Source # get :: Get ChannelRequestExec Source #

data ChannelRequestSignal Source #

Constructors

ChannelRequestSignal
Fields crSignal :: ShortByteString

Instances

Eq ChannelRequestSignal Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelRequestSignal -> ChannelRequestSignal -> Bool # (/=) :: ChannelRequestSignal -> ChannelRequestSignal -> Bool #
Show ChannelRequestSignal Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelRequestSignal -> ShowS # show :: ChannelRequestSignal -> String # showList :: [ChannelRequestSignal] -> ShowS #
Encoding ChannelRequestSignal Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelRequestSignal -> b Source # get :: Get ChannelRequestSignal Source #

data ChannelRequestExitStatus Source #

Constructors

ChannelRequestExitStatus
Fields crExitStatus :: ExitCode

Instances

Eq ChannelRequestExitStatus Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelRequestExitStatus -> ChannelRequestExitStatus -> Bool # (/=) :: ChannelRequestExitStatus -> ChannelRequestExitStatus -> Bool #
Show ChannelRequestExitStatus Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelRequestExitStatus -> ShowS # show :: ChannelRequestExitStatus -> String # showList :: [ChannelRequestExitStatus] -> ShowS #
Encoding ChannelRequestExitStatus Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelRequestExitStatus -> b Source # get :: Get ChannelRequestExitStatus Source #

data ChannelRequestExitSignal Source #

Constructors

ChannelRequestExitSignal
Fields crSignalName :: ShortByteString crCodeDumped :: Bool crErrorMessage :: ShortByteString crLanguageTag :: ShortByteString

Instances

Eq ChannelRequestExitSignal Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelRequestExitSignal -> ChannelRequestExitSignal -> Bool # (/=) :: ChannelRequestExitSignal -> ChannelRequestExitSignal -> Bool #
Show ChannelRequestExitSignal Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelRequestExitSignal -> ShowS # show :: ChannelRequestExitSignal -> String # showList :: [ChannelRequestExitSignal] -> ShowS #
Encoding ChannelRequestExitSignal Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelRequestExitSignal -> b Source # get :: Get ChannelRequestExitSignal Source #

ChannelSuccess (99)

data ChannelSuccess Source #

Constructors

ChannelSuccess ChannelId

Instances

Eq ChannelSuccess Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelSuccess -> ChannelSuccess -> Bool # (/=) :: ChannelSuccess -> ChannelSuccess -> Bool #
Show ChannelSuccess Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelSuccess -> ShowS # show :: ChannelSuccess -> String # showList :: [ChannelSuccess] -> ShowS #
Encoding ChannelSuccess Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelSuccess -> b Source # get :: Get ChannelSuccess Source #

ChannelFailure (100)

data ChannelFailure Source #

Constructors

ChannelFailure ChannelId

Instances

Eq ChannelFailure Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelFailure -> ChannelFailure -> Bool # (/=) :: ChannelFailure -> ChannelFailure -> Bool #
Show ChannelFailure Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelFailure -> ShowS # show :: ChannelFailure -> String # showList :: [ChannelFailure] -> ShowS #
Encoding ChannelFailure Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelFailure -> b Source # get :: Get ChannelFailure Source #

Misc

data AuthMethod Source #

Constructors

AuthNone
AuthHostBased
AuthPassword Password
AuthPublicKey PublicKey (Maybe Signature)
AuthOther Name

Instances

Eq AuthMethod Source #
Instance details Defined in Network.SSH.Message Methods (==) :: AuthMethod -> AuthMethod -> Bool # (/=) :: AuthMethod -> AuthMethod -> Bool #
Show AuthMethod Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> AuthMethod -> ShowS # show :: AuthMethod -> String # showList :: [AuthMethod] -> ShowS #
HasName AuthMethod Source #
Instance details Defined in Network.SSH.Message Methods name :: AuthMethod -> Name Source #
Encoding AuthMethod Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => AuthMethod -> b Source # get :: Get AuthMethod Source #

newtype ChannelId Source #

Constructors

ChannelId Word32

Instances

Eq ChannelId Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelId -> ChannelId -> Bool # (/=) :: ChannelId -> ChannelId -> Bool #
Ord ChannelId Source #
Instance details 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 Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelId -> ShowS # show :: ChannelId -> String # showList :: [ChannelId] -> ShowS #
Encoding ChannelId Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelId -> b Source # get :: Get ChannelId Source #

newtype ChannelType Source #

Constructors

ChannelType ShortByteString

Instances

Eq ChannelType Source #
Instance details Defined in Network.SSH.Message Methods (==) :: ChannelType -> ChannelType -> Bool # (/=) :: ChannelType -> ChannelType -> Bool #
Ord ChannelType Source #
Instance details 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 Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> ChannelType -> ShowS # show :: ChannelType -> String # showList :: [ChannelType] -> ShowS #
Encoding ChannelType Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => ChannelType -> b Source # get :: Get ChannelType Source #

type ChannelPacketSize = Word32 Source #

type ChannelWindowSize = Word32 Source #

data Cookie Source #

newCookie :: MonadRandom m => m Cookie Source #

nilCookie :: Cookie Source #

newtype Password Source #

Constructors

Password ShortByteString

Instances

Eq Password Source #
Instance details Defined in Network.SSH.Message Methods (==) :: Password -> Password -> Bool # (/=) :: Password -> Password -> Bool #
Ord Password Source #
Instance details 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 Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> Password -> ShowS # show :: Password -> String # showList :: [Password] -> ShowS #

data PtySettings Source #

Constructors

PtySettings
Fields ptyEnv :: ShortByteString ptyWidthCols :: Word32 ptyHeightRows :: Word32 ptyWidthPixels :: Word32 ptyHeightPixels :: Word32 ptyModes :: ShortByteString

Instances

Eq PtySettings Source #
Instance details Defined in Network.SSH.Message Methods (==) :: PtySettings -> PtySettings -> Bool # (/=) :: PtySettings -> PtySettings -> Bool #
Show PtySettings Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> PtySettings -> ShowS # show :: PtySettings -> String # showList :: [PtySettings] -> ShowS #
Encoding PtySettings Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => PtySettings -> b Source # get :: Get PtySettings Source #

data PublicKey Source #

Constructors

PublicKeyEd25519 PublicKey
PublicKeyRSA PublicKey
PublicKeyOther Name

Instances

Eq PublicKey Source #
Instance details Defined in Network.SSH.Key Methods (==) :: PublicKey -> PublicKey -> Bool # (/=) :: PublicKey -> PublicKey -> Bool #
Show PublicKey Source #
Instance details Defined in Network.SSH.Key Methods showsPrec :: Int -> PublicKey -> ShowS # show :: PublicKey -> String # showList :: [PublicKey] -> ShowS #
HasName PublicKey Source #
Instance details Defined in Network.SSH.Key Methods name :: PublicKey -> Name Source #
Encoding PublicKey Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => PublicKey -> b Source # get :: Get PublicKey Source #

newtype SessionId Source #

Constructors

SessionId ShortByteString

Instances

Eq SessionId Source #
Instance details Defined in Network.SSH.Message Methods (==) :: SessionId -> SessionId -> Bool # (/=) :: SessionId -> SessionId -> Bool #
Ord SessionId Source #
Instance details 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 Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> SessionId -> ShowS # show :: SessionId -> String # showList :: [SessionId] -> ShowS #
Encoding SessionId Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => SessionId -> b Source # get :: Get SessionId Source #

data Signature Source #

Constructors

SignatureEd25519 Signature
SignatureRSA ByteString
SignatureOther Name

Instances

Eq Signature Source #
Instance details Defined in Network.SSH.Message Methods (==) :: Signature -> Signature -> Bool # (/=) :: Signature -> Signature -> Bool #
Show Signature Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> Signature -> ShowS # show :: Signature -> String # showList :: [Signature] -> ShowS #
HasName Signature Source #
Instance details Defined in Network.SSH.Message Methods name :: Signature -> Name Source #
Encoding Signature Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => Signature -> b Source # get :: Get Signature Source #

newtype Version Source #

Constructors

Version ShortByteString

Instances

Eq Version Source #
Instance details Defined in Network.SSH.Message Methods (==) :: Version -> Version -> Bool # (/=) :: Version -> Version -> Bool #
Ord Version Source #
Instance details 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 Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> Version -> ShowS # show :: Version -> String # showList :: [Version] -> ShowS #
Encoding Version Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => Version -> b Source # get :: Get Version Source #

type ServiceName = Name Source #

type UserName = Name Source #

newtype Name Source #

Constructors

Name ShortByteString

Instances

Eq Name Source #
Instance details Defined in Network.SSH.Name Methods (==) :: Name -> Name -> Bool # (/=) :: Name -> Name -> Bool #
Ord Name Source #
Instance details 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 Source #
Instance details Defined in Network.SSH.Name Methods showsPrec :: Int -> Name -> ShowS # show :: Name -> String # showList :: [Name] -> ShowS #
IsString Name Source #
Instance details Defined in Network.SSH.Name Methods fromString :: String -> Name #

class HasName a where Source #

Methods

name :: a -> Name Source #

Instances

HasName PublicKey Source #
Instance details Defined in Network.SSH.Key Methods name :: PublicKey -> Name Source #
HasName Signature Source #
Instance details Defined in Network.SSH.Message Methods name :: Signature -> Name Source #
HasName AuthMethod Source #
Instance details Defined in Network.SSH.Message Methods name :: AuthMethod -> Name Source #
HasName CompressionAlgorithm Source #
Instance details Defined in Network.SSH.Algorithms Methods name :: CompressionAlgorithm -> Name Source #
HasName EncryptionAlgorithm Source #
Instance details Defined in Network.SSH.Algorithms Methods name :: EncryptionAlgorithm -> Name Source #
HasName KeyExchangeAlgorithm Source #
Instance details Defined in Network.SSH.Algorithms Methods name :: KeyExchangeAlgorithm -> Name Source #
HasName HostKeyAlgorithm Source #
Instance details Defined in Network.SSH.Algorithms Methods name :: HostKeyAlgorithm -> Name Source #

data Connection identity Source #

data ConnectionConfig identity Source #

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) Source #
Instance details Defined in Network.SSH.Server.Service.Connection Methods def :: ConnectionConfig identity #

data SessionRequest Source #

Information associated with the session request.

Might be exteded in the future.

Constructors

SessionRequest

Instances

Eq SessionRequest Source #
Instance details Defined in Network.SSH.Server.Service.Connection Methods (==) :: SessionRequest -> SessionRequest -> Bool # (/=) :: SessionRequest -> SessionRequest -> Bool #
Ord SessionRequest Source #
Instance details 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 Source #
Instance details Defined in Network.SSH.Server.Service.Connection Methods showsPrec :: Int -> SessionRequest -> ShowS # show :: SessionRequest -> String # showList :: [SessionRequest] -> ShowS #

newtype SessionHandler Source #

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

The Environment is list of key-value pairs.

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

Constructors

Environment [(ByteString, ByteString)]

Instances

Eq Environment Source #
Instance details Defined in Network.SSH.Server.Service.Connection Methods (==) :: Environment -> Environment -> Bool # (/=) :: Environment -> Environment -> Bool #
Ord Environment Source #
Instance details 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 Source #
Instance details Defined in Network.SSH.Server.Service.Connection Methods showsPrec :: Int -> Environment -> ShowS # show :: Environment -> String # showList :: [Environment] -> ShowS #

data TermInfo Source #

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

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 Source #
Instance details Defined in Network.SSH.Server.Service.Connection Methods (==) :: Command -> Command -> Bool # (/=) :: Command -> Command -> Bool #
Ord Command Source #
Instance details 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 Source #
Instance details Defined in Network.SSH.Server.Service.Connection Methods showsPrec :: Int -> Command -> ShowS # show :: Command -> String # showList :: [Command] -> ShowS #
IsString Command Source #
Instance details Defined in Network.SSH.Server.Service.Connection Methods fromString :: String -> Command #

data DirectTcpIpRequest Source #

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 Source #
Instance details Defined in Network.SSH.Server.Service.Connection Methods (==) :: DirectTcpIpRequest -> DirectTcpIpRequest -> Bool # (/=) :: DirectTcpIpRequest -> DirectTcpIpRequest -> Bool #
Ord DirectTcpIpRequest Source #
Instance details 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 Source #
Instance details Defined in Network.SSH.Server.Service.Connection Methods showsPrec :: Int -> DirectTcpIpRequest -> ShowS # show :: DirectTcpIpRequest -> String # showList :: [DirectTcpIpRequest] -> ShowS #

newtype DirectTcpIpHandler Source #

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

Constructors

ConnectionChannelOpen ChannelOpen
ConnectionChannelClose ChannelClose
ConnectionChannelEof ChannelEof
ConnectionChannelData ChannelData
ConnectionChannelRequest ChannelRequest
ConnectionChannelWindowAdjust ChannelWindowAdjust

Instances

Eq ConnectionMsg Source #
Instance details Defined in Network.SSH.Server.Service.Connection Methods (==) :: ConnectionMsg -> ConnectionMsg -> Bool # (/=) :: ConnectionMsg -> ConnectionMsg -> Bool #
Show ConnectionMsg Source #
Instance details Defined in Network.SSH.Server.Service.Connection Methods showsPrec :: Int -> ConnectionMsg -> ShowS # show :: ConnectionMsg -> String # showList :: [ConnectionMsg] -> ShowS #
Encoding ConnectionMsg Source #
Instance details Defined in Network.SSH.Server.Service.Connection Methods put :: Builder b => ConnectionMsg -> b Source # get :: Get ConnectionMsg Source #

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

data UserAuthConfig identity Source #

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) Source #
Instance details 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 Source #

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

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

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

Instances

DuplexStream TStreamingQueue Source #
Instance details Defined in Network.SSH.TStreamingQueue

class OutputStream stream where Source #

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

Minimal complete definition

send

Methods

send :: stream -> ByteString -> IO Int Source #

Send a chunk of bytes into the stream.

This method shall block until at least one byte could be sent or the connection got closed.
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 Source #

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

Instances

OutputStream TStreamingQueue Source #
Instance details Defined in Network.SSH.TStreamingQueue Methods send :: TStreamingQueue -> ByteString -> IO Int Source # sendUnsafe :: TStreamingQueue -> MemView -> IO Int Source #

class InputStream stream where Source #

An InputStream is something that bytes can be read from.

Minimal complete definition

peek, receive

Methods

peek :: stream -> Int -> IO ByteString Source #

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

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

receive :: stream -> Int -> IO ByteString Source #

Receive a chunk of bytes from the stream.

This method shall block until at least one byte becomes available or the connection got closed.
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!
The second parameter determines how many bytes to receive at most, but the ByteString returned might be shorter.
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 Source #

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

Instances

InputStream TStreamingQueue Source #
Instance details Defined in Network.SSH.TStreamingQueue Methods peek :: TStreamingQueue -> Int -> IO ByteString Source # receive :: TStreamingQueue -> Int -> IO ByteString Source # receiveUnsafe :: TStreamingQueue -> MemView -> IO Int Source #

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

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

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

Instances

MessageStream Transport Source #
Instance details Defined in Network.SSH.Transport Methods sendMessage :: Encoding msg => Transport -> msg -> IO () Source # receiveMessage :: Encoding msg => Transport -> IO msg Source #

data TransportConfig Source #

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 Source #
Instance details Defined in Network.SSH.Transport Methods def :: TransportConfig #

data Disconnected Source #

Constructors

Disconnected
Fields disconnectedReason :: DisconnectReason disconnectedDescription :: ShortByteString disconnectedLanguageTag :: ShortByteString

Instances

Eq Disconnected Source #
Instance details Defined in Network.SSH.Message Methods (==) :: Disconnected -> Disconnected -> Bool # (/=) :: Disconnected -> Disconnected -> Bool #
Show Disconnected Source #
Instance details Defined in Network.SSH.Message Methods showsPrec :: Int -> Disconnected -> ShowS # show :: Disconnected -> String # showList :: [Disconnected] -> ShowS #
Encoding Disconnected Source #
Instance details Defined in Network.SSH.Message Methods put :: Builder b => Disconnected -> b Source # get :: Get Disconnected Source #

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

plainEncryptionContext :: OutputStream stream => stream -> EncryptionContext Source #

plainDecryptionContext :: InputStream stream => stream -> DecryptionContext Source #

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

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

data TStreamingQueue Source #

Constructors

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

Instances

InputStream TStreamingQueue Source #
Instance details Defined in Network.SSH.TStreamingQueue Methods peek :: TStreamingQueue -> Int -> IO ByteString Source # receive :: TStreamingQueue -> Int -> IO ByteString Source # receiveUnsafe :: TStreamingQueue -> MemView -> IO Int Source #
OutputStream TStreamingQueue Source #
Instance details Defined in Network.SSH.TStreamingQueue Methods send :: TStreamingQueue -> ByteString -> IO Int Source # sendUnsafe :: TStreamingQueue -> MemView -> IO Int Source #
DuplexStream TStreamingQueue Source #
Instance details Defined in Network.SSH.TStreamingQueue

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

capacity :: TStreamingQueue -> Word32 Source #

getSize :: TStreamingQueue -> STM Word32 Source #

getFree :: TStreamingQueue -> STM Word32 Source #

getWindowSpace :: TStreamingQueue -> STM Word32 Source #

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

askWindowSpaceAdjustRecommended :: TStreamingQueue -> STM Bool Source #

fillWindowSpace :: TStreamingQueue -> STM Word32 Source #

terminate :: TStreamingQueue -> STM () Source #

enqueue :: TStreamingQueue -> ByteString -> STM Word32 Source #

dequeue :: TStreamingQueue -> Word32 -> STM ByteString Source #

dequeueShort :: TStreamingQueue -> Word32 -> STM ShortByteString Source #

lookAhead :: TStreamingQueue -> Word32 -> STM ByteString Source #