Skip to content

Mbed TLS platform

«interface»SolidSyslogMbedTlsCredentialsMbedTlsHandleCredentialsMbedTlsMbedTlsNullCredentialsMbedTlsMbedTlsPemBufferCredentialsMbedTlsMbedTlsStreamMbedTls

Struct SolidSyslogMbedTlsCredentials

ClassList > SolidSyslogMbedTlsCredentials

  • #include <SolidSyslogMbedTlsCredentialsDefinition.h>
struct SolidSyslogMbedTlsCredentials
{
    bool (*Install)(
        struct SolidSyslogMbedTlsCredentials* self,
        struct mbedtls_ssl_config* conf,
        struct SolidSyslogTlsCredentialsInstalled* installed
    );
    void (*Release)(struct SolidSyslogMbedTlsCredentials* self);
};

Detailed Description

Where an MbedTlsStream's credentials come from.

Called once per connection each, so material is obtained only for a connection actually being made and released when it ends.

Public Attributes Documentation

Install

Install trust anchors, any pinned peer fingerprints, and - for mutual TLS - the client credential onto conf , reporting throughinstalled what the stream cannot read back out ofconf .

bool(* SolidSyslogMbedTlsCredentials::Install) (struct SolidSyslogMbedTlsCredentials *self, struct mbedtls_ssl_config *conf, struct SolidSyslogTlsCredentialsInstalled *installed);

Called from Open, after the transport connects.

Return value:

  • false the material that authorises the peer could not be produced; the connection attempt fails and the sender retries on its next pass. A fault in the client's own credential is reported by the backend and returns true - it never stops delivery.

Release

Release what Install acquired.

void(* SolidSyslogMbedTlsCredentials::Release) (struct SolidSyslogMbedTlsCredentials *self);

Called from Close exactly once for every Install call, whatever that call returned, so a backend needs no rollback of its own and the integrator is always told when the credential window has closed. Must be a safe no-op when nothing was acquired.



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