virgil-sdk 4.2.3

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

@@ -0,0 +1,113 @@
+# 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
+      module HTTP
+        # Cards service connection class.
+        #
+        # Contains cards service specific errors dictionary.
+        class CardsServiceConnection < BaseConnection
+          ERRORS = {
+              10000 => "Internal application error. You know, shit happens, so do internal server errors.Just take a deep breath and try harder.",
+              20300 => "The Virgil access token was not specified or is invalid",
+              20301 => "The Virgil authenticator service responded with an error",
+              20302 => "The Virgil access token validation has failed on the Virgil Authenticator service",
+              20303 => "The application was not found for the acsses token",
+              20400 => "Request sign is invalid",
+              20401 => "Request sign header is missing",
+              20500 => "The Virgil Card is not available in this application",
+              30000 => "JSON specified as a request is invalid",
+              30010 => "A data inconsistency error",
+              30100 => "Global Virgil Card identity type is invalid, because it can be only an 'email'",
+              30101 => "Virgil Card scope must be either 'global' or 'application'",
+              30102 => "Virgil Card id validation failed",
+              30103 => "Virgil Card data parameter cannot contain more than 16 entries",
+              30104 => "Virgil Card info parameter cannot be empty if specified and must contain 'device' and/or 'device_name' key",
+              30105 => "Virgil Card info parameters length validation failed.The length cannot exceed 256 characters",
+              30106 => "Virgil Card data parameter must be an associative array(https://en.wikipedia.org/wiki/Associative_array)",
+              30107 => "A CSR parameter (content_snapshot) parameter is missing or is incorrect",
+              30111 => "Virgil Card identities passed to search endpoint must be a list of non-empty strings",
+              30113 => "Virgil Card identity type is invalid",
+              30116 => "Virgil Card identity application is invalid",
+              30117 => "Public key length is invalid.It goes from 16 to 2048 bytes",
+              30118 => "Public key must be base64-encoded string",
+              30119 => "Virgil Card data parameter must be a key/value list of strings",
+              30120 => "Virgil Card data parameters must be strings",
+              30121 => "Virgil Card custom data entry value length validation failed.It mustn't exceed 256 characters",
+              30122 => "VirgilIdentity validation token is invalid",
+              30123 => "SCR signs list parameter is missing or is invalid",
+              # 30126 => "SCR sign item signer card id is irrelevant and doesn't match Virgil Card id or Application Id",
+              # 30127 => "SCR sign item signed digest is invalid for the Virgil Card public key",
+              30128 => "SCR sign item signed digest is invalid for the application",
+              30131 => "Virgil Card id specified in the request body must match with the one passed in the URL",
+              30134 => "Virgil Card data parameters key must be aplphanumerical",
+              # 30135 => "Virgil Card validation token must be an object with value parameter",
+              # 30136 => "SCR sign item signed digest is invalid for the virgil identity service",
+              30137 => "Global Virigl Card cannot be created unconfirmed(which means that Virgil VirgilIdentity service sign is mandatory)",
+              30138 => "Virigl Card with the same fingerprint exists already",
+              30139 => "Virigl Card revocation reason isn't specified or is invalid",
+              30140 => "SCR sign validation failed",
+              30141 => "SCR one of signers Virgil Cards is not found",
+              30142 => "SCR sign item is invalid or missing for the Client",
+              30143 => "SCR sign item is invalid or missing for the Virgil Registration Authority service",
+              30300 => "Development Portal sign was not found inside the meta.signs property",
+              30301 => "Development Portal sign is invalid",
+              30302 => "VirgilIdentity Validation Token is invalid or has expired",
+              30303 => "Provided Virgil Card was not found or invalid",
+              40000 => "JSON specified as a request body is invalid",
+              40100 => "VirgilIdentity type is invalid",
+              40110 => "VirgilIdentity's ttl is invalid",
+              40120 => "VirgilIdentity's ctl is invalid",
+              40130 => "VirgilIdentity's token parameter is missing",
+              40140 => "VirgilIdentity's token doesn't match parameters",
+              40150 => "VirgilIdentity's token has expired",
+              40160 => "VirgilIdentity's token cannot be decrypted",
+              40170 => "VirgilIdentity's token parameter is invalid",
+              40180 => "VirgilIdentity is not unconfirmed",
+              40190 => "Hash to be signed parameter is invalid",
+              40200 => "Email identity value validation failed",
+              40210 => "VirgilIdentity's confirmation code is invalid",
+              40300 => "Application value is invalid",
+              40310 => "Application's signed message is invalid",
+              41000 => "VirgilIdentity entity was not found",
+              41010 => "VirgilIdentity's confirmation period has expired",
+              50010 => "Requested route was not found"
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# 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
+      module HTTP
+        # Http request wrapper.
+        #
+        # Attributes:
+        #   endpoint: request endpoint
+        #   body: request body
+        #   headers: dict of request additional headers
+        #   method: http request method
+        Request = Struct.new(:endpoint, :body, :headers, :method) do
+          # Constructs new Request object.
+          def initialize(attributes)
+            self.endpoint = attributes[:endpoint]
+            self.body = attributes[:body]
+            self.headers = attributes[:headers]
+            self.method = attributes[:method]
+          end
+        end
+
+        Request::GET = :get
+        Request::POST = :post
+        Request::PUT = :put
+        Request::DELETE = :delete
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+# 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 signing high_level requests.
+      class RequestSigner
+        attr_reader :crypto
+
+        # Constructs new RequestSigner object
+        def initialize(crypto)
+          @crypto = crypto
+        end
+
+        # Sign passed request with private key.
+        #
+        # Args:
+        #     signable_request: request for signing.
+        #     private_key: private key to sign with.
+        def self_sign(signable_request, private_key)
+          fingerprint = self.crypto.calculate_fingerprint(
+            signable_request.snapshot
+          )
+          signature = self.crypto.sign(
+            fingerprint.value,
+            private_key
+          )
+
+          signable_request.sign_with(
+            fingerprint.to_hex,
+            signature
+          )
+        end
+
+        # Sign passed request with authority private key.
+        #
+        # Args:
+        #     signable_request: request for signing.
+        #     signer_id: authority id.
+        #     private_key: authority private key to sign with.
+        def authority_sign(signable_request, signer_id, private_key)
+          fingerprint = self.crypto.calculate_fingerprint(
+            signable_request.snapshot
+          )
+          signature = self.crypto.sign(
+            fingerprint.value,
+            private_key
+          )
+
+          signable_request.sign_with(
+            signer_id,
+            signature
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# 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 Requests
+        autoload :SignableRequest, 'virgil/sdk/client/requests/signable_request'
+        autoload :RevokeCardRequest,
+                 'virgil/sdk/client/requests/revoke_card_request'
+        autoload :CreateCardRequest,
+                 'virgil/sdk/client/requests/create_card_request'
+        autoload :VerifyIdentityRequest,
+                 'virgil/sdk/client/requests/verify_identity_request'
+        autoload :ConfirmIdentityRequest,
+                  'virgil/sdk/client/requests/confirm_identity_request'
+      end
+    end
+  end
+end

data/lib/virgil/sdk/client/requests/confirm_identity_request.rb

@@ -0,0 +1,67 @@
+# 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
+      module Requests
+        class ConfirmIdentityRequest
+          attr_reader :confirmation_code, :action_id, :time_to_live, :count_to_live
+          #
+          def initialize(confirmation_code, action_id, time_to_live, count_to_live)
+            @confirmation_code = confirmation_code
+            @action_id = action_id
+            @time_to_live = time_to_live
+            @count_to_live = count_to_live
+          end
+
+
+          # # Request model used for json representation.
+          def request_model
+            return {
+                'confirmation_code': confirmation_code,
+                'action_id': action_id,
+                'token': {
+                    'time_to_live': time_to_live,
+                    'count_to_live': count_to_live
+                }
+            }
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/virgil/sdk/client/requests/create_card_request.rb

@@ -0,0 +1,105 @@
+# 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
+      module Requests
+        # Create card signable API request.
+        class CreateCardRequest < SignableRequest
+          attr_accessor :identity, :identity_type, :public_key, :data, :info, :scope
+
+          # Constructs new CreateCardRequest object
+          def initialize(attributes)
+            super()
+            self.identity = attributes[:identity]
+            self.identity_type = attributes[:identity_type]
+            self.public_key = attributes[:raw_public_key]
+            self.scope = attributes[:scope] || Card::APPLICATION
+            self.data = attributes[:data]
+            self.info = attributes[:info]
+          end
+
+          # Restores request from snapshot model.
+          #
+          # Args:
+          #   snapshot_model: snapshot model dict
+          def restore_from_snapshot_model(snapshot_model)
+            self.identity = snapshot_model['identity']
+            self.identity_type = snapshot_model['identity_type']
+            self.public_key = snapshot_model['public_key']
+            self.scope = snapshot_model['scope']
+            self.data = snapshot_model.fetch('data', {})
+            self.info = snapshot_model['info']
+          end
+
+
+          def self.import(data_base64)
+            request = new({})
+            begin
+              request_model = JSON.parse(Base64.decode64(data_base64))
+            rescue JSON::ParserError => e
+              raise ArgumentError.new("data_base64 is not valid")
+            end
+            validation_token = nil
+            if request_model['meta']['validation'] && request_model['meta']['validation']['token']
+              validation_token = Virgil::Crypto::Bytes.from_base64(request_model['meta']['validation']['token'])
+            end
+            request.restore(Virgil::Crypto::Bytes.from_base64(request_model['content_snapshot']),
+                            request_model['meta']['signs'],
+                            validation_token
+            )
+            request
+          end
+
+          # Constructs snapshot model for exporting and signing.
+          #
+          # Returns:
+          #   Dict containing snapshot data model used for card creation request.
+          def snapshot_model
+            model = {
+                'identity': identity,
+                'identity_type': identity_type,
+                'public_key': Virgil::Crypto::Bytes.new(public_key).to_base64,
+                'scope': scope,
+                'data': data
+            }
+            model['info'] = info if (info && info.any?)
+            model
+          end
+        end
+      end
+    end
+  end
+end