C++ Reference

Overview

The C++ interface is the most complete API for Keychain Core on account of the library being written in native C++ itself.

Objects

charencoding

Character encoding enumeration

cipher

Symmetric encryption cipher enumeration

contact

Externally-managed Facade

facade

Self-sovereign identity

gateway

The cryptographic management object

key_id_type

Key Type enumeration

monitor

Checks the blockchain and updates the Keychain DB used by the Gateway

pair_helper

Development/POC example of a bare-bones Trusted Directory interface

persona

Internally-managed Facade

persona_status

Facade blockchain state enumeration

security_level

Encryption strength enumeration

settings

Abstraction of configuration file

uri

Location of Facade certificate on blockchain

verification

Information about a signature’s validity

Notes

  1. No exceptions are thrown from Keychain methods in the C++ library. All exceptions are caught and returned through a kc_code which should be checked by the caller.

  2. With minor exceptions for some primitive return values, most methods return by output parameter (e.g. kc::persona &out_val)