net-http-signature 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 791d4891ed58fa87c4b08c571899d6aeba4bf48a
+  data.tar.gz: 00f3c6d94312b5bd6db8312c5091e0d54c0dbbf4
+SHA512:
+  metadata.gz: a24a2b2ce36768bc0fd3d9dffa5859bdecd1d2541411834278eba26ef231b92da015b5475a45865057c2619404efaae8280de3187f191954435933459ee28906
+  data.tar.gz: eafde53865e3469a14256af39513f7ee1363a93f2cea5750cade230df65ada2ff991042e619f53ea5c8e3fb06a1854688524fa633c7a88f72bbc062320efe382

data/lib/net-http-signature.rb

@@ -0,0 +1 @@
+require_relative "net/http/signature"

data/lib/net/http/signature.rb

@@ -0,0 +1,45 @@
+require "base64"
+require "openssl"
+
+module Net
+  class HTTP
+    class Signature
+      require_relative "signature/request"
+      require_relative "signature/signer"
+      require_relative "signature/version"
+
+      HEADER = "Signature"
+
+      def initialize(key:, signer:)
+        @key = key
+        @signer = signer
+      end
+
+      def valid?(string)
+        to_s == string
+      end
+
+      def to_s
+        "key=#{key} algorithm=#{algorithm} token=#{signer}"
+      end
+
+      def to_h
+        {
+          HEADER => to_s
+        }
+      end
+
+      private def key
+        @key
+      end
+
+      private def algorithm
+        @signer.algorithm
+      end
+
+      private def signer
+        @signer
+      end
+    end
+  end
+end

data/lib/net/http/signature/request.rb

@@ -0,0 +1,36 @@
+module Net
+  class HTTP
+    class Signature
+      class Request
+        def initialize(verb:, uri:, headers:, body:)
+          @verb = verb
+          @uri = uri
+          @headers = headers
+          @body = body
+
+          fail ArgumentError, "Date header required" unless @headers.key?("Date")
+        end
+
+        def to_s
+          "#{verb} #{uri} #{headers} #{body}"
+        end
+
+        private def headers
+          @headers.to_a.sort_by(&:first).map { |(key, value)| "#{key}: #{value}" }.join("\n")
+        end
+
+        private def verb
+          @verb.upcase
+        end
+
+        private def uri
+          @uri
+        end
+
+        private def body
+          @body
+        end
+      end
+    end
+  end
+end

data/lib/net/http/signature/signer.rb

@@ -0,0 +1,47 @@
+module Net
+  class HTTP
+    class Signature
+      class Signer
+        def initialize(request:, algorithm:, secret:)
+          @request = request
+          @algorithm = algorithm
+          @secret = secret
+
+          unless @algorithm =~ /.+-.+/
+            fail ArgumentError, "Invalid algorithm format: {{key}}-{{digester}}"
+          end
+
+          unless key
+            fail ArgumentError, "Crypto scheme not supported"
+          end
+        end
+
+        def algorithm
+          @algorithm
+        end
+
+        def to_s
+          Base64.encode64(key.update(request).digest)
+        end
+
+        private def secret
+          @secret
+        end
+
+        private def request
+          @request.to_s
+        end
+
+        private def key
+          case algorithm.split("-").first
+          when "hmac" then OpenSSL::HMAC.new(secret, digester)
+          end
+        end
+
+        private def digester
+          algorithm.split("-").last.upcase
+        end
+      end
+    end
+  end
+end

data/lib/net/http/signature/version.rb

@@ -0,0 +1,7 @@
+module Net
+  class HTTP
+    class Signature
+      VERSION = "1.0.0"
+    end
+  end
+end

data/spec/lib/net/http/signature/request_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+describe Net::HTTP::Signature::Request do
+  let(:verb) { "GET" }
+  let(:uri) { "http://api.example.com" }
+  let(:headers) do
+    {
+      "Host" => "api.example.com",
+      "Date" => "2014-10-13 00:48:28 -0500",
+      "Content-Type" => "application/json",
+      "Accept" => "application/json",
+      "Authentication" => "Bearer fas425fmig.idfiodf"
+    }
+  end
+  let(:body) { "examplebody" }
+  let(:request) { described_class.new(verb: verb, uri: uri, headers: headers, body: body) }
+
+  context "with an missing Date header" do
+    let(:headers) do
+      {
+        "Host" => "api.example.com",
+        "Content-Type" => "application/json",
+        "Accept" => "application/json",
+        "Authentication" => "Bearer fas425fmig.idfiodf"
+      }
+    end
+
+    it "raises an error" do
+      expect { request }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "#to_s" do
+    let(:to_s) { request.to_s }
+
+    it "includes the verb" do
+      expect(to_s).to include(verb)
+    end
+
+    it "includes the uri" do
+      expect(to_s).to include(uri)
+    end
+
+    it "includes the headers" do
+      expect(to_s).to include(headers.to_a.sort_by(&:first).map { |(key, value)| "#{key}: #{value}" }.join("\n"))
+    end
+
+    it "includes the body" do
+      expect(to_s).to include(body)
+    end
+  end
+end

data/spec/lib/net/http/signature/signer_spec.rb

@@ -0,0 +1,68 @@
+require "spec_helper"
+
+describe Net::HTTP::Signature::Signer do
+  let(:verb) { "GET" }
+  let(:uri) { "http://api.example.com" }
+  let(:headers) do
+    {
+      "Host" => "api.example.com",
+      "Date" => "2014-10-13 00:48:28 -0500",
+      "Content-Type" => "application/json",
+      "Accept" => "application/json",
+      "Authentication" => "Bearer fas425fmig.idfiodf"
+    }
+  end
+  let(:body) { "examplebody" }
+  let(:request) { Net::HTTP::Signature::Request.new(verb: verb, uri: uri, headers: headers, body: body) }
+  let(:digester) { "hmac" }
+  let(:sha) { "sha512" }
+  let(:algorithm_name) { "#{digester}-#{sha}" }
+  let(:secret) { "foo" }
+  let(:signer) { described_class.new(request: request, algorithm: algorithm_name, secret: secret) }
+
+  context "with an invalid digester" do
+    let(:algorithm_name) { "example-sha512" }
+
+    it "raises an error" do
+      expect { signer }.to raise_error(ArgumentError)
+    end
+  end
+
+  context "with an invalid sha" do
+    let(:algorithm_name) { "hmac-sha666" }
+
+    it "raises an error" do
+      expect { signer }.to raise_error(RuntimeError)
+    end
+  end
+
+  context "with an invalid algorithm name" do
+    let(:algorithm_name) { "hmac sha512" }
+
+    it "raises an error" do
+      expect { signer }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "#algorithm" do
+    let(:algorithm) { signer.algorithm }
+
+    it "includes the digester" do
+      expect(algorithm).to include(digester)
+    end
+
+    it "includes the sha" do
+      expect(algorithm).to include(sha)
+    end
+  end
+
+  describe "#to_s" do
+    let(:to_s) { signer.to_s }
+    let(:signature) { OpenSSL.const_get(digester.upcase).digest(sha, secret, request.to_s) }
+    let(:encoded_signature) { Base64.encode64(signature) }
+
+    it "includes the base64'd signature token" do
+      expect(to_s).to eq(encoded_signature)
+    end
+  end
+end

data/spec/lib/net/http/signature_spec.rb

@@ -0,0 +1,124 @@
+require "spec_helper"
+
+describe Net::HTTP::Signature do
+  let(:verb) { "GET" }
+  let(:uri) { "http://api.example.com" }
+  let(:headers) do
+    {
+      "Host" => "api.example.com",
+      "Date" => "2014-10-13 00:48:28 -0500",
+      "Content-Type" => "application/json",
+      "Accept" => "application/json",
+      "Authentication" => "Bearer fas425fmig.idfiodf"
+    }
+  end
+  let(:body) { "" }
+  let(:secret) { "examplesecret" }
+  let(:algorithm) { "hmac-sha512" }
+  let(:request) { Net::HTTP::Signature::Request.new(verb: verb, uri: uri, headers: headers, body: body) }
+  let(:signer) { Net::HTTP::Signature::Signer.new(request: request, algorithm: algorithm, secret: secret) }
+  let(:key) { "examplekey" }
+  let(:signature) { described_class.new(signer: signer, key: key) }
+
+  let(:comparison_verb) { verb }
+  let(:comparison_uri) { uri }
+  let(:comparison_headers) { headers }
+  let(:comparison_body) { body }
+  let(:comparison_secret) { secret }
+  let(:comparison_algorithm) { algorithm }
+  let(:comparison_request) { Net::HTTP::Signature::Request.new(verb: comparison_verb, uri: comparison_uri, headers: comparison_headers, body: comparison_body) }
+  let(:comparison_signer) { Net::HTTP::Signature::Signer.new(request: comparison_request, algorithm: comparison_algorithm, secret: comparison_secret) }
+  let(:comparison_key) { key }
+  let(:comparison_signature) { described_class.new(signer: comparison_signer, key: comparison_key) }
+  let(:comparison) { comparison_signature.to_h["Signature"] }
+
+  describe "#valid?" do
+    let(:valid?) { signature.valid?(comparison) }
+
+    context "with a valid secret" do
+      it "returns true" do
+        expect(valid?).to be(true)
+      end
+    end
+
+    context "with an non-same secret" do
+      let(:comparison_secret) { "nonexamplesecret" }
+
+      it "returns false" do
+        expect(valid?).to be(false)
+      end
+    end
+
+    context "with an non-same verb" do
+      let(:comparison_verb) { "POST" }
+
+      it "returns false" do
+        expect(valid?).to be(false)
+      end
+    end
+
+    context "with non-same body" do
+      let(:comparison_body) { "f" }
+
+      it "returns false" do
+        expect(valid?).to be(false)
+      end
+    end
+
+    context "with non-same headers" do
+      let(:comparison_headers) do
+        {
+          "Date" => "2014-10-13 00:48:20 -0500"
+        }
+      end
+
+      it "returns false" do
+        expect(valid?).to be(false)
+      end
+    end
+
+    context "with non-same uri" do
+      let(:comparison_uri) { "http://aii.example.com" }
+
+      it "returns false" do
+        expect(valid?).to be(false)
+      end
+    end
+
+    context "with an invalid string" do
+      let(:comparison) { "foobar" }
+
+      it "returns false" do
+        expect(valid?).to be(false)
+      end
+    end
+  end
+
+  describe "#to_s" do
+    let(:to_s) { signature.to_s }
+
+    it "includes the algorithm" do
+      expect(to_s).to include("algorithm=#{algorithm}")
+    end
+
+    it "includes the key" do
+      expect(to_s).to include("key=#{key}")
+    end
+
+    it "includes the token" do
+      expect(to_s).to include("token=#{signer}")
+    end
+  end
+
+  describe "#to_h" do
+    let(:to_h) { signature.to_h }
+
+    it "includes the Signature key" do
+      expect(to_h.keys).to include("Signature")
+    end
+
+    it "includes the string form as a value to Signature key" do
+      expect(to_h["Signature"]).to eq(signature.to_s)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require "pry"
+require "rspec"
+require "net-http-signature"

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: net-http-signature
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kurtis Rainbolt-Greene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: A signing library for HTTP requests
+email:
+- me@kurtisrainboltgreene.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/net-http-signature.rb
+- lib/net/http/signature.rb
+- lib/net/http/signature/request.rb
+- lib/net/http/signature/signer.rb
+- lib/net/http/signature/version.rb
+- spec/lib/net/http/signature/request_spec.rb
+- spec/lib/net/http/signature/signer_spec.rb
+- spec/lib/net/http/signature/version_spec.rb
+- spec/lib/net/http/signature_spec.rb
+- spec/spec_helper.rb
+homepage: http://krainboltgreene.github.io/net-http-signature
+licenses:
+- MIT
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A signing library for HTTP requests
+test_files:
+- spec/lib/net/http/signature/request_spec.rb
+- spec/lib/net/http/signature/signer_spec.rb
+- spec/lib/net/http/signature/version_spec.rb
+- spec/lib/net/http/signature_spec.rb
+- spec/spec_helper.rb
+has_rdoc: