freeclimb 4.1.3 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6478ad1652831cea81595098617c0c74fb6d2f1697d09098b87b2c7131ab3a02
-  data.tar.gz: 254f990d422aa7d1fee557e78ffd328cc6800aea723c0841169803cf8ece059d
+  metadata.gz: d7826dfa439ee726cf91d308b8cd9eee895a48d53a425ac24926765525c23760
+  data.tar.gz: cec6eee4ac9ca13157b48a10a23f837c18f684bf3621cbe41fb89655291e493c
 SHA512:
-  metadata.gz: 304c8351ee2b95fbb8b306dc410f065dfc80237b0018d9ba123ba4b6101ed7130f2aa067012afd453439a990e9360f8e30a419861cafbea72ffed16a239b1e8e
-  data.tar.gz: 99a2e12550a6b7ba9e8927e1e87354755870466ddc602d5b728803ea104ff2ac25267d427cdeacf3b242fcc313663ff400f570b695a1686edaa89f1520d3a13e
+  metadata.gz: 0f6600bdf1b690008a0c6dfffb24de9e180e5e58600103e6e556dff32243fde20bd7f8d84ce5fcc1211804487fa82c68fd3f000b70bb1a4126278d4edbbcd537
+  data.tar.gz: c5e79a2cfbf443175d929f7b6ee271ae8a4c8202c93f7823cc8212a1a97ce0aff0b424f93a2ab022c63a3757cd2405bbfc81ab8b72de24bc7eb2835731d47e25

data/CHANGELOG.md

@@ -9,6 +9,22 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 None
 
+<a name="4.2.0"></a>
+
+## [4.2.0] - 2023-04-03
+
+### Added
+
+- Introduce signing secret verification class (RequestVerifier) - https://docs.freeclimb.com/docs/validating-requests-from-freeclimb#how-to-verify-requests-manually
+
+<a name="4.1.4"></a>
+
+## [4.1.4] - 2023-03-31
+
+### Changed
+
+- PerclScript.to_json serialization fixed
+
 <a name="4.1.3"></a>
 
 ## [4.1.3] - 2023-03-13

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    freeclimb (4.1.3)
+    freeclimb (4.2.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.1)
+    activesupport (7.0.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -17,7 +17,7 @@ GEM
     ast (2.4.0)
     byebug (11.1.1)
     coderay (1.1.2)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.2.2)
     crack (0.4.5)
       rexml
     diff-lcs (1.3)
@@ -28,11 +28,11 @@ GEM
       activesupport (>= 5.0.0)
     ffi (1.15.5)
     hashdiff (1.0.1)
-    i18n (1.9.1)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
     method_source (0.9.2)
-    minitest (5.15.0)
+    minitest (5.18.0)
     parallel (1.19.1)
     parser (2.7.0.2)
       ast (~> 2.4.0)
@@ -71,7 +71,7 @@ GEM
     ruby-progressbar (1.10.1)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
-    tzinfo (2.0.4)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.5.0)
     webmock (3.14.0)

data/README.md

@@ -7,7 +7,7 @@ FreeClimb is a cloud-based application programming interface (API) that puts the
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0.0
-- Package version: 4.1.3
+- Package version: 4.2.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://www.freeclimb.com/support/](https://www.freeclimb.com/support/)
 
@@ -15,7 +15,7 @@ For more information, please visit [https://www.freeclimb.com/support/](https://
 
 Add this to the Gemfile:
 
-    gem 'freeclimb', '~> 4.1.3'
+    gem 'freeclimb', '~> 4.2.0'
 
 and run from your terminal
 
@@ -44,9 +44,9 @@ gem build freeclimb.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./freeclimb-4.1.3.gem
+gem install ./freeclimb-4.2.0.gem
 ```
-(for development, run `gem install --dev ./freeclimb-4.1.3.gem` to install the development dependencies)
+(for development, run `gem install --dev ./freeclimb-4.2.0.gem` to install the development dependencies)
 
 ## Getting Started
 
@@ -285,7 +285,30 @@ Class | Method | HTTP request | Description
 
 - **Type**: HTTP basic authentication
 
+<a name="documentation-for-verify-request-signature"></a>
+
+## Documentation for verifying request signature
+
+- To verify the signature request, we will need to use the verifySignatureRequest method within the Request Verifier class
+
+  Freeclimb::RequestVerifier.verify_request_signature(requestBody, requestHeader, signingSecret, tolerance)
+
+  This is a method that you can call directly from the request verifier class, it will throw exceptions depending on whether all parts of the request signature is valid otherwise it will throw a specific error message depending on which request signature part is causing issues
+
+  This method requires a requestBody of type string, a requestHeader of type string, a signingSecret of type string, and a tolerance value of type int
+
+  Example code down below
+
+  ```ruby
+  class RequestVerifier
+    def verify_request_signature_example()
+        request_header = "t=1679944186,v1=c3957749baf61df4b1506802579cc69a74c77a1ae21447b930e5a704f9ec4120,v1=1ba18712726898fbbe48cd862dd096a709f7ad761a5bab14bda9ac24d963a6a8"
+        signing_secret = "sigsec_ead6d3b6904196c60835d039e91b3341c77a7793"
+        tolerance = (5 * 60)
+        request_body =  "{\"accountId\":\"AC1334ffb694cd8d969f51cddf5f7c9b478546d50c\",\"callId\":\"CAccb0b00506553cda09b51c5477f672a49e0b2213\",\"callStatus\":\"ringing\",\"conferenceId\":null,\"direction\":\"inbound\",\"from\":\"+13121000109\",\"parentCallId\":null,\"queueId\":null,\"requestType\":\"inboundCall\",\"to\":\"+13121000096\"}"
+        Freeclimb::RequestVerifier.verify_request_signature(request_body, request_header, signing_secret, tolerance)
+  ```
 
 ## Getting Help
 
-If you are experiencing difficulties, [contact support](https://freeclimb.com/support).
+If you are experiencing difficulties, [contact support](https://freeclimb.com/support).

data/lib/freeclimb/models/percl_command.rb

@@ -221,15 +221,15 @@ module Freeclimb
     end
     def to_percl_hash()
       command = self.command
-      attributes = self.class.openapi_types
-      percl_hash = attributes.each_with_object({}) do |(attr, _type), hash|
+      attributes = self.class.attribute_map
+      percl_hash = attributes.each_with_object({}) do |(attr, percl_attr), hash|
         value = self.send(attr)
         if value.is_a?(Array)
-          hash[attr] = value.compact.map { |v| v.is_a?(PerclCommand) ? v.to_percl_hash() : v }
+          hash[percl_attr] = value.compact.map { |v| v.is_a?(PerclCommand) ? v.to_percl_hash() : v }
         elsif value.is_a?(PerclCommand)
-          hash[attr] = value.to_percl_hash()
+          hash[percl_attr] = value.to_percl_hash()
         elsif !value.nil?
-          hash[attr] = value
+          hash[percl_attr] = value
         end
       end
       result = {}

data/lib/freeclimb/utils/request_verifier.rb

@@ -0,0 +1,61 @@
+module Freeclimb
+    class RequestVerifier
+        class << self
+            @@DEFAULT_TOLERANCE = 5 * 60 * 1000
+            
+            def verify_request_signature(request_body, request_header, signing_secret, tolerance=DEFAULT_TOLERANCE)
+                request_verifier_object = Freeclimb::RequestVerifier.new()
+                request_verifier_object.instance_eval{ check_request_body(request_body) }
+                request_verifier_object.instance_eval{ check_request_header(request_header) }
+                request_verifier_object.instance_eval{ check_signing_secret(signing_secret) }
+                request_verifier_object.instance_eval{ check_tolerance(tolerance) }
+                info = Freeclimb::SignatureInformation.new(request_header)
+                request_verifier_object.instance_eval{ verify_tolerance(info, tolerance) }
+                request_verifier_object.instance_eval{ verify_signature(info, request_body, signing_secret)}
+            end
+        end
+
+        private
+
+        def check_request_body(request_body)
+            if request_body == "" || request_body == nil
+                raise 'Request Body cannot be empty or null'
+            end
+        end
+
+        def check_request_header(request_header)
+            if request_header == "" || request_header == nil
+                raise 'Error with request header, Request header is empty'
+            elsif !(request_header.include? "t")
+                raise 'Error with request header, timestamp is not present'
+            elsif !(request_header.include? "v1")
+                raise 'Error with request header, signatures are not present'
+            end
+        end
+
+        def check_signing_secret(signing_secret)
+            if signing_secret == "" || signing_secret == nil
+                raise 'Signing secret cannot be empty or null'
+            end
+        end
+
+        def check_tolerance(tolerance)
+            if tolerance <= 0 || !(tolerance.is_a? Integer)
+                raise 'Tolerance value must be a positive integer'
+            end
+        end
+
+        def verify_tolerance(info, tolerance)
+            currentTime = info.get_current_unix_time()
+            if !info.is_request_time_valid(tolerance)
+                raise "Request time exceeded tolerance threshold. Request: " + info.request_timestamp.to_s + ", CurrentTime: " + currentTime.to_s + ", tolerance: " + tolerance.to_s
+            end
+        end
+
+        def verify_signature(info, request_body, signing_secret)
+            if !info.is_signature_safe(request_body, signing_secret)
+                raise "Unverified signature request, If this request was unexpected, it may be from a bad actor. Please proceed with caution. If the request was exepected, please check any typos or issues with the signingSecret"
+            end
+        end
+    end
+end

data/lib/freeclimb/utils/signature_information.rb

@@ -0,0 +1,45 @@
+require 'date'
+require 'openssl'
+
+module Freeclimb
+    class SignatureInformation
+        attr_accessor :request_timestamp
+        attr_accessor :signatures
+
+        def initialize(request_header)
+            @request_timestamp = 0
+            @signatures = []
+            signatureHeader = request_header.try(:split, ",")
+            signatureHeader.each { |signature|
+                header, value = signature.try(:split, "=")
+                if header == "t"
+                    @request_timestamp = value.to_i
+                elsif header == "v1"
+                    @signatures.append(value)
+                end 
+            }
+        end
+
+        def is_request_time_valid(tolerance)
+            currentTime = self.get_current_unix_time()
+            timeCalculation = @request_timestamp + tolerance
+            return (timeCalculation) < currentTime
+        end
+
+        def is_signature_safe(request_body, signing_secret)
+            hashValue = self.compute_hash(request_body, signing_secret)
+            return @signatures.include? hashValue
+        end
+
+        def compute_hash(request_body, signing_secret)
+            data = @request_timestamp.to_s + "." + request_body
+            return OpenSSL::HMAC.hexdigest('sha256', signing_secret, data)
+        end
+
+        def get_current_unix_time()
+            return DateTime.now.strftime('%s').to_i
+        end
+
+        private :compute_hash
+    end
+end

data/lib/freeclimb/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.4.0
 =end
 
 module Freeclimb
-  VERSION = '4.1.3'
+  VERSION = '4.2.0'
 end

data/lib/freeclimb.rb

@@ -148,6 +148,10 @@ require 'freeclimb/models/unpark'
 # APIs
 require 'freeclimb/api/default_api'
 
+#Utils
+require 'freeclimb/utils/signature_information'
+require 'freeclimb/utils/request_verifier'
+
 module Freeclimb
   class << self
     # Customize default settings for the SDK using block.

data/spec/quickstart_spec.rb

@@ -3,8 +3,9 @@ require 'json'
 describe "quickstart" do
     it "generates percl to say the text 'Hello, World!'" do
         say = Freeclimb::Say.new(text:'Hello, World!')
-        script = Freeclimb::PerclScript.new(commands:[say])
+        get_speech = Freeclimb::GetSpeech.new(action_url: 'https://example.com/update')
+        script = Freeclimb::PerclScript.new(commands:[say, get_speech])
         json = script.to_json()
-        expect(json).to eq("[{\"Say\":{\"text\":\"Hello, World!\",\"loop\":1}}]")
+        expect(json).to eq("[{\"Say\":{\"text\":\"Hello, World!\",\"loop\":1}},{\"GetSpeech\":{\"actionUrl\":\"https://example.com/update\"}}]")
     end
 end

data/spec/utils/request_verifier_spec.rb

@@ -0,0 +1,148 @@
+require 'spec_helper'
+
+describe 'RequestVerifier' do
+    before do
+        @request_verifier_object = Freeclimb::RequestVerifier.new()
+    end
+
+    describe '#check_request_body' do
+        context 'Request Body is empty' do
+            it 'throws "Request Body cannot be empty or null"' do
+                request_header = "t=1679944186,v1=c3957749baf61df4b1506802579cc69a74c77a1ae21447b930e5a704f9ec4120,v1=1ba18712726898fbbe48cd862dd096a709f7ad761a5bab14bda9ac24d963a6a8"
+                signing_secret = "sigsec_ead6d3b6904196c60835d039e91b3341c77a7793"
+                tolerance = 5 * 60
+                request_body = ""
+                expect { Freeclimb::RequestVerifier.verify_request_signature(request_body, request_header, signing_secret, tolerance) }.to raise_error("Request Body cannot be empty or null")
+            end
+        end
+        context 'Request Body is nil' do
+            it 'throws "Request Body cannot be empty or null"' do
+                request_header = "t=1679944186,v1=c3957749baf61df4b1506802579cc69a74c77a1ae21447b930e5a704f9ec4120,v1=1ba18712726898fbbe48cd862dd096a709f7ad761a5bab14bda9ac24d963a6a8"
+                signing_secret = "sigsec_ead6d3b6904196c60835d039e91b3341c77a7793"
+                tolerance = 5 * 60
+                request_body = nil
+                expect { Freeclimb::RequestVerifier.verify_request_signature(request_body, request_header, signing_secret, tolerance) }.to raise_error("Request Body cannot be empty or null")
+            end
+        end
+    end
+
+    describe '#check_request_header' do
+        context 'signatures are not present' do
+            it 'throws "Error with request header, signatures are not present"' do
+                request_header = "t=1679944186,"
+                signing_secret = "sigsec_ead6d3b6904196c60835d039e91b3341c77a7793"
+                tolerance = 5 * 60
+                request_body = "{\"accountId\":\"AC1334ffb694cd8d969f51cddf5f7c9b478546d50c\",\"callId\":\"CAccb0b00506553cda09b51c5477f672a49e0b2213\",\"callStatus\":\"ringing\",\"conferenceId\":null,\"direction\":\"inbound\",\"from\":\"+13121000109\",\"parentCallId\":null,\"queueId\":null,\"requestType\":\"inboundCall\",\"to\":\"+13121000096\"}"
+                expect { Freeclimb::RequestVerifier.verify_request_signature(request_body, request_header, signing_secret, tolerance) }.to raise_error("Error with request header, signatures are not present")
+            end
+        end
+        context 'timestamp is not present' do
+            it 'throws "Error with request header, timestamp is not present"' do
+                request_header = "v1=c3957749baf61df4b1506802579cc69a74c77a1ae21447b930e5a704f9ec4120,v1=1ba18712726898fbbe48cd862dd096a709f7ad761a5bab14bda9ac24d963a6a8"
+                signing_secret = "sigsec_ead6d3b6904196c60835d039e91b3341c77a7793"
+                tolerance = 5 * 60
+                request_body = "{\"accountId\":\"AC1334ffb694cd8d969f51cddf5f7c9b478546d50c\",\"callId\":\"CAccb0b00506553cda09b51c5477f672a49e0b2213\",\"callStatus\":\"ringing\",\"conferenceId\":null,\"direction\":\"inbound\",\"from\":\"+13121000109\",\"parentCallId\":null,\"queueId\":null,\"requestType\":\"inboundCall\",\"to\":\"+13121000096\"}"
+                expect { Freeclimb::RequestVerifier.verify_request_signature(request_body, request_header, signing_secret, tolerance) }.to raise_error("Error with request header, timestamp is not present")
+            end
+        end
+        context 'Request header is empty' do
+            it 'throws "Error with request header, Request header is empty"' do
+                request_header = ""
+                signing_secret = "sigsec_ead6d3b6904196c60835d039e91b3341c77a7793"
+                tolerance = 5 * 60
+                request_body = "{\"accountId\":\"AC1334ffb694cd8d969f51cddf5f7c9b478546d50c\",\"callId\":\"CAccb0b00506553cda09b51c5477f672a49e0b2213\",\"callStatus\":\"ringing\",\"conferenceId\":null,\"direction\":\"inbound\",\"from\":\"+13121000109\",\"parentCallId\":null,\"queueId\":null,\"requestType\":\"inboundCall\",\"to\":\"+13121000096\"}"
+                expect { Freeclimb::RequestVerifier.verify_request_signature(request_body, request_header, signing_secret, tolerance) }.to raise_error("Error with request header, Request header is empty")
+            end
+        end
+    end
+
+    describe '#check_signing_secret' do
+        context 'Signing secret is empty' do
+            it 'throws "Signing secret cannot be empty or null"' do
+                request_header = "t=1679944186,v1=c3957749baf61df4b1506802579cc69a74c77a1ae21447b930e5a704f9ec4120,v1=1ba18712726898fbbe48cd862dd096a709f7ad761a5bab14bda9ac24d963a6a8"
+                signing_secret = ""
+                tolerance = 5 * 60
+                request_body = "{\"accountId\":\"AC1334ffb694cd8d969f51cddf5f7c9b478546d50c\",\"callId\":\"CAccb0b00506553cda09b51c5477f672a49e0b2213\",\"callStatus\":\"ringing\",\"conferenceId\":null,\"direction\":\"inbound\",\"from\":\"+13121000109\",\"parentCallId\":null,\"queueId\":null,\"requestType\":\"inboundCall\",\"to\":\"+13121000096\"}"
+                expect { Freeclimb::RequestVerifier.verify_request_signature(request_body, request_header, signing_secret, tolerance) }.to raise_error("Signing secret cannot be empty or null")
+            end
+        end
+        context 'Signing secret is nil' do
+            it 'throws "Signing secret cannot be empty or null"' do
+                request_header = "t=1679944186,v1=c3957749baf61df4b1506802579cc69a74c77a1ae21447b930e5a704f9ec4120,v1=1ba18712726898fbbe48cd862dd096a709f7ad761a5bab14bda9ac24d963a6a8"
+                signing_secret = nil
+                tolerance = 5 * 60
+                request_body = "{\"accountId\":\"AC1334ffb694cd8d969f51cddf5f7c9b478546d50c\",\"callId\":\"CAccb0b00506553cda09b51c5477f672a49e0b2213\",\"callStatus\":\"ringing\",\"conferenceId\":null,\"direction\":\"inbound\",\"from\":\"+13121000109\",\"parentCallId\":null,\"queueId\":null,\"requestType\":\"inboundCall\",\"to\":\"+13121000096\"}"
+                expect { Freeclimb::RequestVerifier.verify_request_signature(request_body, request_header, signing_secret, tolerance) }.to raise_error("Signing secret cannot be empty or null")
+            end
+        end
+    end
+
+    describe '#check_tolerance' do
+        context 'Tolerance value is a negative value' do
+            it 'throws "Tolerance value must be a positive integer"' do
+                request_header = "t=1679944186,v1=c3957749baf61df4b1506802579cc69a74c77a1ae21447b930e5a704f9ec4120,v1=1ba18712726898fbbe48cd862dd096a709f7ad761a5bab14bda9ac24d963a6a8"
+                signing_secret = "sigsec_ead6d3b6904196c60835d039e91b3341c77a7793"
+                tolerance = -5
+                request_body = "{\"accountId\":\"AC1334ffb694cd8d969f51cddf5f7c9b478546d50c\",\"callId\":\"CAccb0b00506553cda09b51c5477f672a49e0b2213\",\"callStatus\":\"ringing\",\"conferenceId\":null,\"direction\":\"inbound\",\"from\":\"+13121000109\",\"parentCallId\":null,\"queueId\":null,\"requestType\":\"inboundCall\",\"to\":\"+13121000096\"}"
+                expect { Freeclimb::RequestVerifier.verify_request_signature(request_body, request_header, signing_secret, tolerance) }.to raise_error("Tolerance value must be a positive integer")
+            end
+        end
+        context 'Tolerance value is 0' do
+            it 'throws "Tolerance value must be a positive integer"' do
+                request_header = "t=1679944186,v1=c3957749baf61df4b1506802579cc69a74c77a1ae21447b930e5a704f9ec4120,v1=1ba18712726898fbbe48cd862dd096a709f7ad761a5bab14bda9ac24d963a6a8"
+                signing_secret = "sigsec_ead6d3b6904196c60835d039e91b3341c77a7793"
+                tolerance = 0
+                request_body = "{\"accountId\":\"AC1334ffb694cd8d969f51cddf5f7c9b478546d50c\",\"callId\":\"CAccb0b00506553cda09b51c5477f672a49e0b2213\",\"callStatus\":\"ringing\",\"conferenceId\":null,\"direction\":\"inbound\",\"from\":\"+13121000109\",\"parentCallId\":null,\"queueId\":null,\"requestType\":\"inboundCall\",\"to\":\"+13121000096\"}"
+                expect { Freeclimb::RequestVerifier.verify_request_signature(request_body, request_header, signing_secret, tolerance) }.to raise_error("Tolerance value must be a positive integer")
+            end
+        end
+        context 'Tolerance value is NaN' do
+            it 'throws "Tolerance value must be a positive integer"' do
+                request_header = "t=1679944186,v1=c3957749baf61df4b1506802579cc69a74c77a1ae21447b930e5a704f9ec4120,v1=1ba18712726898fbbe48cd862dd096a709f7ad761a5bab14bda9ac24d963a6a8"
+                signing_secret = "sigsec_ead6d3b6904196c60835d039e91b3341c77a7793"
+                tolerance = Float::NAN
+                request_body = "{\"accountId\":\"AC1334ffb694cd8d969f51cddf5f7c9b478546d50c\",\"callId\":\"CAccb0b00506553cda09b51c5477f672a49e0b2213\",\"callStatus\":\"ringing\",\"conferenceId\":null,\"direction\":\"inbound\",\"from\":\"+13121000109\",\"parentCallId\":null,\"queueId\":null,\"requestType\":\"inboundCall\",\"to\":\"+13121000096\"}"
+                expect { Freeclimb::RequestVerifier.verify_request_signature(request_body, request_header, signing_secret, tolerance) }.to raise_error("Tolerance value must be a positive integer")
+            end
+        end
+    end
+
+    describe '#verify_tolerance' do
+        context 'Request plus tolerance is not less than the current datetime' do
+            it 'throws "Request time exceeded tolerance threshold. Request: 1900871395, CurrentTime: currentTimeValue, tolerance, toleranceValue"' do
+                currentTime = DateTime.now.strftime('%s').to_i
+                request_header = "t=1900871395,v1=1d798c86e977ff734dec3a8b8d67fe8621dcc1df46ef4212e0bfe2e122b01bfd,v1=1ba18712726898fbbe48cd862dd096a709f7ad761a5bab14bda9ac24d963a6a8"
+                signing_secret = "sigsec_ead6d3b6904196c60835d039e91b3341c77a7793"
+                tolerance = (5 * 60)
+                request_body =  "{\"accountId\":\"AC1334ffb694cd8d969f51cddf5f7c9b478546d50c\",\"callId\":\"CAccb0b00506553cda09b51c5477f672a49e0b2213\",\"callStatus\":\"ringing\",\"conferenceId\":null,\"direction\":\"inbound\",\"from\":\"+13121000109\",\"parentCallId\":null,\"queueId\":null,\"requestType\":\"inboundCall\",\"to\":\"+13121000096\"}"
+                expect { Freeclimb::RequestVerifier.verify_request_signature(request_body, request_header, signing_secret, tolerance) }.to raise_error("Request time exceeded tolerance threshold. Request: 1900871395" + ", CurrentTime: " + currentTime.to_s + ", tolerance: " + tolerance.to_s)
+            end
+        end
+    end
+
+    describe '#verify_signature' do
+        context 'Signature request is unverified, signing secret does not exist in signatures, potential typo' do
+            it 'throws "Unverified signature request, If this request was unexpected, it may be from a bad actor. Please proceed with caution. If the request was exepected, please check any typos or issues with the signingSecret"' do
+                currentTime = DateTime.now.strftime('%s').to_i
+                request_header = "t=1679944186,v1=c3957749baf61df4b1506802579cc69a74c77a1ae21447b930e5a704f9ec4120,v1=1ba18712726898fbbe48cd862dd096a709f7ad761a5bab14bda9ac24d963a6a8"
+                signing_secret = "sigsec_ead6d3b6904196c60835d039e91b3341c77a7794"
+                tolerance = (5 * 60)
+                request_body =  "{\"accountId\":\"AC1334ffb694cd8d969f51cddf5f7c9b478546d50c\",\"callId\":\"CAccb0b00506553cda09b51c5477f672a49e0b2213\",\"callStatus\":\"ringing\",\"conferenceId\":null,\"direction\":\"inbound\",\"from\":\"+13121000109\",\"parentCallId\":null,\"queueId\":null,\"requestType\":\"inboundCall\",\"to\":\"+13121000096\"}"
+                expect { Freeclimb::RequestVerifier.verify_request_signature(request_body, request_header, signing_secret, tolerance) }.to raise_error("Unverified signature request, If this request was unexpected, it may be from a bad actor. Please proceed with caution. If the request was exepected, please check any typos or issues with the signingSecret")
+            end
+        end
+    end
+
+    describe '#verify_request_signature' do
+        context 'Request is valid' do
+            it 'No errors are thrown' do
+                request_header = "t=1679944186,v1=c3957749baf61df4b1506802579cc69a74c77a1ae21447b930e5a704f9ec4120,v1=1ba18712726898fbbe48cd862dd096a709f7ad761a5bab14bda9ac24d963a6a8"
+                signing_secret = "sigsec_ead6d3b6904196c60835d039e91b3341c77a7793"
+                tolerance = (5 * 60)
+                request_body =  "{\"accountId\":\"AC1334ffb694cd8d969f51cddf5f7c9b478546d50c\",\"callId\":\"CAccb0b00506553cda09b51c5477f672a49e0b2213\",\"callStatus\":\"ringing\",\"conferenceId\":null,\"direction\":\"inbound\",\"from\":\"+13121000109\",\"parentCallId\":null,\"queueId\":null,\"requestType\":\"inboundCall\",\"to\":\"+13121000096\"}"
+                expect { Freeclimb::RequestVerifier.verify_request_signature(request_body, request_header, signing_secret, tolerance) }.not_to raise_error
+            end
+        end
+    end
+    
+end

data/spec/utils/signature_information_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe 'SignatureInformation' do
+    before do
+        @request_header = "t=1679944186,v1=c3957749baf61df4b1506802579cc69a74c77a1ae21447b930e5a704f9ec4120,v1=1ba18712726898fbbe48cd862dd096a709f7ad761a5bab14bda9ac24d963a6a8"
+        @signature_information_object = Freeclimb::SignatureInformation.new(@request_header)
+    end
+    describe '#is_request_time_valid' do
+        context 'request time is within tolerance threshold' do
+            it 'returns true' do
+                tolerance = 5 * 60
+                expect(@signature_information_object.is_request_time_valid(tolerance)).to be true
+            end
+        end
+        context 'request time is not within tolerance threshold' do
+            it 'returns false since it does not match condition of request time being within tolerance threshold' do
+                tolerance = 5 * 60 * 10000
+                expect(@signature_information_object.is_request_time_valid(tolerance)).to be false
+            end
+        end
+    end
+    describe '#is_signature_safe' do
+        context 'signingSecret exists in signature array' do
+            it 'returns true' do
+                request_body = "{\"accountId\":\"AC1334ffb694cd8d969f51cddf5f7c9b478546d50c\",\"callId\":\"CAccb0b00506553cda09b51c5477f672a49e0b2213\",\"callStatus\":\"ringing\",\"conferenceId\":null,\"direction\":\"inbound\",\"from\":\"+13121000109\",\"parentCallId\":null,\"queueId\":null,\"requestType\":\"inboundCall\",\"to\":\"+13121000096\"}"
+                signing_secret = "sigsec_ead6d3b6904196c60835d039e91b3341c77a7793"
+                expect(@signature_information_object.is_signature_safe(request_body, signing_secret)).to be true
+            end
+        end
+        context 'signingSecret does not exists in signature array' do
+            it 'returns false since it does not match condition of signingSecret being within signature array' do
+                request_body = "{\"accountId\":\"AC1334ffb694cd8d969f51cddf5f7c9b478546d50c\",\"callId\":\"CAccb0b00506553cda09b51c5477f672a49e0b2213\",\"callStatus\":\"ringing\",\"conferenceId\":null,\"direction\":\"inbound\",\"from\":\"+13121000109\",\"parentCallId\":null,\"queueId\":null,\"requestType\":\"inboundCall\",\"to\":\"+13121000096\"}"
+                signing_secret = "sigsec_ead6d3b6904196c60835d039e91b3341c77a7794"
+                expect(@signature_information_object.is_signature_safe(request_body, signing_secret)).to be false
+            end
+        end
+    end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: freeclimb
 version: !ruby/object:Gem::Version
-  version: 4.1.3
+  version: 4.2.0
 platform: ruby
 authors:
 - OpenAPI-Generator
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-13 00:00:00.000000000 Z
+date: 2023-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -330,6 +330,8 @@ files:
 - lib/freeclimb/models/update_conference_participant_request.rb
 - lib/freeclimb/models/update_conference_request.rb
 - lib/freeclimb/models/update_conference_request_status.rb
+- lib/freeclimb/utils/request_verifier.rb
+- lib/freeclimb/utils/signature_information.rb
 - lib/freeclimb/version.rb
 - openapi.json
 - spec/api/default_api_spec.rb
@@ -423,6 +425,8 @@ files:
 - spec/models/update_conference_request_status_spec.rb
 - spec/quickstart_spec.rb
 - spec/spec_helper.rb
+- spec/utils/request_verifier_spec.rb
+- spec/utils/signature_information_spec.rb
 homepage: https://freeclimb.com
 licenses:
 - Unlicense
@@ -451,90 +455,92 @@ test_files:
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
 - spec/factories.rb
-- spec/models/update_conference_participant_request_spec.rb
-- spec/models/request_type_spec.rb
-- spec/models/message_status_spec.rb
-- spec/models/available_number_list_spec.rb
-- spec/models/mutable_resource_model_spec.rb
-- spec/models/add_to_conference_spec.rb
-- spec/models/account_type_spec.rb
-- spec/models/queue_request_spec.rb
-- spec/models/language_spec.rb
-- spec/models/start_record_call_spec.rb
-- spec/models/remove_from_conference_spec.rb
-- spec/models/message_direction_spec.rb
-- spec/models/application_result_spec.rb
-- spec/models/log_result_spec.rb
-- spec/models/terminate_conference_spec.rb
-- spec/models/create_conference_request_spec.rb
-- spec/models/enqueue_spec.rb
-- spec/models/out_dial_spec.rb
+- spec/models/recording_result_spec.rb
+- spec/models/pagination_model_spec.rb
 - spec/models/redirect_spec.rb
-- spec/models/conference_list_spec.rb
-- spec/models/call_list_spec.rb
-- spec/models/incoming_number_list_spec.rb
-- spec/models/record_utterance_spec.rb
-- spec/models/set_talk_spec.rb
-- spec/models/log_level_spec.rb
-- spec/models/log_list_spec.rb
 - spec/models/percl_script_spec.rb
+- spec/models/get_digits_spec.rb
+- spec/models/dequeue_spec.rb
+- spec/models/update_conference_participant_request_spec.rb
+- spec/models/log_result_spec.rb
 - spec/models/answered_by_spec.rb
-- spec/models/reject_spec.rb
-- spec/models/grammar_file_built_in_spec.rb
 - spec/models/grammar_type_spec.rb
-- spec/models/if_machine_spec.rb
 - spec/models/account_result_spec.rb
-- spec/models/get_speech_spec.rb
-- spec/models/get_digits_spec.rb
+- spec/models/incoming_number_request_spec.rb
+- spec/models/filter_logs_request_spec.rb
+- spec/models/message_status_spec.rb
+- spec/models/start_record_call_spec.rb
+- spec/models/conference_participant_result_spec.rb
+- spec/models/message_result_spec.rb
+- spec/models/record_utterance_term_reason_spec.rb
+- spec/models/sms_spec.rb
 - spec/models/get_speech_reason_spec.rb
+- spec/models/message_request_spec.rb
+- spec/models/account_status_spec.rb
+- spec/models/out_dial_spec.rb
+- spec/models/call_direction_spec.rb
+- spec/models/language_spec.rb
+- spec/models/play_beep_spec.rb
+- spec/models/conference_status_spec.rb
+- spec/models/request_type_spec.rb
+- spec/models/terminate_conference_spec.rb
+- spec/models/conference_result_spec.rb
+- spec/models/create_conference_request_spec.rb
+- spec/models/buy_incoming_number_request_spec.rb
+- spec/models/reject_spec.rb
+- spec/models/messages_list_spec.rb
+- spec/models/hangup_spec.rb
+- spec/models/queue_member_spec.rb
+- spec/models/percl_command_spec.rb
+- spec/models/machine_type_spec.rb
+- spec/models/unpark_spec.rb
+- spec/models/application_request_spec.rb
+- spec/models/account_request_spec.rb
+- spec/models/incoming_number_result_spec.rb
 - spec/models/queue_result_spec.rb
-- spec/models/message_result_spec.rb
+- spec/models/record_utterance_spec.rb
 - spec/models/available_number_spec.rb
-- spec/models/call_direction_spec.rb
-- spec/models/account_status_spec.rb
 - spec/models/pause_spec.rb
-- spec/models/message_request_spec.rb
-- spec/models/park_spec.rb
-- spec/models/update_conference_request_status_spec.rb
-- spec/models/unpark_spec.rb
+- spec/models/conference_participant_list_spec.rb
+- spec/models/set_listen_spec.rb
+- spec/models/available_number_list_spec.rb
+- spec/models/add_to_conference_spec.rb
+- spec/models/enqueue_spec.rb
+- spec/models/application_result_spec.rb
+- spec/models/call_result_spec.rb
+- spec/models/update_call_request_spec.rb
 - spec/models/call_status_spec.rb
-- spec/models/application_request_spec.rb
+- spec/models/grammar_file_built_in_spec.rb
+- spec/models/capabilities_spec.rb
+- spec/models/park_spec.rb
+- spec/models/queue_request_spec.rb
+- spec/models/message_direction_spec.rb
+- spec/models/mutable_resource_model_spec.rb
+- spec/models/update_conference_request_spec.rb
+- spec/models/recording_list_spec.rb
 - spec/models/application_list_spec.rb
-- spec/models/filter_logs_request_spec.rb
-- spec/models/hangup_spec.rb
-- spec/models/percl_command_spec.rb
-- spec/models/update_call_request_status_spec.rb
-- spec/models/messages_list_spec.rb
-- spec/models/recording_result_spec.rb
-- spec/models/buy_incoming_number_request_spec.rb
-- spec/models/update_call_request_spec.rb
-- spec/models/conference_status_spec.rb
-- spec/models/make_call_request_spec.rb
-- spec/models/conference_participant_result_spec.rb
-- spec/models/conference_result_spec.rb
+- spec/models/play_early_media_spec.rb
+- spec/models/remove_from_conference_spec.rb
+- spec/models/account_type_spec.rb
 - spec/models/queue_result_status_spec.rb
 - spec/models/send_digits_spec.rb
-- spec/models/account_request_spec.rb
-- spec/models/queue_list_spec.rb
-- spec/models/queue_member_spec.rb
-- spec/models/play_early_media_spec.rb
-- spec/models/machine_type_spec.rb
-- spec/models/capabilities_spec.rb
+- spec/models/say_spec.rb
+- spec/models/log_level_spec.rb
+- spec/models/update_conference_request_status_spec.rb
+- spec/models/make_call_request_spec.rb
 - spec/models/create_conference_spec.rb
-- spec/models/record_utterance_term_reason_spec.rb
-- spec/models/pagination_model_spec.rb
-- spec/models/play_beep_spec.rb
-- spec/models/sms_spec.rb
-- spec/models/conference_participant_list_spec.rb
-- spec/models/update_conference_request_spec.rb
 - spec/models/play_spec.rb
-- spec/models/incoming_number_request_spec.rb
-- spec/models/say_spec.rb
-- spec/models/dequeue_spec.rb
-- spec/models/incoming_number_result_spec.rb
-- spec/models/call_result_spec.rb
+- spec/models/get_speech_spec.rb
+- spec/models/log_list_spec.rb
 - spec/models/queue_member_list_spec.rb
-- spec/models/set_listen_spec.rb
-- spec/models/recording_list_spec.rb
+- spec/models/conference_list_spec.rb
+- spec/models/update_call_request_status_spec.rb
+- spec/models/queue_list_spec.rb
+- spec/models/call_list_spec.rb
+- spec/models/set_talk_spec.rb
+- spec/models/incoming_number_list_spec.rb
+- spec/models/if_machine_spec.rb
 - spec/quickstart_spec.rb
 - spec/spec_helper.rb
+- spec/utils/signature_information_spec.rb
+- spec/utils/request_verifier_spec.rb