kmipclient

A modern C++20 client implementation of the Key Management Interoperability Protocol (KMIP), an OASIS communication standard for managing objects stored in key management systems. It supports KMIP 1.4 and 2.0 and is tested against PyKMIP, HashiCorp Vault, Fortanix DSM, and Cosmian KMS.

The project consists of two libraries:

• kmipcore — the protocol layer: typed KMIP model, TTLV serialization/parsing, request/response classes. No network code.
• kmipclient — the client layer: high-level KMIP operations, an OpenSSL-based transport (replaceable via the NetClient interface), and a thread-safe connection pool.

Supported operations include creating, registering, retrieving, locating, activating, revoking, and destroying keys and secrets, as well as querying server capabilities. See the kmipclient README for the full API documentation and usage examples.

Quick example

#include "kmipclient/Kmip.hpp"
using namespace kmipclient;

Kmip kmip(host, port, client_cert, client_key, server_ca, timeout_ms);
auto key_id = kmip.client().op_create_aes_key("mykey", "mygroup");
auto key    = kmip.client().op_get_key(key_id);

Runnable example programs for every operation live in kmipclient/examples/.

Requirements

• A C++20 compiler (GCC or Clang)
• CMake 3.10 or newer
• OpenSSL

Build

cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build -j

To install, add cmake --install build (use -DCMAKE_INSTALL_PREFIX to choose a custom prefix).

Tests

Configure with -DBUILD_TESTS=ON to build the unit and integration tests (GoogleTest is fetched automatically):

cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTS=ON
cmake --build build -j
ctest --test-dir build --output-on-failure

The integration tests require a running KMIP server, configured via the KMIP_ADDR, KMIP_PORT, KMIP_CLIENT_CA, KMIP_CLIENT_KEY, and KMIP_SERVER_CA environment variables; they are skipped when these are not set. Set KMIP_RUN_2_0_TESTS=1 (at build time too — test discovery filters on it) to also run the KMIP 2.0 suite.

AddressSanitizer

cmake -S . -B build-asan -DCMAKE_BUILD_TYPE=Debug -DWITH_ASAN=ON -DBUILD_TESTS=ON
cmake --build build-asan -j
ctest --test-dir build-asan --output-on-failure

API documentation

Doxygen documentation can be generated with:

cmake -S . -B build-docs -DBUILD_DOCS=ON
cmake --build build-docs --target doc