fix: add missing mapping of VerificationMethod type

bscholtes1A · Feb 9, 2024 · df57cd7 · df57cd7
1 parent 13e6bde
commit df57cd7
Show file tree

Hide file tree

Showing 26 changed files with 241 additions and 143 deletions.
diff --git a/...dentity-hub-did/src/main/java/org/eclipse/edc/identityhub/did/DidDocumentServiceImpl.java b/...dentity-hub-did/src/main/java/org/eclipse/edc/identityhub/did/DidDocumentServiceImpl.java
@@ -264,6 +264,7 @@ private void keypairAdded(KeyPairAdded event) {
                         .id(event.getKeyId())
                         .publicKeyJwk(jwk.toJSONObject())
                         .controller(dd.getDocument().getId())
+                        .type(event.getType())
                         .build()))
                 .map(didResourceStore::update)
                 .filter(StoreResult::failed)

diff --git a/...ub-keypairs/src/main/java/org/eclipse/edc/identityhub/keypairs/KeyPairEventPublisher.java b/...ub-keypairs/src/main/java/org/eclipse/edc/identityhub/keypairs/KeyPairEventPublisher.java
@@ -35,11 +35,11 @@ public KeyPairEventPublisher(Clock clock, EventRouter eventRouter) {
     }
 
     @Override
-    public void added(KeyPairResource keyPair) {
+    public void added(KeyPairResource keyPair, String type) {
         var event = KeyPairAdded.Builder.newInstance()
                 .participantId(keyPair.getParticipantId())
                 .keyId(keyPair.getId())
-                .publicKey(keyPair.getSerializedPublicKey())
+                .publicKey(keyPair.getSerializedPublicKey(), type)
                 .build();
         publish(event);
     }

diff --git a/...y-hub-keypairs/src/main/java/org/eclipse/edc/identityhub/keypairs/KeyPairServiceImpl.java b/...y-hub-keypairs/src/main/java/org/eclipse/edc/identityhub/keypairs/KeyPairServiceImpl.java
@@ -74,7 +74,8 @@ public ServiceResult<Void> addKeyPair(String participantId, KeyDescriptor keyDes
                 .participantId(participantId)
                 .build();
 
-        return ServiceResult.from(keyPairResourceStore.create(newResource)).onSuccess(v -> observable.invokeForEach(l -> l.added(newResource)));
+        return ServiceResult.from(keyPairResourceStore.create(newResource))
+                .onSuccess(v -> observable.invokeForEach(l -> l.added(newResource, keyDescriptor.getType())));
     }
 
     @Override

diff --git a/...tests/src/test/java/org/eclipse/edc/identityhub/tests/KeyPairResourceApiEndToEndTest.java b/...tests/src/test/java/org/eclipse/edc/identityhub/tests/KeyPairResourceApiEndToEndTest.java
@@ -44,6 +44,14 @@
 @EndToEndTest
 public class KeyPairResourceApiEndToEndTest extends ManagementApiEndToEndTest {
 
+    private static KeyDescriptor.Builder createKeyDescriptor(String participantId) {
+        var id = UUID.randomUUID().toString();
+        return KeyDescriptor.Builder.newInstance()
+                .keyId(id)
+                .keyGeneratorParams(Map.of("algorithm", "EC", "curve", Curve.P_384.getStdName()))
+                .privateKeyAlias("%s-%s-alias".formatted(participantId, id));
+    }
+
     @Test
     void findById_notAuthorized() {
         var user1 = "user1";
@@ -288,9 +296,11 @@ void revoke() {
 
         assertThat(Arrays.asList(token, getSuperUserApiKey()))
                 .allSatisfy(t -> {
+                    var keyDesc = createKeyDescriptor(user1).build();
                     RUNTIME_CONFIGURATION.getManagementEndpoint().baseRequest()
                             .contentType(JSON)
                             .header(new Header("x-api-key", t))
+                            .body(keyDesc)
                             .post("/v1/participants/%s/keypairs/%s/revoke".formatted(user1, keyId))
                             .then()
                             .log().ifValidationFails()
@@ -313,9 +323,11 @@ void revoke_notAuthorized() {
         var keyId = createKeyPair(user1);
 
         // attempt to publish user1's DID document, which should fail
+        var keyDesc = createKeyDescriptor(user1).build();
         RUNTIME_CONFIGURATION.getManagementEndpoint().baseRequest()
                 .contentType(JSON)
                 .header(new Header("x-api-key", token2))
+                .body(keyDesc)
                 .post("/v1/participants/%s/keypairs/%s/revoke".formatted(user1, keyId))
                 .then()
                 .log().ifValidationFails()
@@ -333,12 +345,4 @@ private String createKeyPair(String participantId) {
         return descriptor.getKeyId();
     }
 
-    private static KeyDescriptor.Builder createKeyDescriptor(String participantId) {
-        var id = UUID.randomUUID().toString();
-        return KeyDescriptor.Builder.newInstance()
-                .keyId(id)
-                .keyGeneratorParams(Map.of("algorithm", "EC", "curve", Curve.P_384.getStdName()))
-                .privateKeyAlias("%s-%s-alias".formatted(participantId, id));
-    }
-
 }
diff --git a/extensions/api/did-mgmt-api/build.gradle.kts b/extensions/api/did-mgmt-api/build.gradle.kts
@@ -23,6 +23,7 @@ dependencies {
     api(project(":spi:identity-hub-spi"))
     api(project(":spi:identity-hub-did-spi"))
     implementation(project(":extensions:api:identityhub-management-api-configuration"))
+    implementation(project(":extensions:api:identityhub-management-api-validators"))
     implementation(libs.edc.spi.validator)
     implementation(libs.edc.spi.web)
     implementation(libs.edc.core.jerseyproviders)

diff --git a/...java/org/eclipse/edc/identityhub/api/didmanagement/v1/validation/DidRequestValidator.java b/...java/org/eclipse/edc/identityhub/api/didmanagement/v1/validation/DidRequestValidator.java
diff --git a/extensions/api/identityhub-management-api-validators/build.gradle.kts b/extensions/api/identityhub-management-api-validators/build.gradle.kts
@@ -0,0 +1,13 @@
+plugins {
+    `java-library`
+    `maven-publish`
+}
+
+dependencies {
+    api(libs.edc.spi.core)
+    api(project(":spi:identity-hub-spi"))
+    api(project(":spi:identity-hub-did-spi"))
+    implementation(libs.edc.util)
+
+    testImplementation(libs.edc.junit)
+}
diff --git a/...v1/validation/KeyDescriptorValidator.java → ...v1/validation/KeyDescriptorValidator.java b/...v1/validation/KeyDescriptorValidator.java → ...v1/validation/KeyDescriptorValidator.java
@@ -12,16 +12,19 @@
  *
  */
 
-package org.eclipse.edc.identityhub.api.participantcontext.v1.validation;
+package org.eclipse.edc.identityhub.api.v1.validation;
 
+import org.eclipse.edc.iam.did.spi.document.DidConstants;
 import org.eclipse.edc.identityhub.spi.model.participant.KeyDescriptor;
+import org.eclipse.edc.spi.monitor.Monitor;
 import org.eclipse.edc.util.string.StringUtils;
 import org.eclipse.edc.validator.spi.ValidationResult;
 import org.eclipse.edc.validator.spi.Validator;
 
 import java.util.Objects;
 import java.util.stream.Stream;
 
+import static java.lang.String.format;
 import static org.eclipse.edc.validator.spi.ValidationResult.failure;
 import static org.eclipse.edc.validator.spi.ValidationResult.success;
 import static org.eclipse.edc.validator.spi.Violation.violation;
@@ -37,6 +40,13 @@
  * </ul>
  */
 public class KeyDescriptorValidator implements Validator<KeyDescriptor> {
+
+    private final Monitor monitor;
+
+    public KeyDescriptorValidator(Monitor monitor) {
+        this.monitor = monitor;
+    }
+
     @Override
     public ValidationResult validate(KeyDescriptor input) {
         if (input == null) {
@@ -47,6 +57,10 @@ public ValidationResult validate(KeyDescriptor input) {
             return failure(violation("keyId cannot be null.", "keyId"));
         }
 
+        if (!DidConstants.ALLOWED_VERIFICATION_TYPES.contains(input.getType())) {
+            monitor.warning(format("Provided type %s is not supported.", input.getType()));
+        }
+
         if (StringUtils.isNullOrBlank(input.getPrivateKeyAlias())) {
             return failure(violation("privateKeyAlias cannot be null.", "privateKeyAlias"));
         }

diff --git a/...idation/ParticipantManifestValidator.java → ...idation/ParticipantManifestValidator.java b/...idation/ParticipantManifestValidator.java → ...idation/ParticipantManifestValidator.java
@@ -12,9 +12,10 @@
  *
  */
 
-package org.eclipse.edc.identityhub.api.participantcontext.v1.validation;
+package org.eclipse.edc.identityhub.api.v1.validation;
 
 import org.eclipse.edc.identityhub.spi.model.participant.ParticipantManifest;
+import org.eclipse.edc.spi.monitor.Monitor;
 import org.eclipse.edc.util.string.StringUtils;
 import org.eclipse.edc.validator.spi.ValidationResult;
 import org.eclipse.edc.validator.spi.Validator;
@@ -24,7 +25,11 @@
 import static org.eclipse.edc.validator.spi.Violation.violation;
 
 public class ParticipantManifestValidator implements Validator<ParticipantManifest> {
-    private final KeyDescriptorValidator keyDescriptorValidator = new KeyDescriptorValidator();
+    private final KeyDescriptorValidator keyDescriptorValidator;
+
+    public ParticipantManifestValidator(Monitor monitor) {
+        this.keyDescriptorValidator = new KeyDescriptorValidator(monitor);
+    }
 
     @Override
     public ValidationResult validate(ParticipantManifest input) {

diff --git a/...alidation/KeyDescriptorValidatorTest.java → ...alidation/KeyDescriptorValidatorTest.java b/...alidation/KeyDescriptorValidatorTest.java → ...alidation/KeyDescriptorValidatorTest.java
@@ -12,9 +12,10 @@
  *
  */
 
-package org.eclipse.edc.identityhub.api.participantcontext.v1.validation;
+package org.eclipse.edc.identityhub.api.v1.validation;
 
 import org.eclipse.edc.identityhub.spi.model.participant.KeyDescriptor;
+import org.eclipse.edc.spi.monitor.ConsoleMonitor;
 import org.junit.jupiter.api.Test;
 
 import java.util.Map;
@@ -23,7 +24,7 @@
 
 class KeyDescriptorValidatorTest {
 
-    private final KeyDescriptorValidator validator = new KeyDescriptorValidator();
+    private final KeyDescriptorValidator validator = new KeyDescriptorValidator(new ConsoleMonitor());
 
     @Test
     void validate_success() {
@@ -110,6 +111,5 @@ void validate_publicKeyPemAndGeneratorParams() {
         assertThat(validator.validate(descriptor)).isFailed()
                 .detail().isEqualTo("Either the public key is specified (PEM or JWK), or the generator params are provided, not both.");
     }
-
-
+
 }
diff --git a/...ion/ParticipantManifestValidatorTest.java → ...ion/ParticipantManifestValidatorTest.java b/...ion/ParticipantManifestValidatorTest.java → ...ion/ParticipantManifestValidatorTest.java
@@ -12,11 +12,12 @@
  *
  */
 
-package org.eclipse.edc.identityhub.api.participantcontext.v1.validation;
+package org.eclipse.edc.identityhub.api.v1.validation;
 
 import org.eclipse.edc.iam.did.spi.document.Service;
 import org.eclipse.edc.identityhub.spi.model.participant.KeyDescriptor;
 import org.eclipse.edc.identityhub.spi.model.participant.ParticipantManifest;
+import org.eclipse.edc.spi.monitor.ConsoleMonitor;
 import org.jetbrains.annotations.NotNull;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
@@ -29,7 +30,25 @@
 
 class ParticipantManifestValidatorTest {
 
-    private final ParticipantManifestValidator validator = new ParticipantManifestValidator();
+    private final ParticipantManifestValidator validator = new ParticipantManifestValidator(new ConsoleMonitor());
+
+    @NotNull
+    private static ParticipantManifest.Builder createManifest() {
+        return ParticipantManifest.Builder.newInstance()
+                .serviceEndpoint(new Service("id", "type", "foobar"))
+                .active(true)
+                .did("did:web:test-did")
+                .participantId("test-id")
+                .key(createKeyDescriptor().build());
+    }
+
+    @NotNull
+    private static KeyDescriptor.Builder createKeyDescriptor() {
+        return KeyDescriptor.Builder.newInstance()
+                .keyId("key-id")
+                .privateKeyAlias("alias")
+                .publicKeyJwk(Map.of("foo", "bar"));
+    }
 
     @Test
     void validate_success() {
@@ -75,22 +94,4 @@ void validate_participantIdNull(String participantId) {
         assertThat(validator.validate(manifest)).isFailed()
                 .detail().isEqualTo("participantId cannot be null or empty.");
     }
-
-    @NotNull
-    private static ParticipantManifest.Builder createManifest() {
-        return ParticipantManifest.Builder.newInstance()
-                .serviceEndpoint(new Service("id", "type", "foobar"))
-                .active(true)
-                .did("did:web:test-did")
-                .participantId("test-id")
-                .key(createKeyDescriptor().build());
-    }
-
-    @NotNull
-    private static KeyDescriptor.Builder createKeyDescriptor() {
-        return KeyDescriptor.Builder.newInstance()
-                .keyId("key-id")
-                .privateKeyAlias("alias")
-                .publicKeyJwk(Map.of("foo", "bar"));
-    }
 }
diff --git a/extensions/api/keypair-mgmt-api/build.gradle.kts b/extensions/api/keypair-mgmt-api/build.gradle.kts
@@ -9,6 +9,7 @@ dependencies {
     api(project(":spi:identity-hub-spi"))
     api(project(":spi:identity-hub-store-spi"))
     implementation(project(":extensions:api:identityhub-management-api-configuration"))
+    implementation(project(":extensions:api:identityhub-management-api-validators"))
     implementation(libs.edc.spi.web)
     implementation(libs.edc.util)
     implementation(libs.jakarta.rsApi)

diff --git a/...eyPairResourceManagementApiExtension.java → ...eyPairResourceManagementApiExtension.java b/...eyPairResourceManagementApiExtension.java → ...eyPairResourceManagementApiExtension.java
@@ -12,9 +12,10 @@
  *
  */
 
-package org.eclipse.edc.identityhub.api.verifiablecredentials;
+package org.eclipse.edc.identityhub.api.keypair;
 
-import org.eclipse.edc.identityhub.api.verifiablecredentials.v1.KeyPairResourceApiController;
+import org.eclipse.edc.identityhub.api.keypair.v1.KeyPairResourceApiController;
+import org.eclipse.edc.identityhub.api.v1.validation.KeyDescriptorValidator;
 import org.eclipse.edc.identityhub.spi.AuthorizationService;
 import org.eclipse.edc.identityhub.spi.KeyPairService;
 import org.eclipse.edc.identityhub.spi.ManagementApiConfiguration;
@@ -23,13 +24,14 @@
 import org.eclipse.edc.runtime.metamodel.annotation.Extension;
 import org.eclipse.edc.runtime.metamodel.annotation.Inject;
 import org.eclipse.edc.spi.EdcException;
+import org.eclipse.edc.spi.monitor.Monitor;
 import org.eclipse.edc.spi.query.Criterion;
 import org.eclipse.edc.spi.query.QuerySpec;
 import org.eclipse.edc.spi.system.ServiceExtension;
 import org.eclipse.edc.spi.system.ServiceExtensionContext;
 import org.eclipse.edc.web.spi.WebService;
 
-import static org.eclipse.edc.identityhub.api.verifiablecredentials.KeyPairResourceManagementApiExtension.NAME;
+import static org.eclipse.edc.identityhub.api.keypair.KeyPairResourceManagementApiExtension.NAME;
 
 @Extension(NAME)
 public class KeyPairResourceManagementApiExtension implements ServiceExtension {
@@ -43,6 +45,8 @@ public class KeyPairResourceManagementApiExtension implements ServiceExtension {
     private KeyPairService keyPairService;
     @Inject
     private AuthorizationService authorizationService;
+    @Inject
+    private Monitor monitor;
 
     @Override
     public String name() {
@@ -52,7 +56,7 @@ public String name() {
     @Override
     public void initialize(ServiceExtensionContext context) {
         authorizationService.addLookupFunction(KeyPairResource.class, this::findById);
-        var controller = new KeyPairResourceApiController(authorizationService, keyPairService);
+        var controller = new KeyPairResourceApiController(authorizationService, keyPairService, new KeyDescriptorValidator(monitor));
         webService.registerResource(managementApiConfiguration.getContextAlias(), controller);
     }
 

diff --git a/...blecredentials/v1/KeyPairResourceApi.java → ...ub/api/keypair/v1/KeyPairResourceApi.java b/...blecredentials/v1/KeyPairResourceApi.java → ...ub/api/keypair/v1/KeyPairResourceApi.java
@@ -12,7 +12,7 @@
  *
  */
 
-package org.eclipse.edc.identityhub.api.verifiablecredentials.v1;
+package org.eclipse.edc.identityhub.api.keypair.v1;
 
 import io.swagger.v3.oas.annotations.OpenAPIDefinition;
 import io.swagger.v3.oas.annotations.Operation;