Struct SolidSyslogOpenSslPemFileCredentialsConfig¶

ClassList > SolidSyslogOpenSslPemFileCredentialsConfig

#include <SolidSyslogOpenSslPemFileCredentials.h>

struct SolidSyslogOpenSslPemFileCredentialsConfig
{
    const char* CaBundlePath;
    const char* ClientCertChainPath;
    const char* ClientKeyPath;
    const char* const * PeerFingerprints;
    size_t PeerFingerprintCount;
};

Detailed Description¶

Where this backend's material lives.

Every member is the caller's and must stay valid for the lifetime of the credentials. The key must not be encrypted: a passphrase is never prompted for, so an encrypted key fails to load and is reported as CLIENT_CREDENTIAL_NOT_INSTALLED.

Public Attributes Documentation¶

CaBundlePath¶

PEM file of trust anchors the peer certificate must chain to; NULL installs none, which leaves the peer authorised only if the stream has another means to do it.

const char* SolidSyslogOpenSslPemFileCredentialsConfig::CaBundlePath;

ClientCertChainPath¶

PEM leaf certificate (plus intermediates) for mutual TLS; NULL means no client credential.

const char* SolidSyslogOpenSslPemFileCredentialsConfig::ClientCertChainPath;

Certificate and key are all-or-nothing - supplying one without the other is reported.

ClientKeyPath¶

PEM private key matching ClientCertChainPath; NULL means no client credential.

const char* SolidSyslogOpenSslPemFileCredentialsConfig::ClientKeyPath;

PeerFingerprintCount¶

size_t SolidSyslogOpenSslPemFileCredentialsConfig::PeerFingerprintCount;

PeerFingerprints¶

Fingerprints of certificates the peer may present, any one of which authorises it.

const char* const* SolidSyslogOpenSslPemFileCredentialsConfig::PeerFingerprints;

Each is the RFC 5425 §4.2.2 form: the IANA hash name, a colon, then the digest of the DER certificate as colon-separated hexadecimal bytes in either case, e.g. sha-256:E1:2D:.... sha-256 and sha-1 are accepted; a sha-1 pin is reported on every connection. A pin in any other form is reported when the stream opens and that attempt fails. NULL with a count of zero pins no peer; a count with no list behind it, or a NULL pin in one, is reported at Create, which returns the Null credentials. The array and the strings must outlive the credentials.

The documentation for this class was generated from the following file Platform/OpenSsl/Interface/SolidSyslogOpenSslPemFileCredentials.h