Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %Net.SASL.Base
Private  Storage   

%Net.SASL.Base


abstract class %Net.SASL.Base extends
%RegisteredObject

The abstract super class of all security mechanisms to be used with %Net.Authenticator, our implement of the Simple Authentication and Security Layer (SASL) as defined by RFC 2222.

Each defined mechanism will add additional properties defining the parameters needed for the mechanism and override the emthods defined here.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 2


Summary


Properties
MechanismName Password UserName

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
Next Start

Subclasses
%Net.SASL.CRAMMD5 %Net.SASL.LOGIN %Net.SASL.PLAIN

Properties


• property MechanismName as %String;
The name of the security mechanism. This name must be one of SASL mechanism names that is registered with IANA.
• property Password as %String;
The password for the user name being authenticated.
• property UserName as %String;
The user name being authenticated. No authentication will be attempted unless UserName and Password are supplied.

Methods


• method Next(challenge As %String, ByRef response As %String) as %Boolean
Return next response based on challenge using this SASL mechanism. Return value is false to indicate abort.
• method Start(ByRef response As %String) as %Boolean
Start authentication based on UserName and Password using this mechanism.