NAME

Authen::Simple::FTP - Simple FTP authentication

SYNOPSIS

use Authen::Simple::FTP;

my $ftp = Authen::Simple::FTP->new( 
    host => 'ftp.company.com'
);

if ( $ftp->authenticate( $username, $password ) ) {
    # successfull authentication
}

# or as a mod_perl Authen handler

PerlModule Authen::Simple::Apache
PerlModule Authen::Simple::FTP

PerlSetVar AuthenSimpleFTP_host "ftp.company.com"

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

DESCRIPTION

Authenticate against a FTP service.

METHODS

• new

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

  • host

    Connection host, can be a hostname or IP number. Defaults to localhost.

    host => 'ftp.company.com'
    host => '10.0.0.1'

  • port

    Connection port, default to 21.

    port => 21

  • timeout

    Connection timeout, defaults to 60.

    timeout => 60

  • log

    Any object that supports debug, info, error and warn.

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

• authenticate( $username, $password )

  Returns true on success and false on failure.

SEE ALSO

Authen::Simple.

Net::FTP.

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.