Safe Haskell	None
Language	Haskell2010

Network.SSH

Contents

Authentication & Identity
Input / Output
- receive, receiveAll
- send, sendAll
Transport
Misc

Synopsis

class AuthAgent agent where
- getPublicKeys :: agent -> IO [PublicKey]
- getSignature :: ByteArrayAccess hash => agent -> PublicKey -> hash -> IO (Maybe Signature)
data KeyPair = KeyPairEd25519 PublicKey SecretKey
newKeyPair :: IO KeyPair
decodePrivateKeyFile :: (MonadFail m, ByteArray input, ByteArrayAccess passphrase, ByteArray comment) => passphrase -> input -> m [(KeyPair, comment)]
class (InputStream stream, OutputStream stream) => DuplexStream stream
class InputStream stream where
- peek :: stream -> Int -> IO ByteString
- receive :: stream -> Int -> IO ByteString
- receiveUnsafe :: stream -> MemView -> IO Int
receiveAll :: InputStream stream => stream -> Int -> IO ByteString
class OutputStream stream where
- send :: stream -> ByteString -> IO Int
- sendUnsafe :: stream -> MemView -> IO Int
sendAll :: OutputStream stream => stream -> ByteString -> IO ()
data TransportConfig = TransportConfig {
- serverHostKeyAlgorithms :: NonEmpty HostKeyAlgorithm
- kexAlgorithms :: NonEmpty KeyExchangeAlgorithm
- encryptionAlgorithms :: NonEmpty EncryptionAlgorithm
- maxTimeBeforeRekey :: Word64
- maxDataBeforeRekey :: Word64
- onSend :: ByteString -> IO ()
- onReceive :: ByteString -> IO ()
}
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
data Name
type UserName = Name
type ServiceName = Name
class HasName a where
- name :: a -> Name
data HostKeyAlgorithm = SshEd25519
data KeyExchangeAlgorithm = Curve25519Sha256AtLibsshDotOrg
data EncryptionAlgorithm = Chacha20Poly1305AtOpensshDotCom
data CompressionAlgorithm = None
data PublicKey
- = PublicKeyEd25519 PublicKey
- | PublicKeyRSA PublicKey
- | PublicKeyOther Name
data Signature
- = SignatureEd25519 Signature
- | SignatureRSA ByteString
- | SignatureOther Name

Authentication & Identity

AuthAgent

class AuthAgent agent where Source #

An AuthAgent is something that is capable of cryptographic signing using a public key algorithm like Ed25519 or RSA.

Currently, KeyPair is the only instance, but the method signatures have been designed with other mechanisms like HSM's or agent-forwarding in mind.

Methods

getPublicKeys :: agent -> IO [PublicKey] Source #

Get a list of public keys for which the agent holds the corresponding private keys.

The list contents may change when called subsequently.

getSignature :: ByteArrayAccess hash => agent -> PublicKey -> hash -> IO (Maybe Signature) Source #

Sign the given hash with the requested public key.

The signature may be denied in case the key is no longer available. This method shall not throw exceptions, but rather return Nothing if possible.

Instances

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 #

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

newKeyPair :: IO KeyPair Source #

decodePrivateKeyFile

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

Input / Output

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

receive, receiveAll

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 #

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.

send, sendAll

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 #

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.

Transport

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 #

Misc

Disconnect

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 #

Name

data Name Source #

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 #

type UserName = Name Source #

type ServiceName = Name Source #

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 #

Algorithms

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 #

PublicKey

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 #

Signature

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 #