Virgil Security provides an SDK which symplifies work with Virgil services and presents easy to use API for adding security to any application. In a few simple steps you can setup user encryption with multidevice support.
- multidevice support
- manage users' Public Keys
Virgil E3Kit is provided as a set of frameworks. These frameworks are distributed via Carthage. Also in this guide, you find one more package called VirgilCrypto (Virgil Crypto Library) that is used by the E3Kit to perform cryptographic operations.
All frameworks are available for:
- iOS 9.0+
- macOS 10.10+
- tvOS 9.0+
- watchOS 2.0+
Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
You can install Carthage with Homebrew using the following command:
$ brew update
$ brew install carthage
To integrate VirgilSDK 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/e3kit-x" ~> 0.1.0
To link prebuilt frameworks to your app, run following command:
$ carthage update --no-use-binaries
This will build each dependency or download a pre-compiled framework from github Releases.
On your application targets’ “General” settings tab, in the “Linked Frameworks and Libraries” section, add following frameworks from the Carthage/Build folder inside your project's folder:
- VirgilSDK
- VirgilCryptoAPI
- VirgilCryptoApiImpl
- VirgilCrypto
- VSCCrypto
- VirgilPythiaSDK
- VirgilKeyknoxSDK
On your application targets’ “Build Phases” settings tab, click the “+” icon and choose “New Run Script Phase.” Create a Run Script in which you specify your shell (ex: /bin/sh), add the following contents to the script area below the shell:
/usr/local/bin/carthage copy-frameworks
and add the paths to the frameworks you want to use under “Input Files”, e.g.:
$(SRCROOT)/Carthage/Build/iOS/VirgilSDK.framework
$(SRCROOT)/Carthage/Build/iOS/VirgilCryptoAPI.framework
$(SRCROOT)/Carthage/Build/iOS/VirgilCryptoAPIImpl.framework
$(SRCROOT)/Carthage/Build/iOS/VirgilCrypto.framework
$(SRCROOT)/Carthage/Build/iOS/VSCCrypto.framework
$(SRCROOT)/Carthage/Build/iOS/VirgilPythiaSDK.framework
$(SRCROOT)/Carthage/Build/iOS/VirgilKeyknoxSDK.framework
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:
- VirgilSDK
- VirgilCryptoAPI
- VirgilCryptoApiImpl
- VirgilCrypto
- VSCCrypto
- VirgilPythiaSDK
- VirgilKeyknoxSDK
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 corresponding dSYM file.
It is possible to use carthage just for fetching the right sources for further integration into your project. Run following command:
$ carthage update --no-build
This will fetch dependencies into a Carthage/Checkouts folder inside your project's folder. Then, drag and drop VirgilCrypto.xcodeproj, VirgilCryptoAPI.xcodeproj and VirgilSDK.xcodeproj from corresponding folders inside Carthage/Checkouts folder to your Xcode Project Navigator sidebar.
Next, on your application target's “General” settings tab, in the “Embedded Binaries” section add the following frameworks from subprojects:
- VirgilSDK
- VirgilCryptoAPI
- VirgilCryptoApiImpl
- VirgilCrypto
- VSCCrypto
- VirgilPythiaSDK
- VirgilKeyknoxSDK
Use the following lines of code to authenticate user.
import VirgilE3Kit
// initialize E3Kit
EThree.initialize(tokenCallback) { eThree, error in
guard let eThree = eThree, error == nil else {
// error handling here
}
eThree.bootstrap(password: password) { error in
// done
}
}
Virgil E3Kit lets you use a user's Private key and his or her Public Keys to sign, then encrypt text.
import VirgilE3Kit
// prepare a message
let messageToEncrypt = "Hello, Bob!"
// initialize E3Kit
EThree.initialize(tokenCallback) { eThree, error in
// Authenticate user
eThree!.bootstrap(password: password) { error in
// Search user's publicKeys to encrypt for
eThree!.lookUpPublicKeys(of: ["Alice", "Den"]) { publicKeys, errors in
// encrypt text
let encryptedMessage = try! eThree.encrypt(messageToEncrypt, for: publicKeys)
}
}
}
This library is released under the 3-clause BSD License.
Our developer support team is here to help you. Find out more information on our Help Center.
You can find us on Twitter or send us email support@VirgilSecurity.com.
Also, get extra help from our support team on Slack.