Authen...SLprep(3pm)

💖 Authen::SASL::SASLprep — bestie edition 💖

okay so this is a page from the User Contributed Perl Documentation, and it's about Authen::SASL::SASLprep, which is literally a Stringprep Profile for User Names and Passwords (RFC 4013). yes queen, unicode hygiene 💅

---

✨ NAME ✨

Authen::SASL::SASLprep — a Stringprep Profile for User Names and Passwords (RFC 4013). that's it, that's the whole identity 🎀

---

🦋 SYNOPSIS 🦋

the whole vibe in four lines, no cap:

use Authen::SASL::SASLprep;
$output_query = saslprep $input;
$output_stored = saslprep $stored;

---

🌸 DESCRIPTION 🌸

so this module implements the SASLprep specification, which is the thing that describes how to prepare Unicode strings representing user names and passwords for comparison. like, it's giving "let's make sure these two strings actually match before we let you in" energy.

SASLprep is a profile of the stringprep algorithm. periodt. ✨

---

👑 FUNCTIONS 👑

this module implements a single function, saslprep, and bestie, it is exported by default. no import gymnastics required 🫶

• saslprep($input, [$stored] — processes $input according to the SASLprep specification and returns the result.

⚠️ if $input contains characters not allowed for SASLprep, it throws an exception — so use eval if necessary, okay?? don't say I didn't warn you 😭

if the boolean parameter $stored is true, an exception is also thrown when characters are not allowed for stored strings (i.e., when characters are unassigned in Unicode 3.2). the default is to prepare query strings, in which unassigned characters are allowed. so like, query mode = chill, stored mode = strict 💀

---

💜 AUTHOR 💜

Claus Faerber <CFAERBER@cpan.org> — iconic, we stan 💖

---

🎀 LICENSE 🎀

Copyright 2009-2016 Claus Faerber.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. slay, open source behavior fr fr 🌈

---

🌟 SEE ALSO 🌟

• Unicode::Stringprep
• RFC 4013 <http://www.ietf.org/rfc/rfc4013.txt>

---

and that's the whole page, bestie!! this was rendered by perl v5.36.0, dated 2022-11-27, under the very same Authen...SLprep(3pm) title you scrolled past at the top 🦋✨ go forth and saslprep responsibly 💅