Contents

require 'base64'
require 'digest'
require 'openssl'

module SendGrid
  # This class allows you to use the Event Webhook feature. Read the docs for
  # more details: https://sendgrid.com/docs/for-developers/tracking-events/event
  class EventWebhook
    # * *Args* :
    #   - +public_key+ -> verification key under Mail Settings
    #
    def convert_public_key_to_ecdsa(public_key)
      verify_engine
      OpenSSL::PKey::EC.new(Base64.decode64(public_key))
    end

    # * *Args* :
    #   - +public_key+ -> elliptic curve public key
    #   - +payload+ -> event payload in the request body
    #   - +signature+ -> signature value obtained from the 'X-Twilio-Email-Event-Webhook-Signature' header
    #   - +timestamp+ -> timestamp value obtained from the 'X-Twilio-Email-Event-Webhook-Timestamp' header
    def verify_signature(public_key, payload, signature, timestamp)
      verify_engine
      timestamped_playload = "#{timestamp}#{payload}"
      payload_digest = Digest::SHA256.digest(timestamped_playload)
      decoded_signature = Base64.decode64(signature)
      public_key.dsa_verify_asn1(payload_digest, decoded_signature)
    rescue
      false
    end

    def verify_engine
      # JRuby does not fully support ECDSA: https://github.com/jruby/jruby-openssl/issues/193
      if RUBY_PLATFORM == "java"
        raise NotSupportedError, "Event Webhook verification is not supported by JRuby"
      end
    end

    class Error < ::RuntimeError
    end

    class NotSupportedError < Error
    end
  end

  # This class lists headers that get posted to the webhook. Read the docs for
  # more details: https://sendgrid.com/docs/for-developers/tracking-events/event
  class EventWebhookHeader
    SIGNATURE = "HTTP_X_TWILIO_EMAIL_EVENT_WEBHOOK_SIGNATURE"
    TIMESTAMP = "HTTP_X_TWILIO_EMAIL_EVENT_WEBHOOK_TIMESTAMP"
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
sendgrid-ruby-6.3.4	lib/sendgrid/helpers/eventwebhook/eventwebhook.rb
sendgrid-ruby-6.3.3	lib/sendgrid/helpers/eventwebhook/eventwebhook.rb
sendgrid-ruby-6.3.2	lib/sendgrid/helpers/eventwebhook/eventwebhook.rb
sendgrid-ruby-6.3.1	lib/sendgrid/helpers/eventwebhook/eventwebhook.rb