Module ejabberd_auth_anonymous [erl svg]

Function Index

allow_anonymous/1Return true if anonymous is allowed for host or false otherwise.
allow_multiple_connections/1Return true if multiple connections have been allowed in the config file.
anonymous_protocol/1*Return the anonymous protocol to use: sasl_anon|login_anon|both.
anonymous_user_exist/2Check if user exist in the anonymous database.
check_password/3When anonymous login is enabled, check the password for permenant users before allowing access.
check_password/5
dirty_get_registered_users/0
get_password/2Return password of permanent user or false for anonymous users.
get_password/3
get_vh_registered_users/1
is_login_anonymous_enabled/1Return true if anonymous login is enabled on the server.
is_sasl_anonymous_enabled/1Return true if anonymous mode is enabled and if anonymous protocol is SASL anonymous.
is_user_exists/2Returns true if the user exists in the DB or if an anonymous user is logged under the given name.
login/2
plain_password_required/0
purge_hook/3*Launch the hook to purge user data only for anonymous users.
register_connection/3Register connection.
remove_connection/3*Remove connection from Mnesia tables.
remove_user/2
remove_user/3
set_password/3When anonymous login is enabled, check that the user is permanent before changing its password.
start/1Create the anonymous table if at least one virtual host has anonymous features enabled.
stop/1
store_type/0
try_register/3When anonymous login is enabled, check if permanent users are allowed on the server:.
unregister_connection/3Remove an anonymous user from the anonymous users table.
update_tables/0*

Function Details

allow_anonymous/1

allow_anonymous(Host) -> bool()

Return true if anonymous is allowed for host or false otherwise.

allow_multiple_connections/1

allow_multiple_connections(Host) -> bool()

Return true if multiple connections have been allowed in the config file. defaults to false

anonymous_protocol/1 *

anonymous_protocol(Host) -> sasl_anon | login_anon | both

Return the anonymous protocol to use: sasl_anon|login_anon|both. defaults to login_anon

anonymous_user_exist/2

anonymous_user_exist(User, Server) -> bool()

Check if user exist in the anonymous database.

check_password/3

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

When anonymous login is enabled, check the password for permenant users before allowing access.

check_password/5

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

dirty_get_registered_users/0

dirty_get_registered_users() -> nil()

get_password/2

get_password(User, Server) -> Password | false

Return password of permanent user or false for anonymous users.

get_password/3

get_password(User, Server, DefaultValue) -> DefaultValue | false

get_vh_registered_users/1

get_vh_registered_users(Server) -> nil()

is_login_anonymous_enabled/1

is_login_anonymous_enabled(Host) -> bool()

Return true if anonymous login is enabled on the server. anonymous login can be use using standard authentication method (i.e. with clients that do not support anonymous login)

is_sasl_anonymous_enabled/1

is_sasl_anonymous_enabled(Host) -> bool()

Return true if anonymous mode is enabled and if anonymous protocol is SASL anonymous. protocol can be: sasl_anon|login_anon|both

is_user_exists/2

is_user_exists(User, Server) -> bool()

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

login/2

login(User, Server) -> bool()

plain_password_required/0

plain_password_required() -> bool()

purge_hook/3 *

purge_hook(X1::bool(), LUser, LServer) -> term()

Launch the hook to purge user data only for anonymous users.

register_connection/3

register_connection(SID, JID, Info) -> term()

Register connection.

remove_connection/3 *

remove_connection(SID, LUser, LServer) -> term()

Remove connection from Mnesia tables.

remove_user/2

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

remove_user/3

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

set_password/3

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

When anonymous login is enabled, check that the user is permanent before changing its password.

start/1

start(Host) -> ok

Create the anonymous table if at least one virtual host has anonymous features enabled. Register to login / logout events.

stop/1

stop(Host) -> any()

store_type/0

store_type() -> any()

try_register/3

try_register(User, Server, Password) -> {error, not_allowed}

When anonymous login is enabled, check if permanent users are allowed on the server:

unregister_connection/3

unregister_connection(SID, JID, X3::Ignored) -> term()

Remove an anonymous user from the anonymous users table.

update_tables/0 *

update_tables() -> any()


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