The SKC Secure KMIP Client Toolkit

Table of Contents

• Introduction
• Getting Help
• Getting Started
• Reference Guides
• Examples

Introduction

This guide contains all the infromation you need to get started with the SKC C++ KMIP Client Toolkit. It outlines the steps needed to incorporate, build and deploy the client with your application. It provides an overview, working examples of using the client, and a detailed API reference for the client's various interfaces.

Getting Help

There are many ways to get help using SKC.

• Check the documentation (you're already here)
• Look for an example. There are many examples already in the examples directory of your SKC installation.
• Search our Knowledgebase
• Submit a support request

Getting Started

The following sections will get you started with the basics of SKC. This is just some introductory stuff to get you going quickly. Once you understand how to build the examples and load and deploy SKC, you will be ready to move on the KMIP Reference Guide and HPE Atalla NSP PKCS 11 Reference Guide which documents the component interfaces and provides SKC specific examples.

1. SKC Directory Structure
2. Building The Examples
3. Building Your Application With SKC
4. Loading Components
5. Deploying SKC
6. SKC Redistributibles

Reference Guides

• KMIP Reference Guide
• KMIP Command Line Tool Reference Guide
• Java Native Interface (JNI) KMIP Reference Guide
• p6pythonkmip
• HPE Atalla NSP PKCS 11 Reference Guide
• PKCS 11 Command Line Tool Reference Guide
• SKC UEFI Platform Reference Guide

Examples

Examples are the easiest way to learn how to use our toolkit. Below are several examples that should get you started. All examples compile and run (see Building The Examples) and should help give you a good start on using the SKC toolkit in your aplications. Please let us know if you you have ideas for more examples, and/or have examples that you would like to contribute.

• KMIP Example 1 - Basic Code Structure
• KMIP Example 2 - Asynchronous KMIP operation
• KMIP Example 3 - Key Wrapping
• KMIP Example 4 - Register a symmetric key
• KMIP Example 5 - Clean all managed objects off of KMIP server
• KMIP Example 6 - Notify and Put Support
• KMIP Example 7 - Create and register asymmetric keys
• KMIP Example 8 - KMIP server creates asymmetric keys
• KMIP Example 9 - KMIP server creates certificate for key pair
• KMIP Example 10 - Adding multiple attributes to a managed object
• KMIP Example 11 - Attributes and Enumerators
• KMIP Example 12 - Query Server and Enumerators
• KMIP Example 13 - Low Level SDK APIs
• KMIP Example 14 - Key Management with Low Level SDK APIs
• KMIP Example 15 - A C Language version of example 1
• KMIP Example 16 - Generate a KMIP keystore
• KMIP Example 17 - Create a key if not found on KMIP server
• KMIP Example 18 - Rekey an existing key with a Name attribute
• KMIP Example 19 - Locate and Get a Symmetric Key
• KMIP Example 20 - Multiple Create Key Operations in a single KMIP Request
• KMIP Example 21 - ReKey Operation Creating a Chain of Replaced Keys
• KMIP Example 22 - Retriving Extension Attributes
• KMIP Example 23 - Register a key with no key material
• JNI KMIP Example 1 - Basic Client Operation
• JNI KMIP Example 2 - Locate a KMIP Key
• JNI KMIP Example 3 - Activate a KMIP Key
• JNI KMIP Example 4 - Re-key a KMIP Key
• JNI KMIP Example 5 - KMIP Attributes
• JNI KMIP Example 6 - Register a Key
• JNI KMIP Example 7 - KMIP Structure Attributes
• JNI KMIP Example 8 - Register a Certificate
• JNI KMIP Example 9 - Register Secret / Opaque Objects
• JNI KMIP Example 10 - Random Data from KMIP
• JNI KMIP Example 11 - Basic Cryptographic Operations
• JNI KMIP Example 12 - Wrapping KMIP Keys
• JNI KMIP Example 13 - Streaming Cryptographic Operations
• JNI KMIP Example 14 - Streaming 2 Cryptographic Operations
• JNI KMIP Example 15 - Alternate Configuration KMIP
• JNI KMIP Example 16 - KMIP Multi-Instance Attributes
• JNI KMIP Example 17 - KMIP Derive Key
• JNI KMIP Example 18 - KMIP PKCS#12 Support
• JNI KMIP Example 19 - KMIP OAEP Support
• JNI KMIP Example 20 - KMIP Signing with Digested Data
• JNI KMIP Example 21 - KMIP Streaming Signing
• JNI KMIP Example 22 - KMIP GCM Support
• JNI KMIP Example 23 - KMIP Elliptic Curve Support
• JNI KMIP Example 24 - KMIP OAEP Support
• python_example1
• python_example2
• python_example3
• python_example4
• python_example5
• python_example6
• python_example7
• python_example8
• python_example9
• python_example10
• python_example11
• python_example12
• python_example13
• python_example14
• python_example15
• python_example16
• python_example17
• python_example18
• python_example19
• PKCS 11 Example 1: Initialize a token
• PKCS 11 Example 2: Store a key onto a token
• PKCS 11 Example 3: Search for a key on a token
• PKCS 11 Example 4: Generate a key on a token
• PKCS 11 Example 5: Perform Encryption / Decryption
• PKCS 11 Example 6: Utimaco HSM Integration, Initialize a Token
• PKCS 11 Example 7: Utimaco HSM Integration, Perform Encryption / Decryption
• PKCS 11 Example 8: HSM Integration, list all slots on HSM token
• PKCS 11 Example 9: Thales nShield Connect HSM Integration
• PKCS 11 Example 10: FutureX HSM Integration
• PKCS 11 Example 11: Java Security Provider -- Public/Private keys
• PKCS 11 Example 12: Java Security Provider -- Symmetric Keys
• PKCS 11 Example 13: Java Security Provider -- Streaming Encryption
• PKCS 11 Example 14: Wrap a Key