Network.MQTT.Broker.Authentication

Documentation

class Exception (AuthenticationException a) => Authenticator a where

A peer identity optionally associated with connection/session specific information. newtype Principal = Principal T.Text deriving (Eq, Ord, Show)

An Authenticator is able to determine a Principal's identity from a Request.

Minimal complete definition

newAuthenticator, authenticate, getPrincipal

Associated Types

data AuthenticatorConfig a

data AuthenticationException a

This Exception may be thrown by any operation within this class. Operations must only throw this type of exception. Other exceptions won't be catched and may kill the broker.

Methods

newAuthenticator :: AuthenticatorConfig a -> IO a

Create a new authenticator instance from configuration.

authenticate :: a -> ConnectionRequest -> IO (Maybe PrincipalIdentifier)

Try to determine a Principal's identity from a connection Request.

The operation shall return Nothing in case the authentication mechanism is working, but couldn't associate an identity. It shall throw an AuthenticationException in case of other problems.

getPrincipal :: a -> PrincipalIdentifier -> IO (Maybe Principal)

Gets a principal by principal primary key (UUID).

The operation shall return Nothing in case the principal is not / no longer available. It shall throw an AuthenticationException in case of other problems.

type PrincipalIdentifier = UUID

data Principal

Constructors

Principal

Fields

• principalUsername :: Maybe Username
• principalQuota :: Quota
• principalPublishPermissions :: Trie ()
• principalSubscribePermissions :: Trie ()
• principalRetainPermissions :: Trie ()

Instances

Eq Principal

Methods

(==) :: Principal -> Principal -> Bool

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

Show Principal

Methods

showsPrec :: Int -> Principal -> ShowS

show :: Principal -> String

showList :: [Principal] -> ShowS

Generic Principal

Associated Types

type Rep Principal :: * -> *

Methods

from :: Principal -> Rep Principal x

to :: Rep Principal x -> Principal

Binary Principal

Methods

put :: Principal -> Put

get :: Get Principal

putList :: [Principal] -> Put

type Rep Principal

type Rep Principal = D1 (MetaData "Principal" "Network.MQTT.Broker.Authentication" "mqtt-0.1.1.0-6z0Hs5qv6meCmpWtAOex9N" False) (C1 (MetaCons "Principal" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "principalUsername") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Username))) (S1 (MetaSel (Just Symbol "principalQuota") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Quota))) ((:*:) (S1 (MetaSel (Just Symbol "principalPublishPermissions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Trie ()))) ((:*:) (S1 (MetaSel (Just Symbol "principalSubscribePermissions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Trie ()))) (S1 (MetaSel (Just Symbol "principalRetainPermissions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Trie ())))))))

data Quota

Constructors

Quota

Fields

• quotaMaxIdleSessionTTL :: Word64
• quotaMaxPacketSize :: Word64
• quotaMaxPacketIdentifiers :: Word64
• quotaMaxQueueSizeQoS0 :: Word64
• quotaMaxQueueSizeQoS1 :: Word64
• quotaMaxQueueSizeQoS2 :: Word64

Instances

Eq Quota

Methods

(==) :: Quota -> Quota -> Bool

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

Ord Quota

Methods

compare :: Quota -> Quota -> Ordering

(<) :: Quota -> Quota -> Bool

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

(>) :: Quota -> Quota -> Bool

(>=) :: Quota -> Quota -> Bool

max :: Quota -> Quota -> Quota

min :: Quota -> Quota -> Quota

Show Quota

Methods

showsPrec :: Int -> Quota -> ShowS

show :: Quota -> String

showList :: [Quota] -> ShowS

Generic Quota

Associated Types

type Rep Quota :: * -> *

Methods

from :: Quota -> Rep Quota x

to :: Rep Quota x -> Quota

Binary Quota

Methods

put :: Quota -> Put

get :: Get Quota

putList :: [Quota] -> Put

type Rep Quota

type Rep Quota = D1 (MetaData "Quota" "Network.MQTT.Broker.Authentication" "mqtt-0.1.1.0-6z0Hs5qv6meCmpWtAOex9N" False) (C1 (MetaCons "Quota" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "quotaMaxIdleSessionTTL") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word64)) ((:*:) (S1 (MetaSel (Just Symbol "quotaMaxPacketSize") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word64)) (S1 (MetaSel (Just Symbol "quotaMaxPacketIdentifiers") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word64)))) ((:*:) (S1 (MetaSel (Just Symbol "quotaMaxQueueSizeQoS0") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word64)) ((:*:) (S1 (MetaSel (Just Symbol "quotaMaxQueueSizeQoS1") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word64)) (S1 (MetaSel (Just Symbol "quotaMaxQueueSizeQoS2") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word64))))))

data ConnectionRequest

This class defines how the information gathered from a connection request looks like. An Authenticator may use whatever information it finds suitable to authenticate the Principal.

Constructors

ConnectionRequest

Fields

• requestClientIdentifier :: ClientIdentifier
• requestCleanSession :: Bool
• requestSecure :: Bool

  Is this connection secure in terms of Transport Layer Security?

• requestCredentials :: Maybe (Username, Maybe Password)

  The username and password supplied with the MQTT handshake.

• requestHttp :: Maybe (ByteString, [(CI ByteString, ByteString)])

  The HTTP request head in case the client connected via WebSocket.

• requestCertificateChain :: Maybe CertificateChain

  An X.509 certificate chain supplied by the peer. It can be assumed that the transport layer implementation already verified that the peer owns the corresponding private key. The validation of the certificate claims (including certificate chain checking) must be performed by the Authenticator.

• requestRemoteAddress :: Maybe ByteString

Instances

Show ConnectionRequest

Methods

showsPrec :: Int -> ConnectionRequest -> ShowS

show :: ConnectionRequest -> String

showList :: [ConnectionRequest] -> ShowS