virgil-sdk 4.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62b33c8c8fa9703959fa5b2aa79b18de5e6a8fc7
+  data.tar.gz: 9ae4342ed919b4664f1f54487b0ec0bb53d4038c
+SHA512:
+  metadata.gz: 5b98e2d0c08ec1277a74f09149cd76eaff5e42e2f25b4cbff526e512394deb4d528b99a87d2f0e847a0c4770a2f224f887ff2c19229df9b191985669a428409a
+  data.tar.gz: 7909cd3752d9679ad569b751ff3aa0461165e15bc092d583724f2e6ec4e925d126487d48c5dac82a6687daea6c0dfc06c74c1f48a5574ad4f231c11862675f3d

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+lib/virgil/sdk/virgil_crypto_ruby.so
+*.gem
+.idea
+sample.rb
+key_storage
+*.virgilkey

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in virgil-sdk.gemspec
+gemspec

data/README.md

@@ -0,0 +1,134 @@
+# Virgil Security Ruby SDK 
+
+[Installation](#installation) | [Encryption Example](#encryption-example) | [Initialization](#initialization) | [Documentation](#documentation) | [Support](#support)
+
+[Virgil Security](https://virgilsecurity.com) provides a set of APIs for adding security to any application. In a few simple steps you can encrypt communication, securely store data, provide passwordless login, and ensure data integrity.
+
+For a full overview head over to our Ruby [Get Started][_getstarted] guides.
+
+## Installation
+
+The Virgil SDK is provided as a gem named *virgil-sdk*. The package is distributed via *bundler* package manager.
+
+The gem is available for Ruby 2.1 and newer.
+
+Installing the gem
+
+To install package use the command below:
+
+```
+gem install virgil-sdk
+```
+
+or add the following line to your Gemfile:
+
+```
+gem 'virgil-sdk', '~> 4.2.0'
+```
+
+__Next:__ [Get Started with the Ruby SDK][_getstarted].
+
+## Encryption Example
+
+Virgil Security makes it super easy to add encryption to any application. With our SDK you create a public [__Virgil Card__](#link_to_virgil_cards_guide) for every one of your users and devices. With these in place you can easily encrypt any data in the client.
+
+```ruby
+require "virgil/sdk"
+include Virgil::SDK::HighLevel
+
+# initialize Virgil SDK
+virgil = VirgilApi.new(access_token: "[YOUR_ACCESS_TOKEN_HERE]")
+
+# find Alice's card(s)
+alice_cards = virgil.cards.find("alice")
+
+# encrypt the message using Alice's cards
+message = "Hello Alice!"
+encrypted_message = alice_cards.encrypt(message)
+
+# transmit the message with your preferred technology
+ transmit_message(encrypted_message.to_base64)
+```
+
+The receiving user then uses their stored __private key__ to decrypt the message.
+
+
+```ruby
+# load Alice's Key from storage.
+alice_key = virgil.keys.load("alice_key_1", "mypassword")
+
+# decrypt the message using the key 
+original_message = alice_key.decrypt(transfer_data).to_s
+```
+
+__Next:__ To [get you properly started][_encryption_get_started_guide] you'll need to know how to create and store Virgil Cards. Our [Get Started guide][_encryption_get_started_guide] will get you there all the way.
+
+__Also:__ [Encrypted communication][_getstarted_encryption] is just one of the few things our SDK can do. Have a look at our guides on  [Encrypted Storage][_getstarted_storage], [Data Integrity][_getstarted_data_integrity] and [Passwordless Login][_getstarted_passwordless_login] for more information.
+
+
+## Initialization
+
+To use this SDK you need to [sign up for an account](https://developer.virgilsecurity.com/account/signup) and create your first __application__. Make sure to save the __app id__, __private key__ and it's __password__. After this, create an __application token__ for your application to make authenticated requests from your clients.
+
+To initialize the SDK on the client side you will only need the __access token__ you created.
+
+```ruby
+virgil = VirgilApi.new(access_token: "[YOUR_ACCESS_TOKEN_HERE]")
+```
+
+> __Note:__ this client will have [limited capabilities](#guide_on_client_access_permissions). For example, it will be able to generate new __Cards__ but it will need a server-side client to transmit these to Virgil.
+
+To initialize the SDK on the server side we will need the __access token__, __app id__ and the __App Key__ you created on the [Developer Dashboard](https://developer.virgilsecurity.com/).
+
+```ruby
+ # initialize Virgil SDK high-level instance.
+context = VirgilContext.new(
+    access_token: "[YOUR_ACCESS_TOKEN_HERE]",
+    # Credentials are required only in case of publish and revoke local Virgil Cards.
+    credentials: VirgilAppCredentials.new(app_id: "[YOUR_APP_ID_HERE]",
+                                        app_key_data: VirgilBuffer.from_file("[YOUR_APP_KEY_PATH_HERE]"),
+                                        app_key_password: "[YOUR_APP_KEY_PASSWORD_HERE]"),
+    card_verifiers: [ VirgilCardVerifierInfo.new("[YOUR_CARD_ID_HERE]", 
+                                                VirgilBuffer.from_base64("[YOUR_PUBLIC_KEY_HERE]"))]
+)
+
+virgil = VirgilApi.new(context: context)
+
+```
+
+Next: [Learn more about our the different ways of initializing the Ruby SDK](#_guide_initialization) in our documentation.
+
+## Documentation
+
+Virgil Security has a powerful set of APIs, and the documentation is there to get you started today.
+
+* [Get Started][_getstarted_root] documentation
+  * [Initialize the SDK][_initialize_root]
+  * [Encrypted storage][_getstarted_storage]
+  * [Encrypted communication][_getstarted_encryption]
+  * [Data integrity][_getstarted_data_integrity]
+  * [Passwordless login][_getstarted_passwordless_login]
+* [Guides][_guides]
+  * [Virgil Cards][_guide_virgil_cards]
+  * [Virgil Keys][_guide_virgil_keys]
+
+## 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) and [email](support).
+
+[support]: mailto:support@virgilsecurity.com
+[_getstarted_root]: https://virgilsecurity.com/docs/sdk/ruby/
+[_getstarted]: https://virgilsecurity.com/docs/sdk/ruby/
+[_getstarted_encryption]: https://virgilsecurity.com/docs/use-cases/encrypted-communication
+[_getstarted_storage]: https://virgilsecurity.com/docs/use-cases/secure-data-at-rest
+[_getstarted_data_integrity]: https://virgilsecurity.com/docs/use-cases/data-verification
+[_getstarted_passwordless_login]: https://virgilsecurity.com/docs/use-cases/passwordless-authentication
+[_guides]: https://stg.virgilsecurity.com/docs/sdk/ruby/features
+[_guide_initialization]: https://virgilsecurity.com/docs/sdk/ruby/get-started
+[_guide_virgil_cards]: https://virgilsecurity.com/docs/sdk/ruby/features#virgil-cards
+[_guide_virgil_keys]: https://virgilsecurity.com/docs/sdk/ruby/features#virgil-keys
+[_initialize_root]: https://virgilsecurity.com/docs/sdk/ruby/programming-guide#initializing

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "virgil/sdk"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start
+
+

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dockefiles/Dockerfile-200

@@ -0,0 +1,25 @@
+FROM ruby:2.0.0
+MAINTAINER marfachaiko@gmail.com
+
+# Install apt based dependencies required to run Rails as
+# well as RubyGems. As the Ruby image itself is based on a
+# Debian image, we use apt-get to install those.
+RUN apt-get update && apt-get install -y \
+  build-essential
+
+# Configure the main working directory. This is the base
+# directory used in any further RUN, COPY, and ENTRYPOINT
+# commands.
+RUN mkdir  /virgil-sdk-2.0.0
+WORKDIR /virgil-sdk-2.0.0
+
+# Copy the Gemfile as well as the Gemfile.lock and install
+# the RubyGems. This is a separate step so the dependencies
+# will be cached unless changes to one of those two files
+# are made.
+ADD lib /virgil-sdk-2.0.0/lib
+ADD virgil-sdk.gemspec /virgil-sdk-2.0.0
+ADD Gemfile /virgil-sdk-2.0.0
+RUN gem install bundler && bundle install --jobs 20 --retry 5
+
+ADD . /virgil-sdk-2.0.0

data/dockefiles/Dockerfile-2110

@@ -0,0 +1,36 @@
+FROM ruby:2.1.10
+MAINTAINER marfachaiko@gmail.com
+
+# Install apt based dependencies required to run Rails as
+# well as RubyGems. As the Ruby image itself is based on a
+# Debian image, we use apt-get to install those.
+
+RUN apt-get update && apt-get install -y \
+  build-essential \
+  swig
+
+RUN mkdir /temp
+WORKDIR temp
+RUN    wget https://cmake.org/files/v3.7/cmake-3.7.2.tar.gz
+RUN    tar xzvf cmake-3.7.2.tar.gz
+RUN    cd cmake-3.7.2/;  ./configure; make; make install
+RUN export PATH=/usr/local/bin:$PATH
+RUN export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH
+
+
+# Configure the main working directory. This is the base
+# directory used in any further RUN, COPY, and ENTRYPOINT
+# commands.
+RUN mkdir  /virgil-sdk-2.1.10
+WORKDIR /virgil-sdk-2.1.10
+
+# Copy the Gemfile as well as the Gemfile.lock and install
+# the RubyGems. This is a separate step so the dependencies
+# will be cached unless changes to one of those two files
+# are made.
+ADD lib /virgil-sdk-2.1.10/lib
+ADD virgil-sdk.gemspec /virgil-sdk-2.1.10
+ADD Gemfile /virgil-sdk-2.1.10
+RUN gem install bundler && bundle install
+
+ADD . /virgil-sdk-2.1.10

data/dockefiles/Dockerfile-220

@@ -0,0 +1,26 @@
+FROM ruby:2.2.0
+MAINTAINER marfachaiko@gmail.com
+
+# Install apt based dependencies required to run Rails as
+# well as RubyGems. As the Ruby image itself is based on a
+# Debian image, we use apt-get to install those.
+RUN apt-get update && apt-get install -y \
+  build-essential
+
+# Configure the main working directory. This is the base
+# directory used in any further RUN, COPY, and ENTRYPOINT
+# commands.
+RUN mkdir  /virgil-sdk-2.2.0
+WORKDIR /virgil-sdk-2.2.0
+
+# Copy the Gemfile as well as the Gemfile.lock and install
+# the RubyGems. This is a separate step so the dependencies
+# will be cached unless changes to one of those two files
+# are made.
+ADD lib /virgil-sdk-2.2.0/lib
+ADD virgil-sdk.gemspec /virgil-sdk-2.2.0
+ADD Gemfile /virgil-sdk-2.2.0
+RUN gem install bundler && bundle install --jobs 20 --retry 5
+
+ADD . /virgil-sdk-2.2.0
+

data/dockefiles/Dockerfile-226

@@ -0,0 +1,25 @@
+FROM ruby:2.2.6
+MAINTAINER marfachaiko@gmail.com
+
+# Install apt based dependencies required to run Rails as
+# well as RubyGems. As the Ruby image itself is based on a
+# Debian image, we use apt-get to install those.
+RUN apt-get update && apt-get install -y \
+  build-essential
+
+# Configure the main working directory. This is the base
+# directory used in any further RUN, COPY, and ENTRYPOINT
+# commands.
+RUN mkdir  /virgil-sdk-2.2.6
+WORKDIR /virgil-sdk-2.2.6
+
+# Copy the Gemfile as well as the Gemfile.lock and install
+# the RubyGems. This is a separate step so the dependencies
+# will be cached unless changes to one of those two files
+# are made.
+ADD lib /virgil-sdk-2.2.6/lib
+ADD virgil-sdk.gemspec /virgil-sdk-2.2.6
+ADD Gemfile /virgil-sdk-2.2.6
+RUN gem install bundler && bundle install --jobs 20 --retry 5
+
+ADD . /virgil-sdk-2.2.6

data/dockefiles/Dockerfile-233

@@ -0,0 +1,25 @@
+FROM ruby:2.3.3
+MAINTAINER marfachaiko@gmail.com
+
+# Install apt based dependencies required to run Rails as
+# well as RubyGems. As the Ruby image itself is based on a
+# Debian image, we use apt-get to install those.
+RUN apt-get update && apt-get install -y \
+  build-essential
+
+# Configure the main working directory. This is the base
+# directory used in any further RUN, COPY, and ENTRYPOINT
+# commands.
+RUN mkdir  /virgil-sdk-2.3.3
+WORKDIR /virgil-sdk-2.3.3
+
+# Copy the Gemfile as well as the Gemfile.lock and install
+# the RubyGems. This is a separate step so the dependencies
+# will be cached unless changes to one of those two files
+# are made.
+ADD lib /virgil-sdk-2.3.3/lib
+ADD virgil-sdk.gemspec /virgil-sdk-2.3.3
+ADD Gemfile /virgil-sdk-2.3.3
+RUN gem install bundler && bundle install --jobs 20 --retry 5
+
+ADD . /virgil-sdk-2.3.3

data/dockefiles/Dockerfile-240

@@ -0,0 +1,26 @@
+FROM ruby:2.4.0
+MAINTAINER marfachaiko@gmail.com
+
+# Install apt based dependencies required to run Rails as
+# well as RubyGems. As the Ruby image itself is based on a
+# Debian image, we use apt-get to install those.
+RUN apt-get update && apt-get install -y \
+  build-essential
+
+# Configure the main working directory. This is the base
+# directory used in any further RUN, COPY, and ENTRYPOINT
+# commands.
+RUN mkdir  /virgil-sdk-2.4.0
+WORKDIR /virgil-sdk-2.4.0
+
+# Copy the Gemfile as well as the Gemfile.lock and install
+# the RubyGems. This is a separate step so the dependencies
+# will be cached unless changes to one of those two files
+# are made.
+ADD lib /virgil-sdk-2.4.0/lib
+ADD virgil-sdk.gemspec /virgil-sdk-2.4.0
+ADD Gemfile /virgil-sdk-2.4.0
+RUN gem install bundler && bundle install --jobs 20 --retry 5
+
+ADD . /virgil-sdk-2.4.0
+

data/docker-compose.yml

@@ -0,0 +1,107 @@
+version: '2'
+services:
+# Unsupported versions should return ERRORS:
+#   2.0.0- virgil-crypto can't be installed.
+#   2.1.10 - virgil-sdk can't be installed
+#
+#  sdk-2.0.0:
+#    build:
+#      context: .
+#      dockerfile: dockefiles/Dockerfile-200
+#    command: bundle exec rake
+#    volumes:
+#      - .:/virgil-sdk-ruby-2.0.0
+#    environment:
+#        VIRGIL_ACCESS_TOKEN: ${VIRGIL_ACCESS_TOKEN}
+#        VIRGIL_APP_ID: ${VIRGIL_APP_ID}
+#        VIRGIL_SERVICE_URL: ${VIRGIL_SERVICE_URL}
+#        VIRGIL_READ_ONLY_SERVICE_URL: ${VIRGIL_READ_ONLY_SERVICE_URL}
+#        VIRGIL_IDENTITY_SERVICE_URL: ${VIRGIL_IDENTITY_SERVICE_URL}
+#        VIRGIL_APP_BUNDLE: ${VIRGIL_APP_BUNDLE}
+#        VIRGIL_APP_KEY_PATH: ${VIRGIL_APP_KEY_NAME}
+#        VIRGIL_APP_KEY_PASSWORD: ${VIRGIL_APP_KEY_PASSWORD}
+
+#  sdk-2.1.10:
+#    build:
+#      context: .
+#      dockerfile: dockefiles/Dockerfile-2110
+#    command: bundle exec rake
+#    volumes:
+#      - .:/virgil-sdk-ruby-2.1.10
+#    environment:
+#        VIRGIL_ACCESS_TOKEN: ${VIRGIL_ACCESS_TOKEN}
+#        VIRGIL_APP_ID: ${VIRGIL_APP_ID}
+#        VIRGIL_SERVICE_URL: ${VIRGIL_SERVICE_URL}
+#        VIRGIL_READ_ONLY_SERVICE_URL: ${VIRGIL_READ_ONLY_SERVICE_URL}
+#        VIRGIL_IDENTITY_SERVICE_URL: ${VIRGIL_IDENTITY_SERVICE_URL}
+#        VIRGIL_APP_BUNDLE: ${VIRGIL_APP_BUNDLE}
+#        VIRGIL_APP_KEY_PATH: ${VIRGIL_APP_KEY_NAME}
+#        VIRGIL_APP_KEY_PASSWORD: ${VIRGIL_APP_KEY_PASSWORD}
+
+  sdk-2.2.0:
+    build:
+      context: .
+      dockerfile: dockefiles/Dockerfile-220
+    command: bundle exec rake
+    volumes:
+      - .:/virgil-sdk-ruby-2.2.0
+    environment:
+        VIRGIL_ACCESS_TOKEN: ${VIRGIL_ACCESS_TOKEN}
+        VIRGIL_APP_ID: ${VIRGIL_APP_ID}
+        VIRGIL_SERVICE_URL: ${VIRGIL_SERVICE_URL}
+        VIRGIL_READ_ONLY_SERVICE_URL: ${VIRGIL_READ_ONLY_SERVICE_URL}
+        VIRGIL_IDENTITY_SERVICE_URL: ${VIRGIL_IDENTITY_SERVICE_URL}
+        VIRGIL_APP_BUNDLE: ${VIRGIL_APP_BUNDLE}
+        VIRGIL_APP_KEY_PATH: ${VIRGIL_APP_KEY_NAME}
+        VIRGIL_APP_KEY_PASSWORD: ${VIRGIL_APP_KEY_PASSWORD}
+
+  sdk-2.2.6:
+      build:
+        context: .
+        dockerfile: dockefiles/Dockerfile-226
+      command: bundle exec rake
+      volumes:
+        - .:/virgil-sdk-ruby-2.2.6
+      environment:
+          VIRGIL_ACCESS_TOKEN: ${VIRGIL_ACCESS_TOKEN}
+          VIRGIL_APP_ID: ${VIRGIL_APP_ID}
+          VIRGIL_SERVICE_URL: ${VIRGIL_SERVICE_URL}
+          VIRGIL_READ_ONLY_SERVICE_URL: ${VIRGIL_READ_ONLY_SERVICE_URL}
+          VIRGIL_IDENTITY_SERVICE_URL: ${VIRGIL_IDENTITY_SERVICE_URL}
+          VIRGIL_APP_BUNDLE: ${VIRGIL_APP_BUNDLE}
+          VIRGIL_APP_KEY_PATH: ${VIRGIL_APP_KEY_NAME}
+          VIRGIL_APP_KEY_PASSWORD: ${VIRGIL_APP_KEY_PASSWORD}
+
+  sdk-2.3.3:
+      build:
+        context: .
+        dockerfile: dockefiles/Dockerfile-233
+      command: bundle exec rake
+      volumes:
+        - .:/virgil-sdk-ruby-2.3.3
+      environment:
+          VIRGIL_ACCESS_TOKEN: ${VIRGIL_ACCESS_TOKEN}
+          VIRGIL_APP_ID: ${VIRGIL_APP_ID}
+          VIRGIL_SERVICE_URL: ${VIRGIL_SERVICE_URL}
+          VIRGIL_READ_ONLY_SERVICE_URL: ${VIRGIL_READ_ONLY_SERVICE_URL}
+          VIRGIL_IDENTITY_SERVICE_URL: ${VIRGIL_IDENTITY_SERVICE_URL}
+          VIRGIL_APP_BUNDLE: ${VIRGIL_APP_BUNDLE}
+          VIRGIL_APP_KEY_PATH: ${VIRGIL_APP_KEY_NAME}
+          VIRGIL_APP_KEY_PASSWORD: ${VIRGIL_APP_KEY_PASSWORD}
+
+  sdk-2.4.0:
+      build:
+        context: .
+        dockerfile: dockefiles/Dockerfile-240
+      command: bundle exec rake
+      volumes:
+        - .:/virgil-sdk-ruby-2.4.0
+      environment:
+          VIRGIL_ACCESS_TOKEN: ${VIRGIL_ACCESS_TOKEN}
+          VIRGIL_APP_ID: ${VIRGIL_APP_ID}
+          VIRGIL_SERVICE_URL: ${VIRGIL_SERVICE_URL}
+          VIRGIL_READ_ONLY_SERVICE_URL: ${VIRGIL_READ_ONLY_SERVICE_URL}
+          VIRGIL_IDENTITY_SERVICE_URL: ${VIRGIL_IDENTITY_SERVICE_URL}
+          VIRGIL_APP_BUNDLE: ${VIRGIL_APP_BUNDLE}
+          VIRGIL_APP_KEY_PATH: ${VIRGIL_APP_KEY_NAME}
+          VIRGIL_APP_KEY_PASSWORD: ${VIRGIL_APP_KEY_PASSWORD}