https://github.com/remind101/request_signing

https://github.com/remind101/request_signing

Last synced: over 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/remind101/request_signing
• Owner: remind101
• License: mit
• Created: 2017-10-25T00:39:52.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-11-08T22:27:15.000Z (over 8 years ago)
• Last Synced: 2025-01-10T16:37:25.827Z (over 1 year ago)
• Language: Ruby
• Size: 41 KB
• Stars: 0
• Watchers: 52
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# RequestSigning

[![Gem Version](https://badge.fury.io/rb/request_signing.svg)](https://badge.fury.io/rb/request_signing)

[![Build Status](https://circleci.com/gh/remind101/request_signing.png?style=shield&circle-token=b945a7d85dbfbd7ef5a1257a985dee1ff3b47015)](https://circleci.com/gh/remind101/request_signing)

[![Docs](https://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/request_signing/RequestSigning)

An extensible implementation of [http request signing spec draft](https://tools.ietf.org/html/draft-cavage-http-signatures-08)

for Ruby HTTP clients and servers.

Supports the following algorithms:

* rsa-sha1

* rsa-sha256

* rsa-sha512

* dsa-sha1

* hmac-sha1

* hmac-sha256

* hmac-sha512

Integrates with the following libraries:

* rack

* net/http

* faraday

## Plugins

* request_signing-rack

  [![Gem Version](https://badge.fury.io/rb/request_signing.svg)](https://badge.fury.io/rb/request_signing-rack)

  [![Docs](https://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/request_signing-rack/RequestSigning/Rack/Middleware)

* request_signing-faraday

  [![Gem Version](https://badge.fury.io/rb/request_signing.svg)](https://badge.fury.io/rb/request_signing-faraday)

  [![Docs](https://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/request_signing-faraday/RequestSigning/Faraday/Middleware)

* request_signing-ssm

  [![Gem Version](https://badge.fury.io/rb/request_signing.svg)](https://badge.fury.io/rb/request_signing-ssm)

  [![Docs](https://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/request_signing-ssm/RequestSigning/KeyStores/SSM)

## Installation

Add these lines to your application's Gemfile:

```ruby

gem 'request_signing'

gem 'request_signing-rack'    # for rack integration

gem 'request_signing-faraday' # for faraday integration

gem 'request_signing-ssm'     # for AWS SSM integration

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install request_signing request_signing-rack request_signing-faraday request_signing-ssm

## Usage

See [examples](./examples)

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/remind101/request_signing.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).