LdapScimBridge

Documentation

data LdapConf

Constructors

LdapConf

Fields

• ldapHost :: Host

  eg. Ldap.Tls (host conf) Ldap.defaultTlsSettings

• ldapPort :: PortNumber

  usually 389 for plaintext or 636 for TLS.

• ldapDn :: Dn

  `$ slapcat | grep ^modifiersName`, eg. Dn "cn=admin,dc=nodomain".

• ldapPassword :: Password
• ldapSearch :: LdapSearch
• ldapCodec :: Codec

  anything from Data.Text.Encoding.

• ldapDeleteOnAttribute :: Maybe LdapFilterAttr
• ldapDeleteFromDirectory :: Maybe LdapSearch

Instances

FromJSON LdapConf

Defined in LdapScimBridge

Methods

parseJSON :: Value -> Parser LdapConf

parseJSONList :: Value -> Parser [LdapConf]

Show LdapConf

Defined in LdapScimBridge

Methods

showsPrec :: Int -> LdapConf -> ShowS

show :: LdapConf -> String

showList :: [LdapConf] -> ShowS

data LdapFilterAttr

Constructors

LdapFilterAttr

Fields

• key :: Text
• value :: Text

Instances

FromJSON LdapFilterAttr

Defined in LdapScimBridge

Methods

parseJSON :: Value -> Parser LdapFilterAttr

parseJSONList :: Value -> Parser [LdapFilterAttr]

Generic LdapFilterAttr

Defined in LdapScimBridge

Associated Types

type Rep LdapFilterAttr :: Type -> Type

Methods

from :: LdapFilterAttr -> Rep LdapFilterAttr x

to :: Rep LdapFilterAttr x -> LdapFilterAttr

Show LdapFilterAttr

Defined in LdapScimBridge

Methods

showsPrec :: Int -> LdapFilterAttr -> ShowS

show :: LdapFilterAttr -> String

showList :: [LdapFilterAttr] -> ShowS

Eq LdapFilterAttr

Defined in LdapScimBridge

Methods

(==) :: LdapFilterAttr -> LdapFilterAttr -> Bool

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

type Rep LdapFilterAttr

Defined in LdapScimBridge

type Rep LdapFilterAttr = D1 ('MetaData "LdapFilterAttr" "LdapScimBridge" "ldap-scim-bridge-0.10-inplace" 'False) (C1 ('MetaCons "LdapFilterAttr" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data LdapSearch

Constructors

LdapSearch

Fields

• ldapSearchBase :: Dn

  `$ slapcat | grep ^dn`, eg. Dn "dc=nodomain".

• ldapSearchObjectClass :: Text

  eg. "account"

• ldapSearchExtra :: [LdapFilterAttr]

  eg. @[LdapFilterAttr "memberOf" "team red", LdapFilterAttr "hairColor" "yellow"]

Instances

FromJSON LdapSearch

Defined in LdapScimBridge

Methods

parseJSON :: Value -> Parser LdapSearch

parseJSONList :: Value -> Parser [LdapSearch]

Show LdapSearch

Defined in LdapScimBridge

Methods

showsPrec :: Int -> LdapSearch -> ShowS

show :: LdapSearch -> String

showList :: [LdapSearch] -> ShowS

Eq LdapSearch

Defined in LdapScimBridge

Methods

(==) :: LdapSearch -> LdapSearch -> Bool

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

data Codec

Constructors

Utf8

Latin1

Instances

Show Codec

Defined in LdapScimBridge

Methods

showsPrec :: Int -> Codec -> ShowS

show :: Codec -> String

showList :: [Codec] -> ShowS

Eq Codec

Defined in LdapScimBridge

Methods

(==) :: Codec -> Codec -> Bool

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

data ScimConf

Constructors

ScimConf

Fields

• scimTls :: Bool
• scimHost :: String
• scimPort :: Int
• scimPath :: String
• scimToken :: Text

Instances

FromJSON ScimConf

Defined in LdapScimBridge

Methods

parseJSON :: Value -> Parser ScimConf

parseJSONList :: Value -> Parser [ScimConf]

Generic ScimConf

Defined in LdapScimBridge

Associated Types

type Rep ScimConf :: Type -> Type

Methods

from :: ScimConf -> Rep ScimConf x

to :: Rep ScimConf x -> ScimConf

Show ScimConf

Defined in LdapScimBridge

Methods

showsPrec :: Int -> ScimConf -> ShowS

show :: ScimConf -> String

showList :: [ScimConf] -> ShowS

Eq ScimConf

Defined in LdapScimBridge

Methods

(==) :: ScimConf -> ScimConf -> Bool

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

type Rep ScimConf

Defined in LdapScimBridge

type Rep ScimConf = D1 ('MetaData "ScimConf" "LdapScimBridge" "ldap-scim-bridge-0.10-inplace" 'False) (C1 ('MetaCons "ScimConf" 'PrefixI 'True) ((S1 ('MetaSel ('Just "scimTls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "scimHost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :*: (S1 ('MetaSel ('Just "scimPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: (S1 ('MetaSel ('Just "scimPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "scimToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))))

data BridgeConf

Constructors

BridgeConf

Fields

• ldapSource :: LdapConf
• scimTarget :: ScimConf
• mapping :: Mapping
• logLevel :: PhantomParent Level

Instances

FromJSON BridgeConf

Defined in LdapScimBridge

Methods

parseJSON :: Value -> Parser BridgeConf

parseJSONList :: Value -> Parser [BridgeConf]

Generic BridgeConf

Defined in LdapScimBridge

Associated Types

type Rep BridgeConf :: Type -> Type

Methods

from :: BridgeConf -> Rep BridgeConf x

to :: Rep BridgeConf x -> BridgeConf

Show BridgeConf

Defined in LdapScimBridge

Methods

showsPrec :: Int -> BridgeConf -> ShowS

show :: BridgeConf -> String

showList :: [BridgeConf] -> ShowS

type Rep BridgeConf

Defined in LdapScimBridge

type Rep BridgeConf = D1 ('MetaData "BridgeConf" "LdapScimBridge" "ldap-scim-bridge-0.10-inplace" 'False) (C1 ('MetaCons "BridgeConf" 'PrefixI 'True) ((S1 ('MetaSel ('Just "ldapSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LdapConf) :*: S1 ('MetaSel ('Just "scimTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ScimConf)) :*: (S1 ('MetaSel ('Just "mapping") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Mapping) :*: S1 ('MetaSel ('Just "logLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PhantomParent Level)))))

newtype PhantomParent a

Work around orphan instances. Might not be a phantom, but I like the name. :)

Constructors

PhantomParent

Fields

• unPhantomParent :: a

Instances

FromJSON (PhantomParent Level)

Defined in LdapScimBridge

Methods

parseJSON :: Value -> Parser (PhantomParent Level)

parseJSONList :: Value -> Parser [PhantomParent Level]

Bounded a => Bounded (PhantomParent a)

Defined in LdapScimBridge

Methods

minBound :: PhantomParent a

maxBound :: PhantomParent a

Generic (PhantomParent a)

Defined in LdapScimBridge

Associated Types

type Rep (PhantomParent a) :: Type -> Type

Methods

from :: PhantomParent a -> Rep (PhantomParent a) x

to :: Rep (PhantomParent a) x -> PhantomParent a

Show a => Show (PhantomParent a)

Defined in LdapScimBridge

Methods

showsPrec :: Int -> PhantomParent a -> ShowS

show :: PhantomParent a -> String

showList :: [PhantomParent a] -> ShowS

Eq a => Eq (PhantomParent a)

Defined in LdapScimBridge

Methods

(==) :: PhantomParent a -> PhantomParent a -> Bool

(/=) :: PhantomParent a -> PhantomParent a -> Bool

Ord a => Ord (PhantomParent a)

Defined in LdapScimBridge

Methods

compare :: PhantomParent a -> PhantomParent a -> Ordering

(<) :: PhantomParent a -> PhantomParent a -> Bool

(<=) :: PhantomParent a -> PhantomParent a -> Bool

(>) :: PhantomParent a -> PhantomParent a -> Bool

(>=) :: PhantomParent a -> PhantomParent a -> Bool

max :: PhantomParent a -> PhantomParent a -> PhantomParent a

min :: PhantomParent a -> PhantomParent a -> PhantomParent a

type Rep (PhantomParent a)

Defined in LdapScimBridge

type Rep (PhantomParent a) = D1 ('MetaData "PhantomParent" "LdapScimBridge" "ldap-scim-bridge-0.10-inplace" 'True) (C1 ('MetaCons "PhantomParent" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPhantomParent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

data MappingError

Constructors

MissingMandatoryValue Text Text

WrongNumberOfAttrValues Text Text String Int

CouldNotParseEmail Text Text Text String

Instances

Eq MappingError

Defined in LdapScimBridge

Methods

(==) :: MappingError -> MappingError -> Bool

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

renderMappingError :: MappingError -> String

renderSearchError :: [(SearchEntry, MappingError)] -> String

data FieldMapping

Constructors

FieldMapping

Fields

• fieldMappingLabel :: Text

  This is the SCIM label (the LDAP label is in the key of the Mapping)

• fieldMappingFun :: [Text] -> Either MappingError (User ScimTag -> User ScimTag)

Instances

Show FieldMapping

Defined in LdapScimBridge

Methods

showsPrec :: Int -> FieldMapping -> ShowS

show :: FieldMapping -> String

showList :: [FieldMapping] -> ShowS

data ScimTag

Fill in the parameters for hscim User type with plausible defaults. (You may want to touch this if you're using the library for something new.)

Instances

AuthTypes ScimTag

Defined in LdapScimBridge

Associated Types

type AuthData ScimTag

type AuthInfo ScimTag

GroupTypes ScimTag

Defined in LdapScimBridge

Associated Types

type GroupId ScimTag

UserTypes ScimTag

Defined in LdapScimBridge

Associated Types

type UserId ScimTag

type UserExtra ScimTag

Methods

supportedSchemas :: [Schema]

type AuthData ScimTag

Defined in LdapScimBridge

type AuthData ScimTag = Text

type AuthInfo ScimTag

Defined in LdapScimBridge

type AuthInfo ScimTag = ()

type GroupId ScimTag

Defined in LdapScimBridge

type GroupId ScimTag = Text

type UserExtra ScimTag

Defined in LdapScimBridge

type UserExtra ScimTag = NoUserExtra

type UserId ScimTag

Defined in LdapScimBridge

type UserId ScimTag = Text

newtype Mapping

Map attribute keys to functions from attribute values to changes to scim records. We'll start off with an empty scim record, and change it based on attributes we find that are listed in the mapping. Mappigns can fail, eg. if there is more than one attribute value for the attribute mapping to externalId.

Constructors

Mapping

Fields

• fromMapping :: Map Text [FieldMapping]

Instances

FromJSON Mapping

Defined in LdapScimBridge

Methods

parseJSON :: Value -> Parser Mapping

parseJSONList :: Value -> Parser [Mapping]

Show Mapping

Defined in LdapScimBridge

Methods

showsPrec :: Int -> Mapping -> ShowS

show :: Mapping -> String

showList :: [Mapping] -> ShowS

type LdapResult a = IO (Either LdapError a)

ldapObjectClassFilter :: Text -> Filter

ldapFilterAttrToFilter :: LdapFilterAttr -> Filter

listLdapUsers :: LdapConf -> LdapSearch -> LdapResult [SearchEntry]

type User = User ScimTag

type StoredUser = StoredUser ScimTag

emptyScimUser :: User

Note that the userName field is mandatory in SCIM, but we gloss over this by setting it to an empty Text here. See RequireUserName, ldapToScim if you wonder whether this is a good idea.

scimSchemas :: [Schema]

data RequireUserName

Constructors

Lenient

Strict

Instances

Show RequireUserName

Defined in LdapScimBridge

Methods

showsPrec :: Int -> RequireUserName -> ShowS

show :: RequireUserName -> String

showList :: [RequireUserName] -> ShowS

Eq RequireUserName

Defined in LdapScimBridge

Methods

(==) :: RequireUserName -> RequireUserName -> Bool

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

ldapToScim :: forall m. m ~ Either [(SearchEntry, MappingError)] => RequireUserName -> BridgeConf -> SearchEntry -> m (SearchEntry, User)

Translate an LDAP record into a SCIM record. If username is not provided in the LDAP record, behavior is defined by the first argument: if Lenient, just fill in an empty Text; if Strict, throw an error.

connectScim :: Logger -> ScimConf -> IO ClientEnv

isDeletee :: LdapConf -> SearchEntry -> Bool

updateScimPeer :: Logger -> BridgeConf -> IO ()

lookupScimByExternalId :: ClientEnv -> Maybe Text -> User tag -> IO (Maybe StoredUser)

updateScimPeerPostPut :: Logger -> ClientEnv -> Maybe (AuthData ScimTag) -> [User] -> IO ()

updateScimPeerPostPutStep :: Logger -> ClientEnv -> Maybe Text -> User ScimTag -> Text -> IO ()

updateScimPeerDelete :: Logger -> ClientEnv -> Maybe (AuthData ScimTag) -> [User] -> IO ()

parseCli :: IO BridgeConf

type Logger = Level -> Text -> IO ()

mkLogger :: Level -> IO Logger

main :: IO ()