Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/VirgilSecurity/virgil-crypto-x

Virgil Crypto stack Objective-C/Swift
https://github.com/VirgilSecurity/virgil-crypto-x

crypto cryptography double-ratchet encryption post-quantum-cryptography virgil

Last synced: about 2 months ago
JSON representation

Virgil Crypto stack Objective-C/Swift

Lists

README 

        
# Virgil Crypto Library Objective-C/Swift



[![Build Status](https://api.travis-ci.com/VirgilSecurity/virgil-crypto-x.svg?branch=master)](https://travis-ci.com/VirgilSecurity/virgil-crypto-x)

[![CocoaPods Compatible](https://img.shields.io/cocoapods/v/VirgilCrypto.svg)](https://img.shields.io/cocoapods/v/VirgilCrypto.svg)

[![SPM compatible](https://img.shields.io/badge/Swift_Package_Manager-compatible-green.svg?style=flat)](https://www.swift.org/package-manager)

![Platform](https://img.shields.io/cocoapods/p/VirgilCrypto.svg?style=flat)

[![GitHub license](https://img.shields.io/badge/license-BSD%203--Clause-blue.svg)](https://github.com/VirgilSecurity/virgil/blob/master/LICENSE)



[Introduction](#introduction) | [Library purposes](#library-purposes) | [Installation](#installation) | [Usage examples](#usage-examples) | [Docs](#docs) | [License](#license) | [Contacts](#support)



## Introduction



Virgil Crypto Library Objective-C/Swift is a small, flexible and convenient wrapper for a variety of crypto algorithms. 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 a requirement for developers to have strong cryptographic skills.



Virgil Security Objective-C/Swift Crypto Library uses Swift wrapper [Virgil Security Crypto Library Wrapper](https://github.com/VirgilSecurity/virgil-cryptowrapper-x) over C library [Virgil Security Crypto Library](https://github.com/VirgilSecurity/virgil-crypto-c). 



## Library purposes



* Asymmetric Key Generation

* Encryption/Decryption of data and streams

* Generation/Verification of digital signatures

* Double Ratchet algorithm support

* **Post-quantum algorithms support**: [Round5](https://round5.org/) (encryption) and [Falcon](https://falcon-sign.info/) (signature) 

* Crypto for using [Virgil Core SDK](https://github.com/VirgilSecurity/virgil-sdk-x)



## Installation



VirgilCrypto is provided as a set of frameworks. These frameworks are distributed via Carthage and CocoaPods.



All frameworks are available for:

- iOS 11.0+

- macOS 10.13+

- tvOS 11.0+

- watchOS 4.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 VirgilCrypto into your Xcode project using CocoaPods, specify it in your *Podfile*:



```bash

target '' do

  use_frameworks!



  pod 'VirgilCrypto', '~> 7.0.1'

end

```



Then, run the following command:



```bash

$ pod install

```



### 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.



## Usage examples



### Generate a key pair



Generate a private key using the default algorithm (EC_X25519):



```swift

import VirgilCrypto



let crypto = try! VirgilCrypto()

let keyPair = try! crypto.generateKeyPair()

```



### Generate and verify a signature



Generate signature and sign data with a private key:



```swift

import VirgilCrypto



let crypto = try! VirgilCrypto()



// prepare a message

let messageToSign = "Hello, Bob!"

let dataToSign = messageToSign.data(using: .utf8)!



// generate a signature

let signature = try! crypto.generateSignature(of: dataToSign, using: senderPrivateKey)

```



Verify a signature with a public key:



```swift

import VirgilCrypto



let crypto = try! VirgilCrypto()



// verify a signature

let verified = try! crypto.verifySignature(signature, of: dataToSign, with: senderPublicKey)

```

### Encrypt and decrypt data



Encrypt data with a public key:



```swift

import VirgilCrypto



let crypto = try! VirgilCrypto()



// prepare a message

let messageToEncrypt = "Hello, Bob!"

let dataToEncrypt = messageToEncrypt.data(using: .utf8)!



// encrypt the message

let encryptedData = try! crypto.encrypt(dataToEncrypt, for: [receiverPublicKey])

```

Decrypt the encrypted data with a Private Key:

```swift

import VirgilCrypto



let crypto = try! VirgilCrypto()



// prepare data to be decrypted

let decryptedData = try! crypto.decrypt(encryptedData, with: receiverPrivateKey)



// decrypt the encrypted data using a private key

let decryptedMessage = String(data: decryptedData, encoding: .utf8)!

```



### Import and export keys



Export keys:



```

import VirgilCrypto



// generate a Key Pair

let crypto = VirgilCrypto()

let keyPair = try! crypto.generateKeyPair()



// export a Private key

let privateKeyData = try! crypto.exportPrivateKey(keyPair.privateKey, password: "YOUR_PASSWORD")

let privateKeyStr = privateKeyData.base64EncodedString()



// export a Public key

let publicKeyData = crypto.exportPublicKey(keyPair.publicKey)

let publicKeyStr = publicKeyData.base64EncodedString()

```



Import keys:



```

import VirgilCrypto



let crypto = VirgilCrypto()



let privateKeyStr = "MIGhMF0GCSqGSIb3DQEFDTBQMC8GCSqGSIb3DQEFDDAiBBBtfBoM7VfmWPlvyHuGWvMSAgIZ6zAKBggqhkiG9w0CCjAdBglghkgBZQMEASoEECwaKJKWFNn3OMVoUXEcmqcEQMZ+WWkmPqzwzJXGFrgS/+bEbr2DvreVgEUiLKrggmXL9ZKugPKG0VhNY0omnCNXDzkXi5dCFp25RLqbbSYsCyw="



let privateKeyData = Data(base64Encoded: privateKeyStr)!



// import a Private key

let privateKey = try! crypto.importPrivateKey(from: privateKeyData, password: "YOUR_PASSWORD")



//-----------------------------------------------------



let publicKeyStr = "MCowBQYDK2VwAyEA9IVUzsQENtRVzhzraTiEZZy7YLq5LDQOXGQG/q0t0kE="



let publicKeyData = Data(base64Encoded: publicKeyStr)!



// import a Public key

let publicKey = try! crypto.importPublicKey(from: publicKeyData)

```



## Docs

- [Crypto Core Library C](https://github.com/VirgilSecurity/virgil-crypto-c)

- [Developer Documentation](https://developer.virgilsecurity.com/docs/)



## 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).