phpman > perldoc > Authen::SASL::SASLprep

📛 NAME

Authen::SASL::SASLprep - A Stringprep Profile for User Names and Passwords (RFC 4013)

📜 SYNOPSIS

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

📖 DESCRIPTION

This module implements the *SASLprep* specification, which describes how to prepare Unicode strings representing user names and passwords for comparison. SASLprep is a profile of the stringprep algorithm.

⚙️ FUNCTIONS

This module implements a single function, "saslprep", which is exported by default.

💠 saslprep

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

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.

✍️ AUTHOR

Claus Färber <CFAERBER AT cpan.org>

⚖️ LICENSE

Copyright 2009-2016 Claus Färber.

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

🔗 SEE ALSO

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