This is an alpha release, a pre 1.0 version. If you use this, be aware it's in its infancy.
Rack Middleware used to verify signed requests.
Add this line to your application's Gemfile:
gem 'rack-signature'
And then execute:
$ bundle
Or install it yourself as:
$ gem install rack-signature
This is meant to be added to a Rails initializer like so:
Rails.application.config.middleware.use Rack::Signature,
klass: ClassWithSharedKey,
method: 'method_within_class',
header_token: 'http header used to hold the api key'This gem is assumed to be used within a rails application. It computes the HMAC Signature internally and only sends a (single) request over the network when Signatures fail to match; sending a 401. Otherwise, it makes no requests - only accepts incoming JSON Api requests.
This gem will build an HMAC Signature based off an incoming request made to its JSON Api initiated by some external client. Once it builds the "expected" HMAC Signature, it will compare its Signature against the Signature that was sent by the external client. If they match, the request is allowed to continue to the Rails application. If it fails, this gem will send back a 401 response from its own internal Rack application.
The name of the class within the rails application that can be used to query for a model's shared key.
It is assumed that each consumer has it's own unique shared key; similar to Oauth.
The method within the +klass+ that will be called to request a shared key to build the HMAC. This is a class level method.
This is a bad name. It will be changed.
This is the name of the HTTP Header that holds the Api Key that is associated with the consumer's account. It is used as the authentication as well as a way to get the consumer's account to retreive the +shared key+.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request