NAME

Dancer2::Plugin::Auth::Extensible::Example - example authentication provider

DESCRIPTION

This class is intended as an example of what an authentication provider class should do. It is not intended for serious use (clearly).

See Dancer2::Plugin::Auth::Extensible for details on how to use the authentication framework, including how to pick a more useful authentication provider.

However, if you just want to test the framework, or want an example to work from to build your own authentication provider class, this may be of use.

Class methods

users

Returns hash reference with example users.

authenticate_user

Given the username and password entered by the user, return true if they are authenticated, or false if not.

get_user_details

Given a username, return details about the user. The details returned will vary depending on the provider; some providers may be able to return various data about the user, some may not, depending on the authentication source.

Details should be returned as a hashref.

get_user_roles

Given a username, return a list of roles that user has.