Merge pull request #3 from skiptools/cache-cacerts

Do not recreate the cacerts cache unless the source certificates have changed

Author: marcprux

Sources/AndroidNative/AndroidNative.swift

@@ -19,31 +19,68 @@ public class AndroidBootstrap {
     /// See https://github.com/apple/swift-nio-ssl/blob/d1088ebe0789d9eea231b40741831f37ab654b61/Sources/NIOSSL/AndroidCABundle.swift#L30
     @available(macOS 13.0, iOS 16.0, *)
     public static func setupCACerts(force: Bool = false, fromCertficateFolders certsFolders: [String] = ["/system/etc/security/cacerts", "/apex/com.android.conscrypt/cacerts"]) throws {
+        //setenv("URLSessionCertificateAuthorityInfoFile", "INSECURE_SSL_NO_VERIFY", 1) // disables all certificate verification
+        //setenv("URLSessionCertificateAuthorityInfoFile", "/system/etc/security/cacerts/", 1) // doesn't work for directories
+
         // if someone else has already set URLSessionCertificateAuthorityInfoFile then do not override unless forced
         if !force && getenv("URLSessionCertificateAuthorityInfoFile") != nil {
             return
         }
 
+        // get a list of all the certificate URLs
+        var certURLs: [URL] = []
+        for certsFolder in certsFolders {
+            let certsFolderURL = URL(fileURLWithPath: certsFolder)
+            if (try? certsFolderURL.resourceValues(forKeys: [.isDirectoryKey]).isDirectory) != true { continue }
+            let certFolderURLs = try FileManager.default.contentsOfDirectory(at: certsFolderURL, includingPropertiesForKeys: [.isRegularFileKey, .isReadableKey, .fileSizeKey, .contentModificationDateKey])
+            for certURL in certFolderURLs {
+                //logger.debug("setupCACerts: certURL=\(certURL)")
+                // certificate files have names like "53a1b57a.0"
+                if certURL.pathExtension != "0" { continue }
+                do {
+                    if try certURL.resourceValues(forKeys: [.isRegularFileKey]).isRegularFile == false { continue }
+                    if try certURL.resourceValues(forKeys: [.isReadableKey]).isReadable == false { continue }
+                    certURLs.append(certURL)
+                } catch {
+                    //logger.warning("setupCACerts: error reading certificate file \(certURL.path): \(error)")
+                    continue
+                }
+            }
+        }
+        certURLs = certURLs.sorted { $0.path < $1.path }
+
+        // generate a checksum of all the certificate URL names and their sizes and modification times in order to define the aggregate file name
+        // we do this so was can safely cache the aggregate certificate file without re-creating it every time
+        var urlSummary = ""
+        for certURL in certURLs {
+            urlSummary.append(certURL.path)
+            urlSummary.append("|")
+            urlSummary.append((try? certURL.resourceValues(forKeys: [.fileSizeKey]).fileSize?.description) ?? "")
+            urlSummary.append("|")
+            urlSummary.append((try? certURL.resourceValues(forKeys: [.contentModificationDateKey]).contentModificationDate?.timeIntervalSince1970.description) ?? "")
+            urlSummary.append("|")
+        }
+        let checksum = crc32Checksum(of: urlSummary.data(using: .utf8) ?? Data())
+
         var cacheFolder = try FileManager.default.url(for: .cachesDirectory, in: .userDomainMask, appropriateFor: nil, create: false)
         var cacheFolderIsDir: Bool = false
         if !FileManager.default.fileExists(atPath: cacheFolder.path, isDirectory: &cacheFolderIsDir) || !cacheFolderIsDir {
             cacheFolder = URL.temporaryDirectory
         }
-        //logger.debug("setupCACerts: \(cacheFolder)")
-        let generatedCacertsURL = cacheFolder.appendingPathComponent("cacerts-aggregate.pem")
-        //logger.debug("setupCACerts: generatedCacertsURL=\(generatedCacertsURL)")
+        let generatedCacertsURL = cacheFolder.appendingPathComponent("cacerts-aggregate-\(checksum).pem")
 
-        let contents = try FileManager.default.contentsOfDirectory(at: cacheFolder, includingPropertiesForKeys: nil)
-        //logger.debug("setupCACerts: cacheFolder=\(cacheFolder) contents=\(contents)")
-
-        // clear any previous generated certificates file that may have been created by this app
         if FileManager.default.fileExists(atPath: generatedCacertsURL.path) {
+            // cached aggregate file already exists; just re-use
+            if !force {
+                setenv("URLSessionCertificateAuthorityInfoFile", generatedCacertsURL.path, 1)
+                return
+            }
+
+            // clear any previous generated certificates file that may have been created by this app
             try FileManager.default.removeItem(atPath: generatedCacertsURL.path)
         }
 
-        let created = FileManager.default.createFile(atPath: generatedCacertsURL.path, contents: nil)
-        //logger.debug("setupCACerts: created file: \(created): \(generatedCacertsURL.path)")
-
+        _ = FileManager.default.createFile(atPath: generatedCacertsURL.path, contents: nil)
         let fs = try FileHandle(forWritingTo: generatedCacertsURL)
         defer { try? fs.close() }
 
@@ -60,30 +97,28 @@ public class AndroidBootstrap {
         // The .0 files will contain some extra metadata, but libcurl only cares about the
         // -----BEGIN CERTIFICATE----- and -----END CERTIFICATE----- sections,
         // so we can naïvely concatenate them all and libcurl will understand the bundle.
-        for certsFolder in certsFolders {
-            let certsFolderURL = URL(fileURLWithPath: certsFolder)
-            if (try? certsFolderURL.resourceValues(forKeys: [.isDirectoryKey]).isDirectory) != true { continue }
-            let certURLs = try FileManager.default.contentsOfDirectory(at: certsFolderURL, includingPropertiesForKeys: [.isRegularFileKey, .isReadableKey])
-            for certURL in certURLs {
-                //logger.debug("setupCACerts: certURL=\(certURL)")
-                // certificate files have names like "53a1b57a.0"
-                if certURL.pathExtension != "0" { continue }
-                do {
-                    if try certURL.resourceValues(forKeys: [.isRegularFileKey]).isRegularFile == false { continue }
-                    if try certURL.resourceValues(forKeys: [.isReadableKey]).isReadable == false { continue }
-                    try fs.write(contentsOf: try Data(contentsOf: certURL))
-                } catch {
-                    //logger.warning("setupCACerts: error reading certificate file \(certURL.path): \(error)")
-                    continue
+        for certURL in certURLs {
+            try fs.write(contentsOf: try Data(contentsOf: certURL))
+        }
+
+        setenv("URLSessionCertificateAuthorityInfoFile", generatedCacertsURL.path, 1)
+    }
+
+    private static func crc32Checksum(of data: Data) -> UInt32 {
+        var crc: UInt32 = 0xFFFFFFFF
+
+        for byte in data {
+            crc = crc ^ UInt32(byte)
+            for _ in 0..<8 {
+                if crc & 1 == 1 {
+                    crc = (crc >> 1) ^ 0xEDB88320
+                } else {
+                    crc = crc >> 1
                 }
             }
         }
 
-
-        //setenv("URLSessionCertificateAuthorityInfoFile", "INSECURE_SSL_NO_VERIFY", 1) // disables all certificate verification
-        //setenv("URLSessionCertificateAuthorityInfoFile", "/system/etc/security/cacerts/", 1) // doesn't work for directories
-        setenv("URLSessionCertificateAuthorityInfoFile", generatedCacertsURL.path, 1)
-        //logger.debug("setupCACerts: set URLSessionCertificateAuthorityInfoFile=\(generatedCacertsURL.path)")
+        return ~crc
     }
 }
 #endif