File: README

package info (click to toggle)
libauthen-simple-http-perl 0.2-5
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid, stretch
  • size: 108 kB
  • ctags: 4
  • sloc: perl: 84; makefile: 2
file content (66 lines) | stat: -rw-r--r-- 1,681 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
NAME
    Authen::Simple::HTTP - Simple HTTP authentication

SYNOPSIS
        use Authen::Simple::HTTP;
    
        my $http = Authen::Simple::HTTP->new( 
            url => 'http://www.host.com/protected'
        );
    
        if ( $http->authenticate( $username, $password ) ) {
            # successfull authentication
        }
    
        # or as a mod_perl Authen handler
    
        PerlModule Authen::Simple::Apache
        PerlModule Authen::Simple::HTTP

        PerlSetVar AuthenSimpleHTTP_url "http://www.host.com/protected"

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

DESCRIPTION
    Authenticate against an HTTP server.

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

        * url   Url to authenticate against. Required.

                    url => 'http://www.host.com/protected'

        * agent Any object that is a subclass of LWP::UserAgent.

                    agent => LWP::UserAgent->new;

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

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

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

SEE ALSO
    Authen::Simple.

    LWP::UserAgent.

    LWPx::ParanoidAgent.

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.