man CGI::Application::Plugin::Authentication::Display::Classic (3): login box that works out of the box

VERSION

This document describes CGI::Application::Plugin::Authentication::Display::Classic version 0.20

DESCRIPTION

This module provides a login box that works out of the box but which can be configured to modify the styling.

METHODS

new

The constructor must be passed the CGI::Application object as the first non-object argument.

login_box

This method will return the HTML for a login box that can be embedded into another page. This is the same login box that is used in the default authen_login runmode that the plugin provides.

You can set this option to customize the login form that is created when a user needs to be authenticated. If you wish to replace the entire login form with a completely custom version, then just set LOGIN_RUNMODE to point to your custom runmode.

All of the parameters listed below are optional, and a reasonable default will be used if left blank:

TITLE (default: Sign In): the heading at the top of the login box
USERNAME_LABEL (default: User Name): the label for the user name input
PASSWORD_LABEL (default: Password): the label for the password input
SUBMIT_LABEL (default: Sign In): the label for the submit button
COMMENT (default: Please enter your username and password in the fields below.): a message provided on the first login attempt
REMEMBERUSER_OPTION (default: 1): provide a checkbox to offer to remember the users name in a cookie so that their user name will be pre-filled the next time they log in
REMEMBERUSER_LABEL (default: Remember User Name): the label for the remember user name checkbox
REMEMBERUSER_COOKIENAME (default: CAPAUTHTOKEN): the name of the cookie where the user name will be saved
REGISTER_URL (default: <none>): the URL for the register new account link
REGISTER_LABEL (default: Register Now!): the label for the register new account link
FORGOTPASSWORD_URL (default: <none>): the URL for the forgot password link
FORGOTPASSWORD_LABEL (default: Forgot Password?): the label for the forgot password link
INVALIDPASSWORD_MESSAGE (default: Invalid username or password<br />(login attempt %d): a message given when a login failed
INCLUDE_STYLESHEET (default: 1): use this to disable the built in style-sheet for the login box so you can provide your own custom styles
FORM_SUBMIT_METHOD (default: post): use this to get the form to submit using 'get' instead of 'post'
FOCUS_FORM_ONLOAD (default: 1): use this to automatically focus the login form when the page loads so a user can start typing right away.
BASE_COLOUR (default: #445588): This is the base colour that will be used in the included login box. All other colours are automatically calculated based on this colour (unless you hardcode the colour values). In order to calculate other colours, you will need the Color::Calc module. If you do not have the Color::Calc module, then you will need to use fixed values for all of the colour options. All colour values besides the BASE_COLOUR can be simple percentage values (including the % sign). For example if you set the LIGHTER_COLOUR option to 80%, then the calculated colour will be 80% lighter than the BASE_COLOUR.
LIGHT_COLOUR (default: 50% or #a2aac4): A colour that is lighter than the base colour.
LIGHTER_COLOUR (default: 75% or #d0d5e1): A colour that is another step lighter than the light colour.
DARK_COLOUR (default: 30% or #303c5f): A colour that is darker than the base colour.
DARKER_COLOUR (default: 60% or #1b2236): A colour that is another step darker than the dark colour.
GREY_COLOUR (default: #565656): A grey colour that is calculated by desaturating the base colour.

  LOGIN_FORM => {
    TITLE              => 'Login',
    SUBMIT_LABEL       => 'Login',
    REMEMBERUSER_LABEL => 1,
    BASE_COLOUR        => '#0099FF',
    LIGHTER_COLOUR     => '#AAFFFF',
    DARK_COLOUR        => '50%',
  }

BUGS

This is alpha software and as such, the features and interface are subject to change. So please check the Changes file when upgrading.

AUTHOR

Author: Cees Hek <[email protected]>; Co-maintainer: Nicholas Bamber <[email protected]>.

CREDITS

Thanks to SiteSuite (http://www.sitesuite.com.au) for funding the development of this plugin and for releasing it to the world.

Thanks to Christian Walde for suggesting changes to fix the incompatibility with CGI::Application::Plugin::ActionDispatch and for help with github.

LICENCE AND COPYRIGHT

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.