Network.SSH

Authentication & Identity

AuthAgent

class AuthAgent agent where

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]

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)

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

Defined in Network.SSH.AuthAgent

Methods

getPublicKeys :: KeyPair -> IO [PublicKey]

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

data KeyPair

Constructors

KeyPairEd25519 PublicKey SecretKey

Instances

Eq KeyPair

Defined in Network.SSH.Key

Methods

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

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

Show KeyPair

Defined in Network.SSH.Key

Methods

showsPrec :: Int -> KeyPair -> ShowS

show :: KeyPair -> String

showList :: [KeyPair] -> ShowS

AuthAgent KeyPair

Defined in Network.SSH.AuthAgent

Methods

getPublicKeys :: KeyPair -> IO [PublicKey]

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

newKeyPair

newKeyPair :: IO KeyPair

decodePrivateKeyFile

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

Input / Output

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

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

Instances

DuplexStream TStreamingQueue

Defined in Network.SSH.TStreamingQueue

receive, receiveAll

class InputStream stream where

An InputStream is something that bytes can be read from.

Minimal complete definition

peek, receive

Methods

peek :: stream -> Int -> IO ByteString

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

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

receive :: stream -> Int -> IO ByteString

Receive a chunk of bytes from the stream.

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

receiveUnsafe :: stream -> MemView -> IO Int

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

Instances

InputStream TStreamingQueue

Defined in Network.SSH.TStreamingQueue

Methods

peek :: TStreamingQueue -> Int -> IO ByteString

receive :: TStreamingQueue -> Int -> IO ByteString

receiveUnsafe :: TStreamingQueue -> MemView -> IO Int

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

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

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

send, sendAll

class OutputStream stream where

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

Minimal complete definition

send

Methods

send :: stream -> ByteString -> IO Int

Send a chunk of bytes into the stream.

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

sendUnsafe :: stream -> MemView -> IO Int

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

Instances

OutputStream TStreamingQueue

Defined in Network.SSH.TStreamingQueue

Methods

send :: TStreamingQueue -> ByteString -> IO Int

sendUnsafe :: TStreamingQueue -> MemView -> IO Int

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

Try to send the complete ByteString.

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

Transport

data TransportConfig

Constructors

TransportConfig

Fields

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

Instances

Default TransportConfig

Defined in Network.SSH.Transport

Methods

def :: TransportConfig

Misc

Disconnect

data Disconnect

Constructors

Disconnect DisconnectParty DisconnectReason DisconnectMessage

Instances

Eq Disconnect

Defined in Network.SSH.Exception

Methods

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

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

Ord Disconnect

Defined in Network.SSH.Exception

Methods

compare :: Disconnect -> Disconnect -> Ordering

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

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

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

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

max :: Disconnect -> Disconnect -> Disconnect

min :: Disconnect -> Disconnect -> Disconnect

Show Disconnect

Defined in Network.SSH.Exception

Methods

showsPrec :: Int -> Disconnect -> ShowS

show :: Disconnect -> String

showList :: [Disconnect] -> ShowS

Exception Disconnect

Defined in Network.SSH.Exception

Methods

toException :: Disconnect -> SomeException

fromException :: SomeException -> Maybe Disconnect

displayException :: Disconnect -> String

data DisconnectParty

Constructors

Local

Remote

Instances

Eq DisconnectParty

Defined in Network.SSH.Exception

Methods

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

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

Ord DisconnectParty

Defined in Network.SSH.Exception

Methods

compare :: DisconnectParty -> DisconnectParty -> Ordering

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

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

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

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

max :: DisconnectParty -> DisconnectParty -> DisconnectParty

min :: DisconnectParty -> DisconnectParty -> DisconnectParty

Show DisconnectParty

Defined in Network.SSH.Exception

Methods

showsPrec :: Int -> DisconnectParty -> ShowS

show :: DisconnectParty -> String

showList :: [DisconnectParty] -> ShowS

data DisconnectReason

Constructors

DisconnectHostNotAllowedToConnect

DisconnectProtocolError

DisconnectKeyExchangeFailed

DisconnectReserved

DisconnectMacError

DisconnectCompressionError

DisconnectServiceNotAvailable

DisconnectProtocolVersionNotSupported

DisconnectHostKeyNotVerifiable

DisconnectConnectionLost

DisconnectByApplication

DisconnectTooManyConnection

DisconnectAuthCancelledByUser

DisconnectNoMoreAuthMethodsAvailable

DisconnectIllegalUsername

DisconnectOtherReason Word32

Instances

Eq DisconnectReason

Defined in Network.SSH.Exception

Methods

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

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

Ord DisconnectReason

Defined in Network.SSH.Exception

Methods

compare :: DisconnectReason -> DisconnectReason -> Ordering

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

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

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

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

max :: DisconnectReason -> DisconnectReason -> DisconnectReason

min :: DisconnectReason -> DisconnectReason -> DisconnectReason

Show DisconnectReason

Defined in Network.SSH.Exception

Methods

showsPrec :: Int -> DisconnectReason -> ShowS

show :: DisconnectReason -> String

showList :: [DisconnectReason] -> ShowS

Encoding DisconnectReason

Defined in Network.SSH.Message

Methods

put :: Builder b => DisconnectReason -> b

get :: Get DisconnectReason

newtype DisconnectMessage

Constructors

DisconnectMessage ByteString

Instances

Eq DisconnectMessage

Defined in Network.SSH.Exception

Methods

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

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

Ord DisconnectMessage

Defined in Network.SSH.Exception

Methods

compare :: DisconnectMessage -> DisconnectMessage -> Ordering

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

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

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

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

max :: DisconnectMessage -> DisconnectMessage -> DisconnectMessage

min :: DisconnectMessage -> DisconnectMessage -> DisconnectMessage

Show DisconnectMessage

Defined in Network.SSH.Exception

Methods

showsPrec :: Int -> DisconnectMessage -> ShowS

show :: DisconnectMessage -> String

showList :: [DisconnectMessage] -> ShowS

IsString DisconnectMessage

Defined in Network.SSH.Exception

Methods

fromString :: String -> DisconnectMessage

Semigroup DisconnectMessage

Defined in Network.SSH.Exception

Methods

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

sconcat :: NonEmpty DisconnectMessage -> DisconnectMessage

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

Monoid DisconnectMessage

Defined in Network.SSH.Exception

Methods

mempty :: DisconnectMessage

mappend :: DisconnectMessage -> DisconnectMessage -> DisconnectMessage

mconcat :: [DisconnectMessage] -> DisconnectMessage

Name

data Name

Instances

Eq Name

Defined in Network.SSH.Name

Methods

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

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

Ord Name

Defined in Network.SSH.Name

Methods

compare :: Name -> Name -> Ordering

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

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

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

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

max :: Name -> Name -> Name

min :: Name -> Name -> Name

Show Name

Defined in Network.SSH.Name

Methods

showsPrec :: Int -> Name -> ShowS

show :: Name -> String

showList :: [Name] -> ShowS

IsString Name

Defined in Network.SSH.Name

Methods

fromString :: String -> Name

type UserName = Name

type ServiceName = Name

class HasName a where

Methods

name :: a -> Name

Instances

HasName PublicKey

Defined in Network.SSH.Key

Methods

name :: PublicKey -> Name

HasName Signature

Defined in Network.SSH.Message

Methods

name :: Signature -> Name

HasName AuthMethod

Defined in Network.SSH.Message

Methods

name :: AuthMethod -> Name

HasName CompressionAlgorithm

Defined in Network.SSH.Algorithms

Methods

name :: CompressionAlgorithm -> Name

HasName EncryptionAlgorithm

Defined in Network.SSH.Algorithms

Methods

name :: EncryptionAlgorithm -> Name

HasName KeyExchangeAlgorithm

Defined in Network.SSH.Algorithms

Methods

name :: KeyExchangeAlgorithm -> Name

HasName HostKeyAlgorithm

Defined in Network.SSH.Algorithms

Methods

name :: HostKeyAlgorithm -> Name

Algorithms

data HostKeyAlgorithm

Constructors

SshEd25519

Instances

Eq HostKeyAlgorithm

Defined in Network.SSH.Algorithms

Methods

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

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

Show HostKeyAlgorithm

Defined in Network.SSH.Algorithms

Methods

showsPrec :: Int -> HostKeyAlgorithm -> ShowS

show :: HostKeyAlgorithm -> String

showList :: [HostKeyAlgorithm] -> ShowS

HasName HostKeyAlgorithm

Defined in Network.SSH.Algorithms

Methods

name :: HostKeyAlgorithm -> Name

data KeyExchangeAlgorithm

Constructors

Curve25519Sha256AtLibsshDotOrg

Instances

Eq KeyExchangeAlgorithm

Defined in Network.SSH.Algorithms

Methods

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

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

Show KeyExchangeAlgorithm

Defined in Network.SSH.Algorithms

Methods

showsPrec :: Int -> KeyExchangeAlgorithm -> ShowS

show :: KeyExchangeAlgorithm -> String

showList :: [KeyExchangeAlgorithm] -> ShowS

HasName KeyExchangeAlgorithm

Defined in Network.SSH.Algorithms

Methods

name :: KeyExchangeAlgorithm -> Name

data EncryptionAlgorithm

Constructors

Chacha20Poly1305AtOpensshDotCom

Instances

Eq EncryptionAlgorithm

Defined in Network.SSH.Algorithms

Methods

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

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

Show EncryptionAlgorithm

Defined in Network.SSH.Algorithms

Methods

showsPrec :: Int -> EncryptionAlgorithm -> ShowS

show :: EncryptionAlgorithm -> String

showList :: [EncryptionAlgorithm] -> ShowS

HasName EncryptionAlgorithm

Defined in Network.SSH.Algorithms

Methods

name :: EncryptionAlgorithm -> Name

data CompressionAlgorithm

Constructors

None

Instances

Eq CompressionAlgorithm

Defined in Network.SSH.Algorithms

Methods

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

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

Show CompressionAlgorithm

Defined in Network.SSH.Algorithms

Methods

showsPrec :: Int -> CompressionAlgorithm -> ShowS

show :: CompressionAlgorithm -> String

showList :: [CompressionAlgorithm] -> ShowS

HasName CompressionAlgorithm

Defined in Network.SSH.Algorithms

Methods

name :: CompressionAlgorithm -> Name

PublicKey

data PublicKey

Constructors

PublicKeyEd25519 PublicKey

PublicKeyRSA PublicKey

PublicKeyOther Name

Instances

Eq PublicKey

Defined in Network.SSH.Key

Methods

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

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

Show PublicKey

Defined in Network.SSH.Key

Methods

showsPrec :: Int -> PublicKey -> ShowS

show :: PublicKey -> String

showList :: [PublicKey] -> ShowS

HasName PublicKey

Defined in Network.SSH.Key

Methods

name :: PublicKey -> Name

Encoding PublicKey

Defined in Network.SSH.Message

Methods

put :: Builder b => PublicKey -> b

get :: Get PublicKey

Signature

data Signature

Constructors

SignatureEd25519 Signature

SignatureRSA ByteString

SignatureOther Name

Instances

Eq Signature

Defined in Network.SSH.Message

Methods

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

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

Show Signature

Defined in Network.SSH.Message

Methods

showsPrec :: Int -> Signature -> ShowS

show :: Signature -> String

showList :: [Signature] -> ShowS

HasName Signature

Defined in Network.SSH.Message

Methods

name :: Signature -> Name

Encoding Signature

Defined in Network.SSH.Message

Methods

put :: Builder b => Signature -> b

get :: Get Signature