virgil-sdk 4.2.3

data/lib/virgil/sdk/high_level/virgil_identity/validation_token.rb

@@ -0,0 +1,49 @@
+# 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 HighLevel
+      module VirgilIdentity
+        class ValidationToken
+          attr_reader :value
+
+          def initialize(value)
+            @value = value
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/virgil/sdk/high_level/virgil_identity/verification_attempt.rb

@@ -0,0 +1,69 @@
+# 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 HighLevel
+      module VirgilIdentity
+        class VerificationAttempt
+          attr_reader :action_id, :context, :additional_options, :identity, :identity_type
+
+          def initialize(context:, action_id:, identity:, identity_type:, additional_options: nil)
+            @context = context
+            @action_id = action_id
+            @identity = identity
+            @identity_type = identity_type
+            @additional_options = additional_options || VerificationOptions.new
+          end
+
+
+          def confirm(confirmation)
+            raise ConfirmationIsNotValid unless confirmation
+            token = confirmation.confirm_and_grab_validation_token(self, self.context.client)
+            ValidationToken.new(token)
+
+          end
+        end
+
+
+        class ConfirmationIsNotValid < StandardError
+          def to_s
+            "Confirmation is not valid"
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/virgil/sdk/high_level/virgil_identity/verification_options.rb

@@ -0,0 +1,56 @@
+# 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 HighLevel
+      module VirgilIdentity
+        class VerificationOptions
+
+          # time_to_live is used to limit the lifetime of the token in
+          # seconds (maximum value is 60 * 60 * 24 * 365 = 1 year). Default value is 3600.
+          #
+          # count_to_live parameter is used to restrict the number of validation token
+          # usages (maximum value is 100).
+          attr_reader :time_to_live, :count_to_live
+
+          def initialize(options = {})
+            @time_to_live = options[:time_to_live] || 3600
+            @count_to_live = options[:count_to_live] || 12
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/virgil/sdk/high_level/virgil_key.rb

@@ -0,0 +1,168 @@
+# 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 HighLevel
+      # This class represents a user's high-level Private key which provides
+      # a list of methods that allows to store the key and perform cryptographic operations like
+      # Decrypt, Sign etc.
+      class VirgilKey
+        attr_reader :context, :private_key
+
+        def initialize(context, private_key)
+          @context = context
+          @private_key = private_key
+        end
+
+
+        # Decrypts the specified cipher data using Virgil key.
+        #
+        # Args:
+        #   cipher_buffer: The encrypted data wrapped by VirgilBuffer.
+        #
+        # Returns:
+        #   A byte array containing the result from performing the operation wrapped by VirgilBuffer.
+        #
+        # Raises:
+        #   ArgumentError: buffer is not valid if buffer doesn't have type VirgilBuffer or String
+        #   Recipient with given identifier is not found  if user tries to decrypt cipher data by private key,
+        #     though its public key was not used for encryption
+        def decrypt(cipher_buffer)
+          VirgilBuffer.validate_buffer_param(cipher_buffer, "cipher buffer")
+          bytes = context.crypto.decrypt(cipher_buffer.bytes, private_key)
+          VirgilBuffer.new(bytes)
+        end
+
+
+        # Generates a digital signature for specified data using current Virgil key.
+        #
+        # Args:
+        #   buffer: The data wrapped by VirgilBuffer for which the digital signature will be generated.
+        #
+        # Returns:
+        #   A new buffer that containing the result from performing the operation.
+        #
+        # Raises:
+        #   ArgumentError: buffer is not valid if buffer doesn't have type VirgilBuffer or String
+        def sign(buffer)
+          VirgilBuffer.validate_buffer_param(buffer)
+          bytes = context.crypto.sign(buffer.bytes, private_key)
+          VirgilBuffer.new(bytes)
+        end
+
+
+        # Encrypts and signs the data.
+        #
+        # Args:
+        #   buffer: The data wrapped by VirgilBuffer to be encrypted and signed
+        #   recipients: The list of VirgilCard recipients.
+        #
+        # Returns:
+        #   A new buffer that containing the encrypted and signed data
+        #
+
+        # Raises:
+        #   ArgumentError: buffer is not valid if buffer doesn't have type VirgilBuffer or String
+        #   ArgumentError: recipients is not valid if recipients doesn't have type Array or empty
+        def sign_then_encrypt(buffer, recipients)
+
+          VirgilBuffer.validate_buffer_param(buffer)
+          raise ArgumentError.new("recipients is not valid") if (!recipients.is_a?(Array) || recipients.empty?)
+          public_keys = recipients.map(&:public_key)
+          bytes = context.crypto.sign_then_encrypt(buffer.bytes, private_key, *public_keys)
+          VirgilBuffer.new(bytes)
+
+        end
+
+
+        # Decrypts and verifies the data.
+        #
+        # Args:
+        #   cipher_buffer: The data to be decrypted and verified
+        #   card: The signer's VirgilCard
+        #
+        # Returns:
+        #   The decrypted data, which is the original plain text before encryption The decrypted data, wrapped by VirgilBuffer
+        #
+        # Raises:
+        #   ArgumentError: buffer is not valid if buffer doesn't have type VirgilBuffer or String
+        #   ArgumentError: recipients is not valid if recipients doesn't have type Array or empty
+        def decrypt_then_verify(cipher_buffer, card)
+
+          VirgilBuffer.validate_buffer_param(cipher_buffer, "cipher buffer")
+          raise ArgumentError.new("card is not valid") unless card.is_a?(VirgilCard)
+
+          bytes = context.crypto.decrypt_then_verify(cipher_buffer.bytes, private_key, card.public_key)
+          VirgilBuffer.new(bytes)
+        end
+
+
+        #  Saves a current VirgilKey in secure storage.
+        #
+        # Args:
+        #   key_name: The name of the key.
+        #   key_password: The key password.
+        #
+        # Returns:
+        #   An instance of VirgilKey class
+        #
+        # Raises:
+        #    KeyEntryAlreadyExistsException: if key storage already has item with such name
+        #   ArgumentError: key_name is not valid if key_name is nil
+        #   KeyStorageException: Destination folder doesn't exist or you don't have permission to write there
+        def save(key_name, key_password=nil)
+
+          raise ArgumentError.new("key_name is not valid") if key_name.nil?
+
+          exported_private_key = context.crypto.export_private_key(private_key, key_password)
+          storage_item = Cryptography::Keys::StorageItem.new(key_name, exported_private_key)
+          context.key_storage.store(storage_item)
+          self
+
+        end
+
+
+        #  Exports the Public key value from current VirgilKey.
+        #
+        # Returns:
+        #   A new VirgilBuffer that contains Public Key value.
+        def export_public_key
+          public_key = context.crypto.extract_public_key(private_key)
+          VirgilBuffer.from_bytes(context.crypto.export_public_key(public_key))
+        end
+
+      end
+    end
+  end
+end

data/lib/virgil/sdk/high_level/virgil_key_manager.rb

@@ -0,0 +1,97 @@
+# 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 HighLevel
+      # this class provides a list of methods to generate the VirgilKey
+      # and further them storage in secure place.
+      class VirgilKeyManager
+        attr_reader :context
+
+        def initialize(context)
+          @context = context
+        end
+
+
+        # Generates a new VirgilKey with default parameters.
+        def generate
+          key_pair = context.crypto.generate_keys()
+          VirgilKey.new(context, key_pair.private_key)
+        end
+
+
+        # Loads the VirgilKey from current storage by specified key name.
+        #
+        # Args:
+        #   key_name: The name of the key.
+        #   key_password: The key password.
+        #
+        # Returns:
+        #   An instance of VirgilKey class
+        #
+        # Raises:
+        #   KeyEntryNotFoundException: if key storage doesn't have item with such name
+        #   ArgumentError: key_name is not valid if key_name is nil
+        #   KeyStorageException: Destination folder doesn't exist or you don't have permission to write there
+        def load(key_name, key_password=nil)
+
+          raise ArgumentError.new("key_name is not valid") if key_name.nil?
+
+          storage_item = context.key_storage.load(key_name)
+          private_key = context.crypto.import_private_key(storage_item.data, key_password)
+          VirgilKey.new(context, private_key)
+
+        end
+
+
+        # Remove the VirgilKey from current storage by specified key name.
+        #
+        # Args:
+        #   key_name: The name of the key.
+        #
+        # Raises:
+        #   KeyEntryNotFoundException: if key storage doesn't have item with such name
+        #   ArgumentError: key_name is not valid if key_name is nil
+        #   KeyStorageException: Destination folder doesn't exist or you don't have permission to write there
+        def delete(key_name)
+
+          raise ArgumentError.new("key_name is not valid") if key_name.nil?
+
+          context.key_storage.delete(key_name)
+        end
+
+      end
+    end
+  end
+end

data/lib/virgil/sdk/version.rb

@@ -0,0 +1,5 @@
+module Virgil
+  module SDK
+    VERSION = "4.2.3"
+  end
+end