medcrypt::guardian::utilities

Classes

	Name
struct	medcrypt::guardian::utilities::InitializeFiles Storage for initialization files used by Guardian::Initialize.
struct	medcrypt::guardian::utilities::ProvisionFiles Storage for generating provision request files in Guardian::GenerateProvisionRequest.
struct	medcrypt::guardian::utilities::ProvisionOnlineFiles Storage for online provisioning files in Guardian::StartProvisioningOnline.

Functions

	Name
bool	GetInitializeFilesFromPath(const std::string & in_filespath, const bool & in_use_provision_files, InitializeFiles * io_files, const std::string & in_prefix ="") Populate file buffers required by Guardian::Initialize from path.
void	DeleteInitializeFileBuffers(InitializeFiles * io_files) Delete dynamic memroy in created by GetInitializeFilesFromPath()
bool	GetProvisionFilesFromPath(const std::string & in_filespath, const bool & in_use_provision_files, ProvisionFiles * io_files, const std::string & in_prefix ="") Populate file buffers required by Guardian::GenerateProvisionRequest from path.
void	DeleteProvisionFileBuffers(ProvisionFiles * io_files) Delete dynamic memroy in created by GetProvisionFilesFromPath()

Attributes

	Name
const char	kRequestExtension
const char	kProfileExtension
const char	kRunProfileExtension
const char	kIdentityExtension
const char	kRunIdentityExtension
const char	kTrustExtension
const char	kRevocationExtension

Functions Documentation

function GetInitializeFilesFromPath

static inline bool GetInitializeFilesFromPath(
    const std::string & in_filespath,
    const bool & in_use_provision_files,
    InitializeFiles * io_files,
    const std::string & in_prefix =""
)

Populate file buffers required by Guardian::Initialize from path.

Parameters:

• in_filespath absolute or working directory relative path to profile files

• in_use_provision_files used to return provisioning profiles for initializing to run online provisioning

• io_files file structure to populate

• in_prefix prefix that each found file is required to have, allows multiple profile sets in the same folder separated by file prefix

Returns:

• true io_files populated successfully

• false io_files not populated

Return: bool

Searches for files in in_filepath with prefix in_prefix. Sorts alphanumerically after applying prefix and uses the first result.

Note: This function creates memory in InitializeFiles char* buffers using new[], its paired DeleteInitializeFileBuffers() function will delete the created dynamic memory.

function DeleteInitializeFileBuffers

static inline void DeleteInitializeFileBuffers(
    InitializeFiles * io_files
)

Delete dynamic memroy in created by GetInitializeFilesFromPath()

Parameters:

• io_files file structure to clean up

Return: none

Calls delete[] on all InitializeFiles char* buffers.

function GetProvisionFilesFromPath

static inline bool GetProvisionFilesFromPath(
    const std::string & in_filespath,
    const bool & in_use_provision_files,
    ProvisionFiles * io_files,
    const std::string & in_prefix =""
)

Populate file buffers required by Guardian::GenerateProvisionRequest from path.

Parameters:

• in_filespath absolute or working directory relative path to profile files

• in_use_provision_files used to return provisioning profiles, usually should be true

• io_files file structure to populate

• in_prefix prefix that each found file is required to have, allows multiple profile sets in the same folder separated by file prefix

Returns:

• true io_files populated successfully

• false io_files not populated

Return: bool

Searches for files in in_filepath with prefix in_prefix. Sorts alphanumerically after applying prefix and uses the first result.

Note: This function creates memory in ProvisionFiles char* buffers using new[], its paired DeleteProvisionFileBuffers() function will delete the created dynamic memory.

Note: This function does not create memory for outputs ProvisionFiles::ProvisionRequest or ProvisionFiles::GeneratedPrivateIdentity

function DeleteProvisionFileBuffers

static inline void DeleteProvisionFileBuffers(
    ProvisionFiles * io_files
)

Delete dynamic memroy in created by GetProvisionFilesFromPath()

Parameters:

• io_files file structure to clean up

Return: none

Calls delete[] on all ProvisionFiles char* buffers except for outputs ProvisionFiles::ProvisionRequest and ProvisionFiles::GeneratedPrivateIdentity

Attributes Documentation

variable kRequestExtension

static const char kRequestExtension = ".mcpr";

Provision request file extension

variable kProfileExtension

static const char kProfileExtension = ".mcpp";

Certified provisioning profile file extension

variable kRunProfileExtension

static const char kRunProfileExtension = ".mcp";

Certified profile file extension

variable kIdentityExtension

static const char kIdentityExtension = ".mcpip";

Provisioning private identity file extension

variable kRunIdentityExtension

static const char kRunIdentityExtension = ".mcpi";

Private identity file extension

variable kTrustExtension

static const char kTrustExtension = ".mcts";

Trust store file extension

variable kRevocationExtension

static const char kRevocationExtension = ".mccrl";

Certificate revocation list file extension