RobotRaconteur::ServiceSecurityPolicy Class Reference

Security policy for Robot Raconteur service. More...

#include <Security.h>

Public Member Functions
	ServiceSecurityPolicy ()
	Construct an empty ServiceSecurityPolicy.
	ServiceSecurityPolicy (const boost::shared_ptr< UserAuthenticator > &Authenticator, const std::map< std::string, std::string > &Policies)
	Construct a ServiceSecurityPolicy.

Detailed Description

Security policy for Robot Raconteur service.

The security policy sets an authenticator, and a set of policies. PasswordFileUserAuthenticator is an example of an authenticator. The valid options for Policies are as follows:

Policy name	Possible Values	Default	Description
requirevaliduser	true,false	false	Set to "true" to require a user be authenticated before accessing service
allowobjectlock	true,false	false	If "true" allow users to request object locks. requirevaliduser most also be

"true" |

The security policy is passed as a parameter to RobotRaconteurNode::RegisterService(boost::string_ref, boost::string_ref, const boost::shared_ptr<RRObject>&, boost::shared_ptr< ServiceSecurityPolicy > securitypolicy), or set using ServerContext::SetSecurityPolicy().

See Security for more information.

Constructor & Destructor Documentation

ServiceSecurityPolicy() [1/2]

RobotRaconteur::ServiceSecurityPolicy::ServiceSecurityPolicy

(

)

Construct an empty ServiceSecurityPolicy.

Must use boost::make_shared<ServiceSecurityPolicy>()

ServiceSecurityPolicy() [2/2]

RobotRaconteur::ServiceSecurityPolicy::ServiceSecurityPolicy	(	const boost::shared_ptr< UserAuthenticator > &	Authenticator,
		const std::map< std::string, std::string > &	Policies )

Construct a ServiceSecurityPolicy.

Parameters

Authenticator	The user authenticator
Policies	The security policies

---

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

• /builddir/build/BUILD/robotraconteur-1.2.8-build/RobotRaconteur-1.2.8-Source/RobotRaconteurCore/include/RobotRaconteur/Security.h