A Proton default SASL client authenticator which only supports remote SASL exchanges where the ANONYMOUS mechanism is an published option. More...
Public Member Functions | |
| void | HandleSaslChallenge (ISaslClientContext context, IProtonBuffer challenge) |
| Called when a SASL challenge frame has arrived and its effect applied, indicating the challenge sent by the 'server' peer. The client should respond to the mechanisms event by creating a response buffer and sending it using the context API either immediately or later but using the same thread context as this event arrived in. More... | |
| void | HandleSaslMechanisms (ISaslClientContext context, Symbol[] mechanisms) |
| Called when a SASL mechanisms frame has arrived and its effect applied, indicating the offered mechanisms sent by the 'server' peer. The client should respond to the mechanisms event by selecting one from the offered list and use the provided client context to send the chosen mechanism back to the remote server. The caller should ensure that the call to send the chosen mechanism occurs in the same thread as that of this handler call. More... | |
| void | HandleSaslOutcome (ISaslClientContext context, SaslAuthOutcome outcome, IProtonBuffer additional) |
| Called when a SASL outcome frame has arrived and its effect applied, indicating the outcome and any success additional data sent by the 'server' peer. The client can consider the SASL negotiations complete following this event. The client should respond appropriately to the outcome whose state can indicate that negotiations have failed and the server has not authenticated the client. More... | |
 Public Member Functions inherited from Apache.Qpid.Proton.Engine.Sasl.ISaslClientAuthenticator | |
| void | Initialize (ISaslClientContext context) |
| Called before SASL authentication begins to give the application code a clear point to initialize all the client side expectations. More... | |
Static Public Attributes | |
| static readonly ProtonDefaultSaslClientAuthenticator | Instance = new() |
Detailed Description
A Proton default SASL client authenticator which only supports remote SASL exchanges where the ANONYMOUS mechanism is an published option.
Member Function Documentation
◆ HandleSaslChallenge()
|
inline |
Called when a SASL challenge frame has arrived and its effect applied, indicating the challenge sent by the 'server' peer. The client should respond to the mechanisms event by creating a response buffer and sending it using the context API either immediately or later but using the same thread context as this event arrived in.
In the event that the client cannot perform the negotiation due to some configuration or other internal issue it should call the failure method of the sasl client context provided here.
- Parameters
-
context The client context handling the SASL exchange challenge The challenge bytes sent from the server
Implements Apache.Qpid.Proton.Engine.Sasl.ISaslClientAuthenticator.
◆ HandleSaslMechanisms()
|
inline |
Called when a SASL mechanisms frame has arrived and its effect applied, indicating the offered mechanisms sent by the 'server' peer. The client should respond to the mechanisms event by selecting one from the offered list and use the provided client context to send the chosen mechanism back to the remote server. The caller should ensure that the call to send the chosen mechanism occurs in the same thread as that of this handler call.
In the event that the client cannot perform the negotiation due to some configuration or other internal issue it should call the failure method of the sasl client context provided here.
- Parameters
-
context The client context handling the SASL exchange mechanisms
Implements Apache.Qpid.Proton.Engine.Sasl.ISaslClientAuthenticator.
◆ HandleSaslOutcome()
|
inline |
Called when a SASL outcome frame has arrived and its effect applied, indicating the outcome and any success additional data sent by the 'server' peer. The client can consider the SASL negotiations complete following this event. The client should respond appropriately to the outcome whose state can indicate that negotiations have failed and the server has not authenticated the client.
In the event that the client cannot perform the negotiation due to some configuration or other internal issue it should call the failure method of the sasl client context provided here.
- Parameters
-
context The client context handling the SASL exchange outcome The SASL outcome provided by the server peer additional Optional additional data provided by the server
Implements Apache.Qpid.Proton.Engine.Sasl.ISaslClientAuthenticator.
The documentation for this class was generated from the following file:
- src/Proton/Engine/Implementation/Sasl/ProtonDefaultSaslClientAuthenticator.cs
