C2SP / C2SP/wycheproof

Format descriptions in schema docs are imprecise

Open
#179 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
Go
Stars
3.1k
Forks
333
Avg merge
8d 19h
Merged PRs (30d)
1

Description

The schema docs stay things like:

> Pem encoded public key
> Pem encoded private key

The format is called PEM, not Pem. I guess the types do the camel-case thing on the initialisms, but docs for human consumption should use the more conventional "PEM" spelling.

> DER encoded public key

This doesn't say the format. It should specify whether this is a SubjectPublicKeyInfo or RSAPublicKey or whatever. Sampling things, it seems SubejctPublicKeyInfo is the most common, but I haven't checked all of them.

> Pkcs 8 encoded private key

I mean, this is actually specific, but in human docs, it should be styled "PKCS #8". (If we're touching it, I might say "PKCS #8 PrivateKeyInfo" since PKCS #8 is the document.)

But I also agree with https://github.com/C2SP/wycheproof/issues/178#issuecomment-3247355377 that maybe we shouldn't have so many formats.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.