NAME

Mojolicious::Plugin::DigestAuth - HTTP Digest Authentication for Mojolicious

SYNOPSIS

   use Mojolicious::Lite;

   plugin 'digest_auth';

   get '/admin/users' => sub {
       my $self = shift;
       return unless $self->digest_auth(realm => 'Thangz',
                                        allow => '/some/file/htdigest_formated');

       # ...
   }

   # Setup with user-defined defaults
   plugin 'digest_auth',
           realm => 'My Realm',
           expires => 120,
           algorithm => 'MD5-sess',
           allow => {   
             # Will use 'My Realm'
             sshaw => 'Ay3Br4h_!',
             bob   => 'lovemywife'
           };

   get '/account/edit' => sub { 
       my $self = shift;
       return unless $self->digest_auth;

       # ...
   }

   # Override some of the defaults here
   get '/' => sub { 
       my $self = shift;
       return unless $self->digest_auth(realm => 'RealmX',
                                        qop   => 'auth',
                                        algorithm => 'MD5,
                                        allow => { 
                                          RealmX => { user => 'password' }
                                       });

       # ...
   }
  
   # Setup authentication for a set of of routes
   package YourApp;

   use Mojo::Base 'Mojolicious';
    
   sub startup
   {
     my $self = shift;
     $self->plugin('digest_auth');

     # ...

     my $admin = $self->digest_auth('/admin',
                                    realm => 'Admin',
                                    allow => '/www/auth/admin');
     
     $admin->route('/:id')->to('users#show');
     $admin->route('/edit/:id')->to('users#edit')
   }

CONFIGURATION

Options can be set globally when loading the plugin:

   plugin 'digest_auth', %options

Or locally when calling digest_auth

    $self->digest_auth(%options);

Local options override their global counterparts.

Digest Authentication can be perfomed on a set of routes:

   sub startup
   {
     my $self = shift;
     $self->plugin('digest_auth');

     # ...

     my $admin = $self->digest_auth('/admin', %options);
     $admin->route('/edit/:id')->to('users#edit');
   }

Or from within an action:

   sub some_action
   {
       my $self = shift;
       return unless $self->digest_auth(realm => 'RealmX',
                                        allow => { 
                                          RealmX => { user => 'password' }
                                       });
   }   

METHODS

digest_auth

   $self->digest_auth(allow => { bob => 'password' });

   # or

   my $r = $self->digest_auth('/admin', allow => { bob => 'password' });
   $r->route('/new')->to('users#new');

Arguments

An optional URL prefix and/or an option hash

...more to come...

Returns

Without a URL prefix:

1 if authentication was successful, undef otherwise.

With a URL prefix:

An instance of Mojolicious::Routes. Use this to define a set of actions to authenticate against. In this case authentication is performed via a "bridge" in Mojolicious::Routes.

Errors

Will croak if any of the options are invalid.

SEE ALSO

Mojolicious, Mojolicious::Plugin::BasicAuth

AUTHOR

(C) 2011 Skye Shaw (sshaw AT lucas.cis.temple.edu)

LICENSE

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

cpanm Mojolicious::Plugin::DigestAuth

perl -MCPAN -e shell
install Mojolicious::Plugin::DigestAuth