{"id":42688784,"url":"https://github.com/open-eid/cdoc2-shares-server","last_synced_at":"2026-01-29T12:45:01.870Z","repository":{"id":264831484,"uuid":"881784854","full_name":"open-eid/cdoc2-shares-server","owner":"open-eid","description":"cdoc2 shares server","archived":false,"fork":false,"pushed_at":"2025-03-26T15:24:16.000Z","size":355,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-26T16:26:29.404Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/open-eid.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-01T08:14:40.000Z","updated_at":"2025-03-26T15:24:19.000Z","dependencies_parsed_at":"2025-01-06T12:30:24.430Z","dependency_job_id":"dcc057f6-1628-46c4-a9ac-db881c08bcbd","html_url":"https://github.com/open-eid/cdoc2-shares-server","commit_stats":null,"previous_names":["open-eid/cdoc2-shares-server"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/open-eid/cdoc2-shares-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-eid%2Fcdoc2-shares-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-eid%2Fcdoc2-shares-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-eid%2Fcdoc2-shares-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-eid%2Fcdoc2-shares-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/open-eid","download_url":"https://codeload.github.com/open-eid/cdoc2-shares-server/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-eid%2Fcdoc2-shares-server/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28877877,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-29T10:31:27.438Z","status":"ssl_error","status_checked_at":"2026-01-29T10:31:01.017Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-29T12:45:01.123Z","updated_at":"2026-01-29T12:45:01.861Z","avatar_url":"https://github.com/open-eid.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CDOC2 Key Shares Server\n\nCDOC2 Key Shares Server for [CDOC2](https://open-eid.github.io/CDOC2/). \n\nImplements `cdoc2-key-shares-openapi` [OpenAPI spec](https://github.com/open-eid/cdoc2-openapi/blob/master/cdoc2-key-shares-openapi.yaml) from [cdoc2-openapi](https://github.com/open-eid/cdoc2-openapi/)\nfor Key Shares upload/download. Used by [cdoc2-java-ref-impl](https://github.com/open-eid/cdoc2-java-ref-impl) \nand [DigiDoc4-Client](https://github.com/open-eid/DigiDoc4-Client) for CDOC2 encryption/decryption Smart-ID/Mobile-ID scenarios.\n\n## Structure\n\n  - shares-server       - Implements `/key-shares` API-s. \n  - server-db           - shared DB code. Liquibase based DB creation\n  - server-openapi      - server stub generation from OpenAPI specifications\n\n\n## Preconditions for building\n* Java 17\n* Maven 3.8.x\n* Docker available and running (required for running tests, use `-Dmaven.test.skip=true` to skip)\n\n## Maven dependencies\n\nDepends on:\n* https://github.com/open-eid/cdoc2-openapi OpenAPI specifications for server stub generation\n* https://github.com/open-eid/cdoc2-java-ref-impl (for unit tests only, use `-Dmaven.test.skip=true` to skip)\n\nConfigure github package repo access\nhttps://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-with-a-personal-access-token\n\nExample `\u003cprofile\u003e` section of `settings.xml` for using cdoc2 dependencies:\n```xml\n  \u003cprofile\u003e\n      \u003cid\u003egithub\u003c/id\u003e\n      \u003crepositories\u003e\n        \u003crepository\u003e\n          \u003cid\u003ecentral\u003c/id\u003e\n          \u003curl\u003ehttps://repo1.maven.org/maven2\u003c/url\u003e\n        \u003c/repository\u003e\n        \u003crepository\u003e\n          \u003cid\u003egithub\u003c/id\u003e\n          \u003curl\u003ehttps://maven.pkg.github.com/open-eid/cdoc2-java-ref-impl\u003c/url\u003e\n        \u003c/repository\u003e\n      \u003c/repositories\u003e\n  \u003c/profile\u003e\n```\n\nNote: When pulling, the package index is based on the organization level, not the repository level.\nhttps://stackoverflow.com/questions/63041402/github-packages-single-maven-repository-for-github-organization\n\nSo defining single Maven package repo from `open-eid` is enough for pulling cdoc2-* dependencies.\n\n## Building \u0026 Running\n\n[![Build cdoc2-shares-server with CI](https://github.com/open-eid/cdoc2-shares-server/actions/workflows/maven.yml/badge.svg)](https://github.com/open-eid/cdoc2-shares-server/actions/workflows/maven.yml)\n\n```bash\nmvn clean install\n```\n\nTo build Docker images:\n```bash\n./build-images.sh\n```\n```\n[INFO] Successfully built image 'ghcr.io/open-eid/cdoc2-shares-server:0.4.1-SNAPSHOT'\n[INFO] Successfully created image tag 'ghcr.io/open-eid/cdoc2-shares-server:latest'\n```\n\n### GitHub workflow build\n\nMaven build is executed for GH event `pull_request` an and `push` to 'master'.\n\nGH build workflow configures Maven repository automatically. For fork based pull_requests\nMaven repo value will be set to `github.event.pull_request.base.repo.full_name` (`open-eid/*`). It can be overwritten\nby [defining repository variable](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/variables#creating-configuration-variables-for-a-repository)\n`MAVEN_REPO`\n\n\n### Running\n\nSee [getting-started.md](getting-started.md) and  [admin-guide.md](admin-guide.md)\n\n### Running pre-built Docker/OCI images\n\nPre-built images can be found \u003chttps://github.com/orgs/open-eid/packages?ecosystem=container\u003e\n\nQuickstart:\n```bash\ndocker compose up -d\ncurl -k https://localhost:18443/actuator/info\necho \"Run 'docker compose down' to shut down 'cdoc2-shares-server'\"\n```\n\n```bash\ncurl -i -k -X POST https://localhost:8443/key-shares \\\n-H 'Content-Type: application/json' \\\n-H 'Accept: application/json' \\\n-d '{\"share\":\"dGVzdHRlc3R0ZXN0dGVzdHRlc3R0ZXN0dGVzdHRlc3QK\",\"recipient\":\"etsi/PNOEE-30303039914\"}'\n```\n```\nHTTP/1.1 201 \nLocation: /key-shares/ee368ad654142dda1d9d8e00744df2c8\n```\n\nFor more info see [admin-guide.md](admin-guide.md) and other existing configurations:\n\n* [cdoc2-java-ref-impl/test/config/shares-server/docker-compose.yml](https://github.com/open-eid/cdoc2-java-ref-impl/blob/master/test/config/shares-server/docker-compose.yml)\n* [cdoc2-gatling-tests/cdoc2-shares-server/setup-load-testing](https://github.com/open-eid/cdoc2-gatling-tests/tree/master/cdoc2-shares-server/setup-load-testing)\n\nFor end-to-end tests see\n[cdoc2-java-ref-impl/test/bats/README.md](https://github.com/open-eid/cdoc2-java-ref-impl/tree/master/test#running-smart-idmobile-id-tests-experimental)\n\n### GitHub release\n\n[Create release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release). Tag name is used as built image version, so it should start with shares-server version \nfrom [shares-server/pom.xml](shares-server/pom.xml).\nIt will trigger [`maven-release.yml`](.github/workflows/maven-release.yml) workflow that will deploy Maven packages to GitHub Maven package repository\nand build \u0026 publish Docker/OCI images. Docker images are published to \u003chttps://github.com/orgs/open-eid/packages?ecosystem=container\u003e\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-eid%2Fcdoc2-shares-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopen-eid%2Fcdoc2-shares-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-eid%2Fcdoc2-shares-server/lists"}