Class: Faraday::HttpSignature::Middleware::Options

Inherits:
Object
  • Object
show all
Defined in:
lib/faraday/http_signature/middleware.rb

Overview

Configuration options for the HTTP signature middleware.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#components ⇒ Array<String>

Returns the list of HTTP message components to sign.

Returns:

  • (Array<String>) 


119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/faraday/http_signature/middleware.rb', line 119

class Options < Faraday::Options.new(:key, :sign_request, :sign_key, :components, :verify_response, :verify_key, :params, :strict, :profile)
  # Returns the generic key.
  # @return [Linzer::Key, nil]
  def key
    self[:key]
  end

  # Whether outgoing requests should be signed.
  # Defaults to +true+ (returns +true+ when unset).
  # @return [Boolean]
  def sign_request?
    self[:sign_request] != false
  end

  # Whether incoming responses should be verified.
  # Defaults to +false+ (returns +false+ when unset).
  # @return [Boolean]
  def verify_response?
    self[:verify_response]
  end

  # Whether verification failures should raise an exception.
  # Defaults to +true+ (returns +true+ when unset).
  # @return [Boolean]
  def strict?
    self[:strict] != false
  end

  # Returns the list of HTTP message components to sign.
  # @return [Array<String>]
  def components
    Array(self[:components])
  end

  # Returns additional signature parameters.
  # @return [Hash]
  def params
    Hash(self[:params])
  end

  # Returns the signing profile configuration.
  #
  # @return [Symbol, Linzer::Signature::Profile::Base, nil]
  def profile
    self[:profile]
  end
end

#key ⇒ Linzer::Key?

Returns the generic key.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/faraday/http_signature/middleware.rb', line 119

class Options < Faraday::Options.new(:key, :sign_request, :sign_key, :components, :verify_response, :verify_key, :params, :strict, :profile)
  # Returns the generic key.
  # @return [Linzer::Key, nil]
  def key
    self[:key]
  end

  # Whether outgoing requests should be signed.
  # Defaults to +true+ (returns +true+ when unset).
  # @return [Boolean]
  def sign_request?
    self[:sign_request] != false
  end

  # Whether incoming responses should be verified.
  # Defaults to +false+ (returns +false+ when unset).
  # @return [Boolean]
  def verify_response?
    self[:verify_response]
  end

  # Whether verification failures should raise an exception.
  # Defaults to +true+ (returns +true+ when unset).
  # @return [Boolean]
  def strict?
    self[:strict] != false
  end

  # Returns the list of HTTP message components to sign.
  # @return [Array<String>]
  def components
    Array(self[:components])
  end

  # Returns additional signature parameters.
  # @return [Hash]
  def params
    Hash(self[:params])
  end

  # Returns the signing profile configuration.
  #
  # @return [Symbol, Linzer::Signature::Profile::Base, nil]
  def profile
    self[:profile]
  end
end

#params ⇒ Hash

Returns additional signature parameters.

Returns:

  • (Hash) 


119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/faraday/http_signature/middleware.rb', line 119

class Options < Faraday::Options.new(:key, :sign_request, :sign_key, :components, :verify_response, :verify_key, :params, :strict, :profile)
  # Returns the generic key.
  # @return [Linzer::Key, nil]
  def key
    self[:key]
  end

  # Whether outgoing requests should be signed.
  # Defaults to +true+ (returns +true+ when unset).
  # @return [Boolean]
  def sign_request?
    self[:sign_request] != false
  end

  # Whether incoming responses should be verified.
  # Defaults to +false+ (returns +false+ when unset).
  # @return [Boolean]
  def verify_response?
    self[:verify_response]
  end

  # Whether verification failures should raise an exception.
  # Defaults to +true+ (returns +true+ when unset).
  # @return [Boolean]
  def strict?
    self[:strict] != false
  end

  # Returns the list of HTTP message components to sign.
  # @return [Array<String>]
  def components
    Array(self[:components])
  end

  # Returns additional signature parameters.
  # @return [Hash]
  def params
    Hash(self[:params])
  end

  # Returns the signing profile configuration.
  #
  # @return [Symbol, Linzer::Signature::Profile::Base, nil]
  def profile
    self[:profile]
  end
end

#profile ⇒ Symbol, ...

Returns the signing profile configuration.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/faraday/http_signature/middleware.rb', line 119

class Options < Faraday::Options.new(:key, :sign_request, :sign_key, :components, :verify_response, :verify_key, :params, :strict, :profile)
  # Returns the generic key.
  # @return [Linzer::Key, nil]
  def key
    self[:key]
  end

  # Whether outgoing requests should be signed.
  # Defaults to +true+ (returns +true+ when unset).
  # @return [Boolean]
  def sign_request?
    self[:sign_request] != false
  end

  # Whether incoming responses should be verified.
  # Defaults to +false+ (returns +false+ when unset).
  # @return [Boolean]
  def verify_response?
    self[:verify_response]
  end

  # Whether verification failures should raise an exception.
  # Defaults to +true+ (returns +true+ when unset).
  # @return [Boolean]
  def strict?
    self[:strict] != false
  end

  # Returns the list of HTTP message components to sign.
  # @return [Array<String>]
  def components
    Array(self[:components])
  end

  # Returns additional signature parameters.
  # @return [Hash]
  def params
    Hash(self[:params])
  end

  # Returns the signing profile configuration.
  #
  # @return [Symbol, Linzer::Signature::Profile::Base, nil]
  def profile
    self[:profile]
  end
end

#sign_key ⇒ Linzer::Key?

Returns explicit key for signing; required when both signing and verification are enabled.

Returns:

  • (Linzer::Key, nil) —

    explicit key for signing; required when both signing and verification are enabled



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/faraday/http_signature/middleware.rb', line 119

class Options < Faraday::Options.new(:key, :sign_request, :sign_key, :components, :verify_response, :verify_key, :params, :strict, :profile)
  # Returns the generic key.
  # @return [Linzer::Key, nil]
  def key
    self[:key]
  end

  # Whether outgoing requests should be signed.
  # Defaults to +true+ (returns +true+ when unset).
  # @return [Boolean]
  def sign_request?
    self[:sign_request] != false
  end

  # Whether incoming responses should be verified.
  # Defaults to +false+ (returns +false+ when unset).
  # @return [Boolean]
  def verify_response?
    self[:verify_response]
  end

  # Whether verification failures should raise an exception.
  # Defaults to +true+ (returns +true+ when unset).
  # @return [Boolean]
  def strict?
    self[:strict] != false
  end

  # Returns the list of HTTP message components to sign.
  # @return [Array<String>]
  def components
    Array(self[:components])
  end

  # Returns additional signature parameters.
  # @return [Hash]
  def params
    Hash(self[:params])
  end

  # Returns the signing profile configuration.
  #
  # @return [Symbol, Linzer::Signature::Profile::Base, nil]
  def profile
    self[:profile]
  end
end

#sign_request ⇒ Boolean

Returns whether to sign outgoing requests (defaults to true).

Returns:

  • (Boolean) —

    whether to sign outgoing requests (defaults to true)



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/faraday/http_signature/middleware.rb', line 119

class Options < Faraday::Options.new(:key, :sign_request, :sign_key, :components, :verify_response, :verify_key, :params, :strict, :profile)
  # Returns the generic key.
  # @return [Linzer::Key, nil]
  def key
    self[:key]
  end

  # Whether outgoing requests should be signed.
  # Defaults to +true+ (returns +true+ when unset).
  # @return [Boolean]
  def sign_request?
    self[:sign_request] != false
  end

  # Whether incoming responses should be verified.
  # Defaults to +false+ (returns +false+ when unset).
  # @return [Boolean]
  def verify_response?
    self[:verify_response]
  end

  # Whether verification failures should raise an exception.
  # Defaults to +true+ (returns +true+ when unset).
  # @return [Boolean]
  def strict?
    self[:strict] != false
  end

  # Returns the list of HTTP message components to sign.
  # @return [Array<String>]
  def components
    Array(self[:components])
  end

  # Returns additional signature parameters.
  # @return [Hash]
  def params
    Hash(self[:params])
  end

  # Returns the signing profile configuration.
  #
  # @return [Symbol, Linzer::Signature::Profile::Base, nil]
  def profile
    self[:profile]
  end
end

#strict ⇒ Boolean

Returns when true (default), raises VerifyError on verification failure; when false, sets env[:http_signature_verified] to false and continues.

Returns:

  • (Boolean) —

    when true (default), raises VerifyError on verification failure; when false, sets env[:http_signature_verified] to false and continues



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/faraday/http_signature/middleware.rb', line 119

class Options < Faraday::Options.new(:key, :sign_request, :sign_key, :components, :verify_response, :verify_key, :params, :strict, :profile)
  # Returns the generic key.
  # @return [Linzer::Key, nil]
  def key
    self[:key]
  end

  # Whether outgoing requests should be signed.
  # Defaults to +true+ (returns +true+ when unset).
  # @return [Boolean]
  def sign_request?
    self[:sign_request] != false
  end

  # Whether incoming responses should be verified.
  # Defaults to +false+ (returns +false+ when unset).
  # @return [Boolean]
  def verify_response?
    self[:verify_response]
  end

  # Whether verification failures should raise an exception.
  # Defaults to +true+ (returns +true+ when unset).
  # @return [Boolean]
  def strict?
    self[:strict] != false
  end

  # Returns the list of HTTP message components to sign.
  # @return [Array<String>]
  def components
    Array(self[:components])
  end

  # Returns additional signature parameters.
  # @return [Hash]
  def params
    Hash(self[:params])
  end

  # Returns the signing profile configuration.
  #
  # @return [Symbol, Linzer::Signature::Profile::Base, nil]
  def profile
    self[:profile]
  end
end

#verify_key ⇒ Linzer::Key?

Returns explicit key for verification; required when both signing and verification are enabled.

Returns:

  • (Linzer::Key, nil) —

    explicit key for verification; required when both signing and verification are enabled



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/faraday/http_signature/middleware.rb', line 119

class Options < Faraday::Options.new(:key, :sign_request, :sign_key, :components, :verify_response, :verify_key, :params, :strict, :profile)
  # Returns the generic key.
  # @return [Linzer::Key, nil]
  def key
    self[:key]
  end

  # Whether outgoing requests should be signed.
  # Defaults to +true+ (returns +true+ when unset).
  # @return [Boolean]
  def sign_request?
    self[:sign_request] != false
  end

  # Whether incoming responses should be verified.
  # Defaults to +false+ (returns +false+ when unset).
  # @return [Boolean]
  def verify_response?
    self[:verify_response]
  end

  # Whether verification failures should raise an exception.
  # Defaults to +true+ (returns +true+ when unset).
  # @return [Boolean]
  def strict?
    self[:strict] != false
  end

  # Returns the list of HTTP message components to sign.
  # @return [Array<String>]
  def components
    Array(self[:components])
  end

  # Returns additional signature parameters.
  # @return [Hash]
  def params
    Hash(self[:params])
  end

  # Returns the signing profile configuration.
  #
  # @return [Symbol, Linzer::Signature::Profile::Base, nil]
  def profile
    self[:profile]
  end
end

#verify_response ⇒ Boolean

Returns whether to verify incoming response signatures (defaults to false).

Returns:

  • (Boolean) —

    whether to verify incoming response signatures (defaults to false)



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/faraday/http_signature/middleware.rb', line 119

class Options < Faraday::Options.new(:key, :sign_request, :sign_key, :components, :verify_response, :verify_key, :params, :strict, :profile)
  # Returns the generic key.
  # @return [Linzer::Key, nil]
  def key
    self[:key]
  end

  # Whether outgoing requests should be signed.
  # Defaults to +true+ (returns +true+ when unset).
  # @return [Boolean]
  def sign_request?
    self[:sign_request] != false
  end

  # Whether incoming responses should be verified.
  # Defaults to +false+ (returns +false+ when unset).
  # @return [Boolean]
  def verify_response?
    self[:verify_response]
  end

  # Whether verification failures should raise an exception.
  # Defaults to +true+ (returns +true+ when unset).
  # @return [Boolean]
  def strict?
    self[:strict] != false
  end

  # Returns the list of HTTP message components to sign.
  # @return [Array<String>]
  def components
    Array(self[:components])
  end

  # Returns additional signature parameters.
  # @return [Hash]
  def params
    Hash(self[:params])
  end

  # Returns the signing profile configuration.
  #
  # @return [Symbol, Linzer::Signature::Profile::Base, nil]
  def profile
    self[:profile]
  end
end

Instance Method Details

#sign_request? ⇒ Boolean

Whether outgoing requests should be signed. Defaults to true (returns true when unset).

Returns:

  • (Boolean) 


129
130
131
 
# File 'lib/faraday/http_signature/middleware.rb', line 129

def sign_request?
  self[:sign_request] != false
end

#strict? ⇒ Boolean

Whether verification failures should raise an exception. Defaults to true (returns true when unset).

Returns:

  • (Boolean) 


143
144
145
 
# File 'lib/faraday/http_signature/middleware.rb', line 143

def strict?
  self[:strict] != false
end

#verify_response? ⇒ Boolean

Whether incoming responses should be verified. Defaults to false (returns false when unset).

Returns:

  • (Boolean) 


136
137
138
 
# File 'lib/faraday/http_signature/middleware.rb', line 136

def verify_response?
  self[:verify_response]
end