.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "CGI::Application::Plugin::Authentication::Display::Classic 3pm" .TH CGI::Application::Plugin::Authentication::Display::Classic 3pm "2024-01-07" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" CGI::Application::Plugin::Authentication::Display::Classic \- login box that works out of the box .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides a login box that works out of the box but which can be configured to modify the styling. .SH "METHODS" .IX Header "METHODS" .SS "new" .IX Subsection "new" The constructor must be passed the CGI::Application object as the first non-object argument. .SS "login_box" .IX Subsection "login_box" This method will return the \s-1HTML\s0 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. .PP 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 \s-1LOGIN_RUNMODE\s0 to point to your custom runmode. .PP All of the parameters listed below are optional, and a reasonable default will be used if left blank: .IP "\s-1TITLE\s0 (default: Sign In)" 4 .IX Item "TITLE (default: Sign In)" the heading at the top of the login box .IP "\s-1USERNAME_LABEL\s0 (default: User Name)" 4 .IX Item "USERNAME_LABEL (default: User Name)" the label for the user name input .IP "\s-1PASSWORD_LABEL\s0 (default: Password)" 4 .IX Item "PASSWORD_LABEL (default: Password)" the label for the password input .IP "\s-1SUBMIT_LABEL\s0 (default: Sign In)" 4 .IX Item "SUBMIT_LABEL (default: Sign In)" the label for the submit button .IP "\s-1COMMENT\s0 (default: Please enter your username and password in the fields below.)" 4 .IX Item "COMMENT (default: Please enter your username and password in the fields below.)" a message provided on the first login attempt .IP "\s-1REMEMBERUSER_OPTION\s0 (default: 1)" 4 .IX Item "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 .IP "\s-1REMEMBERUSER_LABEL\s0 (default: Remember User Name)" 4 .IX Item "REMEMBERUSER_LABEL (default: Remember User Name)" the label for the remember user name checkbox .IP "\s-1REMEMBERUSER_COOKIENAME\s0 (default: \s-1CAPAUTHTOKEN\s0)" 4 .IX Item "REMEMBERUSER_COOKIENAME (default: CAPAUTHTOKEN)" the name of the cookie where the user name will be saved .IP "\s-1REGISTER_URL\s0 (default: )" 4 .IX Item "REGISTER_URL (default: )" the \s-1URL\s0 for the register new account link .IP "\s-1REGISTER_LABEL\s0 (default: Register Now!)" 4 .IX Item "REGISTER_LABEL (default: Register Now!)" the label for the register new account link .IP "\s-1FORGOTPASSWORD_URL\s0 (default: )" 4 .IX Item "FORGOTPASSWORD_URL (default: )" the \s-1URL\s0 for the forgot password link .IP "\s-1FORGOTPASSWORD_LABEL\s0 (default: Forgot Password?)" 4 .IX Item "FORGOTPASSWORD_LABEL (default: Forgot Password?)" the label for the forgot password link .ie n .IP "\s-1INVALIDPASSWORD_MESSAGE\s0 (default: Invalid username or password
(login attempt %d)" 4 .el .IP "\s-1INVALIDPASSWORD_MESSAGE\s0 (default: Invalid username or password
(login attempt \f(CW%d\fR)" 4 .IX Item "INVALIDPASSWORD_MESSAGE (default: Invalid username or password
(login attempt %d)" a message given when a login failed .IP "\s-1INCLUDE_STYLESHEET\s0 (default: 1)" 4 .IX Item "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 .IP "\s-1FORM_SUBMIT_METHOD\s0 (default: post)" 4 .IX Item "FORM_SUBMIT_METHOD (default: post)" use this to get the form to submit using 'get' instead of 'post' .IP "\s-1FOCUS_FORM_ONLOAD\s0 (default: 1)" 4 .IX Item "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. .IP "\s-1BASE_COLOUR\s0 (default: #445588)" 4 .IX Item "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 \s-1BASE_COLOUR\s0 can be simple percentage values (including the % sign). For example if you set the \s-1LIGHTER_COLOUR\s0 option to 80%, then the calculated colour will be 80% lighter than the \s-1BASE_COLOUR.\s0 .IP "\s-1LIGHT_COLOUR\s0 (default: 50% or #a2aac4)" 4 .IX Item "LIGHT_COLOUR (default: 50% or #a2aac4)" A colour that is lighter than the base colour. .IP "\s-1LIGHTER_COLOUR\s0 (default: 75% or #d0d5e1)" 4 .IX Item "LIGHTER_COLOUR (default: 75% or #d0d5e1)" A colour that is another step lighter than the light colour. .IP "\s-1DARK_COLOUR\s0 (default: 30% or #303c5f)" 4 .IX Item "DARK_COLOUR (default: 30% or #303c5f)" A colour that is darker than the base colour. .IP "\s-1DARKER_COLOUR\s0 (default: 60% or #1b2236)" 4 .IX Item "DARKER_COLOUR (default: 60% or #1b2236)" A colour that is another step darker than the dark colour. .IP "\s-1GREY_COLOUR\s0 (default: #565656)" 4 .IX Item "GREY_COLOUR (default: #565656)" A grey colour that is calculated by desaturating the base colour. .PP .Vb 8 \& LOGIN_FORM => { \& TITLE => \*(AqLogin\*(Aq, \& SUBMIT_LABEL => \*(AqLogin\*(Aq, \& REMEMBERUSER_LABEL => 1, \& BASE_COLOUR => \*(Aq#0099FF\*(Aq, \& LIGHTER_COLOUR => \*(Aq#AAFFFF\*(Aq, \& DARK_COLOUR => \*(Aq50%\*(Aq, \& } .Ve .SH "BUGS" .IX Header "BUGS" This is alpha software and as such, the features and interface are subject to change. So please check the Changes file when upgrading. .SH "SEE ALSO" .IX Header "SEE ALSO" CGI::Application, \fBperl\fR\|(1) .SH "AUTHOR" .IX Header "AUTHOR" Author: Cees Hek ; Co-maintainer: Nicholas Bamber . .SH "CREDITS" .IX Header "CREDITS" Thanks to SiteSuite (http://www.sitesuite.com.au) for funding the development of this plugin and for releasing it to the world. .PP Thanks to Christian Walde for suggesting changes to fix the incompatibility with CGI::Application::Plugin::ActionDispatch and for help with github. .SH "LICENCE AND COPYRIGHT" .IX Header "LICENCE AND COPYRIGHT" Copyright (c) 2005, SiteSuite. All rights reserved. Copyright (c) 2010, Nicholas Bamber. All rights reserved. .PP This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .SH "DISCLAIMER OF WARRANTY" .IX Header "DISCLAIMER OF WARRANTY" \&\s-1BECAUSE 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 \*(L"AS IS\*(R" 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.\s0 .PP \&\s-1IN 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\s0 (\s-1INCLUDING 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\s0), \s-1EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.\s0