File: README

package info (click to toggle)
libauthen-simple-smb-perl 0.1-4.1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 84 kB
  • sloc: perl: 45; makefile: 2
file content (71 lines) | stat: -rw-r--r-- 1,725 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
NAME
    Authen::Simple::SMB - Simple SMB authentication

SYNOPSIS
        use Authen::Simple::SMB;
    
        my $smb = Authen::Simple::SMB->new( 
            domain => 'DOMAIN', 
            pdc    => 'PDC'
        );
    
        if ( $smb->authenticate( $username, $password ) ) {
            # successfull authentication
        }
    
        # or as a mod_perl Authen handler
    
        PerlModule Authen::Simple::Apache
        PerlModule Authen::Simple::SMB

        PerlSetVar AuthenSimpleSMB_domain "DOMAIN"
        PerlSetVar AuthenSimpleSMB_pdc    "PDC"

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

DESCRIPTION
    Authenticate against an SMB server.

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

        * domain
                Domain to authenticate against. Required.

                    domain => 'NTDOMAIN'

        * pdc   Primary Domain Controller. Required.

                    pdc => 'PDC'

        * bdc   Backup Domain Controller.

                    bdc => 'BDC'

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

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

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

SEE ALSO
    Authen::Simple.

    Authen::Smb.

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.