virgil-sdk 4.2.3

data/lib/virgil/sdk/cryptography.rb

@@ -0,0 +1,42 @@
+# 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 Cryptography
+      autoload :VirgilCrypto, 'virgil/sdk/cryptography/virgil_crypto'
+      autoload :Keys, 'virgil/sdk/cryptography/keys'
+      autoload :Hashes, 'virgil/sdk/cryptography/hashes'
+    end
+  end
+end

data/lib/virgil/sdk/cryptography/hashes.rb

@@ -0,0 +1,44 @@
+# 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 Cryptography
+      module Hashes
+        autoload :HashAlgorithm, 'virgil/sdk/cryptography/hashes/hash_algorithm'
+        autoload :Fingerprint, 'virgil/sdk/cryptography/hashes/fingerprint'
+      end
+    end
+  end
+end

data/lib/virgil/sdk/cryptography/hashes/fingerprint.rb

@@ -0,0 +1,79 @@
+# 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 Cryptography
+      module Hashes
+        # Fingerprint container class.
+        #
+        # Class provides methods for importing and exporting fingerprints.
+        class Fingerprint
+          def initialize(fingerprint_bytes)
+            @fingerprint_bytes = fingerprint_bytes
+          end
+
+          # Creates new Fingerprint from hex.
+          #
+          # Args:
+          #   fingerprint_hex: hex string of the fingerprint.
+          #
+          # Returns:
+          #   Imported Fingerprint.
+          def self.from_hex(fingerprint_hex)
+            data = Crypto::Native::VirgilByteArrayUtils.hex_to_bytes(fingerprint_hex)
+            return self.new(data)
+          end
+
+          # Raw fingerprint value.
+          #
+          #  Returns:
+          #    Fingerprint bytes.
+          def value
+            @fingerprint_bytes
+          end
+
+          # Fingerprint data in hexadecimal.
+          #
+          # Returns:
+          #   Hexademical fingerprint representation.
+          def to_hex
+            hex_data = Crypto::Native::VirgilByteArrayUtils.bytes_to_hex(value)
+            return hex_data
+          end
+        end
+      end
+    end
+  end
+end

data/lib/virgil/sdk/cryptography/hashes/hash_algorithm.rb

@@ -0,0 +1,91 @@
+# 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 Cryptography
+      module Hashes
+        # Enumeration containing supported Algorithms
+        class HashAlgorithm
+
+          # Exception raised when Unknown Algorithm passed to convertion method
+          class UnknownAlgorithmException < StandardError
+            def initialize(algorithm)
+              @algorithm = algorithm
+              super
+            end
+
+            def to_s
+              "KeyPairType not found: #{@algorithm}"
+            end
+          end
+
+          MD5 = :MD5
+          SHA1 = :SHA1
+          SHA224 = :SHA224
+          SHA256 = :SHA256
+          SHA384 = :SHA384
+          SHA512 = :SHA512
+
+          ALGORITHMS_TO_NATIVE = {
+            MD5: Crypto::Native::VirgilHash::Algorithm_MD5,
+            SHA1: Crypto::Native::VirgilHash::Algorithm_SHA1,
+            SHA224: Crypto::Native::VirgilHash::Algorithm_SHA224,
+            SHA256: Crypto::Native::VirgilHash::Algorithm_SHA256,
+            SHA384: Crypto::Native::VirgilHash::Algorithm_SHA384,
+            SHA512: Crypto::Native::VirgilHash::Algorithm_SHA512,
+          }
+
+          # Converts algorithm enum value to native value
+          #
+          # Args:
+          #   algorithm: algorithm for conversion.
+
+          # Returns:
+          #   Native library algorithm id.
+
+          # Raises:
+          #   UnknownAlgorithmException: if algorithm is not supported.
+          def self.convert_to_native(algorithm)
+            if ALGORITHMS_TO_NATIVE.has_key?(algorithm)
+              return ALGORITHMS_TO_NATIVE[algorithm]
+            end
+            raise cls.UnknownAlgorithmException(algorithm)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/virgil/sdk/cryptography/keys.rb

@@ -0,0 +1,48 @@
+# 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 Cryptography
+      module Keys
+        autoload :PublicKey, 'virgil/sdk/cryptography/keys/public_key'
+        autoload :PrivateKey, 'virgil/sdk/cryptography/keys/private_key'
+        autoload :KeyPair, 'virgil/sdk/cryptography/keys/key_pair'
+        autoload :KeyPairType, 'virgil/sdk/cryptography/keys/key_pair_type'
+        autoload :KeyStorage, 'virgil/sdk/cryptography/keys/key_storage'
+        autoload :StorageItem, 'virgil/sdk/cryptography/keys/storage_item'
+      end
+    end
+  end
+end

data/lib/virgil/sdk/cryptography/keys/key_pair.rb

@@ -0,0 +1,46 @@
+# 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 Cryptography
+      module Keys
+        # Class containing key pair information
+        KeyPair = Struct.new(:private_key, :public_key) do
+
+        end
+      end
+    end
+  end
+end

data/lib/virgil/sdk/cryptography/keys/key_pair_type.rb

@@ -0,0 +1,108 @@
+# 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 Cryptography
+      module Keys
+        # Enumeration containing supported KeyPairTypes
+        class KeyPairType
+          # Exception raised when Unknown Type passed to convertion method
+          class UnknownTypeException < StandardError
+            def initialize(key_pair_type)
+              @key_pair_type = key_pair_type
+              super
+            end
+
+            def to_s
+              "KeyPairType not found: #{@key_pair_type}"
+            end
+          end
+
+          Default = :Default
+          RSA_2048 = :RSA_2048
+          RSA_3072 = :RSA_3072
+          RSA_4096 = :RSA_4096
+          RSA_8192 = :RSA_8192
+          EC_SECP256R1 = :EC_SECP256R1
+          EC_SECP384R1 = :EC_SECP384R1
+          EC_SECP521R1 = :EC_SECP521R1
+          EC_BP256R1 = :EC_BP256R1
+          EC_BP384R1 = :EC_BP384R1
+          EC_BP512R1 = :EC_BP512R1
+          EC_SECP256K1 = :EC_SECP256K1
+          EC_CURVE25519 = :EC_CURVE25519
+          FAST_EC_X25519 = :FAST_EC_X25519
+          FAST_EC_ED25519 = :FAST_EC_ED25519
+
+          TYPES_TO_NATIVE = {
+            Default: Crypto::Native::VirgilKeyPair::Type_FAST_EC_ED25519,
+            RSA_2048: Crypto::Native::VirgilKeyPair::Type_RSA_2048,
+            RSA_3072: Crypto::Native::VirgilKeyPair::Type_RSA_3072,
+            RSA_4096: Crypto::Native::VirgilKeyPair::Type_RSA_4096,
+            RSA_8192: Crypto::Native::VirgilKeyPair::Type_RSA_8192,
+            EC_SECP256R1: Crypto::Native::VirgilKeyPair::Type_EC_SECP256R1,
+            EC_SECP384R1: Crypto::Native::VirgilKeyPair::Type_EC_SECP384R1,
+            EC_SECP521R1: Crypto::Native::VirgilKeyPair::Type_EC_SECP521R1,
+            EC_BP256R1: Crypto::Native::VirgilKeyPair::Type_EC_BP256R1,
+            EC_BP384R1: Crypto::Native::VirgilKeyPair::Type_EC_BP384R1,
+            EC_BP512R1: Crypto::Native::VirgilKeyPair::Type_EC_BP512R1,
+            EC_SECP256K1: Crypto::Native::VirgilKeyPair::Type_EC_SECP256K1,
+            EC_CURVE25519: Crypto::Native::VirgilKeyPair::Type_EC_CURVE25519,
+            FAST_EC_X25519: Crypto::Native::VirgilKeyPair::Type_FAST_EC_X25519,
+            FAST_EC_ED25519: Crypto::Native::VirgilKeyPair::Type_FAST_EC_ED25519,
+          }
+
+          # Converts type enum value to native value
+          #
+          # Args:
+          #   key_pair_type: type id for conversion.
+          #
+          # Returns:
+          #   Native library key pair type id.
+          #
+          # Raises:
+          #   UnknownTypeException: if type is not supported.
+          def self.convert_to_native(key_pair_type)
+            if TYPES_TO_NATIVE.has_key?(key_pair_type)
+              return TYPES_TO_NATIVE[key_pair_type]
+            end
+            raise UnknownTypeException.new(key_pair_type)
+          end
+        end
+      end
+    end
+  end
+end