Skip to content

Commit

Permalink
Merge branch 'main' into slh-dsa
Browse files Browse the repository at this point in the history
  • Loading branch information
fpseverino authored Dec 12, 2024
2 parents 7e89717 + 8650683 commit e9d5a61
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .spi.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: 1
builder:
configs:
- documentation_targets: [Crypto]
- documentation_targets: [Crypto, _CryptoExtras]
12 changes: 12 additions & 0 deletions Sources/Crypto/Docs.docc/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# ``Crypto``

A cryptography library for Swift.

## Overview

Swift Crypto provides a Swift library for common cryptographic operations. It is available as a Swift package and provides two main libraries:

* `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.
5 changes: 5 additions & 0 deletions Sources/_CryptoExtras/Docs.docc/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# ``CryptoExtras``

Provides additional cryptographic APIs that are not available in CryptoKit (and therefore the core Crypto library).


0 comments on commit e9d5a61

Please sign in to comment.