Contains the authentication settings. More...

#include <fw/RemoteModule.h>

Public Member Functions
template<typename Reflector >
void	reflect (Reflector &r)

AuthMode	getMode () const

void	clearAuth ()
	Clears authentication settings. More...

const std::string &	getPassword () const
	Returns the authentication password. More...

void	setPassword (const boost::optional< std::string > &passwd)
	Sets a password. More...

const RSAKey &	getKey () const
	Returns the authentication key. More...

void	setKey (const boost::optional< std::string > &str)
	Sets a key. More...

void	setKeyFile (const boost::optional< std::string > &file)
	Sets a key file. More...

Public Attributes
std::string	group

Detailed Description

Contains the authentication settings.

Each framework may belong to a certain workgroup. The framework will be able to connect to other frameworks within the same group only. Moreover, there are three modes for authentication:

No additional authentication
Weak authentication using a password
Strong authentication using a RSA key pair

Member Function Documentation

◆ reflect()

void reflect ( Reflector & r )

inline

◆ getMode()

AuthMode getMode ( ) const

inline

◆ clearAuth()

void clearAuth ( )

Clears authentication settings.

◆ getPassword()

const std::string& getPassword ( ) const

Returns the authentication password.

Exceptions

XInvalidParameter if no password is set

◆ setPassword()

void setPassword ( const boost::optional< std::string > & passwd )

Sets a password.

◆ getKey()

const RSAKey& getKey ( ) const

Returns the authentication key.

Exceptions

XInvalidParameter if no key is set

◆ setKey()

void setKey ( const boost::optional< std::string > & str )

Sets a key.

◆ setKeyFile()

void setKeyFile ( const boost::optional< std::string > & file )

Sets a key file.

Member Data Documentation

◆ group

std::string group

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

framework/include/fw/RemoteModule.h

Public Member Functions

Public Attributes