mirror of
https://github.com/apple/swift-crypto
synced 2026-11-22 04:30:39 +00:00
### Motivation: The comment we have in our package manifest was a bit ambiguous about Foundation linking and caused some confusion (reported in #496). As discussed on that issue, I don't think there's anything we want to do differently here, but we can try and improve the comment so other adopters don't waste time on a misunderstanding. ### Modifications: Clarify the privacy manifest comment in the package manifest. ### Result: Fixes #496.
245 lines
9.8 KiB
Swift
245 lines
9.8 KiB
Swift
// swift-tools-version:6.2
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the SwiftCrypto open source project
|
|
//
|
|
// Copyright (c) 2019-2023 Apple Inc. and the SwiftCrypto project authors
|
|
// Licensed under Apache License v2.0
|
|
//
|
|
// See LICENSE.txt for license information
|
|
// See CONTRIBUTORS.txt for the list of SwiftCrypto project authors
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// This package contains a vendored copy of BoringSSL. For ease of tracking
|
|
// down problems with the copy of BoringSSL in use, we include a copy of the
|
|
// commit hash of the revision of BoringSSL included in the given release.
|
|
// This is also reproduced in a file called hash.txt in the
|
|
// Sources/CCryptoBoringSSL directory. The source repository is at
|
|
// https://boringssl.googlesource.com/boringssl.
|
|
//
|
|
// BoringSSL Commit: 0226f30467f540a3f62ef48d453f93927da199b6
|
|
|
|
import PackageDescription
|
|
|
|
import class Foundation.ProcessInfo
|
|
|
|
// NOTE: To develop the the non-Darwin Crypto target on macOS, use a Dev Container.
|
|
let nonDarwinPlatforms: [Platform] = [
|
|
.linux,
|
|
.android,
|
|
.windows,
|
|
.wasi,
|
|
.openbsd,
|
|
// The SwiftPM Platform symbol is not yet public but the underlying platform name is set.
|
|
// -- https://github.com/swiftlang/swift-package-manager/blob/swift-6.2.3-RELEASE/Sources/PackageDescription/SupportedPlatforms.swift#L75
|
|
.custom("freebsd"),
|
|
]
|
|
|
|
var swiftSettings: [SwiftSetting] = [
|
|
.define("CRYPTO_IN_SWIFTPM"),
|
|
.enableExperimentalFeature("Lifetimes"),
|
|
.enableExperimentalFeature("SourceWarningControl"),
|
|
]
|
|
|
|
// Only enable CheckImplementationOnly on 6.4 -- 6.3 has the feature, but produces many false positives.
|
|
#if compiler(>=6.4)
|
|
swiftSettings.append(.enableExperimentalFeature("CheckImplementationOnly"))
|
|
#endif
|
|
|
|
// A resource makes SwiftPM generate a `Bundle.module` accessor that imports Foundation, not just FoundationEssentials.
|
|
// `canImport(Darwin)` checks the host, not the target, so cross-compiling from Darwin still adds the resource.
|
|
#if canImport(Darwin)
|
|
let privacyManifestExclude: [String] = []
|
|
let privacyManifestResource: [PackageDescription.Resource] = [.copy("PrivacyInfo.xcprivacy")]
|
|
#else
|
|
// Exclude on other platforms to avoid build warnings.
|
|
let privacyManifestExclude: [String] = ["PrivacyInfo.xcprivacy"]
|
|
let privacyManifestResource: [PackageDescription.Resource] = []
|
|
#endif
|
|
|
|
let package = Package(
|
|
name: "swift-crypto",
|
|
products: [
|
|
.library(name: "Crypto", targets: ["Crypto"]),
|
|
// Kept for backward compatibility
|
|
.library(name: "_CryptoExtras", targets: ["_CryptoExtras"]),
|
|
.library(name: "CryptoExtras", targets: ["CryptoExtras"]),
|
|
/* This target is used only for symbol mangling. It's added and removed automatically because it emits build warnings. MANGLE_START
|
|
.library(name: "CCryptoBoringSSL", type: .static, targets: ["CCryptoBoringSSL"]),
|
|
MANGLE_END */
|
|
],
|
|
dependencies: [
|
|
// Dependencies are added below so that they can be switched between local and absolute URLs
|
|
],
|
|
targets: [
|
|
.target(
|
|
name: "CCryptoBoringSSL",
|
|
exclude: privacyManifestExclude + [
|
|
"hash.txt",
|
|
"CMakeLists.txt",
|
|
/*
|
|
* These files are excluded to support WASI libc which doesn't provide <netdb.h>.
|
|
* This is safe for all platforms as we do not rely on networking features.
|
|
*/
|
|
"crypto/bio/connect.cc",
|
|
"crypto/bio/socket_helper.cc",
|
|
"crypto/bio/socket.cc",
|
|
],
|
|
resources: privacyManifestResource,
|
|
cSettings: [
|
|
// These defines come from BoringSSL's build system
|
|
.define("_HAS_EXCEPTIONS", to: "0", .when(platforms: [Platform.windows])),
|
|
.define("WIN32_LEAN_AND_MEAN", .when(platforms: [Platform.windows])),
|
|
.define("NOMINMAX", .when(platforms: [Platform.windows])),
|
|
.define("_CRT_SECURE_NO_WARNINGS", .when(platforms: [Platform.windows])),
|
|
/*
|
|
* These defines are required on Wasm/WASI, to disable use of pthread.
|
|
*/
|
|
.define(
|
|
"OPENSSL_NO_THREADS_CORRUPT_MEMORY_AND_LEAK_SECRETS_IF_THREADED",
|
|
.when(platforms: [Platform.wasi])
|
|
),
|
|
.define("OPENSSL_NO_ASM", .when(platforms: [Platform.wasi])),
|
|
// BoringSSL is vendored verbatim; we don't fix its warnings. Xcode enables
|
|
// -Wshorten-64-to-32 by default (SwiftPM does not), which produces dozens
|
|
// of warnings. Silence that group here.
|
|
.disableWarning("shorten-64-to-32"),
|
|
]
|
|
),
|
|
.target(
|
|
name: "CXKCP",
|
|
exclude: [
|
|
"CMakeLists.txt"
|
|
],
|
|
cSettings: [
|
|
.define("XKCP_has_KeccakP1600"),
|
|
.headerSearchPath("include"),
|
|
.headerSearchPath("high"),
|
|
.headerSearchPath("low"),
|
|
.headerSearchPath("low/KeccakP-1600"),
|
|
.headerSearchPath("low/common"),
|
|
.headerSearchPath("common"),
|
|
.disableWarning("macro-redefined"),
|
|
]
|
|
),
|
|
.target(
|
|
name: "CXKCPShims",
|
|
dependencies: ["CXKCP"],
|
|
exclude: privacyManifestExclude + [
|
|
"CMakeLists.txt"
|
|
],
|
|
resources: privacyManifestResource
|
|
),
|
|
.target(
|
|
name: "Crypto",
|
|
dependencies: [
|
|
.target(name: "CCryptoBoringSSL", condition: .when(platforms: nonDarwinPlatforms)),
|
|
.target(name: "CryptoBoringWrapper", condition: .when(platforms: nonDarwinPlatforms)),
|
|
.target(name: "CXKCP", condition: .when(platforms: nonDarwinPlatforms)),
|
|
.target(name: "CXKCPShims", condition: .when(platforms: nonDarwinPlatforms)),
|
|
],
|
|
exclude: privacyManifestExclude + [
|
|
"vendored-sources.txt",
|
|
"CMakeLists.txt",
|
|
"Signatures/BoringSSL/MLDSA_boring.swift.gyb",
|
|
"KEM/BoringSSL/MLKEM_boring.swift.gyb",
|
|
],
|
|
resources: privacyManifestResource,
|
|
swiftSettings: swiftSettings
|
|
),
|
|
.target(
|
|
name: "CryptoExtras",
|
|
dependencies: [
|
|
"CCryptoBoringSSL",
|
|
"CryptoBoringWrapper",
|
|
"Crypto",
|
|
.product(name: "SwiftASN1", package: "swift-asn1"),
|
|
],
|
|
exclude: privacyManifestExclude + [
|
|
"CMakeLists.txt"
|
|
],
|
|
resources: privacyManifestResource,
|
|
swiftSettings: swiftSettings
|
|
),
|
|
.target(
|
|
name: "_CryptoExtras",
|
|
dependencies: [
|
|
"CryptoExtras",
|
|
],
|
|
swiftSettings: swiftSettings
|
|
),
|
|
.target(
|
|
name: "CryptoBoringWrapper",
|
|
dependencies: [
|
|
"CCryptoBoringSSL",
|
|
],
|
|
exclude: privacyManifestExclude + [
|
|
"CMakeLists.txt"
|
|
],
|
|
resources: privacyManifestResource,
|
|
swiftSettings: swiftSettings
|
|
),
|
|
.executableTarget(name: "crypto-shasum", dependencies: ["Crypto"]),
|
|
.testTarget(
|
|
name: "CryptoTests",
|
|
dependencies: ["Crypto"],
|
|
resources: [
|
|
.copy("HPKE/hpke-test-vectors.json"),
|
|
.copy("KEM/MLKEM768_BSSLKAT.json"),
|
|
.copy("KEM/MLKEM768KAT.json"),
|
|
.copy("KEM/MLKEM1024_BSSLKAT.json"),
|
|
.copy("KEM/MLKEM1024KAT.json"),
|
|
.copy("KEM/test-vectors.json"),
|
|
.copy("Signatures/MLDSA/MLDSA65_KeyGen_KAT.json"),
|
|
.copy("Signatures/MLDSA/MLDSA87_KeyGen_KAT.json"),
|
|
],
|
|
swiftSettings: swiftSettings
|
|
),
|
|
.testTarget(
|
|
name: "CryptoExtrasTests",
|
|
dependencies: ["CryptoExtras"],
|
|
resources: [
|
|
.copy("ECToolbox/H2CVectors/P256_XMD-SHA-256_SSWU_RO_.json"),
|
|
.copy("ECToolbox/H2CVectors/P384_XMD-SHA-384_SSWU_RO_.json"),
|
|
.copy("OPRFs/OPRFVectors/OPRFVectors-VOPRFDraft8.json"),
|
|
.copy("OPRFs/OPRFVectors/OPRFVectors-VOPRFDraft19.json"),
|
|
.copy("OPRFs/OPRFVectors/OPRFVectors-edgecases.json"),
|
|
],
|
|
swiftSettings: swiftSettings
|
|
),
|
|
.testTarget(name: "CryptoBoringWrapperTests", dependencies: ["CryptoBoringWrapper"]),
|
|
.testTarget(name: "CXKCPTests", dependencies: ["CXKCP"]),
|
|
],
|
|
cxxLanguageStandard: .cxx17
|
|
)
|
|
|
|
// Switch between local and remote dependencies depending on an environment variable
|
|
if ProcessInfo.processInfo.environment["SWIFTCI_USE_LOCAL_DEPS"] == nil {
|
|
package.dependencies += [
|
|
.package(url: "https://github.com/apple/swift-asn1.git", from: "1.2.0")
|
|
]
|
|
} else {
|
|
package.dependencies += [
|
|
.package(path: "../swift-asn1")
|
|
]
|
|
}
|
|
|
|
// --- STANDARD CROSS-REPO SETTINGS DO NOT EDIT --- //
|
|
for target in package.targets {
|
|
switch target.type {
|
|
case .regular, .test, .executable:
|
|
var settings = target.swiftSettings ?? []
|
|
// https://github.com/swiftlang/swift-evolution/blob/main/proposals/0444-member-import-visibility.md
|
|
settings.append(.enableUpcomingFeature("MemberImportVisibility"))
|
|
target.swiftSettings = settings
|
|
case .macro, .plugin, .system, .binary:
|
|
() // not applicable
|
|
@unknown default:
|
|
() // we don't know what to do here, do nothing
|
|
}
|
|
}
|
|
// --- END: STANDARD CROSS-REPO SETTINGS DO NOT EDIT --- //
|