z_auth (zotonic_core v1.0.0-rc.17)

Handle authentication of zotonic users. Also shows the logon screen when authentication is required.

Summary

Functions

confirm(UserId, Context)

Set the user to 'confirmed'.

is_auth(Context)

Check if the visitor has been authenticated. Assumes a completely initalized context.

is_enabled(UserId, Context)

Check if the user is enabled, a user is enabled when the rsc is published and within its publication date range.

logoff(Context)

Forget about the user being logged on.

logon(UserId, Context)

Logon a user whose id we know, set all user prefs in the context.

logon_pw(Username, Password, Context)

Logon a username/password combination, checks passwords with m_identity.

logon_redirect(UserId, Url, Context)

Logon a user and redirect the user agent. The MQTT websocket MUST be connected.

logon_switch(ToUserId, Context)

Allow an admin user to switch to another user account.

logon_switch(ToUserId, ActingUserId, Context)

Allow an admin user to switch to another user account. The ActingUserId is typically the user_id of the user that initially logged on. This is stored in the auth_options as 'sudo_user_id' and is set when performing the switch.

publish_user_session(Context)

Publish the current IP address and session-id to the sessions topic of the user. This enables tracking where users are active. This _must_ be a session initiated from a remote IP address. If no remote IP address is known then the user session is not logged.

switch_user(UserId, Context)

Request the client's auth worker to re-authenticate as a new user. The ACL for this operation is checked by z_auth:logon_switch/3, which is called by the controller_authentication when asked to make the switch.

unpublish_user_session(Context)

Remove the retained user session value, this removes the session from the overview of active sessions. Called when resetting the authentication cookies.

Functions

confirm(UserId, Context)

-spec confirm(m_rsc:resource_id(), z:context()) -> {ok, z:context()} | {error, user_not_enabled}.

Set the user to 'confirmed'.

is_auth(Context)

-spec is_auth(z:context()) -> boolean().

Check if the visitor has been authenticated. Assumes a completely initalized context.

is_enabled(UserId, Context)

-spec is_enabled(m_rsc:resource_id(), z:context()) -> boolean().

Check if the user is enabled, a user is enabled when the rsc is published and within its publication date range.

logoff(Context)

-spec logoff(z:context()) -> z:context().

Forget about the user being logged on.

logon(UserId, Context)

-spec logon(m_rsc:resource_id(), z:context()) -> {ok, z:context()} | {error, user_not_enabled}.

Logon a user whose id we know, set all user prefs in the context.

logon_pw(Username, Password, Context)

-spec logon_pw(binary(), binary(), z:context()) -> {boolean(), z:context()}.

Logon a username/password combination, checks passwords with m_identity.

logon_redirect(UserId, Url, Context)

-spec logon_redirect(m_rsc:resource_id(), binary() | undefined, z:context()) -> ok | {error, term()}.

Logon a user and redirect the user agent. The MQTT websocket MUST be connected.

logon_switch(ToUserId, Context)

-spec logon_switch(m_rsc:resource_id(), z:context()) -> {ok, z:context()} | {error, eacces}.

Allow an admin user to switch to another user account.

logon_switch(ToUserId, ActingUserId, Context)

-spec logon_switch(ToUserId, ActingUserId, Context) -> {ok, Context1} | {error, eacces}
                      when
                          ToUserId :: m_rsc:resource_id(),
                          ActingUserId :: m_rsc:resource_id(),
                          Context :: z:context(),
                          Context1 :: z:context().

Allow an admin user to switch to another user account. The ActingUserId is typically the user_id of the user that initially logged on. This is stored in the auth_options as 'sudo_user_id' and is set when performing the switch.

publish_user_session(Context)

-spec publish_user_session(Context) -> ok | {error, Reason}
                              when Context :: z:context(), Reason :: no_user | no_session | term().

Publish the current IP address and session-id to the sessions topic of the user. This enables tracking where users are active. This _must_ be a session initiated from a remote IP address. If no remote IP address is known then the user session is not logged.

switch_user(UserId, Context)

-spec switch_user(m_rsc:resource_id(), z:context()) -> ok | {error, eacces}.

Request the client's auth worker to re-authenticate as a new user. The ACL for this operation is checked by z_auth:logon_switch/3, which is called by the controller_authentication when asked to make the switch.

unpublish_user_session(Context)

-spec unpublish_user_session(Context) -> ok | {error, Reason}
                                when Context :: z:context(), Reason :: no_user | no_session | term().

Remove the retained user session value, this removes the session from the overview of active sessions. Called when resetting the authentication cookies.