oxidecomputer / oxidecomputer/omicron

API: `DerEncodedKeyPair` should include json schema annotation for base64 encoding

Open
#3,395 0 comments 0 reactions 1 assignee View on GitHub

@ahl is already working on this.

Since Jun 22, 2023.

Dominant language
Rust
Stars
572
Forks
97
Avg merge
2d 12h
Merged PRs (30d)
96

Description

Right now, this is the schema:

      "DerEncodedKeyPair": {
        "type": "object",
        "properties": {
          "private_key": {
            "description": "request signing private key (base64 encoded der file)",
            "type": "string"
          },
          "public_cert": {
            "description": "request signing public certificate (base64 encoded der file)",
            "type": "string"
          }
        },
        "required": [
          "private_key",
          "public_cert"
        ]
      },

We could use this schema for private_key and private_cert:

{
  "type": "string",
  "format": "bytes"
}

This implies base64 encoding... which means that the CLI could automate the encoding and accept a filename for each parameter.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.