MemorySecurityMaterialStore

class kanzi::connect::MemorySecurityMaterialStore

Stores security material artifacts (keys, certificates) in memory.

Public API is fully re-entrant.

Public Types

enum Type

Values:

enumerator DefaultServer_ServerCertificate
enumerator DefaultServer_ServerPrivateKey
enumerator DefaultServer_ClientCA
enumerator DefaultWebServer_ServerCertificate
enumerator DefaultWebServer_ServerPrivateKey
enumerator DefaultWebServer_ClientCA
enumerator DefaultClient_ClientCertificate
enumerator DefaultClient_ClientPrivateKey
enumerator DefaultClient_ServerCA
enumerator DefaultClient_ServerName
typedef enum kanzi::connect::MemorySecurityMaterialStore::Type Type

Public Static Functions

static void clear()

Clears the memory security material store contents.

static bool contains(Type type)

Checks whether store contains a specific material.

Return

If material is stored, true, otherwise false.

Parameters
  • type: Defines the material type.

static bool containsDefaultClientMaterials()

Determines whether store contains default materials to be used at client side DefaultClient_ClientCertificate, DefaultClient_ClientPrivateKey, DefaultClient_ServerCA.

Return

If default material is set, true, otherwise false.

static bool containsDefaultServerMaterials()

Determines whether store contains default material used by server.

DefaultServer_ServerCertificate, DefaultServer_ServerPrivateKey and DefaultServer_ClientCA

Return

If default material is set, true, otherwise false.

static bool containsDefaultWebServerMaterials()

Determines whether store contains default material used by web server.

DefaultWebServer_ServerCertificate, DefaultWebServer_ServerPrivateKey and DefaultWebServer_ClientCA

Return

If default material is set, true, otherwise false.

static void remove(Type type)

Removes a specific type of material from the store.

Parameters
  • type: The type to remove.

static void removeAll()

Removes all content from the store.

static string retrieve(Type type)

Retrieves a typed material.

Parameters
  • type: Defines the material type.

static void store(Type type, const char *contents)

Stores a specific type of material into the store.

material usually certificates and private keys.

Parameters
  • type: Defines the material type.

  • contents: The material to store.