API Reference Haytni v0.7.0

Documentation for Haytni.

This is a base plugin as it handles basic informations of a user (which are email and hashed password) and their authentication.

The only purpose of this plugin is to handle the HTTP Clear-Site-Data header for you.

This plugin ensure that email addresses given by users are valid by sending them an email containing an unique token that they have to return back in order to really be able to use (unlock) their account.

Regroup various helper functions that are not directly tied to the web part (mostly for plugins use but not in controllers, views or templates).

This plugin provides the feature of registration on invitation or sponsorship.

This module provides some basic helpers to query invitations to be independant and not have to know the internals of the Invitable plugin.

This module "replace" the _csrf_token generated by Phoenix, if you can't use it (mainly because of caching), to recognize the current authenticated user in channels and, by extension, live view since access to session through websocket rely on this _csrf_token. To do so, this module provides a controller to deliver short lived ciphered and signed token which you request in Javascript (ajax is the main way) and send it back to the server for the websocket connection. Then, Haytni will set the current user for the websocket when you call connect/4 from your Phoenix.Socket.connect/3 callback (channels) and mount_user/4 from your c:Phoenix.LiveView.mount/3 (live view).

This plugin locks an account after a specified number of failed sign-in attempts. User can unlock its account via email and/or after a specified time period.

An intermediate to easily create a Bamboo email in a Phoenix way.

Regroup various helper functions specifically used by migrations

Convenient functions to build the params Map (parameters for the HTTP request) in tests

This plugin provides a basic password policy based on its length and its content (character types). If you are looking for a more advanced policy you'll probably want to disable this plugin and write your own.

Defines a plugin to be used by Haytni

This plugin allows the user to reset its password if he forgot it. To do so, its email addresse (default) is asked to him then an unique token is generated and send to its mailbox. This mail contains a link to activate where a new password will be requested to override the previous one.

This plugin allows the user to register and edit their account.

This plugin makes artificialy last user's authentication by creating a cookie which stores a token for remembering the user.

This module handles generation of tokens for the use of Haytni's plugins.

This module keeps tracks of the following elements

This module provides some basic helpers to query connections to be independant and not have to know the internals of the Trackable plugin.

Contains shared stuffs between Haytni base plugins.