Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Output content differs between --format tle and --format json #2052

Open
lkatalin opened this issue Mar 18, 2024 · 1 comment
Open

Output content differs between --format tle and --format json #2052

lkatalin opened this issue Mar 18, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@lkatalin
Copy link
Contributor

lkatalin commented Mar 18, 2024

When issuing a rekor-cli get command, the --format flag changes more than just the formatting of the output. It changes the actual content of what is output. I think these should output the same thing and/or there should be better documentation and flag names, ex. the flags could be --basic vs --verbose output or something similar.

Current output:

field present in --format tle present in --format json same information displayed?
logIndex [x] [x] [x]
logID [x] [x] no
kindVersion [x] - -
integratedTime [x] [x] [x]
inclusionPromise [x] - -
inclusionProof [x] - -
canonicalizedBody [x] - -
Body - [x] -
UUID - [x] -

tl;dr only logIndex and integratedTime fields are consistent across output formats.

@bobcallaway
Copy link
Member

  • logID is base64 encoded in tle format, where as it is rendered as a hex string in json format
  • the UUID can be computed from the canonicalizedBody in tle format
  • kindVersion in tle format is visible within Body in jsonformat

While I agree that this isn't the cleanest UX, Body in the json output is not really part of any standard within the sigstore ecosystem, but given that it has been an output format for a couple of years, we should probably be careful about changing it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants