virgil-sdk 4.2.3

data/lib/virgil/sdk.rb

@@ -0,0 +1,10 @@
+require "virgil/sdk/version"
+require "virgil/crypto"
+
+module Virgil
+  module SDK
+    autoload :Cryptography, 'virgil/sdk/cryptography'
+    autoload :Client, 'virgil/sdk/client'
+    autoload :HighLevel, 'virgil/sdk/high_level'
+  end
+end

data/lib/virgil/sdk/client.rb

@@ -0,0 +1,47 @@
+# Copyright (C) 2016 Virgil Security Inc.
+#
+# Lead Maintainer: Virgil Security Inc. <support@virgilsecurity.com>
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#   (1) Redistributions of source code must retain the above copyright
+#   notice, this list of conditions and the following disclaimer.
+#
+#   (2) Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in
+#   the documentation and/or other materials provided with the
+#   distribution.
+#
+#   (3) Neither the name of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY EXPRESS OR
+# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, bytes, OR PROFITS; OR BUSINESS INTERRUPTION)
+# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+module Virgil
+  module SDK
+    module Client
+      autoload :SignaturesBase64, 'virgil/sdk/client/signatures_base64'
+      autoload :Card, 'virgil/sdk/client/card'
+      autoload :CardValidator, 'virgil/sdk/client/card_validator'
+      autoload :SearchCriteria, 'virgil/sdk/client/search_criteria'
+      autoload :RequestSigner, 'virgil/sdk/client/request_signer'
+      autoload :VirgilClient, 'virgil/sdk/client/virgil_client'
+      autoload :HTTP, 'virgil/sdk/client/http'
+      autoload :Requests, 'virgil/sdk/client/requests'
+    end
+  end
+end

data/lib/virgil/sdk/client/card.rb

@@ -0,0 +1,142 @@
+# Copyright (C) 2016 Virgil Security Inc.
+#
+# Lead Maintainer: Virgil Security Inc. <support@virgilsecurity.com>
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#     (1) Redistributions of source code must retain the above copyright
+#     notice, this list of conditions and the following disclaimer.
+#
+#     (2) Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in
+#     the documentation and/or other materials provided with the
+#     distribution.
+#
+#     (3) Neither the name of the copyright holder nor the names of its
+#     contributors may be used to endorse or promote products derived from
+#     this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY EXPRESS OR
+# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+require 'base64'
+require 'json'
+module Virgil
+  module SDK
+    module Client
+      # Model representing cards information.
+      Card = Struct.new(:id, :snapshot, :identity,
+                        :identity_type, :public_key, :scope,
+                        :data, :device, :device_name, :version,
+                        :signatures, :validation_token) do
+
+        extend SignaturesBase64
+
+        def initialize(options)
+          self.id = options[:id]
+          self.snapshot = options[:snapshot]
+          self.identity = options[:identity]
+          self.identity_type = options[:identity_type]
+          self.public_key = options[:public_key]
+          self.scope = options[:scope]
+          self.data = options[:data] || {}
+          self.device = options[:device]
+          self.device_name = options[:device_name]
+          self.version = options[:version]
+          self.signatures = options[:signatures] || {}
+        end
+
+        # Create new Card from response containing json-encoded snapshot.
+        # Args:
+        #     response: Cards service response containing base64 encoded content_snapshot.
+        # Returns:
+        #     Card model restored from snapshot.
+        def self.from_response(response)
+          snapshot = Base64.decode64(response["content_snapshot"])
+          snapshot_model = JSON.parse(snapshot)
+          info = snapshot_model.fetch("info", {}) || {}
+
+          return new(
+              id: response["id"],
+              snapshot: snapshot,
+              identity: snapshot_model["identity"],
+              identity_type: snapshot_model["identity_type"],
+              public_key: Virgil::Crypto::Bytes.from_base64(
+                  snapshot_model["public_key"]
+              ),
+              device: info["device"],
+              device_name: info["device_name"],
+              data: snapshot_model.fetch("data", {}),
+              scope: snapshot_model["scope"],
+              version: response["meta"]["card_version"],
+              signatures: response["meta"]["signs"]
+          )
+        end
+
+
+
+
+        def to_request
+          request = Virgil::SDK::Client::Requests::CreateCardRequest.new({})
+          request.restore(Crypto::Bytes.from_string(self.snapshot), self.signatures, validation_token)
+          request
+        end
+
+        def export
+          self.to_request.export
+        end
+
+
+        def self.from_request_model(request_model)
+          snapshot = Base64.decode64(request_model[:content_snapshot])
+          # if request_model[:content_snapshot].is_a?(Array)
+          #   snapshot = Virgil::Crypto::Bytes.new(request_model[:content_snapshot]).to_s
+          # end
+
+          snapshot_model = JSON.parse(snapshot)
+          meta = request_model[:meta]
+          info = snapshot_model.fetch("info", {}) || {}
+          return new(
+              snapshot: snapshot,
+              identity: snapshot_model["identity"],
+              identity_type: snapshot_model["identity_type"],
+              public_key: Virgil::Crypto::Bytes.from_base64(
+                  snapshot_model["public_key"]
+              ),
+              device: info["device"],
+              device_name: info["device_name"],
+              data: snapshot_model.fetch("data", {}),
+              scope: snapshot_model["scope"],
+              signatures: meta[:signs]
+          )
+        end
+
+
+      end
+
+      Card::APPLICATION = "application"
+      Card::GLOBAL = "global"
+
+
+
+
+      Card::SERVICE_URL = ENV["VIRGIL_SERVICE_URL"] || "https://ra.virgilsecurity.com"
+      Card::READ_ONLY_SERVICE_URL = ENV["VIRGIL_READ_ONLY_SERVICE_URL"] || "https://cards-ro.virgilsecurity.com"
+
+      Card::VRA_VERSION = "v1" # version of service, which creates and deletes local and global cards
+      Card::VC_VERSION = "v4" # version of service, which gets, searchs card
+    end
+  end
+end

data/lib/virgil/sdk/client/card_validator.rb

@@ -0,0 +1,104 @@
+# Copyright (C) 2016 Virgil Security Inc.
+#
+# Lead Maintainer: Virgil Security Inc. <support@virgilsecurity.com>
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#     (1) Redistributions of source code must retain the above copyright
+#     notice, this list of conditions and the following disclaimer.
+#
+#     (2) Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in
+#     the documentation and/or other materials provided with the
+#     distribution.
+#
+#     (3) Neither the name of the copyright holder nor the names of its
+#     contributors may be used to endorse or promote products derived from
+#     this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY EXPRESS OR
+# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+
+
+module Virgil
+  module SDK
+    module Client
+      # Class used for cards signatures validation.
+      class CardValidator
+        SERVICE_CARD_ID =
+          '3e29d43373348cfb373b7eae189214dc01d7237765e572db685839b64adca853'
+        SERVICE_PUBLIC_KEY =
+          'LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUNvd0JRWURLMlZ3QXlFQVlSNTAx'\
+          'a1YxdFVuZTJ1T2RrdzRrRXJSUmJKcmMyU3lhejVWMWZ1RytyVnM9Ci0tLS0tRU5E'\
+          'IFBVQkxJQyBLRVktLS0tLQo='
+
+        attr_reader :crypto, :verifiers
+
+        def initialize(crypto)
+          @crypto = crypto
+          @public_key_bytes = Crypto::Bytes.from_base64(SERVICE_PUBLIC_KEY)
+          @public_key = crypto.import_public_key(@public_key_bytes)
+          @verifiers = {
+            SERVICE_CARD_ID => @public_key
+          }
+        end
+
+        #  Add signature verifier.
+        #
+        #  Args:
+        #      card_id: Card identifier
+        #      public_key: Public key used for signature verification.
+        def add_verifier(card_id, public_key)
+          @verifiers[card_id] = public_key
+        end
+
+        # Validates Card using verifiers.
+        #
+        # Args:
+        #     card: Card for validation.
+        # Returns:
+        #     True if card signatures are valid, false otherwise.
+        def is_valid?(card)
+
+          return true if (card.version == '4.0' || card.version == '3.0')
+
+          fingerprint = self.crypto.calculate_fingerprint(
+            Crypto::Bytes.from_string(card.snapshot)
+          )
+          fingerprint_hex = fingerprint.to_hex
+          return false if fingerprint_hex != card.id
+
+          verifiers = self.verifiers.clone
+          card_public_key = self.crypto.import_public_key(card.public_key)
+          verifiers[fingerprint_hex] = card_public_key
+          verifiers.each do |id, key|
+            unless card.signatures.has_key?(id)
+              return false
+            end
+            is_valid = self.crypto.verify(
+              fingerprint.value,
+              Crypto::Bytes.from_base64(card.signatures[id]),
+              key
+            )
+            return false unless is_valid
+          end
+          true
+        end
+      end
+    end
+  end
+end

data/lib/virgil/sdk/client/http.rb

@@ -0,0 +1,45 @@
+# Copyright (C) 2016 Virgil Security Inc.
+#
+# Lead Maintainer: Virgil Security Inc. <support@virgilsecurity.com>
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#   (1) Redistributions of source code must retain the above copyright
+#   notice, this list of conditions and the following disclaimer.
+#
+#   (2) Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in
+#   the documentation and/or other materials provided with the
+#   distribution.
+#
+#   (3) Neither the name of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY EXPRESS OR
+# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, bytes, OR PROFITS; OR BUSINESS INTERRUPTION)
+# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+module Virgil
+  module SDK
+    module Client
+      module HTTP
+        autoload :Request, 'virgil/sdk/client/http/request'
+        autoload :BaseConnection, 'virgil/sdk/client/http/base_connection'
+        autoload :CardsServiceConnection,
+                 'virgil/sdk/client/http/cards_service_connection'
+      end
+    end
+  end
+end

data/lib/virgil/sdk/client/http/base_connection.rb

@@ -0,0 +1,112 @@
+# Copyright (C) 2016 Virgil Security Inc.
+#
+# Lead Maintainer: Virgil Security Inc. <support@virgilsecurity.com>
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#   (1) Redistributions of source code must retain the above copyright
+#   notice, this list of conditions and the following disclaimer.
+#
+#   (2) Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in
+#   the documentation and/or other materials provided with the
+#   distribution.
+#
+#   (3) Neither the name of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY EXPRESS OR
+# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+
+module Virgil
+  module SDK
+    module Client
+      module HTTP
+        # Base API service connection class.
+        class BaseConnection
+          class ApiError < StandardError
+          end
+
+          ERRORS = {}
+
+          attr_accessor :access_token, :base_url
+
+          # Constructs new BaseConnection object.
+          def initialize(access_token, base_url)
+            self.access_token = access_token
+            self.base_url = base_url
+          end
+
+          # Sends http request to the endpoint.
+          #
+          # Args:
+          #   request: HTTP::Request object containing sending request data.
+          #
+          # Returns:
+          #   Deserialized ruby object from the json response.
+          #
+          # Raises:
+          #   HTTPError with error message decoded from errors dictionary.
+          def send_request(request)
+            response = faraday_connection.run_request(
+                request.method,
+                request.endpoint,
+                request.body,
+                request.headers
+            )
+            return response.body if response.success?
+
+            raise ApiError.new(error_message(response))
+
+          end
+
+          private
+
+          def faraday_connection
+            @faraday_connection ||= Faraday.new(url: base_url) do |connection|
+              if access_token
+                connection.authorization :VIRGIL, access_token
+              end
+              connection.request :json
+              connection.response :json, :content_type => /\bjson$/
+              connection.response :follow_redirects
+              connection.adapter Faraday.default_adapter
+            end
+          end
+
+
+          def error_message(response)
+            error_message = nil
+            error_body = response.body
+            if error_body
+              error_body = JSON.parse(error_body) unless error_body.is_a? Hash
+              error_code = error_body['code'] ||
+                  (error_body['error'] && error_body['error']['code'])
+              error_message = self.class::ERRORS[error_code] || error_code
+            end
+            # token = attempt.confirm(emailConfirmation)
+            error_message = "Error code is #{response.status}" unless error_message
+            error_message
+          end
+        end
+      end
+    end
+  end
+end