Rm-5752: add x-expiry-time to POST response

jann0k · jann0k · commit cb897a7af271 · 2025-06-11T12:01:04.000+03:00
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -10,10 +10,11 @@ variables:
   tags:
     - dind
   rules:
-    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
-      when: on_success
-    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
-      when: on_success
+# TODO: Building from Dockerfile is deprecated, use buildpacks instead, see build-images.sh
+#    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+#      when: on_success
+#    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+#      when: on_success
     - when: never
   script:
     - |
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,16 @@
 # Changelog
 
+## [1.5.0] Add `x-expiry-time` header to `POST /key-capsules/{transactionId}` response (2025-06-09)
+
+### Features
+* Add `x-expiry-time` header to `POST` `/key-capsules/{transactionId}` result as specified in [cdoc2-key-capsules 2.2.0 OAS](https://github.com/open-eid/cdoc2-openapi)
+
+### Internal
+* Use `spring-boot-dependencies` BOM for `cdoc2-server` parent POM for easier version alignment with `cdoc2-put-server` and `cdoc2-get-server` that use `spring-boot-starter-parent` parent 
+* Update `spring-boot` version `3.4.3` -> `3.5.0`
+* Update `org.bouncycastle:bcpkix-jdk18on` version `1.80` -> `1.81`
+
+
 ## [1.4.2] Return `x-expiry-time` header to `GET /key-capsules/{transactionId}` (2025-03-27)
 
 ### Bugfixes
diff --git a/cdoc2-shared-crypto/pom.xml b/cdoc2-shared-crypto/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>ee.cyber.cdoc2</groupId>
     <artifactId>cdoc2-shared-crypto</artifactId>
-    <version>0.2.1</version>
+    <version>0.2.2</version>
     <description>CDOC2 common crypto functions shared between lib and server</description>
     <packaging>jar</packaging>
 
@@ -16,8 +16,8 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 
 
-        <bouncycastle.version>1.80</bouncycastle.version>
-        <logback.version>1.5.16</logback.version>
+        <bouncycastle.version>1.81</bouncycastle.version>
+        <logback.version>1.5.18</logback.version>
     </properties>
 
     <profiles>
diff --git a/get-server/pom.xml b/get-server/pom.xml
@@ -5,13 +5,13 @@
 	<parent>
 		<groupId>org.springframework.boot</groupId>
 		<artifactId>spring-boot-starter-parent</artifactId>
-		<version>3.4.3</version>
+		<version>3.5.0</version>
 		<relativePath /> <!-- lookup parent from repository -->
 	</parent>
 
 	<artifactId>cdoc2-get-server</artifactId>
 	<groupId>ee.cyber.cdoc2</groupId>
-	<version>1.4.2</version>
+	<version>1.5.0</version>
 	<packaging>jar</packaging>
 
 	<name>cdoc2-get-server</name>
@@ -24,11 +24,7 @@
 
 		<tests>!(pkcs11 | slow)</tests>
 
-		<spring-boot.version>3.4.3</spring-boot.version>
-		<org-testcontainers.version>1.20.6</org-testcontainers.version>
-        <micrometer.version>1.14.4</micrometer.version>
-    	<!-- https://docs.spring.io/spring-boot/appendix/dependency-versions/coordinates.html-->
-		<logback.version>1.5.16</logback.version>
+		<spring-boot.version>3.5.0</spring-boot.version>
 	</properties>
 
 	<profiles>
@@ -74,7 +70,7 @@
 				<dependency>
 					<groupId>ee.cyber.cdoc2</groupId>
 					<artifactId>cdoc2-common-server</artifactId>
-					<version>2.2.0</version>
+					<version>2.2.1</version>
 					<type>test-jar</type>
 					<scope>test</scope>
 				</dependency>
@@ -200,19 +196,19 @@
 		<dependency>
 			<groupId>ee.cyber.cdoc2</groupId>
 			<artifactId>cdoc2-common-server</artifactId>
-			<version>2.2.0</version>
+			<version>2.2.1</version>
 		</dependency>
 
 		<dependency>
 			<groupId>ee.cyber.cdoc2</groupId>
 			<artifactId>cdoc2-server-db</artifactId>
-			<version>2.2.1</version>
+			<version>2.2.2</version>
 		</dependency>
 
 		<dependency>
 			<groupId>ee.cyber.cdoc2</groupId>
 			<artifactId>cdoc2-server-openapi</artifactId>
-			<version>0.1.1</version>
+			<version>0.2.0</version>
 		</dependency>
 
 		<dependency>
@@ -239,32 +235,27 @@
 		<dependency>
 			<groupId>io.micrometer</groupId>
 			<artifactId>micrometer-registry-prometheus</artifactId>
-			<version>${micrometer.version}</version>
 			<scope>runtime</scope>
 		</dependency>
 
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-test</artifactId>
-			<version>${spring-boot.version}</version>
 			<scope>test</scope>
 		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-test</artifactId>
-			<version>${spring-boot.version}</version>
 			<scope>test</scope>
 		</dependency>
 		<dependency>
 			<groupId>org.testcontainers</groupId>
 			<artifactId>junit-jupiter</artifactId>
-			<version>${org-testcontainers.version}</version>
 			<scope>test</scope>
 		</dependency>
 		<dependency>
 			<groupId>org.testcontainers</groupId>
 			<artifactId>postgresql</artifactId>
-			<version>${org-testcontainers.version}</version>
 			<scope>test</scope>
 		</dependency>
 		<dependency>
@@ -276,7 +267,6 @@
 		<dependency>
 			<groupId>org.apache.httpcomponents.client5</groupId>
 			<artifactId>httpclient5</artifactId>
-			<version>5.4.2</version>
 			<scope>test</scope>
 		</dependency>
     </dependencies>
diff --git a/pom.xml b/pom.xml
@@ -4,7 +4,7 @@
 
 	<artifactId>cdoc2-server</artifactId>
 	<groupId>ee.cyber.cdoc2</groupId>
-	<version>1.4.1</version>
+	<version>1.4.2</version>
 
 	<description>CDOC2 server pom</description>
 
@@ -32,14 +32,18 @@
 		<!-- ldap test require connection to external esteid.ldap.sk.ee server -->
 		<tests>!(pkcs11 | slow | ldap)</tests>
 
-		<!-- versions of dependencies has to correspond with spring boot version-->
-		<!-- https://docs.spring.io/spring-boot/docs/current/reference/html/dependency-versions.html-->
-		<junit-jupiter.version>5.11.4</junit-jupiter.version>
-		<lombok.version>1.18.36</lombok.version>
-		<logback-classic.version>1.5.16</logback-classic.version>
+		<junit-jupiter.version>5.12.2</junit-jupiter.version>
+
+		<!-- versions for spring-boot dependencies are defined here: -->
+		<!-- https://docs.spring.io/spring-boot/appendix/dependency-versions/coordinates.html -->
+		<spring-boot.version>3.5.0</spring-boot.version>
+
+		<!-- to override spring-boot dependency version, find its name from
+		    https://docs.spring.io/spring-boot/appendix/dependency-versions/properties.html
+		-->
+
+
 		<exec-maven-plugin.version>3.4.10</exec-maven-plugin.version>
-		<spring-boot.version>3.4.3</spring-boot.version>
-		<spring.version>6.2.3</spring.version>
 
   	</properties>
 
@@ -160,9 +164,21 @@
 				<type>pom</type>
 				<scope>import</scope>
 			</dependency>
+
+			<!-- For dependencies, use versions from  spring-boot-dependencies BOM
+
+			 https://docs.spring.io/spring-boot/appendix/dependency-versions/coordinates.html -->
+			<dependency>
+				<groupId>org.springframework.boot</groupId>
+				<artifactId>spring-boot-dependencies</artifactId>
+				<version>${spring-boot.version}</version>
+				<type>pom</type>
+				<scope>import</scope>
+			</dependency>
 		</dependencies>
 	</dependencyManagement>
 
+
 	<repositories>
 	<!-- configure repositories in settings.xml -->
 	<!--
diff --git a/put-server/pom.xml b/put-server/pom.xml
@@ -5,13 +5,13 @@
 	<parent>
 		<groupId>org.springframework.boot</groupId>
 		<artifactId>spring-boot-starter-parent</artifactId>
-		<version>3.4.3</version>
+		<version>3.5.0</version>
 		<relativePath /> <!-- lookup parent from repository -->
 	</parent>
 
 	<artifactId>cdoc2-put-server</artifactId>
 	<groupId>ee.cyber.cdoc2</groupId>
-	<version>1.4.2</version>
+	<version>1.5.0</version>
 	<packaging>jar</packaging>
 
 	<name>cdoc2-put-server</name>
@@ -24,11 +24,8 @@
 
 		<tests>!(pkcs11 | slow)</tests>
 
-		<spring-boot.version>3.4.3</spring-boot.version>
-		<org-testcontainers.version>1.20.6</org-testcontainers.version>
-		<micrometer.version>1.14.4</micrometer.version>
+		<spring-boot.version>3.5.0</spring-boot.version>
 		<!-- https://docs.spring.io/spring-boot/appendix/dependency-versions/coordinates.html-->
-		<logback.version>1.5.16</logback.version>
 	</properties>
 
 	<profiles>
@@ -75,7 +72,7 @@
 				<dependency>
 					<groupId>ee.cyber.cdoc2</groupId>
 					<artifactId>cdoc2-common-server</artifactId>
-					<version>2.2.0</version>
+					<version>2.2.1</version>
 					<type>test-jar</type>
 					<scope>test</scope>
 				</dependency>
@@ -201,26 +198,25 @@
 		<dependency>
 			<groupId>ee.cyber.cdoc2</groupId>
 			<artifactId>cdoc2-server-openapi</artifactId>
-			<version>0.1.1</version>
+			<version>0.2.0</version>
 		</dependency>
 
 
 		<dependency>
 			<groupId>ee.cyber.cdoc2</groupId>
 			<artifactId>cdoc2-common-server</artifactId>
-			<version>2.2.0</version>
+			<version>2.2.1</version>
 		</dependency>
 
 		<dependency>
 			<groupId>ee.cyber.cdoc2</groupId>
 			<artifactId>cdoc2-server-db</artifactId>
-			<version>2.2.1</version>
+			<version>2.2.2</version>
 		</dependency>
 
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter</artifactId>
-			<version>${spring-boot.version}</version>
 		</dependency>
 
 		<!--
@@ -241,32 +237,27 @@
 		<dependency>
 			<groupId>io.micrometer</groupId>
 			<artifactId>micrometer-registry-prometheus</artifactId>
-			<version>${micrometer.version}</version>
 			<scope>runtime</scope>
 		</dependency>
 
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-test</artifactId>
-			<version>${spring-boot.version}</version>
 			<scope>test</scope>
 		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-test</artifactId>
-			<version>${spring-boot.version}</version>
 			<scope>test</scope>
 		</dependency>
 		<dependency>
 			<groupId>org.testcontainers</groupId>
 			<artifactId>junit-jupiter</artifactId>
-			<version>${org-testcontainers.version}</version>
 			<scope>test</scope>
 		</dependency>
 		<dependency>
 			<groupId>org.testcontainers</groupId>
 			<artifactId>postgresql</artifactId>
-			<version>${org-testcontainers.version}</version>
 			<scope>test</scope>
 		</dependency>
 		<dependency>
@@ -278,7 +269,6 @@
 		<dependency>
 			<groupId>org.apache.httpcomponents.client5</groupId>
 			<artifactId>httpclient5</artifactId>
-			<version>5.4.2</version>
 			<scope>test</scope>
 		</dependency>
 
diff --git a/put-server/src/main/java/ee/cyber/cdoc2/server/api/CreateKeyCapsuleApi.java b/put-server/src/main/java/ee/cyber/cdoc2/server/api/CreateKeyCapsuleApi.java
@@ -1,5 +1,6 @@
 package ee.cyber.cdoc2.server.api;
 
+import ee.cyber.cdoc2.server.Constants;
 import ee.cyber.cdoc2.server.config.KeyCapsuleConfigProperties;
 import ee.cyber.cdoc2.server.generated.model.Capsule;
 import ee.cyber.cdoc2.server.generated.api.KeyCapsulesApi;
@@ -12,6 +13,7 @@
 import java.time.LocalDateTime;
 import java.time.OffsetDateTime;
 import java.time.ZoneOffset;
+import java.time.format.DateTimeFormatter;
 import java.util.Base64;
 import java.util.Optional;
 
@@ -78,7 +80,10 @@ public ResponseEntity<Void> createCapsule(
 
             URI created = getResourceLocation(saved.getTransactionId());
 
-            return ResponseEntity.created(created).build();
+            return ResponseEntity
+                .created(created)
+                .header(Constants.X_EXPIRY_TIME_HEADER, DateTimeFormatter.ISO_INSTANT.format(saved.getExpiryTime()))
+                .build();
         } catch (Exception e) {
             log.error(
                 "Failed to save key capsule(type={}, recipient={}, payloadLength={})",
diff --git a/put-server/src/test/java/ee/cyber/cdoc2/server/CreateKeyCapsuleApiTest.java b/put-server/src/test/java/ee/cyber/cdoc2/server/CreateKeyCapsuleApiTest.java
@@ -9,10 +9,12 @@
 import java.time.Instant;
 import java.time.LocalDateTime;
 import java.time.ZoneOffset;
+import java.time.format.DateTimeFormatter;
 import java.time.temporal.ChronoUnit;
 import java.util.Optional;
 import java.util.UUID;
 
+import lombok.extern.slf4j.Slf4j;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
@@ -33,7 +35,7 @@
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
-
+@Slf4j
 class CreateKeyCapsuleApiTest extends KeyCapsuleIntegrationTest {
 
     @Autowired
@@ -142,6 +144,11 @@ private void assertCapsuleCreateRequestIsSuccessful(
         ResponseEntity<Void> response
             = api.createCapsule(rsaCapsule, requestExpiryTime);
         assertEquals(HttpStatus.CREATED, response.getStatusCode());
+        assertTrue(response.getHeaders().containsKey(Constants.X_EXPIRY_TIME_HEADER));
+
+        log.debug("POST expiry-time {}", response.getHeaders().get(Constants.X_EXPIRY_TIME_HEADER));
+        //no exception means that x-expiry-time is formatted correctly
+        DateTimeFormatter.ISO_INSTANT.parse(response.getHeaders().get(Constants.X_EXPIRY_TIME_HEADER).get(0));
     }
 
     private KeyCapsuleDb assertCapsuleCreatedInDb(Capsule capsule) {
diff --git a/server-common/pom.xml b/server-common/pom.xml
diff --git a/server-db/pom.xml b/server-db/pom.xml
diff --git a/server-openapi/pom.xml b/server-openapi/pom.xml
