File: README

package info (click to toggle)
libauthen-simple-dbi-perl 0.2-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid, stretch
  • size: 100 kB
  • ctags: 6
  • sloc: perl: 110; sql: 12; makefile: 3
file content (83 lines) | stat: -rw-r--r-- 2,272 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
73
74
75
76
77
78
79
80
81
82
83
NAME
    Authen::Simple::DBI - Simple DBI authentication

SYNOPSIS
        use Authen::Simple::DBI;
    
        my $dbi = Authen::Simple::DBI->new(
            dsn       => 'dbi:SQLite:dbname=database.db',
            statement => 'SELECT password FROM users WHERE username = ?'
        );
    
        if ( $dbi->authenticate( $username, $password ) ) {
            # successfull authentication
        }
    
        # or as a mod_perl Authen handler

        PerlModule Apache::DBI
        PerlModule Authen::Simple::Apache
        PerlModule Authen::Simple::DBI

        PerlSetVar AuthenSimpleDBI_dsn       "dbi:SQLite:dbname=database.db"
        PerlSetVar AuthenSimpleDBI_statement "SELECT password FROM users WHERE username = ?"

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

DESCRIPTION
    DBI authentication.

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

        * dsn   Database Source Name. Required.

                    dsn => 'dbi:SQLite:dbname=database.db'
                    dsn => 'dbi:mysql:database=database;host=localhost;'

        * statement
                SQL statement. The statement must take a single string
                argument (username) and return a single value (password).
                Required.

                    statement => 'SELECT password FROM users WHERE username = ?'

        * username
                Database username.

                    username => 'username'
    
        * password
                Database password.

                    password => 'secret'

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

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

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

SEE ALSO
    Authen::Simple.

    Authen::Simple::Password.

    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.