Authen...le::FTP(3pm)

💖 Authen::Simple::FTP 💖

okay so bestie, welcome to Authen::Simple::FTP — she's a little Perl module that does Simple FTP authentication and honestly? she ate. no cap. this is from the User Contributed Perl Documentation crew and she's here to vibe check your users against an FTP server. 💅

---

✨ SYNOPSIS ✨

the way you just drop her in like this:

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>

(yes, # successfull authentication — that's literally how it's spelled in the source, we do not edit the queen's comments 🫶)

---

🌸 DESCRIPTION 🌸

Authenticate against a FTP service. that's it, that's the whole girl. she takes a username and a password, she goes and asks the FTP server if they're valid, and she comes back with an answer. lowkey iconic, highkey useful. ✨

---

🎀 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. that's the whole contract bestie, she's not gonna be mysterious about it. 💖

---

🔥 SEE ALSO 🔥

• Authen::Simple.
• Net::FTP.

go read those too, they're the supporting cast and they understood the assignment. 👑

---

👑 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.

---

periodt. 💅✨

---

that's the whole page bestie — she's from perl v5.34.0, dated 2022-06-08, living in the User Contributed Perl Documentation section as Authen::Simple::FTP(3pm). go forth and authenticate, ily, bye! 🦋🌸🎀