-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding utility endpoint for validating SD-JWT VCs (#221)
- Loading branch information
Showing
6 changed files
with
362 additions
and
39 deletions.
There are no files selected for viewing
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
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
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
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
150 changes: 150 additions & 0 deletions
150
src/main/kotlin/eu/europa/ec/eudi/verifier/endpoint/port/input/ValidateSdJwtVc.kt
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| /* | ||
| * Copyright (c) 2023 European Commission | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package eu.europa.ec.eudi.verifier.endpoint.port.input | ||
|
|
||
| import arrow.core.Either | ||
| import arrow.core.getOrElse | ||
| import arrow.core.toNonEmptyListOrNull | ||
| import eu.europa.ec.eudi.sdjwt.* | ||
| import eu.europa.ec.eudi.sdjwt.vc.DefaultHttpClientFactory | ||
| import eu.europa.ec.eudi.sdjwt.vc.SdJwtVcVerifier | ||
| import eu.europa.ec.eudi.sdjwt.vc.X509CertificateTrust | ||
| import eu.europa.ec.eudi.verifier.endpoint.adapter.out.cert.X5CShouldBe | ||
| import eu.europa.ec.eudi.verifier.endpoint.adapter.out.cert.X5CValidator | ||
| import eu.europa.ec.eudi.verifier.endpoint.domain.Nonce | ||
| import kotlinx.serialization.Serializable | ||
| import kotlinx.serialization.json.JsonObject | ||
| import kotlinx.serialization.json.buildJsonObject | ||
| import kotlinx.serialization.json.put | ||
| import org.slf4j.LoggerFactory | ||
| import java.security.KeyStore | ||
|
|
||
| /** | ||
| * Reasons why validation of an SD-JWT Verifiable Credential might fail. | ||
| */ | ||
| @Serializable | ||
| enum class SdJwtVcValidationErrorTO { | ||
| ContainsInvalidDisclosures, | ||
| ContainsInvalidJwt, | ||
| ContainsInvalidKeyBindingJwt, | ||
| IsMissingHolderPublicKey, | ||
| IsMissingKeyBindingJwt, | ||
| ContainsDisclosuresWithNoDigests, | ||
| ContainsUnknownHashingAlgorithm, | ||
| ContainsNonUniqueDigests, | ||
| ContainsNonUniqueDisclosures, | ||
| IsUnparsable, | ||
| Other, | ||
| } | ||
|
|
||
| sealed interface SdJwtVcValidationResult { | ||
| /** | ||
| * Successfully validated an SD-JWT Verifiable Credential. | ||
| */ | ||
| data class Valid(val payload: JsonObject) : SdJwtVcValidationResult | ||
|
|
||
| /** | ||
| * SD-JWT Verifiable Credential validation failed. | ||
| */ | ||
| data class Invalid(val reason: SdJwtVcValidationErrorTO) : SdJwtVcValidationResult | ||
| } | ||
|
|
||
| internal typealias SdJwt = String | ||
| internal typealias Audience = String | ||
|
|
||
| private object Claims { | ||
| val Audience = RFC7519.AUDIENCE | ||
| val Nonce = "nonce" | ||
| } | ||
|
|
||
| /** | ||
| * Validates an SD-JWT Verifiable Credential. | ||
| * | ||
| * @param trustedIssuers keystore containing the X509 Certificates of the trusted issuers | ||
| * @param audience the public url of this verifier, expected to be found in the KeyBinding JWT | ||
| */ | ||
| internal class ValidateSdJwtVc( | ||
| trustedIssuers: KeyStore?, | ||
| private val audience: Audience, | ||
| ) { | ||
| private val verifier: SdJwtVcVerifier by lazy { | ||
| val x5CShouldBe = trustedIssuers?.let { | ||
| X5CShouldBe.fromKeystore(it) { | ||
| isRevocationEnabled = false | ||
| } | ||
| } ?: X5CShouldBe.Ignored | ||
| val x5cValidator = X5CValidator(x5CShouldBe) | ||
| val x509CertificateTrust = X509CertificateTrust { chain -> | ||
| chain.toNonEmptyListOrNull()?.let { | ||
| x5cValidator.ensureTrusted(it).fold( | ||
| ifLeft = { _ -> false }, | ||
| ifRight = { _ -> true }, | ||
| ) | ||
| } ?: false | ||
| } | ||
| SdJwtVcVerifier.usingX5cOrIssuerMetadata( | ||
| x509CertificateTrust = x509CertificateTrust, | ||
| httpClientFactory = DefaultHttpClientFactory, | ||
| ) | ||
| } | ||
|
|
||
| suspend operator fun invoke(unverified: SdJwt, nonce: Nonce): SdJwtVcValidationResult { | ||
| val challenge = buildJsonObject { | ||
| put(Claims.Audience, audience) | ||
| put(Claims.Nonce, nonce.value) | ||
| } | ||
|
|
||
| return Either.catch { | ||
| val (presentation, keyBinding) = verifier.verifyPresentation(unverified, challenge).getOrThrow() | ||
| checkNotNull(keyBinding) { "KeyBinding JWT cannot be null" } | ||
|
|
||
| val payload = with(DefaultSdJwtOps) { | ||
| presentation.recreateClaims(visitor = null) | ||
| } | ||
| SdJwtVcValidationResult.Valid(payload) | ||
| }.getOrElse { | ||
| log.error("SD-JWT-VC validation failed", it) | ||
| if (it is SdJwtVerificationException) { | ||
| SdJwtVcValidationResult.Invalid(it.toSdJwtVcValidationErrorTO()) | ||
| } else { | ||
| SdJwtVcValidationResult.Invalid(SdJwtVcValidationErrorTO.Other) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private val log = LoggerFactory.getLogger(ValidateSdJwtVc::class.java) | ||
|
|
||
| private fun SdJwtVerificationException.toSdJwtVcValidationErrorTO(): SdJwtVcValidationErrorTO = | ||
| when (val reason = this.reason) { | ||
| is VerificationError.InvalidDisclosures -> SdJwtVcValidationErrorTO.ContainsInvalidDisclosures | ||
| VerificationError.InvalidJwt -> SdJwtVcValidationErrorTO.ContainsInvalidJwt | ||
| is VerificationError.KeyBindingFailed -> reason.details.toSdJwtVcValidationErrorTO() | ||
| is VerificationError.MissingDigests -> SdJwtVcValidationErrorTO.ContainsDisclosuresWithNoDigests | ||
| VerificationError.MissingOrUnknownHashingAlgorithm -> SdJwtVcValidationErrorTO.ContainsUnknownHashingAlgorithm | ||
| VerificationError.NonUniqueDisclosureDigests -> SdJwtVcValidationErrorTO.ContainsNonUniqueDigests | ||
| VerificationError.NonUniqueDisclosures -> SdJwtVcValidationErrorTO.ContainsNonUniqueDisclosures | ||
| is VerificationError.Other -> SdJwtVcValidationErrorTO.Other | ||
| VerificationError.ParsingError -> SdJwtVcValidationErrorTO.IsUnparsable | ||
| } | ||
|
|
||
| private fun KeyBindingError.toSdJwtVcValidationErrorTO(): SdJwtVcValidationErrorTO = | ||
| when (this) { | ||
| KeyBindingError.InvalidKeyBindingJwt -> SdJwtVcValidationErrorTO.ContainsInvalidKeyBindingJwt | ||
| KeyBindingError.MissingHolderPubKey -> SdJwtVcValidationErrorTO.IsMissingHolderPublicKey | ||
| KeyBindingError.MissingKeyBindingJwt -> SdJwtVcValidationErrorTO.IsMissingKeyBindingJwt | ||
| KeyBindingError.UnexpectedKeyBindingJwt -> error("KeyBindingJwt is required, but verification failed with '$this'") | ||
| } |
Oops, something went wrong.