Ldap.Client

This module is intended to be imported qualified

import qualified Ldap.Client as Ldap

Documentation

with :: Host -> PortNumber -> (Ldap -> IO a) -> IO (Either LdapError a)

The entrypoint into LDAP.

It catches all LDAP-related exceptions.

data Host

LDAP host.

Constructors

Plain String

Plain LDAP.

Tls String TLSSettings

LDAP over TLS.

Instances

Show Host

Methods

showsPrec :: Int -> Host -> ShowS

show :: Host -> String

showList :: [Host] -> ShowS

defaultTlsSettings :: TLSSettings

insecureTlsSettings :: TLSSettings

data PortNumber :: *

Use the Num instance (i.e. use a literal) to create a PortNumber value with the correct network-byte-ordering. You should not use the PortNum constructor. It will be removed in the next release.

>>> 1 :: PortNumber
1
>>> read "1" :: PortNumber
1

Instances

Enum PortNumber

Methods

succ :: PortNumber -> PortNumber

pred :: PortNumber -> PortNumber

toEnum :: Int -> PortNumber

fromEnum :: PortNumber -> Int

enumFrom :: PortNumber -> [PortNumber]

enumFromThen :: PortNumber -> PortNumber -> [PortNumber]

enumFromTo :: PortNumber -> PortNumber -> [PortNumber]

enumFromThenTo :: PortNumber -> PortNumber -> PortNumber -> [PortNumber]

Eq PortNumber

Methods

(==) :: PortNumber -> PortNumber -> Bool

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

Integral PortNumber

Methods

quot :: PortNumber -> PortNumber -> PortNumber

rem :: PortNumber -> PortNumber -> PortNumber

div :: PortNumber -> PortNumber -> PortNumber

mod :: PortNumber -> PortNumber -> PortNumber

quotRem :: PortNumber -> PortNumber -> (PortNumber, PortNumber)

divMod :: PortNumber -> PortNumber -> (PortNumber, PortNumber)

toInteger :: PortNumber -> Integer

Num PortNumber

Methods

(+) :: PortNumber -> PortNumber -> PortNumber

(-) :: PortNumber -> PortNumber -> PortNumber

(*) :: PortNumber -> PortNumber -> PortNumber

negate :: PortNumber -> PortNumber

abs :: PortNumber -> PortNumber

signum :: PortNumber -> PortNumber

fromInteger :: Integer -> PortNumber

Ord PortNumber

Methods

compare :: PortNumber -> PortNumber -> Ordering

(<) :: PortNumber -> PortNumber -> Bool

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

(>) :: PortNumber -> PortNumber -> Bool

(>=) :: PortNumber -> PortNumber -> Bool

max :: PortNumber -> PortNumber -> PortNumber

min :: PortNumber -> PortNumber -> PortNumber

Read PortNumber

Methods

readsPrec :: Int -> ReadS PortNumber

readList :: ReadS [PortNumber]

readPrec :: ReadPrec PortNumber

readListPrec :: ReadPrec [PortNumber]

Real PortNumber

Methods

toRational :: PortNumber -> Rational

Show PortNumber

Methods

showsPrec :: Int -> PortNumber -> ShowS

show :: PortNumber -> String

showList :: [PortNumber] -> ShowS

Storable PortNumber

Methods

sizeOf :: PortNumber -> Int

alignment :: PortNumber -> Int

peekElemOff :: Ptr PortNumber -> Int -> IO PortNumber

pokeElemOff :: Ptr PortNumber -> Int -> PortNumber -> IO ()

peekByteOff :: Ptr b -> Int -> IO PortNumber

pokeByteOff :: Ptr b -> Int -> PortNumber -> IO ()

peek :: Ptr PortNumber -> IO PortNumber

poke :: Ptr PortNumber -> PortNumber -> IO ()

data Ldap

A token. All functions that interact with the Directory require one.

Instances

Eq Ldap

Methods

(==) :: Ldap -> Ldap -> Bool

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

data LdapError

Various failures that can happen when working with LDAP.

Constructors

IOError !IOError

Network failure.

ParseError !ASN1Error

Invalid ASN.1 data received from the server.

ResponseError !ResponseError

An LDAP operation failed.

DisconnectError !Disconnect

Notice of Disconnection has been received.

Instances

Eq LdapError

Methods

(==) :: LdapError -> LdapError -> Bool

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

Show LdapError

Methods

showsPrec :: Int -> LdapError -> ShowS

show :: LdapError -> String

showList :: [LdapError] -> ShowS

data ResponseError

Response indicates a failed operation.

Constructors

ResponseInvalid !Request !Response

LDAP server did not follow the protocol, so ldap-client couldn't make sense of the response.

ResponseErrorCode !Request !ResultCode !Dn !Text

The response contains a result code indicating failure and an error message.

Instances

Eq ResponseError

Methods

(==) :: ResponseError -> ResponseError -> Bool

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

Show ResponseError

Methods

showsPrec :: Int -> ResponseError -> ShowS

show :: ResponseError -> String

showList :: [ResponseError] -> ShowS

Exception ResponseError

Methods

toException :: ResponseError -> SomeException

fromException :: SomeException -> Maybe ResponseError

displayException :: ResponseError -> String

data ResultCode

LDAP operation's result.

Constructors

Success

OperationError

ProtocolError

TimeLimitExceeded

SizeLimitExceeded

CompareFalse

CompareTrue

AuthMethodNotSupported

StrongerAuthRequired

Referral

AdminLimitExceeded

UnavailableCriticalExtension

ConfidentialityRequired

SaslBindInProgress

NoSuchAttribute

UndefinedAttributeType

InappropriateMatching

ConstraintViolation

AttributeOrValueExists

InvalidAttributeSyntax

NoSuchObject

AliasProblem

InvalidDNSyntax

AliasDereferencingProblem

InappropriateAuthentication

InvalidCredentials

InsufficientAccessRights

Busy

Unavailable

UnwillingToPerform

LoopDetect

NamingViolation

ObjectClassViolation

NotAllowedOnNonLeaf

NotAllowedOnRDN

EntryAlreadyExists

ObjectClassModsProhibited

AffectsMultipleDSAs

Other

Instances

Eq ResultCode

Methods

(==) :: ResultCode -> ResultCode -> Bool

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

Show ResultCode

Methods

showsPrec :: Int -> ResultCode -> ShowS

show :: ResultCode -> String

showList :: [ResultCode] -> ShowS

Bind

newtype Password

User's password.

Constructors

Password ByteString

Instances

Eq Password

Methods

(==) :: Password -> Password -> Bool

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

Show Password

Methods

showsPrec :: Int -> Password -> ShowS

show :: Password -> String

showList :: [Password] -> ShowS

bind :: Ldap -> Dn -> Password -> IO ()

Perform the Bind operation synchronously. Raises ResponseError on failures.

externalBind :: Ldap -> Dn -> Maybe Text -> IO ()

Perform a SASL EXTERNAL Bind operation synchronously. Raises ResponseError on failures.

Search

search :: Ldap -> Dn -> Mod Search -> Filter -> [Attr] -> IO [SearchEntry]

Perform the Search operation synchronously. Raises ResponseError on failures.

data SearchEntry

Entry found during the Search.

Constructors

SearchEntry !Dn !(AttrList [])

Instances

Eq SearchEntry

Methods

(==) :: SearchEntry -> SearchEntry -> Bool

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

Show SearchEntry

Methods

showsPrec :: Int -> SearchEntry -> ShowS

show :: SearchEntry -> String

showList :: [SearchEntry] -> ShowS

Search modifiers

data Search

Search options. Use Mod to change some of those.

Instances

Eq Search

Methods

(==) :: Search -> Search -> Bool

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

Show Search

Methods

showsPrec :: Int -> Search -> ShowS

show :: Search -> String

showList :: [Search] -> ShowS

data Mod a

Search modifier. Combine using Semigroup and/or Monoid instance.

Instances

Semigroup (Mod a)

Methods

(<>) :: Mod a -> Mod a -> Mod a

sconcat :: NonEmpty (Mod a) -> Mod a

stimes :: Integral b => b -> Mod a -> Mod a

Monoid (Mod a)

Methods

mempty :: Mod a

mappend :: Mod a -> Mod a -> Mod a

mconcat :: [Mod a] -> Mod a

data Scope

Scope of the search to be performed.

Constructors

BaseObject

Constrained to the entry named by baseObject.

SingleLevel

Constrained to the immediate subordinates of the entry named by baseObject.

WholeSubtree

Constrained to the entry named by baseObject and to all its subordinates.

Instances

Eq Scope

Methods

(==) :: Scope -> Scope -> Bool

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

Show Scope

Methods

showsPrec :: Int -> Scope -> ShowS

show :: Scope -> String

showList :: [Scope] -> ShowS

scope :: Scope -> Mod Search

Scope of the search (default: WholeSubtree).

size :: Int32 -> Mod Search

Maximum number of entries to be returned as a result of the Search. No limit if the value is 0 (default: 0).

time :: Int32 -> Mod Search

Maximum time (in seconds) allowed for the Search. No limit if the value is 0 (default: 0).

typesOnly :: Bool -> Mod Search

Whether Search results are to contain just attribute descriptions, or both attribute descriptions and values (default: False).

data DerefAliases

An indicator as to whether or not alias entries (as defined in [RFC4512]) are to be dereferenced during stages of the Search operation.

Constructors

NeverDerefAliases

Do not dereference aliases in searching or in locating the base object of the Search.

DerefInSearching

While searching subordinates of the base object, dereference any alias within the search scope.

DerefFindingBaseObject

Dereference aliases in locating the base object of the Search.

DerefAlways

Dereference aliases both in searching and in locating the base object of the Search.

Instances

Eq DerefAliases

Methods

(==) :: DerefAliases -> DerefAliases -> Bool

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

Show DerefAliases

Methods

showsPrec :: Int -> DerefAliases -> ShowS

show :: DerefAliases -> String

showList :: [DerefAliases] -> ShowS

derefAliases :: DerefAliases -> Mod Search

Alias dereference policy (default: NeverDerefAliases).

data Filter

Conditions that must be fulfilled in order for the Search to match a given entry.

Constructors

Not !Filter

Filter does not match the entry

And !(NonEmpty Filter)

All filters match the entry

Or !(NonEmpty Filter)

Any filter matches the entry

Present !Attr

Attribute is present in the entry

!Attr := !AttrValue

Attribute's value is equal to the assertion

!Attr :>= !AttrValue

Attribute's value is equal to or greater than the assertion

!Attr :<= !AttrValue

Attribute's value is equal to or less than the assertion

!Attr :~= !AttrValue

Attribute's value approximately matches the assertion

!Attr :=* !(Maybe AttrValue, [AttrValue], Maybe AttrValue)

Glob match

!(Maybe Attr, Maybe Attr, Bool) ::= !AttrValue

Extensible match

Modify

modify :: Ldap -> Dn -> [Operation] -> IO ()

Perform the Modify operation synchronously. Raises ResponseError on failures.

data Operation

Type of modification being performed.

Constructors

Delete !Attr ![AttrValue]

Delete values from the attribute. Deletes the attribute if the list is empty or all current values are listed.

Add !Attr ![AttrValue]

Add values to the attribute, creating it if necessary.

Replace !Attr ![AttrValue]

Replace all existing values of the attribute with the new list. Deletes the attribute if the list is empty.

Instances

Eq Operation

Methods

(==) :: Operation -> Operation -> Bool

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

Show Operation

Methods

showsPrec :: Int -> Operation -> ShowS

show :: Operation -> String

showList :: [Operation] -> ShowS

Add

add :: Ldap -> Dn -> AttrList NonEmpty -> IO ()

Perform the Add operation synchronously. Raises ResponseError on failures.

Delete

delete :: Ldap -> Dn -> IO ()

Perform the Delete operation synchronously. Raises ResponseError on failures.

ModifyDn

newtype RelativeDn

A component of Dn.

Constructors

RelativeDn Text

Instances

Eq RelativeDn

Methods

(==) :: RelativeDn -> RelativeDn -> Bool

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

Show RelativeDn

Methods

showsPrec :: Int -> RelativeDn -> ShowS

show :: RelativeDn -> String

showList :: [RelativeDn] -> ShowS

modifyDn :: Ldap -> Dn -> RelativeDn -> Bool -> Maybe Dn -> IO ()

Perform the Modify DN operation synchronously. Raises ResponseError on failures.

Compare

compare :: Ldap -> Dn -> Attr -> AttrValue -> IO Bool

Perform the Compare operation synchronously. Raises ResponseError on failures.

Extended

newtype Oid

Globally unique LDAP object identifier.

Constructors

Oid Text

Instances

Eq Oid

Methods

(==) :: Oid -> Oid -> Bool

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

Show Oid

Methods

showsPrec :: Int -> Oid -> ShowS

show :: Oid -> String

showList :: [Oid] -> ShowS

IsString Oid

Methods

fromString :: String -> Oid

extended :: Ldap -> Oid -> Maybe ByteString -> IO ()

Perform the Extended operation synchronously. Raises ResponseError on failures.

Miscellanous

newtype Dn

Unique identifier of an LDAP entry.

Constructors

Dn Text

Instances

Eq Dn

Methods

(==) :: Dn -> Dn -> Bool

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

Show Dn

Methods

showsPrec :: Int -> Dn -> ShowS

show :: Dn -> String

showList :: [Dn] -> ShowS

newtype Attr

Attribute name.

Constructors

Attr Text

Instances

Eq Attr

Methods

(==) :: Attr -> Attr -> Bool

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

Show Attr

Methods

showsPrec :: Int -> Attr -> ShowS

show :: Attr -> String

showList :: [Attr] -> ShowS

type AttrValue = ByteString

Attribute value.

type AttrList f = [(Attr, f AttrValue)]

List of attributes and their values. f is the structure these values are in, e.g. NonEmpty.

Re-exports

data NonEmpty a :: * -> *

Non-empty (and non-strict) list type.

Since: 4.9.0.0

Instances

Monad NonEmpty

Methods

(>>=) :: NonEmpty a -> (a -> NonEmpty b) -> NonEmpty b

(>>) :: NonEmpty a -> NonEmpty b -> NonEmpty b

return :: a -> NonEmpty a

fail :: String -> NonEmpty a

Functor NonEmpty

Methods

fmap :: (a -> b) -> NonEmpty a -> NonEmpty b

(<$) :: a -> NonEmpty b -> NonEmpty a

MonadFix NonEmpty

Methods

mfix :: (a -> NonEmpty a) -> NonEmpty a

Applicative NonEmpty

Methods

pure :: a -> NonEmpty a

(<*>) :: NonEmpty (a -> b) -> NonEmpty a -> NonEmpty b

(*>) :: NonEmpty a -> NonEmpty b -> NonEmpty b

(<*) :: NonEmpty a -> NonEmpty b -> NonEmpty a

Foldable NonEmpty

Methods

fold :: Monoid m => NonEmpty m -> m

foldMap :: Monoid m => (a -> m) -> NonEmpty a -> m

foldr :: (a -> b -> b) -> b -> NonEmpty a -> b

foldr' :: (a -> b -> b) -> b -> NonEmpty a -> b

foldl :: (b -> a -> b) -> b -> NonEmpty a -> b

foldl' :: (b -> a -> b) -> b -> NonEmpty a -> b

foldr1 :: (a -> a -> a) -> NonEmpty a -> a

foldl1 :: (a -> a -> a) -> NonEmpty a -> a

toList :: NonEmpty a -> [a]

null :: NonEmpty a -> Bool

length :: NonEmpty a -> Int

elem :: Eq a => a -> NonEmpty a -> Bool

maximum :: Ord a => NonEmpty a -> a

minimum :: Ord a => NonEmpty a -> a

sum :: Num a => NonEmpty a -> a

product :: Num a => NonEmpty a -> a

Traversable NonEmpty

Methods

traverse :: Applicative f => (a -> f b) -> NonEmpty a -> f (NonEmpty b)

sequenceA :: Applicative f => NonEmpty (f a) -> f (NonEmpty a)

mapM :: Monad m => (a -> m b) -> NonEmpty a -> m (NonEmpty b)

sequence :: Monad m => NonEmpty (m a) -> m (NonEmpty a)

Generic1 NonEmpty

Associated Types

type Rep1 (NonEmpty :: * -> *) :: * -> *

Methods

from1 :: NonEmpty a -> Rep1 NonEmpty a

to1 :: Rep1 NonEmpty a -> NonEmpty a

MonadZip NonEmpty

Methods

mzip :: NonEmpty a -> NonEmpty b -> NonEmpty (a, b)

mzipWith :: (a -> b -> c) -> NonEmpty a -> NonEmpty b -> NonEmpty c

munzip :: NonEmpty (a, b) -> (NonEmpty a, NonEmpty b)

IsList (NonEmpty a)

Associated Types

type Item (NonEmpty a) :: *

Methods

fromList :: [Item (NonEmpty a)] -> NonEmpty a

fromListN :: Int -> [Item (NonEmpty a)] -> NonEmpty a

toList :: NonEmpty a -> [Item (NonEmpty a)]

Eq a => Eq (NonEmpty a)

Methods

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

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

Data a => Data (NonEmpty a)

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> NonEmpty a -> c (NonEmpty a)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (NonEmpty a)

toConstr :: NonEmpty a -> Constr

dataTypeOf :: NonEmpty a -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c (NonEmpty a))

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (NonEmpty a))

gmapT :: (forall b. Data b => b -> b) -> NonEmpty a -> NonEmpty a

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> NonEmpty a -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> NonEmpty a -> r

gmapQ :: (forall d. Data d => d -> u) -> NonEmpty a -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> NonEmpty a -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> NonEmpty a -> m (NonEmpty a)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> NonEmpty a -> m (NonEmpty a)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> NonEmpty a -> m (NonEmpty a)

Ord a => Ord (NonEmpty a)

Methods

compare :: NonEmpty a -> NonEmpty a -> Ordering

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

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

(>) :: NonEmpty a -> NonEmpty a -> Bool

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

max :: NonEmpty a -> NonEmpty a -> NonEmpty a

min :: NonEmpty a -> NonEmpty a -> NonEmpty a

Read a => Read (NonEmpty a)

Methods

readsPrec :: Int -> ReadS (NonEmpty a)

readList :: ReadS [NonEmpty a]

readPrec :: ReadPrec (NonEmpty a)

readListPrec :: ReadPrec [NonEmpty a]

Show a => Show (NonEmpty a)

Methods

showsPrec :: Int -> NonEmpty a -> ShowS

show :: NonEmpty a -> String

showList :: [NonEmpty a] -> ShowS

Generic (NonEmpty a)

Associated Types

type Rep (NonEmpty a) :: * -> *

Methods

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

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

Semigroup (NonEmpty a)

Methods

(<>) :: NonEmpty a -> NonEmpty a -> NonEmpty a

sconcat :: NonEmpty (NonEmpty a) -> NonEmpty a

stimes :: Integral b => b -> NonEmpty a -> NonEmpty a

ToAsn1 a => ToAsn1 (NonEmpty a)

Methods

toAsn1 :: NonEmpty a -> Endo [ASN1]

type Rep1 NonEmpty

type Rep1 NonEmpty = D1 (MetaData "NonEmpty" "Data.List.NonEmpty" "base" False) (C1 (MetaCons ":|" (InfixI RightAssociative 5) False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) Par1) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec1 []))))

type Rep (NonEmpty a)

type Rep (NonEmpty a) = D1 (MetaData "NonEmpty" "Data.List.NonEmpty" "base" False) (C1 (MetaCons ":|" (InfixI RightAssociative 5) False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [a]))))

type Item (NonEmpty a)

type Item (NonEmpty a) = a