Module ejabberd_auth [erl svg]

Data Types
Function Index
Function Details

To do

Use the functions in ejabberd auth to add and remove users.

Data Types

authmodule()

Function Index

auth_modules/0*	Return the lists of all the auth modules actually used in the configuration.
auth_modules/1	Return the list of authenticated modules for a given host.
check_password/3	Check if the user and password can login in server.
check_password/5	Check if the user and password can login in server.
check_password_loop/3*
check_password_with_authmodule/3	Check if the user and password can login in server.
check_password_with_authmodule/5	Check the password is valid and also return the authentication module that accepts it.
dirty_get_registered_users/0	Registered users list do not include anonymous users logged.
entropy/1	Calculate informational entropy.
get_password/2	Get the password of the user.
get_password_s/2	Get the password of the user.
get_password_with_authmodule/2	Get the password of the user and the auth module.
get_vh_registered_users/1	Registered users list do not include anonymous users logged.
get_vh_registered_users/2
get_vh_registered_users_number/1
get_vh_registered_users_number/2
is_user_exists/2	Returns true if the user exists in the DB or if an anonymous user is logged under the given name.
is_user_exists_in_other_modules/3	Check if the user exists in all authentications module except the module passed as parameter.
is_user_exists_in_other_modules_loop/3*
module_name/1*
plain_password_required/1
remove_host/1
remove_user/2	Remove user.
remove_user/3	Try to remove user if the provided password is correct.
set_password/3
start/0
start/1
start_modules/2
stop/1
stop_modules/2
store_type/1
trigger_register_hooks/3*
try_register/3

Function Details

auth_modules/0 *

auth_modules() -> [authmodule()]

Return the lists of all the auth modules actually used in the configuration.

auth_modules/1

auth_modules(Server) -> [authmodule()]

Server = string()

Return the list of authenticated modules for a given host.

check_password/3

check_password(User, Server, Password) -> bool()

User = string()
Server = string()
Password = string()

Check if the user and password can login in server.

check_password/5

check_password(User, Server, Password, Digest, DigestGen) -> bool()

User = string()
Server = string()
Password = string()
Digest = string()
DigestGen = function()

Check if the user and password can login in server.

check_password_loop/3 *

check_password_loop(AuthModules, Args, LastReason) -> any()

check_password_with_authmodule/3

check_password_with_authmodule(User::string(), Server::string(), Password::string()) -> {true, AuthModule} | {false, Reason::string()}

AuthModule = ejabberd_auth_anonymous | ejabberd_auth_external | ejabberd_auth_internal | ejabberd_auth_ldap | ejabberd_auth_odbc | ejabberd_auth_pam

Check if the user and password can login in server. The user can login if at least an authentication method accepts the user and the password. The first authentication method that accepts the credentials is returned.

check_password_with_authmodule/5

check_password_with_authmodule(User, Server, Password, Digest, DigestGen) -> {true, AuthModule} | false

User = string()
Server = string()
Password = string() | undefined
Digest = string() | undefined
DigestGen = function()
AuthModule = authmodule()

Check the password is valid and also return the authentication module that accepts it. The password is 'undefined' if the client authenticates using the digest method as defined in XEP-0078: Non-SASL Authentication

dirty_get_registered_users/0

dirty_get_registered_users() -> [{LUser, LServer}]

LUser = string()
LServer = string()

Registered users list do not include anonymous users logged.

entropy/1

entropy(IOList) -> non_negative_float()

Calculate informational entropy.

get_password/2

get_password(User, Server) -> Password | false

User = string()
Server = string()
Password = string()

Get the password of the user.

get_password_s/2

get_password_s(User, Server) -> Password | nil()

User = string()
Server = string()
Password = string()

Get the password of the user.

get_password_with_authmodule/2

get_password_with_authmodule(User, Server) -> {Password, AuthModule} | {false, none}

User = string()
Server = string()
Password = string()
AuthModule = authmodule()

Get the password of the user and the auth module.

get_vh_registered_users/1

get_vh_registered_users(Server) -> [{LUser, LServer}]

Server = string()
LUser = string()
LServer = string()

Registered users list do not include anonymous users logged.

get_vh_registered_users/2

get_vh_registered_users(Server, Opts) -> [{LUser, LServer}]

Server = string()
Opts = [{Opt, Val}]
Opt = atom()
Val = term()
LUser = string()
LServer = string()

get_vh_registered_users_number/1

get_vh_registered_users_number(Server) -> Users_Number

Server = string()
Users_Number = integer()

get_vh_registered_users_number/2

get_vh_registered_users_number(Server, Opts) -> Users_Number

Server = string()
Opts = [{Opt, Val}]
Opt = atom()
Val = term()
Users_Number = integer()

is_user_exists/2

is_user_exists(User, Server) -> bool()

User = string()
Server = string()

Returns true if the user exists in the DB or if an anonymous user is logged under the given name.

is_user_exists_in_other_modules/3

is_user_exists_in_other_modules(Module, User, Server) -> true | false | maybe

Module = authmodule()
User = string()
Server = string()

Check if the user exists in all authentications module except the module passed as parameter.

is_user_exists_in_other_modules_loop/3 *

is_user_exists_in_other_modules_loop(AuthModules, User, Server) -> any()

module_name/1 *

module_name(Method) -> any()

plain_password_required/1

plain_password_required(Server) -> bool()

Server = string()

remove_host/1

remove_host(HostB) -> any()

remove_user/2

remove_user(User, Server) -> ok | error | {error, not_allowed}

User = string()
Server = string()

Remove user.

To do

Fix me: It always return ok even if there was some problem removing the user. dialyzer warning ejabberd_auth.erl:388: The variable _ can never match since previous clauses completely covered the type 'ok'

remove_user/3

remove_user(User, Server, Password) -> ok | not_exists | not_allowed | bad_request | error

User = string()
Server = string()
Password = string()

Try to remove user if the provided password is correct. The removal is attempted in each auth method provided: when one returns 'ok' the loop stops; if no method returns 'ok' then it returns the error message indicated by the last method attempted.

set_password/3

set_password(User, Server, Password) -> ok | {error, ErrorType}

User = string()
Server = string()
Password = string()
ErrorType = empty_password | not_allowed | invalid_jid

Server = string()

trigger_register_hooks/3 *

trigger_register_hooks(Res, User, Server) -> any()

try_register/3

try_register(User, Server, Password) -> {atomic, ok} | {atomic, exists} | {error, not_allowed}

User = string()
Server = string()
Password = string() | nil()

Generated by EDoc, May 23 2012, 07:15:17.