forked from eclipse-edc/IdentityHub
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add Issuer Service skeleton (eclipse-edc#524)
* feat: add Credential Request API + issuer service skeleton * added issuer-service launcher * added issuer APIs (skeletons) * removed yaml folder * license headers * update api version files * fix API version file
- Loading branch information
1 parent
09b6026
commit 05e2398
Showing
30 changed files
with
939 additions
and
10 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| /* | ||
| * Copyright (c) 2025 Cofinity-X | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Apache License, Version 2.0 which is available at | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * Contributors: | ||
| * Cofinity-X - initial API and implementation | ||
| * | ||
| */ | ||
|
|
||
| plugins { | ||
| `java-library` | ||
| } | ||
|
|
||
| dependencies { | ||
| runtimeOnly(project(":core:identity-hub-did")) | ||
| runtimeOnly(project(":core:identity-hub-core")) | ||
| runtimeOnly(project(":core:identity-hub-participants")) | ||
| runtimeOnly(project(":core:identity-hub-keypairs")) | ||
| runtimeOnly(project(":extensions:did:local-did-publisher")) | ||
| // API modules | ||
| runtimeOnly(project(":extensions:protocols:dcp:issuer-api")) | ||
|
|
||
| runtimeOnly(project(":extensions:sts:sts-account-provisioner")) | ||
| runtimeOnly(libs.edc.identity.did.core) | ||
| runtimeOnly(libs.edc.core.token) | ||
| runtimeOnly(libs.edc.api.version) | ||
| runtimeOnly(libs.edc.transaction.local) // needed by the PresentationCreatorRegistry | ||
|
|
||
| runtimeOnly(libs.edc.identity.did.web) | ||
| runtimeOnly(libs.bundles.connector) | ||
| } | ||
|
|
||
| edcBuild { | ||
|
|
||
| } |
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,27 @@ | ||
| /* | ||
| * Copyright (c) 2025 Cofinity-X | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Apache License, Version 2.0 which is available at | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * Contributors: | ||
| * Cofinity-X - initial API and implementation | ||
| * | ||
| */ | ||
|
|
||
|
|
||
| plugins { | ||
| `java-library` | ||
| } | ||
|
|
||
| dependencies { | ||
| runtimeOnly(project(":dist:bom:issuerservice-base-bom")) | ||
| runtimeOnly(project(":extensions:sts:sts-account-service-remote")) | ||
| } | ||
|
|
||
| edcBuild { | ||
|
|
||
| } |
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,39 @@ | ||
| /* | ||
| * Copyright (c) 2025 Cofinity-X | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Apache License, Version 2.0 which is available at | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * Contributors: | ||
| * Cofinity-X - initial API and implementation | ||
| * | ||
| */ | ||
|
|
||
|
|
||
| plugins { | ||
| `java-library` | ||
| } | ||
|
|
||
| dependencies { | ||
| // sql modules | ||
| api(project(":extensions:store:sql:identity-hub-credentials-store-sql")) | ||
| api(project(":extensions:store:sql:identity-hub-did-store-sql")) | ||
| api(project(":extensions:store:sql:identity-hub-keypair-store-sql")) | ||
| api(project(":extensions:store:sql:identity-hub-participantcontext-store-sql")) | ||
|
|
||
| api(libs.edc.sql.core) | ||
| api(libs.edc.transaction.local) | ||
| api(libs.edc.sql.pool) | ||
| api(libs.edc.sql.bootstrapper) | ||
| api(libs.edc.sql.jtivdalidation) | ||
|
|
||
| // third-party deps | ||
| api(libs.postgres) | ||
| } | ||
|
|
||
| edcBuild { | ||
|
|
||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| /* | ||
| * Copyright (c) 2025 Cofinity-X | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Apache License, Version 2.0 which is available at | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * Contributors: | ||
| * Cofinity-X - initial API and implementation | ||
| * | ||
| */ | ||
|
|
||
|
|
||
| plugins { | ||
| `java-library` | ||
| `maven-publish` | ||
| id("io.swagger.core.v3.swagger-gradle-plugin") | ||
| } | ||
|
|
||
| dependencies { | ||
| api(project(":spi:identity-hub-spi")) | ||
| api(project(":spi:verifiable-credential-spi")) | ||
| api(libs.edc.spi.jsonld) | ||
| api(libs.edc.spi.jwt) | ||
| api(libs.edc.spi.core) | ||
| implementation(libs.edc.spi.web) | ||
| implementation(libs.edc.spi.dcp) | ||
| implementation(libs.edc.lib.jerseyproviders) | ||
| implementation(libs.edc.lib.transform) | ||
| implementation(libs.edc.dcp.transform) | ||
| implementation(libs.jakarta.rsApi) | ||
| testImplementation(libs.edc.junit) | ||
| testImplementation(libs.edc.jsonld) | ||
| testImplementation(testFixtures(libs.edc.core.jersey)) | ||
| testImplementation(testFixtures(project(":spi:verifiable-credential-spi"))) | ||
| testImplementation(libs.nimbus.jwt) | ||
| } | ||
|
|
||
| edcBuild { | ||
| swagger { | ||
| apiGroup.set("issuer-api") | ||
| } | ||
| } |
95 changes: 95 additions & 0 deletions
95
...pi/src/main/java/org/eclipse/edc/identityhub/protocols/dcp/issuer/IssuerApiExtension.java
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,95 @@ | ||
| /* | ||
| * Copyright (c) 2025 Cofinity-X | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Apache License, Version 2.0 which is available at | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * Contributors: | ||
| * Cofinity-X - initial API and implementation | ||
| * | ||
| */ | ||
|
|
||
| package org.eclipse.edc.identityhub.protocols.dcp.issuer; | ||
|
|
||
| import com.fasterxml.jackson.databind.DeserializationFeature; | ||
| import org.eclipse.edc.identityhub.protocols.dcp.issuer.api.v1alpha.credentialrequest.CredentialRequestApiController; | ||
| import org.eclipse.edc.identityhub.protocols.dcp.issuer.api.v1alpha.credentialrequeststatus.CredentialRequestStatusApiController; | ||
| import org.eclipse.edc.identityhub.protocols.dcp.issuer.api.v1alpha.issuermetadata.IssuerMetadataApiController; | ||
| import org.eclipse.edc.runtime.metamodel.annotation.Configuration; | ||
| import org.eclipse.edc.runtime.metamodel.annotation.Extension; | ||
| import org.eclipse.edc.runtime.metamodel.annotation.Inject; | ||
| import org.eclipse.edc.runtime.metamodel.annotation.Setting; | ||
| import org.eclipse.edc.runtime.metamodel.annotation.Settings; | ||
| import org.eclipse.edc.spi.EdcException; | ||
| import org.eclipse.edc.spi.system.ServiceExtension; | ||
| import org.eclipse.edc.spi.system.ServiceExtensionContext; | ||
| import org.eclipse.edc.spi.system.apiversion.ApiVersionService; | ||
| import org.eclipse.edc.spi.system.apiversion.VersionRecord; | ||
| import org.eclipse.edc.spi.types.TypeManager; | ||
| import org.eclipse.edc.web.spi.WebService; | ||
| import org.eclipse.edc.web.spi.configuration.PortMapping; | ||
| import org.eclipse.edc.web.spi.configuration.PortMappingRegistry; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.stream.Stream; | ||
|
|
||
| import static org.eclipse.edc.identityhub.protocols.dcp.issuer.IssuerApiExtension.NAME; | ||
| import static org.eclipse.edc.identityhub.spi.webcontext.IdentityHubApiContext.ISSUER_API; | ||
|
|
||
| @Extension(value = NAME) | ||
| public class IssuerApiExtension implements ServiceExtension { | ||
| public static final String NAME = "Issuer API extension"; | ||
|
|
||
| private static final String API_VERSION_JSON_FILE = "issuer-api-version.json"; | ||
|
|
||
| @Inject | ||
| private TypeManager typeManager; | ||
| @Inject | ||
| private ApiVersionService apiVersionService; | ||
| @Inject | ||
| private WebService webService; | ||
| @Inject | ||
| private PortMappingRegistry portMappingRegistry; | ||
|
|
||
| @Configuration | ||
| private CredentialRequestApiConfiguration apiConfiguration; | ||
|
|
||
| @Override | ||
| public void initialize(ServiceExtensionContext context) { | ||
|
|
||
| portMappingRegistry.register(new PortMapping(ISSUER_API, apiConfiguration.port(), apiConfiguration.path())); | ||
|
|
||
| webService.registerResource(ISSUER_API, new CredentialRequestApiController()); | ||
| webService.registerResource(ISSUER_API, new CredentialRequestStatusApiController()); | ||
| webService.registerResource(ISSUER_API, new IssuerMetadataApiController()); | ||
|
|
||
| registerVersionInfo(getClass().getClassLoader()); | ||
| } | ||
|
|
||
| private void registerVersionInfo(ClassLoader resourceClassLoader) { | ||
| try (var versionContent = resourceClassLoader.getResourceAsStream(API_VERSION_JSON_FILE)) { | ||
| if (versionContent == null) { | ||
| throw new EdcException("Version file '%s' not found or not readable.".formatted(API_VERSION_JSON_FILE)); | ||
| } | ||
| Stream.of(typeManager.getMapper() | ||
| .enable(DeserializationFeature.ACCEPT_SINGLE_VALUE_AS_ARRAY) | ||
| .readValue(versionContent, VersionRecord[].class)) | ||
| .forEach(vr -> apiVersionService.addRecord("issuer-api", vr)); | ||
| } catch (IOException e) { | ||
| throw new EdcException(e); | ||
| } | ||
| } | ||
|
|
||
| @Settings | ||
| record CredentialRequestApiConfiguration( | ||
| @Setting(key = "web.http." + ISSUER_API + ".port", description = "Port for " + ISSUER_API + " api context", defaultValue = 13132 + "") | ||
| int port, | ||
| @Setting(key = "web.http." + ISSUER_API + ".path", description = "Path for " + ISSUER_API + " api context", defaultValue = "/api/issuer") | ||
| String path | ||
| ) { | ||
|
|
||
| } | ||
| } |
36 changes: 36 additions & 0 deletions
36
...src/main/java/org/eclipse/edc/identityhub/protocols/dcp/issuer/api/v1alpha/ApiSchema.java
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,36 @@ | ||
| /* | ||
| * Copyright (c) 2025 Cofinity-X | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Apache License, Version 2.0 which is available at | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * Contributors: | ||
| * Cofinity-X - initial API and implementation | ||
| * | ||
| */ | ||
|
|
||
| package org.eclipse.edc.identityhub.protocols.dcp.issuer.api.v1alpha; | ||
|
|
||
| import io.swagger.v3.oas.annotations.media.Schema; | ||
|
|
||
| public interface ApiSchema { | ||
| @Schema(name = "ApiErrorDetail", example = ApiErrorDetailSchema.API_ERROR_EXAMPLE) | ||
| record ApiErrorDetailSchema( | ||
| String message, | ||
| String type, | ||
| String path, | ||
| String invalidValue | ||
| ) { | ||
| public static final String API_ERROR_EXAMPLE = """ | ||
| { | ||
| "message": "error message", | ||
| "type": "ErrorType", | ||
| "path": "object.error.path", | ||
| "invalidValue": "this value is not valid" | ||
| } | ||
| """; | ||
| } | ||
| } |
Oops, something went wrong.