Authen...::CDBI(3pm)

✨ Authen::Simple::CDBI ✨

okay bestie, sit down, hydrate, and let me tell you about Authen::Simple::CDBI 💖 — it's the 3pm manual page for a little module that does Class::DBI authentication. Simple. Clean. Iconic. It's giving "I just want to log someone in, please stop making it weird." 💅

---

🌸 NAME 🌸

Authen::Simple::CDBI — literally just Simple Class::DBI authentication, no notes 🎀

---

🦋 SYNOPSIS 🦋

here's the vibe, copy-paste core 🫶

use Authen::Simple::CDBI;

my $cdbi = Authen::Simple::CDBI->new(
    class => 'MyApp::Model::User'
);

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

# or as a mod_perl Authen handler

PerlModule Authen::Simple::Apache
PerlModule Authen::Simple::CDBI

PerlSetVar AuthenSimpleDBI_class "MyApp::Model::User"

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

bestie the PerlSetVar AuthenSimpleDBI_class line is exactly what the page says, so don't go "fixing" it, okay? copy it character for character or it's not gonna hit the same 💀

---

🌈 DESCRIPTION 🌈

Class::DBI authentication. that's the whole description. short queen. she said what she said 👑

---

💅 METHODS 💅

🌟 new

this method takes a hash of parameters, and honestly the options are:

• class — your Class::DBI subclass. Required. like, you genuinely cannot skip this one, it's the main character ✨

class => 'MyApp::Model::User'

• username — the name of your "username" column. defaults to "username" 🍓

username => 'username'

• password — the name of your "password" column. defaults to "password" 🔐

password => 'password'

• log — any object that supports "debug", "info", "error" and "warn" 📝

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

---

🌟 authenticate( $username, $password )

returns true on success and false on failure. that's it. that's the whole contract. she's not complicated, she's just correct 💖

---

🎀 SEE ALSO 🎀

• Authen::Simple.
• Authen::Simple::Password.
• Class::DBI.

go read them, iykyk 📚✨

---

👑 AUTHOR 👑

Christian Hansen ch@ngmedia.com — thank you for your service, legend 🫶

---

⭐ COPYRIGHT ⭐

this program is free software, you can redistribute it and/or modify it under the same terms as Perl itself. slay, open source queen 💜

---

perl v5.34.0 · 2022-06-08 — that's the version and date this page shipped with, mwah, go forth and authenticate responsibly 🌸💖🦋