functionality extensions and api changes and tweaks (#243)

Co-authored-by: Nick Genise <ngenise@apple.com>
Co-authored-by: Ruiyu Zhu <ruiyu_zhu@apple.com>
Co-authored-by: Fabian Boemer <fabian_boemer@apple.com>

Author: 4 people

.swiftlint.yml

@@ -17,6 +17,9 @@ excluded:
   - "**/DoubleWidthUInt.swift"
   - "**/.build/"
 
+type_name:
+  allowed_symbols: "_"
+
 line_length:
   warning: 120
   ignores_urls: true

Benchmarks/PrivateInformationRetrievalBenchmark/PirBenchmark.swift

@@ -18,14 +18,15 @@
 
 import _BenchmarkUtilities
 import HomomorphicEncryption
+import PrivateInformationRetrieval
 
 nonisolated(unsafe) let benchmarks: () -> Void = {
-    pirProcessBenchmark(Bfv<UInt32>.self)()
-    pirProcessBenchmark(Bfv<UInt64>.self)()
+    pirProcessBenchmark(PirUtil<Bfv<UInt32>>.self)()
+    pirProcessBenchmark(PirUtil<Bfv<UInt64>>.self)()
 
-    indexPirBenchmark(Bfv<UInt32>.self)()
-    indexPirBenchmark(Bfv<UInt64>.self)()
+    indexPirBenchmark(PirUtil<Bfv<UInt32>>.self)()
+    indexPirBenchmark(PirUtil<Bfv<UInt64>>.self)()
 
-    keywordPirBenchmark(Bfv<UInt32>.self)()
-    keywordPirBenchmark(Bfv<UInt64>.self)()
+    keywordPirBenchmark(PirUtil<Bfv<UInt32>>.self)()
+    keywordPirBenchmark(PirUtil<Bfv<UInt64>>.self)()
 }

Benchmarks/RlweBenchmark/RlweBenchmark.swift

@@ -43,7 +43,7 @@ func getRandomPlaintextData<T: ScalarType>(count: Int, in range: Range<T>) -> [T
 
 struct RlweBenchmarkContext<Scheme: HeScheme>: Sendable {
     var encryptionParameters: EncryptionParameters<Scheme.Scalar>
-    var context: Context<Scheme>
+    var context: Scheme.Context
 
     let data: [Scheme.Scalar]
     let signedData: [Scheme.SignedScalar]
@@ -69,7 +69,7 @@ struct RlweBenchmarkContext<Scheme: HeScheme>: Sendable {
                                                                  Scheme.Scalar.self),
                                                              errorStdDev: ErrorStdDev.stdDev32,
                                                              securityLevel: SecurityLevel.quantum128)
-        self.context = try Context(encryptionParameters: encryptionParameters)
+        self.context = try Scheme.Context(encryptionParameters: encryptionParameters)
         self.secretKey = try context.generateSecretKey()
         let columnElement = GaloisElement.swappingRows(degree: polyDegree)
         let rowElement = try GaloisElement.rotatingColumns(by: rotateColumnsStep, degree: polyDegree)

Package.resolved

@@ -27,6 +27,22 @@ let executableSettings: [SwiftSetting] =
 
 let benchmarkSettings: [SwiftSetting] = [.unsafeFlags(["-cross-module-optimization"], .when(configuration: .release))]
 
+let enableFlags = "SWIFT_HOMOMORPHIC_ENCRYPTION_MODULAR_ARITHMETIC_EXTRA_SWIFT_FLAGS"
+func shouldEnableFlags() -> Bool {
+    if let flag = ProcessInfo.processInfo.environment[enableFlags], flag != "0", flag != "false" {
+        return true
+    }
+    return false
+}
+
+var flags: [SwiftSetting] = []
+let enableFlagsBool = shouldEnableFlags()
+if enableFlagsBool {
+    print("Building with additional flags. To disable, unset \(enableFlags) in your environment.")
+    let flagsAsString = (ProcessInfo.processInfo.environment[enableFlags] ?? "") as String
+    flags += [.unsafeFlags(flagsAsString.components(separatedBy: ","))]
+}
+
 let package = Package(
     name: "swift-homomorphic-encryption",
     products: [
@@ -60,6 +76,7 @@ let package = Package(
     dependencies: [
         .package(url: "https://github.com/apple/swift-algorithms", from: "1.2.0"),
         .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.2.0"),
+        .package(url: "https://github.com/apple/swift-async-algorithms.git", from: "1.0.2"),
         .package(url: "https://github.com/apple/swift-crypto.git", from: "3.10.0"),
         .package(url: "https://github.com/apple/swift-log.git", from: "1.0.0"),
         .package(url: "https://github.com/apple/swift-numerics", from: "1.0.0"),
@@ -71,7 +88,7 @@ let package = Package(
         .target(
             name: "ModularArithmetic",
             dependencies: [],
-            swiftSettings: librarySettings),
+            swiftSettings: librarySettings + flags),
         .target(
             name: "CUtil",
             dependencies: [],
@@ -100,12 +117,14 @@ let package = Package(
         .target(
             name: "PrivateInformationRetrieval",
             dependencies: ["HomomorphicEncryption",
+                           .product(name: "AsyncAlgorithms", package: "swift-async-algorithms"),
                            .product(name: "Numerics", package: "swift-numerics")],
             swiftSettings: librarySettings),
         .target(
             name: "PrivateNearestNeighborSearch",
             dependencies: [
                 .product(name: "Algorithms", package: "swift-algorithms"),
+                .product(name: "AsyncAlgorithms", package: "swift-async-algorithms"),
                 "HomomorphicEncryption",
                 "_HomomorphicEncryptionExtras",
             ],

Package.swift

@@ -85,7 +85,7 @@ func summarize<Scheme: HeScheme>(
     parameters: EncryptionParameters<Scheme.Scalar>, _: Scheme.Type) throws
 {
     let values = (0..<8).map { Scheme.Scalar($0) }
-    let context = try Context<Scheme>(encryptionParameters: parameters)
+    let context = try Scheme.Context(encryptionParameters: parameters)
     let plaintext: Scheme.CoeffPlaintext = try context.encode(
         values: values,
         format: .coefficient)

Snippets/HomomorphicEncryption/EncryptionParametersSnippet.swift

@@ -24,7 +24,7 @@ extension Apple_SwiftHomomorphicEncryption_Pir_V1_EncryptedIndices {
     /// - Parameter context: Context to associate with the native type.
     /// - Returns: The converted native type.
     /// - Throws: Error upon invalid protobuf object.
-    public func native<Scheme: HeScheme>(context: Context<Scheme>) throws -> Query<Scheme> {
+    public func native<Scheme: HeScheme>(context: Scheme.Context) throws -> Query<Scheme> {
         let ciphertexts: [Scheme.CanonicalCiphertext] = try ciphertexts.map { ciphertext in
             let serializedCiphertext: SerializedCiphertext<Scheme.Scalar> = try ciphertext.native()
             return try Ciphertext(
@@ -54,7 +54,7 @@ extension ProcessedDatabaseWithParameters {
     /// - Parameter context: The context that was used to create processed database.
     /// - Returns: The PIR parameters protobuf object.
     /// - Throws: Error when the parameters cannot be represented as a protobuf object.
-    public func proto(context: Context<Scheme>) throws -> Apple_SwiftHomomorphicEncryption_Pir_V1_PirParameters {
+    public func proto(context: Scheme.Context) throws -> Apple_SwiftHomomorphicEncryption_Pir_V1_PirParameters {
         let encryptionParameters = context.encryptionParameters
         return try Apple_SwiftHomomorphicEncryption_Pir_V1_PirParameters.with { params in
             params.encryptionParameters = try encryptionParameters.proto(scheme: Scheme.self)

Sources/ApplicationProtobuf/PirConversion.swift

@@ -21,7 +21,7 @@ extension Apple_SwiftHomomorphicEncryption_Api_Pir_V1_PIRResponse {
     /// - Parameter context: Context to associate with the native type.
     /// - Returns: The converted native type.
     /// - Throws: Error upon invalid protobuf object.
-    public func native<Scheme: HeScheme>(context: Context<Scheme>) throws -> Response<Scheme> {
+    public func native<Scheme: HeScheme>(context: Scheme.Context) throws -> Response<Scheme> {
         let ciphertexts: [[Scheme.CoeffCiphertext]] = try replies.map { reply in
             let serializedCiphertexts: [SerializedCiphertext<Scheme.Scalar>] = try reply.native()
             return try serializedCiphertexts.map { serialized in

Sources/ApplicationProtobuf/PirConversionApi.swift

@@ -315,7 +315,7 @@ extension [Apple_SwiftHomomorphicEncryption_Pnns_V1_SerializedCiphertextMatrix]
     /// Converts the native object into a protobuf object.
     /// - Returns: The converted protobuf object.
     /// - Throws: Error upon unsupported object.
-    public func native<Scheme: HeScheme>(context: Context<Scheme>) throws -> Query<Scheme> {
+    public func native<Scheme: HeScheme>(context: Scheme.Context) throws -> Query<Scheme> {
         let matrices: [CiphertextMatrix<Scheme, Coeff>] = try map { matrix in
             let native: SerializedCiphertextMatrix<Scheme.Scalar> = try matrix.native()
             return try CiphertextMatrix(deserialize: native, context: context)

Sources/ApplicationProtobuf/PnnsConversion.swift

@@ -23,7 +23,7 @@ extension Apple_SwiftHomomorphicEncryption_Api_Pnns_V1_PNNSShardResponse {
     /// - Parameter contexts: Contexts to associate with the native type; one context per plaintext modulus.
     /// - Returns: The converted native type.
     /// - Throws: Error upon invalid protobuf object.
-    public func native<Scheme: HeScheme>(contexts: [Context<Scheme>]) throws -> Response<Scheme> {
+    public func native<Scheme: HeScheme>(contexts: [Scheme.Context]) throws -> Response<Scheme> {
         precondition(contexts.count == reply.count)
         let matrices: [CiphertextMatrix<Scheme, Coeff>] = try zip(reply, contexts).map { matrix, context in
             let serialized: SerializedCiphertextMatrix<Scheme.Scalar> = try matrix.native()