kmip-explorer

Browse and manage your KMIP objects in your terminal. It supports KMIP from v1.0 up to v1.4.

Quick start

Installation

From release

Download the latest release from the release page

Install with go

Run go install github.com/phsym/kmip-explorer/cmd/kmip-explorer@latest

Use as a library

The terminal UI can be embedded into your own application. The root package exposes a minimal API by design: you build and own a kmipclient.Client (controlling TLS, middlewares and the server address yourself), hand it to explorer.New, then call Run to start the UI.

package main

import (
	"log"

	"github.com/ovh/kmip-go/kmipclient"
	explorer "github.com/phsym/kmip-explorer"
)

func main() {
	client, err := kmipclient.Dial(
		"eu-west-rbx.okms.ovh.net:5696",
		kmipclient.WithClientCertFiles("cert.pem", "key.pem"),
	)
	if err != nil {
		log.Fatal(err)
	}
	defer client.Close()

	// version is shown in the banner; pass "" as latestVersion to disable the
	// update hint.
	exp := explorer.New(client, "dev", "")
	if err := exp.Run(); err != nil {
		log.Fatal(err)
	}
}

Run takes over the terminal and blocks until the user quits. See the package documentation for details.

Run it

Display help with kmip-explorer -h

Usage of kmip-explorer:
  -addr string
        Address and port of the KMIP Server (default "eu-west-rbx.okms.ovh.net:5696")
  -ca string
        Server's CA (optional)
  -cert string
        Path to the client certificate
  -key string
        Path to the client private key
  -no-ccv
        Do not add client correlation value to requests
  -no-check-update
        Do not check for update
  -tls12-ciphers string
        Coma separated list of tls 1.2 ciphers to allow. Defaults to a list of secured ciphers
  -version
        Display version information

And run it with

kmip-explorer -addr eu-west-rbx.okms.ovh.net:5696 -cert client.crt -key client.key

Demo

Compatibility

This project is developed using using OVHcloud's KMIP client and inherits the library compatibility. Checkout the compatibility matrix.

It supports KMIP protocol from v1.0 up to v1.4, and is tested against OVHcloud's KMS service.

PyKMIP

Running kmip-explorer with a PyKMIP server with default settings may require you to pass the 2 following arguments:

kmip-explorer -tls12-ciphers TLS_RSA_WITH_AES_128_CBC_SHA256 -no-ccv