CryptoSwift

Pure Swift cryptographic primitives and utilities for Swift. (#PureSwift)

Note: The current release line builds with Swift 5.6 and newer toolchains. If you need an older compiler, use the matching legacy branch listed in Swift version support. Older branches are not actively maintained.

---

Requirements | Features | Recommended Defaults | Contribution | Installation | Swift Version Support | How-to | Author | License | Changelog

Support & Sponsors

The financial sustainability of the project is possible thanks to the ongoing contributions from our GitHub Sponsors

Premium Sponsors

None

Requirements

Good mood

• Swift 5.6 or newer
• Apple deployment targets: iOS 11, macOS 10.13, Mac Catalyst 13, tvOS 11, watchOS 4, visionOS 1
• Linux and Android are exercised in CI

Features

• Pure Swift implementation
• Convenient extensions for String, Data, and Array<UInt8>
• Support for incremental updates and streaming APIs
• Apple platforms, Linux, and Android support

Hash (Digest)

MD5 | SHA1 | SHA2-224 | SHA2-256 | SHA2-384 | SHA2-512 | SHA3

Cyclic Redundancy Check (CRC)

CRC32 | CRC32C | CRC16

Cipher

AES-128, AES-192, AES-256 | ChaCha20 | XChaCha20 | Rabbit | Blowfish

RSA (public-key encryption algorithm)

Encryption, Signature

Message authenticators

Poly1305 | HMAC (MD5, SHA1, SHA256) | CMAC | CBC-MAC

Cipher mode of operation

• Electronic codebook (ECB)
• Cipher-block chaining (CBC)
• Propagating Cipher Block Chaining (PCBC)
• Cipher feedback (CFB)
• Output Feedback (OFB)
• Counter Mode (CTR)
• Galois/Counter Mode (GCM)
• Counter with Cipher Block Chaining-Message Authentication Code (CCM)
• OCB Authenticated-Encryption Algorithm (OCB)

Password-Based Key Derivation Function

• PBKDF1 (Password-Based Key Derivation Function 1)
• PBKDF2 (Password-Based Key Derivation Function 2)
• HKDF (HMAC-based Extract-and-Expand Key Derivation Function)
• Scrypt (The scrypt Password-Based Key Derivation Function)

Data padding

• PKCS#5
• EMSA-PKCS1-v1_5 (Encoding Method for Signature)
• EME-PKCS1-v1_5 (Encoding Method for Encryption)
• PKCS#7
• Zero padding
• ISO/IEC 7816-4
• ISO10126
• No padding

Authenticated Encryption with Associated Data (AEAD)

• AEAD_CHACHA20_POLY1305
• AEAD_XCHACHA20_POLY1305

Recommended Defaults

• Prefer AEAD constructions such as AES-GCM, AES-CCM, ChaCha20-Poly1305, or XChaCha20-Poly1305 for new protocols.
• Prefer SHA-256, SHA-512, or SHA-3 over MD5 and SHA-1.
• Use a fresh IV or nonce for every encryption operation.
• Use RSA keys of at least 2048 bits for new systems.
• Treat MD5, SHA-1, ECB, CBC-MAC, and PKCS#1 v1.5 compatibility paths as legacy interoperability features.

Why

Why? Because I can.

How do I get involved?

You want to help, great! Go ahead and fork our repo, make your changes and send us a pull request.

Contribution

Check out CONTRIBUTING.md for more information on how to help with CryptoSwift.

• If you found a bug, open a discussion.
• If you have a feature request, open a discussion.

Installation

Swift Package Manager

CryptoSwift is primarily distributed as source through Swift Package Manager.

Add the package dependency:

dependencies: [
  .package(url: "https://github.com/krzyzanowskim/CryptoSwift.git", from: "1.10.0")
]

Then add the product to the target that uses it:

.target(
  name: "MyTarget",
  dependencies: [
    .product(name: "CryptoSwift", package: "CryptoSwift")
  ]
)

If you profile crypto-heavy workloads from Xcode, compare Debug and Release builds before drawing conclusions. Debug builds can be dramatically slower than optimized Release builds.

XCFramework

If you prefer a prebuilt optimized binary for manual Xcode integration, build CryptoSwift.xcframework locally:

./scripts/build-framework.sh

The generated CryptoSwift.xcframework is an alternative to source-based Swift Package Manager integration. It is not used by the package defined in Package.swift.

Hardened Runtime (macOS) and Xcode

If you embed the prebuilt CryptoSwift.xcframework in a hardened macOS app, library validation can prevent the binary from loading when the app is signed with Sign to Run Locally.

To avoid that, use one of these options:

• Sign the app with a proper Development certificate.
• Enable Disable Library Validation (com.apple.security.cs.disable-library-validation) for the app.

Xcode Project

To vendor CryptoSwift directly in an Xcode project, add it as a submodule from the top-level project directory:

git submodule add https://github.com/krzyzanowskim/CryptoSwift.git

Enable Whole-Module Optimization for best performance. Non-optimized builds of crypto-heavy code are significantly slower.

Legacy Package Managers

Carthage

You can use Carthage for existing projects. Specify in Cartfile:

github "krzyzanowskim/CryptoSwift"

Run carthage to build the framework and drag the built CryptoSwift.framework into your Xcode project. Follow the Carthage getting started guide. See common issues if the build fails.

CocoaPods

Note: CocoaPods is deprecated for new CryptoSwift integrations. Prefer Swift Package Manager. Keep CocoaPods only when you need it for an existing project.

You can still use CocoaPods.

pod 'CryptoSwift', '~> 1.10.0'

CocoaPods builds may need manual optimization settings if performance matters. You can adjust them after installation, or use the cocoapods-wholemodule plugin.

Embedded Framework

Embedded frameworks require a minimum deployment target of iOS 11.0 or macOS 10.13. Drag CryptoSwift.xcodeproj into your Xcode project, add the appropriate framework as a dependency, then embed CryptoSwift.framework in your app target.

Sometimes the embedded framework option is not available automatically. In that case, add a new build phase for the target.

iOS, macOS, watchOS, tvOS

In the project, you'll find single scheme for all platforms:

• CryptoSwift

Swift Version Support

• Current release line: Swift 5.6 and newer toolchains

Legacy compiler branches:

• Swift 1.2: branch swift12 version <= 0.0.13
• Swift 2.1: branch swift21 version <= 0.2.3
• Swift 2.2, 2.3: branch swift2 version <= 0.5.2
• Swift 3.1, branch swift3 version <= 0.6.9
• Swift 3.2, branch swift32 version = 0.7.0
• Swift 4.0, branch swift4 version <= 0.12.0
• Swift 4.2, branch swift42 version <= 0.15.0
• Swift 5.0, branch swift5 version <= 1.2.0
• Swift 5.1, branch swift51 version <= 1.3.3
• Swift 5.3, branch swift53 version <= 1.8.5
• Swift 5.6 and newer, branch main

How-to

• [Basics (data types, conversion,