Base class for implementing servers that use gzipped-WML network protocol. More...

#include <server_base.hpp>

Inheritance diagram for server_base:

Classes
struct	login_ban_info

Public Types
typedef std::map< std::string, std::string >	info_table

Public Member Functions
	server_base (unsigned short port, bool keep_alive)

virtual	~server_base ()

int	run ()

template<class SocketPtr >
void	coro_send_doc (SocketPtr socket, simple_wml::document &doc, const boost::asio::yield_context &yield)
	Send a WML document from within a coroutine. More...

void	coro_send_file (const socket_ptr &socket, const std::string &filename, const boost::asio::yield_context &yield)
	Send contents of entire file directly to socket from within a coroutine. More...

void	coro_send_file (tls_socket_ptr socket, const std::string &filename, const boost::asio::yield_context &yield)

template<class SocketPtr >
std::unique_ptr< simple_wml::document >	coro_receive_doc (SocketPtr socket, const boost::asio::yield_context &yield)
	Receive WML document from a coroutine. More...

template<class SocketPtr >
void	async_send_doc_queued (SocketPtr socket, simple_wml::document &doc)
	High level wrapper for sending a WML document. More...

template<class SocketPtr >
void	async_send_error (SocketPtr socket, const std::string &msg, const char *error_code="", const info_table &info={})

template<class SocketPtr >
void	async_send_warning (SocketPtr socket, const std::string &msg, const char *warning_code="", const info_table &info={})

std::string	hash_password (const std::string &pw, const std::string &salt, const std::string &username)
	Handles hashing the password provided by the player before comparing it to the hashed password in the forum database. More...

Protected Member Functions
void	load_tls_config (const config &cfg)

void	start_server ()

void	serve (const boost::asio::yield_context &yield, boost::asio::ip::tcp::acceptor &acceptor, const boost::asio::ip::tcp::endpoint &endpoint)

virtual void	handle_new_client (socket_ptr socket)=0

virtual void	handle_new_client (tls_socket_ptr socket)=0

virtual bool	accepting_connections () const

virtual bool	ip_exceeds_connection_limit (const std::string &) const

virtual utils::optional< login_ban_info >	is_ip_banned (const std::string &)

void	read_from_fifo ()

virtual void	handle_read_from_fifo (const boost::system::error_code &error, std::size_t bytes_transferred)=0

virtual void	handle_sighup (const boost::system::error_code &error, int signal_number)=0

Protected Attributes
unsigned short	port_

bool	keep_alive_

boost::asio::io_context	io_service_

boost::asio::ssl::context	tls_context_ { boost::asio::ssl::context::sslv23 }

bool	tls_enabled_ { false }

boost::asio::ip::tcp::acceptor	acceptor_v6_

boost::asio::ip::tcp::acceptor	acceptor_v4_

uint32_t	handshake_response_

boost::asio::posix::stream_descriptor	input_

std::string	fifo_path_

boost::asio::streambuf	admin_cmd_

boost::asio::signal_set	sighup_

Private Member Functions
template<class SocketPtr >
void	send_doc_queued (SocketPtr socket, std::unique_ptr< simple_wml::document > &doc_ptr, boost::asio::yield_context yield)

Detailed Description

Base class for implementing servers that use gzipped-WML network protocol.

The protocol is based on TCP connection between client and server. Before WML payloads can be sent a handshake is required. Handshake process is as follows:

client establishes a TCP connection to server.
client sends 32-bit integer(network byte order) representing protocol version requested.
server receives 32-bit integer. Depending on number received server does the following: 0: unencrypted protocol, send unspecified 32-bit integer for compatibility(current implementation sends 42) 1: depending on whether TLS is enabled on server if TLS enabled: send 32-bit integer 0 and immediately start TLS, client is expected to start TLS on receiving this 0 if TLS disabled: send 32-bit integer 0xFFFFFFFF, on receiving this client should proceed as with unencrypted connection or immediately close any other number: server closes connection immediately
at this point handshake is completed and client and server can exchange WML messages

Message format is as follows:

32-bit unsigned integer(network byte order), this is size of the following payload
payload: gzipped WML data, which is WML text fed through gzip utility or the equivalent library function.

Definition at line 80 of file server_base.hpp.

Member Typedef Documentation

◆ info_table

typedef std::map<std::string, std::string> server_base::info_table

Definition at line 122 of file server_base.hpp.

Constructor & Destructor Documentation

◆ server_base()

server_base::server_base	(	unsigned short	port,
		bool	keep_alive
	)

Definition at line 64 of file server_base.cpp.

◆ ~server_base()

virtual server_base::~server_base ( )

inlinevirtual

Definition at line 86 of file server_base.hpp.

Member Function Documentation

◆ accepting_connections()

virtual bool server_base::accepting_connections ( ) const

inlineprotectedvirtual

Reimplemented in wesnothd::server.

Definition at line 155 of file server_base.hpp.

Referenced by serve().

◆ async_send_doc_queued()

template<class SocketPtr >

void server_base::async_send_doc_queued	(	SocketPtr	socket,
		simple_wml::document &	doc
	)

High level wrapper for sending a WML document.

This function returns before send is finished. This function can be called again on same socket before previous send was finished. WML documents are kept in internal queue and sent in FIFO order.

Parameters

socket
doc	Document to send. A copy of it will be made so there is no need to keep the reference live after the function returns.

Definition at line 586 of file server_base.cpp.

References simple_wml::document::clone(), e, and io_service_.

Referenced by async_send_error(), async_send_warning(), wesnothd::server::handle_player(), campaignd::server::handle_request_campaign_list(), campaignd::server::handle_server_id(), wesnothd::server::login_client(), campaignd::server::send_error(), campaignd::server::send_message(), wesnothd::server::send_password_request(), wesnothd::server::send_server_message(), and wesnothd::server::send_to_player().

◆ async_send_error()

template<class SocketPtr >

template void server_base::async_send_error< tls_socket_ptr >	(	SocketPtr	socket,
		const std::string &	msg,
		const char *	error_code = `""`,
		const info_table &	info = `{}`
	)

Definition at line 598 of file server_base.cpp.

References simple_wml::node::add_child(), async_send_doc_queued(), simple_wml::document::child(), lg::info(), wfl::msg(), simple_wml::document::root(), simple_wml::node::set_attr(), and simple_wml::node::set_attr_dup().

Referenced by wesnothd::server::authenticate(), coro_receive_doc(), wesnothd::server::is_login_allowed(), wesnothd::server::kick_handler(), wesnothd::server::kickban_handler(), wesnothd::server::login_client(), and serve().

◆ async_send_warning()

template<class SocketPtr >

template void server_base::async_send_warning< tls_socket_ptr >	(	SocketPtr	socket,
		const std::string &	msg,
		const char *	warning_code = `""`,
		const info_table &	info = `{}`
	)

Definition at line 612 of file server_base.cpp.

References simple_wml::node::add_child(), async_send_doc_queued(), simple_wml::document::child(), lg::info(), wfl::msg(), simple_wml::document::root(), simple_wml::node::set_attr(), and simple_wml::node::set_attr_dup().

Referenced by wesnothd::server::authenticate().

◆ coro_receive_doc()

template<class SocketPtr >

template std::unique_ptr< simple_wml::document > server_base::coro_receive_doc< tls_socket_ptr >	(	SocketPtr	socket,
		const boost::asio::yield_context &	yield
	)

Receive WML document from a coroutine.

Parameters

socket
yield	The function will suspend on read operation using this yield context

Returns: unique_ptr with doc deceived. In case of error empty unique_ptr

Definition at line 526 of file server_base.cpp.

References async_send_error(), check_error(), simple_wml::document::document_size_limit, e, ERR_SERVER, log_address(), and utf8::size().

Referenced by wesnothd::server::handle_player(), wesnothd::server::login_client(), and campaignd::server::serve_requests().

◆ coro_send_doc()

template<class SocketPtr >

template void server_base::coro_send_doc< tls_socket_ptr >	(	SocketPtr	socket,
		simple_wml::document &	doc,
		const boost::asio::yield_context &	yield
	)

Send a WML document from within a coroutine.

Parameters

socket
doc
yield	The function will suspend on write operation using this yield context

Definition at line 314 of file server_base.cpp.

References check_error(), dump_wml, e, log_address(), simple_wml::document::output(), simple_wml::document::output_compressed(), s, utf8::size(), and WRN_CONFIG.

Referenced by campaignd::server::handle_request_campaign(), wesnothd::server::login_client(), and send_doc_queued().

◆ coro_send_file() [1/2]

void server_base::coro_send_file	(	const socket_ptr &	socket,
		const std::string &	filename,
		const boost::asio::yield_context &	yield
	)

Send contents of entire file directly to socket from within a coroutine.

Parameters

socket
filename
yield	The function will suspend on write operations using this yield context

Definition at line 519 of file server_base.cpp.

References coro_send_file_userspace(), and filename.

Referenced by campaignd::server::handle_request_campaign(), and campaignd::server::handle_request_campaign_hash().

◆ coro_send_file() [2/2]

void server_base::coro_send_file	(	tls_socket_ptr	socket,
		const std::string &	filename,
		const boost::asio::yield_context &	yield
	)

Definition at line 514 of file server_base.cpp.

References coro_send_file_userspace(), and filename.

◆ handle_new_client() [1/2]

virtual void server_base::handle_new_client ( socket_ptr socket )

protectedpure virtual

Implemented in wesnothd::server, campaignd::server, wesnothd::server, and campaignd::server.

Referenced by serve().

◆ handle_new_client() [2/2]

virtual void server_base::handle_new_client ( tls_socket_ptr socket )

protectedpure virtual

Implemented in wesnothd::server, campaignd::server, wesnothd::server, and campaignd::server.

◆ handle_read_from_fifo()

virtual void server_base::handle_read_from_fifo	(	const boost::system::error_code &	error,
		std::size_t	bytes_transferred
	)

protectedpure virtual

Implemented in wesnothd::server, and campaignd::server.

Referenced by read_from_fifo().

◆ handle_sighup()

virtual void server_base::handle_sighup	(	const boost::system::error_code &	error,
		int	signal_number
	)

protectedpure virtual

Implemented in wesnothd::server, and campaignd::server.

Referenced by start_server().

◆ hash_password()

std::string server_base::hash_password	(	const std::string &	pw,
		const std::string &	salt,
		const std::string &	username
	)

Handles hashing the password provided by the player before comparing it to the hashed password in the forum database.

Parameters

pw	The plaintext password.
salt	The salt as retrieved from the forum database.
username	The player attempting to log in.

Returns: The hashed password, or empty if the password couldn't be hashed.

Definition at line 643 of file server_base.cpp.

References utils::md5::base64_digest(), lg::err(), ERR_SERVER, utils::bcrypt::from_salted_salt(), utils::md5::get_iteration_count(), utils::md5::get_salt(), utils::bcrypt::hash_pw(), utils::md5::is_valid_prefix(), and utils::bcrypt::is_valid_prefix().

Referenced by wesnothd::server::authenticate(), and campaignd::server::authenticate_forum().

◆ ip_exceeds_connection_limit()

virtual bool server_base::ip_exceeds_connection_limit ( const std::string & ) const

inlineprotectedvirtual

Reimplemented in wesnothd::server.

Definition at line 156 of file server_base.hpp.

Referenced by serve().

◆ is_ip_banned()

virtual utils::optional<login_ban_info> server_base::is_ip_banned ( const std::string & )

inlineprotectedvirtual

Reimplemented in wesnothd::server.

Definition at line 165 of file server_base.hpp.

Referenced by serve().

◆ load_tls_config()

void server_base::load_tls_config ( const config & cfg )

protected

Definition at line 626 of file server_base.cpp.

References tls_context_, and tls_enabled_.

Referenced by campaignd::server::load_config(), and wesnothd::server::load_config().

◆ read_from_fifo()

void server_base::read_from_fifo ( )

protected

Definition at line 243 of file server_base.cpp.

References admin_cmd_, handle_read_from_fifo(), and input_.

Referenced by campaignd::server::handle_read_from_fifo(), wesnothd::server::handle_read_from_fifo(), campaignd::server::load_config(), and wesnothd::server::setup_fifo().

◆ run()

int server_base::run ( )

Definition at line 252 of file server_base.cpp.

References e, ERR_SERVER, io_service_, and LOG_SERVER.

Referenced by main(), and run_campaignd().

◆ send_doc_queued()

template<class SocketPtr >

void server_base::send_doc_queued	(	SocketPtr	socket,
		std::unique_ptr< simple_wml::document > &	doc_ptr,
		boost::asio::yield_context	yield
	)

private

Definition at line 569 of file server_base.cpp.

References coro_send_doc(), ON_SCOPE_EXIT, and utf8::size().

◆ serve()

void server_base::serve	(	const boost::asio::yield_context &	yield,
		boost::asio::ip::tcp::acceptor &	acceptor,
		const boost::asio::ip::tcp::endpoint &	endpoint
	)

protected

Definition at line 103 of file server_base.cpp.

References accepting_connections(), async_send_error(), check_error(), client_address(), DBG_SERVER, utils::decayed_is_same, e, ERR_SERVER, handle_new_client(), handshake_response_, io_service_, ip_exceeds_connection_limit(), is_ip_banned(), keep_alive_, log_address(), LOG_SERVER, tls_context_, and tls_enabled_.

Referenced by start_server().

◆ start_server()

void server_base::start_server ( )

protected

Definition at line 78 of file server_base.cpp.

References acceptor_v4_, acceptor_v6_, e, handle_sighup(), handshake_response_, io_service_, port_, serve(), and sighup_.

Referenced by campaignd::server::server(), and wesnothd::server::server().

Member Data Documentation

◆ acceptor_v4_

boost::asio::ip::tcp::acceptor server_base::acceptor_v4_

protected

Definition at line 143 of file server_base.hpp.

Referenced by wesnothd::server::restart_handler(), wesnothd::server::shut_down_handler(), and start_server().

◆ acceptor_v6_

boost::asio::ip::tcp::acceptor server_base::acceptor_v6_

protected

Definition at line 142 of file server_base.hpp.

Referenced by wesnothd::server::restart_handler(), wesnothd::server::shut_down_handler(), and start_server().

◆ admin_cmd_

boost::asio::streambuf server_base::admin_cmd_

protected

Definition at line 172 of file server_base.hpp.

Referenced by campaignd::server::handle_read_from_fifo(), wesnothd::server::handle_read_from_fifo(), and read_from_fifo().

◆ fifo_path_

std::string server_base::fifo_path_

protected

Definition at line 169 of file server_base.hpp.

Referenced by campaignd::server::load_config().

◆ handshake_response_

uint32_t server_base::handshake_response_

protected

Definition at line 150 of file server_base.hpp.

Referenced by serve(), and start_server().

◆ input_

boost::asio::posix::stream_descriptor server_base::input_

protected

Definition at line 168 of file server_base.hpp.

Referenced by campaignd::server::load_config(), wesnothd::server::load_config(), read_from_fifo(), and wesnothd::server::setup_fifo().

◆ io_service_

boost::asio::io_context server_base::io_service_

protected

Definition at line 139 of file server_base.hpp.

Referenced by async_send_doc_queued(), campaignd::server::handle_new_client(), wesnothd::server::handle_new_client(), wesnothd::server::handle_player_in_lobby(), wesnothd::server::login_client(), run(), serve(), and start_server().

◆ keep_alive_

bool server_base::keep_alive_

protected

Definition at line 138 of file server_base.hpp.

Referenced by serve().

◆ port_

unsigned short server_base::port_

protected

Definition at line 137 of file server_base.hpp.

Referenced by campaignd::server::load_config(), campaignd::server::server(), and start_server().

◆ sighup_

boost::asio::signal_set server_base::sighup_

protected

Definition at line 174 of file server_base.hpp.

Referenced by campaignd::server::handle_sighup(), wesnothd::server::handle_sighup(), and start_server().

◆ tls_context_

boost::asio::ssl::context server_base::tls_context_ { boost::asio::ssl::context::sslv23 }

protected

Definition at line 140 of file server_base.hpp.

Referenced by load_tls_config(), and serve().

◆ tls_enabled_

bool server_base::tls_enabled_ { false }

protected

Definition at line 141 of file server_base.hpp.

Referenced by load_tls_config(), and serve().

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

server/common/server_base.hpp
server/common/server_base.cpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ info_table

Constructor & Destructor Documentation

◆ server_base()

◆ ~server_base()

Member Function Documentation

◆ accepting_connections()

◆ async_send_doc_queued()

◆ async_send_error()

◆ async_send_warning()

◆ coro_receive_doc()

◆ coro_send_doc()

◆ coro_send_file() [1/2]

◆ coro_send_file() [2/2]

◆ handle_new_client() [1/2]

◆ handle_new_client() [2/2]

◆ handle_read_from_fifo()

◆ handle_sighup()

◆ hash_password()

◆ ip_exceeds_connection_limit()

◆ is_ip_banned()

◆ load_tls_config()

◆ read_from_fifo()

◆ run()

◆ send_doc_queued()

◆ serve()

◆ start_server()

Member Data Documentation

◆ acceptor_v4_

◆ acceptor_v6_

◆ admin_cmd_

◆ fifo_path_

◆ handshake_response_

◆ input_

◆ io_service_

◆ keep_alive_

◆ port_

◆ sighup_

◆ tls_context_

◆ tls_enabled_