NextGenIntelligence / virgil-crypto

Virgil Security Crypto Core Library

Library: Virgil Crypto

• Introduction
• Supported languages and platforms
• Library purposes
• Where library can be used
• Build prerequisites
• Simple build
• Multiarch build
• Support

Introduction

Welcome to Virgil!

Virgil is 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. See below for currently available languages and platforms. Get in touch with us to get preview access to our key infrastructure.

Virgil Security, Inc., 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.

Supported languages and platforms

Language	Supported OS	Usage
C++	ANY	Tutorial, Reference API
PHP	Unix, Linux, OS X
Python	Unix, Linux, OS X	Tutorial
Ruby	Unix, Linux, OS X
Java	Unix, Linux, OS X, Windows	Tutorial
.NET	Unix, Linux, OS X, Windows	Tutorial, Reference API
AsmJS	Unix, Linux, OS X, Windows	Tutorial
NodeJS	Unix, Linux, OS X, Windows	Tutorial

Library purposes

• Encrypt data;
• Decrypt data;
• Sign data;
• Verify data.

Where library can be used

• on the client-side application;
• on the server-side application.

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++, or
  • clang++, or
  • msvc++ (version >= 12.0)
• Build tools:
  • cmake (version >= 3.2)
  • make
• Other tools:
  • git
  • swig (version >= 3.0.7), optional for C++ build
  • doxygen (optional)

Simple build

This section describes how to build Virgil Crypto Library for а particular language.

Step 1 - Choose target language

Table 1 - Supported languages

Language	Supported OS	Dependencies	Build parameters	Environment
C++	ANY		LANG=cpp
PHP	Unix, Linux, OS X	php, php5-dev	LANG=php
Python	Unix, Linux, OS X	python	LANG=python
Ruby	Unix, Linux, OS X	ruby, ruby-dev	LANG=ruby
Java	Unix, Linux, OS X, Windows	Java JDK 1.6	LANG=java	JAVA_HOME
.NET	Unix, Linux, OS X, Windows	.NET 2.0, or mono 2.0	LANG=net
AsmJS	Unix, Linux, OS X, Windows	Emscripten 1.35	LANG=asmjs	EMSDK_HOME
NodeJS	Unix, Linux, OS X, Windows		LANG=nodejs

Step 2 - Configure environment

1. Open Terminal.
2. Check that all the tools which are listed in the build prerequisite are available there.
3. Set environment variables according to the table above.

Step 3 - Get source code

> git clone https://github.com/VirgilSecurity/virgil-crypto.git

Step 4 - Build

Replace {{LANG}} placeholder to the corresponding value from the table above.

> cd virgil-crypto
> cmake -H. -B_build -DCMAKE_INSTALL_PREFIX=_install -DLANG={{LANG}}
> cmake --build _build --target install

Note, if you are using -DLANG=nodejs, one of the next parameters can be appended:

• -DLANG_VERSION=0.12.7
• -DLANG_VERSION=4.1.0

Multiarch build

This section describes how to build Virgil Crypto Library for multi architecture targets, which are packed inside the specific package:

• Apple OS X Framework
• Apple iOS Framework
• Apple WatchOS Framework
• Apple TVOS Framework
• Android Bundle as Jar archive
• Windows Bundle, as structured

Step 1 - Choose target language and platform

Table 2 - Supported languages and platforms

Language	Platform	Host OS	Dependencies	Build parameters	Environment
C++	OS X	OS X		TARGET=osx
C++	iOS	OS X		TARGET=ios
C++	WatchOS	OS X		TARGET=applewatchos
C++	TVOS	OS X		TARGET=appletvos
C++	Windows	Windows		TARGET=cpp
.NET	iOS	OS X	mono 2.0	TARGET=net_ios
.NET	WatchOS	OS X	mono 2.0	TARGET=net_applewatchos
.NET	TVOS	OS X	mono 2.0	TARGET=net_appletvos
.NET	Android	*nix	Android NDK, mono 2.0	TARGET=net_android	ANDROID_NDK
.NET	Windows	Windows	.NET 2.0	TARGET=net
Java	Android	*nix	Android NDK	TARGET=java_android	ANDROID_NDK
Java	Windows	Windows	Java JDK	TARGET=java	JAVA_HOME
NodeJS 0.12	Windows	Windows		TARGET=nodejs-0.12.7
NodeJS 4.1	Windows	Windows		TARGET=nodejs-4.1.0

Step 2 - Configure environment

1. Open Terminal.
2. Check that all tools which are listed in the build prerequisites are available there.

• for Windows compiler should be MSVC;
• for OS X build toolchain should be Xcode Toolchain.

1. Check that all dependencies from the table above are accessible.
2. Set environment variables according to the table above.

Step 3 - Get source code

> git clone https://github.com/VirgilSecurity/virgil-crypto.git

Step 4 - Build

Replace {{TARGET}} placeholder to the corresponding value from the table above.

Unix-like OS:

> cd virgil-crypto
> ./utils/build.sh {{TARGET}}
> ls ./install/{{TARGET}}

Windows OS:

> set MSVC_ROOT=c:\path\to\msvc\root
> set JAVA_HOME=c:\path\to\jdk
> cd virgil-crypto
> .\utils\build.bat {{TARGET}}
> dir .\install\{{TARGET}}

Support

Email to: [e-mail]