Merge branch 'RM-3344_key-capsule-expiry-configuration' into 'master'

RM-3344: Add key capsule expiry time parameter to open API client

See merge request cdoc2/cdoc2-java-ref-impl!18

Author: OlesjaAarma

cdoc2-cli/pom.xml

@@ -4,10 +4,11 @@
     <parent>
         <artifactId>cdoc2</artifactId>
         <groupId>ee.cyber.cdoc2</groupId>
-        <version>1.2.0</version>
+        <version>1.3.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>cdoc2-cli</artifactId>
+    <version>1.2.0</version>
     <description>Command line utility to create/process CDOC2 files</description>
 
     <properties>
@@ -41,7 +42,7 @@
         <dependency>
             <groupId>ee.cyber.cdoc2</groupId>
             <artifactId>cdoc2-lib</artifactId>
-            <version>1.2.0</version>
+            <version>1.3.0-SNAPSHOT</version>
         </dependency>
     </dependencies>
 

cdoc2-client/pom.xml

@@ -4,11 +4,11 @@
     <parent>
         <artifactId>cdoc2</artifactId>
         <groupId>ee.cyber.cdoc2</groupId>
-        <version>1.2.0</version>
+        <version>1.3.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>cdoc2-client</artifactId>
-    <version>1.3.0</version>
+    <version>1.4.0-SNAPSHOT</version>
     <description>CDOC2 server client generation from openapi specification</description>
 
     <properties>
@@ -19,7 +19,7 @@
 
         <spotbugs-annotations.version>4.7.3</spotbugs-annotations.version>
         <!--info.version from cdoc2-openapi/cdoc2-key-capsules-openapi.yaml -->
-        <cdoc2-key-capsules-openapi.version>2.0.0</cdoc2-key-capsules-openapi.version>
+        <cdoc2-key-capsules-openapi.version>2.1.0-SNAPSHOT</cdoc2-key-capsules-openapi.version>
         <maven.repository.url>gitlab.ext.cyber.ee::::https://gitlab.ext.cyber.ee/api/v4/projects/39/packages/maven</maven.repository.url>
     </properties>
 
@@ -178,6 +178,7 @@
                                     <outputDirectory>${project.build.directory}/openapi</outputDirectory>
                                 </artifactItem>
                             </artifactItems>
+                            <useBaseVersion>true</useBaseVersion>
                         </configuration>
                     </execution>
                 </executions>
@@ -218,7 +219,7 @@
                         <dateLibrary>java8</dateLibrary>
                         <enumUnknownDefaultCase>true</enumUnknownDefaultCase>
                         <oas3>true</oas3>
-                        <useOptional>true</useOptional>
+                        <useOptional>false</useOptional>
                         <bigDecimalAsString>true</bigDecimalAsString>
                         <legacyDiscriminatorBehavior>false</legacyDiscriminatorBehavior>
                     </configOptions>

cdoc2-client/src/main/java/ee/cyber/cdoc2/client/Cdoc2KeyCapsuleApiClient.java

@@ -13,6 +13,7 @@
 import java.security.KeyStoreException;
 import java.security.NoSuchAlgorithmException;
 import java.security.SecureRandom;
+import java.time.OffsetDateTime;
 import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
@@ -26,11 +27,13 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+
 /**
  * Client for creating and getting CDOC2 key capsules from key server. Provides Builder to initialize mutual TLS
  * from PKCS11 (smart-card) or PKCS12 (software) key stores.
  */
 public final class Cdoc2KeyCapsuleApiClient {
+
     private static final Logger log = LoggerFactory.getLogger(Cdoc2KeyCapsuleApiClient.class);
 
     public static final int DEFAULT_CONNECT_TIMEOUT_MS = 1000;
@@ -76,7 +79,7 @@ private Builder() {
         /**
          * Init server base url
          * @param url server base url, example https://host:8443
-         * @return
+         * @return client builder
          */
         public Builder withBaseUrl(String url) {
             this.baseUrl = url;
@@ -86,7 +89,7 @@ public Builder withBaseUrl(String url) {
         /**
          * Client keystore used for mutual TLS
          * @param clientKS client key store containing client keys for mutual TLS or null, if mTLS is not used
-         * @return
+         * @return client builder
          */
         public Builder withClientKeyStore(@Nullable KeyStore clientKS) {
             this.clientKeyStore = clientKS;
@@ -111,7 +114,7 @@ public Builder withClientKeyStoreProtectionParameter(KeyStore.ProtectionParamete
          *                     "passwd".toCharArray());
          *</code>
          * @param trustKS initialized trusted key store to be used by TLS
-         * @return
+         * @return client builder
          */
         public Builder withTrustKeyStore(KeyStore trustKS) {
             this.trustKeyStore = trustKS;
@@ -172,7 +175,7 @@ protected void customizeClientBuilder(ClientBuilder clientBuilder) {
 
             apiClient.setDebugging(debug);
             apiClient.addDefaultHeader("Accept", "application/json");
-            apiClient.selectHeaderAccept(new String[]{"application/json"});
+            apiClient.selectHeaderAccept("application/json");
 
             apiClient.setUserAgent(userAgent);
 
@@ -226,11 +229,21 @@ public static Builder builder() {
     }
 
     /**
-     * @param capsule
+     * @param capsule key capsule
      * @return transactionId
-     * @throws ApiException
+     * @throws ApiException if capsule creation has failed
      */
     public String createCapsule(Capsule capsule) throws ApiException {
+        return createCapsule(capsule, null);
+    }
+
+    /**
+     * @param capsule key capsule
+     * @param xExpiryTime capsule expiry time (optional)
+     * @return transactionId
+     * @throws ApiException if capsule creation has failed
+     */
+    public String createCapsule(Capsule capsule, @Nullable OffsetDateTime xExpiryTime) throws ApiException {
 
         Objects.requireNonNull(capsule);
         Objects.requireNonNull(capsule.getCapsuleType());
@@ -240,7 +253,7 @@ public String createCapsule(Capsule capsule) throws ApiException {
         Objects.requireNonNull(capsule.getRecipientId());
         Objects.requireNonNull(capsule.getEphemeralKeyMaterial());
 
-        ApiResponse<Void> response = capsulesApi.createCapsuleWithHttpInfo(capsule);
+        ApiResponse<Void> response = capsulesApi.createCapsuleWithHttpInfo(capsule, xExpiryTime);
         String locationHeaderValue = null;
         if (response.getStatusCode() == 201
                 && response.getHeaders() != null
@@ -267,17 +280,16 @@ public String createCapsule(Capsule capsule) throws ApiException {
     }
 
     /**
-     *
-     * @param id
+     * @param transactionId transaction ID
      * @return Optional with value, if server returned 200 or empty Optional if 404
      * @throws ApiException if http response code is something else that 200 or 404
      */
-    public Optional<Capsule> getCapsule(String id) throws ApiException {
-        if (id == null) {
+    public Optional<Capsule> getCapsule(String transactionId) throws ApiException {
+        if (transactionId == null) {
             throw new IllegalArgumentException("transactionId cannot be null");
         }
 
-        ApiResponse<Capsule> response = capsulesApi.getCapsuleByTransactionIdWithHttpInfo(id);
+        ApiResponse<Capsule> response = capsulesApi.getCapsuleByTransactionIdWithHttpInfo(transactionId);
 
         switch (response.getStatusCode()) {
             case 200:

cdoc2-lib/pom.xml

@@ -3,11 +3,12 @@
     <parent>
         <artifactId>cdoc2</artifactId>
         <groupId>ee.cyber.cdoc2</groupId>
-        <version>1.2.0</version>
+        <version>1.3.0-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
     <artifactId>cdoc2-lib</artifactId>
+    <version>1.3.0-SNAPSHOT</version>
     <description>CDOC2 creation and processing library</description>
 
     <properties>
@@ -25,7 +26,7 @@
         <dependency>
             <groupId>ee.cyber.cdoc2</groupId>
             <artifactId>cdoc2-client</artifactId>
-            <version>1.3.0</version>
+            <version>1.4.0-SNAPSHOT</version>
         </dependency>
 
         <dependency>

cdoc2-lib/src/main/java/ee/cyber/cdoc2/client/EcCapsuleClientImpl.java

@@ -47,7 +47,7 @@ public String storeSenderKey(ECPublicKey receiverKey, ECPublicKey senderKey) thr
                 .recipientId(ECKeys.encodeEcPubKeyForTls(curve, receiverKey))
                 .ephemeralKeyMaterial(ECKeys.encodeEcPubKeyForTls(curve, senderKey));
 
-        return keyCapsulesClient.storeCapsule(capsule);
+        return keyCapsulesClient.storeCapsule(capsule, null);
     }
 
     @Override

cdoc2-lib/src/main/java/ee/cyber/cdoc2/client/KeyCapsuleClient.java

@@ -1,14 +1,22 @@
 package ee.cyber.cdoc2.client;
 
+import jakarta.annotation.Nullable;
+
 import ee.cyber.cdoc2.client.model.Capsule;
+
+import java.time.OffsetDateTime;
 import java.util.Optional;
 
+
 /**
  * Generic capsule client
  */
 public interface KeyCapsuleClient extends ServerClient {
 
     String storeCapsule(Capsule capsule) throws ExtApiException;
 
+    String storeCapsule(Capsule capsule, @Nullable OffsetDateTime xExpiryTime) throws ExtApiException;
+
     Optional<Capsule> getCapsule(String id) throws ExtApiException;
+
 }