mirror of
https://github.com/apple/swift-crypto
synced 2026-11-22 04:30:39 +00:00
## Motivation Xcode 27 is now available[^1] so it's time to merge in our 5.x branch to main and release 5.0. ## Modifications See "Release Notes" section below for overview of changes and links to the PRs that landed on the 5.x branch during the beta period. ## Result The main branch will be ready to tag a 5.0 release. [^1]: https://developer.apple.com/download/all/?q=Xcode%2027 --- ## Release Notes Swift Crypto 5.0 aligns the cross-platform API surface with CryptoKit as shipped in Xcode 27 (CryptoKit-383.2.1), and takes the opportunity to streamline the package for both adopters and maintainers. Most users will be able to depend on the 1.0.0, 2.0.0, 3.0.0, 4.0.0, or 5.0.0 series of releases. To do so, please use the following dependency in your `Package.swift`: ```swift .package(url: "https://github.com/apple/swift-crypto.git", "1.0.0" ..< "6.0.0"), ``` ### Requires Swift 6.2 The package now declares 6.2 as the minimum Swift version in its package manifest. ### New span-based API CryptoKit's new non-allocating, span-based entry points are now available cross-platform: - `SymmetricKey` gains `bytes: RawSpan`, `init(copying: RawSpan)`, `init(copyingWithZeroing: inout MutableRawSpan)`, and `init(size:initializingWith:)` which initializes the key through an `inout OutputRawSpan`. - `HashFunction` gains `update(bytes: RawSpan)` and `hash(bytes: RawSpan)`, and `Digest` gains `init?(copying: RawSpan)`. - `HMAC` gains `authenticationCode(for: RawSpan, using:)`. - `HKDF` gains `deriveKey(inputKeyMaterial:salt:info:output:)` writing into an `inout OutputRawSpan`, along with span-based `extract` and `expand`. The existing `DataProtocol` overload now has a fast path for contiguous salt and info. - `AES.GCM` and `ChaChaPoly` gain in-place `seal(inPlace:using:nonce:authenticating:tag:)` and `open(inPlace:using:nonce:authenticating:tag:)` over `MutableRawSpan`, and their `Nonce` types gain `bytes: RawSpan` and `init(copying: RawSpan)`. ### Single-use KEM keys A new `KEMOneTimePrivateKey` protocol, refining `~Copyable` and `Sendable`, provides a `consuming func decapsulate(_:)` so a decapsulation key cannot be reused. Conforming types are `MLKEM768.OneTimePrivateKey`, `MLKEM1024.OneTimePrivateKey`, and `XWingMLKEM768X25519.OneTimePrivateKey`. ### Extensible enums Historically Swift Crypto needed a new major version each time CryptoKit added a case to a non-frozen enum, because Swift Crypto is not built with library evolution. All public non-frozen enums are now marked `@nonexhaustive` (SE-0487), which should remove that reason for future major bumps. Adopters who do not switch over these enums should not need to widen their version constraints again. ### Other changes - Symbols that were previously marked `@_spi(...) public` have been made internal; they were never intended to be available. - `@available` annotations have been removed from `Crypto`; they are unused in all supported compilation modes. - Some internal reference types are now marked `final` - Some unused code, e.g. `ECDSASignature.derBytes`, is removed. ### Build and packaging - The `CCryptoBoringSSLShims` target is removed, along with all `bindMemory(to:)` calls. - The `.gyb` templates for nonces, digests, ECDH, ECDSA, MLDSA, and MLKEM are removed and the generated Swift is checked in. The BoringSSL backend templates for MLDSA and MLKEM remain. - Conditional compilation is simplified to `#if canImport(CryptoKit)`; branches that could never be taken are gone. - Developing the BoringSSL backend on macOS is no longer supported. Use the Dev Container configuration now shipped in the repository, or build on the target platform. - Warnings are silenced for vendored C sources: `-Wshorten-64-to-32` for BoringSSL and `macro-redefined` for XKCP. CI builds with `-warnings-as-errors`. ### Commits The changes in this release were reviewed and merged to the 5.x branch during the beta period: -0a26a9e3[5.x] Align with CryptoKit APIs from Xcode 27 beta 1 (#442) -8ee9962f[5.x] Align with CryptoKit APIs from Xcode 27 beta 2 (#444) -ce8db476[5.x] Align with CryptoKit APIs from Xcode 27 beta 4 (#453) -15b0fb5b[5.x] Adopt CheckImplementationOnly and CI with -warnings-as-errors (#454) -b3746b14[5.x] Remove bindMemory(to:) calls and the CCryptoBoringSSLShims target (#455) -57782dc6[5.x] Remove duplicate imports from gyb-generated MLDSA backend code (#458) -2c45ca2f[5.x] Remove unused internal code path: ECDSASignature.derBytes (#457) -33785f67[5.x] Mark some class types as final (#456) -2e074efb[5.x] Remove native SwiftPM build-system workaround in CI (#461) -20f90497[5.x] Align with CryptoKit from Xcode 27 beta 6 (#462) --------- Co-authored-by: Dmitry <45711841+darkdi@users.noreply.github.com> Co-authored-by: Cory Benfield <lukasa@apple.com>
103 lines
2.9 KiB
Swift
103 lines
2.9 KiB
Swift
//===----------------------------------------------------------------------===//
|
||
//
|
||
// This source file is part of the SwiftCrypto open source project
|
||
//
|
||
// Copyright (c) 2019-2020 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
|
||
//
|
||
//===----------------------------------------------------------------------===//
|
||
|
||
#if canImport(CryptoKit)
|
||
@_exported import CryptoKit
|
||
#else
|
||
|
||
#if canImport(FoundationEssentials)
|
||
public import FoundationEssentials
|
||
#else
|
||
public import Foundation
|
||
#endif
|
||
|
||
#if hasFeature(Embedded)
|
||
/// A type that represents the output of a hash.
|
||
@preconcurrency
|
||
public protocol Digest: Hashable, Sendable, ContiguousBytes, Sequence where Element == UInt8 {
|
||
/// The number of bytes in the digest.
|
||
static var byteCount: Int { get }
|
||
}
|
||
#else
|
||
/// A type that represents the output of a hash.
|
||
@preconcurrency
|
||
public protocol Digest: Hashable, Sendable, ContiguousBytes, CustomStringConvertible, Sequence where Element == UInt8 {
|
||
/// The number of bytes in the digest.
|
||
static var byteCount: Int { get }
|
||
}
|
||
#endif // hasFeature(Embedded)
|
||
|
||
protocol DigestPrivate: Digest {
|
||
init?(initializingWith body: (inout OutputRawSpan) -> ())
|
||
}
|
||
|
||
extension DigestPrivate {
|
||
@inlinable
|
||
init?(copying bytes: RawSpan) {
|
||
self.init() {
|
||
$0.append(contentsOf: bytes)
|
||
}
|
||
}
|
||
}
|
||
|
||
extension Digest {
|
||
public func makeIterator() -> Array<UInt8>.Iterator {
|
||
self.withUnsafeBytes({ (buffPtr) in
|
||
return Array(buffPtr).makeIterator()
|
||
})
|
||
}
|
||
}
|
||
|
||
// We want to implement constant-time comparison for digests.
|
||
extension Digest {
|
||
/// Determines whether two digests are equal.
|
||
///
|
||
/// - Parameters:
|
||
/// - lhs: The first digest to compare.
|
||
/// - rhs: The second digest to compare.
|
||
///
|
||
/// - Returns: A Boolean value set to `true` if the two digests are equal.
|
||
public static func == (lhs: Self, rhs: Self) -> Bool {
|
||
return safeCompare(lhs, rhs)
|
||
}
|
||
|
||
/// Determines whether a digest is equivalent to a collection of contiguous
|
||
/// bytes.
|
||
///
|
||
/// - Parameters:
|
||
/// - lhs: A digest to compare.
|
||
/// - rhs: A collection of contiguous bytes to compare.
|
||
///
|
||
/// - Returns: A Boolean value that’s `true` if the digest is equivalent to
|
||
/// the collection of binary data.
|
||
public static func == <D: DataProtocol>(lhs: Self, rhs: D) -> Bool {
|
||
if rhs.regions.count != 1 {
|
||
let rhsContiguous = Data(rhs)
|
||
return safeCompare(lhs, rhsContiguous)
|
||
} else {
|
||
return safeCompare(lhs, rhs.regions.first!)
|
||
}
|
||
}
|
||
}
|
||
|
||
#if !hasFeature(Embedded)
|
||
extension Digest {
|
||
public var description: String {
|
||
return "\(Self.self): \(Array(self).hexString)"
|
||
}
|
||
}
|
||
#endif
|
||
|
||
#endif // canImport(CryptoKit)
|