Get rid of certificate-store abstraction

pgp-cert-d-java/build.gradle

@@ -28,9 +28,6 @@ dependencies {
 
     // SQL Subkey table
     testImplementation project(":pgp-cert-d-java-jdbc-sqlite-lookup")
-
-    // Certificate store
-    api project(":pgp-certificate-store")
 }
 
 animalsniffer {

pgp-cert-d-java/src/main/java/pgp/cert_d/BadDataException.java

@@ -0,0 +1,12 @@
+// SPDX-FileCopyrightText: 2022 Paul Schaub <vanitasvitae@fsfe.org>
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package pgp.cert_d;
+
+/**
+ * The data was not a valid OpenPGP cert or key in binary format.
+ */
+public class BadDataException extends Exception {
+
+}

pgp-cert-d-java/src/main/java/pgp/cert_d/BadNameException.java

@@ -0,0 +1,19 @@
+// SPDX-FileCopyrightText: 2022 Paul Schaub <vanitasvitae@fsfe.org>
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package pgp.cert_d;
+
+/**
+ * Provided name was neither a valid fingerprint, nor a known special name.
+ */
+public class BadNameException extends Exception {
+
+    public BadNameException() {
+        super();
+    }
+
+    public BadNameException(String message) {
+        super(message);
+    }
+}

pgp-cert-d-java/src/main/java/pgp/cert_d/FileBasedCertificateDirectoryBackend.java

@@ -4,13 +4,10 @@
 
 package pgp.cert_d;
 
-import pgp.certificate_store.Certificate;
-import pgp.certificate_store.KeyMaterial;
-import pgp.certificate_store.KeyMaterialMerger;
-import pgp.certificate_store.KeyMaterialReaderBackend;
-import pgp.certificate_store.exception.BadDataException;
-import pgp.certificate_store.exception.BadNameException;
-import pgp.certificate_store.exception.NotAStoreException;
+import pgp.certificate.Certificate;
+import pgp.certificate.KeyMaterial;
+import pgp.certificate.KeyMaterialMerger;
+import pgp.certificate.KeyMaterialReaderBackend;
 
 import java.io.BufferedInputStream;
 import java.io.File;

pgp-cert-d-java/src/main/java/pgp/cert_d/InMemoryCertificateDirectoryBackend.java

@@ -4,12 +4,10 @@
 
 package pgp.cert_d;
 
-import pgp.certificate_store.Certificate;
-import pgp.certificate_store.KeyMaterial;
-import pgp.certificate_store.KeyMaterialMerger;
-import pgp.certificate_store.KeyMaterialReaderBackend;
-import pgp.certificate_store.exception.BadDataException;
-import pgp.certificate_store.exception.BadNameException;
+import pgp.certificate.Certificate;
+import pgp.certificate.KeyMaterial;
+import pgp.certificate.KeyMaterialMerger;
+import pgp.certificate.KeyMaterialReaderBackend;
 
 import java.io.IOException;
 import java.io.InputStream;

pgp-cert-d-java/src/main/java/pgp/cert_d/InMemorySubkeyLookup.java

@@ -11,8 +11,6 @@ import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
-import pgp.certificate_store.SubkeyLookup;
-
 public class InMemorySubkeyLookup implements SubkeyLookup {
 
     private static final Map<Long, Set<String>> subkeyMap = new HashMap<>();

pgp-cert-d-java/src/main/java/pgp/cert_d/NotAStoreException.java

@@ -0,0 +1,19 @@
+// SPDX-FileCopyrightText: 2022 Paul Schaub <vanitasvitae@fsfe.org>
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package pgp.cert_d;
+
+/**
+ * The base dir cannot possibly contain a store.
+ */
+public class NotAStoreException extends Exception {
+
+    public NotAStoreException() {
+        super();
+    }
+
+    public NotAStoreException(String message) {
+        super(message);
+    }
+}

pgp-cert-d-java/src/main/java/pgp/cert_d/PGPCertificateDirectories.java

@@ -4,8 +4,7 @@
 
 package pgp.cert_d;
 
-import pgp.certificate_store.KeyMaterialReaderBackend;
-import pgp.certificate_store.exception.NotAStoreException;
+import pgp.certificate.KeyMaterialReaderBackend;
 
 import java.io.File;
 

pgp-cert-d-java/src/main/java/pgp/cert_d/PGPCertificateDirectory.java

@@ -4,11 +4,9 @@
 
 package pgp.cert_d;
 
-import pgp.certificate_store.Certificate;
-import pgp.certificate_store.KeyMaterial;
-import pgp.certificate_store.KeyMaterialMerger;
-import pgp.certificate_store.exception.BadDataException;
-import pgp.certificate_store.exception.BadNameException;
+import pgp.certificate.Certificate;
+import pgp.certificate.KeyMaterial;
+import pgp.certificate.KeyMaterialMerger;
 
 import java.io.IOException;
 import java.io.InputStream;

pgp-cert-d-java/src/main/java/pgp/cert_d/ReadOnlyPGPCertificateDirectory.java

@@ -4,9 +4,7 @@
 
 package pgp.cert_d;
 
-import pgp.certificate_store.Certificate;
-import pgp.certificate_store.exception.BadDataException;
-import pgp.certificate_store.exception.BadNameException;
+import pgp.certificate.Certificate;
 
 import java.io.IOException;
 import java.util.Iterator;

pgp-cert-d-java/src/main/java/pgp/cert_d/SubkeyLookup.java

@@ -0,0 +1,34 @@
+// SPDX-FileCopyrightText: 2022 Paul Schaub <vanitasvitae@fsfe.org>
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package pgp.cert_d;
+
+import java.io.IOException;
+import java.util.List;
+import java.util.Set;
+
+public interface SubkeyLookup {
+
+    /**
+     * Lookup the fingerprint of the certificate that contains the given subkey.
+     * If no record is found, return null.
+     *
+     * @param subkeyId subkey id
+     * @return fingerprint of the certificate
+     *
+     * @throws IOException in case of an IO error
+     */
+    Set<String> getCertificateFingerprintsForSubkeyId(long subkeyId) throws IOException;
+
+    /**
+     * Record, which certificate the subkey-ids in the list belong to.
+     * This method does not change the affiliation of subkey-ids not contained in the provided list.
+     *
+     * @param certificate certificate fingerprint
+     * @param subkeyIds subkey ids
+     *
+     * @throws IOException in case of an IO error
+     */
+    void storeCertificateSubkeyIds(String certificate, List<Long> subkeyIds) throws IOException;
+}

pgp-cert-d-java/src/main/java/pgp/cert_d/WritingPGPCertificateDirectory.java

@@ -4,11 +4,9 @@
 
 package pgp.cert_d;
 
-import pgp.certificate_store.Certificate;
-import pgp.certificate_store.KeyMaterial;
-import pgp.certificate_store.KeyMaterialMerger;
-import pgp.certificate_store.exception.BadDataException;
-import pgp.certificate_store.exception.BadNameException;
+import pgp.certificate.Certificate;
+import pgp.certificate.KeyMaterial;
+import pgp.certificate.KeyMaterialMerger;
 
 import java.io.IOException;
 import java.io.InputStream;

pgp-cert-d-java/src/main/java/pgp/certificate/Certificate.java

@@ -0,0 +1,16 @@
+// SPDX-FileCopyrightText: 2022 Paul Schaub <vanitasvitae@fsfe.org>
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package pgp.certificate;
+
+/**
+ * OpenPGP certificate (public key).
+ */
+public abstract class Certificate implements KeyMaterial {
+
+    @Override
+    public Certificate asCertificate() {
+        return this;
+    }
+}

pgp-cert-d-java/src/main/java/pgp/certificate/Key.java

@@ -0,0 +1,24 @@
+// SPDX-FileCopyrightText: 2022 Paul Schaub <vanitasvitae@fsfe.org>
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package pgp.certificate;
+
+/**
+ * OpenPGP key (secret key).
+ */
+public abstract class Key implements KeyMaterial {
+
+    /**
+     * Return the certificate part of this OpenPGP key.
+     *
+     * @return OpenPGP certificate
+     */
+    public abstract Certificate getCertificate();
+
+    @Override
+    public Certificate asCertificate() {
+        return getCertificate();
+    }
+
+}

pgp-cert-d-java/src/main/java/pgp/certificate/KeyMaterial.java

@@ -0,0 +1,40 @@
+// SPDX-FileCopyrightText: 2022 Paul Schaub <vanitasvitae@fsfe.org>
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package pgp.certificate;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Set;
+
+public interface KeyMaterial {
+
+    /**
+     * Return the fingerprint of the certificate as 40 lowercase hex characters.
+     * TODO: Allow OpenPGP V5 fingerprints
+     *
+     * @return fingerprint
+     */
+    String getFingerprint();
+
+    Certificate asCertificate();
+
+    /**
+     * Return an {@link InputStream} of the binary representation of the secret key.
+     *
+     * @return input stream
+     * @throws IOException in case of an IO error
+     */
+    InputStream getInputStream() throws IOException;
+
+    String getTag() throws IOException;
+
+    /**
+     * Return a {@link Set} containing key-ids of subkeys.
+     *
+     * @return subkeys
+     * @throws IOException in case of an IO error
+     */
+    Set<Long> getSubkeyIds() throws IOException;
+}

pgp-cert-d-java/src/main/java/pgp/certificate/KeyMaterialMerger.java

@@ -0,0 +1,25 @@
+// SPDX-FileCopyrightText: 2022 Paul Schaub <vanitasvitae@fsfe.org>
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package pgp.certificate;
+
+import java.io.IOException;
+
+/**
+ * Merge a given {@link Key} (update) with an existing {@link Key}.
+ */
+public interface KeyMaterialMerger {
+
+    /**
+     * Merge the given key material with an existing copy and return the result.
+     * If no existing {@link KeyMaterial} is found (i.e. if existing is null), this method returns the unmodified data.
+     *
+     * @param data key material
+     * @param existing optional already existing copy of the key material
+     * @return merged key material
+     *
+     * @throws IOException in case of an IO error
+     */
+    KeyMaterial merge(KeyMaterial data, KeyMaterial existing) throws IOException;
+}

pgp-cert-d-java/src/main/java/pgp/certificate/KeyMaterialReaderBackend.java

@@ -0,0 +1,24 @@
+// SPDX-FileCopyrightText: 2022 Paul Schaub <vanitasvitae@fsfe.org>
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package pgp.certificate;
+
+import pgp.cert_d.BadDataException;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+public interface KeyMaterialReaderBackend {
+
+    /**
+     * Read a {@link KeyMaterial} (either {@link Key} or {@link Certificate}) from the given {@link InputStream}.
+     *
+     * @param data input stream containing the binary representation of the key.
+     * @return key or certificate object
+     *
+     * @throws IOException in case of an IO error
+     * @throws BadDataException in case that the data stream does not contain a valid OpenPGP key/certificate
+     */
+    KeyMaterial read(InputStream data) throws IOException, BadDataException;
+}

pgp-cert-d-java/src/main/java/pgp/certificate/package-info.java

@@ -0,0 +1,8 @@
+// SPDX-FileCopyrightText: 2022 Paul Schaub <vanitasvitae@fsfe.org>
+//
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * General OpenPGP Certificate Storage related classes.
+ */
+package pgp.certificate;

pgp-cert-d-java/src/test/java/pgp/cert_d/FilenameResolverTest.java

@@ -6,7 +6,6 @@ package pgp.cert_d;
 
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
-import pgp.certificate_store.exception.BadNameException;
 
 import java.io.File;
 import java.io.IOException;

pgp-cert-d-java/src/test/java/pgp/cert_d/SubkeyLookupTest.java

@@ -24,7 +24,6 @@ import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.MethodSource;
 import pgp.cert_d.jdbc.sqlite.DatabaseSubkeyLookup;
 import pgp.cert_d.jdbc.sqlite.SqliteSubkeyLookupDaoImpl;
-import pgp.certificate_store.SubkeyLookup;
 
 public class SubkeyLookupTest {