stripe 5.18.0 → 5.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d22d41c56bb85d7b5712eaf36c274b8636f6a5a27b767d344d766ca59b6be4dc
-  data.tar.gz: ec876e8fcf530e645e4a26bd8dee1c635dee466248d31e7746c33aa4e6373c0e
+  metadata.gz: 609a42b37282281ebdaea0fa8e0fd74540cdf49b44df5c3d03fc2c9d05a71638
+  data.tar.gz: 88f0c70adfa171e72d448126300692dfb027165fbb8d5be69e2dbf1eb7c2a9a1
 SHA512:
-  metadata.gz: 69cdb2b0263d577512d77892a3229b4a8112ccd5c6eae8fb6d38510901981da05d93062dd514a6fa9976d54927f5208a6fdc8f5c2bf6f5db072eaac0089f66a0
-  data.tar.gz: c681fc11a7566635cdf094ad1bbe1c90db63887ed019d65a25f4eb52efe39411786c370c47403bd2b26f8d5df62f588ba951cf4d59bb12d6f4d3f02cda36a5cf
+  metadata.gz: a800f54e6335291b9ce91a14d715b9432ebaa04a1145b8616470037972b1c8fb83622ad8226fb03e79ce9350c4b132bb776451da25ed3ca10c8624dfebdef778
+  data.tar.gz: ff25a1a52d03cdf59c16012cacced71952462ef3daff1f7caea9403045a20c8c1343e5252f326ff5182a92075fdfbd92432c4059504b529f5cca41289a110430

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## - 2020-04-24
+* [#915](https://github.com/stripe/stripe-ruby/pull/915) Expose `Stripe::Webhook.compute_signature` publicly
+
 ## 5.18.0 - 2020-04-22
 * [#911](https://github.com/stripe/stripe-ruby/pull/911) Add support for `BillingPortal` namespace and `Session` resource and APIs
 

data/VERSION

@@ -1 +1 @@
-5.18.0
+5.19.0

data/lib/stripe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stripe
-  VERSION = "5.18.0"
+  VERSION = "5.19.0"
 end

data/lib/stripe/webhook.rb

@@ -24,10 +24,20 @@ module Stripe
     module Signature
       EXPECTED_SCHEME = "v1"
 
-      def self.compute_signature(payload, secret)
-        OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new("sha256"), secret, payload)
+      # Computes a webhook signature given a time (probably the current time),
+      # a payload, and a signing secret.
+      def self.compute_signature(timestamp, payload, secret)
+        raise ArgumentError, "timestamp should be an instance of Time" \
+          unless timestamp.is_a?(Time)
+        raise ArgumentError, "payload should be a string" \
+          unless payload.is_a?(String)
+        raise ArgumentError, "secret should be a string" \
+          unless secret.is_a?(String)
+
+        timestamped_payload = "#{timestamp.to_i}.#{payload}"
+        OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new("sha256"), secret,
+                                timestamped_payload)
       end
-      private_class_method :compute_signature
 
       # Extracts the timestamp and the signature(s) with the desired scheme
       # from the header
@@ -35,7 +45,7 @@ module Stripe
         list_items = header.split(/,\s*/).map { |i| i.split("=", 2) }
         timestamp = Integer(list_items.select { |i| i[0] == "t" }[0][1])
         signatures = list_items.select { |i| i[0] == scheme }.map { |i| i[1] }
-        [timestamp, signatures]
+        [Time.at(timestamp), signatures]
       end
       private_class_method :get_timestamp_and_signatures
 
@@ -53,6 +63,11 @@ module Stripe
         begin
           timestamp, signatures =
             get_timestamp_and_signatures(header, EXPECTED_SCHEME)
+
+        # TODO: Try to knock over this blanket rescue as it can unintentionally
+        # swallow many valid errors. Instead, try to validate an incoming
+        # header one piece at a time, and error with a known exception class if
+        # any part is found to be invalid. Rescue that class here.
         rescue StandardError
           raise SignatureVerificationError.new(
             "Unable to extract timestamp and signatures from header",
@@ -67,8 +82,7 @@ module Stripe
           )
         end
 
-        signed_payload = "#{timestamp}.#{payload}"
-        expected_sig = compute_signature(signed_payload, secret)
+        expected_sig = compute_signature(timestamp, payload, secret)
         unless signatures.any? { |s| Util.secure_compare(expected_sig, s) }
           raise SignatureVerificationError.new(
             "No signatures found matching the expected signature for payload",
@@ -76,7 +90,7 @@ module Stripe
           )
         end
 
-        if tolerance && timestamp < Time.now.to_f - tolerance
+        if tolerance && timestamp < Time.now - tolerance
           raise SignatureVerificationError.new(
             "Timestamp outside the tolerance zone (#{Time.at(timestamp)})",
             header, http_body: payload

data/test/stripe/webhook_test.rb

@@ -13,12 +13,29 @@ module Stripe
     SECRET = "whsec_test_secret"
 
     def generate_header(opts = {})
-      opts[:timestamp] ||= Time.now.to_i
+      opts[:timestamp] ||= Time.now
       opts[:payload] ||= EVENT_PAYLOAD
       opts[:secret] ||= SECRET
       opts[:scheme] ||= Stripe::Webhook::Signature::EXPECTED_SCHEME
-      opts[:signature] ||= Stripe::Webhook::Signature.send(:compute_signature, "#{opts[:timestamp]}.#{opts[:payload]}", opts[:secret])
-      "t=#{opts[:timestamp]},#{opts[:scheme]}=#{opts[:signature]}"
+      opts[:signature] ||= Stripe::Webhook::Signature.compute_signature(
+        opts[:timestamp],
+        opts[:payload],
+        opts[:secret]
+      )
+      "t=#{opts[:timestamp].to_i},#{opts[:scheme]}=#{opts[:signature]}"
+    end
+
+    context ".compute_signature" do
+      should "compute a signature which can then be verified" do
+        timestamp = Time.now
+        signature = Stripe::Webhook::Signature.compute_signature(
+          timestamp,
+          EVENT_PAYLOAD,
+          SECRET
+        )
+        header = generate_header(timestamp: timestamp, signature: signature)
+        assert(Stripe::Webhook::Signature.verify_header(EVENT_PAYLOAD, header, SECRET))
+      end
     end
 
     context ".construct_event" do
@@ -70,7 +87,7 @@ module Stripe
       end
 
       should "raise a SignatureVerificationError when the timestamp is not within the tolerance" do
-        header = generate_header(timestamp: Time.now.to_i - 15)
+        header = generate_header(timestamp: Time.now - 15)
         e = assert_raises(Stripe::SignatureVerificationError) do
           Stripe::Webhook::Signature.verify_header(EVENT_PAYLOAD, header, SECRET, tolerance: 10)
         end
@@ -88,7 +105,7 @@ module Stripe
       end
 
       should "return true when the header contains a valid signature and the timestamp is off but no tolerance is provided" do
-        header = generate_header(timestamp: 12_345)
+        header = generate_header(timestamp: Time.at(12_345))
         assert(Stripe::Webhook::Signature.verify_header(EVENT_PAYLOAD, header, SECRET))
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 5.18.0
+  version: 5.19.0
 platform: ruby
 authors:
 - Stripe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-22 00:00:00.000000000 Z
+date: 2020-04-24 00:00:00.000000000 Z
 dependencies: []
 description: Stripe is the easiest way to accept payments online.  See https://stripe.com
   for details.