google / google/go-tpm-tools

[KeyManager] Reduce KeyRegistry complexity

Open
#667 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
307
Forks
118
Avg merge
1d 16h
Merged PRs (30d)
33

Description

We have KeySpec, KeyMetadata, and KeyRecord. We could probably do away with one of those, to cut down on cognitive overhead. We can consider merging all fields of KeyMetadata into KeyRecord - and perhaps s/KeySpec/KeyMetadata/, since a "key spec" to seems to imply algorithms and policies but not data about specific keys, and the current fields in KeySpec seem metadata-ish.

From @bluegate010 comment at https://github.com/google/go-tpm-tools/pull/649#discussion_r2785770543

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.

Research direction

Start by locating the definitions and usages of KeySpec, KeyMetadata, and KeyRecord throughout the repository. Compare their fields and how callers distinguish specifications from metadata and records. Done means the redundant type is removed, the naming and remaining data model are agreed on, and all affected usages continue to work.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
security
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.