Runs the status-line POP3 command/reply exchange over implicit TLS. More...

#include <pop3s_mock_server.h>

Inheritance diagram for proto_fuzzer::Pop3sMockServer:

Public Member Functions
	Pop3sMockServer ()
	Construct the OpenSSL server carrier used by every POP3S scenario.
	~Pop3sMockServer () 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::Pop3MockServer
	Pop3MockServer ()
	Begin without a borrowed protobuf or open socketpair.
	~Pop3MockServer () override
	Release the server-owned socketpair half after curl has returned its client descriptor.
Public Member Functions inherited from proto_fuzzer::PingpongMockServer
	~PingpongMockServer () override
	Release the server-owned socketpair half after curl has returned its client descriptor.
const std::string &	control_transcript () const
	Expose the bounded command capture from the most recent drive so tests can verify protocol states without coupling assertions to curl debug output.
const std::string &	uploaded_data () const
	Expose a bounded prefix of bytes drained during the most recent body phase while continuing to drain every client byte, so test observability cannot create backpressure.
std::size_t	active_pollset_probe_count () const
	Report how many requested zero-timeout multi-poll probes ran during the most recent drive.
std::size_t	writable_pollset_probe_count () const
	Report how often curl retained writable interest while the peer held an incomplete control command.
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::Pop3MockServer
void	HandleLine (std::string_view line) override
	Advance one reply for every complete command.
void	QueueShutdownReply () override
	Queue a +OK for the blocking QUIT that follows easy cleanup, then let the shared transport half-close so an unfinished transfer cannot wait on a reply that will never arrive.
Protected Member Functions inherited from proto_fuzzer::PingpongMockServer
	PingpongMockServer (MultiDrivePolicy drive_policy=MultiDrivePolicy::kPerform)
	Construct the shared transport state without a borrowed protobuf or open socketpair.
void	BeginMarkerBody (std::string_view terminator)
	Enter marker-terminated body mode.
void	BeginLiteralBody (std::size_t length)
	Enter length-announced literal body mode.
void	BeginExactBody (std::size_t length)
	Enter exact-length body mode.
void	BeginOpaqueDrain ()
	Enter an opaque drain after a transport upgrade.
virtual void	HandleBodyComplete ()
	Called after a body phase reached its terminator and the parser returned to command mode.
virtual void	ResetProtocolState ()
	Reset protocol-specific parser state for a new drive.
curl_socket_t	HandleOpenSocket (curlsocktype purpose=CURLSOCKTYPE_IPCXN, struct curl_sockaddr *address=nullptr) override
	Create the single control socketpair and queue the server greeting.
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	HandleDetachedMulti (CurlMultiPtr multi) override
	Give curl's graceful shutdown one last chance to emit its teardown command while the peer still owns its read half, then release the multi as the base class would.
void	ObserveIncomingData (const unsigned char *data, std::size_t size) override
	Append decoded application bytes to the pending parser buffer.
const curl::fuzzer::proto::Scenario *	scenario () const
	Borrowed scenario for the synchronous drive, or nullptr outside RunLoop().
const std::string *	NextControlReply ()
	Return the next command-aligned response within the shared response-count budget.
bool	WriteControlBytes (std::string_view bytes)
	Keep failed peer writes local to the mock.
bool	WriteNextReply ()
	Consume the next scripted reply.
void	ShutdownControlWrite ()
	Half-close the server-to-client direction while retaining the read half.
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 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::PingpongMockServer
static std::string_view	FirstToken (std::string_view line)
	Remove optional leading horizontal whitespace and return the first token without allocating.
static std::string_view	SecondToken (std::string_view line)
	Skip the first token and return the second whitespace-delimited token without allocating.
static bool	TokenEquals (std::string_view token, std::string_view expected_uppercase)
	Fold only ASCII lowercase command letters.
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 status-line POP3 command/reply exchange over implicit TLS.

POP3S differs from POP3 only in transport setup: curl establishes TLS immediately after CONNECT and then executes the same greeting, CAPA, USER/PASS or APOP, LIST, RETR, and QUIT sequence. This peer therefore inherits the command-aware parser and replaces only the connection factory and trust installation.

POP3 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 pop3s_mock_server.h.

Constructor & Destructor Documentation

◆ Pop3sMockServer()

proto_fuzzer::Pop3sMockServer::Pop3sMockServer ( )

Construct the OpenSSL server carrier used by every POP3S scenario.

POP3 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 pop3s_mock_server.cc.

◆ ~Pop3sMockServer()

proto_fuzzer::Pop3sMockServer::~Pop3sMockServer ( )

override

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

The inherited status-line parser holds no transport state of its own.

Definition at line 27 of file pop3s_mock_server.cc.

Member Function Documentation

◆ completed_handshake_count()

std::size_t proto_fuzzer::Pop3sMockServer::completed_handshake_count ( ) const

Returns: Number of connections that completed TLS negotiation.

Definition at line 48 of file pop3s_mock_server.cc.

◆ CreateConnection()

std::unique_ptr< MockConnection > proto_fuzzer::Pop3sMockServer::CreateConnection ( )

overrideprotectedvirtual

Wrap one socketpair endpoint in an OpenSSL acceptor.

The inherited POP3 loop advances the handshake and then parses only decrypted commands.

Returns: Newly allocated nonblocking TLS connection.

Reimplemented from proto_fuzzer::PingpongMockServer.

Definition at line 42 of file pop3s_mock_server.cc.

◆ Install()

void proto_fuzzer::Pop3sMockServer::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

easy	Easy handle that will initiate the POP3S exchange.

Reimplemented from proto_fuzzer::MockServerBase.

Definition at line 34 of file pop3s_mock_server.cc.

◆ negotiated_alpn()

std::string proto_fuzzer::Pop3sMockServer::negotiated_alpn ( ) const

Returns: ALPN protocol selected by curl, or an empty string when absent.

Definition at line 51 of file pop3s_mock_server.cc.

◆ negotiated_tls_version()

int proto_fuzzer::Pop3sMockServer::negotiated_tls_version ( ) const

Returns: Protocol version selected by the most recent handshake, or zero.

Definition at line 45 of file pop3s_mock_server.cc.

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

proto_fuzzer/pop3s_mock_server.h
proto_fuzzer/pop3s_mock_server.cc

Public Member Functions

Protected Member Functions

Additional Inherited Members