use of com.webauthn4j.data.PublicKeyCredentialDescriptor in project webauthn4j by webauthn4j.
the class WebAuthnModelAuthenticator method getAssertion.
public GetAssertionResponse getAssertion(GetAssertionRequest getAssertionRequest, AuthenticationEmulationOption authenticationEmulationOption) {
byte flags = 0;
// Check if all the supplied parameters are syntactically well-formed and of the correct length.
// If not, return an error code equivalent to "UnknownError" and terminate the operation.
// TODO
// Let credentialOptions be a new empty set of public key credential sources.
List<PublicKeyCredentialSource> credentialOptions = new ArrayList<>();
// If allowCredentialDescriptorList was supplied, then for each descriptor of allowCredentialDescriptorList:
List<PublicKeyCredentialDescriptor> allowCredentialDescriptorList = getAssertionRequest.getAllowCredentialDescriptorList();
if (allowCredentialDescriptorList != null && !allowCredentialDescriptorList.isEmpty()) {
for (PublicKeyCredentialDescriptor credentialDescriptor : getAssertionRequest.getAllowCredentialDescriptorList()) {
// Let credSource be the result of looking up descriptor.id in this authenticator.
PublicKeyCredentialSource credSource = lookup(credentialDescriptor.getId());
if (credSource != null) {
credentialOptions.add(credSource);
}
}
} else // Otherwise (allowCredentialDescriptorList was not supplied),
// for each key -> credSource of this authenticator’s credentials map, append credSource to credentialOptions.
{
for (Map.Entry<CredentialMapKey, PublicKeyCredentialSource> entry : credentialMap.entrySet()) {
credentialOptions.add(entry.getValue());
}
}
// Remove any items from credentialOptions whose rpId is not equal to rpId.
credentialOptions = credentialOptions.stream().filter(item -> item.getRpId().equals(getAssertionRequest.getRpId())).collect(Collectors.toList());
// If credentialOptions is now empty, return an error code equivalent to "NotAllowedError" and terminate the operation.
if (credentialOptions.isEmpty()) {
throw new NotAllowedException("No matching authenticator found");
}
// If requireUserVerification is true, the method of obtaining user consent MUST include user verification.
if (getAssertionRequest.isRequireUserVerification()) {
flags |= BIT_UV;
}
// If requireUserPresence is true, the method of obtaining user consent MUST include a test of user presence.
if (getAssertionRequest.isRequireUserPresence()) {
flags |= BIT_UP;
}
// If the user does not consent, return an error code equivalent to "NotAllowedError" and terminate the operation.
// TODO
PublicKeyCredentialSource selectedCredential = credentialOptions.get(0);
// Let processedExtensions be the result of authenticator extension processing for each supported
// extension identifier -> authenticator extension input in extensions.
AuthenticationExtensionsAuthenticatorOutputs<AuthenticationExtensionAuthenticatorOutput> processedExtensions = new AuthenticationExtensionsAuthenticatorOutputs<>();
if (!processedExtensions.getKeys().isEmpty()) {
flags |= BIT_ED;
}
// Increment the RP ID-associated signature counter or the global signature counter value,
// depending on which approach is implemented by the authenticator, by some positive value.
countUp();
// Let authenticatorData be the byte array specified in §6.1 Authenticator data including processedExtensions,
// if any, as the extensions and excluding attestedCredentialData.
byte[] rpIdHash = MessageDigestUtil.createSHA256().digest(getAssertionRequest.getRpId().getBytes(StandardCharsets.UTF_8));
AuthenticatorData<AuthenticationExtensionAuthenticatorOutput> authenticatorDataObject = new AuthenticatorData<>(rpIdHash, flags, counter, processedExtensions);
byte[] authenticatorData = authenticatorDataConverter.convert(authenticatorDataObject);
// Let signature be the assertion signature of the concatenation authenticatorData || hash using
// the privateKey of selectedCredential as shown in Figure 2, below. A simple, undelimited concatenation is
// safe to use here because the authenticator data describes its own length.
// The hash of the serialized client data (which potentially has a variable length) is always the last element.
byte[] clientDataHash = getAssertionRequest.getHash();
byte[] signedData = ByteBuffer.allocate(authenticatorData.length + clientDataHash.length).put(authenticatorData).put(clientDataHash).array();
byte[] signature = TestDataUtil.calculateSignature(selectedCredential.getPrivateKey().getPrivateKey(), signedData);
// If any error occurred while generating the assertion signature,
// return an error code equivalent to "UnknownError" and terminate the operation.
// Return to the user agent:
GetAssertionResponse getAssertionResponse = new GetAssertionResponse();
getAssertionResponse.setCredentialId(selectedCredential.getId());
getAssertionResponse.setAuthenticatorData(authenticatorData);
getAssertionResponse.setSignature(signature);
getAssertionResponse.setUserHandle(selectedCredential.getUserHandle());
return getAssertionResponse;
}
use of com.webauthn4j.data.PublicKeyCredentialDescriptor in project webauthn4j by webauthn4j.
the class WebAuthnModelAuthenticator method makeCredential.
public MakeCredentialResponse makeCredential(MakeCredentialRequest makeCredentialRequest, RegistrationEmulationOption registrationEmulationOption) {
PublicKeyCredentialRpEntity rpEntity = makeCredentialRequest.getRpEntity();
// Check if all the supplied parameters are syntactically well-formed and of the correct length.
// If not, return an error code equivalent to "UnknownError" and terminate the operation.
// TODO
// Check if at least one of the specified combinations of PublicKeyCredentialType and cryptographic parameters
// in credTypesAndPubKeyAlgs is supported. If not, return an error code equivalent to "NotSupportedError"
// and terminate the operation.
Optional<PublicKeyCredentialParameters> optionalPublicKeyCredentialParameters = makeCredentialRequest.getCredTypesAndPublicKeyAlgs().stream().filter(this::isCapableOfHandling).findFirst();
PublicKeyCredentialParameters publicKeyCredentialParameters;
if (optionalPublicKeyCredentialParameters.isPresent()) {
publicKeyCredentialParameters = optionalPublicKeyCredentialParameters.get();
} else {
throw new NotSupportedException("Specified PublicKeyCredentialParameters are not supported");
}
// For each descriptor of excludeCredentialDescriptorList:
List<PublicKeyCredentialDescriptor> descriptors = makeCredentialRequest.getExcludeCredentialDescriptorList();
if (descriptors == null) {
descriptors = Collections.emptyList();
}
for (PublicKeyCredentialDescriptor descriptor : descriptors) {
PublicKeyCredentialSource publicKeyCredentialSource = lookup(descriptor.getId());
// The method of obtaining user consent MUST include a test of user presence.
if (publicKeyCredentialSource != null) {
if (publicKeyCredentialSource.getRpId().equals(rpEntity.getId()) && publicKeyCredentialSource.getType().equals(descriptor.getType())) {
boolean userConsent = true;
// confirms consent to create a new credential
if (userConsent) {
throw new InvalidStateException("");
} else // does not consent to create a new credential
{
throw new NotAllowedException("User consent is required");
}
}
}
}
// return an error code equivalent to "ConstraintError" and terminate the operation.
if (makeCredentialRequest.isRequireResidentKey() && !isCapableOfStoringClientSideResidentCredential()) {
throw new ConstraintException("Authenticator isn't capable of storing client-side resident credential");
}
// return an error code equivalent to "ConstraintError" and terminate the operation.
if (makeCredentialRequest.isRequireUserVerification() && !isCapableOfUserVerification()) {
throw new ConstraintException("Authenticator isn't capable of user verification");
}
// Obtain user consent for creating a new credential.
// The prompt for obtaining this consent is shown by the authenticator if it has its own output capability,
// or by the user agent otherwise. The prompt SHOULD display rpEntity.id, rpEntity.name, userEntity.name
// and userEntity.displayName, if possible.
boolean userVerification = true;
boolean userConsent = true;
// "NotAllowedError" and terminate the operation.
if (makeCredentialRequest.isRequireUserVerification() && !userVerification) {
throw new NotAllowedException("User is not verified.");
}
if (makeCredentialRequest.isRequireUserPresence() && !userConsent) {
throw new NotAllowedException("User doesn't resolve consent.");
}
// Once user consent has been obtained, generate a new credential object:
byte[] credentialId;
// Let (publicKey, privateKey) be a new pair of cryptographic keys using the combination of
// PublicKeyCredentialType and cryptographic parameters represented by the first item in
// credTypesAndPubKeyAlgs that is supported by this authenticator.
KeyPair credentialKeyPair;
COSEKey cosePublicKey;
COSEKey cosePrivateKey;
try {
credentialKeyPair = ECUtil.createKeyPair();
ECPublicKey publicKey = (ECPublicKey) credentialKeyPair.getPublic();
ECPrivateKey privateKey = (ECPrivateKey) credentialKeyPair.getPrivate();
cosePublicKey = TestDataUtil.createEC2COSEPublicKey(publicKey);
cosePrivateKey = TestDataUtil.createEC2COSEPrivateKey(publicKey, privateKey);
// Let userHandle be userEntity.id.
byte[] userHandle = makeCredentialRequest.getUserEntity().getId();
// Let credentialSource be a new public key credential source with the fields:
PublicKeyCredentialSource credentialSource = new PublicKeyCredentialSource();
credentialSource.setType(PublicKeyCredentialType.PUBLIC_KEY);
credentialSource.setPrivateKey(cosePrivateKey);
credentialSource.setRpId(rpEntity.getId());
credentialSource.setUserHandle(userHandle);
credentialSource.setOtherUI(null);
// Credential Private Key:
if (makeCredentialRequest.isRequireResidentKey()) {
// Let credentialId be a new credential id.
credentialId = new byte[32];
secureRandom.nextBytes(credentialId);
// Set credentialSource.id to credentialId.
credentialSource.setId(credentialId);
// Let credentials be this authenticator’s credentials map.
// noinspection UnnecessaryLocalVariable
Map<CredentialMapKey, PublicKeyCredentialSource> credentials = credentialMap;
credentials.put(new CredentialMapKey(rpEntity.getId(), userHandle), credentialSource);
} else // Otherwise:
{
// Let credentialId be the result of serializing and encrypting credentialSource
// so that only this authenticator can decrypt it.
byte[] data = cborConverter.writeValueAsBytes(credentialSource);
credentialId = CipherUtil.encrypt(data, credentialEncryptionKey);
}
}// return an error code equivalent to "UnknownError" and terminate the operation.
catch (RuntimeException e) {
throw new WebAuthnModelException(e);
}
// Let processedExtensions be the result of authenticator extension processing for each
// supported extension identifier -> authenticator extension input in extensions.
AuthenticationExtensionsAuthenticatorOutputs<RegistrationExtensionAuthenticatorOutput> registrationExtensionAuthenticatorOutputs = processRegistrationExtensions(makeCredentialRequest);
// If the authenticator supports:
// a per-RP ID signature counter
// allocate the counter, associate it with the RP ID, and initialize the counter value as zero.
// a global signature counter
// Use the global signature counter's actual value when generating authenticator data.
// a per credential signature counter
// allocate the counter, associate it with the new credential, and initialize the counter value as zero.
// TODO: counter mode
countUp();
// Let attestedCredentialData be the attested credential data byte array including the credentialId and publicKey.
byte[] rpIdHash = MessageDigestUtil.createSHA256().digest(rpEntity.getId().getBytes(StandardCharsets.UTF_8));
byte flag = BIT_AT;
if (userConsent)
flag |= BIT_UP;
if (userVerification)
flag |= BIT_UV;
if (!registrationExtensionAuthenticatorOutputs.getKeys().isEmpty())
flag |= BIT_ED;
AttestedCredentialData attestedCredentialData = new AttestedCredentialData(aaguid, credentialId, cosePublicKey);
// Let authenticatorData be the byte array specified in §6.1 Authenticator data,
// including attestedCredentialData as the attestedCredentialData and processedExtensions, if any, as the extensions.
AuthenticatorData<RegistrationExtensionAuthenticatorOutput> authenticatorData = new AuthenticatorData<>(rpIdHash, flag, counter, attestedCredentialData, registrationExtensionAuthenticatorOutputs);
byte[] authenticatorDataBytes = authenticatorDataConverter.convert(authenticatorData);
byte[] signedData = getSignedData(authenticatorDataBytes, makeCredentialRequest.getHash());
byte[] clientDataHash = makeCredentialRequest.getHash();
AttestationStatementRequest attestationStatementRequest = new AttestationStatementRequest(signedData, credentialKeyPair, clientDataHash);
AttestationStatement attestationStatement = createAttestationStatement(attestationStatementRequest, registrationEmulationOption);
// Return the attestation object for the new credential created by the procedure specified in
// §6.3.4 Generating an Attestation Object using an authenticator-chosen attestation statement format,
// authenticatorData, and hash. For more details on attestation, see §6.3 Attestation.
AttestationObject attestationObject = new AttestationObject(authenticatorData, attestationStatement);
// On successful completion of this operation, the authenticator returns the attestation object to the client.
MakeCredentialResponse makeCredentialResponse = new MakeCredentialResponse();
makeCredentialResponse.setAttestationObject(attestationObject);
return makeCredentialResponse;
}
use of com.webauthn4j.data.PublicKeyCredentialDescriptor in project webauthn4j-spring-security by webauthn4j.
the class AssertionOptionsTest method getter_test.
@Test
public void getter_test() {
String rpId = "example.com";
long timeout = 0;
Challenge challenge = new DefaultChallenge();
byte[] credentialId = new byte[32];
List<PublicKeyCredentialDescriptor> allowCredentials = Collections.singletonList(new PublicKeyCredentialDescriptor(PublicKeyCredentialType.PUBLIC_KEY, credentialId, CollectionUtil.unmodifiableSet(AuthenticatorTransport.USB, AuthenticatorTransport.NFC, AuthenticatorTransport.BLE)));
AssertionOptions credentialRequestOptions = new AssertionOptions(challenge, timeout, rpId, allowCredentials, UserVerificationRequirement.DISCOURAGED, null);
assertAll(() -> assertThat(credentialRequestOptions.getChallenge()).isEqualTo(challenge), () -> assertThat(credentialRequestOptions.getTimeout()).isEqualTo(timeout), () -> assertThat(credentialRequestOptions.getRpId()).isEqualTo(rpId), () -> assertThat(credentialRequestOptions.getAllowCredentials()).isEqualTo(allowCredentials), () -> assertThat(credentialRequestOptions.getUserVerification()).isEqualTo(UserVerificationRequirement.DISCOURAGED), () -> assertThat(credentialRequestOptions.getExtensions()).isNull());
}
use of com.webauthn4j.data.PublicKeyCredentialDescriptor in project webauthn4j-spring-security by webauthn4j.
the class PublicKeyCredentialDescriptorMixinTest method test.
@Test
public void test() {
ObjectMapper jsonMapper = new ObjectMapper();
jsonMapper.addMixIn(PublicKeyCredentialDescriptor.class, PublicKeyCredentialDescriptorMixin.class);
ObjectMapper cborMapper = new ObjectMapper(new CBORFactory());
ObjectConverter objectConverter = new ObjectConverter(jsonMapper, cborMapper);
PublicKeyCredentialDescriptor publicKeyCredentialDescriptor = new PublicKeyCredentialDescriptor(PublicKeyCredentialType.PUBLIC_KEY, new byte[32], Collections.singleton(AuthenticatorTransport.INTERNAL));
String json = objectConverter.getJsonConverter().writeValueAsString(publicKeyCredentialDescriptor);
assertThat(json).isEqualTo("{\"type\":\"public-key\",\"id\":\"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\",\"transports\":[\"internal\"]}");
assertThat(objectConverter.getJsonConverter().readValue(json, PublicKeyCredentialDescriptor.class)).isEqualTo(publicKeyCredentialDescriptor);
}
use of com.webauthn4j.data.PublicKeyCredentialDescriptor in project webauthn4j by webauthn4j.
the class FIDOU2FAuthenticatorAdaptor method authenticate.
@Override
public CredentialRequestResponse authenticate(PublicKeyCredentialRequestOptions publicKeyCredentialRequestOptions, CollectedClientData collectedClientData, AuthenticationEmulationOption authenticationEmulationOption) {
byte[] collectedClientDataBytes = collectedClientDataConverter.convertToBytes(collectedClientData);
String rpId = publicKeyCredentialRequestOptions.getRpId();
byte[] rpIdHash = MessageDigestUtil.createSHA256().digest(rpId.getBytes(StandardCharsets.UTF_8));
byte control = 0x00;
byte[] challenge = MessageDigestUtil.createSHA256().digest(collectedClientDataBytes);
// noinspection UnnecessaryLocalVariable
byte[] applicationParameter = rpIdHash;
List<PublicKeyCredentialDescriptor> publicKeyCredentialDescriptors = publicKeyCredentialRequestOptions.getAllowCredentials();
PublicKeyCredentialDescriptor publicKeyCredentialDescriptor = publicKeyCredentialDescriptors.get(0);
// TODO: what to do if multiple publicKeyCredentialDescriptors are supplied
byte[] keyHandle = publicKeyCredentialDescriptor.getId();
AuthenticationRequest authenticationRequest = new AuthenticationRequest(control, challenge, applicationParameter, keyHandle);
AuthenticationResponse authenticationResponse = fidoU2FAuthenticator.authenticate(authenticationRequest, authenticationEmulationOption);
byte[] credentialId = publicKeyCredentialDescriptor.getId();
long counter = ByteBuffer.allocate(8).put(new byte[4]).put(authenticationResponse.getCounter()).getLong(0);
AuthenticatorData<AuthenticationExtensionAuthenticatorOutput> authenticatorData = new AuthenticatorData<>(rpIdHash, authenticationResponse.getUserPresence(), counter);
byte[] authenticatorDataBytes = authenticatorDataConverter.convert(authenticatorData);
byte[] signature = authenticationResponse.getSignature();
return new CredentialRequestResponse(credentialId, collectedClientDataBytes, authenticatorDataBytes, signature, null);
}
Aggregations