man-pages/man3/Authen::SASL::Perl::PLAIN.3pm.html
2021-03-31 01:06:50 +01:00

141 lines
3.1 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of Authen::SASL::Perl::PLAIN</TITLE>
</HEAD><BODY>
<H1>Authen::SASL::Perl::PLAIN</H1>
Section: User Contributed Perl Documentation (3pm)<BR>Updated: 2014-04-26<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
Authen::SASL::Perl::PLAIN - Plain Login Authentication class
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
use Authen::SASL qw(Perl);
$sasl = Authen::SASL-&gt;new(
mechanism =&gt; 'PLAIN',
callback =&gt; {
user =&gt; $user,
pass =&gt; $pass
},
);
</PRE>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
This method implements the client and server part of the <FONT SIZE="-1">PLAIN SASL</FONT> algorithm,
as described in <FONT SIZE="-1">RFC 2595</FONT> resp. <FONT SIZE="-1">IETF</FONT> Draft draft-ietf-sasl-plain-XX.txt
<A NAME="lbAE">&nbsp;</A>
<H3><FONT SIZE="-1">CALLBACK</FONT></H3>
The callbacks used are:
<P>
<I>Client</I>
<DL COMPACT>
<DT id="1">authname<DD>
The authorization id to use after successful authentication (client)
<DT id="2">user<DD>
The username to be used for authentication (client)
<DT id="3">pass<DD>
The user's password to be used for authentication.
</DL>
<P>
<I>Server</I>
<DL COMPACT>
<DT id="4">checkpass(username, password, realm)<DD>
returns true and false depending on the validity of the credentials passed
in arguments.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>SEE ALSO</H2>
Authen::SASL,
Authen::SASL::Perl
<A NAME="lbAG">&nbsp;</A>
<H2>AUTHORS</H2>
Software written by Graham Barr &lt;<A HREF="mailto:gbarr@pobox.com">gbarr@pobox.com</A>&gt;,
documentation written by Peter Marschall &lt;<A HREF="mailto:peter@adpm.de">peter@adpm.de</A>&gt;.
<P>
Please report any bugs, or post any suggestions, to the perl-ldap mailing list
&lt;<A HREF="mailto:perl-ldap@perl.org">perl-ldap@perl.org</A>&gt;
<A NAME="lbAH">&nbsp;</A>
<H2>COPYRIGHT</H2>
Copyright (c) 2002-2004 Graham Barr.
All rights reserved. This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
<P>
Documentation Copyright (c) 2004 Peter Marschall.
All rights reserved. This documentation is distributed,
and may be redistributed, under the same terms as Perl itself.
<P>
Server support Copyright (c) 2009 Yann Kerherve.
All rights reserved. This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="5"><A HREF="#lbAB">NAME</A><DD>
<DT id="6"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="7"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DL>
<DT id="8"><A HREF="#lbAE"><FONT SIZE="-1">CALLBACK</FONT></A><DD>
</DL>
<DT id="9"><A HREF="#lbAF">SEE ALSO</A><DD>
<DT id="10"><A HREF="#lbAG">AUTHORS</A><DD>
<DT id="11"><A HREF="#lbAH">COPYRIGHT</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:36 GMT, March 31, 2021
</BODY>
</HTML>