CI Crate Docs

kmip-protocol - A library for (de)serializing KMIP protocol objects

KMIP:

The OASIS Key Management Interoperability Protocol specifications which define message formats for the manipulation of cryptographic material on a key management server.

Welcome

This crate offers a partial implementation of (de)serialization of KMIP v1.0-1.2 protocol messages for use primarily by the Krill project. The interface offered is based on the popular Rust Serde (de)serialization framework for decorating arbitrary high level Rust "business object" structs with attributes that guide the (de)serialization process.

For details about the level of specification implementation and test coverage see the crate documentation.

Scope

This crate consists of: - Many Serde attributed Rust type definitions that represent KMIP request and response business objects. - A Client struct that uses the kmip-ttlv crate to serialize entire KMIP requests (composed from business object types) to a writer and deserialize the responses from a reader.

The "operations" supported by the Client (such as create key, sign data, etc.) is a work in progress and reflects the needs of the Krill project.

This crate is one of potentially several crates that will be implemented to add the ability to Krill to interact with KMIP compliant servers. This crate includes an example demonstrating how to connect over TCP+TLS to a KMIP server. This may be promoted to optional functionality offered by the crate behind a feature flag.

Status

This is a work-in-progress. The interface offered by this library is expected to change and no guarantee of interface stability is made at this time. The intention is publish this crate in the near future to https://crates.io/ to be depended on by Krill like any other Rust crate dependency. At the time of writing limited manual testing with PyKMIP (results) and Kryptus HSM (results) appears to work as expected.

Example Code

See examples/cli-tool.rs. For more information about running the example see:

bash cargo run --example cli-tool -- --help