.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Authen::SASL::Perl::DIGEST_MD5 3"
.TH Authen::SASL::Perl::DIGEST_MD5 3 2024-09-01 "perl v5.40.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Authen::SASL::Perl::DIGEST_MD5 \- Digest MD5 Authentication class
.SH VERSION
.IX Header "VERSION"
version 2.1700
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Authen::SASL qw(Perl);
\&
\&  $sasl = Authen::SASL\->new(
\&    mechanism => \*(AqDIGEST\-MD5\*(Aq,
\&    callback  => {
\&      user => $user, 
\&      pass => $pass,
\&      serv => $serv
\&    },
\&  );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This method implements the client and server parts of the DIGEST\-MD5 SASL
algorithm, as described in RFC 2831.
.SS CALLBACK
.IX Subsection "CALLBACK"
The callbacks used are:
.PP
\fIclient\fR
.IX Subsection "client"
.IP authname 4
.IX Item "authname"
The authorization id to use after successful authentication
.IP user 4
.IX Item "user"
The username to be used in the response
.IP pass 4
.IX Item "pass"
The password to be used to compute the response.
.IP serv 4
.IX Item "serv"
The service name when authenticating to a replicated service
.IP realm 4
.IX Item "realm"
The authentication realm when overriding the server-provided default.
If not given the server-provided value is used.
.Sp
The callback will be passed the list of realms that the server provided
in the initial response.
.PP
\fIserver\fR
.IX Subsection "server"
.IP realm 4
.IX Item "realm"
The default realm to provide to the client
.IP "getsecret(username, realm, authzid)" 4
.IX Item "getsecret(username, realm, authzid)"
returns the password associated with \f(CW\*(C`username\*(C'\fR and \f(CW\*(C`realm\*(C'\fR
.SS PROPERTIES
.IX Subsection "PROPERTIES"
The properties used are:
.IP maxbuf 4
.IX Item "maxbuf"
The maximum buffer size for receiving cipher text
.IP minssf 4
.IX Item "minssf"
The minimum SSF value that should be provided by the SASL security layer.
The default is 0
.IP maxssf 4
.IX Item "maxssf"
The maximum SSF value that should be provided by the SASL security layer.
The default is 2**31
.IP externalssf 4
.IX Item "externalssf"
The SSF value provided by an underlying external security layer.
The default is 0
.IP ssf 4
.IX Item "ssf"
The actual SSF value provided by the SASL security layer after the SASL
authentication phase has been completed. This value is read-only and set
by the implementation after the SASL authentication phase has been completed.
.IP maxout 4
.IX Item "maxout"
The maximum plaintext buffer size for sending data to the peer.
This value is set by the implementation after the SASL authentication
phase has been completed and a SASL security layer is in effect.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Authen::SASL,
Authen::SASL::Perl
.SH AUTHORS
.IX Header "AUTHORS"
Graham Barr, Djamel Boudjerda (NEXOR), Paul Connolly, Julian Onions (NEXOR),
Yann Kerherve.
.PP
Please report any bugs, or post any suggestions, to the perl-ldap mailing list
<perl\-ldap@perl.org>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
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.