MySQL 8.4.2
Source Code Documentation
AuthSha256Forwarder Class Reference

#include <classic_auth_sha256_password_forwarder.h>

Inheritance diagram for AuthSha256Forwarder:
[legend]

Public Types

enum class  Stage {
  Init , ClientData , EncryptedPassword , PublicKeyResponse ,
  PublicKey , Response , Error , Ok ,
  Done
}
 
- Public Types inherited from BasicProcessor
enum class  Result {
  Again , RecvFromClient , SendToClient , RecvFromServer ,
  RecvFromBoth , SendToServer , SendableToServer , Suspend ,
  Done , Void
}
 

Public Member Functions

 AuthSha256Forwarder (MysqlRoutingClassicConnectionBase *conn, std::string initial_server_auth_data, bool in_handshake=false)
 
stdx::expected< Result, std::error_code > process () override
 
void stage (Stage stage)
 
Stage stage () const
 
- Public Member Functions inherited from Processor
 BasicProcessor (MysqlRoutingClassicConnectionBase *conn)
 
- Public Member Functions inherited from BasicProcessor
 BasicProcessor (MysqlRoutingClassicConnectionBase *conn)
 
virtual ~BasicProcessor ()=default
 
const MysqlRoutingClassicConnectionBaseconnection () const
 
MysqlRoutingClassicConnectionBaseconnection ()
 

Private Types

using Auth = AuthSha256Password
 

Private Member Functions

stdx::expected< Result, std::error_code > init ()
 
stdx::expected< Result, std::error_code > client_data ()
 
stdx::expected< Result, std::error_code > encrypted_password ()
 
stdx::expected< Result, std::error_code > response ()
 
stdx::expected< Result, std::error_code > public_key ()
 
stdx::expected< Result, std::error_code > public_key_response ()
 
stdx::expected< Result, std::error_code > error ()
 
stdx::expected< Result, std::error_code > ok ()
 
stdx::expected< Result, std::error_code > send_password ()
 

Private Attributes

std::string initial_server_auth_data_
 
Stage stage_
 

Additional Inherited Members

- Static Public Attributes inherited from ForwardingProcessor
static constexpr const std::chrono::milliseconds kConnectRetryInterval
 interval between connect-retries. More...
 
- Protected Member Functions inherited from ForwardingProcessor
stdx::expected< Result, std::error_code > forward_server_to_client (bool noflush=false)
 forward the current packet from the server-side to the client-side. More...
 
stdx::expected< Result, std::error_code > forward_client_to_server (bool noflush=false)
 forward the current packet from the client-side to the server-side. More...
 
stdx::expected< Processor::Result, std::error_code > skip_or_inject_end_of_columns (bool no_flush=false)
 adjust the end-of-columns packet. More...
 
stdx::expected< bool, std::error_code > pool_server_connection ()
 move the server connection to the pool. More...
 
stdx::expected< Processor::Result, std::error_code > socket_reconnect_start (TraceEvent *parent_event)
 reconnect a socket. More...
 
stdx::expected< Processor::Result, std::error_code > mysql_reconnect_start (TraceEvent *parent_event)
 reconnect a mysql classic connection. More...
 
stdx::expected< Result, std::error_code > recv_server_failed_and_check_client_socket (std::error_code ec)
 handle error-code of a failed receive() from the server-socket and check the status of the client socket. More...
 
stdx::expected< Processor::Result, std::error_code > reconnect_send_error_msg (Channel &src_channel, ClassicProtocolState &src_protocol)
 send a Error msg based on the reconnect_error(). More...
 
template<class Proto >
stdx::expected< Processor::Result, std::error_code > reconnect_send_error_msg (TlsSwitchableConnection< Proto > &conn)
 
void reconnect_error (classic_protocol::message::server::Error err)
 set the reconnect error. More...
 
classic_protocol::message::server::Error reconnect_error () const
 get the reconnect error. More...
 
- Protected Member Functions inherited from Processor
stdx::expected< Result, std::error_code > send_server_failed (std::error_code ec)
 
stdx::expected< Result, std::error_code > recv_server_failed (std::error_code ec)
 
stdx::expected< Result, std::error_code > send_client_failed (std::error_code ec)
 
stdx::expected< Result, std::error_code > recv_client_failed (std::error_code ec)
 
stdx::expected< Result, std::error_code > server_socket_failed (std::error_code ec)
 
stdx::expected< Result, std::error_code > client_socket_failed (std::error_code ec)
 
stdx::expected< void, std::error_code > discard_current_msg (Channel &src_channel, ClassicProtocolState &src_protocol)
 discard to current message. More...
 
template<class Proto >
stdx::expected< void, std::error_code > discard_current_msg (TlsSwitchableConnection< Proto > &conn)
 
void trace (Tracer::Event e)
 
Tracertracer ()
 
TraceEventtrace_span (TraceEvent *parent_span, const std::string_view &prefix)
 start a span. More...
 
void trace_span_end (TraceEvent *event, TraceEvent::StatusCode status_code=TraceEvent::StatusCode::kUnset)
 end a span and set a status-code. More...
 
TraceEventtrace_command (const std::string_view &prefix)
 start a command span. More...
 
TraceEventtrace_connect_and_forward_command (TraceEvent *parent_span)
 start a connect-and-forward span. More...
 
TraceEventtrace_connect (TraceEvent *parent_span)
 start a connect span. More...
 
void trace_set_connection_attributes (TraceEvent *ev)
 start a connect span. More...
 
TraceEventtrace_forward_command (TraceEvent *parent_span)
 start a forward span. More...
 
void trace_command_end (TraceEvent *event, TraceEvent::StatusCode status_code=TraceEvent::StatusCode::kUnset)
 end a command span and set a status-code. More...
 
- Static Protected Member Functions inherited from ForwardingProcessor
template<class T >
static bool message_can_be_forwarded_as_is (ClassicProtocolState &src_protocol, ClassicProtocolState &dst_protocol, const T &msg)
 check of the capabilities of the source and the destination are the same for this message. More...
 
static bool connect_error_is_transient (const classic_protocol::message::server::Error &err)
 check if the error is a transient error. More...
 
- Static Protected Member Functions inherited from Processor
static void log_fatal_error_code (const char *msg, std::error_code ec)
 log a message with error-code as error. More...
 

Member Typedef Documentation

◆ Auth

Member Enumeration Documentation

◆ Stage

enum class AuthSha256Forwarder::Stage
strong
Enumerator
Init 
ClientData 
EncryptedPassword 
PublicKeyResponse 
PublicKey 
Response 
Error 
Ok 
Done 

Constructor & Destructor Documentation

◆ AuthSha256Forwarder()

AuthSha256Forwarder::AuthSha256Forwarder ( MysqlRoutingClassicConnectionBase conn,
std::string  initial_server_auth_data,
bool  in_handshake = false 
)
inline

Member Function Documentation

◆ client_data()

stdx::expected< Processor::Result, std::error_code > AuthSha256Forwarder::client_data ( )
private

◆ encrypted_password()

stdx::expected< Processor::Result, std::error_code > AuthSha256Forwarder::encrypted_password ( )
private

◆ error()

stdx::expected< Processor::Result, std::error_code > AuthSha256Forwarder::error ( )
private

◆ init()

stdx::expected< Processor::Result, std::error_code > AuthSha256Forwarder::init ( )
private

◆ ok()

stdx::expected< Processor::Result, std::error_code > AuthSha256Forwarder::ok ( )
private

◆ process()

stdx::expected< Processor::Result, std::error_code > AuthSha256Forwarder::process ( )
overridevirtual

Implements BasicProcessor.

◆ public_key()

stdx::expected< Processor::Result, std::error_code > AuthSha256Forwarder::public_key ( )
private

◆ public_key_response()

stdx::expected< Processor::Result, std::error_code > AuthSha256Forwarder::public_key_response ( )
private

◆ response()

stdx::expected< Processor::Result, std::error_code > AuthSha256Forwarder::response ( )
private

◆ send_password()

stdx::expected< Processor::Result, std::error_code > AuthSha256Forwarder::send_password ( )
private

◆ stage() [1/2]

Stage AuthSha256Forwarder::stage ( ) const
inline

◆ stage() [2/2]

void AuthSha256Forwarder::stage ( Stage  stage)
inline

Member Data Documentation

◆ initial_server_auth_data_

std::string AuthSha256Forwarder::initial_server_auth_data_
private

◆ stage_

Stage AuthSha256Forwarder::stage_
private

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