package Mojolicious::Plugin::BasicAuth;
use strict;
use warnings;
use Mojo::ByteStream;
our $VERSION = '0.06';
use base 'Mojolicious::Plugin';
sub register {
my ($plugin, $app) = @_;
$app->renderer->add_helper(
basic_auth => sub {
my $self = shift;
#
# Sent Credentials
my $auth = $self->req->url->to_abs->userinfo || '';
# Required credentials
my ($realm, $password, $username) = $plugin->_expected_auth(@_);
my $callback = $password if ref $password eq 'CODE';
# No credentials entered
return $plugin->_password_prompt($self, $realm)
if !$auth and !$callback;
# Verification within callback
return 1 if $callback and $callback->(split /:/, $auth, 2);
# Verified with realm => username => password syntax
return 1 if $auth eq ($username || '') . ":$password";
# Not verified
return $plugin->_password_prompt($self, $realm);
}
);
}
sub _expected_auth {
my $self = shift;
my $realm = shift;
return @$realm{qw/ realm password username /} if ref $realm eq "HASH";
# realm, pass, user || realm, pass, undef || realm, callback
return $realm, reverse @_;
}
sub _password_prompt {
my ($self, $c, $realm) = @_;
$c->res->headers->www_authenticate("Basic realm=$realm");
$c->res->code(401);
$c->rendered;
return;
}
1;
__END__
=head1 NAME
Mojolicious::Plugin::BasicAuth - Basic HTTP Auth Helper
=head1 DESCRIPTION
L<Mojolicous::Plugin::BasicAuth> is a helper for basic http authentication.
=head1 USAGE
use Mojolicious::Lite;
plugin 'basic_auth';
get '/' => sub {
my $self = shift;
return $self->render_text('ok')
if $self->basic_auth(
realm => sub { return 1 if "@_" eq 'username password' }
);
};
app->start;
=head1 METHODS
L<Mojolicious::Plugin::BasicAuth> inherits all methods from
L<Mojolicious::Plugin> and implements the following new ones.
=head2 C<register>
$plugin->register;
Register condition in L<Mojolicious> application.
=head1 SEE ALSO
L<Mojolicious>
=head1 DEVELOPMENT
L<http://github.com/tempire/mojolicious-plugin-basicauth>
=head1 VERSION
0.06
=head1 CREDITS
=over 4
=item Kirill Miazine
=back
=head1 AUTHOR
Glen Hinkle tempire@cpan.org
=cut