openpubkey / openpubkey/openpubkey

Protocol Versioning

Open
#80 0 comments 0 reactions 1 assignee View on GitHub

@EthanHeilman is already working on this.

Since Dec 21, 2023.

Dominant language
Go
Stars
909
Forks
74
Avg merge
12m
Merged PRs (30d)
1

Description

This is a very early draft to pose the questions of how we think about versioning OpenPubkey.

This issue exists to think discuss if, and in what places ,we might want to version the OpenPubkey. The primary purpose of such versioning would be simplify our lives. We should take a goal that version must be simple and not introduce complex handshakes or versioning negotiation.

PK Token versioning:

We can version the PK Token using a key in the protected header of each signature we want to version. The OP signature and payload can't be versioned because it is OIDC token and not under our control. Do we want one version for the entire PK Token or instead version the CIC Signature and COS Signature separately.

MFA Cosigner API Versioning

The MFA Cosigner API uses the well-known URI and this provides an excellent point to specify parameters and versions from the cosigner to the client.

OSM and POP Auth versioning

OSM and POP Auth could be versioned at the signature or the API layer.

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.