OpenTTD Source  20241121-master-g67a0fccfad
Public Member Functions
NetworkAuthenticationHandler Class Referenceabstract

Base class for cryptographic authentication handlers. More...

#include <network_crypto.h>

Inheritance diagram for NetworkAuthenticationHandler:
NetworkAuthenticationClientHandler NetworkAuthenticationServerHandler CombinedAuthenticationClientHandler X25519AuthorizedKeyClientHandler X25519KeyExchangeOnlyClientHandler X25519PAKEClientHandler CombinedAuthenticationServerHandler X25519AuthorizedKeyServerHandler X25519KeyExchangeOnlyServerHandler X25519PAKEServerHandler

Public Member Functions

virtual std::string_view GetName () const =0
 Get the name of the handler for debug messages. More...
 
virtual NetworkAuthenticationMethod GetAuthenticationMethod () const =0
 Get the method this handler is providing functionality for. More...
 
virtual std::unique_ptr< NetworkEncryptionHandler > CreateClientToServerEncryptionHandler () const =0
 Create a NetworkEncryptionHandler to encrypt or decrypt messages from the client to the server. More...
 
virtual std::unique_ptr< NetworkEncryptionHandler > CreateServerToClientEncryptionHandler () const =0
 Create a NetworkEncryptionHandler to encrypt or decrypt messages from the server to the client. More...
 

Detailed Description

Base class for cryptographic authentication handlers.

Definition at line 190 of file network_crypto.h.

Member Function Documentation

◆ CreateClientToServerEncryptionHandler()

virtual std::unique_ptr<NetworkEncryptionHandler> NetworkAuthenticationHandler::CreateClientToServerEncryptionHandler ( ) const
pure virtual

Create a NetworkEncryptionHandler to encrypt or decrypt messages from the client to the server.

Returns
The handler for the client to server encryption.

Implemented in CombinedAuthenticationServerHandler, CombinedAuthenticationClientHandler, X25519AuthorizedKeyServerHandler, X25519AuthorizedKeyClientHandler, X25519PAKEServerHandler, X25519PAKEClientHandler, X25519KeyExchangeOnlyServerHandler, and X25519KeyExchangeOnlyClientHandler.

Referenced by CombinedAuthenticationClientHandler::CreateClientToServerEncryptionHandler().

◆ CreateServerToClientEncryptionHandler()

virtual std::unique_ptr<NetworkEncryptionHandler> NetworkAuthenticationHandler::CreateServerToClientEncryptionHandler ( ) const
pure virtual

Create a NetworkEncryptionHandler to encrypt or decrypt messages from the server to the client.

Returns
The handler for the server to client encryption.

Implemented in CombinedAuthenticationServerHandler, CombinedAuthenticationClientHandler, X25519AuthorizedKeyServerHandler, X25519AuthorizedKeyClientHandler, X25519PAKEServerHandler, X25519PAKEClientHandler, X25519KeyExchangeOnlyServerHandler, and X25519KeyExchangeOnlyClientHandler.

Referenced by CombinedAuthenticationClientHandler::CreateServerToClientEncryptionHandler().

◆ GetAuthenticationMethod()

virtual NetworkAuthenticationMethod NetworkAuthenticationHandler::GetAuthenticationMethod ( ) const
pure virtual

Get the method this handler is providing functionality for.

Returns
The NetworkAuthenticationMethod.

Implemented in CombinedAuthenticationServerHandler, CombinedAuthenticationClientHandler, X25519AuthorizedKeyServerHandler, X25519AuthorizedKeyClientHandler, X25519PAKEServerHandler, X25519PAKEClientHandler, X25519KeyExchangeOnlyServerHandler, and X25519KeyExchangeOnlyClientHandler.

Referenced by CombinedAuthenticationClientHandler::GetAuthenticationMethod().

◆ GetName()

virtual std::string_view NetworkAuthenticationHandler::GetName ( ) const
pure virtual

Get the name of the handler for debug messages.

Returns
The name of the handler.

Implemented in CombinedAuthenticationServerHandler, CombinedAuthenticationClientHandler, X25519AuthorizedKeyServerHandler, X25519AuthorizedKeyClientHandler, X25519PAKEServerHandler, X25519PAKEClientHandler, X25519KeyExchangeOnlyServerHandler, and X25519KeyExchangeOnlyClientHandler.

Referenced by CombinedAuthenticationClientHandler::GetName().

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