[![Build Status](https://travis-ci.org/VirgilSecurity/virgil-crypto.svg?branch=master)](https://travis-ci.org/VirgilSecurity/virgil-crypto) [![GitHub license](https://img.shields.io/badge/license-BSD%203--Clause-blue.svg)](https://raw.githubusercontent.com/VirgilSecurity/virgil-crypto/master/LICENSE) [![Documentation Developers](https://img.shields.io/badge/docs-developers-green.svg)](https://developer.virgilsecurity.com) # Library: Virgil Crypto [Library features](#library-features) | [Supported algorithms](#supported-algorithms) | [Build](#build) | [Benchmark](#benchmark) | [Docs](#docs) | [Support](#support) ## Introduction Welcome to Virgil Security! Virgil Security guides software developers into the forthcoming security world in which everything will be encrypted (and passwords will be eliminated). In this world, the days of developers having to raise millions of dollars to build a secure chat, secure email, secure file-sharing, or a secure anything have come to an end. Now developers can instead focus on building features that give them a competitive market advantage while end-users can enjoy the privacy and security they increasingly demand. Virgil Security offers this security via a stack of security libraries (ECIES with Crypto Agility wrapped in Virgil Cryptogram) and all the necessary infrastructure to enable seamless, end-to-end encryption for any application, platform or device. End-to-end encryption can be used for a variety of important reasons: compliance with regulations like HIPAA and GDPR, the transfer and storage of PII, general user privacy as a feature, breach risk mitigation and more. Virgil Crypto also has all required cryptographic functions and primitives to perform an implementation of [Pythia](http://pages.cs.wisc.edu/~ace/papers/pythia-full.pdf) technology. See below for currently available languages and platforms. Get in touch with us to get beta access to our Key infrastructure. ## Library Features ### Supported crypto operations * Generate keys; * Encrypt data; * Decrypt data; * Sign data; * Verify data; * Pythia protocol. ### Supported platforms Crypto Library is suitable for the following platforms: * Desktop (Windows, Linux, MacOS); * Mobile (iOS, Android, watchOS, tvOS); * Web (WebAssembly, AsmJS) ### Supported languages Crypto Library is written in C++ [[CDN](https://cdn.virgilsecurity.com/virgil-crypto/cpp/)] and supports bindings for the following programming languages: * Go [[CDN](https://cdn.virgilsecurity.com/virgil-crypto/go/)] * PHP [[CDN](https://cdn.virgilsecurity.com/virgil-crypto/php/)] * Python [[CDN](https://cdn.virgilsecurity.com/virgil-crypto/python/)] * Ruby [[CDN](https://cdn.virgilsecurity.com/virgil-crypto/ruby/)] * Java [[CDN](https://cdn.virgilsecurity.com/virgil-crypto/java/)] * C# [[CDN](https://cdn.virgilsecurity.com/virgil-crypto/net/)] * AsmJS [[CDN](https://cdn.virgilsecurity.com/virgil-crypto/asmjs/)] * NodeJS [[CDN](https://cdn.virgilsecurity.com/virgil-crypto/nodejs/)] * WebAssembly [[CDN](https://cdn.virgilsecurity.com/virgil-crypto/webasm/)] **Swift/Objective_C** language can use the Virgil Crypto Library directly, without any bind. ### Available Wrappers Virgil also has special wrappers for simplifying Crypto Library implementation in your digital solutions. We support wrappers for the following programming languages: * [Go](https://github.com/VirgilSecurity/virgil-crypto-go) * [Objective-C/Swift](https://github.com/VirgilSecurity/virgil-foundation-x) * [C#/.NET](https://github.com/VirgilSecurity/virgil-sdk-crypto-net) * [Ruby](https://github.com/VirgilSecurity/virgil-crypto-ruby) * [Python](https://github.com/VirgilSecurity/virgil-crypto-python) * [PHP](https://github.com/VirgilSecurity/virgil-sdk-crypto-php) * [JS](https://github.com/VirgilSecurity/virgil-crypto-javascript) ## Supported algorithms | Purpose | Algorithm, Source | |----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Key Generation, PRNG | [NIST SP 800-90A](http://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-90Ar1.pdf) | | Key Derivation | [KDF2\*](https://www.ietf.org/rfc/rfc2898),
[HKDF](https://tools.ietf.org/html/rfc5869) | | Key Exchange | [X25519\*](https://tools.ietf.org/html/rfc7748),
[ECDH](http://csrc.nist.gov/groups/ST/toolkit/documents/SP800-56Arev1_3-8-07.pdf),
[RSA](http://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-56Br1.pdf) | | Hashing | [SHA-2 (256/384\*/512)](https://tools.ietf.org/html/rfc4634),
[Blake2](https://tools.ietf.org/html/rfc7693) | | Digital Signature | [Ed25519\*](https://tools.ietf.org/html/rfc8032),
[ECDSA](http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-4.pdf),
[RSASSA-PSS](https://tools.ietf.org/html/rfc4056) | | Entropy Source | Linux [/dev/urandom](https://tls.mbed.org/module-level-design-rng),
Windows [CryptGenRandom()](https://tls.mbed.org/module-level-design-rng) | | Symmetric Algorithms | [AES GCM\*](http://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf),
[AES CBC](https://tools.ietf.org/html/rfc3602) | | Elliptic Curves | [X25519](https://tools.ietf.org/html/rfc7748),
[Ed25519\*](https://tools.ietf.org/html/rfc8032),
[Koblitz](https://www.ietf.org/rfc/rfc4492) (secp192k1, secp224k1, secp256k1),
[Brainpool](https://tools.ietf.org/html/rfc5639) (bp256r1, bp384r1, bp512r1),
[NIST](https://www.ietf.org/rfc/rfc5480.txt) (secp256r1, secp192r1, secp224r1, secp384r1, secp521r1) | > **\*** - used by default. ## Build ### Prerequisites The page lists the prerequisite packages which need to be installed on the different platforms to be able to configure and to build Virgil Crypto Library. * Compiler: - ```g++``` (version >= 4.9), or - ```clang++``` (version >= 3.6), or - ```msvc++``` (version >= 14.0) * Build tools: - ```cmake``` (version >= 3.10) - ```make``` * Other tools: - ```git``` - ```swig``` (version >= 3.0.12), optional for C++ build - ```doxygen``` (optional) ### Build the Library This section describes how to build Virgil Crypto Library for а particular OS. #### Step 1 - Get source code - Open Terminal. - Get the source code: ```shell > git clone https://github.com/VirgilSecurity/virgil-crypto.git ``` #### Step 2 - Run a build Script Unix-like OS: ```shell > cd virgil-crypto > ./utils/build.sh ``` Windows OS: ```shell > cd virgil-crypto > ./utils/build.bat ``` Run the build script with the option `-h` to get help on how to build a library for a necessary OS, Platforms or languages. Build command has the following syntax: ```shell ./utils/build.sh [--target=] [--feature=] [--src=] [--build=] [--install=] ``` where the command options are: - <target> - (default = cpp) target to build which contains two parts <name>[-<version>], where <name>: | <name> | build information | |------------------|---------------------------------------------------------------------------------| | cpp | build C++ library | | macos | build framework for Apple macOSX, requirements: OS X, Xcode | | ios | build framework for Apple iOS, requirements: OS X, Xcode | | watchos | build framework for Apple WatchOS, requirements: OS X, Xcode | | tvos | build framework for Apple TVOS, requirements: OS X, Xcode | | php | build PHP library, requirements: php-dev | | python | build Python library | | ruby | build Ruby library | | java | build Java library, requirements: $JAVA_HOME | | java_android | build Java library under Android platform, requirements: $ANDROID_NDK | | net | build .NET library, requirements: .NET or Mono | | net_macos | build .NET library under Apple macOSX platform, requirements: Mono, OS X, Xcode | | net_ios | build .NET library under Apple iOS platform, requirements: Mono, OS X, Xcode | | net_applewatchos | build .NET library under WatchOS platform, requirements: Mono, OS X, Xcode | | net_appletvos | build .NET library under TVOS platform, requirements: Mono, OS X, Xcode | | net_android | build .NET library under Android platform, requirements: Mono, $ANDROID_NDK | | asmjs | build AsmJS library, requirements: $EMSDK_HOME | | webasm | build WebAssembly library, requirements: $EMSDK_HOME | | nodejs | build NodeJS module | | go | build Golang library | - <feature> - available features: * pythia - ask to enable feature Pythia. Some targets enable this feature by default. - <src_dir> - a path to the directory where a root CMakeLists.txt file is located (default = .). - <build_dir> - a path to the directory where temp files will be stored (default = build/<target>). - <install_dir> - a path to the directory where library files will be installed (default = install/<target>). > All available Crypto Library versions you can find [here](http://virgilsecurity.github.io/virgil-crypto/). ## Benchmark You can find out benchmark of the Crypto Library in the [benchmark.md](benchmark.md) file. ## Docs We always try to make cryptography accessible for programmers, and the documentation below can get you started today. * [Crypto Library API](http://virgilsecurity.github.io/virgil-crypto/) * [Library usage examples](https://developer.virgilsecurity.com/docs/how-to#cryptography) * [Generate a key pair](https://developer.virgilsecurity.com/docs/cs/how-to/cryptography/generate-keypair) * [import and export keys](https://developer.virgilsecurity.com/docs/cs/how-to/cryptography/import-export-keys) * [generate and verify signature](https://developer.virgilsecurity.com/docs/cs/how-to/cryptography/generate-verify-signature) * [encrypt and decrypt data](https://developer.virgilsecurity.com/docs/cs/how-to/cryptography/encrypt-decrypt-data) * [Virgil CLI for the Crypto Library](https://developer.virgilsecurity.com/docs/sdk-and-tools/virgil-cli/generate-keypair) ## Support Our developer support team is here to help you. You can find us on [Twitter](https://twitter.com/VirgilSecurity) or send us email support@VirgilSecurity.com. Also, get extra help from our support team on [Slack](https://join.slack.com/t/VirgilSecurity/shared_invite/enQtMjg4MDE4ODM3ODA4LTc2OWQwOTQ3YjNhNTQ0ZjJiZDc2NjkzYjYxNTI0YzhmNTY2ZDliMGJjYWQ5YmZiOGU5ZWEzNmJiMWZhYWVmYTM). ## License BSD 3-Clause. See [LICENSE](LICENSE) for details.