Class: HmacSignature::Request

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

Constant Summary collapse

VALID_METHODS = 
%w(GET POST)
ISO8601 =

www.w3.org/TR/NOTE-datetime

"%Y-%m-%dT%H:%M:%SZ"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(method, path, params, credentials = nil) ⇒ Request

Returns a new instance of Request.

Raises:

  • (ArgumentError) 


10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/hmac_signature/request.rb', line 10

def initialize method, path, params, credentials=nil
	raise ArgumentError, "Expected GET or POST" unless method.is_a?(String) && VALID_METHODS.include?(method)
	raise ArgumentError, "Expected string" unless path.is_a?(String) && !path.empty?
	raise ArgumentError, "Expected hash" unless params.is_a?(Hash)
	raise ArgumentError, "Expected credentials" unless credentials.nil? || credentials.is_a?(HmacSignature::Credentials)

	@method = method
	@path = path
	@params = params
	@credentials = credentials
end

Instance Attribute Details

#credentials ⇒ Object (readonly)

Returns the value of attribute credentials.



8
9
10
 
# File 'lib/hmac_signature/request.rb', line 8

def credentials
  @credentials
end

#method ⇒ Object (readonly)

Returns the value of attribute method.



8
9
10
 
# File 'lib/hmac_signature/request.rb', line 8

def method
  @method
end

#params ⇒ Object (readonly)

Returns the value of attribute params.



8
9
10
 
# File 'lib/hmac_signature/request.rb', line 8

def params
  @params
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



8
9
10
 
# File 'lib/hmac_signature/request.rb', line 8

def path
  @path
end

Instance Method Details

#authenticate ⇒ Object

Raises:

  • (ArgumentError) 


32
33
34
35
36
37
38
39
40
41
 
# File 'lib/hmac_signature/request.rb', line 32

def authenticate
	raise ArgumentError, "Block required" unless block_given?
	raise AuthenticationError, "Missing parameter: key" unless credentials.key
	token = yield credentials.key
	unless token
		raise AuthenticationError, "Unknown key"
	end
	authenticate_by_token! token
	return token
end

#authenticate_by_token(token) ⇒ Object 



43
44
45
46
47
 
# File 'lib/hmac_signature/request.rb', line 43

def authenticate_by_token token
	authenticate_by_token! token
rescue
	false
end

#authenticate_by_token!(token) ⇒ Object

Raises:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/hmac_signature/request.rb', line 49

def authenticate_by_token! token
	raise HmacSignature::AuthenticationError, "Credentials required" unless credentials

	if token.secret.nil? || token.secret.empty?
		raise ArgumentError, "Provided token is missing secret"
	end

	# authenticates version
	raise HmacSignature::AuthenticationError, "Version required" unless credentials.version
       raise HmacSignature::AuthenticationError, "Version not supported" unless credentials.version == '1.0'
       
	# authenticates expiry
	raise HmacSignature::AuthenticationError, "Expiration timestamp required" unless credentials.expiry
	if Time.now.utc.to_i > credentials.expiry.to_i
		raise HmacSignature::AuthenticationError, "Timestamp expired: Given timestamp "\
		"(#{Time.at(credentials.expiry.to_i).utc.strftime(ISO8601)}) "\
		"has expired. The current server time is "\
		"(#{Time.now.utc.strftime(ISO8601)})"
	end

	# authenticates signature
	valid_signature = generate_signature(token, credentials.expiry, credentials.version)
	unless credentials.signature == valid_signature.to_s
		raise HmacSignature::AuthenticationError, "Invalid signature: you should have "\
		"sent HmacSHA256Hex(#{valid_signature.string_to_sign.inspect}, your_secret_key)"\
		", but you sent #{credentials.signature.inspect}"
	end
	
	true
end

#sign(token, expires_in = 600) ⇒ Object 



22
23
24
25
26
27
28
29
30
 
# File 'lib/hmac_signature/request.rb', line 22

def sign token, expires_in=600
	expires_at 	= (Time.now.utc.to_i + expires_in).to_s
	version 	= Signature::VERSION
	key 		= token.key
	secret 		= token.secret
	signature 	= generate_signature(token, expires_at, version).to_s

	HmacSignature::Credentials.new(key, expires_at, version, signature)
end