API Reference YipyipExAuth v0.3.0-alpha.1
Modules
Config struct. Keys :session_ttl
, :refresh_token_ttl
and :session_store_module
have no defaults and are mandatory.
Setting :session_ttl
to nil
means sessions can live forever, as long as they are refreshed.
The token salts serve to separate one token from another, the real secret is the endpoint's secret key base.
Defaults
A session.
Tokens to be communicated to the client.
Function plugs to create and delete sessions. upsert_session/3
can be used in combination with YipyipExAuth.Plugs.ProcessRefreshToken
for token refreshing.
Plug to process and verify access tokens. Must be initialized with a YipyipExAuth.Config
-struct, which can be initialized itself using YipyipExAuth.Config.from_enum/1
.
Plug to process and verify refresh tokens. Must be initialized with a YipyipExAuth.Config
-struct, which can be initialized itself using YipyipExAuth.Config.from_enum/1
.
Behaviour definition of a persistent session store, to be implemented by the application. The implementation is expected to handle cleanup of expired entries.
Helper functions for generating "valid" tokens for testing purposes.
Utility functions, mainly getters and setters for module internals.