Class: Slack::Events::Request

Inherits:
Object
  • Object
show all
Defined in:
lib/slack/events/request.rb

Defined Under Namespace

Classes: InvalidSignature, MissingSigningSecret, TimestampExpired

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(http_request, options = {}) ⇒ Request

Returns a new instance of Request.



13
14
15
16
17
18
 
# File 'lib/slack/events/request.rb', line 13

def initialize(http_request, options = {})
  @http_request = http_request
  @signing_secret = options[:signing_secret] || Slack::Events.config.signing_secret
  @signature_expires_in =
    options[:signature_expires_in] || Slack::Events.config.signature_expires_in
end

Instance Attribute Details

#http_request ⇒ Object (readonly)

Returns the value of attribute http_request.



9
10
11
 
# File 'lib/slack/events/request.rb', line 9

def http_request
  @http_request
end

#signature_expires_in ⇒ Object (readonly)

Returns the value of attribute signature_expires_in.



9
10
11
 
# File 'lib/slack/events/request.rb', line 9

def signature_expires_in
  @signature_expires_in
end

#signing_secret ⇒ Object (readonly)

Returns the value of attribute signing_secret.



9
10
11
 
# File 'lib/slack/events/request.rb', line 9

def signing_secret
  @signing_secret
end

Instance Method Details

#body ⇒ Object

Request body.



37
38
39
 
# File 'lib/slack/events/request.rb', line 37

def body
  @body ||= http_request.body.read
end

#expired? ⇒ Boolean

Returns true if the signature coming from Slack has expired.

Returns:

  • (Boolean) 


42
43
44
 
# File 'lib/slack/events/request.rb', line 42

def expired?
  timestamp.nil? || (Time.now.to_i - timestamp.to_i).abs > signature_expires_in
end

#signature ⇒ Object

The signature is created by combining the signing secret with the body of the request Slack is sending using a standard HMAC-SHA256 keyed hash.



27
28
29
 
# File 'lib/slack/events/request.rb', line 27

def signature
  @signature ||= http_request.headers['X-Slack-Signature']
end

#timestamp ⇒ Object

Request timestamp.



21
22
23
 
# File 'lib/slack/events/request.rb', line 21

def timestamp
  @timestamp ||= http_request.headers['X-Slack-Request-Timestamp']
end

#valid? ⇒ Boolean

Returns true if the signature coming from Slack is valid.

Returns:

  • (Boolean)

Raises:



47
48
49
50
51
52
53
54
55
 
# File 'lib/slack/events/request.rb', line 47

def valid?
  raise MissingSigningSecret unless signing_secret

  digest = OpenSSL::Digest::SHA256.new
  signature_basestring = [version, timestamp, body].join(':')
  hex_hash = OpenSSL::HMAC.hexdigest(digest, signing_secret, signature_basestring)
  computed_signature = [version, hex_hash].join('=')
  computed_signature == signature
end

#verify! ⇒ Object

Validates the request signature and its expiration.

Raises:



58
59
60
61
62
63
 
# File 'lib/slack/events/request.rb', line 58

def verify!
  raise TimestampExpired if expired?
  raise InvalidSignature unless valid?

  true
end

#version ⇒ Object

Signature version.



32
33
34
 
# File 'lib/slack/events/request.rb', line 32

def version
  'v0'
end