plugin

Required.

disable_roles

encryption_algorithm

Defaults to 'SHA-512';

match_password $given, $correct

encrypt_password $password

required methods

•

authenticate_user $username, $password

If either of $username or $password are undefined then die.

Return true on success.

optional methods

• get_user_details $username

  Die if $username is undefined. Otherwise return a user object (if appropriate) or a hash reference of user details.

• get_user_roles $username

  Die if $username is undefined. Otherwise return an array reference of user roles.

• create_user %user

  Create user with fields specified in %user.

  Method should croak if "username" key is empty or undefined. If a user with the specified username already exists then we would normally expect the method to die though this is of course dependent on the backend in use.

  The new user should be returned.

• get_user_by_code $code

  Try to find a user which has "pw_reset_code" field set to $code.

  Returns the user on success.

• set_user_details $username, %update

  Update user with $username according to %update.

  Passing an empty or undefined $username should cause the method to die.

  The update user should be returned.

• set_user_password $username, $password

  Set the password for the user specified by $username to <$password> encrypted using "encrypt_password" or via whatever other method is appropriate for the backend.

• password_expired $user

  The $user should be as returned from "get_user_details". The method checks whether the user's password has expired and returns 1 if it has and 0 if it has not.