Module z_authentication_tokens

Authentication tokens and cookies.

Copyright © 2019-2020 Marc Worrell

Authors: Marc Worrell (marc@worrell.nl).

Description

Authentication tokens and cookies.

Function Index

autologon_expires/1
decode_auth_token/2
decode_autologon_token/2
decode_onetime_token/2
encode_auth_token/3
encode_autologon_token/2
encode_onetime_token/2
encode_onetime_token/3
ensure_auth_cookie/1
refresh_auth_cookie/2
req_auth_cookie/1Check the request for an authentication cookie.
req_autologon_cookie/1Check the request for an automatic logon cookie.
reset_auth_cookie/1
reset_autologon_cookie/1
reset_cookies/1
session_expires/1
set_auth_cookie/3
set_autologon_cookie/2

Function Details

autologon_expires/1

autologon_expires(Context::z:context()) -> integer()

decode_auth_token/2

decode_auth_token(AuthCookie::binary(), Context::z:context()) -> {ok, {m_rsc:resource_id() | undefined, map(), integer()}} | {error, term()}

decode_autologon_token/2

decode_autologon_token(AutoLogonCookie::binary(), Context::z:context()) -> {ok, m_rsc:resource_id()} | {error, term()}

decode_onetime_token/2

decode_onetime_token(OnetimeToken::binary(), Context::z:context()) -> {ok, m_rsc:resource_id()} | {error, term()}

encode_auth_token/3

encode_auth_token(UserId::m_rsc:resource_id() | undefined, Options::map(), Context::z:context()) -> binary()

encode_autologon_token/2

encode_autologon_token(UserId::m_rsc:resource_id(), Context::z:context()) -> binary()

encode_onetime_token/2

encode_onetime_token(UserId::m_rsc:resource_id(), Context::z:context()) -> {ok, binary()} | {error, no_session}

encode_onetime_token/3

encode_onetime_token(UserId::m_rsc:resource_id(), SId::binary() | undefined, Context::z:context()) -> {ok, binary()} | {error, no_session}

ensure_auth_cookie/1

ensure_auth_cookie(Context::z:context()) -> z:context()

refresh_auth_cookie/2

refresh_auth_cookie(RequestOptions::map(), Context::z:context()) -> z:context()

req_auth_cookie/1

req_auth_cookie(Context::z:context()) -> z:context()

Check the request for an authentication cookie. If valid then logon the user in the user context.

req_autologon_cookie/1

req_autologon_cookie(Context::z:context()) -> z:context()

Check the request for an automatic logon cookie. If valid then logon the user in the user context and set an auth cookie.

reset_auth_cookie/1

reset_auth_cookie(Context::z:context()) -> z:context()

reset_autologon_cookie/1

reset_autologon_cookie(Context::z:context()) -> z:context()

reset_cookies/1

reset_cookies(Context::z:context()) -> z:context()

session_expires/1

session_expires(Context::z:context()) -> integer()

set_auth_cookie/3

set_auth_cookie(UserId::m_rsc:resource_id() | undefined, AuthOptions::map(), Context::z:context()) -> z:context()

set_autologon_cookie/2

set_autologon_cookie(UserId::m_rsc:resource_id(), Context::z:context()) -> z:context()


Generated by EDoc