Cert-D-Java 0.2.1-SNAPSHOT

CHANGELOG.md

@@ -5,15 +5,18 @@ SPDX-License-Identifier: CC0-1.0
 
 # Cert-D-Java Changelog
 
-## 0.1.2-SNAPSHOT
+## 0.2.0
 - `pgp-certificate-store`:
   - Rework `Certificate`, `Key` to inherit from `KeyMaterial`
   - Rename `CertificateReaderBackend` to `KeyMaterialReaderBackend`
   - Rename `CertificateMerger` to `KeyMaterialMerger`
   - Rework `PGPCertificateStore` class
 - `pgp-cert-d-java`:
+  - Increase minimum Android API level to 26
+  - Add `PGPCertificateDirectories` factory class
   - Rework `PGPCertificateDirectory` class by separating out backend logic
   - Split interface into `ReadOnlyPGPCertificateDirectory` and `WritingPGPCertificateDirectory`
+  - `FileBasedCertificateDirectoryBackend`: Calculate tag based on file attributes (inode)
 - `pgp-cert-d-java-jdbc-sqlite-lookup`:
   - Add `DatabaseSubkeyLookupFactory`
 

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

@@ -35,12 +35,20 @@ import java.util.Iterator;
 import java.util.List;
 import java.util.regex.Pattern;
 
+/**
+ * Implementation of {@link PGPCertificateDirectory.Backend} which stores certificates in a directory structure.
+ *
+ * @see <a href="https://sequoia-pgp.gitlab.io/pgp-cert-d/#name-implementation">Shared PGP Certificate Directory</a>
+ */
 public class FileBasedCertificateDirectoryBackend implements PGPCertificateDirectory.Backend {
 
     private abstract static class Lazy<E> {
         abstract E get() throws BadDataException;
     }
 
+    /**
+     * Locking mechanism which uses a lock file to synchronize write-access to the store.
+     */
     private static class FileLockingMechanism implements PGPCertificateDirectory.LockingMechanism {
 
         private final File lockFile;
@@ -209,6 +217,10 @@ public class FileBasedCertificateDirectoryBackend implements PGPCertificateDirec
                     }
                 });
 
+                if (subdirectories == null) {
+                    subdirectories = new File[0];
+                }
+
                 for (File subdirectory : subdirectories) {
                     File[] files = subdirectory.listFiles(new FileFilter() {
                         @Override
@@ -217,6 +229,10 @@ public class FileBasedCertificateDirectoryBackend implements PGPCertificateDirec
                         }
                     });
 
+                    if (files == null) {
+                        files = new File[0];
+                    }
+
                     for (File certFile : files) {
                         certificateQueue.add(new Lazy<Certificate>() {
                             @Override
@@ -364,10 +380,14 @@ public class FileBasedCertificateDirectoryBackend implements PGPCertificateDirec
         return getTag(certFile);
     }
 
+    /**
+     * Class to resolve file names from certificate fingerprints / special names.
+     */
     public static class FilenameResolver {
 
         private final File baseDirectory;
-        private final Pattern openPgpV4FingerprintPattern = Pattern.compile("^[a-f0-9]{40}$");
+        // matches v4 and v5 fingerprints (v4 = 40 hex chars, v5 = 64 hex chars)
+        private final Pattern openPgpFingerprint = Pattern.compile("^[a-f0-9]{40}([a-f0-9]{24})?$");
 
         public FilenameResolver(File baseDirectory) {
             this.baseDirectory = baseDirectory;
@@ -415,26 +435,8 @@ public class FileBasedCertificateDirectoryBackend implements PGPCertificateDirec
             return new File(getBaseDirectory(), specialName);
         }
 
-        /**
-         * Calculate the file location for the key addressed using the given special name.
-         * For known special names, see {@link SpecialNames}.
-         *
-         * @param specialName special name (e.g. "trust-root")
-         * @return absolute key file location
-         *
-         * @throws BadNameException in case the given special name is not known
-         */
-        public File getKeyFileBySpecialName(String specialName)
-                throws BadNameException {
-            if (!isSpecialName(specialName)) {
-                throw new BadNameException(String.format("%s is not a known special name", specialName));
-            }
-
-            return new File(getBaseDirectory(), specialName + ".key");
-        }
-
         private boolean isFingerprint(String fingerprint) {
-            return openPgpV4FingerprintPattern.matcher(fingerprint).matches();
+            return openPgpFingerprint.matcher(fingerprint).matches();
         }
 
         private boolean isSpecialName(String specialName) {

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

@@ -21,6 +21,10 @@ import java.util.Iterator;
 import java.util.Map;
 import java.util.concurrent.atomic.AtomicLong;
 
+/**
+ * Implementation of the {@link PGPCertificateDirectory.Backend} which stores key material in-memory.
+ * It uses object locking with {@link #wait()} and {@link #notify()} to synchronize write-access.
+ */
 public class InMemoryCertificateDirectoryBackend implements PGPCertificateDirectory.Backend {
 
     protected static class ObjectLockingMechanism implements PGPCertificateDirectory.LockingMechanism {

pgp-cert-d-java/src/main/java/pgp/cert_d/subkey_lookup/InMemorySubkeyLookupFactory.java

@@ -6,6 +6,9 @@ package pgp.cert_d.subkey_lookup;
 
 import java.io.File;
 
+/**
+ * Factory class to instantiate {@link InMemorySubkeyLookup} objects.
+ */
 public class InMemorySubkeyLookupFactory implements SubkeyLookupFactory {
     @Override
     public SubkeyLookup createFileBasedInstance(File baseDirectory) {

pgp-cert-d-java/src/main/java/pgp/cert_d/subkey_lookup/SubkeyLookupFactory.java

@@ -6,6 +6,9 @@ package pgp.cert_d.subkey_lookup;
 
 import java.io.File;
 
+/**
+ * Factory class to instantiate different {@link SubkeyLookup} implementations.
+ */
 public interface SubkeyLookupFactory {
 
     /**

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

@@ -70,7 +70,7 @@ public class PGPCertificateDirectoryTest {
 
     @ParameterizedTest
     @MethodSource("provideTestSubjects")
-    public void lockDirectoryAndInsertWillFail(PGPCertificateDirectory directory)
+    public void lockDirectoryAndTryInsertWillFail(PGPCertificateDirectory directory)
             throws IOException, InterruptedException, BadDataException {
         // Manually lock the dir
         assertFalse(directory.backend.getLock().isLocked());
@@ -86,6 +86,40 @@ public class PGPCertificateDirectoryTest {
         assertNotNull(inserted);
     }
 
+    @ParameterizedTest
+    @MethodSource("provideTestSubjects")
+    public void lockDirectoryAndTryInsertTrustRootWillFail(PGPCertificateDirectory directory)
+            throws IOException, InterruptedException, BadDataException {
+        // Manually lock the dir
+        assertFalse(directory.backend.getLock().isLocked());
+        directory.backend.getLock().lockDirectory();
+        assertTrue(directory.backend.getLock().isLocked());
+
+        KeyMaterial inserted = directory.tryInsertTrustRoot(TestKeys.getHarryKey(), merger);
+        assertNull(inserted);
+
+        directory.backend.getLock().releaseDirectory();
+        inserted = directory.tryInsertTrustRoot(TestKeys.getHarryKey(), merger);
+        assertNotNull(inserted);
+    }
+
+    @ParameterizedTest
+    @MethodSource("provideTestSubjects")
+    public void lockDirectoryAndTryInsertWithSpecialNameWillFail(PGPCertificateDirectory directory)
+            throws IOException, InterruptedException, BadDataException, BadNameException {
+        // Manually lock the dir
+        assertFalse(directory.backend.getLock().isLocked());
+        directory.backend.getLock().lockDirectory();
+        assertTrue(directory.backend.getLock().isLocked());
+
+        Certificate inserted = directory.tryInsertWithSpecialName(SpecialNames.TRUST_ROOT, TestKeys.getHarryKey(), merger);
+        assertNull(inserted);
+
+        directory.backend.getLock().releaseDirectory();
+        inserted = directory.tryInsertWithSpecialName(SpecialNames.TRUST_ROOT, TestKeys.getHarryKey(), merger);
+        assertNotNull(inserted);
+    }
+
     @ParameterizedTest
     @MethodSource("provideTestSubjects")
     public void getByInvalidNameFails(PGPCertificateDirectory directory) {

version.gradle

@@ -4,7 +4,7 @@
 
 allprojects {
     ext {
-        shortVersion = '0.1.2'
+        shortVersion = '0.2.1'
         isSnapshot = true
         minAndroidSdk = 26
         animalsnifferSignatureVersion = "$minAndroidSdk:8.0.0_r2"