Package.swift

// swift-tools-version: 6.0
// The swift-tools-version declares the minimum version of Swift required to build this package.
// Remember to update CI if changing

// Copyright 2024-2025 Apple Inc. and the Swift Homomorphic Encryption project authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import Foundation
import PackageDescription

let librarySettings: [SwiftSetting] = []

let executableSettings: [SwiftSetting] =
    librarySettings +
    [.unsafeFlags(["-cross-module-optimization"], .when(configuration: .release))]

let benchmarkSettings: [SwiftSetting] = [.unsafeFlags(["-cross-module-optimization"], .when(configuration: .release))]

let package = Package(
    name: "swift-homomorphic-encryption",
    products: [
        // Products define the executables and libraries a package produces, making them visible to other packages.
        .library(
            name: "ModularArithmetic",
            targets: ["ModularArithmetic"]),
        .library(
            name: "HomomorphicEncryption",
            targets: ["HomomorphicEncryption"]),
        .library(
            name: "HomomorphicEncryptionProtobuf",
            targets: ["HomomorphicEncryptionProtobuf"]),
        .library(
            name: "PrivateInformationRetrieval",
            targets: ["PrivateInformationRetrieval"]),
        .library(
            name: "PrivateInformationRetrievalProtobuf",
            targets: ["PrivateInformationRetrievalProtobuf"]),
        .library(
            name: "PrivateNearestNeighborSearch",
            targets: ["PrivateNearestNeighborSearch"]),
        .library(
            name: "PrivateNearestNeighborSearchProtobuf",
            targets: ["PrivateNearestNeighborSearchProtobuf"]),
        .library(name: "_TestUtilities", targets: ["_TestUtilities"]),
        .executable(name: "PIRGenerateDatabase", targets: ["PIRGenerateDatabase"]),
        .executable(name: "PIRProcessDatabase", targets: ["PIRProcessDatabase"]),
        .executable(name: "PIRShardDatabase", targets: ["PIRShardDatabase"]),
        .executable(name: "PNNSGenerateDatabase", targets: ["PNNSGenerateDatabase"]),
        .executable(name: "PNNSProcessDatabase", targets: ["PNNSProcessDatabase"]),
    ],
    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-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"),
        .package(url: "https://github.com/apple/swift-protobuf", from: "1.29.0"), // Keep version in sync with README
        .package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.1.0"),
    ],
    targets: [
        // Targets are the basic building blocks of a package, defining a module or a test suite.
        // Targets can depend on other targets in this package and products from dependencies.
        .target(
            name: "ModularArithmetic",
            dependencies: [],
            swiftSettings: librarySettings),
        .target(
            name: "CUtil",
            dependencies: [],
            path: "Sources/CUtil",
            sources: ["zeroize.c"],
            publicHeadersPath: "."),
        .target(
            name: "HomomorphicEncryption",
            dependencies: [
                .product(name: "Crypto", package: "swift-crypto"),
                .product(name: "_CryptoExtras", package: "swift-crypto"),
                "CUtil",
                "ModularArithmetic",
            ],
            swiftSettings: librarySettings),
        .target(
            name: "HomomorphicEncryptionProtobuf",
            dependencies: ["HomomorphicEncryption",
                           .product(name: "SwiftProtobuf", package: "swift-protobuf")],
            exclude: ["generated/README.md"],
            swiftSettings: librarySettings),
        .target(
            name: "PrivateInformationRetrieval",
            dependencies: ["HomomorphicEncryption",
                           .product(name: "Numerics", package: "swift-numerics")],
            swiftSettings: librarySettings),
        .target(
            name: "PrivateInformationRetrievalProtobuf",
            dependencies: ["PrivateInformationRetrieval",
                           "HomomorphicEncryption",
                           "HomomorphicEncryptionProtobuf",
                           .product(name: "SwiftProtobuf", package: "swift-protobuf")],
            exclude: ["generated/README.md", "protobuf_module_mappings.txtpb"],
            swiftSettings: librarySettings),
        .target(
            name: "PrivateNearestNeighborSearch",
            dependencies: [
                .product(name: "Algorithms", package: "swift-algorithms"),
                "HomomorphicEncryption",
            ],
            swiftSettings: librarySettings),
        .target(
            name: "PrivateNearestNeighborSearchProtobuf",
            dependencies: ["PrivateNearestNeighborSearch",
                           "HomomorphicEncryption",
                           "HomomorphicEncryptionProtobuf",
                           .product(name: "SwiftProtobuf", package: "swift-protobuf")],
            exclude: ["generated/README.md", "protobuf_module_mappings.txtpb"],
            swiftSettings: librarySettings),
        .target(
            name: "_TestUtilities",
            dependencies: [
                "HomomorphicEncryption",
                "PrivateInformationRetrieval",
                "PrivateNearestNeighborSearch",
                .product(name: "Numerics", package: "swift-numerics"),
            ],
            path: "Sources/TestUtilities",
            swiftSettings: librarySettings),
        .executableTarget(
            name: "PIRGenerateDatabase",
            dependencies: [
                .product(name: "ArgumentParser", package: "swift-argument-parser"),
                "HomomorphicEncryption",
                "PrivateInformationRetrievalProtobuf",
            ],
            swiftSettings: executableSettings),
        .executableTarget(
            name: "PIRProcessDatabase",
            dependencies: [
                .product(name: "ArgumentParser", package: "swift-argument-parser"),
                "HomomorphicEncryptionProtobuf",
                "PrivateInformationRetrievalProtobuf",
                "HomomorphicEncryption",
                .product(name: "Logging", package: "swift-log"),
            ],
            swiftSettings: executableSettings),
        .executableTarget(
            name: "PIRShardDatabase",
            dependencies: [
                .product(name: "ArgumentParser", package: "swift-argument-parser"),
                "HomomorphicEncryption",
                "PrivateInformationRetrievalProtobuf",
            ],
            swiftSettings: executableSettings),
        .executableTarget(
            name: "PNNSGenerateDatabase",
            dependencies: [
                .product(name: "ArgumentParser", package: "swift-argument-parser"),
                "HomomorphicEncryption",
                "PrivateNearestNeighborSearchProtobuf",
            ],
            swiftSettings: executableSettings),
        .executableTarget(
            name: "PNNSProcessDatabase",
            dependencies: [
                .product(name: "ArgumentParser", package: "swift-argument-parser"),
                "HomomorphicEncryptionProtobuf",
                "PrivateNearestNeighborSearchProtobuf",
                "HomomorphicEncryption",
                .product(name: "Logging", package: "swift-log"),
            ],
            swiftSettings: executableSettings),
        .testTarget(
            name: "HomomorphicEncryptionTests",
            dependencies: [
                "HomomorphicEncryption", "_TestUtilities",
                .product(name: "Numerics", package: "swift-numerics"),
            ], swiftSettings: executableSettings),
        .testTarget(
            name: "HomomorphicEncryptionProtobufTests",
            dependencies: [
                "HomomorphicEncryption",
                "HomomorphicEncryptionProtobuf",
                "_TestUtilities",
            ], swiftSettings: executableSettings),
        .testTarget(
            name: "PIRGenerateDatabaseTests",
            dependencies: ["PIRGenerateDatabase",
                           "_TestUtilities",
                           .product(name: "Numerics", package: "swift-numerics")], swiftSettings: executableSettings),
        .testTarget(
            name: "PIRProcessDatabaseTests",
            dependencies: ["PIRProcessDatabase",
                           "_TestUtilities",
                           .product(name: "Numerics", package: "swift-numerics")], swiftSettings: executableSettings),
        .testTarget(
            name: "PrivateInformationRetrievalTests",
            dependencies: [
                "PrivateInformationRetrieval", "_TestUtilities",
                .product(name: "Numerics", package: "swift-numerics"),
            ], swiftSettings: executableSettings),
        .testTarget(
            name: "PrivateInformationRetrievalProtobufTests",
            dependencies: [
                "PrivateInformationRetrieval",
                "PrivateInformationRetrievalProtobuf",
                "_TestUtilities",
            ], swiftSettings: executableSettings),
        .testTarget(
            name: "PrivateNearestNeighborSearchTests",
            dependencies: [
                "PrivateNearestNeighborSearch", "HomomorphicEncryption", "_TestUtilities",
            ], swiftSettings: executableSettings),
        .testTarget(
            name: "PrivateNearestNeighborSearchProtobufTests",
            dependencies: [
                "PrivateNearestNeighborSearch",
                "PrivateNearestNeighborSearchProtobuf",
            ], swiftSettings: executableSettings),
    ])

// MARK: - Benchmarks

var enableBenchmarking: Bool {
    let benchmarkFlags = "SWIFT_HOMOMORPHIC_ENCRYPTION_ENABLE_BENCHMARKING"
    if let flag = ProcessInfo.processInfo.environment[benchmarkFlags], flag == "1" {
        return true
    }
    return false
}

if enableBenchmarking {
    print("Enabling benchmarking")
    package.dependencies += [
        .package(url: "https://github.com/ordo-one/package-benchmark", .upToNextMajor(from: "1.4.0")),
    ]
    package.products += [.library(name: "_BenchmarkUtilities", targets: ["_BenchmarkUtilities"])]
    package.targets += [
        .target(
            name: "_BenchmarkUtilities",
            dependencies: [
                .product(name: "Benchmark", package: "package-benchmark"),
                "HomomorphicEncryption",
                "HomomorphicEncryptionProtobuf",
                "PrivateInformationRetrieval",
                "PrivateInformationRetrievalProtobuf",
                "PrivateNearestNeighborSearch",
                "PrivateNearestNeighborSearchProtobuf",
            ],
            path: "Sources/BenchmarkUtilities",
            swiftSettings: benchmarkSettings),
        .executableTarget(
            name: "PolyBenchmark",
            dependencies: [
                .product(name: "Benchmark", package: "package-benchmark"),
                "HomomorphicEncryption",
            ],
            path: "Benchmarks/PolyBenchmark",
            swiftSettings: benchmarkSettings,
            plugins: [
                .plugin(name: "BenchmarkPlugin", package: "package-benchmark"),
            ]),
        .executableTarget(
            name: "RlweBenchmark",
            dependencies: [
                .product(name: "Benchmark", package: "package-benchmark"),
                "HomomorphicEncryption",
            ],
            path: "Benchmarks/RlweBenchmark",
            swiftSettings: benchmarkSettings,
            plugins: [
                .plugin(name: "BenchmarkPlugin", package: "package-benchmark"),
            ]),
        .executableTarget(
            name: "PIRBenchmark",
            dependencies: [
                .product(name: "Benchmark", package: "package-benchmark"),
                "HomomorphicEncryption",
                "_BenchmarkUtilities",
            ],
            path: "Benchmarks/PrivateInformationRetrievalBenchmark",
            swiftSettings: benchmarkSettings,
            plugins: [
                .plugin(name: "BenchmarkPlugin", package: "package-benchmark"),
            ]),
        .executableTarget(
            name: "PNNSBenchmark",
            dependencies: [
                .product(name: "Benchmark", package: "package-benchmark"),
                "HomomorphicEncryption",
                "_BenchmarkUtilities",
            ],
            path: "Benchmarks/PrivateNearestNeighborSearchBenchmark",
            swiftSettings: benchmarkSettings,
            plugins: [
                .plugin(name: "BenchmarkPlugin", package: "package-benchmark"),
            ]),
    ]
}

// Set the minimum macOS version for the package
#if canImport(Darwin)
package.platforms = [
    .macOS(.v15), // Constrained by UInt128 support
]
#endif