mirror of
https://github.com/apple/swift-crypto
synced 2026-11-22 04:30:39 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
334e682869 | ||
|
|
c68a7a7c7f | ||
|
|
8c9d27a339 |
No files matched your search
@@ -25,6 +25,15 @@ jobs:
|
||||
windows_nightly_next_arguments_override: "--explicit-target-dependency-import-check error"
|
||||
windows_nightly_main_arguments_override: "--explicit-target-dependency-import-check error"
|
||||
|
||||
release-builds:
|
||||
name: Release builds
|
||||
uses: apple/swift-nio/.github/workflows/release_builds.yml@main
|
||||
with:
|
||||
windows_6_0_enabled: true
|
||||
windows_6_1_enabled: true
|
||||
windows_nightly_next_enabled: true
|
||||
windows_nightly_main_enabled: true
|
||||
|
||||
cxx-interop:
|
||||
name: Cxx interop
|
||||
uses: apple/swift-nio/.github/workflows/cxx_interop.yml@main
|
||||
|
||||
@@ -30,6 +30,15 @@ jobs:
|
||||
windows_nightly_next_arguments_override: "--explicit-target-dependency-import-check error"
|
||||
windows_nightly_main_arguments_override: "--explicit-target-dependency-import-check error"
|
||||
|
||||
release-builds:
|
||||
name: Release builds
|
||||
uses: apple/swift-nio/.github/workflows/release_builds.yml@main
|
||||
with:
|
||||
windows_6_0_enabled: true
|
||||
windows_6_1_enabled: true
|
||||
windows_nightly_next_enabled: true
|
||||
windows_nightly_main_enabled: true
|
||||
|
||||
cxx-interop:
|
||||
name: Cxx interop
|
||||
uses: apple/swift-nio/.github/workflows/cxx_interop.yml@main
|
||||
|
||||
@@ -147,8 +147,9 @@ extension AES {
|
||||
extension AES._CBC {
|
||||
/// An initialization vector.
|
||||
@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, macCatalyst 13, visionOS 1.0, *)
|
||||
public struct IV: Sendable {
|
||||
public struct IV: Sendable, Sequence {
|
||||
// AES CBC uses a 128-bit IV.
|
||||
@usableFromInline
|
||||
var ivBytes: (
|
||||
UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8,
|
||||
UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8, UInt8
|
||||
@@ -193,6 +194,13 @@ extension AES._CBC {
|
||||
bytesPtr.copyBytes(from: ivBytes)
|
||||
}
|
||||
}
|
||||
|
||||
@inlinable
|
||||
public func makeIterator() -> some IteratorProtocol<UInt8> {
|
||||
withUnsafeBytes(of: ivBytes) { unsafeRawBufferPointer in
|
||||
Array(unsafeRawBufferPointer).makeIterator()
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,200 @@
|
||||
//===----------------------------------------------------------------------===//
|
||||
//
|
||||
// This source file is part of the SwiftCrypto open source project
|
||||
//
|
||||
// Copyright (c) 2025 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
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
@_implementationOnly import CCryptoBoringSSL
|
||||
import Crypto
|
||||
|
||||
#if canImport(FoundationEssentials)
|
||||
import FoundationEssentials
|
||||
#else
|
||||
import Foundation
|
||||
#endif
|
||||
|
||||
@available(iOS 13.0, macOS 10.15, watchOS 6.0, tvOS 13.0, *)
|
||||
extension AES {
|
||||
/// A cipher-based message authentication code.
|
||||
///
|
||||
/// CMAC uses AES to implement a MAC. CMAC is useful in contexts where access to
|
||||
/// a hash function is not guaranteed, but a block cipher will be available.
|
||||
public struct CMAC: @unchecked Sendable {
|
||||
// Unchecked sendable because this is CoW.
|
||||
fileprivate var backing: Backing
|
||||
|
||||
/// Creates a message authentication code generator.
|
||||
///
|
||||
/// Defaults the output size to 128 bits.
|
||||
///
|
||||
/// - Parameters:
|
||||
/// - key: The symmetric key used to secure the computation.
|
||||
public init(key: SymmetricKey) throws {
|
||||
try self.init(key: key, outputSize: 16)
|
||||
}
|
||||
|
||||
/// Creates a message authentication code generator.
|
||||
///
|
||||
/// - Parameters:
|
||||
/// - key: The symmetric key used to secure the computation.
|
||||
/// - outputSize: The number of bytes of MAC to generate. Must be in the range 0 to 16 inclusive.
|
||||
public init(key: SymmetricKey, outputSize: Int) throws {
|
||||
guard [128, 192, 256].contains(key.bitCount) else {
|
||||
throw CryptoError.incorrectKeySize
|
||||
}
|
||||
guard (0...16).contains(outputSize) else {
|
||||
throw CryptoKitError.incorrectParameterSize
|
||||
}
|
||||
|
||||
self.backing = Backing(key: key, outputSize: outputSize)
|
||||
}
|
||||
|
||||
/// Adds data to be authenticated by MAC function. This can be called one or more times to append additional data.
|
||||
///
|
||||
/// - Parameters:
|
||||
/// - bufferPointer: The data to be authenticated.
|
||||
public mutating func update(bufferPointer: UnsafeRawBufferPointer) {
|
||||
self.cowIfNeeded()
|
||||
self.backing.update(bufferPointer)
|
||||
}
|
||||
|
||||
/// Finalizes the message authentication computation and returns the
|
||||
/// computed code.
|
||||
///
|
||||
/// - Returns: The message authentication code.
|
||||
public consuming func finalize() -> AES.CMAC.MAC {
|
||||
// The combination of "consuming" and "cowifneeded" should
|
||||
// produce an environment where, if users may choose to
|
||||
// keep using the MAC, they can, but if they aren't we'll
|
||||
// avoid an unnecessary CoW.
|
||||
self.cowIfNeeded()
|
||||
return self.backing.finalize()
|
||||
}
|
||||
|
||||
/// Updates the MAC with data.
|
||||
///
|
||||
/// - Parameter data: The data to update the MAC
|
||||
public mutating func update<D: DataProtocol>(data: D) {
|
||||
for memoryRegion in data.regions {
|
||||
memoryRegion.withUnsafeBytes { bp in
|
||||
self.update(bufferPointer: bp)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private mutating func cowIfNeeded() {
|
||||
if !isKnownUniquelyReferenced(&self.backing) {
|
||||
self.backing = Backing(copying: self.backing)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@available(iOS 13.0, macOS 10.15, watchOS 6.0, tvOS 13.0, *)
|
||||
extension AES.CMAC {
|
||||
/// A cipher-based message authentication code.
|
||||
public struct MAC: MessageAuthenticationCode {
|
||||
fileprivate let underlyingData: Data
|
||||
|
||||
init(underlyingData: Data) {
|
||||
self.underlyingData = underlyingData
|
||||
}
|
||||
|
||||
/// The number of bytes in the message authentication code.
|
||||
public var byteCount: Int {
|
||||
self.underlyingData.count
|
||||
}
|
||||
|
||||
/// Invokes the given closure with a buffer pointer covering the raw bytes
|
||||
/// of the code.
|
||||
///
|
||||
/// - Parameters:
|
||||
/// - body: A closure that takes a raw buffer pointer to the bytes of the
|
||||
/// code.
|
||||
public func withUnsafeBytes<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R {
|
||||
try self.underlyingData.withUnsafeBytes(body)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@available(iOS 13.0, macOS 10.15, watchOS 6.0, tvOS 13.0, *)
|
||||
extension AES.CMAC {
|
||||
fileprivate final class Backing {
|
||||
private let key: SymmetricKey
|
||||
private let context: OpaquePointer
|
||||
private let outputSize: Int
|
||||
|
||||
init(key: SymmetricKey, outputSize: Int) {
|
||||
self.key = key
|
||||
self.context = CCryptoBoringSSL_CMAC_CTX_new()
|
||||
self.outputSize = outputSize
|
||||
|
||||
let rc = self.key.withUnsafeBytes { keyPtr in
|
||||
CCryptoBoringSSL_CMAC_Init(
|
||||
self.context,
|
||||
keyPtr.baseAddress,
|
||||
keyPtr.count,
|
||||
key.aesEVP,
|
||||
nil
|
||||
)
|
||||
}
|
||||
precondition(rc == 1)
|
||||
}
|
||||
|
||||
init(copying other: Backing) {
|
||||
self.key = other.key
|
||||
self.context = CCryptoBoringSSL_CMAC_CTX_new()
|
||||
self.outputSize = other.outputSize
|
||||
let rc = CCryptoBoringSSL_CMAC_CTX_copy(self.context, other.context)
|
||||
precondition(rc == 1)
|
||||
|
||||
// Ensure we don't lose `other` at this time.
|
||||
withExtendedLifetime(other) {}
|
||||
}
|
||||
|
||||
deinit {
|
||||
CCryptoBoringSSL_CMAC_CTX_free(self.context)
|
||||
}
|
||||
|
||||
func update(_ bytes: UnsafeRawBufferPointer) {
|
||||
let rc = CCryptoBoringSSL_CMAC_Update(self.context, bytes.baseAddress, bytes.count)
|
||||
precondition(rc == 1)
|
||||
}
|
||||
|
||||
func finalize() -> AES.CMAC.MAC {
|
||||
let bytes = withUnsafeTemporaryAllocation(byteCount: 16, alignment: 1) { bytes in
|
||||
precondition(bytes.count >= 16)
|
||||
var count = 16
|
||||
let rc = CCryptoBoringSSL_CMAC_Final(self.context, bytes.baseAddress, &count)
|
||||
precondition(count == 16)
|
||||
precondition(rc == 1)
|
||||
|
||||
return Data(UnsafeRawBufferPointer(rebasing: bytes.prefix(self.outputSize)))
|
||||
}
|
||||
return AES.CMAC.MAC(underlyingData: bytes)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@available(iOS 13.0, macOS 10.15, watchOS 6.0, tvOS 13.0, *)
|
||||
extension SymmetricKey {
|
||||
fileprivate var aesEVP: OpaquePointer {
|
||||
switch self.bitCount {
|
||||
case 128:
|
||||
CCryptoBoringSSL_EVP_aes_128_cbc()
|
||||
case 192:
|
||||
CCryptoBoringSSL_EVP_aes_192_cbc()
|
||||
case 256:
|
||||
CCryptoBoringSSL_EVP_aes_256_cbc()
|
||||
default:
|
||||
fatalError("Should be unreachable")
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -21,6 +21,7 @@ add_library(_CryptoExtras
|
||||
"AES/BoringSSL/AES_CFB_boring.swift"
|
||||
"AES/BoringSSL/AES_CTR_boring.swift"
|
||||
"AES/BoringSSL/AES_GCM_SIV_boring.swift"
|
||||
"AES/CMAC.swift"
|
||||
"ARC/ARC+API.swift"
|
||||
"ARC/ARC.swift"
|
||||
"ARC/ARCCredential.swift"
|
||||
|
||||
@@ -158,6 +158,14 @@ final class CBCTests: XCTestCase {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testToDataConversion() throws {
|
||||
let randomBytes = (0..<16).map { _ in UInt8.random(in: UInt8.min...UInt8.max) }
|
||||
let dataIn = Data(randomBytes)
|
||||
let iv = try AES._CBC.IV(ivBytes: dataIn)
|
||||
let dataOut = Data(iv)
|
||||
XCTAssertEqual(dataIn, dataOut)
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,197 @@
|
||||
//===----------------------------------------------------------------------===//
|
||||
//
|
||||
// This source file is part of the SwiftCrypto open source project
|
||||
//
|
||||
// Copyright (c) 2025 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
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
import Crypto
|
||||
import Foundation
|
||||
import XCTest
|
||||
import _CryptoExtras
|
||||
|
||||
final class CMACTests: XCTestCase {
|
||||
// Borrowed from CryptoKit
|
||||
func testVector1() throws {
|
||||
let key = try Array(hexString: "a60269f095ad3c3bafae907c6f215de0")
|
||||
let mac = try Array(hexString: "172084c3fe99fde4af29aa8e6e5fe1")
|
||||
let msg = try Array(hexString: "cead1c5af16ca89bc0821775f8cba8c25620a03dfd27d6f1186f75f1c0bcfe4a20")
|
||||
|
||||
var authenticator = try AES.CMAC(key: SymmetricKey(data: key), outputSize: 15)
|
||||
authenticator.update(data: msg)
|
||||
XCTAssert(authenticator.finalize() == mac)
|
||||
}
|
||||
|
||||
// rfc4493 example vectors
|
||||
// https://datatracker.ietf.org/doc/html/rfc4493#page-11
|
||||
let exampleVector1 = ""
|
||||
|
||||
let exampleVector2 = """
|
||||
6bc1bee22e409f96e93d7e117393172a
|
||||
"""
|
||||
|
||||
let exampleVector3 = """
|
||||
6bc1bee22e409f96e93d7e117393172a\
|
||||
ae2d8a571e03ac9c9eb76fac45af8e51\
|
||||
30c81c46a35ce411
|
||||
"""
|
||||
|
||||
let exampleVector4 = """
|
||||
6bc1bee22e409f96e93d7e117393172a\
|
||||
ae2d8a571e03ac9c9eb76fac45af8e51\
|
||||
30c81c46a35ce411e5fbc1191a0a52ef\
|
||||
f69f2445df4f9b17ad2b417be66c3710
|
||||
"""
|
||||
|
||||
func testExampleVector1() throws {
|
||||
let key = try Array(hexString: "2b7e151628aed2a6abf7158809cf4f3c")
|
||||
let mac = try Array(hexString: "bb1d6929e95937287fa37d129b756746")
|
||||
let msg = try Array(hexString: exampleVector1)
|
||||
|
||||
var authenticator = try AES.CMAC(key: SymmetricKey(data: key), outputSize: 16)
|
||||
authenticator.update(data: msg)
|
||||
XCTAssert(authenticator.finalize() == mac)
|
||||
}
|
||||
|
||||
func testExampleVector2() throws {
|
||||
let key = try Array(hexString: "2b7e151628aed2a6abf7158809cf4f3c")
|
||||
let mac = try Array(hexString: "070a16b46b4d4144f79bdd9dd04a287c")
|
||||
let msg = try Array(hexString: exampleVector2)
|
||||
|
||||
var authenticator = try AES.CMAC(key: SymmetricKey(data: key), outputSize: 16)
|
||||
authenticator.update(data: msg)
|
||||
XCTAssert(authenticator.finalize() == mac)
|
||||
}
|
||||
|
||||
func testExampleVector2PerByte() throws {
|
||||
let key = try Array(hexString: "2b7e151628aed2a6abf7158809cf4f3c")
|
||||
let mac = try Array(hexString: "070a16b46b4d4144f79bdd9dd04a287c")
|
||||
let msg = try Array(hexString: exampleVector2)
|
||||
|
||||
var authenticator = try AES.CMAC(key: SymmetricKey(data: key), outputSize: 16)
|
||||
for byte in msg {
|
||||
authenticator.update(data: [byte])
|
||||
}
|
||||
XCTAssert(authenticator.finalize() == mac)
|
||||
}
|
||||
|
||||
func testExampleVector3() throws {
|
||||
let key = try Array(hexString: "2b7e151628aed2a6abf7158809cf4f3c")
|
||||
let mac = try Array(hexString: "dfa66747de9ae63030ca32611497c827")
|
||||
let msg = try Array(hexString: exampleVector3)
|
||||
|
||||
var authenticator = try AES.CMAC(key: SymmetricKey(data: key), outputSize: 16)
|
||||
authenticator.update(data: msg)
|
||||
XCTAssert(authenticator.finalize() == mac)
|
||||
}
|
||||
|
||||
func testExampleVector3PerByte() throws {
|
||||
let key = try Array(hexString: "2b7e151628aed2a6abf7158809cf4f3c")
|
||||
let mac = try Array(hexString: "dfa66747de9ae63030ca32611497c827")
|
||||
let msg = try Array(hexString: exampleVector3)
|
||||
|
||||
var authenticator = try AES.CMAC(key: SymmetricKey(data: key), outputSize: 16)
|
||||
for byte in msg {
|
||||
authenticator.update(data: [byte])
|
||||
}
|
||||
XCTAssert(authenticator.finalize() == mac)
|
||||
}
|
||||
|
||||
// rfc4493 example vector 4
|
||||
// https://datatracker.ietf.org/doc/html/rfc4493#page-11
|
||||
func testExampleVector4() throws {
|
||||
let key = try Array(hexString: "2b7e151628aed2a6abf7158809cf4f3c")
|
||||
let mac = try Array(hexString: "51f0bebf7e3b9d92fc49741779363cfe")
|
||||
let msg = try Array(hexString: exampleVector4)
|
||||
|
||||
var authenticator = try AES.CMAC(key: SymmetricKey(data: key), outputSize: 16)
|
||||
authenticator.update(data: msg)
|
||||
XCTAssert(authenticator.finalize() == mac)
|
||||
}
|
||||
|
||||
// rfc4493 example vector 4
|
||||
// https://datatracker.ietf.org/doc/html/rfc4493#page-11
|
||||
func testExampleVector4PerByte() throws {
|
||||
let key = try Array(hexString: "2b7e151628aed2a6abf7158809cf4f3c")
|
||||
let mac = try Array(hexString: "51f0bebf7e3b9d92fc49741779363cfe")
|
||||
let msg = try Array(hexString: exampleVector4)
|
||||
|
||||
var authenticator = try AES.CMAC(key: SymmetricKey(data: key), outputSize: 16)
|
||||
for byte in msg {
|
||||
authenticator.update(data: [byte])
|
||||
}
|
||||
XCTAssert(authenticator.finalize() == mac)
|
||||
}
|
||||
|
||||
func testWycheproof() throws {
|
||||
try wycheproofTest(jsonName: "aes_cmac_test") { (group: TestGroup) in
|
||||
for test in group.tests {
|
||||
precondition(test.flags.isEmpty)
|
||||
|
||||
do {
|
||||
var authenticator = try AES.CMAC(key: test.computedKey, outputSize: test.computedTag.count)
|
||||
authenticator.update(data: test.computedMsg)
|
||||
let result = authenticator.finalize()
|
||||
|
||||
switch test.result {
|
||||
case "valid":
|
||||
XCTAssertTrue(
|
||||
result == test.computedTag,
|
||||
"Unexpected invalid test \(test.tcId) (\(test.comment))"
|
||||
)
|
||||
case "invalid":
|
||||
XCTAssertFalse(
|
||||
result == test.computedTag,
|
||||
"Unexpected valid test \(test.tcId) (\(test.comment))"
|
||||
)
|
||||
default:
|
||||
fatalError("Unexpected result type")
|
||||
}
|
||||
} catch {
|
||||
XCTAssertTrue(test.result == "invalid", "Unexpected invalid test \(test.tcId) (\(test.comment))")
|
||||
XCTAssertTrue(
|
||||
test.comment == "invalid key size",
|
||||
"Unexpected invalid test \(test.tcId) (\(test.comment))"
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
struct TestGroup: Codable {
|
||||
var keySize: Int
|
||||
var tagSize: Int
|
||||
var type: String
|
||||
var tests: [Test]
|
||||
}
|
||||
|
||||
extension TestGroup {
|
||||
struct Test: Codable {
|
||||
var tcId: Int
|
||||
var comment: String
|
||||
var key: String
|
||||
var msg: String
|
||||
var tag: String
|
||||
var result: String
|
||||
var flags: [String]
|
||||
|
||||
var computedKey: SymmetricKey {
|
||||
SymmetricKey(hexEncoded: self.key)
|
||||
}
|
||||
|
||||
var computedMsg: Data {
|
||||
try! Data(hexString: self.msg)
|
||||
}
|
||||
|
||||
var computedTag: Data {
|
||||
try! Data(hexString: self.tag)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -41,7 +41,11 @@ extension Array where Element == UInt8 {
|
||||
init(hexString: String) throws {
|
||||
self.init()
|
||||
|
||||
guard hexString.count.isMultiple(of: 2), !hexString.isEmpty else {
|
||||
if hexString.count == 0 {
|
||||
return
|
||||
}
|
||||
|
||||
if hexString.count % 2 != 0 {
|
||||
throw ByteHexEncodingErrors.incorrectString
|
||||
}
|
||||
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
Reference in new issue
Block a user