virgil-crypto 2.3.0 → 3.6.2

data/lib/virgil/crypto.rb

@@ -1,10 +1,54 @@
+# Copyright (C) 2015-2019 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.
+
 require "virgil/crypto/version"
-module Virgil
-  module Crypto
-    autoload :Virgil_crypto_ruby, 'virgil/crypto/virgil_crypto_ruby'
-    autoload :Bytes, 'virgil/crypto/bytes'
-    autoload :VirgilStreamDataSink, 'virgil/crypto/virgil_stream_data_sink'
-    autoload :VirgilStreamDataSource, 'virgil/crypto/virgil_stream_data_source'
-    Native = Virgil_crypto_ruby
-  end
-end
+require "virgil/crypto/virgil_crypto_ruby.bundle"
+Virgil::Crypto::Core = Virgil_crypto_ruby
+require "virgil/crypto/stream_data_sink"
+require "virgil/crypto/stream_data_source"
+require "virgil/crypto/access_token_signer"
+require "virgil/crypto/private_key_exporter"
+require "virgil/crypto/bytes"
+require "virgil/crypto/card_crypto"
+require "virgil/crypto/crypto_exception"
+require "virgil/crypto/hash_algorithm"
+require "virgil/crypto/key_pair"
+require "virgil/crypto/key_pair_type"
+require "virgil/crypto/private_key"
+require "virgil/crypto/public_key"
+require "virgil/crypto/validation"
+require "virgil/crypto/virgil_crypto"
+
+
+

data/lib/virgil/crypto/access_token_signer.rb

@@ -0,0 +1,79 @@
+# Copyright (C) 2015-2019 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 Crypto
+    # Provides a cryptographic operations in applications, such as signature generation
+    # and verification in an access token.
+    class VirgilAccessTokenSigner
+
+
+      # Represents used signature algorithm.
+      attr_reader :algorithm
+
+      # Initializes a new instance of the [VirgilAccessTokenSigner] class.
+      def initialize
+        @virgil_crypto = VirgilCrypto.new
+        @algorithm = 'VEDS512'
+      end
+
+      # Generates the digital signature for the specified token_bytes
+      #  using the specified [VirgilPrivateKey]
+      # @param token_bytes [Bytes] The material representation bytes of access token
+      # for which to compute the signature.
+      # @param private_key [VirgilPrivateKey] The digital signature for the material representation
+      # bytes of access token.
+      # @return The digital signature for the material representation bytes of access token.
+      def generate_token_signature(token_bytes, private_key)
+        @virgil_crypto.generate_signature(token_bytes, private_key)
+      end
+
+      # Verifies that a digital signature is valid by checking the signature,
+      # provided public_key and token_bytes
+      # @param signature [Bytes] The digital signature for the token_bytes
+      # @param token_bytes [Bytes] The material representation bytes of access token
+      # for which the signature has been generated.
+      # @param public_key [VirgilPublicKey] public
+      # key for verification.
+      # @return [Boolean] True if signature is valid, False otherwise.
+      def verify_token_signature(signature, token_bytes, public_key)
+        @virgil_crypto.verify_signature(signature, token_bytes, public_key)
+      end
+
+      private
+
+      attr_reader :virgil_crypto
+    end
+  end
+end

data/lib/virgil/crypto/bytes.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016 Virgil Security Inc.
+# Copyright (C) 2015-2019 Virgil Security Inc.
 #
 # Lead Maintainer: Virgil Security Inc. <support@virgilsecurity.com>
 #
@@ -8,17 +8,17 @@
 # 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.
+#   (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.
+#   (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.
+#   (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
@@ -26,36 +26,100 @@
 # 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)
+# 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.
+
 require 'base64'
 require 'json'
 
 module Virgil
   module Crypto
     class Bytes < Array
-      def self.from_string(source)
-        new(source.bytes.to_a)
+      # Initializes a new array of bytes from specified string, which encodes binary data.
+      # @param str [String] String to decode.
+      # @param encoding [VirgilStringEncoding] The character encoding of string.
+      # @raise [ArgumentError] if encoding is undefined
+      def self.from_string(str, encoding = VirgilStringEncoding::UTF8)
+        case encoding
+        when VirgilStringEncoding::BASE64
+          from_base64(str)
+        when VirgilStringEncoding::HEX
+          from_hex(str)
+        when VirgilStringEncoding::UTF8
+          from_utf8(str)
+        else
+          raise ArgumentError, 'Encoding is undefined'
+        end
       end
 
-      def self.from_base64(source)
-        new(Base64.decode64(source).bytes)
+      # Decodes the current bytes to a string according to the specified
+      # character encoding.
+      # @param encoding [VirgilStringEncoding] The character encoding to encode to.
+      #    equivalent string representation if raw bytes in selected encoding.
+      # @return [String]
+      # @raise [ArgumentError] if encoding is undefined
+      def to_string(encoding = VirgilStringEncoding::UTF8)
+        case encoding
+        when VirgilStringEncoding::BASE64
+          to_base64
+        when VirgilStringEncoding::HEX
+          to_hex
+        when VirgilStringEncoding::UTF8
+          to_s
+        else
+          raise ArgumentError, 'Encoding is undefined'
+        end
       end
 
+      # Converts all the bytes to its equivalent string representation in utf8.
       def to_s
         pack('c*')
       end
 
-      def to_json(*a)
-        Base64.strict_encode64(to_s).to_json(*a)
+      # Initializes a new array of bytes from specified string,
+      # which encodes binary data as base-64 digits.
+      def self.from_base64(str)
+        new(Base64.decode64(str).bytes)
+      end
+
+      # Initializes a new array of bytes from specified string,
+      # which encodes binary data as utf8.
+      def self.from_utf8(str)
+        new(str.bytes)
       end
 
+      # Initializes a new array of bytes from specified string,
+      # which encodes binary data as hexadecimal digits.
+      def self.from_hex(str)
+        new(str.scan(/../).map { |x| x.hex })
+      end
+
+      # Converts all the bytes to its equivalent string representation that
+      # is encoded with base-64 digits.
       def to_base64
         Base64.strict_encode64(to_s)
       end
+
+      # Encodes all the bytes into a utf8 string.
+      def to_utf8
+        to_s
+      end
+
+      # Converts the numeric value of each element of a current array of bytes to its
+      # equivalent hexadecimal string representation.
+      def to_hex
+        to_s.each_byte.map { |b| b.to_s(16) }.join
+      end
+
+    end
+
+    module VirgilStringEncoding
+      BASE64 = 1
+      HEX = 2
+      UTF8 = 3
     end
   end
 end

data/lib/virgil/crypto/card_crypto.rb

@@ -0,0 +1,115 @@
+# Copyright (C) 2015-2019 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 Crypto
+    # Provides a cryptographic operations in applications, such as hashing,
+    # signature generation and verification, and encryption and decryption.
+    class VirgilCardCrypto
+      attr_reader :virgil_crypto
+
+      # Initializes a new instance of the [VirgilCardCrypto] class.
+      def initialize
+        @virgil_crypto = VirgilCrypto.new
+      end
+
+      # Imports the Public key from material representation.
+      # @param key_bytes [Crypto::Bytes] public key material
+      # representation bytes.
+      # @return [VirgilPublicKey] Imported public key.
+      # @example
+      #   include Virgil::Crypto
+      #   card_crypto = VirgilCardCrypto.new
+      #   public_key = card_crypto.import_public_key(exported_public_key)
+      # @see #export_public_key How to get exported_public_key
+      def import_public_key(key_bytes)
+        @virgil_crypto.import_public_key(key_bytes)
+      end
+
+      # Exports the Public key into material representation.
+      # @param public_key [VirgilPublicKey] public key for export.
+      # @return [Crypto::Bytes] Key material representation bytes.
+      # @example
+      #   include Virgil::Crypto
+      #   crypto = VirgilCrypto.new
+      #   alice_keys = crypto.generate_keys
+      #   card_crypto = VirgilCardCrypto.new
+      #   exported_public_key = card_crypto.export_public_key(alice_keys.public_key)
+      def export_public_key(public_key)
+        @virgil_crypto.export_public_key(public_key)
+      end
+
+      # Signs the specified data using Private key.
+      # @param bytes [Crypto::Bytes] raw data bytes for signing.
+      # @param private_key [VirgilPrivateKey] private key for signing.
+      # @return [Crypto::Bytes] Signature data.
+      # @example Sign the fingerprint of bytes using your private key.
+      #   include Virgil::Crypto
+      #   crypto = VirgilCrypto.new
+      #   alice_keys = crypto.generate_keys()
+      #   # The data to be signed with alice's Private key
+      #   data = Bytes.from_string('Hello Bob, How are you?')
+      #   card_crypto = VirgilCardCrypto.new
+      #   signature = card_crypto.generate_signature(data, alice.private_key)
+      def generate_signature(bytes, private_key)
+        @virgil_crypto.generate_signature(bytes, private_key)
+      end
+
+      # Verifies the specified signature using original data
+      # and signer's public key.
+      # @param bytes [Crypto::Bytes] original data bytes for verification.
+      # @param signature [Crypto::Bytes] signature bytes for verification.
+      # @param signer_public_key [VirgilPublicKey] signer public
+      # key for verification.
+      # @return [Boolean] True if signature is valid, False otherwise.
+      # @example Verify the signature of the fingerprint of
+      # bytes using Public key.
+      #   include Virgil::Crypto
+      #   card_crypto = VirgilCardCrypto.new
+      #   public_key = crypto.import_public_key(exported_public_key)
+      #   data = Bytes.from_string('Hello Bob, How are you?')
+      #   is_valid = card_crypto.verify_signature(signature, data, public_key)
+      def verify_signature(signature, bytes, signer_public_key)
+        @virgil_crypto.verify_signature(signature, bytes, signer_public_key)
+      end
+
+      # Calculates the fingerprint.
+      # @param bytes [Crypto::Bytes] original data bytes to be hashed.
+      # @return [Crypto::Bytes] SHA512 hash value.
+      def generate_SHA512(bytes)
+        @virgil_crypto.generate_hash(bytes)
+      end
+    end
+  end
+end

data/lib/virgil/crypto/crypto_exception.rb

@@ -0,0 +1,40 @@
+# Copyright (C) 2015-2019 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 Crypto
+    class VirgilCryptoException < StandardError
+    end
+  end
+end

data/lib/virgil/crypto/hash_algorithm.rb

@@ -0,0 +1,82 @@
+# Copyright (C) 2015-2019 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 Crypto
+    # Enumeration containing supported Algorithms
+    class HashAlgorithm
+
+      # Exception raised when Unknown Algorithm passed to converting 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: Core::VirgilHash::Algorithm_MD5,
+        SHA1: Core::VirgilHash::Algorithm_SHA1,
+        SHA224: Core::VirgilHash::Algorithm_SHA224,
+        SHA256: Core::VirgilHash::Algorithm_SHA256,
+        SHA384: Core::VirgilHash::Algorithm_SHA384,
+        SHA512: Core::VirgilHash::Algorithm_SHA512
+      }
+
+
+      # Converts algorithm enum value to native value
+      # @param algorithm [HashAlgorithm] algorithm for conversion.
+      # @return [Integer] Native library algorithm id.
+      # @raise [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 UnknownAlgorithmException("KeyPairType not found: #{algorithm}")
+      end
+    end
+  end
+end