Client.Configuration.ServerSettings

This module defines the settings used for an individual IRC connection. These are static settings that are not expected change over the lifetime of a connection.

Server settings type

data ServerSettings

Static server-level settings

Constructors

ServerSettings

Fields

• _ssNicks :: !(NonEmpty Text)

  connection nicknames

• _ssUser :: !Text

  connection username

• _ssReal :: !Text

  connection realname / GECOS

• _ssPassword :: !(Maybe Secret)

  server password

• _ssSaslMechanism :: !(Maybe SaslMechanism)

  SASL mechanism

• _ssHostName :: !HostName

  server hostname

• _ssPort :: !(Maybe PortNumber)

  server port

• _ssTls :: !TlsMode

  use TLS to connect

• _ssTlsVerify :: !TlsVerify

  verify TLS hostname

• _ssTlsClientCert :: !(Maybe FilePath)

  path to client TLS certificate

• _ssTlsClientKey :: !(Maybe FilePath)

  path to client TLS key

• _ssTlsClientKeyPassword :: !(Maybe Secret)

  client key PEM password

• _ssTlsServerCert :: !(Maybe FilePath)

  additional CA certificates for validating server

• _ssTlsCiphers :: String

  OpenSSL cipher suite

• _ssTls13Ciphers :: Maybe String

  OpenSSL TLS 1.3 cipher suite

• _ssTlsPubkeyFingerprint :: !(Maybe Fingerprint)

  optional acceptable public key fingerprint

• _ssTlsCertFingerprint :: !(Maybe Fingerprint)

  optional acceptable certificate fingerprint

• _ssSts :: !Bool

  Honor STS policies when true

• _ssConnectCmds :: ![[ExpansionChunk]]

  commands to execute upon successful connection

• _ssSocksHost :: !(Maybe HostName)

  hostname of SOCKS proxy

• _ssSocksPort :: !PortNumber

  port of SOCKS proxy

• _ssChanservChannels :: ![Identifier]

  Channels with chanserv permissions

• _ssFloodPenalty :: !Rational

  Flood limiter penalty (seconds)

• _ssFloodThreshold :: !Rational

  Flood limited threshold (seconds)

• _ssMessageHooks :: ![HookConfig]

  Initial message hooks

• _ssName :: !(Maybe Text)

  The name referencing the server in commands

• _ssReconnectAttempts :: !Int

  The number of reconnect attempts to make on error

• _ssReconnectError :: !(Maybe KnownRegex)

  Regular expression for ERROR messages that trigger reconnect

• _ssAutoconnect :: !Bool

  Connect to this network on server startup

• _ssNickCompletion :: WordCompletionMode

  Nick completion mode for this server

• _ssLogDir :: Maybe FilePath

  Directory to save logs of chat

• _ssBindHostName :: Maybe HostName

  Local bind host

• _ssShowAccounts :: !Bool

  Render account names

• _ssCapabilities :: ![Text]

  Extra capabilities to unconditionally request

Instances

Show ServerSettings

Defined in Client.Configuration.ServerSettings

Methods

showsPrec :: Int -> ServerSettings -> ShowS

show :: ServerSettings -> String

showList :: [ServerSettings] -> ShowS

data HookConfig

Hook name and configuration arguments

Constructors

HookConfig Text [Text]

Instances

Show HookConfig

Defined in Client.Configuration.ServerSettings

Methods

showsPrec :: Int -> HookConfig -> ShowS

show :: HookConfig -> String

showList :: [HookConfig] -> ShowS

serverSpec :: ValueSpec (Maybe Text, ServerSettings -> ServerSettings)

identifierSpec :: ValueSpec Identifier

Lenses

ssNicks :: Lens' ServerSettings (NonEmpty Text)

ssUser :: Lens' ServerSettings Text

ssReal :: Lens' ServerSettings Text

ssPassword :: Lens' ServerSettings (Maybe Secret)

ssSaslMechanism :: Lens' ServerSettings (Maybe SaslMechanism)

ssHostName :: Lens' ServerSettings HostName

ssPort :: Lens' ServerSettings (Maybe PortNumber)

ssTls :: Lens' ServerSettings TlsMode

ssTlsVerify :: Lens' ServerSettings TlsVerify

ssTlsClientCert :: Lens' ServerSettings (Maybe FilePath)

ssTlsClientKey :: Lens' ServerSettings (Maybe FilePath)

ssTlsClientKeyPassword :: Lens' ServerSettings (Maybe Secret)

ssTlsServerCert :: Lens' ServerSettings (Maybe FilePath)

ssTlsCiphers :: Lens' ServerSettings String

ssTls13Ciphers :: Lens' ServerSettings (Maybe String)

ssConnectCmds :: Lens' ServerSettings [[ExpansionChunk]]

ssSocksHost :: Lens' ServerSettings (Maybe HostName)

ssSocksPort :: Lens' ServerSettings PortNumber

ssChanservChannels :: Lens' ServerSettings [Identifier]

ssFloodPenalty :: Lens' ServerSettings Rational

ssFloodThreshold :: Lens' ServerSettings Rational

ssMessageHooks :: Lens' ServerSettings [HookConfig]

ssName :: Lens' ServerSettings (Maybe Text)

ssReconnectAttempts :: Lens' ServerSettings Int

ssReconnectError :: Lens' ServerSettings (Maybe KnownRegex)

ssAutoconnect :: Lens' ServerSettings Bool

ssNickCompletion :: Lens' ServerSettings WordCompletionMode

ssLogDir :: Lens' ServerSettings (Maybe FilePath)

ssBindHostName :: Lens' ServerSettings (Maybe HostName)

ssSts :: Lens' ServerSettings Bool

ssTlsPubkeyFingerprint :: Lens' ServerSettings (Maybe Fingerprint)

ssTlsCertFingerprint :: Lens' ServerSettings (Maybe Fingerprint)

ssShowAccounts :: Lens' ServerSettings Bool

ssCapabilities :: Lens' ServerSettings [Text]

SASL Mechanisms

data SaslMechanism

SASL mechanisms and configuration data.

Constructors

SaslPlain (Maybe Text) Text Secret

SASL PLAIN RFC4616 - authzid authcid password

SaslEcdsa (Maybe Text) Text FilePath

SASL NIST - https://github.com/kaniini/ecdsatool - authzid keypath

SaslExternal (Maybe Text)

SASL EXTERNAL RFC4422 - authzid

SaslScram ScramDigest (Maybe Text) Text Secret

SASL SCRAM-SHA-256 RFC7677 - authzid authcid password

SaslEcdh (Maybe Text) Text Secret

SASL ECDH-X25519-CHALLENGE - authzid authcid private-key

Instances

Show SaslMechanism

Defined in Client.Configuration.ServerSettings

Methods

showsPrec :: Int -> SaslMechanism -> ShowS

show :: SaslMechanism -> String

showList :: [SaslMechanism] -> ShowS

_SaslExternal :: Prism' SaslMechanism (Maybe Text)

_SaslEcdsa :: Prism' SaslMechanism (Maybe Text, Text, FilePath)

_SaslPlain :: Prism' SaslMechanism (Maybe Text, Text, Secret)

_SaslScram :: Prism' SaslMechanism (ScramDigest, Maybe Text, Text, Secret)

Secrets

data Secret

Constructors

SecretText Text

Constant text

SecretCommand (NonEmpty Text)

Command to generate text

Instances

Show Secret

Defined in Client.Configuration.ServerSettings

Methods

showsPrec :: Int -> Secret -> ShowS

show :: Secret -> String

showList :: [Secret] -> ShowS

HasSpec Secret

Defined in Client.Configuration.ServerSettings

Methods

anySpec :: ValueSpec Secret

data SecretException

Constructors

SecretException String String

Instances

Show SecretException

Defined in Client.Configuration.ServerSettings

Methods

showsPrec :: Int -> SecretException -> ShowS

show :: SecretException -> String

showList :: [SecretException] -> ShowS

Exception SecretException

Defined in Client.Configuration.ServerSettings

Methods

toException :: SecretException -> SomeException

fromException :: SomeException -> Maybe SecretException

displayException :: SecretException -> String

loadSecrets :: ServerSettings -> IO ServerSettings

Run the secret commands in a server configuration replacing them with secret text. Throws SecretException

Defaults

defaultServerSettings :: ServerSettings

The defaults for server settings.

TLS settings

data UseTls

Security setting for network connection

Constructors

UseTls

TLS connection

UseInsecureTls

TLS connection without certificate checking

UseInsecure

Plain connection

Instances

Show UseTls

Defined in Client.Configuration.ServerSettings

Methods

showsPrec :: Int -> UseTls -> ShowS

show :: UseTls -> String

showList :: [UseTls] -> ShowS

data Fingerprint

Fingerprint used to validate server certificates.

Constructors

FingerprintSha1 ByteString

SHA-1 fingerprint

FingerprintSha256 ByteString

SHA-2 256-bit fingerprint

FingerprintSha512 ByteString

SHA-2 512-bit fingerprint

Instances

Show Fingerprint

Defined in Client.Configuration.ServerSettings

Methods

showsPrec :: Int -> Fingerprint -> ShowS

show :: Fingerprint -> String

showList :: [Fingerprint] -> ShowS

data TlsMode

Constructors

TlsYes

TlsNo

TlsStart

Instances

Show TlsMode

Defined in Client.Configuration.ServerSettings

Methods

showsPrec :: Int -> TlsMode -> ShowS

show :: TlsMode -> String

showList :: [TlsMode] -> ShowS

Regex wrapper

data KnownRegex

Regular expression matched with original source to help with debugging.

Constructors

KnownRegex Text Regex

Instances

Show KnownRegex

Defined in Client.Configuration.ServerSettings

Methods

showsPrec :: Int -> KnownRegex -> ShowS

show :: KnownRegex -> String

showList :: [KnownRegex] -> ShowS

getRegex :: KnownRegex -> Regex