Copyright	(c) Eric Mertens 2016
License	ISC
Maintainer	emertens@gmail.com
Safe Haskell	None
Language	Haskell2010

Client.Configuration.ServerSettings

Contents

Server settings type
Lenses
SASL Mechanisms
Secrets
Defaults
TLS settings
Regex wrapper

Description

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.

Synopsis

data ServerSettings = ServerSettings {
- _ssNicks :: !(NonEmpty Text)
- _ssUser :: !Text
- _ssReal :: !Text
- _ssPassword :: !(Maybe Secret)
- _ssSaslMechanism :: !(Maybe SaslMechanism)
- _ssHostName :: !HostName
- _ssPort :: !(Maybe PortNumber)
- _ssTls :: !UseTls
- _ssTlsClientCert :: !(Maybe FilePath)
- _ssTlsClientKey :: !(Maybe FilePath)
- _ssTlsClientKeyPassword :: !(Maybe Secret)
- _ssTlsServerCert :: !(Maybe FilePath)
- _ssTlsCiphers :: String
- _ssConnectCmds :: ![[ExpansionChunk]]
- _ssSocksHost :: !(Maybe HostName)
- _ssSocksPort :: !PortNumber
- _ssChanservChannels :: ![Identifier]
- _ssFloodPenalty :: !Rational
- _ssFloodThreshold :: !Rational
- _ssMessageHooks :: ![HookConfig]
- _ssName :: !(Maybe Text)
- _ssReconnectAttempts :: !Int
- _ssReconnectError :: !(Maybe KnownRegex)
- _ssAutoconnect :: !Bool
- _ssNickCompletion :: WordCompletionMode
- _ssLogDir :: Maybe FilePath
- _ssBindHostName :: Maybe HostName
- _ssSts :: !Bool
- _ssTlsPubkeyFingerprint :: !(Maybe Fingerprint)
- _ssTlsCertFingerprint :: !(Maybe Fingerprint)
- _ssShowAccounts :: !Bool
- _ssCapabilities :: ![Text]
}
data HookConfig = HookConfig Text [Text]
serverSpec :: ValueSpec (ServerSettings -> ServerSettings)
identifierSpec :: ValueSpec Identifier
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 UseTls
ssTlsClientCert :: Lens' ServerSettings (Maybe FilePath)
ssTlsClientKey :: Lens' ServerSettings (Maybe FilePath)
ssTlsClientKeyPassword :: Lens' ServerSettings (Maybe Secret)
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)
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]
data SaslMechanism
- = SaslPlain (Maybe Text) Text Secret
- | SaslEcdsa (Maybe Text) Text FilePath
- | SaslExternal (Maybe Text)
_SaslExternal :: Prism' SaslMechanism (Maybe Text)
_SaslEcdsa :: Prism' SaslMechanism (Maybe Text, Text, FilePath)
_SaslPlain :: Prism' SaslMechanism (Maybe Text, Text, Secret)
data Secret
- = SecretText Text
- | SecretCommand (NonEmpty Text)
data SecretException = SecretException String String
loadSecrets :: ServerSettings -> IO ServerSettings
defaultServerSettings :: ServerSettings
data UseTls
- = UseTls
- | UseInsecureTls
- | UseInsecure
data Fingerprint
- = FingerprintSha1 ByteString
- | FingerprintSha256 ByteString
- | FingerprintSha512 ByteString
data KnownRegex = KnownRegex Text Regex
getRegex :: KnownRegex -> Regex

Server settings type

data ServerSettings Source #

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 :: !UseTls
use TLS to connect
_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
_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
_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 Source #
Instance details Defined in Client.Configuration.ServerSettings Methods showsPrec :: Int -> ServerSettings -> ShowS # show :: ServerSettings -> String # showList :: [ServerSettings] -> ShowS #

data HookConfig Source #

Hook name and configuration arguments

Constructors

HookConfig Text [Text]

Instances

Show HookConfig Source #
Instance details Defined in Client.Configuration.ServerSettings Methods showsPrec :: Int -> HookConfig -> ShowS # show :: HookConfig -> String # showList :: [HookConfig] -> ShowS #

serverSpec :: ValueSpec (ServerSettings -> ServerSettings) Source #

identifierSpec :: ValueSpec Identifier Source #

Lenses

ssNicks :: Lens' ServerSettings (NonEmpty Text) Source #

ssUser :: Lens' ServerSettings Text Source #

ssReal :: Lens' ServerSettings Text Source #

ssPassword :: Lens' ServerSettings (Maybe Secret) Source #

ssSaslMechanism :: Lens' ServerSettings (Maybe SaslMechanism) Source #

ssHostName :: Lens' ServerSettings HostName Source #

ssPort :: Lens' ServerSettings (Maybe PortNumber) Source #

ssTls :: Lens' ServerSettings UseTls Source #

ssTlsClientCert :: Lens' ServerSettings (Maybe FilePath) Source #

ssTlsClientKey :: Lens' ServerSettings (Maybe FilePath) Source #

ssTlsClientKeyPassword :: Lens' ServerSettings (Maybe Secret) Source #

ssTlsServerCert :: Lens' ServerSettings (Maybe FilePath) Source #

ssTlsCiphers :: Lens' ServerSettings String Source #

ssConnectCmds :: Lens' ServerSettings [[ExpansionChunk]] Source #

ssSocksHost :: Lens' ServerSettings (Maybe HostName) Source #

ssSocksPort :: Lens' ServerSettings PortNumber Source #

ssChanservChannels :: Lens' ServerSettings [Identifier] Source #

ssFloodPenalty :: Lens' ServerSettings Rational Source #

ssFloodThreshold :: Lens' ServerSettings Rational Source #

ssMessageHooks :: Lens' ServerSettings [HookConfig] Source #

ssName :: Lens' ServerSettings (Maybe Text) Source #

ssReconnectAttempts :: Lens' ServerSettings Int Source #

ssReconnectError :: Lens' ServerSettings (Maybe KnownRegex) Source #

ssAutoconnect :: Lens' ServerSettings Bool Source #

ssNickCompletion :: Lens' ServerSettings WordCompletionMode Source #

ssLogDir :: Lens' ServerSettings (Maybe FilePath) Source #

ssBindHostName :: Lens' ServerSettings (Maybe HostName) Source #

ssSts :: Lens' ServerSettings Bool Source #

ssTlsPubkeyFingerprint :: Lens' ServerSettings (Maybe Fingerprint) Source #

ssTlsCertFingerprint :: Lens' ServerSettings (Maybe Fingerprint) Source #

ssShowAccounts :: Lens' ServerSettings Bool Source #

ssCapabilities :: Lens' ServerSettings [Text] Source #

SASL Mechanisms

data SaslMechanism Source #

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

Instances

Show SaslMechanism Source #
Instance details Defined in Client.Configuration.ServerSettings Methods showsPrec :: Int -> SaslMechanism -> ShowS # show :: SaslMechanism -> String # showList :: [SaslMechanism] -> ShowS #

_SaslExternal :: Prism' SaslMechanism (Maybe Text) Source #

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

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

Secrets

data Secret Source #

Constructors

SecretText Text	Constant text
SecretCommand (NonEmpty Text)	Command to generate text

Instances

Show Secret Source #
Instance details Defined in Client.Configuration.ServerSettings Methods showsPrec :: Int -> Secret -> ShowS # show :: Secret -> String # showList :: [Secret] -> ShowS #
HasSpec Secret Source #
Instance details Defined in Client.Configuration.ServerSettings Methods anySpec :: ValueSpec Secret #

data SecretException Source #

Constructors

SecretException String String

Instances

Show SecretException Source #
Instance details Defined in Client.Configuration.ServerSettings Methods showsPrec :: Int -> SecretException -> ShowS # show :: SecretException -> String # showList :: [SecretException] -> ShowS #
Exception SecretException Source #
Instance details Defined in Client.Configuration.ServerSettings Methods toException :: SecretException -> SomeException # fromException :: SomeException -> Maybe SecretException # displayException :: SecretException -> String #

loadSecrets :: ServerSettings -> IO ServerSettings Source #

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

Defaults

defaultServerSettings :: ServerSettings Source #

The defaults for server settings.

TLS settings

data UseTls Source #

Security setting for network connection

Constructors

UseTls	TLS connection
UseInsecureTls	TLS connection without certificate checking
UseInsecure	Plain connection

Instances

Show UseTls Source #
Instance details Defined in Client.Configuration.ServerSettings Methods showsPrec :: Int -> UseTls -> ShowS # show :: UseTls -> String # showList :: [UseTls] -> ShowS #

data Fingerprint Source #

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 Source #
Instance details Defined in Client.Configuration.ServerSettings Methods showsPrec :: Int -> Fingerprint -> ShowS # show :: Fingerprint -> String # showList :: [Fingerprint] -> ShowS #

Regex wrapper

data KnownRegex Source #

Regular expression matched with original source to help with debugging.

Constructors

KnownRegex Text Regex

Instances

Show KnownRegex Source #
Instance details Defined in Client.Configuration.ServerSettings Methods showsPrec :: Int -> KnownRegex -> ShowS # show :: KnownRegex -> String # showList :: [KnownRegex] -> ShowS #

getRegex :: KnownRegex -> Regex Source #