File: README

package info (click to toggle)
libauthen-simple-cdbi-perl 0.2-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid, stretch
  • size: 100 kB
  • ctags: 8
  • sloc: perl: 99; sql: 12; makefile: 3
file content (72 lines) | stat: -rw-r--r-- 1,782 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
NAME
    Authen::Simple::CDBI - Simple Class::DBI authentication

SYNOPSIS
        use Authen::Simple::CDBI;
    
        my $cdbi = Authen::Simple::CDBI->new(
            class => 'MyApp::Model::User'
        );
    
        if ( $cdbi->authenticate( $username, $password ) ) {
            # successfull authentication
        }
    
        # or as a mod_perl Authen handler

        PerlModule Authen::Simple::Apache
        PerlModule Authen::Simple::CDBI

        PerlSetVar AuthenSimpleDBI_class "MyApp::Model::User"

        <Location /protected>
          PerlAuthenHandler Authen::Simple::CDBI
          AuthType          Basic
          AuthName          "Protected Area"
          Require           valid-user
        </Location>

DESCRIPTION
    Class::DBI authentication.

METHODS
    * new
        This method takes a hash of parameters. The following options are
        valid:

        * class Class::DBI subclass. Required.

                    class => 'MyApp::Model::User'

        * username
                Name of "username" column. Defaults to "username".

                    username => 'username'
    
        * password
                Name of "password" column. Defaults to "password".

                    password => 'password'

        * log   Any object that supports "debug", "info", "error" and
                "warn".

                    log => Log::Log4perl->get_logger('Authen::Simple::CDBI')

    * authenticate( $username, $password )
        Returns true on success and false on failure.

SEE ALSO
    Authen::Simple.

    Authen::Simple::Password.

    Class::DBI.

AUTHOR
    Christian Hansen "ch@ngmedia.com"

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