Preparations for new release (#3)

Reworked handling of URI resources and SSLContext.
Improved compatibility with maven.
Upgraded Gradle to 7.3.

Author: NicklasWallgren

README.md

@@ -21,14 +21,14 @@ The artifact is available through Maven Central via Sonatype.
 <dependency>
     <groupId>dev.nicklasw</groupId>
     <artifactId>bankid-sdk</artifactId>
-    <version>0.10.0</version>
+    <version>0.11.0</version>
 </dependency>
 ```
 
 ### Gradle
 
 ```
-implementation 'dev.nicklasw:bankid-sdk:0.10.0'
+implementation 'dev.nicklasw:bankid-sdk:0.11.0'
 ```
 
 ## Changelog
@@ -62,10 +62,8 @@ import dev.nicklasw.bankid.configuration.Configuration;
 import dev.nicklasw.bankid.configuration.Pkcs12;
 import dev.nicklasw.bankid.exceptions.BankIdApiErrorException;
 
-final URI pkcs12ResourceUri = ResourceUtils.optionalUriFrom("test.p12")
-    .orElseThrow();
-final URI caResourceUri = ResourceUtils.optionalUriFrom("ca.test.crt")
-    .orElseThrow();
+final URI pkcs12ResourceUri = ResourceUtils.tryUriFrom("test.p12")
+final URI caResourceUri = ResourceUtils.tryUriFrom("ca.test.crt")
 
 final Configuration configuration = Configuration.builder()
     .baseURL(URL_TEST)

build.gradle

@@ -21,14 +21,14 @@ repositories {
 }
 
 dependencies {
-    implementation 'com.fasterxml.jackson.core:jackson-databind:2.12.+'
+    implementation 'com.fasterxml.jackson.core:jackson-databind:2.12.5'
 
     compileOnly 'com.github.spotbugs:spotbugs-annotations'
 
-    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.7.+'
-    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.7.+'
+    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.7.2'
+    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.7.2'
 
-    errorprone 'com.google.errorprone:error_prone_core:2.8.+'
+    errorprone 'com.google.errorprone:error_prone_core:2.8.1'
 }
 
 apply from: "gradle/publish.gradle"

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.3-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

src/main/java/dev/nicklasw/bankid/client/Client.java

@@ -1,11 +1,20 @@
 package dev.nicklasw.bankid.client;
 
+import java.io.IOException;
+import java.net.URI;
+import java.net.http.HttpClient;
+import java.net.http.HttpRequest;
+import java.net.http.HttpResponse;
+import java.time.Duration;
+import java.util.concurrent.CompletableFuture;
+import javax.net.ssl.SSLContext;
+
 import com.fasterxml.jackson.databind.ObjectMapper;
 import dev.nicklasw.bankid.client.request.Request;
 import dev.nicklasw.bankid.client.response.JsonBodyHandler;
 import dev.nicklasw.bankid.client.response.Response;
 import dev.nicklasw.bankid.client.response.ResponseWrapper;
-import dev.nicklasw.bankid.client.ssl.SSLContexts;
+import dev.nicklasw.bankid.client.internal.ssl.SslUtils;
 import dev.nicklasw.bankid.configuration.Configuration;
 import dev.nicklasw.bankid.configuration.Pkcs12;
 import dev.nicklasw.bankid.exceptions.BankIdApiErrorException;
@@ -15,15 +24,6 @@
 import lombok.RequiredArgsConstructor;
 import lombok.SneakyThrows;
 
-import javax.net.ssl.SSLContext;
-import java.io.IOException;
-import java.net.URI;
-import java.net.http.HttpClient;
-import java.net.http.HttpRequest;
-import java.net.http.HttpResponse;
-import java.time.Duration;
-import java.util.concurrent.CompletableFuture;
-
 @RequiredArgsConstructor(access = AccessLevel.PRIVATE)
 public class Client {
 
@@ -103,10 +103,10 @@ private String body(final Request request) {
     private static SSLContext sslContext(final Configuration configuration) {
         final Pkcs12 pkcs12 = configuration.getPkcs12();
 
-        return SSLContexts.builder()
-            .loadKeyManager(pkcs12.getPath(), pkcs12.getPassword())
-            .loadTrustManager(configuration.getCertificate())
-            .build();
+        return SslUtils.tryCreateSSLContext(
+            SslUtils.tryCreateKeyManager(pkcs12.getPath(), pkcs12.getPassword()),
+            SslUtils.tryCreateTrustManager(configuration.getCertificate())
+        );
     }
 
     private static <R extends Response> R unwrap(final HttpResponse<ResponseWrapper<R>> response) {

…klasw/bankid/client/ssl/SSLContexts.java …bankid/client/internal/ssl/SslUtils.javasrc/main/java/dev/nicklasw/bankid/client/ssl/SSLContexts.java renamed to src/main/java/dev/nicklasw/bankid/client/internal/ssl/SslUtils.java src/main/java/dev/nicklasw/bankid/client/ssl/SSLContexts.java renamed to src/main/java/dev/nicklasw/bankid/client/internal/ssl/SslUtils.java

@@ -1,4 +1,4 @@
-package dev.nicklasw.bankid.client.ssl;
+package dev.nicklasw.bankid.client.internal.ssl;
 
 import java.io.InputStream;
 import java.nio.file.Files;
@@ -11,19 +11,15 @@
 import javax.net.ssl.SSLContext;
 import javax.net.ssl.TrustManagerFactory;
 
+import lombok.NonNull;
 import lombok.SneakyThrows;
+import lombok.experimental.UtilityClass;
 
-public class SSLContexts {
-
-    private KeyManagerFactory keyManagerFactory;
-    private TrustManagerFactory trustManagerFactory;
-
-    public static SSLContexts builder() {
-        return new SSLContexts();
-    }
+@UtilityClass
+public class SslUtils {
 
     @SneakyThrows
-    public SSLContext build() {
+    public SSLContext tryCreateSSLContext(final KeyManagerFactory keyManagerFactory, final TrustManagerFactory trustManagerFactory) {
         final SSLContext sslContext = SSLContext.getInstance("TLS");
 
         sslContext.init(keyManagerFactory.getKeyManagers(), trustManagerFactory.getTrustManagers(), new SecureRandom());
@@ -32,34 +28,35 @@ public SSLContext build() {
     }
 
     @SneakyThrows
-    public SSLContexts loadKeyManager(final Path path, final String password) {
+    public static KeyManagerFactory tryCreateKeyManager(@NonNull final Path path, @NonNull final String password) {
         final KeyStore clientStore = KeyStore.getInstance("PKCS12");
 
         try (final InputStream inputStream = Files.newInputStream(path)) {
             clientStore.load(inputStream, password.toCharArray());
         }
 
-        keyManagerFactory = KeyManagerFactory.getInstance(KeyManagerFactory.getDefaultAlgorithm());
+        final KeyManagerFactory keyManagerFactory = KeyManagerFactory.getInstance(KeyManagerFactory.getDefaultAlgorithm());
         keyManagerFactory.init(clientStore, password.toCharArray());
 
-        return this;
+        return keyManagerFactory;
     }
 
     @SneakyThrows
-    public SSLContexts loadTrustManager(final Path path) {
+    public static TrustManagerFactory tryCreateTrustManager(@NonNull final Path path) {
         final CertificateFactory certificateFactory = CertificateFactory.getInstance("X.509");
         final X509Certificate caCert = (X509Certificate) certificateFactory.generateCertificate(Files.newInputStream(path));
 
-        trustManagerFactory = TrustManagerFactory
-                .getInstance(TrustManagerFactory.getDefaultAlgorithm());
+        final TrustManagerFactory trustManagerFactory = TrustManagerFactory
+            .getInstance(TrustManagerFactory.getDefaultAlgorithm());
 
         final KeyStore keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
         keyStore.load(null);
         keyStore.setCertificateEntry("caCert", caCert);
 
         trustManagerFactory.init(keyStore);
 
-        return this;
+        return trustManagerFactory;
     }
 
+
 }

src/main/java/dev/nicklasw/bankid/client/utils/ResourceUtils.java

@@ -1,18 +1,43 @@
 package dev.nicklasw.bankid.client.utils;
 
-import edu.umd.cs.findbugs.annotations.Nullable;
-import lombok.experimental.UtilityClass;
-
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.net.URL;
 import java.util.Optional;
 
+import dev.nicklasw.bankid.exceptions.BankIdException;
+import edu.umd.cs.findbugs.annotations.Nullable;
+import lombok.NonNull;
+import lombok.experimental.UtilityClass;
+
 @UtilityClass
 public class ResourceUtils {
 
-    public static Optional<URI> optionalUriFrom(final String name) {
-        return Optional.ofNullable(classLoader().getResource(name))
+    /**
+     * Tries to load a resource by name and returns a {@link URI}.
+     *
+     * @param resourceName the resource name to be loaded
+     * @throws BankIdException in case of an error
+     */
+    public static URI tryUriFrom(@NonNull final String resourceName) {
+        final URL resource = classLoader().getResource(resourceName);
+
+        if (resource == null) {
+            throw new BankIdException(
+                String.format("The resource could not found and/or accessed. %s", resourceName));
+        }
+
+        return tryResourceToURI(resource);
+    }
+
+    /**
+     * Loads a resource by name. Returns a {@link Optional#empty} is case of an error.
+     *
+     * @param resourceName the resource name to be loaded
+     * @throws BankIdException in case of an error
+     */
+    public static Optional<URI> optionalUriFrom(@NonNull final String resourceName) {
+        return Optional.ofNullable(classLoader().getResource(resourceName))
             .map(ResourceUtils::resourceToURI);
     }
 
@@ -27,6 +52,14 @@ private static URI resourceToURI(final URL url) {
         return null;
     }
 
+    private static URI tryResourceToURI(final URL url) {
+        try {
+            return url.toURI();
+        } catch (final URISyntaxException e) {
+            throw new BankIdException("Invalid resource provided", e);
+        }
+    }
+
     private static ClassLoader classLoader() {
         return Thread.currentThread().getContextClassLoader();
     }

src/main/java/dev/nicklasw/bankid/configuration/Pkcs12.java

@@ -2,6 +2,7 @@
 
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
+import lombok.NonNull;
 import lombok.RequiredArgsConstructor;
 import lombok.ToString;
 
@@ -12,6 +13,8 @@
 @EqualsAndHashCode
 @RequiredArgsConstructor(staticName = "of")
 public class Pkcs12 {
+    @NonNull
     private final Path path;
+    @NonNull
     private final String password;
 }

src/main/java/dev/nicklasw/bankid/exceptions/BankIdApiErrorException.java

@@ -8,7 +8,8 @@ public class BankIdApiErrorException extends BankIdException {
     Response response;
 
     private BankIdApiErrorException(final Response response) {
-        super(null);
+        super("Encountered a error from the BankId API");
+
         this.response = response;
     }
 

src/main/java/dev/nicklasw/bankid/exceptions/BankIdException.java

@@ -5,7 +5,12 @@ public BankIdException(final Throwable cause) {
         super(cause);
     }
 
+    public BankIdException(final String message) {
+        super(message);
+    }
+
     public BankIdException(final String message, final Throwable cause) {
         super(message, cause);
     }
+
 }

src/main/java/module-info.java

@@ -13,5 +13,4 @@
     exports dev.nicklasw.bankid.client.request;
     exports dev.nicklasw.bankid.client.model;
     exports dev.nicklasw.bankid.client.utils;
-    exports dev.nicklasw.bankid.client.ssl;
 }