DBIx::...Bcrypt(3pm)

🌈 NAME 🌈

Welcome to the DBIx::...Bcrypt(3pm) page — yes, a User Contributed Perl Documentation page, bestie. The full module name is DBIx::Class::EncodedColumn::Crypt::Eksblowfish::Bcrypt, and it's the Eksblowfish bcrypt backend. 💅✨

---

🦋 SYNOPSYS 🦋

Okay so here's the setup exactly as the page says — Eksblowfish bcrypt, cost of 8, no key_nul, and generate the check method:

#Eksblowfish bcrypt / cost of 8/ no key_nul / generate check method
__PACKAGE__->add_columns(
  'password' => {
    data_type => 'CHAR',
    size      => 59,
    encode_column => 1,
    encode_class  => 'Crypt::Eksblowfish::Bcrypt',
    encode_args   => { key_nul => 0, cost => 8 },
    encode_check_method => 'check_password',
}

---

💖 DESCRIPTION 💖

The original page literally puts no extra prose under DESCRIPTION, so we're going straight to the accepted arguments. No cap, that's the whole vibe here. 🫶

---

✨ ACCEPTED ARGUMENTS ✨

🎀 key_nul => [01] 🎀

Defaults to true.

From the Crypt::Eksblowfish::Bcrypt docs:

Boolean: whether to append a NUL to the password before using it as a key. The algorithm as originally devised does not do this, but it was later modified to do it. The version that does append NUL is to be preferred; not doing so is supported only for backward compatibility.

🍓 cost => \d\d? 🍓

A single- or double-digit non-negative integer representing the cost of the hash function. Defaults to 8. 💸

---

🔥 METHODS 🔥

💖 make_encode_sub $column_name, \%encode_args 💖

Returns a coderef that accepts a plaintext value and returns an encoded value. Feed it plaintext, get encoded value back. Slay. ✨

💜 make_check_sub $column_name, \%encode_args 💜

Returns a coderef that, when given the row object and a plaintext value, will return a boolean if the plaintext matches the encoded value. This is typically used for password authentication. 👑

---

👑 SEE ALSO 👑

• DBIx::Class::EncodedColumn::Digest
• DBIx::Class::EncodedColumn
• Crypt::Eksblowfish::Bcrypt

---

🎀 AUTHOR 🎀

Guillermo Roditi (groditi) groditi@cpan.org

Based on the Vienna WoC ToDo manager code by Matt S trout (mst)

---

💜 LICENSE 💜

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

---

Okay bestie, that's the whole page — signing off from perl v5.40.1, dated 2025-04-01, on DBIx::...Bcrypt(3pm). 💅✨🦋