Wip

pgp-certificates/build.gradle

@@ -0,0 +1,35 @@
+// SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>
+//
+// SPDX-License-Identifier: Apache-2.0
+
+plugins {
+    id 'java-library'
+}
+
+group 'org.pgpainless'
+
+repositories {
+    mavenCentral()
+}
+
+apply plugin: 'ru.vyarus.animalsniffer'
+
+dependencies {
+    // animal sniffer
+    signature "net.sf.androidscents.signature:android-api-level-${minAndroidSdk}:2.3.3_r2@signature"
+
+    testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
+    testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
+
+    // Logging
+    api "org.slf4j:slf4j-api:$slf4jVersion"
+    testImplementation "ch.qos.logback:logback-classic:$logbackVersion"
+}
+
+animalsniffer {
+    sourceSets = [sourceSets.main]
+}
+
+test {
+    useJUnitPlatform()
+}

pgp-certificates/src/main/java/pgp/Certificate.java

@@ -0,0 +1,36 @@
+// SPDX-FileCopyrightText: 2022 Paul Schaub <vanitasvitae@fsfe.org>
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package pgp;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Set;
+
+public abstract class Certificate {
+    /**
+     * Return the fingerprint of the certificate as 40 lowercase hex characters.
+     * TODO: Allow OpenPGP V5 fingerprints
+     *
+     * @return fingerprint
+     */
+    public abstract String getFingerprint();
+
+    /**
+     * Return an {@link InputStream} of the binary representation of the certificate.
+     *
+     * @return input stream
+     */
+    public abstract InputStream getInputStream() throws IOException;
+
+    /**
+     * Return a tag of the certificate.
+     * The tag is a checksum calculated over the binary representation of the certificate.
+     *
+     * @return tag
+     */
+    public abstract String getTag() throws IOException;
+
+    public abstract Set<Long> getSubkeyIds() throws IOException;
+}

pgp-certificates/src/main/java/pgp/CertificateMerger.java

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

pgp-certificates/src/main/java/pgp/CertificateReader.java

@@ -0,0 +1,26 @@
+// SPDX-FileCopyrightText: 2022 Paul Schaub <vanitasvitae@fsfe.org>
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package pgp;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+/**
+ * Interface definition for a class that can read {@link Certificate Certificates} from binary
+ * {@link InputStream InputStreams}.
+ */
+public interface CertificateReader {
+
+    /**
+     * Read a {@link Certificate} from the given {@link InputStream}.
+     *
+     * @param inputStream input stream containing the binary representation of the certificate.
+     * @return certificate object
+     *
+     * @throws IOException in case of an IO error
+     */
+    Certificate readCertificate(InputStream inputStream) throws IOException;
+
+}

pgp-certificates/src/main/java/pgp/package-info.java

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