Skip to content

Latest commit

 

History

History
89 lines (61 loc) · 3.72 KB

README.md

File metadata and controls

89 lines (61 loc) · 3.72 KB
Raw

CDOC2 Capsule Server

CDOC2 Capsule Server for CDOC2.

Implements cdoc2-key-capsule-openapi OpenAPI spec from cdoc2-openapi for Key Capsules upload/download. Used by cdoc2-java-ref-impl and DigiDoc4-Client for CDOC2 encryption/decryption server scenarios.

Structure

  • put-server - Implements /key-capsules POST API. TLS port, for uploading capsules (encryption).
  • get-server - Implements /key-capsules GET API. mTLS port, for downloading key capsules (decryption).
  • server-db - shared DB code. Liquibase based DB creation
  • server-common - shared common server code
  • server-openapi - server stub generation from OpenAPI specifications
  • cdoc2-shared-crypto - some shared crypto functions

Preconditions for building

  • Java 17
  • Maven 3.8.x
  • Docker available and running (required for running tests, use -Dmaven.test.skip=true to skip)

Maven dependencies

Depends on:

Configure github package repo access https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-with-a-personal-access-token

Example <profile> section of settings.xml for using cdoc2 dependencies:

  <profile>
      <id>github</id>
      <repositories>
        <repository>
          <id>central</id>
          <url>https://repo1.maven.org/maven2</url>
        </repository>
        <repository>
          <id>github</id>
          <url>https://maven.pkg.github.com/open-eid/cdoc2-java-ref-impl</url>
        </repository>
      </repositories>
  </profile>

Note: When pulling, the package index is based on the organization level, not the repository level. https://stackoverflow.com/questions/63041402/github-packages-single-maven-repository-for-github-organization

So defining single Maven package repo from open-eid is enough for pulling cdoc2-* dependencies.

Building & Running

Build cdoc2-capsule-server with CI

mvn clean install

GitHub workflow build

Maven build is executed for GH event pull_request an and push to 'master'.

GH build workflow configures Maven repository automatically. For fork based pull_requests Maven repo value will be set to github.event.pull_request.base.repo.full_name (open-eid/*). It can be overwritten by defining repository variable MAVEN_REPO

Running

See getting-started.md and admin-guide.md

Releasing and versioning

See VERSIONING.md

GitHub release

Create release on tag done by VERSIONING.md process. It will trigger maven-release.yml workflow that will deploy Maven packages to GitHub Maven package repository.

Related projects