Packages

simple_auth

1.5.4
1.11.0 1.10.1 1.10.0 1.9.0 1.8.0 1.7.0 1.6.1 1.6.0 1.5.8 1.5.7 1.5.6 1.5.5 1.5.4 1.5.3 1.5.2 1.5.1 1.5.1-rc

Adds authentication and authorization to a Phoenix project. A user can login with a username and password held in the DB or against an LDAP server.

HexDocs

Current section

Files

Jump to
Readme
17 Versions
3 Dependencies
Dependants
Files
Activity
simple_auth lib ldap_helper.ex
Raw

lib/ldap_helper.ex 

defmodule SimpleAuth.LdapHelperAPI do

  @moduledoc "API for authentication"



  @doc """

  Builds the LDAP user to be passed to ldap from the username.  This should be a very simple

  function that just returns for example "myorg\\<username>"

  """

  @callback build_ldap_user(username :: term) :: term



  @doc """

  Invoked when adding a new user.  The user struct can be enhanced with extra properties if required

  Returns the enhanced user struct

  """

  @type option :: {:new_user, boolean}

  @callback enhance_user(user :: term, connection :: term, [option]) :: term

end