#include <SASLMechanism.hpp>
Public Member Functions | |
| virtual const string | getName () const =0 |
| virtual bool | step (shared_ptr< SASLSession > sess, const byte_t *challenge, const size_t challengeLen, byte_t **response, size_t *responseLen)=0 |
| virtual bool | isComplete () const =0 |
| virtual bool | hasInitialResponse () const =0 |
| virtual void | encode (shared_ptr< SASLSession > sess, const byte_t *input, const size_t inputLen, byte_t **output, size_t *outputLen)=0 |
| virtual void | decode (shared_ptr< SASLSession > sess, const byte_t *input, const size_t inputLen, byte_t **output, size_t *outputLen)=0 |
Additional Inherited Members | |
 Protected Member Functions inherited from object | |
| object () | |
| object (const object &) | |
| object & | operator= (const object &) |
| virtual | ~object () |
Detailed Description
An SASL mechanism.
Member Function Documentation
◆ decode()
|
pure virtual |
Decode data according to negotiated SASL mechanism.
This might mean that data is integrity or privacy protected.
- Parameters
-
sess SASL session input input buffer inputLen length of input buffer output output buffer (allocated bu the function, free with delete[]) outputLen length of output buffer
- Exceptions
-
exceptions::sasl_exception if an error occurred during the encoding of data (in this case, the values in 'output' and 'outputLen' are undetermined)
Implemented in builtinSASLMechanism, and XOAuth2SASLMechanism.
◆ encode()
|
pure virtual |
Encode data according to negotiated SASL mechanism.
This might mean that data is integrity or privacy protected.
- Parameters
-
sess SASL session input input buffer inputLen length of input buffer output output buffer (allocated bu the function, free with delete[]) outputLen length of output buffer
- Exceptions
-
exceptions::sasl_exception if an error occurred during the encoding of data (in this case, the values in 'output' and 'outputLen' are undetermined)
Implemented in builtinSASLMechanism, and XOAuth2SASLMechanism.
◆ getName()
Return the name of this mechanism.
- Returns
- mechanism name
Implemented in builtinSASLMechanism, and XOAuth2SASLMechanism.
◆ hasInitialResponse()
Determine if this mechanism has an optional initial response.
If true, caller should call step() with an empty challenge to get the initial response.
- Returns
- true if this mechanism has an initial response, or false otherwise
Implemented in builtinSASLMechanism, and XOAuth2SASLMechanism.
◆ isComplete()
Check whether authentication has completed.
If false, more calls to evaluateChallenge() are needed to complete the authentication process).
- Returns
- true if the authentication has finished, or false otherwise
Implemented in builtinSASLMechanism, and XOAuth2SASLMechanism.
◆ step()
|
pure virtual |
Perform one step of SASL authentication.
Accept data from the server (challenge), process it and return data to be returned in response to the server.
If the challenge is empty (challengeLen == 0), the initial response is returned, if this mechanism has one.
- Parameters
-
sess SASL session challenge challenge sent from the server challengeLen length of challenge response response to send to the server (allocated by this function, free with delete[]) responseLen length of response buffer
- Returns
- true if authentication terminated successfully, or false if the authentication process should continue
- Exceptions
-
exceptions::sasl_exception if an error occurred during authentication (in this case, the values in 'response' and 'responseLen' are undetermined)
Implemented in builtinSASLMechanism, and XOAuth2SASLMechanism.
The documentation for this class was generated from the following file:
