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

Clarify meaning of "unless" in UP flag validation #2126

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

emlun
Copy link
Member

@emlun emlun commented Aug 19, 2024

Fixes #2122.

I'm not entirely convinced about the "ignore this" part being a completely separated sentence, but I chose to formulate it this way to emphasize that by default the UP flag should be verified, and only in exceptional circumstances should this verification be ignored.


Preview | Diff

@zacknewman
Copy link
Contributor

zacknewman commented Aug 19, 2024

If you don't like how it's phrased, perhaps:

Verify that the UP bit of the flags in authData is set or options.mediation is set to conditional.

Of course "or" in natural language does not often mean what it does in logic (i.e., it can often mean mutual exclusivity), so you could phrase it like:

Verify that the UP bit of the flags in authData is set; if not, verify options.mediation is set to conditional.

@timcappalli
Copy link
Member

TBH, I think the original text makes more sense.

Comment on lines +5638 to +5640
1. Verify that the [=UP=] bit of the <code>[=flags=]</code> in |authData| is set.
If <code>|options|.{{CredentialCreationOptions/mediation}}</code> is set to {{CredentialMediationRequirement/conditional}},
ignore this verification step.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about something like this instead?

Suggested change
1. Verify that the [=UP=] bit of the <code>[=flags=]</code> in |authData| is set.
If <code>|options|.{{CredentialCreationOptions/mediation}}</code> is set to {{CredentialMediationRequirement/conditional}},
ignore this verification step.
1. If <code>|options|.{{CredentialCreationOptions/mediation}}</code> is not set to {{CredentialMediationRequirement/conditional}}, verify that the [=UP=] bit of the <code>[=flags=]</code> in |authData| is set.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wfm!

Base automatically changed from rp-ops-options to main August 28, 2024 19:25
@nadalin nadalin added this to the L3-WD-02 milestone Sep 11, 2024
@nadalin nadalin requested a review from agl September 11, 2024 18:19
@emlun emlun marked this pull request as draft September 11, 2024 18:19
Copy link
Contributor

@agl agl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with suggested change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

options.mediation should be called something else in step 14 of Registering a New Credential
6 participants