Class Autumn::Authentication::Base
In: lib/autumn/authentication.rb
Parent: Object

The basic subclass for all authenticators. If you wish to write your own authenticator, you must subclass this class. You must at a minimum override the authenticate method. You should also override the initialize method if you need to store any options or other data for later use.

The authentication module will become a stem listener, so see Autumn::Stem#add_listener for information on other methods you can implement.

Methods

Public Class methods

Stores the options for this authenticator and configures it for use.

Public Instance methods

Returns true if the user is authorized, false if not. sender is a sender hash as defined in the Autumn::Stem docs.

Returns a string to be displayed to a user who is not authorized to perform a command. Override this method to provide more specific hints to a user on what he can do to authorize himself (e.g., "Tell me your password").

[Validate]