aws-signature-v4 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01b2caa6ec91431a8e02a25b5888e97e66698ded
+  data.tar.gz: 16b5463b54621416c7337c477e7a39d76ece029e
+SHA512:
+  metadata.gz: 75fc4b0d62ae7c05512d1526649a68df401ecdb140de942921b540ea871f7d51bac7e37e291615d0cc0cdfa754375f457be66c4d2d8e4e131ef6609795d2ca62
+  data.tar.gz: 5238c0bc18112f0236e3edd9bb778de16ecd9f2e48d9fe4c04dcb1055a38ae550fa2e0d1e9019539edcf234b40c6c4e17b7413a1f060931dcb6ea5081efdc56b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.14.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at khaled@supahands.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aws-signature-v4.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 khaled83
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Aws::Signature::V4
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/aws/signature/v4`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aws-signature-v4'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aws-signature-v4
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/khaled83/aws-signature-v4. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/aws-signature-v4.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aws/signature/v4/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aws-signature-v4'
+  spec.version       = Aws::Signature::V4::VERSION
+  spec.authors       = ['khaled83']
+  spec.email         = ['khaled@supahands.com']
+
+  spec.summary       = 'Executes AWS Signature Version 4 Signing Process to add authentication information to AWS requests.'
+  spec.description   = 'Executes AWS Signature Version 4 Signing Process as explained at http://docs.aws.amazon.com/general/latest/gr/sigv4_signing.html.<br>It calculates the signature token and provides HTTP headers with authentication header.'
+  spec.homepage      = 'https://github.com/Supahands/aws-signature-v4.git'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "aws/signature/v4"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/aws/signature/v4.rb

@@ -0,0 +1,137 @@
+require "aws/signature/v4/version"
+
+module Aws
+  module Signature
+    module V4
+
+      class Signature
+
+        require 'json'
+
+        # Your code goes here...
+
+        attr_accessor :headers, :signature
+
+        # @param [String] region  AWS region
+        # @param [String] key_id  AWS user key id
+        # @param [String] secret_key  AWS user secret key
+        def initialize (region, key_id, secret_key, algorithm = 'AWS4-HMAC-SHA256', content_type = 'application/x-amz-json-1.0', content_type_sign_header = 'application/x-amz-json-1.0,application/x-www-form-urlencoded')
+          # calculate date and time
+          @t = Time.now.utc
+          @date = @t.strftime('%Y%m%d')
+          @time = @t.strftime('%Y%m%dT%H%M%SZ')
+          # mandatory fields
+          @region = region
+          @key_id = key_id
+          @secret_key = secret_key
+          # optional fields
+          @algorithm = algorithm
+          # content type used as signing header for generating token
+          @content_type_sign_header = content_type_sign_header
+          # final content type sent with service request
+          @content_type = content_type
+        end
+
+        # Public - generates AWS authentication signature key v4 to use with low level API calls (not using AWS SDKs)
+        # This also sets 'Authorization' header in the current instance
+        # See http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html for reference
+        # @param [String] service_name  AWS service name e.g. dynamodb
+        # @param [String] amz_target  AWS service target operation
+        # @param [String] http_method  HTTP method e.g. POST
+        # @param [String] payload  HTTP body content
+        # @param [String] host  HTTP host url
+        # @param [String] uri  HTTP path after host
+        # @return [String] signature string that can be used in Authentication header to allow access to AWS services using APIs
+        def generate_signature (service_name, amz_target, http_method, payload, host, uri)
+          # remove protocol (http://, https://) from host
+          host = host.sub(/^https?\:\/\/(www.)?/,'')
+          # construct headers
+          # ordering of header values is important, so we reconstruct rather than add new fields
+          @headers = {
+              'Content-Type': @content_type_sign_header,
+              'Host': host,
+              'X-Amz-Date': @time,
+              'X-Amz-Target': amz_target
+          }
+          # calculate credential scope
+          credential_scope = "#{@date}/#{@region}/#{service_name}/aws4_request"
+
+          hashed_payload = Digest::hexencode(Digest::SHA256.digest(payload.to_json)).downcase
+
+          # CanonicalHeaders
+          canonical_headers = @headers.keys.map {|k,v| k.downcase }.join(';')
+          canonical_headers_entry = @headers.map {|k,v| k.to_s.downcase + ':' + v.to_s }.join("\n")
+
+          # Task 1: Create a Canonical Request For Signature Version 4
+          # http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html
+          canonical_request =
+              "#{http_method}\n"\
+              "#{uri}\n"\
+              "\n"\
+              "#{canonical_headers_entry}\n"\
+              "\n"\
+              "#{canonical_headers}\n"\
+              "#{hashed_payload}"
+
+          hashed_canonical_request = Digest::hexencode(Digest::SHA256.digest(canonical_request)).downcase
+
+          # Task 2: Create a String to Sign for Signature Version 4
+          # http://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html
+          string_to_sign =
+              "#{@algorithm}\n"\
+              "#{@time}\n"\
+              "#{credential_scope}\n"\
+              "#{hashed_canonical_request}"
+
+          # Task 3: Calculate the AWS Signature Version 4
+          # http://docs.aws.amazon.com/general/latest/gr/sigv4-calculate-signature.html
+          signingKey = get_signature_key (service_name)
+
+          # Task 4: Add the Signing Information to the Request
+          # http://docs.aws.amazon.com/general/latest/gr/sigv4-add-signature-to-request.html
+          @signature = Digest::hexencode(OpenSSL::HMAC.digest( OpenSSL::Digest.new('SHA256'),signingKey, string_to_sign))
+          # generate authorization header and update it in headers
+          generate_authorization_header(service_name, amz_target, http_method, payload, host, uri)
+          @signature
+        end
+
+        def get_signature_key (service_name)
+          kDate    = OpenSSL::HMAC.digest('sha256', "AWS4" + @secret_key, @date)
+          kRegion  = OpenSSL::HMAC.digest('sha256', kDate, @region)
+          kService = OpenSSL::HMAC.digest('sha256', kRegion, service_name)
+          kSigning = OpenSSL::HMAC.digest('sha256', kService, "aws4_request")
+          kSigning
+        end
+
+        private
+
+        # Public - returns authorization header value using signature key v4
+        def generate_authorization_header(service_name, amz_target, http_method, payload, host, uri)
+          # remove protocol (http://, https://) from host
+          host = host.sub(/^https?\:\/\/(www.)?/,'')
+          # update headers host and amz_target
+          # ordering of header values is important, so we reconstruct rather than add new fields
+          @headers = {
+              'Content-Type': @content_type_sign_header,
+              'Host': host,
+              'X-Amz-Date': @time,
+              'X-Amz-Target': amz_target
+          }
+          # generate signature token
+          generate_signature(service_name, amz_target, http_method, payload, host, uri) unless @signature
+          # calculate signed headers
+          signed_headers = @headers.keys.map {|k,v| k.downcase }.join(';')
+          # calculate credential scope
+          credential_scope = "#{@date}/#{@region}/#{service_name}/aws4_request"
+          # generate AWS authorization header value
+          authorization_header = "#{@algorithm} Credential=#{@key_id}/#{credential_scope}, SignedHeaders=#{signed_headers}, Signature=#{@signature}"
+          @headers[:'Content-Type'] = @content_type
+          @headers['Authorization'] = authorization_header
+          authorization_header
+        end
+
+      end
+
+    end
+  end
+end

data/lib/aws/signature/v4/version.rb

@@ -0,0 +1,7 @@
+module Aws
+  module Signature
+    module V4
+      VERSION = '0.1.0'
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: aws-signature-v4
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- khaled83
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Executes AWS Signature Version 4 Signing Process as explained at http://docs.aws.amazon.com/general/latest/gr/sigv4_signing.html.<br>It
+  calculates the signature token and provides HTTP headers with authentication header.
+email:
+- khaled@supahands.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/aws-signature-v4.iml"
+- ".idea/encodings.xml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/workspace.xml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aws-signature-v4.gemspec
+- bin/console
+- bin/setup
+- lib/aws/signature/v4.rb
+- lib/aws/signature/v4/version.rb
+homepage: https://github.com/Supahands/aws-signature-v4.git
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Executes AWS Signature Version 4 Signing Process to add authentication information
+  to AWS requests.
+test_files: []