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

Representation of public key and signature in meta.security is underspecified #375

Open
magnusbaeck opened this issue Nov 29, 2023 · 1 comment
Labels
protocol All protocol changes

Comments

@magnusbaeck
Copy link
Member

Description

The documentation of the meta.security.integrityProtection{publicKey,signature} fields doesn't specify the representation/encoding of the values. Are they expected to be hex strings? Or Base64? A complete PEM file? The schema itself doesn't give any guidance; the fields are just plain strings without any restrictions.

Data like this is typically expressed in Base64 and that's probably what the original spec author intended. It's also what the .NET SDK implementation has chosen.

The documentation is the important part, but we could also amend the schemas themselves to only allow the characters permitted in Base64 encoding, plus probably horizontal whitespace.

Motivation

Clarity for people implementing support for event signing in applications and SDKs.

Exemplification

N/A

Benefits

Clarity and unambiguity.

Possible Drawbacks

None.

@magnusbaeck magnusbaeck added the protocol All protocol changes label Nov 29, 2023
@magnusbaeck magnusbaeck added this to the Edition Santiago milestone Jan 7, 2024
@e-backmark-ericsson
Copy link
Member

For reference, the public key was added to the meta.security object through PR #197, and was earlier discussed in issue #185.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
protocol All protocol changes
Projects
Status: Todo
Development

No branches or pull requests

2 participants