ahoy_email 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c664f526e52ac8f97cf3d5fe5b154ab6396e3f5c8db3d42c7c76022df9e0b35
-  data.tar.gz: 063f9ac13bebe763ff2e33677e68bebd75f46837c5e63b920208e2547725a2a9
+  metadata.gz: 55896391d55a0158cdf032a2d7a29860984db55a4c116b96317e8986acdef143
+  data.tar.gz: 6c1c742d62fa0c2b2b62832dc0030fa7dad31839fc5e015f3806766c14ce9804
 SHA512:
-  metadata.gz: 1d7556134bb052f06eea6755f668cdd7c4eb5355dcbe46098894ff6b5ed8735b4c20b240378bafebb9b03b9c2525cf4e7b79e9a0fa240bf1a86289b8c0eb2c2b
-  data.tar.gz: b576323d7768c3c0872afecbbfa35a7ce12b1d8df9a6dc9877d96e691e1d4675a60ef590e00705be8c245a543dc151249504ba511a96d6bbf37ead17afcf6666
+  metadata.gz: 411579c14c08b65b59aaf34dafa6e37e0fdff00acc2232eb9962c31ce7077826aa228d3e7e7b09f657b2e6a2542b003b005e43237106b162ffd60930a13e9cf8
+  data.tar.gz: a042562ba6f0a1ed0e342f823bd75b7960fdae2490699f02cbfd1320f81fd82cd19bdaabb437369825701656eb78f5a1663a14ccf918c28605257c3af966dbbf

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.3.0 (2024-06-01)
+
+- Added support for secret token rotation
+- Improved secret token generation
+
 ## 2.2.0 (2023-07-02)
 
 - Removed support for Ruby < 3 and Rails < 6.1

data/README.md

@@ -4,9 +4,9 @@ First-party email analytics for Rails
 
 :fire: For web and native app analytics, check out [Ahoy](https://github.com/ankane/ahoy)
 
-:bullettrain_side: To manage unsubscribes, check out [Mailkick](https://github.com/ankane/mailkick)
+:bullettrain_side: To manage email subscriptions, check out [Mailkick](https://github.com/ankane/mailkick)
 
-[![Build Status](https://github.com/ankane/ahoy_email/workflows/build/badge.svg?branch=master)](https://github.com/ankane/ahoy_email/actions)
+[![Build Status](https://github.com/ankane/ahoy_email/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/ahoy_email/actions)
 
 ## Installation
 
@@ -106,7 +106,7 @@ user.messages
 Add extra data to messages. Create a migration like:
 
 ```ruby
-class AddCouponIdToAhoyMessages < ActiveRecord::Migration[7.0]
+class AddCouponIdToAhoyMessages < ActiveRecord::Migration[7.1]
   def change
     add_column :ahoy_messages, :coupon_id, :integer
   end

data/app/controllers/ahoy/messages_controller.rb

@@ -11,24 +11,23 @@ module Ahoy
     end
 
     def click
-      if params[:id]
-        # legacy
+      legacy = params[:id]
+      if legacy
         token = params[:id].to_s
+        campaign = nil
         url = params[:url].to_s
         signature = params[:signature].to_s
-        expected_signature = OpenSSL::HMAC.hexdigest("SHA1", AhoyEmail::Utils.secret_token, url)
       else
         token = params[:t].to_s
         campaign = params[:c].to_s
         url = params[:u].to_s
         signature = params[:s].to_s
-        expected_signature = AhoyEmail::Utils.signature(token: token, campaign: campaign, url: url)
       end
 
       redirect_options = {}
       redirect_options[:allow_other_host] = true if ActionPack::VERSION::MAJOR >= 7
 
-      if ActiveSupport::SecurityUtils.secure_compare(signature, expected_signature)
+      if AhoyEmail::Utils.signature_verified?(legacy: legacy, token: token, campaign: campaign, url: url, signature: signature)
         data = {}
         data[:campaign] = campaign if campaign
         data[:token] = token

data/lib/ahoy_email/engine.rb

@@ -4,6 +4,10 @@ module AhoyEmail
   class Engine < ::Rails::Engine
     initializer "ahoy_email" do |app|
       AhoyEmail.secret_token ||= begin
+        tokens = []
+        tokens << app.key_generator.generate_key("ahoy_email")
+
+        # TODO remove in 3.0
         creds =
           if app.respond_to?(:credentials) && app.credentials.secret_key_base
             app.credentials
@@ -15,7 +19,9 @@ module AhoyEmail
 
         token = creds.respond_to?(:secret_key_base) ? creds.secret_key_base : creds.secret_token
         token ||= app.secret_key_base # should come first, but need to maintain backward compatibility
-        token
+        tokens << token
+
+        tokens
       end
     end
   end

data/lib/ahoy_email/utils.rb

@@ -7,13 +7,28 @@ module AhoyEmail
     }
 
     class << self
-      def signature(token:, campaign:, url:)
+      def signature(token:, campaign:, url:, secret_token: nil)
+        secret_token ||= secret_tokens.first
+
         # encode and join with a character outside encoding
         data = [token, campaign, url].map { |v| Base64.strict_encode64(v.to_s) }.join("|")
 
         Base64.urlsafe_encode64(OpenSSL::HMAC.digest("SHA256", secret_token, data), padding: false)
       end
 
+      def signature_verified?(legacy:, token:, campaign:, url:, signature:)
+        secret_tokens.any? do |secret_token|
+          expected_signature =
+            if legacy
+              OpenSSL::HMAC.hexdigest("SHA1", secret_token, url)
+            else
+              signature(token: token, campaign: campaign, url: url, secret_token: secret_token)
+            end
+
+          ActiveSupport::SecurityUtils.secure_compare(signature, expected_signature)
+        end
+      end
+
       def publish(name, event)
         method_name = "track_#{name}"
         AhoyEmail.subscribers.each do |subscriber|
@@ -27,8 +42,8 @@ module AhoyEmail
         end
       end
 
-      def secret_token
-        AhoyEmail.secret_token || (raise "Secret token is empty")
+      def secret_tokens
+        Array(AhoyEmail.secret_token || (raise "Secret token is empty"))
       end
     end
   end

data/lib/ahoy_email/version.rb

@@ -1,3 +1,3 @@
 module AhoyEmail
-  VERSION = "2.2.0"
+  VERSION = "2.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_email
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-02 00:00:00.000000000 Z
+date: 2024-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: First-party email analytics for Rails