petermetz/cactus-keychain-vault-server repository overview

⁠Rust API for openapi_client

Contains/describes the Keychain API types/paths for Hyperledger Cactus.

⁠Overview

This client/server was generated by the [openapi-generator] (https://openapi-generator.tech⁠) project. By using the OpenAPI-Spec⁠ from a remote server, you can easily generate a server stub.

To see how to make this your own, look here:

README⁠

• API version: 0.3.0
• Build date: 2021-01-10T23:14:36.828Z[GMT]

This autogenerated project defines an API crate openapi_client which contains:

• An Api trait defining the API in Rust.
• Data types representing the underlying data model.
• A Client type which implements Api and issues HTTP requests for each operation.
• A router which accepts HTTP requests and invokes the appropriate Api method for each operation.

It also contains an example server and client which make use of openapi_client:

• The example server starts up a web server using the openapi_client router, and supplies a trivial implementation of Api which returns failure for every operation.
• The example client provides a CLI which lets you invoke any single operation on the openapi_client client by passing appropriate arguments on the command line.

You can use the example server and client as a basis for your own code. See below for more detail on implementing a server⁠.

⁠Examples

Run examples with:

cargo run --example <example-name>

To pass in arguments to the examples, put them after --, for example:

cargo run --example client -- --help

⁠Building and running an example server docker container

docker run --cap-add=IPC_LOCK -e 'VAULT_DEV_ROOT_TOKEN_ID=myroot' -p 8200:8200 vault
docker build . -t ckvs
docker run --net="host" --rm -e VAULT_TOKEN=myroot -p 8080:8080 ckvs

export THE_SECRET=$(uuidgen)

curl --location --request POST 'http://127.0.0.1:8080/api/v1/plugins/@hyperledger/cactus-plugin-keychain-vault/set-keychain-entry' \
--header 'Content-Type: application/json' \
--data-raw '{
    "key": "mysecret",
    "value": "'"$THE_SECRET"'"
}'

curl --location --request POST 'http://127.0.0.1:8080/api/v1/plugins/@hyperledger/cactus-plugin-keychain-vault/get-keychain-entry' \
--header 'Content-Type: application/json' \
--data-raw '{
    "key": "mysecret"
}'

> {"key":"mysecret","value":"3e87c7a5-758c-4953-afb8-20e04e05b746"}

⁠Running the example server

To run the server, follow these simple steps:

VAULT_TOKEN=myroot cargo run --example server

⁠Running the example client

To run a client, follow one of the following simple steps:

⁠HTTPS

The examples can be run in HTTPS mode by passing in the flag --https, for example:

VAULT_TOKEN=myroot cargo run --example server -- --https

This will use the keys/certificates from the examples directory. Note that the server chain is signed with CN=localhost.

⁠Using the generated library

The generated library has a few optional features that can be activated through Cargo.

• server
  • This defaults to enabled and creates the basic skeleton of a server implementation based on hyper
  • To create the server stack you'll need to provide an implementation of the API trait to provide the server function.
• client
  • This defaults to enabled and creates the basic skeleton of a client implementation based on hyper
  • The constructed client implements the API trait by making remote API call.
• conversions
  • This defaults to disabled and creates extra derives on models to allow "transmogrification" between objects of structurally similar types.

See https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section⁠ for how to use features in your Cargo.toml.

⁠Documentation for API Endpoints

All URIs are relative to http://localhost⁠

⁠Documentation For Models

• GetKeychainEntryRequest⁠
• GetKeychainEntryResponse⁠
• SetKeychainEntryRequest⁠
• SetKeychainEntryResponse⁠

⁠Documentation For Authorization

Endpoints do not require authorization.

⁠Author