class %Net.SASL.LOGIN extends %Net.SASL.Base

The implementation of the LOGIN SASL security mechanism to be used with %Net.Authenticator, our implementation of the Simple Authentication and Security Layer (SASL) as defined by RFC 2222.

Property Inventory (Including Private)

Method Inventory (Including Private)


property MechanismName as %String [ InitialExpression = "LOGIN" ];
The name of the security mechanism. This name must be one of SASL mechanism names that is registered with IANA.
Property methods: MechanismNameDisplayToLogical(), MechanismNameGet(), MechanismNameIsValid(), MechanismNameLogicalToDisplay(), MechanismNameLogicalToOdbc(), MechanismNameNormalize(), MechanismNameSet()
property state as %Integer [ Private ];
State of client side of authentication:
1 - initial 2 - userName previously returned 3 - password previously returned
Property methods: stateDisplayToLogical(), stateGet(), stateIsValid(), stateLogicalToDisplay(), stateNormalize(), stateSet()


Return next response based on challenge using the PLAIN SASL mechanism. Return value is false to indicate abort.
method Start(ByRef response As %String) as %Boolean [ Language = objectscript ]
Start authentication based on UserName and Password using the PLAIN SASL mechanism.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)