Alternate interface for checking signer of email credentials #1795
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
artwyman
commented
Jun 18, 2024
| */ | ||
| export async function verifyCredential( | ||
| credential: Credential | ||
| credential: Credential, | ||
| isTrustedEmailPCDSigner?: (emailPCDSigner: EdDSAPublicKey) => boolean |
There was a problem hiding this comment.
A simpler version of this would be to pass an array of keys to accept, which might be more obvious how to use correctly. The function gives the caller more flexibility, including to throw their own exception (which I did in the CredentialSubservice) or to accept anything.
|
Ping @robknight for feedback here. This is draft in that I'm not sure we want to go with this approach, but I would like to get thoughts on whether or not to proceed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I started out just trying to update the documentation, but then decided to experiment with how to change the interface so it's harder to forget to check the signing key on the email PCD. @robknight let me know if you think is a good direction to go.
I updated the PODBox code to use the new optional arg. It should be backward-compatible for any callers who aren't doing so, though I think it would be good to update ZuAuth to use the new arg as well so it becomes an example of proper usage.