curl-fuzzer C++ reference
Loading...
Searching...
No Matches
proto_fuzzer::MqttsMockServer Class Referencefinal

Runs the binary MQTT packet exchange over implicit TLS. More...

#include <mqtts_mock_server.h>

Inheritance diagram for proto_fuzzer::MqttsMockServer:
proto_fuzzer::MqttMockServer proto_fuzzer::MockServerBase proto_fuzzer::IncomingDataObserver

Public Member Functions

 MqttsMockServer ()
 Construct the OpenSSL server carrier used by every MQTTS scenario.
 ~MqttsMockServer () override
 Release the TLS connection before the carrier-owned server context.
void ObserveState () override
 Retain protocol outcomes in coverage and introspector builds.
void Install (CURL *easy) override
 Install the shared socket callbacks and a stable local trust anchor.
int negotiated_tls_version () const
std::size_t completed_handshake_count () const
std::string negotiated_alpn () const
Public Member Functions inherited from proto_fuzzer::MqttMockServer
 MqttMockServer (curl::fuzzer::proto::MqttProbeMode mode=curl::fuzzer::proto::MQTT_PROBE_DEFAULT)
 Begin without a borrowed protobuf or open socketpair.
 ~MqttMockServer () override
 Release the server-owned socketpair half after curl has returned its client descriptor.
const std::string & packet_transcript () const
const std::string & published_topic () const
const std::string & published_payload () const
std::size_t packet_count () const
std::size_t connect_count () const
std::size_t publish_count () const
std::size_t subscribe_count () const
std::size_t qos1_publish_count () const
std::size_t active_pollset_probe_count () const
 Report how many requested zero-timeout multi-poll probes ran during the most recent drive.
Public Member Functions inherited from proto_fuzzer::MockServerBase
virtual ~MockServerBase ()
 Out-of-line destructor so MockConnection can stay forward-declared in the base header (its complete type is only needed where unique_ptr is instantiated for destruction).
virtual void ConfigureRequestData (ScenarioRequestData *request_data)
 Bind protocol-specific work to the request-data callbacks after their per-scenario state has been constructed.
CURLcode DriveScenario (CURL *easy, const curl::fuzzer::proto::Scenario &scenario)
 Run 'scenario' to completion on 'easy': allocate a multi, attach 'easy', delegate protocol-specific work to RunLoop, consume its completion message, and clean up.
virtual CURLcode DriveEasyScenario (CURL *easy, const curl::fuzzer::proto::Scenario &scenario, bool use_events=false)
 Run through the public easy entrypoint when a protocol mock can preload all peer work before curl takes control.
virtual ConnectOnlyRunStats DriveConnectOnlyScenario (CURL *easy, const curl::fuzzer::proto::Scenario &scenario)
 Establish a CONNECT_ONLY transport, then perform bounded direct I/O.
void SetMultiObserver (MultiObserver observer)
 Register an observer invoked with the live multi handle after 'easy' is attached and before the drive loop starts.
MockConnection * connection ()

Protected Member Functions

std::unique_ptr< MockConnection > CreateConnection () override
 Wrap one socketpair endpoint in an OpenSSL acceptor.
Protected Member Functions inherited from proto_fuzzer::MqttMockServer
curl_socket_t HandleOpenSocket (curlsocktype purpose=CURLSOCKTYPE_IPCXN, struct curl_sockaddr *address=nullptr) override
 Create the single MQTT socketpair and queue the scenario's first server bytes.
void RunLoop (CURLM *multi, CURL *easy, const curl::fuzzer::proto::Scenario &scenario) override
 Alternate curl transitions with immediate peer service until the transfer completes or deterministic idle/operation caps win.
void ObserveIncomingData (const unsigned char *data, std::size_t size) override
 Append decoded application bytes to the pending parser buffer.
Protected Member Functions inherited from proto_fuzzer::MockServerBase
 MockServerBase (MultiDrivePolicy drive_policy=MultiDrivePolicy::kPerform)
 Construct an empty base instance with a fixed multi-drive policy.
virtual void HandleDetachedMulti (CurlMultiPtr multi)
 Dispose of or retain the multi after its easy handle has been removed.
virtual SocketSetupDisposition GetSocketSetupDisposition (curl_socket_t curlfd, curlsocktype purpose) const
 Describe the socket returned by HandleOpenSocket without issuing native descriptor queries.
MultiSocketDriver * multi_socket_driver ()
 Expose the callback state installed for the current socket-action drive.
std::size_t additional_handle_cleanup_count () const
void ResumeResponseIfRequested (CURL *easy)
 Resume receive-side callback output at one bounded drive boundary when the dedicated API plan requested it.
void ApplyPendingBackpressure ()
 Apply the BackpressureConfig cached by DriveScenario to the new connection_.

Additional Inherited Members

Public Types inherited from proto_fuzzer::MockServerBase
using MultiObserver = std::function<void(CURLM*)>
 Callback type used to publish the driving multi handle to observers.
Static Protected Member Functions inherited from proto_fuzzer::MockServerBase
static int WaitOnMultiFdset (CURLM *multi, CURLMcode *rc)
 Wait on curl's fdset with a short timeout.
static void ProbeMultiPollset (CURLM *multi)
 Ask curl to construct and inspect its connection-filter pollset without waiting.
static bool MultiPollsetWantsWrite (CURLM *multi, curl_socket_t socket)
 Inspect one socket's current writable interest through curl's public multi fdset API.
static bool UsesTimedDrive (const curl::fuzzer::proto::Scenario &scenario)
 Treat a non-default BackpressureConfig as an explicit request for the slower, timed drive policy.
Protected Attributes inherited from proto_fuzzer::MockServerBase
std::unique_ptr< MockConnection > connection_
 The per-scenario MockConnection, lazily created by HandleOpenSocket().
int pending_recv_buf_bytes_
 Cached SO_RCVBUF/SO_SNDBUF setting in bytes.
std::size_t pending_drain_limit_
 Cached per-call DrainIncoming byte budget.
MultiSocketDriver * multi_socket_driver_
 Non-owning pointer into DriveScenario's stack.
std::size_t additional_handle_cleanup_count_
 Number of application-created handles, excluding the caller's parent, successfully removed from the current multi and cleaned up.
bool resume_response_
 True only for an API-plan multi drive with its one-shot write callback.
MultiObserver multi_observer_
 Observer receiving the live multi handle at the start of a drive.
Static Protected Attributes inherited from proto_fuzzer::MockServerBase
static constexpr int kMaxDriveIterations = 512
 Hard operation budget for one scenario.
static constexpr int kMaxIdleIterations = 8
 Consecutive no-progress budget for ordinary scenarios.
static constexpr int kMaxTimedIdleIterations = 256
 Explicit backpressure scenarios get a larger idle budget and may use the short timed wait above.

Detailed Description

Runs the binary MQTT packet exchange over implicit TLS.

MQTTS differs from MQTT only in transport setup: curl establishes TLS immediately after CONNECT and then executes the same CONNECT/CONNACK, PUBLISH or SUBSCRIBE/SUBACK, server-PUBLISH, and DISCONNECT sequence. This peer therefore inherits the packet-aware parser and replaces only the connection factory and trust installation.

MQTT handshakes carry no ALPN extension. The carrier is constructed with its closed HTTP/1.1 default, but OpenSSL only invokes the selector when the client offers ALPN, so curl negotiates no application protocol here.

Definition at line 36 of file mqtts_mock_server.h.

Constructor & Destructor Documentation

◆ MqttsMockServer()

proto_fuzzer::MqttsMockServer::MqttsMockServer ( )

Construct the OpenSSL server carrier used by every MQTTS scenario.

MQTT sends no ALPN extension, so the closed HTTP/1.1 default is never selected and the handshake completes without an application protocol.

Definition at line 23 of file mqtts_mock_server.cc.

◆ ~MqttsMockServer()

proto_fuzzer::MqttsMockServer::~MqttsMockServer ( )
override

Release the TLS connection before the carrier-owned server context.

The inherited packet parser holds no transport state of its own.

Definition at line 27 of file mqtts_mock_server.cc.

Member Function Documentation

◆ completed_handshake_count()

std::size_t proto_fuzzer::MqttsMockServer::completed_handshake_count ( ) const
Returns
Number of connections that completed TLS negotiation.

Definition at line 48 of file mqtts_mock_server.cc.

◆ CreateConnection()

std::unique_ptr< MockConnection > proto_fuzzer::MqttsMockServer::CreateConnection ( )
overrideprotectedvirtual

Wrap one socketpair endpoint in an OpenSSL acceptor.

The inherited MQTT loop advances the handshake and then parses only decrypted packets.

Returns
Newly allocated nonblocking TLS connection.

Reimplemented from proto_fuzzer::MqttMockServer.

Definition at line 42 of file mqtts_mock_server.cc.

◆ Install()

void proto_fuzzer::MqttsMockServer::Install ( CURL * easy)
overridevirtual

Install the shared socket callbacks and a stable local trust anchor.

Curl copies the blob descriptor during setopt and borrows the inline certificate bytes, whose program lifetime safely exceeds every easy handle. Scenario options run afterwards and can still disable verification.

Parameters
easyEasy handle that will initiate the MQTTS exchange.

Reimplemented from proto_fuzzer::MockServerBase.

Definition at line 34 of file mqtts_mock_server.cc.

◆ negotiated_alpn()

std::string proto_fuzzer::MqttsMockServer::negotiated_alpn ( ) const
Returns
ALPN protocol selected by curl, or an empty string when absent.

Definition at line 51 of file mqtts_mock_server.cc.

◆ negotiated_tls_version()

int proto_fuzzer::MqttsMockServer::negotiated_tls_version ( ) const
Returns
Protocol version selected by the most recent handshake, or zero.

Definition at line 45 of file mqtts_mock_server.cc.


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