10 #ifndef NETWORK_CRYPTO_INTERNAL_H
11 #define NETWORK_CRYPTO_INTERNAL_H
25 struct X25519Key : std::array<uint8_t, X25519_KEY_SIZE> {
46 using X25519Mac = std::array<uint8_t, X25519_MAC_SIZE>;
64 std::array<uint8_t, X25519_KEY_SIZE + X25519_KEY_SIZE>
keys;
117 void SendRequest(
struct Packet &p);
126 std::unique_ptr<NetworkEncryptionHandler> CreateClientToServerEncryptionHandler()
const;
127 std::unique_ptr<NetworkEncryptionHandler> CreateServerToClientEncryptionHandler()
const;
146 virtual std::string_view
GetName()
const override {
return "X25519-KeyExchangeOnly-client"; }
167 virtual void SendRequest(
struct Packet &p)
override { this->X25519AuthenticationHandler::SendRequest(p); }
170 virtual std::string_view
GetName()
const override {
return "X25519-KeyExchangeOnly-server"; }
172 virtual bool CanBeUsed()
const override {
return true; }
187 std::shared_ptr<NetworkAuthenticationPasswordRequestHandler> handler;
200 virtual std::string_view
GetName()
const override {
return "X25519-PAKE-client"; }
224 virtual void SendRequest(
struct Packet &p)
override { this->X25519AuthenticationHandler::SendRequest(p); }
227 virtual std::string_view
GetName()
const override {
return "X25519-PAKE-server"; }
255 virtual std::string_view
GetName()
const override {
return "X25519-AuthorizedKey-client"; }
282 virtual void SendRequest(
struct Packet &p)
override { this->X25519AuthenticationHandler::SendRequest(p); }
285 virtual std::string_view
GetName()
const override {
return "X25519-AuthorizedKey-server"; }
302 using Handler = std::unique_ptr<NetworkAuthenticationClientHandler>;
313 void Add(
Handler &&handler) { this->handlers.push_back(std::move(handler)); }
318 virtual std::string_view
GetName()
const override;
332 using Handler = std::unique_ptr<NetworkAuthenticationServerHandler>;
343 virtual std::string_view
GetName()
const override;
347 virtual std::string
GetPeerPublicKey()
const override {
return this->handlers.back()->GetPeerPublicKey(); }
Handler for combining a number of authentication handlers, where the failure of one of the handlers w...
virtual std::unique_ptr< NetworkEncryptionHandler > CreateClientToServerEncryptionHandler() const override
Create a NetworkEncryptionHandler to encrypt or decrypt messages from the client to the server.
std::vector< Handler > handlers
The handlers that we can authenticate with.
virtual NetworkAuthenticationMethod GetAuthenticationMethod() const override
Get the method this handler is providing functionality for.
NetworkAuthenticationClientHandler * current_handler
The currently active handler.
void Add(Handler &&handler)
Add the given sub-handler to this handler.
virtual bool SendResponse(struct Packet &p) override
Create the response to send to the server.
virtual std::unique_ptr< NetworkEncryptionHandler > CreateServerToClientEncryptionHandler() const override
Create a NetworkEncryptionHandler to encrypt or decrypt messages from the server to the client.
std::unique_ptr< NetworkAuthenticationClientHandler > Handler
The type of the inner handlers.
virtual RequestResult ReceiveRequest(struct Packet &p) override
Read a request from the server.
virtual bool ReceiveEnableEncryption(struct Packet &p) override
Read the request to enable encryption from the server.
virtual std::string_view GetName() const override
Get the name of the handler for debug messages.
Handler for combining a number of authentication handlers, where the failure of one of the handlers w...
virtual std::string_view GetName() const override
Get the name of the handler for debug messages.
virtual std::unique_ptr< NetworkEncryptionHandler > CreateServerToClientEncryptionHandler() const override
Create a NetworkEncryptionHandler to encrypt or decrypt messages from the server to the client.
void Add(Handler &&handler)
Add the given sub-handler to this handler, if the handler can be used (e.g.
virtual std::string GetPeerPublicKey() const override
Get the public key the peer provided during the authentication.
std::vector< Handler > handlers
The handlers that we can (still) authenticate with.
std::unique_ptr< NetworkAuthenticationServerHandler > Handler
The type of the inner handlers.
virtual ResponseResult ReceiveResponse(struct Packet &p) override
Read the response from the client.
virtual std::unique_ptr< NetworkEncryptionHandler > CreateClientToServerEncryptionHandler() const override
Create a NetworkEncryptionHandler to encrypt or decrypt messages from the client to the server.
virtual bool CanBeUsed() const override
Checks whether this handler can be used with the current configuration.
virtual NetworkAuthenticationMethod GetAuthenticationMethod() const override
Get the method this handler is providing functionality for.
virtual void SendRequest(struct Packet &p) override
Create the request to send to the client.
virtual void SendEnableEncryption(struct Packet &p) override
Create the request to enable encryption to the client.
Callback interface for server implementations to provide the authorized key validation.
virtual bool CanBeUsed() const =0
Check whether the key handler can be used, i.e.
Base class for client side cryptographic authentication handlers.
virtual bool ReceiveEnableEncryption(struct Packet &p)=0
Read the request to enable encryption from the server.
RequestResult
The processing result of receiving a request.
@ READY_FOR_RESPONSE
We do not have to wait for user input, and can immediately respond to the server.
@ INVALID
We have received an invalid request.
virtual std::unique_ptr< NetworkEncryptionHandler > CreateClientToServerEncryptionHandler() const =0
Create a NetworkEncryptionHandler to encrypt or decrypt messages from the client to the server.
virtual std::unique_ptr< NetworkEncryptionHandler > CreateServerToClientEncryptionHandler() const =0
Create a NetworkEncryptionHandler to encrypt or decrypt messages from the server to the client.
Callback interface for server implementations to provide the current password.
virtual std::string_view GetPassword() const =0
Callback to return the password where to validate against.
Base class for server side cryptographic authentication handlers.
ResponseResult
The processing result of receiving a response.
Base for handlers using a X25519 key exchange to perform authentication.
bool ReceiveEnableEncryption(struct Packet &p)
Receive the initial nonce for the encrypted connection.
X25519SecretKey our_secret_key
The secret key used by us.
X25519AuthenticationHandler(const X25519SecretKey &secret_key)
Create the handler, and generate the public keys accordingly.
X25519PublicKey peer_public_key
The public key used by our peer.
X25519Nonce encryption_nonce
The nonce to prevent replay attacks the encrypted connection.
NetworkAuthenticationServerHandler::ResponseResult ReceiveResponse(struct Packet &p, std::string_view derived_key_extra_payload)
Read the key exchange data from a Packet that came from the client, and check whether the client pass...
X25519Nonce key_exchange_nonce
The nonce to prevent replay attacks of the key exchange.
bool SendResponse(struct Packet &p, std::string_view derived_key_extra_payload)
Perform the key exchange, and when that is correct fill the Packet with the appropriate data.
X25519DerivedKeys derived_keys
Keys derived from the authentication process.
std::string GetPeerPublicKey() const
Get the public key the peer provided for the key exchange.
bool ReceiveRequest(struct Packet &p)
Read the key exchange data from a Packet that came from the server,.
void SendEnableEncryption(struct Packet &p) const
Send the initial nonce for the encrypted connection.
X25519PublicKey our_public_key
The public key used by us.
Handler for clients using a X25519 key exchange to perform authentication via a set of authorized (pu...
virtual bool SendResponse(struct Packet &p) override
Create the response to send to the server.
virtual std::string_view GetName() const override
Get the name of the handler for debug messages.
virtual std::unique_ptr< NetworkEncryptionHandler > CreateClientToServerEncryptionHandler() const override
Create a NetworkEncryptionHandler to encrypt or decrypt messages from the client to the server.
virtual RequestResult ReceiveRequest(struct Packet &p) override
Read a request from the server.
virtual NetworkAuthenticationMethod GetAuthenticationMethod() const override
Get the method this handler is providing functionality for.
static X25519SecretKey GetValidSecretKeyAndUpdatePublicKey(std::string &secret_key, std::string &public_key)
Get the secret key from the given string.
X25519AuthorizedKeyClientHandler(const X25519SecretKey &secret_key)
Create the handler that uses the given password to check against.
virtual std::unique_ptr< NetworkEncryptionHandler > CreateServerToClientEncryptionHandler() const override
Create a NetworkEncryptionHandler to encrypt or decrypt messages from the server to the client.
virtual bool ReceiveEnableEncryption(struct Packet &p) override
Read the request to enable encryption from the server.
Handler for servers using a X25519 key exchange to perform authentication via a set of authorized (pu...
virtual NetworkAuthenticationMethod GetAuthenticationMethod() const override
Get the method this handler is providing functionality for.
virtual std::unique_ptr< NetworkEncryptionHandler > CreateServerToClientEncryptionHandler() const override
Create a NetworkEncryptionHandler to encrypt or decrypt messages from the server to the client.
X25519AuthorizedKeyServerHandler(const X25519SecretKey &secret_key, const NetworkAuthenticationAuthorizedKeyHandler *authorized_key_handler)
Create the handler that uses the given authorized keys to check against.
virtual bool CanBeUsed() const override
Checks whether this handler can be used with the current configuration.
virtual std::string GetPeerPublicKey() const override
Get the public key the peer provided during the authentication.
virtual void SendRequest(struct Packet &p) override
Create the request to send to the client.
virtual std::unique_ptr< NetworkEncryptionHandler > CreateClientToServerEncryptionHandler() const override
Create a NetworkEncryptionHandler to encrypt or decrypt messages from the client to the server.
virtual ResponseResult ReceiveResponse(struct Packet &p) override
Read the response from the client.
const NetworkAuthenticationAuthorizedKeyHandler * authorized_key_handler
The handler of the authorized keys.
virtual void SendEnableEncryption(struct Packet &p) override
Create the request to enable encryption to the client.
virtual std::string_view GetName() const override
Get the name of the handler for debug messages.
Container for the keys that derived from the X25519 key exchange mechanism.
std::array< uint8_t, X25519_KEY_SIZE+X25519_KEY_SIZE > keys
Single contiguous buffer to store the derived keys in, as they are generated as a single hash.
bool Exchange(const X25519PublicKey &peer_public_key, X25519KeyExchangeSide side, const X25519SecretKey &our_secret_key, const X25519PublicKey &our_public_key, std::string_view extra_payload)
Perform the actual key exchange.
std::span< const uint8_t > ClientToServer() const
Get the key to encrypt or decrypt a message sent from the client to the server.
std::span< const uint8_t > ServerToClient() const
Get the key to encrypt or decrypt a message sent from the server to the client.
~X25519DerivedKeys()
Ensure the derived keys do not get leaked when we're done with it.
Client side handler for using X25519 without actual authentication.
X25519KeyExchangeOnlyClientHandler(const X25519SecretKey &secret_key)
Create the handler that that one does the key exchange.
virtual bool ReceiveEnableEncryption(struct Packet &p) override
Read the request to enable encryption from the server.
virtual bool SendResponse(struct Packet &p) override
Create the response to send to the server.
virtual std::unique_ptr< NetworkEncryptionHandler > CreateServerToClientEncryptionHandler() const override
Create a NetworkEncryptionHandler to encrypt or decrypt messages from the server to the client.
virtual RequestResult ReceiveRequest(struct Packet &p) override
Read a request from the server.
virtual std::string_view GetName() const override
Get the name of the handler for debug messages.
virtual NetworkAuthenticationMethod GetAuthenticationMethod() const override
Get the method this handler is providing functionality for.
virtual std::unique_ptr< NetworkEncryptionHandler > CreateClientToServerEncryptionHandler() const override
Create a NetworkEncryptionHandler to encrypt or decrypt messages from the client to the server.
Server side handler for using X25519 without actual authentication.
X25519KeyExchangeOnlyServerHandler(const X25519SecretKey &secret_key)
Create the handler that that one does the key exchange.
virtual NetworkAuthenticationMethod GetAuthenticationMethod() const override
Get the method this handler is providing functionality for.
virtual std::unique_ptr< NetworkEncryptionHandler > CreateClientToServerEncryptionHandler() const override
Create a NetworkEncryptionHandler to encrypt or decrypt messages from the client to the server.
virtual std::unique_ptr< NetworkEncryptionHandler > CreateServerToClientEncryptionHandler() const override
Create a NetworkEncryptionHandler to encrypt or decrypt messages from the server to the client.
virtual bool CanBeUsed() const override
Checks whether this handler can be used with the current configuration.
virtual void SendEnableEncryption(struct Packet &p) override
Create the request to enable encryption to the client.
virtual void SendRequest(struct Packet &p) override
Create the request to send to the client.
virtual std::string_view GetName() const override
Get the name of the handler for debug messages.
virtual std::string GetPeerPublicKey() const override
Get the public key the peer provided during the authentication.
virtual ResponseResult ReceiveResponse(struct Packet &p) override
Read the response from the client.
Client side handler for using X25519 with a password-authenticated key exchange.
X25519PAKEClientHandler(const X25519SecretKey &secret_key, std::shared_ptr< NetworkAuthenticationPasswordRequestHandler > handler)
Create the handler with the given password handler.
virtual bool ReceiveEnableEncryption(struct Packet &p) override
Read the request to enable encryption from the server.
virtual std::unique_ptr< NetworkEncryptionHandler > CreateServerToClientEncryptionHandler() const override
Create a NetworkEncryptionHandler to encrypt or decrypt messages from the server to the client.
virtual bool SendResponse(struct Packet &p) override
Create the response to send to the server.
virtual std::unique_ptr< NetworkEncryptionHandler > CreateClientToServerEncryptionHandler() const override
Create a NetworkEncryptionHandler to encrypt or decrypt messages from the client to the server.
virtual RequestResult ReceiveRequest(struct Packet &p) override
Read a request from the server.
virtual std::string_view GetName() const override
Get the name of the handler for debug messages.
virtual NetworkAuthenticationMethod GetAuthenticationMethod() const override
Get the method this handler is providing functionality for.
Server side handler for using X25519 with a password-authenticated key exchange.
virtual void SendRequest(struct Packet &p) override
Create the request to send to the client.
virtual NetworkAuthenticationMethod GetAuthenticationMethod() const override
Get the method this handler is providing functionality for.
X25519PAKEServerHandler(const X25519SecretKey &secret_key, const NetworkAuthenticationPasswordProvider *password_provider)
Create the handler with the given password provider.
virtual std::unique_ptr< NetworkEncryptionHandler > CreateServerToClientEncryptionHandler() const override
Create a NetworkEncryptionHandler to encrypt or decrypt messages from the server to the client.
virtual bool CanBeUsed() const override
Checks whether this handler can be used with the current configuration.
virtual std::unique_ptr< NetworkEncryptionHandler > CreateClientToServerEncryptionHandler() const override
Create a NetworkEncryptionHandler to encrypt or decrypt messages from the client to the server.
virtual void SendEnableEncryption(struct Packet &p) override
Create the request to enable encryption to the client.
const NetworkAuthenticationPasswordProvider * password_provider
The password to check against.
virtual ResponseResult ReceiveResponse(struct Packet &p) override
Read the response from the client.
virtual std::string_view GetName() const override
Get the name of the handler for debug messages.
virtual std::string GetPeerPublicKey() const override
Get the public key the peer provided during the authentication.
Crypto specific bits of the network handling.
NetworkAuthenticationMethod
The authentication method that can be used.
@ NETWORK_AUTH_METHOD_X25519_KEY_EXCHANGE_ONLY
No actual authentication is taking place, just perform a x25519 key exchange. This method is not supp...
@ NETWORK_AUTH_METHOD_X25519_PAKE
Authentication using x25519 password-authenticated key agreement.
@ NETWORK_AUTH_METHOD_X25519_AUTHORIZED_KEY
Authentication using x22519 key exchange and authorized keys.
constexpr size_t X25519_MAC_SIZE
The number of bytes the message authentication codes are in X25519.
constexpr size_t X25519_NONCE_SIZE
The number of bytes the nonces are in X25519.
X25519KeyExchangeSide
The side of the key exchange.
@ SERVER
We are the server.
@ CLIENT
We are the client.
std::array< uint8_t, X25519_KEY_EXCHANGE_MESSAGE_SIZE > X25519KeyExchangeMessage
Container for a X25519 key exchange message.
constexpr size_t X25519_KEY_EXCHANGE_MESSAGE_SIZE
The number of bytes the (random) payload of the authentication message has.
constexpr size_t X25519_KEY_SIZE
The number of bytes the public and secret keys are in X25519.
std::array< uint8_t, X25519_MAC_SIZE > X25519Mac
Container for a X25519 message authentication code.
Internal entity of a packet.
Container for a X25519 key that is automatically crypto-wiped when destructed.
~X25519Key()
Ensure the key does not get leaked when we're done with it.
Container for a X25519 nonce that is automatically crypto-wiped when destructed.
static X25519Nonce CreateRandom()
Create a new nonce that's filled with random bytes.
~X25519Nonce()
Ensure the nonce does not get leaked when we're done with it.
Container for a X25519 public key.
Container for a X25519 secret key.
X25519PublicKey CreatePublicKey() const
Create the public key associated with this secret key.
static X25519SecretKey CreateRandom()
Create a new secret key that's filled with random bytes.