Class: OptimizePlayer::Signer

Inherits:
Object
  • Object
show all
Defined in:
lib/optimize_player/signer.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(algorithm = "sha1", opts = {}) ⇒ Signer

Returns a new instance of Signer.



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/optimize_player/signer.rb', line 5

def initialize(algorithm = "sha1", opts = {})
  default_opts = {
    :auth_scheme => "HMAC",
    :auth_param => "auth",
    :auth_header => "Authorization",
    :auth_header_format => "%{auth_scheme} %{signature}",
    :query_based => false,
    :use_alternate_date_header => false,
    :extra_auth_params => {},
    :ignore_params => []
  }
  @algorithm = algorithm
  opts[:nonce_header] ||="X-%{scheme}-Nonce" % {:scheme => (opts[:auth_scheme] || "HMAC")}
  opts[:alternate_date_header] ||= "X-%{scheme}-Date" % {:scheme => (opts[:auth_scheme] || "HMAC")}
  self.default_opts = default_opts.merge(opts)
end

Instance Attribute Details

#algorithm ⇒ Object

Returns the value of attribute algorithm.



3
4
5
 
# File 'lib/optimize_player/signer.rb', line 3

def algorithm
  @algorithm
end

#default_opts ⇒ Object

Returns the value of attribute default_opts.



3
4
5
 
# File 'lib/optimize_player/signer.rb', line 3

def default_opts
  @default_opts
end

Instance Method Details

#canonical_representation(params) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/optimize_player/signer.rb', line 45

def canonical_representation(params)
  rep = ""

  rep << "#{params[:method].upcase}\n"
  rep << "date:#{params[:date]}\n"
  rep << "nonce:#{params[:nonce]}\n"

  (params[:headers] || {}).sort.each do |pair|
    name,value = *pair
    rep << "#{name.downcase}:#{value}\n"
  end

  rep << params[:path]

  p = (params[:query] || {}).dup

  if !p.empty?
    query = p.sort.map do |key, value|
      "%{key}=%{value}" % {
        :key => Rack::Utils.unescape(key.to_s),
        :value => Rack::Utils.unescape(value.to_s)
      }
    end.join("&")
    rep << "?#{query}"
  end

  rep
end

#generate_signature(params) ⇒ Object 



22
23
24
25
26
27
 
# File 'lib/optimize_player/signer.rb', line 22

def generate_signature(params)
  secret = params.delete(:secret)
  return if '' == secret.to_s

  OpenSSL::HMAC.hexdigest(algorithm, secret, canonical_representation(params))
end

#sign_request(url, secret, opts = {}) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/optimize_player/signer.rb', line 74

def sign_request(url, secret, opts = {})
  opts = default_opts.merge(opts)

  uri = parse_url(url)
  headers = opts[:headers] || {}

  date = opts[:date] || Time.now.gmtime
  date = date.gmtime.strftime('%a, %d %b %Y %T GMT') if date.respond_to? :strftime

  method = opts[:method] ? opts[:method].to_s.upcase : "GET"

  query_values = Rack::Utils.parse_nested_query(uri.query)

  if query_values
    query_values.delete_if do |k,v|
      opts[:ignore_params].one? { |param| (k == param) || (k == param.to_s) }
    end
  end

  signature = generate_signature(:secret => secret, :method => method, :path => uri.path, :date => date, :nonce => opts[:nonce], :query => query_values, :headers => opts[:headers], :ignore_params => opts[:ignore_params])

  if opts[:query_based]
    auth_params = opts[:extra_auth_params].merge({
      "date" => date,
      "signature" => signature
    })
    auth_params[:nonce] = opts[:nonce] unless opts[:nonce].nil?

    query_values ||= {}
    query_values[opts[:auth_param]] = auth_params
    uri.query = Rack::Utils.build_nested_query(query_values)
  else
    headers[opts[:auth_header]]   = opts[:auth_header_format] % opts.merge({:signature => signature})
    headers[opts[:nonce_header]]  = opts[:nonce] unless opts[:nonce].nil?

    if opts[:use_alternate_date_header]
      headers[opts[:alternate_date_header]] = date
    else
      headers["Date"] = date
    end
  end

  [headers, uri.to_s]
end

#sign_url(url, secret, opts = {}) ⇒ Object 



119
120
121
122
123
124
125
 
# File 'lib/optimize_player/signer.rb', line 119

def sign_url(url, secret, opts = {})
  opts = default_opts.merge(opts)
  opts[:query_based] = true

  headers, url = *sign_request(url, secret, opts)
  url
end

#validate_url_signature(url, secret, opts = {}) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/optimize_player/signer.rb', line 29

def validate_url_signature(url, secret, opts = {})
  opts = default_opts.merge(opts)
  opts[:query_based] = true

  uri = parse_url(url)
  query_values = Rack::Utils.parse_nested_query(uri.query)
  return false unless query_values

  auth_params = query_values.delete(opts[:auth_param])
  return false unless auth_params

  date = auth_params["date"]
  nonce = auth_params["nonce"]
  compare_hashes(auth_params["signature"], :secret => secret, :method => "GET", :path => uri.path, :date => date, :nonce => nonce, :query => query_values, :headers => {})
end