kanzi::connect::MemorySecurityMaterialStore Class Reference

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

#include <memorysecuritymaterialstore.hpp>

Public Types
enum	Type {   DefaultServer_ServerCertificate, DefaultServer_ServerPrivateKey, DefaultServer_ClientCA, DefaultWebServer_ServerCertificate,   DefaultWebServer_ServerPrivateKey, DefaultWebServer_ClientCA, DefaultClient_ClientCertificate, DefaultClient_ClientPrivateKey,   DefaultClient_ServerCA, DefaultClient_ServerName }
typedef enum kanzi::connect::MemorySecurityMaterialStore::Type	Type

Static Public Member Functions
static void	clear ()
	Clears the memory security material store contents. More...
static bool	contains (Type type)
	Checks whether store contains a specific material. More...
static bool	containsDefaultClientMaterials ()
	Determines whether store contains default materials to be used at client side DefaultClient_ClientCertificate, DefaultClient_ClientPrivateKey, DefaultClient_ServerCA. More...
static bool	containsDefaultServerMaterials ()
	Determines whether store contains default material used by server. More...
static bool	containsDefaultWebServerMaterials ()
	Determines whether store contains default material used by web server. More...
static void	remove (Type type)
	Removes a specific type of material from the store. More...
static void	removeAll ()
	Removes all content from the store. More...
static string	retrieve (Type type)
	Retrieves a typed material. More...
static void	store (Type type, const char *contents)
	Stores a specific type of material into the store. More...

Detailed Description

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

Public API is fully re-entrant.

Member Typedef Documentation

Type

typedef enum kanzi::connect::MemorySecurityMaterialStore::Type kanzi::connect::MemorySecurityMaterialStore::Type

Member Enumeration Documentation

Type

enum kanzi::connect::MemorySecurityMaterialStore::Type

Enumerator
DefaultServer_ServerCertificate
DefaultServer_ServerPrivateKey
DefaultServer_ClientCA
DefaultWebServer_ServerCertificate
DefaultWebServer_ServerPrivateKey
DefaultWebServer_ClientCA
DefaultClient_ClientCertificate
DefaultClient_ClientPrivateKey
DefaultClient_ServerCA
DefaultClient_ServerName

Member Function Documentation

clear()

static void kanzi::connect::MemorySecurityMaterialStore::clear ( )

static

Clears the memory security material store contents.

contains()

static bool kanzi::connect::MemorySecurityMaterialStore::contains ( Type  type )

static

Checks whether store contains a specific material.

Parameters

type	Defines the material type.

Returns

If material is stored, true, otherwise false.

containsDefaultClientMaterials()

static bool kanzi::connect::MemorySecurityMaterialStore::containsDefaultClientMaterials ( )

static

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

Returns

If default material is set, true, otherwise false.

containsDefaultServerMaterials()

static bool kanzi::connect::MemorySecurityMaterialStore::containsDefaultServerMaterials ( )

static

Determines whether store contains default material used by server.

DefaultServer_ServerCertificate, DefaultServer_ServerPrivateKey and DefaultServer_ClientCA

Returns

If default material is set, true, otherwise false.

containsDefaultWebServerMaterials()

static bool kanzi::connect::MemorySecurityMaterialStore::containsDefaultWebServerMaterials ( )

static

Determines whether store contains default material used by web server.

DefaultWebServer_ServerCertificate, DefaultWebServer_ServerPrivateKey and DefaultWebServer_ClientCA

Returns

If default material is set, true, otherwise false.

remove()

static void kanzi::connect::MemorySecurityMaterialStore::remove ( Type  type )

static

Removes a specific type of material from the store.

Parameters

type	The type to remove.

removeAll()

static void kanzi::connect::MemorySecurityMaterialStore::removeAll ( )

static

Removes all content from the store.

retrieve()

static string kanzi::connect::MemorySecurityMaterialStore::retrieve ( Type  type )

static

Retrieves a typed material.

Parameters

type	Defines the material type.

store()

static void kanzi::connect::MemorySecurityMaterialStore::store ( Type  type, const char *  contents  )

static

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.

---

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

• connect/security/memorysecuritymaterialstore.hpp