Engage Engine API  1.264.9126
Real-time tactical communications engine API
Loading...
Searching...
No Matches
AppConfigurationObjects::EnginePolicySecurity Class Reference

Default certificate to use for security operation in the Engage Engine. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Member Functions

void clear ()
 
- Public Member Functions inherited from AppConfigurationObjects::ConfigurationObjectBase
virtual void initForDocumenting ()
 
virtual std::string toString ()
 
virtual bool isDocumenting () const
 

Public Attributes

SecurityCertificate certificate
 The default certificate and private key for the Engine instance.
 
std::vector< std::string > caCertificates
 [Optional] An array of CA certificates to be used for validation of far-end X.509 certificates
 
bool useOsTrustStore
 [Optional, Default: true] When true, certificates from the operating system trust store are included when verifying far-end X.509 certificates.
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Default certificate to use for security operation in the Engage Engine.

Helper C++ class to serialize and de-serialize EnginePolicySecurity JSON

Example:

{
"certificate": {
"certificate": "",
"key": ""
},
"useOsTrustStore": true
}
See also
ConfigurationObjects::EnginePolicy

Definition at line 6731 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ EnginePolicySecurity()

AppConfigurationObjects::EnginePolicySecurity::EnginePolicySecurity ( )
inline

Definition at line 6766 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::EnginePolicySecurity::clear ( )
inline

Definition at line 6771 of file ConfigurationObjects.h.

Member Data Documentation

◆ caCertificates

std::vector<std::string> AppConfigurationObjects::EnginePolicySecurity::caCertificates

[Optional] An array of CA certificates to be used for validation of far-end X.509 certificates

Description

These certificates will be used on Rallypoint connections where no specific CA certificates have been provided.

Definition at line 6757 of file ConfigurationObjects.h.

◆ certificate

SecurityCertificate AppConfigurationObjects::EnginePolicySecurity::certificate

The default certificate and private key for the Engine instance.

Description

The certificate and private key are used for a variety of purposes including:

  • Mission generation
  • As the default for timeline signing
  • As the default for Rallypoint connectivity

Definition at line 6748 of file ConfigurationObjects.h.

◆ useOsTrustStore

bool AppConfigurationObjects::EnginePolicySecurity::useOsTrustStore

[Optional, Default: true] When true, certificates from the operating system trust store are included when verifying far-end X.509 certificates.

Set to false to trust only the CA certificates configured for the Engine and its Rallypoint connections.

Definition at line 6764 of file ConfigurationObjects.h.


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