.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" 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 .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Catalyst::Authentication::Store::Htpasswd 3pm" .TH Catalyst::Authentication::Store::Htpasswd 3pm "2018-09-22" "perl v5.26.2" "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" Catalyst::Authentication::Store::Htpasswd \- Authen::Htpasswd based user storage/authentication .SH "VERSION" .IX Header "VERSION" version 1.006 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& use Catalyst qw/ \& Authentication \& /; \& \& _\|_PACKAGE_\|_\->config( \& authentication => { \& default_realm => \*(Aqtest\*(Aq, \& realms => { \& test => { \& credential => { \& class => \*(AqPassword\*(Aq, \& password_field => \*(Aqpassword\*(Aq, \& password_type => \*(Aqself_check\*(Aq, \& }, \& store => { \& class => \*(AqHtpasswd\*(Aq, \& file => \*(Aqhtpasswd\*(Aq, \& }, \& }, \& }, \& }, \& ); \& \& sub login : Global { \& my ( $self, $c ) = @_; \& \& $c\->authenticate({ username => $c\->req\->param("login"), password => $c\->req\->param("password") }); \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This plugin uses Authen::Htpasswd to let your application use \f(CW\*(C`.htpasswd\*(C'\fR files for it's authentication storage. .SH "METHODS" .IX Header "METHODS" .SS "new" .IX Subsection "new" Simple constructor, dies if the htpassword file can't be found .SS "find_user" .IX Subsection "find_user" Looks up the user, and returns a Catalyst::Authentication::Store::Htpasswd::User object. .SS "user_supports" .IX Subsection "user_supports" Delegates to Catalyst::Authentication::User\->supports or an override in user_class. .SS "from_session" .IX Subsection "from_session" Delegates the user lookup to find_user .SH "CONFIGURATION" .IX Header "CONFIGURATION" .SS "file" .IX Subsection "file" The path to the htpasswd file. If the path starts with a slash, then it is assumed to be a fully qualified path, otherwise the path is fed through \f(CW\*(C`$c\->path_to\*(C'\fR and so normalised to the application root. .PP Alternatively, it is possible to pass in an Authen::Htpasswd object here, and this will be used as the htpasswd file. .SS "user_class" .IX Subsection "user_class" Change the user class which this store returns. Defaults to Catalyst::Authentication::Store::Htpasswd::User. This can be used to add additional functionality to the user class by sub-classing it, but will not normally be needed. .SS "user_field" .IX Subsection "user_field" Change the field that the username is found in in the information passed into the call to \f(CW\*(C`$c\->authenticate()\*(C'\fR. .PP This defaults to \fI username \fR, and generally you should be able to use the module as shown in the synopsis, however if you need a different field name then this setting can change the default. .PP Example: .PP .Vb 8 \& _\|_PACKAGE_\|_\->config( authentication => { realms => { test => { \& store => { \& class => \*(AqHtpasswd\*(Aq, \& user_field => \*(Aqemail_address\*(Aq, \& }, \& }}}); \& # Later in your code \& $c\->authenticate({ email_address => $c\->req\->param("email"), password => $c\->req\->param("password") }); .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" Authen::Htpasswd. .SH "SUPPORT" .IX Header "SUPPORT" Bugs may be submitted through the \s-1RT\s0 bug tracker (or bug\-Catalyst\-Authentication\-Store\-Htpasswd@rt.cpan.org ). .PP There is also a mailing list available for users of this distribution, at . .PP There is also an irc channel available for users of this distribution, at \&\f(CW\*(C`#catalyst\*(C'\fR on \f(CW\*(C`irc.perl.org\*(C'\fR . .SH "AUTHOR" .IX Header "AUTHOR" \&\s-1XXXX XXX\s0'\s-1XX\s0 (Yuval Kogman) .SH "CONTRIBUTORS" .IX Header "CONTRIBUTORS" .IP "\(bu" 4 David Kamholz .IP "\(bu" 4 Tomas Doran .IP "\(bu" 4 Karen Etheridge .IP "\(bu" 4 Tom Bloor .IP "\(bu" 4 Christopher Hoskin .IP "\(bu" 4 Ilmari Vacklin .SH "COPYRIGHT AND LICENCE" .IX Header "COPYRIGHT AND LICENCE" This software is copyright (c) 2005 by \s-1XXXX XXX\s0'\s-1XX\s0 (Yuval Kogman). .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.