192 lines
4.4 KiB
HTML
192 lines
4.4 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of Authen::SASL::Perl::DIGEST_MD5</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>Authen::SASL::Perl::DIGEST_MD5</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"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
Authen::SASL::Perl::DIGEST_MD5 - Digest MD5 Authentication class
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
use Authen::SASL qw(Perl);
|
|
|
|
$sasl = Authen::SASL->new(
|
|
mechanism => 'DIGEST-MD5',
|
|
callback => {
|
|
user => $user,
|
|
pass => $pass,
|
|
serv => $serv
|
|
},
|
|
);
|
|
|
|
</PRE>
|
|
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
|
|
|
|
This method implements the client and server parts of the <FONT SIZE="-1">DIGEST-MD5 SASL</FONT>
|
|
algorithm, as described in <FONT SIZE="-1">RFC 2831.</FONT>
|
|
<A NAME="lbAE"> </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
|
|
<DT id="2">user<DD>
|
|
|
|
|
|
The username to be used in the response
|
|
<DT id="3">pass<DD>
|
|
|
|
|
|
The password to be used to compute the response.
|
|
<DT id="4">serv<DD>
|
|
|
|
|
|
The service name when authenticating to a replicated service
|
|
<DT id="5">realm<DD>
|
|
|
|
|
|
The authentication realm when overriding the server-provided default.
|
|
If not given the server-provided value is used.
|
|
|
|
|
|
<P>
|
|
|
|
|
|
The callback will be passed the list of realms that the server provided
|
|
in the initial response.
|
|
</DL>
|
|
<P>
|
|
|
|
<I>server</I>
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="6">realm<DD>
|
|
|
|
|
|
The default realm to provide to the client
|
|
<DT id="7">getsecret(username, realm, authzid)<DD>
|
|
|
|
|
|
returns the password associated with <TT>"username"</TT> and <TT>"realm"</TT>
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H3><FONT SIZE="-1">PROPERTIES</FONT></H3>
|
|
|
|
|
|
|
|
The properties used are:
|
|
<DL COMPACT>
|
|
<DT id="8">maxbuf<DD>
|
|
|
|
|
|
The maximum buffer size for receiving cipher text
|
|
<DT id="9">minssf<DD>
|
|
|
|
|
|
The minimum <FONT SIZE="-1">SSF</FONT> value that should be provided by the <FONT SIZE="-1">SASL</FONT> security layer.
|
|
The default is 0
|
|
<DT id="10">maxssf<DD>
|
|
|
|
|
|
The maximum <FONT SIZE="-1">SSF</FONT> value that should be provided by the <FONT SIZE="-1">SASL</FONT> security layer.
|
|
The default is 2**31
|
|
<DT id="11">externalssf<DD>
|
|
|
|
|
|
The <FONT SIZE="-1">SSF</FONT> value provided by an underlying external security layer.
|
|
The default is 0
|
|
<DT id="12">ssf<DD>
|
|
|
|
|
|
The actual <FONT SIZE="-1">SSF</FONT> value provided by the <FONT SIZE="-1">SASL</FONT> security layer after the <FONT SIZE="-1">SASL</FONT>
|
|
authentication phase has been completed. This value is read-only and set
|
|
by the implementation after the <FONT SIZE="-1">SASL</FONT> authentication phase has been completed.
|
|
<DT id="13">maxout<DD>
|
|
|
|
|
|
The maximum plaintext buffer size for sending data to the peer.
|
|
This value is set by the implementation after the <FONT SIZE="-1">SASL</FONT> authentication
|
|
phase has been completed and a <FONT SIZE="-1">SASL</FONT> security layer is in effect.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
|
|
|
|
Authen::SASL,
|
|
Authen::SASL::Perl
|
|
<A NAME="lbAH"> </A>
|
|
<H2>AUTHORS</H2>
|
|
|
|
|
|
|
|
Graham Barr, Djamel Boudjerda (<FONT SIZE="-1">NEXOR</FONT>), Paul Connolly, Julian Onions (<FONT SIZE="-1">NEXOR</FONT>),
|
|
Yann Kerherve.
|
|
<P>
|
|
|
|
Please report any bugs, or post any suggestions, to the perl-ldap mailing list
|
|
<<A HREF="mailto:perl-ldap@perl.org">perl-ldap@perl.org</A>>
|
|
<A NAME="lbAI"> </A>
|
|
<H2>COPYRIGHT</H2>
|
|
|
|
|
|
|
|
Copyright (c) 2003-2009 Graham Barr, Djamel Boudjerda, Paul Connolly,
|
|
Julian Onions, Nexor, Peter Marschall and 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"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="14"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="15"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="16"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DL>
|
|
<DT id="17"><A HREF="#lbAE"><FONT SIZE="-1">CALLBACK</FONT></A><DD>
|
|
<DT id="18"><A HREF="#lbAF"><FONT SIZE="-1">PROPERTIES</FONT></A><DD>
|
|
</DL>
|
|
<DT id="19"><A HREF="#lbAG">SEE ALSO</A><DD>
|
|
<DT id="20"><A HREF="#lbAH">AUTHORS</A><DD>
|
|
<DT id="21"><A HREF="#lbAI">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>
|