CGI::A...::DBIC(3pm)

📦
version 0.25+~cs0.5 · 3 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

✨ NAME ✨

CGI::Application::Plugin::Authentication::Driver::DBIC — the DBIx::Class Authentication Driver, bestie 💖

🌸 VERSION 🌸

Version 0.02 — yes she's babygirl, yes she works

🦋 SYNOPSIS 🦋

use base qw(CGI::Application);
use CGI::Application::Plugin::Authentication;

__PACKAGE__->authen->config(
    DRIVER => [
       'DBIC',
       SCHEMA => My::DBIC->connect($dsn), # or existing $schema object
       CLASS => 'Users', # = My::DBIC::Users
       FIELD_METHODS => [qw(user MD5:passphrase)]
    ],
    CREDENTIALS => [qw(auth_username auth_password)],
);

👑 DESCRIPTION 👑

Okay so this auth driver uses the DBIx::Class module to let you authenticate against literally any DBIx::Class class. Any. Of. Them. Iconic behavior fr fr 💅

🎀 PARAMETERS 🎀

The DBIx::Class authentication driver accepts the following required parameters. Not optional. Required required. 🔥

  • SCHEMA (required) — tells the driver which DBIx::Class::Schema object to use for authentication. Heads up though: this class must be loaded prior to use. No lazy loading here, she needs her to be ready 💜
  • CLASS (required) — names the DBIx::Class class within the schema that's holding all your authentication info. That's the one, that's the girl 🫶
  • FIELD_METHODS (required) — an arrayref of the methods in the DBIx::Class class you named in CLASS, and those are the ones used during authentication. Crucial detail bestie: the order of these methods has to match the order of the CREDENTIALS. Like, they're linked. They're in a situationship. If your CREDENTIALS looks like this:
CREDENTIALS => [qw(auth_user auth_domain auth_password)]

then your FIELD_METHODS must look like this:

FIELD_METHODS => [qw(userid domain password)]

And also, FIELD_METHODS supports filters as specified by CGI::Application::Plugin::Authentication::Driver ✨

💅 METHODS 💅

verify_credentials

This method tests the credentials you handed over against the values chillin' in the database, all according to how the Driver is configured. Vibe check, but for passwords 🔐

🌈 SEE ALSO 🌈

  • CGI::Application::Plugin::Authentication::Driver
  • CGI::Application::Plugin::Authentication
  • perl(1)

💀 BUGS 💀

Please report any bugs or feature requests to bug-cgi-application-plugin-authentication-driver-dbic at rt.cpan.org, or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=CGI-Application-Plugin-Authentication-Driver-DBIC>.

Not me getting notified, and then you automatically getting notified of progress on your bug as changes get made. We stay in the loop together bestie 😭💖

🍓 SUPPORT 🍓

You can find documentation for this module with the perldoc command:

perldoc CGI::Application::Plugin::Authentication::Driver::DBIC

You can also look for information at:

🧚 THANKS 🧚

  • Cees Hek for CGI::Application::Plugin::Authentication
  • Shawn Sorichetti for CGI::Application::Plugin::Authentication::Driver::CDBI, which this module is shamelessly copied from 🙈

💜 AUTHOR 💜

Jaldhar H. Vyas, <jaldhar at braincells.com>

Copyright 2007, Consolidated Braincells Inc., all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

and that's the whole page bestie, no cap 💖 this was CGI::A...::DBIC(3pm) from the User Contributed Perl Documentation, running on perl v5.38.2 and dated 2024-06-29 — slay, go authenticate something 👑✨

📦 where this page comes from