Skip to content

Add experimental option FinishRegistrationOptions.isConditionalCreate #415

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

Merged
merged 1 commit into from
Apr 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions NEWS
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@
* (Experimental) Added property `RegisteredCredential.transports`.
** NOTE: Experimental features may receive breaking changes without a major
version increase.
* (Experimental) Added option `FinishRegistrationOptions.isConditionalCreate` to
allow UP=0 in registration response for registration ceremonies with
`mediation: "conditional"`.
** NOTE: Experimental features may receive breaking changes without a major
version increase.


== Version 2.6.0 ==
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,25 @@ public class FinishRegistrationOptions {
*/
private final ByteArray callerTokenBindingId;

/**
* If <code>true</code>, then user presence (UP) will not be required during registration
* verification. This is needed for <a
* href="https://www.w3.org/TR/2025/WD-webauthn-3-20250127/#dom-clientcapability-conditionalcreate">conditional
* create</a> operations.
*
* <p>The default is <code>false</code> (UP is required).
*
* @deprecated EXPERIMENTAL: This feature is from a not yet mature standard; it could change as
* the standard matures.
* @since 2.7.0
* @see <a
* href="https://www.w3.org/TR/2025/WD-webauthn-3-20250127/#dom-clientcapability-conditionalcreate">
* <code>conditionalCreate</code> client capability</a>.
* @see <a href="https://www.w3.org/TR/2025/WD-webauthn-3-20250127/#authdata-flags-up"><code>UP
* </code> flag in authenticator data</a>.
*/
@Deprecated @Builder.Default private final boolean isConditionalCreate = false;

/**
* The <a href="https://tools.ietf.org/html/rfc8471#section-3.2">token binding ID</a> of the
* connection to the client, if any.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ final class FinishRegistrationSteps {
private final Clock clock;
private final boolean allowOriginPort;
private final boolean allowOriginSubdomain;
private final boolean isConditionalCreate;

static FinishRegistrationSteps fromV1(RelyingParty rp, FinishRegistrationOptions options) {
return new FinishRegistrationSteps(
Expand All @@ -102,7 +103,8 @@ static FinishRegistrationSteps fromV1(RelyingParty rp, FinishRegistrationOptions
new CredentialRepositoryV1ToV2Adapter(rp.getCredentialRepository()),
rp.getClock(),
rp.isAllowOriginPort(),
rp.isAllowOriginSubdomain());
rp.isAllowOriginSubdomain(),
options.isConditionalCreate());
}

FinishRegistrationSteps(RelyingPartyV2<?> rp, FinishRegistrationOptions options) {
Expand All @@ -117,7 +119,8 @@ static FinishRegistrationSteps fromV1(RelyingParty rp, FinishRegistrationOptions
rp.getCredentialRepository(),
rp.getClock(),
rp.isAllowOriginPort(),
rp.isAllowOriginSubdomain());
rp.isAllowOriginSubdomain(),
options.isConditionalCreate());
}

public Step6 begin() {
Expand Down Expand Up @@ -303,8 +306,8 @@ class Step14 implements Step<Step15> {
@Override
public void validate() {
assertTrue(
response.getResponse().getParsedAuthenticatorData().getFlags().UP,
"User Presence is required.");
isConditionalCreate || response.getResponse().getParsedAuthenticatorData().getFlags().UP,
"User Presence is required unless isConditionalCreate is true.");
}

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ class RelyingPartyRegistrationSpec
pubkeyCredParams: Option[List[PublicKeyCredentialParameters]] = None,
testData: RegistrationTestData,
clock: Clock = Clock.systemUTC(),
isConditionalCreate: Boolean = false,
): FinishRegistrationSteps = {
var builder = RelyingParty
.builder()
Expand Down Expand Up @@ -191,6 +192,7 @@ class RelyingPartyRegistrationSpec
)
.response(testData.response)
.callerTokenBindingId(callerTokenBindingId.toJava)
.isConditionalCreate(isConditionalCreate)
.build()

builder
Expand Down Expand Up @@ -873,6 +875,7 @@ class RelyingPartyRegistrationSpec
)(chk: Step => B)(
uvr: UserVerificationRequirement,
authDataEdit: ByteArray => ByteArray,
isConditionalCreate: Boolean,
): B = {
val steps = finishRegistration(
testData = testData
Expand All @@ -884,14 +887,19 @@ class RelyingPartyRegistrationSpec
.build()
)
)
.editAuthenticatorData(authDataEdit)
.editAuthenticatorData(authDataEdit),
isConditionalCreate = isConditionalCreate,
)
chk(stepsToStep(steps))
}

def checkFailsWith(
stepsToStep: FinishRegistrationSteps => Step
): (UserVerificationRequirement, ByteArray => ByteArray) => Unit =
): (
UserVerificationRequirement,
ByteArray => ByteArray,
Boolean,
) => Unit =
check(stepsToStep) { step =>
step.validations shouldBe a[Failure[_]]
step.validations.failed.get shouldBe an[
Expand All @@ -902,7 +910,11 @@ class RelyingPartyRegistrationSpec

def checkSucceedsWith(
stepsToStep: FinishRegistrationSteps => Step
): (UserVerificationRequirement, ByteArray => ByteArray) => Unit =
): (
UserVerificationRequirement,
ByteArray => ByteArray,
Boolean,
) => Unit =
check(stepsToStep) { step =>
step.validations shouldBe a[Success[_]]
step.tryNext shouldBe a[Success[_]]
Expand All @@ -912,15 +924,41 @@ class RelyingPartyRegistrationSpec
}

describe("14. Verify that the User Present bit of the flags in authData is set.") {
val (checkFails, checkSucceeds) = checks[
val (chkf, chks) = checks[
FinishRegistrationSteps#Step15,
FinishRegistrationSteps#Step14,
](_.begin.next.next.next.next.next.next.next.next)
def checkFails(
uvr: UserVerificationRequirement,
authDataEdit: ByteArray => ByteArray,
isConditionalCreate: Boolean = false,
): Unit = chkf(uvr, authDataEdit, isConditionalCreate)
def checkSucceeds(
uvr: UserVerificationRequirement,
authDataEdit: ByteArray => ByteArray,
isConditionalCreate: Boolean = false,
): Unit = chks(uvr, authDataEdit, isConditionalCreate)

it("Fails if UV is discouraged and flag is not set.") {
checkFails(UserVerificationRequirement.DISCOURAGED, upOff)
}

it("Fails if UV is discouraged, isConditionalCreate is false and flag is not set.") {
checkFails(
UserVerificationRequirement.DISCOURAGED,
upOff,
isConditionalCreate = false,
)
}

it("Succeeds if UV is discouraged, isConditionalCreate is true and flag is not set.") {
checkSucceeds(
UserVerificationRequirement.DISCOURAGED,
upOff,
isConditionalCreate = true,
)
}

it("Succeeds if UV is discouraged and flag is set.") {
checkSucceeds(UserVerificationRequirement.DISCOURAGED, upOn)
}
Expand Down Expand Up @@ -949,10 +987,20 @@ class RelyingPartyRegistrationSpec
}

describe("15. If user verification is required for this registration, verify that the User Verified bit of the flags in authData is set.") {
val (checkFails, checkSucceeds) = checks[
val (chkf, chks) = checks[
FinishRegistrationSteps#Step16,
FinishRegistrationSteps#Step15,
](_.begin.next.next.next.next.next.next.next.next.next)
def checkFails(
uvr: UserVerificationRequirement,
authDataEdit: ByteArray => ByteArray,
isConditionalCreate: Boolean = false,
): Unit = chkf(uvr, authDataEdit, isConditionalCreate)
def checkSucceeds(
uvr: UserVerificationRequirement,
authDataEdit: ByteArray => ByteArray,
isConditionalCreate: Boolean = false,
): Unit = chks(uvr, authDataEdit, isConditionalCreate)

it("Succeeds if UV is discouraged and flag is not set.") {
checkSucceeds(UserVerificationRequirement.DISCOURAGED, uvOff)
Expand Down