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 Text)

  server password

• _ssSaslUsername :: !(Maybe Text)

  SASL username

• _ssSaslPassword :: !(Maybe Text)

  SASL plain password

• _ssSaslEcdsaFile :: !(Maybe FilePath)

  SASL ecdsa private key

• _ssHostName :: !HostName

  server hostname

• _ssPort :: !(Maybe PortNumber)

  server port

• _ssTls :: !UseTls

  use TLS to connect

• _ssTlsClientCert :: !(Maybe FilePath)

  path to client TLS certificate

• _ssTlsClientKey :: !(Maybe FilePath)

  path to client TLS key

• _ssTlsServerCert :: !(Maybe FilePath)

  additional CA certificates for validating server

• _ssTlsCiphers :: String

  OpenSSL cipher suite

• _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

• _ssProtocolFamily :: Maybe Family

  Protocol family to connect with

• _ssSts :: !Bool

  Honor STS policies when true

• _ssTlsPubkeyFingerprint :: !(Maybe Fingerprint)

  optional acceptable public key fingerprint

• _ssTlsCertFingerprint :: !(Maybe Fingerprint)

  optional acceptable certificate fingerprint

• _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 (ServerSettings -> ServerSettings)

identifierSpec :: ValueSpec Identifier

Lenses

ssNicks :: Lens' ServerSettings (NonEmpty Text)

ssUser :: Lens' ServerSettings Text

ssReal :: Lens' ServerSettings Text

ssPassword :: Lens' ServerSettings (Maybe Text)

ssSaslUsername :: Lens' ServerSettings (Maybe Text)

ssSaslPassword :: Lens' ServerSettings (Maybe Text)

ssSaslEcdsaFile :: Lens' ServerSettings (Maybe FilePath)

ssHostName :: Lens' ServerSettings HostName

ssPort :: Lens' ServerSettings (Maybe PortNumber)

ssTls :: Lens' ServerSettings UseTls

ssTlsClientCert :: Lens' ServerSettings (Maybe FilePath)

ssTlsClientKey :: Lens' ServerSettings (Maybe FilePath)

ssTlsServerCert :: Lens' ServerSettings (Maybe FilePath)

ssTlsCiphers :: Lens' ServerSettings 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)

ssProtocolFamily :: Lens' ServerSettings (Maybe Family)

ssSts :: Lens' ServerSettings Bool

ssTlsPubkeyFingerprint :: Lens' ServerSettings (Maybe Fingerprint)

ssTlsCertFingerprint :: Lens' ServerSettings (Maybe Fingerprint)

ssShowAccounts :: Lens' ServerSettings Bool

ssCapabilities :: Lens' ServerSettings [Text]

Load function

loadDefaultServerSettings :: IO ServerSettings

Load the defaults for server settings based on the environment variables.

Environment variables USER, IRCPASSSWORD, and SASLPASSWORD are used.

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

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