https://github.com/areroketahi/swiftlycrypto
Encrypt your data like using other Swift APIs
https://github.com/areroketahi/swiftlycrypto
aes-encryption crypto cryptography encryption rsa swift swift-package-manager swiftly
Last synced: 12 months ago
JSON representation
Encrypt your data like using other Swift APIs
- Host: GitHub
- URL: https://github.com/areroketahi/swiftlycrypto
- Owner: AreroKetahi
- License: mit
- Created: 2023-08-24T13:36:34.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-22T07:06:35.000Z (over 2 years ago)
- Last Synced: 2025-06-03T11:09:41.680Z (about 1 year ago)
- Topics: aes-encryption, crypto, cryptography, encryption, rsa, swift, swift-package-manager, swiftly
- Language: Swift
- Homepage:
- Size: 27.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# SwiftlyCrypto
Encrypt your data like using other Swift APIs
SwiftlyCrypto is based on [SwCrypt](https://github.com/soyersoyer/SwCrypt) from [@soyersoyer](https://github.com/soyersoyer)
## Why SwiftlyCrypto?
SwiftlyCrypto is a non-abstract crypto library. Developers can benefit from SwiftlyCrypto's figurative API.
SwiftlyCrypto will never define a type as its original value. (Like `Data` or `String`.) This feature can be very useful in large projects, because it makes the code more readable.
SwiftlyCrypto is repackaged from SwCryt. Thanks [@soyersoyer](https://github.com/soyersoyer)'s project [SwCrypt](https://github.com/soyersoyer/SwCrypt)!
# Quick Tutorial
You should import SwiftlyCrypto to your code at the beginning.
```swift
import SwiftlyCrypto
```
## RSA
### Generate key pair
```swift
let (privateKey, publicKey) = RSA.generateKeyPair()
```
### Get PEM format keys
```swift
let pemPrivateKey = privateKey.toPKCS1()
let pemPublicKey = publicKey.toPKCS8()
```
### Encrypt & decrypt private key
```swift
let encryptedPrivateKey = try privateKey.encryptedKey("password")
let decryptedPrivateKey = try RSAPrivateKey(encryptedPrivateKey, password: "password")
```
### Get public key from private key
```swift
let publicKey = try privateKey.getPublicKey()
```
### Encrypt & Decrypt
```swift
let text = "Hello, world!"
let raw = RSARawValue(text)
let encrypted = try raw.encrypt(publicKey: publicKey)
let decrypted = try encrypted.decrypt(privateKey: privateKey)
```
### Sign & Verify
```swift
let text = "Hello, world!"
let raw = RSARawValue(text)
let signed = try raw.sign(privateKey: privateKey)
let verifyResult = try signed.verify(message: raw, publicKey: publicKey) // true for success, otherwise false
```
## AES
### Generate random Key & IV
```swift
let randomKey = AES.generateRandomKey()
let randomIV = AES.generateRandomIV()
```
### Set your own Key & IV
```swift
let key = AESKey("password")
let iv = try AESIV(fromHexString: "12345678901234567890123456789012")
```
### Encrypt & Decrypt
```swift
let text = "Hello, world!"
let raw = AESRawValue(text)
let encrypted = try raw.encrypt(key: key, iv: iv)
let decrypted = try encrypted.decrypt(key: key, iv: iv)
```
### Encrypt with random generation
```swift
// generate both key and iv
let raw = AESRawValue("Hello, world!")
let key = AESKey()
let iv = AESIV()
let encrypted = try raw.encrypt(randomKey: &key, randomIV: &iv)
```
```swift
// generate key
let raw = AESRawValue("Hello, world!")
let key = AESKey()
let iv = try AESIV(fromHexString: "12345678901234567890123456789012")
let encrypted = try raw.encrypt(randomKey: &key, iv: iv)
```
```swift
// generate iv
let raw = AESRawValue("Hello, world!")
let key = AESKey("password")
let iv = AESIV()
let encrypted = try raw.encrypt(key: key, randomIV: &iv)
```
### Check whether the key or IV is empty
```swift
// true for empty, otherwise false
key.isEmpty
iv.isEmpty
```