Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/virgilsecurity/virgil-cryptowrapper-x
Virgil Crypto library is a small, flexible and convenient wrapper for a variety of cryptographic algorithms. Includes asymmetric key generation, encryption/decryption of data, generation/verification of digital signatures, Pythia protocol and Double Ratchet protocol implementation.
https://github.com/virgilsecurity/virgil-cryptowrapper-x
cryptography doubleratchet encryption pythia ratchet
Last synced: 7 days ago
JSON representation
Virgil Crypto library is a small, flexible and convenient wrapper for a variety of cryptographic algorithms. Includes asymmetric key generation, encryption/decryption of data, generation/verification of digital signatures, Pythia protocol and Double Ratchet protocol implementation.
- Host: GitHub
- URL: https://github.com/virgilsecurity/virgil-cryptowrapper-x
- Owner: VirgilSecurity
- License: other
- Created: 2019-01-22T13:04:01.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-10-23T22:18:54.000Z (about 2 years ago)
- Last Synced: 2024-10-06T20:02:21.517Z (about 1 month ago)
- Topics: cryptography, doubleratchet, encryption, pythia, ratchet
- Language: Swift
- Homepage: https://virgilsecurity.com/
- Size: 9.7 MB
- Stars: 4
- Watchers: 11
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Virgil Security Objective-C/Swift Crypto Library Wrapper
[](https://travis-ci.com/VirgilSecurity/virgil-cryptowrapper-x)
[](https://cocoapods.org/pods/VirgilCryptoFoundation)
[](https://github.com/Carthage/Carthage)
[](https://github.com/VirgilSecurity/virgil/blob/master/LICENSE)
### [Introduction](#introduction) | [Features](#features) | [Installation](#installation) | [Docs](#docs) | [License](#license) | [Contacts](#support)
## Introduction
This library is designed to be a small, flexible and convenient wrapper for a variety of crypto algorithms. So it can be used in a small microcontroller as well as in a high load server application. Also, it provides a bunch of custom hybrid algorithms that combine different crypto algorithms to solve common complex cryptographic problems in an easy way. That eliminates requirement for developers to have a strong cryptographic skills.
Virgil Security Objective-C/Swift Crypto Library Wrapper is a wrapper for [Virgil Security Crypto Library](https://github.com/VirgilSecurity/virgil-crypto-c).
## Features
Virgil Security Crypto library wrapper is decomposed to small libraries with specific purposes, so a developer can freely choose a subset of them.
### Library: Foundation
This library contains basic cryptographic algorithms and can be used as building blocks for complex solutions.
| Algorithm Purpose | Implementation details |
|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
| Key Generation, PRNG | CTR_DRBG [NIST SP 800-90A](http://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-90Ar1.pdf) |
| Key Derivation | [KDF1, KDF2](https://www.shoup.net/iso/std6.pdf), [HKDF](https://tools.ietf.org/html/rfc5869), [PBKDF2](https://tools.ietf.org/html/rfc8018#section-5.2) |
| Key Exchange | [X25519](https://tools.ietf.org/html/rfc7748), [RSA](http://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-56Br1.pdf) |
| Hashing | [SHA-2 (224/256/384/512)](https://tools.ietf.org/html/rfc4634) |
| Message Authentication Code | [HMAC](https://www.ietf.org/rfc/rfc2104.txt) |
| Digital Signature | [Ed25519](https://tools.ietf.org/html/rfc8032), [RSASSA-PSS](https://tools.ietf.org/html/rfc4056) |
| Entropy Source | Linux, macOS [/dev/urandom](https://tls.mbed.org/module-level-design-rng),
Windows [CryptGenRandom()](https://tls.mbed.org/module-level-design-rng) |
| Symmetric Algorithms | [AES-256-GCM](http://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf), [AES-256-CBC](https://tools.ietf.org/html/rfc3602) |
| Encryption schemes | [PBES2](https://tools.ietf.org/html/rfc8018#section-6.2) |
| Elliptic Curves | [Ed25519](https://tools.ietf.org/html/rfc8032), [Curve25519](https://tools.ietf.org/html/rfc7748) |
### Library: Pythia
Implementation of the [Pythia](http://pages.cs.wisc.edu/~ace/papers/pythia-full.pdf) protocol.
### Library: Ratchet
Implementation of the [Double Ratchet](https://signal.org/docs/specifications/doubleratchet/) protocol.
## Installation
VirgilCrypto is provided as a set of frameworks. These frameworks are distributed via Carthage and CocoaPods.
All frameworks are available for:
- iOS 9.0+
- macOS 10.9+
- tvOS 9.0+
- watchOS 2.0+
### COCOAPODS
[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
```bash
$ gem install cocoapods
```
To integrate VirgilCryptoWrapper into your Xcode project using CocoaPods, specify it in your *Podfile*:
```bash
target '' do
use_frameworks!
pod 'VirgilCryptoFoundation', '~> 0.16.0'
pod 'VirgilCryptoRatchet', '~> 0.16.0'
pod 'VirgilCryptoPythia', '~> 0.16.0'
end
```
__NOTE__: It's not mandatory to include all this dependencies, add only frameworks you are going to use.
Then, run the following command:
```bash
$ pod install
```
### Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
```bash
$ brew update
$ brew install carthage
```
To integrate VirgilCryptoWrapper into your Xcode project using Carthage, create an empty file with name *Cartfile* in your project's root folder and add following lines to your *Cartfile*
```
github "VirgilSecurity/virgil-cryptowrapper-x" ~> 0.16.0
```
#### Linking against prebuilt binaries
To link prebuilt frameworks to your app, run following command:
```bash
$ carthage update --use-xcframeworks
```
This will build each dependency or download a pre-compiled framework from github Releases.
##### Building for iOS/tvOS/watchOS
On your application target's “General” settings tab, in the “Linked Frameworks and Libraries” section, add following frameworks from the *Carthage/Build* folder inside your project's folder:
- VirgilCryptoFoundation
- VirgilCryptoRatchet
- VirgilCryptoPythia
- VSCCommon
- VSCFoundation
- VSCRatchet
- VSCPythia
Check Embed & sign for each.
##### Building for macOS
On your application target's “General” settings tab, in the “Embedded Binaries” section, drag and drop following frameworks from the Carthage/Build folder on disk:
- VirgilCryptoFoundation
- VirgilCryptoRatchet
- VirgilCryptoPythia
- VSCCommon
- VSCFoundation
- VSCRatchet
- VSCPythia
Additionally, you'll need to copy debug symbols for debugging and crash reporting on macOS.
On your application target’s “Build Phases” settings tab, click the “+” icon and choose “New Copy Files Phase”.
Click the “Destination” drop-down menu and select “Products Directory”. For each framework, drag and drop the corresponding dSYM file.
## Swift Package Manager
[Swift Package Manager](https://www.swift.org/package-manager) is an official Apple tool for managing the distribution of Swift code.
[The Apple documentation](https://developer.apple.com/documentation/swift_packages/adding_package_dependencies_to_your_app) can be used to add frameworks to an Xcode project.
## Docs
- [Crypto Core Library](https://github.com/VirgilSecurity/virgil-crypto-c)
- [More usage examples](https://developer.virgilsecurity.com/docs/how-to#cryptography)
## License
This library is released under the [3-clause BSD License](LICENSE).
## Support
Our developer support team is here to help you.
You can find us on [Twitter](https://twitter.com/VirgilSecurity) or send us email [email protected].
Also, get extra help from our support team on [Slack](https://virgilsecurity.com/join-community).