Turi Create  4.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
cppipc::authentication_token_method Class Reference

#include <core/system/cppipc/common/authentication_token_method.hpp>

Public Member Functions

void apply_auth (call_message &msg)
 
void apply_auth (reply_message &msg)
 
bool validate_auth (call_message &msg)
 
bool validate_auth (reply_message &msg)
 

Detailed Description

The authentication token method is the simplest mode of authentication. Both client and server knows a secret token value, then every message between client and server must contain the token. Without additional safeguards, this authentication method does not provide any real security aside from protecting against accidental connections, since any packet sniffer will be able to obtain the token value.

Definition at line 21 of file authentication_token_method.hpp.

Member Function Documentation

◆ apply_auth() [1/2]

void cppipc::authentication_token_method::apply_auth ( call_message msg)
inlinevirtual

Attaches the authentication information to a message sent from the client to the server. This function must be reentrant.

Implements cppipc::authentication_base.

Definition at line 27 of file authentication_token_method.hpp.

◆ apply_auth() [2/2]

void cppipc::authentication_token_method::apply_auth ( reply_message msg)
inlinevirtual

Attaches the authentication information to a message sent from the server to the client. This function must be reentrant.

Implements cppipc::authentication_base.

Definition at line 31 of file authentication_token_method.hpp.

◆ validate_auth() [1/2]

bool cppipc::authentication_token_method::validate_auth ( call_message msg)
inlinevirtual

Validates a message received on the server from a client. This function must be reentrant. If the function returns true, the message is good. Otherwise, the message is bad.

Implements cppipc::authentication_base.

Definition at line 34 of file authentication_token_method.hpp.

◆ validate_auth() [2/2]

bool cppipc::authentication_token_method::validate_auth ( reply_message msg)
inlinevirtual

Validates a message received on the client from a server. This function must be reentrant. If the function returns true, the message is good. Otherwise, the message is bad.

Implements cppipc::authentication_base.

Definition at line 38 of file authentication_token_method.hpp.


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