File: README

package info (click to toggle)
libauthen-simple-passwd-perl 0.6-4.1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 120 kB
  • sloc: perl: 98; makefile: 3
file content (74 lines) | stat: -rw-r--r-- 2,123 bytes parent folder | download | duplicates (3)
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
NAME
    Authen::Simple::Passwd - Simple Passwd authentication

SYNOPSIS
        use Authen::Simple::Passwd;
    
        my $passwd = Authen::Simple::Passwd->new( 
            path => '/etc/passwd'
        );
    
        if ( $passwd->authenticate( $username, $password ) ) {
            # successfull authentication
        }
    
        # or as a mod_perl Authen handler
    
        PerlModule Authen::Simple::Apache
        PerlModule Authen::Simple::Passwd

        PerlSetVar AuthenSimplePasswd_path "/etc/passwd"

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

DESCRIPTION
    Authenticate against a passwd file.

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

        * path  Path to passwd file to authenticate against. Any standard
                passwd file that has records separated with newline and
                fields separated by ":" is supported. First field is
                expected to be username and second field, plain or encrypted
                password. Required.

                    path => '/etc/passwd'
                    path => '/var/www/.htpasswd'
    
        * flock A boolean to enable or disable the usage of "flock()".
                Defaults to "d_flock" in Config.

                    flock => 0

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

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

    * authenticate( $username, $password )
        Returns true on success and false on failure. Authentication
        attempts with a username that begins with a hyphen "-" will always
        return false.

SEE ALSO
    Authen::Simple.

    Authen::Simple::Password.

    passwd(5).

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.