medcrypt::guardian::utilities::ProvisionFiles

Overview

This is the storage for generating provision request files in GenerateProvisionRequest().

Requirements:

• Input:

  • All const char* inputs should be set to the beginning of the loaded buffer.

  • All size_t inputs should be set to the size of the data loaded in the buffer.

• Output:

  • All char* outputs should be set to the beginning of an allocated buffer.

  • All size_t outputs should be set to the size of the allocated buffer. After success, they will be set to the size of the data written.

Usage:

• This structure is used with GenerateProvisionRequest() to generate provisioning files.

• See GetProvisionFilesFromPath() and DeleteProvisionFileBuffers() in FileHelpers.h for examples.

Include:

#include <ProvisionFiles.h>

Syntax:

struct medcrypt::guardian::utilities::ProvisionFiles;

Structure members

Input members:

• TrustStore: Trust store file buffer

• TrustStoreSize: Trust store file buffer size

• PrivateIdentity: Private identity file buffer

• PrivateIdentitySize: Private identity file buffer size

• CertifiedProfile: Certified profile file buffer

• CertifiedProfileSize: Certified profile file buffer size

• CertifiedCertificateRevocations: Certificate revocations file buffer

• CertifiedCertificateRevocationsSize: Certificate revocations file buffer size

Output members:

• ProvisionRequest: Provision request file buffer

• ProvisionRequestSize: Provision request file buffer size

• GeneratedPrivateIdentity: Generated private identity file buffer

• GeneratedPrivateIdentitySize: Generated private identity file buffer size

Member details

Input members:

TrustStore

• Description: Trust store file buffer.

• Type: const char*

• Usage: Input

• Syntax:

const char * TrustStore;

TrustStoreSize

• Description: Trust store file buffer size.

• Type: size_t

• Usage: Input

• Syntax:

size_t TrustStoreSize;

PrivateIdentity

• Description: Private identity file buffer.

• Type: const char*

• Usage: Input

• Syntax:

const char * PrivateIdentity;

PrivateIdentitySize

• Description: Private identity file buffer size.

• Type: size_t

• Usage: Input

• Syntax:

size_t PrivateIdentitySize;

CertifiedProfile

• Description: Certified profile file buffer.

• Type: const char*

• Usage: Input

• Syntax:

const char * CertifiedProfile;

CertifiedProfileSize

• Description: Certified profile file buffer size.

• Type: size_t

• Usage: Input

• Syntax:

size_t CertifiedProfileSize;

CertifiedCertificateRevocations

• Description: Certificate revocations file buffer.

• Type: const char*

• Usage: Input

• Syntax:

const char * CertifiedCertificateRevocations;

CertifiedCertificateRevocationsSize

• Description: Certificate revocations file buffer size.

• Type: size_t

• Usage: Input

• Syntax:

size_t CertifiedCertificateRevocationsSize;

Output members:

ProvisionRequest

• Description: Provision request file buffer.

• Type: char*

• Usage: Output

• Syntax:

char * ProvisionRequest;

ProvisionRequestSize

• Description: Provision request file buffer size.

  • Input: allocated buffer size.

  • Output: actual data size written.

• Type: size_t

• Usage: Input/Output

• Syntax:

size_t ProvisionRequestSize;

GeneratedPrivateIdentity

• Description: Generated private identity file buffer.

• Type: char*

• Usage: Output

• Syntax:

char * GeneratedPrivateIdentity;

GeneratedPrivateIdentitySize

• Description: Generated private identity file buffer size.

  • Input: allocated buffer size.

  • Output: actual data size written.

• Type: size_t

• Usage: Input/Output

• Syntax:

size_t GeneratedPrivateIdentitySize;

Related classes

• Guardian class: Uses ProvisionFiles in GenerateProvisionRequest()

• InitializeFiles struct - Similar file structure used for initialization

• ProvisionOnlineFiles struct - File structure used for online provisioning

Debugging and logging

Guardian does not create log files. Instead, logging is controlled by the application:

• Guardian logs to stdout and stderr, which appear in the terminal/CLI of the running application during execution. Look for specific error codes or connection failures in the output.

• Custom logging: Use SetLoggingCallback to redirect log messages to a callback function, stopping terminal output and allowing custom log handling

• Log control: Applications can control log level and verbosity.

• Guardian Cloud UI: Check the Guardian Cloud interface for additional error details and provisioning status.