7 Catalyst::Authentication::Store::Htpasswd - Authen::Htpasswd based user storage/authentication
21 default_realm => 'test',
26 password_field => 'password',
27 password_type => 'self_check',
39 my ( $self, $c ) = @_;
41 $c->authenticate({ username => $c->req->param("login"), password => $c->req->param("password") });
46 This plugin uses L<Authen::Htpasswd> to let your application use C<<.htpasswd>>
47 files for it's authentication storage.
53 Simple constructor, dies if the htpassword file can't be found
57 Looks up the user, and returns a Catalyst::Authentication::Store::Htpasswd::User object.
61 Delegates to L<Catalyst::Authentication::Store::Htpasswd::User->user_supports|Catalyst::Authentication::Store::Htpasswd::User#user_supports>
65 Delegates the user lookup to C<< find_user >>
71 The path to the htpasswd file. If the path starts with a slash, then it is assumed to be a fully
72 qualified path, otherwise the path is fed through C<< $c->path_to >> and so normalised to the
75 Alternatively, it is possible to pass in an L<Authen::Htpasswd> object here, and this will be
76 used as the htpasswd file.
80 Change the user class which this store returns. Defaults to L<Catalyst::Authentication::Store::Htpasswd::User>.
81 This can be used to add additional functionality to the user class by sub-classing it, but will not normally be
86 Change the field that the username is found in in the information passed into the call to C<< $c->authenticate() >>.
88 This defaults to I< username >, and generally you should be able to use the module as shown in the synopsis, however
89 if you need a different field name then this setting can change the default.
93 __PACKAGE__->config( authentication => { realms => { test => {
96 user_field => 'email_address',
100 $c->authenticate({ email_address => $c->req->param("email"), password => $c->req->param("password") });
108 Bugs may be submitted through L<the RT bug tracker|https://rt.cpan.org/Public/Dist/Display.html?Name=Catalyst-Authentication-Store-Htpasswd>
109 (or L<bug-Catalyst-Authentication-Store-Htpasswd@rt.cpan.org|mailto:bug-Catalyst-Authentication-Store-Htpasswd@rt.cpan.org>).
111 There is also a mailing list available for users of this distribution, at
112 L<http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst>.
114 There is also an irc channel available for users of this distribution, at
115 L<C<#catalyst> on C<irc.perl.org>|irc://irc.perl.org/#catalyst>.
119 יובל קוג'מן (Yuval Kogman) <nothingmuch@woobling.org>
123 =for stopwords David Kamholz Tomas Doran Karen Etheridge Tom Bloor Ilmari Vacklin
129 David Kamholz <dkamholz@cpan.org>
133 Tomas Doran <bobtfish@bobtfish.net>
137 Karen Etheridge <ether@cpan.org>
141 Tom Bloor <t.bloor@shadowcat.co.uk>
145 Ilmari Vacklin <ilmari.vacklin@cs.helsinki.fi>
149 =head1 COPYRIGHT AND LICENCE
151 This software is copyright (c) 2005 by יובל קוג'מן (Yuval Kogman).
153 This is free software; you can redistribute it and/or modify it under
154 the same terms as the Perl 5 programming language system itself.