proxygen: wangle::ServerSocketConfig Struct Reference

#include <ServerSocketConfig.h>

Inheritance diagram for wangle::ServerSocketConfig:

Public Member Functions
	ServerSocketConfig ()

bool	isSSL () const

void	setSocketOptions (const folly::AsyncSocket::OptionMap &opts)

folly::AsyncSocket::OptionMap &	getSocketOptions ()

const folly::AsyncSocket::OptionMap &	getSocketOptions () const

bool	hasExternalPrivateKey () const

Public Attributes
std::string	name

uint32_t	acceptBacklog {1024}

uint32_t	maxNumPendingConnectionsPerWorker {1024}

std::chrono::milliseconds	connectionIdleTimeout {600000}

std::chrono::milliseconds	sslHandshakeTimeout {60000}

folly::SocketAddress	bindAddress

SSLCacheOptions	sslCacheOptions {std::chrono::seconds(0), 20480, 200}

bool	allowInsecureConnectionsOnSecureServer {false}

TLSTicketKeySeeds	initialTicketSeeds

std::vector< SSLContextConfig >	sslContextConfigs

bool	strictSSL {true}

uint32_t	maxConcurrentSSLHandshakes {30720}

bool	enableTCPFastOpen {false}

uint32_t	fastOpenQueueSize {100}

FizzConfig	fizzConfig

Private Attributes
folly::AsyncSocket::OptionMap	socketOptions_

Detailed Description

Configuration for a single Acceptor.

This configures not only accept behavior, but also some types of SSL behavior that may make sense to configure on a per-VIP basis (e.g. which cert(s) we use, etc).

Definition at line 48 of file ServerSocketConfig.h.

Constructor & Destructor Documentation

wangle::ServerSocketConfig::ServerSocketConfig ( )

inline

Definition at line 49 of file ServerSocketConfig.h.

References wangle::TLSTicketKeySeeds::currentSeeds, wangle::SSLUtil::hexlify(), initialTicketSeeds, folly::Random::secureRandom(), seed, string, and uint8_t.

                        {
     // generate a single random current seed
     uint8_t seed[32];
     folly::Random::secureRandom(seed, sizeof(seed));
     initialTicketSeeds.currentSeeds.push_back(
       SSLUtil::hexlify(std::string((char *)seed, sizeof(seed))));
   }

Member Function Documentation

folly::AsyncSocket::OptionMap& wangle::ServerSocketConfig::getSocketOptions ( )

inline

Definition at line 67 of file ServerSocketConfig.h.

References socketOptions_.

                      {
     return socketOptions_;
   }

const folly::AsyncSocket::OptionMap& wangle::ServerSocketConfig::getSocketOptions ( ) const

inline

Definition at line 71 of file ServerSocketConfig.h.

References socketOptions_.

                            {
     return socketOptions_;
   }

bool wangle::ServerSocketConfig::hasExternalPrivateKey ( ) const

inline

Definition at line 75 of file ServerSocketConfig.h.

References sslContextConfigs.

                                      {
     for (const auto& cfg : sslContextConfigs) {
       if (!cfg.isLocalPrivateKey) {
         return true;
       }
     }
     return false;
   }

bool wangle::ServerSocketConfig::isSSL ( ) const

inline

Definition at line 57 of file ServerSocketConfig.h.

References sslContextConfigs.

Referenced by wangle::Acceptor::init(), wangle::Acceptor::isSSL(), and wangle::Acceptor::processEstablishedConnection().

57 { return !(sslContextConfigs.empty()); }

wangle::ServerSocketConfig::sslContextConfigs

std::vector< SSLContextConfig > sslContextConfigs

Definition: ServerSocketConfig.h:134

void wangle::ServerSocketConfig::setSocketOptions ( const folly::AsyncSocket::OptionMap & opts )

inline

Set/get the socket options to apply on all downstream connections.

Definition at line 62 of file ServerSocketConfig.h.

References bindAddress, wangle::filterIPSocketOptions(), folly::SocketAddress::getFamily(), and socketOptions_.

Referenced by proxygen::HTTPServerAcceptor::makeConfig().

                                            {
     socketOptions_ = filterIPSocketOptions(opts, bindAddress.getFamily());
   }

Member Data Documentation

uint32_t wangle::ServerSocketConfig::acceptBacklog {1024}

The depth of the accept queue backlog.

Definition at line 92 of file ServerSocketConfig.h.

Referenced by wangle::ServerBootstrap< DefaultPipeline >::bind(), wangle::ServerBootstrap< DefaultPipeline >::bindImpl(), proxygen::HTTPServerAcceptor::makeConfig(), and wangle::AsyncServerSocketFactory::newSocket().

bool wangle::ServerSocketConfig::allowInsecureConnectionsOnSecureServer {false}

Determines whether or not to allow insecure connections over a secure port. Can be used to multiplex TLS and plaintext on the same port for some services.

Definition at line 124 of file ServerSocketConfig.h.

Referenced by wangle::Acceptor::init(), main(), and proxygen::HTTPServerAcceptor::makeConfig().

folly::SocketAddress wangle::ServerSocketConfig::bindAddress

The address to bind to.

Definition at line 112 of file ServerSocketConfig.h.

Referenced by wangle::Acceptor::addSSLContextConfig(), wangle::Acceptor::init(), proxygen::HTTPServerAcceptor::makeConfig(), proxygen::HTTPSessionAcceptor::onNewConnection(), wangle::Acceptor::resetSSLContextConfigs(), and setSocketOptions().

std::chrono::milliseconds wangle::ServerSocketConfig::connectionIdleTimeout {600000}

The number of milliseconds a connection can be idle before we close it.

Definition at line 102 of file ServerSocketConfig.h.

Referenced by wangle::Acceptor::getConnTimeout(), wangle::Acceptor::initDownstreamConnectionManager(), and proxygen::HTTPServerAcceptor::makeConfig().

bool wangle::ServerSocketConfig::enableTCPFastOpen {false}

Whether to enable TCP fast open. Before turning this option on, for it to work, it must also be enabled on the machine via /proc/sys/net/ipv4/tcp_fastopen, and the keys for TFO should also be set at /proc/sys/net/ipv4/tcp_fastopen_key

Definition at line 153 of file ServerSocketConfig.h.

Referenced by proxygen::HTTPServerAcceptor::makeConfig(), and wangle::AsyncServerSocketFactory::newSocket().

uint32_t wangle::ServerSocketConfig::fastOpenQueueSize {100}

Limit on size of queue of TFO requests by clients.

Definition at line 158 of file ServerSocketConfig.h.

Referenced by proxygen::HTTPServerAcceptor::makeConfig(), and wangle::AsyncServerSocketFactory::newSocket().

FizzConfig wangle::ServerSocketConfig::fizzConfig

Definition at line 160 of file ServerSocketConfig.h.

Referenced by wangle::Acceptor::init(), wangle::Acceptor::resetSSLContextConfigs(), and wangle::Acceptor::setTLSTicketSecrets().

TLSTicketKeySeeds wangle::ServerSocketConfig::initialTicketSeeds

The initial TLS ticket seeds.

Definition at line 129 of file ServerSocketConfig.h.