Version: @(#) $Id: sasl.php,v 1.7 2004/10/05 03:58:06 mlemos Exp $
Simple Authentication and Security Layer client
Manuel Lemos (mlemos-at-acm.org)
Copyright © (C) Manuel Lemos 2004
@(#) $Id: sasl.php,v 1.7 2004/10/05 03:58:06 mlemos Exp $
Provide a common interface to plug-in driver classes that implement different mechanisms for authentication used by clients of standard protocols like SMTP, POP3, IMAP, HTTP, etc.. Currently the supported authentication mechanisms are: PLAIN, LOGIN, CRAM-MD5 and NTML (Windows or Samba).
.
string
''
Store the message that is returned when an error occurs.
Check this variable to understand what happened when a call to any of the class functions has failed.
This class uses cumulative error handling. This means that if one class functions that may fail is called and this variable was already set to an error message due to a failure in a previous call to the same or other function, the function will also fail and does not do anything.
This allows programs using this class to safely call several functions that may fail and only check the failure condition after the last function call.
Just set this variable to an empty string to clear the error condition.
string
''
Store the name of the mechanism that was selected during the call to the Start function.
.
SetCredential(
Store the value of a credential that may be used by any of the supported mechanisms to process the authentication messages and responses.
.
int GetCredentials(
Retrieve the values of one or more credentials to be used by the authentication mechanism classes.
.
credentials - .
defaults - .
interactions - .
.
int Start(
Process the initial authentication step initializing the driver class that implements the first of the list of requested mechanisms that is supported by this SASL client library implementation.
.
mechanisms - .
message - .
interactions - .
.
int Step(
Process the authentication steps after the initial until the authetication iteration dialog is complete.
.
response - .
message - .
interactions - .
.