MySQL 8.3.0
Source Code Documentation
auth_ldap_sasl_client::Sasl_mechanism_scram Class Reference

Class representing SCRAM family of SASL mechanisms (currently SCRAM-SHA-1 and SCRAM-SHA-256). More...

#include <auth_ldap_sasl_mechanism.h>

Inheritance diagram for auth_ldap_sasl_client::Sasl_mechanism_scram:
[legend]

Public Member Functions

 Sasl_mechanism_scram (const char *mechanism_name)
 Constructor. More...
 
 ~Sasl_mechanism_scram () override=default
 Destructor. More...
 
const sasl_callback_t * get_callbacks () override
 Gets array of SASL callbacks supported by the mechanism. More...
 
- Public Member Functions inherited from auth_ldap_sasl_client::Sasl_mechanism
virtual ~Sasl_mechanism ()=default
 Destructor. More...
 
virtual bool preauthenticate (const char *user, const char *password)
 Preauthentication step, e.g. More...
 
virtual const char * get_ldap_host ()
 Get LDAP host. More...
 
virtual bool get_default_user (std::string &name)
 Get default user name. More...
 
const char * get_mechanism_name ()
 Gets constans string describing mechanism name. More...
 
virtual bool require_conclude_by_server ()
 Check if the authentication method requires conclusion message from the server. More...
 

Static Private Attributes

static const sasl_callback_t callbacks []
 Array of SASL callbacks supported by this mechanism. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from auth_ldap_sasl_client::Sasl_mechanism
static bool create_sasl_mechanism (const char *mechanism_name, Sasl_mechanism *&mechanism)
 SASL mechanism factory function. More...
 
- Static Public Attributes inherited from auth_ldap_sasl_client::Sasl_mechanism
static const char SASL_GSSAPI [] = "GSSAPI"
 GSSAPI string. More...
 
static const char SASL_SCRAM_SHA1 [] = "SCRAM-SHA-1"
 SCRAM-SHA-1 string. More...
 
static const char SASL_SCRAM_SHA256 [] = "SCRAM-SHA-256"
 SCRAM-SHA-256 string. More...
 
- Protected Member Functions inherited from auth_ldap_sasl_client::Sasl_mechanism
 Sasl_mechanism (const char *mechanism_name)
 Constructor. More...
 

Detailed Description

Class representing SCRAM family of SASL mechanisms (currently SCRAM-SHA-1 and SCRAM-SHA-256).

Constructor & Destructor Documentation

◆ Sasl_mechanism_scram()

auth_ldap_sasl_client::Sasl_mechanism_scram::Sasl_mechanism_scram ( const char *  mechanism_name)
inline

Constructor.

Parameters
mechanism_name[in] mame of the mechanism

◆ ~Sasl_mechanism_scram()

auth_ldap_sasl_client::Sasl_mechanism_scram::~Sasl_mechanism_scram ( )
overridedefault

Destructor.

Member Function Documentation

◆ get_callbacks()

const sasl_callback_t * auth_ldap_sasl_client::Sasl_mechanism_scram::get_callbacks ( )
inlineoverridevirtual

Gets array of SASL callbacks supported by the mechanism.

Returns
array of callbacks

Reimplemented from auth_ldap_sasl_client::Sasl_mechanism.

Member Data Documentation

◆ callbacks

const sasl_callback_t auth_ldap_sasl_client::Sasl_mechanism_scram::callbacks
staticprivate
Initial value:
= {
{SASL_CB_USER, nullptr, nullptr},
{SASL_CB_AUTHNAME, nullptr, nullptr},
{SASL_CB_PASS, nullptr, nullptr},
{SASL_CB_ECHOPROMPT, nullptr, nullptr},
{SASL_CB_NOECHOPROMPT, nullptr, nullptr},
{SASL_CB_LIST_END, nullptr, nullptr}}

Array of SASL callbacks supported by this mechanism.


The documentation for this class was generated from the following files: