Add an entry to the LDAP given a class object.

Example:

Paddle.add(%MyApp.PosixAccount{uid: "myUser", cn: "My User", gidNumber: "501", homeDirectory: "/home/myUser"})

Add an entry to the LDAP given a DN and a list of attributes.

The first argument is the DN given as a string or keyword list. The second argument is the list of attributes in the new entry as a keyword list like so:

[objectClass: ["account", "posixAccount"],
 cn: "User",
 loginShell: "/bin/bash",
 homeDirectory: "/home/user",
 uidNumber: 501,
 gidNumber: 100]

Please note that due to the limitation of char lists you cannot pass directly a char list as an attribute value. But, you can wrap it in an array like this: homeDirectory: ['/home/user']

Check the given credentials and authenticate the current connection.

When given the wrong credentials, returns {:error, :invalidCredentials}

The user id can be passed as a binary, which will expand to <account_identifier>=<id>,<account subdn>,<base>, or with a keyword list if you want to specify the whole DN (but still without the base DN).

Example:

iex> Paddle.authenticate("testuser", "test")
:ok
iex> Paddle.authenticate("testuser", "wrong password")
{:error, :invalidCredentials}
iex> Paddle.authenticate([cn: "admin"], "test")
:ok

Returns a specification to start this module under a supervisor.

See Supervisor.

Get the whole configuration of the Paddle application.

Get the environment configuration of the Paddle application under a certain key.

Same as config/1 but allows you to specify a default value.

Delete a LDAP entry given a DN or a class object.

Examples:

Paddle.delete("uid=testuser,ou=People")
Paddle.delete([uid: "testuser", ou: "People"])
Paddle.delete(%MyApp.PosixAccount{uid: "testuser"})

The three examples above do exactly the same thing (provided that the MyApp.PosixAccount is configured appropriately).

Same as get/1 but throws in case of an error.

Same as get/2 but throws in case of an error.

Get one or more LDAP entries given a partial DN and a filter.

Example:

iex> Paddle.get(base: [uid: "testuser", ou: "People"])
{:ok,
 [%{"cn" => ["Test User"],
   "dn" => "uid=testuser,ou=People",
   "gecos" => ["Test User,,,,"], "gidNumber" => ["120"],
   "homeDirectory" => ["/home/testuser"],
   "loginShell" => ["/bin/bash"],
   "objectClass" => ["account", "posixAccount", "top"],
   "uid" => ["testuser"], "uidNumber" => ["500"],
   "userPassword" => ["{SSHA}AIzygLSXlArhAMzddUriXQxf7UlkqopP"]}]}

iex> Paddle.get(base: "uid=testuser,ou=People")
{:ok,
 [%{"cn" => ["Test User"],
   "dn" => "uid=testuser,ou=People",
   "gecos" => ["Test User,,,,"], "gidNumber" => ["120"],
   "homeDirectory" => ["/home/testuser"],
   "loginShell" => ["/bin/bash"],
   "objectClass" => ["account", "posixAccount", "top"],
   "uid" => ["testuser"], "uidNumber" => ["500"],
   "userPassword" => ["{SSHA}AIzygLSXlArhAMzddUriXQxf7UlkqopP"]}]}

iex> Paddle.get(base: [uid: "nothing"])
{:error, :noSuchObject}

iex> Paddle.get(filter: [uid: "testuser"], base: [ou: "People"])
{:ok,
 [%{"cn" => ["Test User"],
   "dn" => "uid=testuser,ou=People",
   "gecos" => ["Test User,,,,"], "gidNumber" => ["120"],
   "homeDirectory" => ["/home/testuser"],
   "loginShell" => ["/bin/bash"],
   "objectClass" => ["account", "posixAccount", "top"],
   "uid" => ["testuser"], "uidNumber" => ["500"],
   "userPassword" => ["{SSHA}AIzygLSXlArhAMzddUriXQxf7UlkqopP"]}]}

Get an entry in the LDAP given a class object. You can specify an optional additional filter as second argument.

Example:

iex> Paddle.get(%MyApp.PosixAccount{})
{:ok,
 [%MyApp.PosixAccount{cn: ["Test User"], description: nil,
   gecos: ["Test User,,,,"], gidNumber: ["120"],
   homeDirectory: ["/home/testuser"], host: nil, l: nil,
   loginShell: ["/bin/bash"], o: nil,
   ou: nil, seeAlso: nil, uid: ["testuser"],
   uidNumber: ["500"],
   userPassword: ["{SSHA}AIzygLSXlArhAMzddUriXQxf7UlkqopP"]}]}

iex> Paddle.get(%MyApp.PosixGroup{cn: "users"})
{:ok,
 [%MyApp.PosixGroup{cn: ["users"], description: nil, gidNumber: ["2"],
   memberUid: ["testuser"], userPassword: nil}]}

iex> Paddle.get(%MyApp.PosixGroup{}, :eldap.substrings('cn', initial: 'a'))
{:ok,
 [%MyApp.PosixGroup{cn: ["adm"], description: nil, gidNumber: ["3"],
   memberUid: nil, userPassword: nil}]}

Get the DN of an entry.

Example:

iex> Paddle.get_dn(%MyApp.PosixAccount{uid: "testuser"})
{:ok, "uid=testuser,ou=People"}

Get a single LDAP entry given an optional partial DN and an optional filter.

Example:

iex> Paddle.get_single(base: [ou: "People"])
{:ok,
 %{"dn" => "ou=People",
  "objectClass" => ["top", "organizationalUnit"], "ou" => ["People"]}}

iex> Paddle.get_single(filter: [uid: "nothing"])
{:error, :noSuchObject}

Modify an LDAP entry given a DN or a class object and a list of modifications.

A modification is specified like so:

{action, {parameters...}}

Available modifications:

• {:add, {field, value}}
• {:delete, field}
• {:replace, {field, value}}

For example, adding a “description” field:

{:add, {"description", "This is a description"}}

This allows you to do things like this:

Paddle.modify([uid: "testuser", ou: "People"],
              add: {"description", "This is a description"},
              delete: "gecos",
              replace: {"o", ["Club *Nix", "Linux Foundation"]})

Or, using class objects:

Paddle.modify(%MyApp.PosixAccount{uid: "testuser"},
              add: {"description", "This is a description"},
              delete: "gecos",
              replace: {"o", ["Club *Nix", "Linux Foundation"]})

Closes the current connection and opens a new one.

Accepts connection information as arguments. Not specified values will be fetched from the config.

Example:

iex> Paddle.reconnect(host: ['example.com'])
{:error, {:not_connected, "connect failed"}}
iex> Paddle.reconnect()
{:ok, :connected}