CYISSLRootCertificateProvider Class Reference

Detailed Description

Provides SSL root certificate information.

The SSL root certification information is provided in two ways:

1. The CYISSLRootCertificateProvider will query the system root certificate store to obtain the default root certificates for the system. This is currently only supported on the PS4 and UWP platforms.
2. The path to a SSL root certificate bundle in PEM format can be specified. For platforms which do not support querying the system root certificate store this path must be set for SSL communication to succeed.

This provider will be used by CYITCPSecureSocket, CYIWebSocket and CYIHTTPService when SSL communcation is required.

Note

The SSL root certificate bundle specified by path will take precedence over the system root certificates.

#include <network/YiSSLRootCertificateProvider.h>

Classes
struct	Certificate

Public Types
enum	CertificateFormat {   CertificateFormat::PEM,   CertificateFormat::X509Encoded }

Public Member Functions
virtual	~CYISSLRootCertificateProvider ()
void	SetRootCertificateBundleFilePath (const CYIString &rFilePath)
const CYIString &	GetRootCertificateBundleFilePath () const
const std::vector< Certificate > &	GetSystemRootCertificates () const

Static Public Member Functions
static CYISSLRootCertificateProvider *	GetInstance ()

Member Enumeration Documentation

enum CYISSLRootCertificateProvider::CertificateFormat

strong

The format of the root certificate contained in the root certificate.

See also

CYISSLRootCertificateProvider::Certificate

Enumerator
PEM	The root certificate is in PEM format.
X509Encoded	The root certificate is in encoded X509 format.

Constructor & Destructor Documentation

virtual CYISSLRootCertificateProvider::~CYISSLRootCertificateProvider ( )

virtual

Member Function Documentation

static CYISSLRootCertificateProvider* CYISSLRootCertificateProvider::GetInstance ( )

static

const CYIString& CYISSLRootCertificateProvider::GetRootCertificateBundleFilePath

(

)

const

Returns the file path to the SSL root certificate bundle.

See also

SetRootCertificateBundleFilePath

const std::vector<Certificate>& CYISSLRootCertificateProvider::GetSystemRootCertificates

(

)

const

Returns the SSL root certificates that were loaded from the system root certificate store.

Note

If a SSL root certificate bundle is set via SetRootCertificateBundleFilePath these certificates will not be used.

void CYISSLRootCertificateProvider::SetRootCertificateBundleFilePath

(

const CYIString &

rFilePath

)

Sets the file path to the SSL root certificate bundle to be used by the CYISSLRootCertificateProvider. This SSL root certificate bundle must be in PEM format.

Note

When set this root certificate bundle will take precedence over the system root certificates.

---

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

• network/YiSSLRootCertificateProvider.h