https://github.com/apple/corecrypto
Apple corecrypto
https://github.com/apple/corecrypto
Last synced: 12 days ago
JSON representation
Apple corecrypto
- Host: GitHub
- URL: https://github.com/apple/corecrypto
- Owner: apple
- License: other
- Created: 2026-05-22T15:07:05.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-05-22T15:31:53.000Z (about 1 month ago)
- Last Synced: 2026-06-15T06:03:45.004Z (13 days ago)
- Language: C++
- Homepage:
- Size: 36 MB
- Stars: 385
- Watchers: 7
- Forks: 38
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: License.txt
Awesome Lists containing this project
README
The corecrypto (cc) project
===========================
The Security framework, CryptoKit and CommonCrypto rely on the corecrypto library to
provide implementations of low-level cryptographic primitives. Although corecrypto
does not directly provide programming interfaces for developers and should not be used
by iOS, iPadOS, or macOS apps, the source code is available to allow for verification
of its security characteristics and correct functioning.
The main goal is to provide low-level fast math routines and cryptographic implementations which
can be used in various environments (Kernel, bootloader, userspace, etc.). It
is an explicit goal to minimize dependencies between modules and functions so
that clients of this library only end up with the routines they need and
nothing more.
Building on macOS
-----------------
The easiest way to build the corecrypto project is to use the `xcodebuild` command. The project supports several schemes, including:
1. `corecrypto`: This scheme compiles corecrypto and produces a static library.
2. `corecrypto_test`: This scheme compiles corecrypto test files and links statically with the corecrypto debug library.
3. `corecrypto_perf`: This scheme compiles corecrypto performance measurement files and links statically with the corecrypto release library.
E.g., `xcodebuild -scheme corecrypto_test`
Running the formal verification
-------------------------------
Our formal verification is in the [`corecrypto_verify`](corecrypto_verify) subdirectory.
Please refer to the [`corecrypto_verify/README.md`](corecrypto_verify/README.md) for more details. For an overview of the process, see our [Formal verification in corecrypto: ML-KEM and ML-DSA in 2026](corecrypto_verify/technical_overview/formal-verification-for-apple-corecrypto.md) technical overview.
Licensing and Contributions
---------------------------
The publication of this code is primarily intended for security research and verification purposes. The default license for the corecrypto (cc) project is the evaluation-only corecrypto Internal Use License Agreement contained in [License.txt](License.txt).
Some Isabelle files, however, are intended for wider use and are also licensed under more permissive terms. For example, the files in:
* the directories in [`corecrypto_verify/isabelle/Apple_Isabelle_Libraries`](./corecrypto_verify/isabelle/Apple_Isabelle_Libraries) are available under per-subdirectory license files as referenced in individual file headers
* the directory [`corecrypto_verify/isabelle/Cryptol/cryptol-to-isabelle/isabelle`](./corecrypto_verify/isabelle/Cryptol/cryptol-to-isabelle/isabelle) are available under an [accompanying LICENSE file](./corecrypto_verify/isabelle/Cryptol/cryptol-to-isabelle/isabelle/LICENSE)
We are not currently accepting external code contributions to this repository. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for information about reporting security issues.
Contact
-------
To report security issues with this code, please use the instructions available [at this page](https://support.apple.com/en-us/102549).