#include <bio.h>

Inheritance diagram for Ssl::ServerBio:

Collaboration diagram for Ssl::ServerBio:

Public Member Functions
	ServerBio (const int anFd)

void	stateChanged (const SSL *ssl, int where, int ret) override
	The ServerBio version of the Ssl::Bio::stateChanged method.

int	write (const char buf, int size, BIO table) override

int	read (char buf, int size, BIO table) override

void	flush (BIO *table) override

void	setClientFeatures (Security::TlsDetails::Pointer const &details, SBuf const &hello)
	Sets the random number to use in client SSL HELLO message.

bool	resumingSession ()

bool	encryptedCertificates () const

bool	holdWrite () const
	The write hold state.

void	holdWrite (bool h)
	Enables or disables the write hold state.

void	recordInput (bool r)
	Enables or disables the input data recording, for internal analysis.

bool	canSplice ()
	Whether we can splice or not the SSL stream.

bool	canBump ()
	Whether we can bump or not the SSL stream.

void	mode (Ssl::BumpMode m)
	The bumping mode.

Ssl::BumpMode	bumpMode ()
	return the bumping mode

bool	gotHello () const

bool	gotHelloFailed () const
	Return true if the Server Hello parsing failed.

const Security::TlsDetails::Pointer &	receivedHelloDetails () const

int	fd () const
	The SSL socket descriptor.

const SBuf &	rBufData ()
	The buffered input data.

Static Public Member Functions
static BIO *	Create (const int fd, Security::Io::Type type)

static void	Link (SSL ssl, BIO bio)
	Tells ssl connection to use BIO and monitor state via stateChanged()

Protected Attributes
const int	fd_
	the SSL socket we are reading and writing

SBuf	rbuf
	Used to buffer input data.

Private Member Functions
int	readAndGive (char buf, const int size, BIO table)
	Read and give everything to OpenSSL.

int	readAndParse (char buf, const int size, BIO table)

int	readAndBuffer (BIO *table)

int	giveBuffered (char *buf, const int size)

Private Attributes
Security::TlsDetails::Pointer	clientTlsDetails
	SSL client features extracted from ClientHello message or SSL object.

SBuf	clientSentHello
	TLS client hello message, used to adapt our tls Hello message to the server.

SBuf	helloMsg
	Used to buffer output data.

mb_size_t	helloMsgSize

bool	helloBuild
	True if the client hello message sent to the server.

bool	allowSplice
	True if the SSL stream can be spliced.

bool	allowBump
	True if the SSL stream can be bumped.

bool	holdWrite_
	The write hold state of the bio.

bool	record_
	If true the input data recorded to rbuf for internal use.

bool	parsedHandshake
	whether we are done parsing TLS Hello

bool	parseError
	error while parsing server hello message

Ssl::BumpMode	bumpMode_

size_t	rbufConsumePos
	The size of data stored in rbuf which passed to the openSSL.

Security::HandshakeParser	parser_
	The TLS/SSL messages parser.

Detailed Description

BIO node to handle socket IO for squid server side If bumping is enabled, analyses the SSL hello message sent by squid OpenSSL subsystem (step3 bumping step) against bumping mode:

Peek mode: Send client hello message instead of the openSSL generated hello message and normally denies bumping and allow only splice or terminate the SSL connection
Stare mode: Sends the openSSL generated hello message and normally denies splicing and allow bump or terminate the SSL connection If SQUID_USE_OPENSSL_HELLO_OVERWRITE_HACK is enabled also checks if the openSSL library features are compatible with the features reported in web client SSL hello message and if it is, overwrites the openSSL SSL object members to replace hello message with web client hello message. This is may allow bumping in peek mode and splicing in stare mode after the server hello message received.

Definition at line 122 of file bio.h.

Constructor & Destructor Documentation

◆ ServerBio()

Ssl::ServerBio::ServerBio ( const int anFd )

explicit

Definition at line 241 of file bio.cc.

Member Function Documentation

◆ bumpMode()

Ssl::BumpMode Ssl::ServerBio::bumpMode ( )

inline

Definition at line 161 of file bio.h.

References bumpMode_.

Referenced by Ssl::PeekingPeerConnector::noteNegotiationError(), and Ssl::PeekingPeerConnector::noteWantWrite().

◆ canBump()

bool Ssl::ServerBio::canBump ( )

inline

Definition at line 158 of file bio.h.

References allowBump.

Referenced by Ssl::PeekingPeerConnector::checkForPeekAndSplice().

◆ canSplice()

bool Ssl::ServerBio::canSplice ( )

inline

Definition at line 156 of file bio.h.

References allowSplice.

Referenced by Ssl::PeekingPeerConnector::checkForPeekAndSplice().

◆ Create()

BIO * Ssl::Bio::Create	(	const int	fd,
		Security::Io::Type	type
	)

staticinherited

Creates a low-level BIO table, creates a high-level Ssl::Bio object for a given socket, and then links the two together via BIO_C_SET_FD.

Definition at line 63 of file bio.cc.

References Ssl::Bio::fd(), squid_bio_create(), squid_bio_ctrl(), squid_bio_destroy(), squid_bio_puts(), squid_bio_read(), squid_bio_write(), and SquidMethods.

Referenced by CreateSession().

◆ encryptedCertificates()

bool Ssl::ServerBio::encryptedCertificates ( ) const

whether the server encrypts its certificate (e.g., TLS v1.3)

Return values

false the server uses plain certs or its intent is unknown

Definition at line 439 of file bio.cc.

References Security::Tls1p3orLater().

Referenced by Ssl::PeekingPeerConnector::noteNegotiationError().

◆ fd()

int Ssl::Bio::fd ( ) const

inlineinherited

Definition at line 49 of file bio.h.

References Ssl::Bio::fd_.

Referenced by Ssl::Bio::Create(), Security::NegotiationHistory::retrieveNegotiatedInfo(), and squid_bio_ctrl().

◆ flush()

void Ssl::ServerBio::flush ( BIO * table )

overridevirtual

The ServerBio version of the Ssl::Bio::flush method. Flushes any buffered data

Reimplemented from Ssl::Bio.

Definition at line 424 of file bio.cc.

References Ssl::Bio::write().

◆ giveBuffered()

int Ssl::ServerBio::giveBuffered	(	char *	buf,
		const int	size
	)

private

give previously buffered bytes to OpenSSL returns the number of bytes given

Definition at line 341 of file bio.cc.

References debugs, and size.

◆ gotHello()

bool Ssl::ServerBio::gotHello ( ) const

inline

Return values

true	if the Server hello message received

Definition at line 164 of file bio.h.

References parsedHandshake, and parseError.

◆ gotHelloFailed()

bool Ssl::ServerBio::gotHelloFailed ( ) const

inline

Definition at line 167 of file bio.h.

References parsedHandshake, and parseError.

◆ holdWrite() [1/2]

bool Ssl::ServerBio::holdWrite ( ) const

inline

Definition at line 150 of file bio.h.

References holdWrite_.

Referenced by Ssl::PeekingPeerConnector::checkForPeekAndSpliceMatched(), Ssl::PeekingPeerConnector::noteNegotiationError(), and Ssl::PeekingPeerConnector::noteWantWrite().

◆ holdWrite() [2/2]

void Ssl::ServerBio::holdWrite ( bool h )

inline

Definition at line 152 of file bio.h.

References holdWrite_.

◆ Link()

void Ssl::Bio::Link	(	SSL *	ssl,
		BIO *	bio
	)

staticinherited

Definition at line 89 of file bio.cc.

References squid_ssl_info().

Referenced by CreateSession().

◆ mode()

void Ssl::ServerBio::mode ( Ssl::BumpMode m )

inline

Definition at line 160 of file bio.h.

References bumpMode_.

Referenced by Ssl::PeekingPeerConnector::initialize().

◆ rBufData()

const SBuf & Ssl::Bio::rBufData ( )

inlineinherited

Definition at line 61 of file bio.h.

References Ssl::Bio::rbuf.

Referenced by Ssl::PeekingPeerConnector::initialize().

◆ read()

int Ssl::ServerBio::read	(	char *	buf,
		int	size,
		BIO *	table
	)

overridevirtual

The ServerBio version of the Ssl::Bio::read method If the record flag is set then append the data to the rbuf member

Reimplemented from Ssl::Bio.

Definition at line 271 of file bio.cc.

References size.

◆ readAndBuffer()

int Ssl::ServerBio::readAndBuffer ( BIO * table )

private

Reads more data into the read buffer. Returns either the number of bytes read or, on errors (including "try again" errors), a negative number.

Definition at line 327 of file bio.cc.

References Ssl::Bio::read(), and SQUID_TCP_SO_RCVBUF.

◆ readAndGive()

int Ssl::ServerBio::readAndGive	(	char *	buf,
		const int	size,
		BIO *	table
	)

private

Definition at line 281 of file bio.cc.

References Ssl::Bio::read(), and size.

◆ readAndParse()

int Ssl::ServerBio::readAndParse	(	char *	buf,
		const int	size,
		BIO *	table
	)

private

Read and give everything to our parser. When/if parsing is finished (successfully or not), start giving to OpenSSL.

Definition at line 301 of file bio.cc.

References debugs, and size.

◆ receivedHelloDetails()

const Security::TlsDetails::Pointer & Ssl::ServerBio::receivedHelloDetails ( ) const

inline

Returns: the TLS Details advertised by TLS server.

Definition at line 170 of file bio.h.

References Security::HandshakeParser::details, and parser_.

Referenced by Security::PeerConnector::recordNegotiationDetails().

◆ recordInput()

void Ssl::ServerBio::recordInput ( bool r )

inline

Definition at line 154 of file bio.h.

References record_.

Referenced by Ssl::PeekingPeerConnector::checkForPeekAndSpliceMatched(), and Ssl::PeekingPeerConnector::initialize().

◆ resumingSession()

bool Ssl::ServerBio::resumingSession ( )

Definition at line 433 of file bio.cc.

Referenced by Ssl::PeekingPeerConnector::noteNegotiationError().

◆ setClientFeatures()

void Ssl::ServerBio::setClientFeatures	(	Security::TlsDetails::Pointer const &	details,
		SBuf const &	hello
	)

Definition at line 264 of file bio.cc.

Referenced by Ssl::PeekingPeerConnector::initialize().

◆ stateChanged()

void Ssl::ServerBio::stateChanged	(	const SSL *	ssl,
		int	where,
		int	ret
	)

overridevirtual

Reimplemented from Ssl::Bio.

Definition at line 258 of file bio.cc.

References Ssl::Bio::stateChanged().

◆ write()

int Ssl::ServerBio::write	(	const char *	buf,
		int	size,
		BIO *	table
	)

overridevirtual

The ServerBio version of the Ssl::Bio::write method If a clientRandom number is set then rewrites the raw hello message "client random" field with the provided random number. It may buffer the output packets.

Reimplemented from Ssl::Bio.

Definition at line 355 of file bio.cc.

References assert, Ssl::bumpPeek, Ssl::bumpStare, debugs, Must, size, and Ssl::Bio::write().

Member Data Documentation

◆ allowBump

bool Ssl::ServerBio::allowBump

private

Definition at line 186 of file bio.h.

Referenced by canBump().

◆ allowSplice

bool Ssl::ServerBio::allowSplice

private

Definition at line 185 of file bio.h.

Referenced by canSplice().

◆ bumpMode_

Ssl::BumpMode Ssl::ServerBio::bumpMode_

private

Definition at line 191 of file bio.h.

Referenced by bumpMode(), and mode().

◆ clientSentHello

SBuf Ssl::ServerBio::clientSentHello

private

Definition at line 181 of file bio.h.

◆ clientTlsDetails

Security::TlsDetails::Pointer Ssl::ServerBio::clientTlsDetails

private

Definition at line 179 of file bio.h.

◆ fd_

const int Ssl::Bio::fd_

protectedinherited

Definition at line 63 of file bio.h.

Referenced by Ssl::Bio::Bio(), and Ssl::Bio::fd().

◆ helloBuild

bool Ssl::ServerBio::helloBuild

private

Definition at line 184 of file bio.h.

◆ helloMsg

SBuf Ssl::ServerBio::helloMsg

private

Definition at line 182 of file bio.h.

◆ helloMsgSize

mb_size_t Ssl::ServerBio::helloMsgSize

private

Definition at line 183 of file bio.h.

◆ holdWrite_

bool Ssl::ServerBio::holdWrite_

private

Definition at line 187 of file bio.h.

Referenced by holdWrite(), and holdWrite().

◆ parsedHandshake

bool Ssl::ServerBio::parsedHandshake

private

Definition at line 189 of file bio.h.

Referenced by gotHello(), and gotHelloFailed().

◆ parseError

bool Ssl::ServerBio::parseError

private

Definition at line 190 of file bio.h.

Referenced by gotHello(), and gotHelloFailed().

◆ parser_

Security::HandshakeParser Ssl::ServerBio::parser_

private

Definition at line 195 of file bio.h.

Referenced by receivedHelloDetails().

◆ rbuf

SBuf Ssl::Bio::rbuf

protectedinherited

Definition at line 64 of file bio.h.

Referenced by Ssl::Bio::rBufData(), and Ssl::ClientBio::setReadBufData().

◆ rbufConsumePos

size_t Ssl::ServerBio::rbufConsumePos

private

Definition at line 194 of file bio.h.

◆ record_

bool Ssl::ServerBio::record_

private

Definition at line 188 of file bio.h.

Referenced by recordInput().

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

squid/src/ssl/bio.h
squid/src/ssl/bio.cc

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ServerBio()

Member Function Documentation

◆ bumpMode()

◆ canBump()

◆ canSplice()

◆ Create()

◆ encryptedCertificates()

◆ fd()

◆ flush()

◆ giveBuffered()

◆ gotHello()

◆ gotHelloFailed()

◆ holdWrite() [1/2]

◆ holdWrite() [2/2]

◆ Link()

◆ mode()

◆ rBufData()

◆ read()

◆ readAndBuffer()

◆ readAndGive()

◆ readAndParse()

◆ receivedHelloDetails()

◆ recordInput()

◆ resumingSession()

◆ setClientFeatures()

◆ stateChanged()

◆ write()

Member Data Documentation

◆ allowBump

◆ allowSplice

◆ bumpMode_

◆ clientSentHello

◆ clientTlsDetails

◆ fd_

◆ helloBuild

◆ helloMsg

◆ helloMsgSize

◆ holdWrite_

◆ parsedHandshake

◆ parseError

◆ parser_

◆ rbuf

◆ rbufConsumePos

◆ record_