Files
swift-crypto/Sources/Crypto/Digests/HashFunctions.swift
T
a9d1d5ab89 Merge the 5.x branch for the Swift Crypto 5.0 release (#470)
## 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>
2026-09-16 14:47:34 +01:00

177 lines
6.9 KiB
Swift
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
//===----------------------------------------------------------------------===//
//
// 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
typealias DigestImpl = OpenSSLDigestImpl
typealias DigestImplSHA3 = XKCPDigestImpl
#if canImport(FoundationEssentials)
public import FoundationEssentials
#else
public import Foundation
#endif
/// A type that performs cryptographically secure hashing.
///
/// The ``HashFunction`` protocol describes an interface for computing a
/// fixed-length digest from an arbitrarily large collection of bytes. Because
/// the digest is small, you can quickly compare the digests to detect a
/// difference in two corresponding data sets. Alternatively, transmit or store
/// data with its digest to detect changes introduced after initially
/// calculating the digest.
///
/// Use one of the protocol’s adopters, like ``SHA256``, ``SHA384``, or
/// ``SHA512``, to output a digest whose value varies significantly over even
/// small differences in the input data.
///
/// Checking a digest doesn’t guard against changes made by a malicious user who
/// also changes the digest to match. To handle this, compute a message
/// authentication code (MAC) like ``HMAC`` instead. MACs rely on hashing, but
/// incorporate a secret cryptographic key into the digest computation. Only a
/// user that has the key can generate a valid MAC.
@preconcurrency
public protocol HashFunction: Sendable {
/// The number of bytes that represents the hash function’s internal state.
static var blockByteCount: Int { get }
associatedtype Digest: Crypto.Digest
/// Creates a hash function.
///
/// Initialize a new hash function by calling this method if you want to
/// hash the data iteratively, such as when you don’t have a buffer large
/// enough to hold all the data at once. Provide data blocks to the hash
/// function using the ``update(data:)`` or ``update(bufferPointer:)``
/// method. After providing all the data, call ``finalize()`` to get the
/// digest.
///
/// If your data fits into a single buffer, you can use the ``hash(data:)``
/// method instead to compute the digest in a single call.
init()
/// Incrementally updates the hash function with the contents of the buffer.
///
/// Call this method one or more times to provide data to the hash function
/// in blocks. After providing the last block of data, call the
/// ``finalize()`` method to get the computed digest. Don’t call the update
/// method again after finalizing the hash function.
///
/// - Note: Typically, it’s safer to use an instance of
/// <doc://com.apple.documentation/documentation/foundation/data>, or some
/// other type that conforms to the
/// <doc://com.apple.documentation/documentation/foundation/dataprotocol>,
/// to hold your data. When possible, use the ``HashFunction/update(data:)``
/// method instead.
///
/// - Parameters:
/// - bufferPointer: A pointer to the next block of data for the ongoing
/// digest calculation.
mutating func update(bufferPointer: UnsafeRawBufferPointer)
/// Finalizes the hash function and returns the computed digest.
///
/// Call this method after you provide the hash function with all the data
/// to hash using one or more calls to the ``update(data:)`` or
/// ``update(bufferPointer:)`` method. After finalizing the hash function,
/// discard it. To compute a new digest, create a new hash function with a
/// call to the ``init()`` method.
///
/// - Returns: The computed digest of the data.
func finalize() -> Digest
}
extension HashFunction {
@inlinable
public mutating func update(bytes: RawSpan) {
bytes.withUnsafeBytes {
self.update(bufferPointer: $0)
}
}
}
extension HashFunction {
/// Computes a digest of the buffer.
///
/// - Parameters:
/// - bufferPointer: The buffer to be hashed.
/// - Returns: The computed digest.
@inlinable
static func hash(bufferPointer: UnsafeRawBufferPointer) -> Digest {
var hasher = Self()
hasher.update(bufferPointer: bufferPointer)
return hasher.finalize()
}
/// Computes a digest of a span of bytes.
///
/// - Parameters:
/// - bytes: The bytes to be hashed.
/// - Returns: The computed digest.
@inlinable
public static func hash(bytes: RawSpan) -> Digest {
var hasher = Self()
hasher.update(bytes: bytes)
return hasher.finalize()
}
/// Computes the digest of the bytes in the given data instance and
/// returns the computed digest.
///
/// Use this method if all your data fits into a single data instance. If
/// the data you want to hash is too large, initialize a hash function and
/// use the ``update(data:)`` and ``finalize()`` methods to compute the
/// digest in blocks.
///
/// - Parameters:
/// - data: The data whose digest the hash function should compute. This can
/// be any type that conforms to
/// <doc://com.apple.documentation/documentation/foundation/dataprotocol>,
/// like <doc://com.apple.documentation/documentation/foundation/data> or an
/// array of <doc://com.apple.documentation/documentation/swift/uint8>
/// instances.
///
/// - Returns: The computed digest of the data.
@inlinable
public static func hash<D: DataProtocol>(data: D) -> Self.Digest {
var hasher = Self()
hasher.update(data: data)
return hasher.finalize()
}
/// Incrementally updates the hash function with the given data.
///
/// Call this method one or more times to provide data to the hash function
/// in blocks. After providing the last block of data, call the
/// ``finalize()`` method to get the computed digest. Don’t call the update
/// method again after finalizing the hash function.
///
/// - Parameters:
/// - data: The next block of data for the ongoing digest calculation. You
/// can provide this as any type that conforms to
/// <doc://com.apple.documentation/documentation/foundation/dataprotocol>,
/// like <doc://com.apple.documentation/documentation/foundation/data> or an
/// array of <doc://com.apple.documentation/documentation/swift/uint8>
/// instances.
@inlinable
public mutating func update<D: DataProtocol>(data: D) {
data.regions.forEach { (regionData) in
regionData.withUnsafeBytes({ (dataPtr) in
self.update(bufferPointer: dataPtr)
})
}
}
}
#endif // canImport(CryptoKit)