Merge branch 'main' into ml-kem

apple · Dec 16, 2024 · 261853f · 261853f
2 parents 3d1731f + 0bf9f47
commit 261853f
Show file tree

Hide file tree

Showing 9 changed files with 83 additions and 10 deletions.
diff --git a/Package.swift b/Package.swift
@@ -27,9 +27,18 @@ import PackageDescription
 // To develop this on Apple platforms, set this to true
 let development = false
 
+// Ideally, we should use `.when(platforms:)` to set `swiftSettings` and
+// `dependencies` like on other platforms. However, `Platform.freebsd` is not
+// yet available, and therefore we guard the settings behind this boolean.
+#if os(FreeBSD)
+let isFreeBSD = true
+#else
+let isFreeBSD = false
+#endif
+
 let swiftSettings: [SwiftSetting]
 let dependencies: [Target.Dependency]
-if development {
+if development || isFreeBSD {
     swiftSettings = [
         .define("CRYPTO_IN_SWIFTPM"),
         .define("CRYPTO_IN_SWIFTPM_FORCE_BUILD_API"),
@@ -44,7 +53,7 @@ if development {
         Platform.linux,
         Platform.android,
         Platform.windows,
-        Platform.wasi,
+        Platform.wasi
     ]
     swiftSettings = [
         .define("CRYPTO_IN_SWIFTPM"),

diff --git a/Sources/CCryptoBoringSSL/CMakeLists.txt b/Sources/CCryptoBoringSSL/CMakeLists.txt
@@ -276,7 +276,7 @@ if(CMAKE_SYSTEM_NAME STREQUAL Darwin AND CMAKE_SYSTEM_PROCESSOR MATCHES "amd64|x
     gen/crypto/chacha-x86_64-apple.S
     gen/crypto/chacha20_poly1305_x86_64-apple.S
     gen/crypto/md5-x86_64-apple.S)
-elseif(CMAKE_SYSTEM_NAME MATCHES "Linux|Android" AND CMAKE_SYSTEM_PROCESSOR MATCHES "amd64|x86_64")
+elseif(CMAKE_SYSTEM_NAME MATCHES "Linux|Android|FreeBSD" AND CMAKE_SYSTEM_PROCESSOR MATCHES "amd64|x86_64")
   target_sources(CCryptoBoringSSL PRIVATE
     gen/bcm/aes-gcm-avx10-x86_64-linux.S
     gen/bcm/aesni-gcm-x86_64-linux.S
@@ -313,7 +313,7 @@ elseif(CMAKE_SYSTEM_NAME STREQUAL Darwin AND CMAKE_SYSTEM_PROCESSOR MATCHES "arm
     gen/bcm/vpaes-armv8-apple.S
     gen/crypto/chacha-armv8-apple.S
     gen/crypto/chacha20_poly1305_armv8-apple.S)
-elseif(CMAKE_SYSTEM_NAME MATCHES "Linux|Android" AND CMAKE_SYSTEM_PROCESSOR MATCHES "arm64|aarch64")
+elseif(CMAKE_SYSTEM_NAME MATCHES "Linux|Android|FreeBSD" AND CMAKE_SYSTEM_PROCESSOR MATCHES "arm64|aarch64")
   target_sources(CCryptoBoringSSL PRIVATE
     gen/bcm/aesv8-armv8-linux.S
     gen/bcm/aesv8-gcm-armv8-linux.S

diff --git a/Sources/Crypto/CMakeLists.txt b/Sources/Crypto/CMakeLists.txt
@@ -96,7 +96,7 @@ add_library(Crypto
 target_compile_definitions(Crypto PRIVATE
   "$<$<COMPILE_LANGUAGE:Swift>:CRYPTO_IN_SWIFTPM>")
 
-if(CMAKE_SYSTEM_NAME STREQUAL "Linux" OR CMAKE_SYSTEM_NAME STREQUAL "Windows" OR CMAKE_SYSTEM_NAME STREQUAL "Android" OR CMAKE_SYSTEM_NAME STREQUAL "WASI")
+if(CMAKE_SYSTEM_NAME STREQUAL "Linux" OR CMAKE_SYSTEM_NAME STREQUAL "Windows" OR CMAKE_SYSTEM_NAME STREQUAL "Android" OR CMAKE_SYSTEM_NAME STREQUAL "WASI" OR CMAKE_SYSTEM_NAME STREQUAL FreeBSD)
   target_compile_definitions(Crypto PRIVATE
     "$<$<COMPILE_LANGUAGE:Swift>:CRYPTO_IN_SWIFTPM_FORCE_BUILD_API>")
 endif()

diff --git a/Sources/Crypto/Docs.docc/index.md b/Sources/Crypto/Docs.docc/index.md
@@ -9,4 +9,46 @@ Swift Crypto provides a Swift library for common cryptographic operations. It is
 * `Crypto` - an open-source implementation of a substantial portion of the API of [Apple CryptoKit](https://developer.apple.com/documentation/cryptokit) suitable for use on Linux platforms. It enables cross-platform or server applications with the advantages of CryptoKit.
 * `CryptoExtras` - a collection of additional cryptographic primitives and utilities that are not part of CryptoKit but useful in a server environment.
 
-Swift Crypto is built on top of [BoringSSL](https://boringssl.googlesource.com/boringssl/), Google's fork of OpenSSL. The current features of Swift Crypto cover key exchange, key derivation, encryption and decryption, hashing, message authentication, and more.
+Swift Crypto is built on top of [BoringSSL](https://boringssl.googlesource.com/boringssl/), Google's fork of OpenSSL. The current features of Swift Crypto cover key exchange, key derivation, encryption and decryption, hashing, message authentication, and more.
+
+## Topics
+
+### Cryptographically secure hashes
+
+- ``HashFunction``
+- ``SHA512``
+- ``SHA384``
+- ``SHA256``
+
+### Message authentication codes
+
+- ``HMAC``
+- ``SymmetricKey``
+- ``SymmetricKeySize``
+
+### Ciphers
+
+- ``AES``
+- ``ChaChaPoly``
+
+### Public key cryptography
+
+- ``Curve25519``
+- ``P521``
+- ``P384``
+- ``P256``
+- ``SharedSecret``
+- ``HPKE``
+
+### Key derivation functions
+
+- ``HKDF``
+
+### Errors
+
+- ``CryptoKitError``
+- ``CryptoKitASN1Error``
+
+### Legacy algorithms
+
+- ``Insecure``
diff --git a/Sources/CryptoBoringWrapper/Util/RandomBytes.swift b/Sources/CryptoBoringWrapper/Util/RandomBytes.swift
@@ -19,7 +19,7 @@ extension UnsafeMutableRawBufferPointer {
             return
         }
 
-        #if canImport(Darwin) || os(Linux) || os(Android) || os(Windows)
+        #if canImport(Darwin) || os(Linux) || os(Android) || os(Windows) || os(FreeBSD)
         var rng = SystemRandomNumberGenerator()
         precondition(count <= self.count)
 

diff --git a/Sources/_CryptoExtras/Docs.docc/index.md b/Sources/_CryptoExtras/Docs.docc/index.md
@@ -2,4 +2,24 @@
 
 Provides additional cryptographic APIs that are not available in CryptoKit (and therefore the core Crypto library).
 
+## Overview
 
+`CryptoExtras` is a collection of additional cryptographic primitives and utilities that are not part of CryptoKit but useful in a server environment.
+
+## Topics
+
+### Ciphers
+
+- ``_CryptoExtras/Crypto/AES``
+
+### Public key cryptography
+
+- ``_RSA``
+
+### Key derivation functions
+
+- ``KDF``
+
+### Legacy algorithms
+
+- ``_CryptoExtras/Crypto/Insecure``
diff --git a/Sources/_CryptoExtras/RSA/RSA+BlindSigning.swift b/Sources/_CryptoExtras/RSA/RSA+BlindSigning.swift
@@ -410,7 +410,7 @@ extension _RSA.BlindSigning.PublicKey {
     /// Prepare a message to be signed using the blind signing protocol.
     ///
     /// - Parameter message: The message to be signed.
-    /// - Parameter parameters: Parameters used in the blind signing protocol.
+    ///
     /// - Returns: A prepared message, modified according to the parameters provided.
     ///
     /// - Seealso: [RFC 9474: Prepare](https://www.rfc-editor.org/rfc/rfc9474.html#name-prepare).
@@ -440,7 +440,7 @@ extension _RSA.BlindSigning.PublicKey {
     ///
     /// - Parameter signature: The signature of the blinded message.
     /// - Parameter message: The message to be signed.
-    /// - Parameter blindInverse: The inverse from the message blinding.
+    /// - Parameter blindingInverse: The inverse from the message blinding.
     /// - Returns: The signature of the message.
     ///
     /// - Seealso: [RFC 9474: Finalize](https://www.rfc-editor.org/rfc/rfc9474.html#name-finalize).

diff --git a/Tests/CryptoTests/Encodings/DERTests.swift b/Tests/CryptoTests/Encodings/DERTests.swift
@@ -49,7 +49,7 @@ class DERTests: XCTestCase {
     }
 
     func randomBytes(count: Int) -> [UInt8] {
-        #if canImport(Darwin) || os(Linux) || os(Android) || os(Windows)
+        #if canImport(Darwin) || os(Linux) || os(Android) || os(Windows) || os(FreeBSD)
         var rng = SystemRandomNumberGenerator()
         return (0..<count).map { _ in rng.next() }
         #else

diff --git a/cmake/modules/SwiftSupport.cmake b/cmake/modules/SwiftSupport.cmake
@@ -42,6 +42,8 @@ function(get_swift_host_arch result_var_name)
     set("${result_var_name}" "armv7" PARENT_SCOPE)
   elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "AMD64")
     set("${result_var_name}" "x86_64" PARENT_SCOPE)
+  elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "amd64")
+    set("${result_var_name}" "x86_64" PARENT_SCOPE)
   elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "IA64")
     set("${result_var_name}" "itanium" PARENT_SCOPE)
   elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "x86")