jive-signed_request 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4624406a4a1f95a499df4133a3393ad5eb168a96
+  data.tar.gz: 857a6823b6342991caa1db9e18330b1f35bca72a
+SHA512:
+  metadata.gz: 71dee81aaa8f5bd0fd2e75e56ee613b8a1ace87178ca65b5676ab337124aed2133e0195737f442202061e86111cba253679faf43cc9f269413ea4db6a9edbe50
+  data.tar.gz: cbd0d5196bcd2799ad71c68f8188b6178a236c3e9f4f6567be8f1e1095430f61cfe9c83f7e57adf6070da4a815ebfb14ff33f94ec1ab3121ac106eed24d58db1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.4
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Butch Marshall
+
+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 @@
+# Jive::SignedRequest
+
+Verify that a signed Jive Authorization header is valid
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jive-SignedRequest'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jive-signed_request
+
+## Usage
+
+To check if a Authentication header is valid
+
+```ruby
+require 'jive/signed_request'
+
+Jive::SignedRequest.authenticate("JiveEXTN algorithm=HmacSHA256&client_id=682a638ba74a4ff5fa6afa344b163e03.i&jive_url=https%3A%2F%2Fsandbox.jiveon.com%3A8443&tenant_id=b22e3911-28ef-480c-ae3b-ca791ba86952&timestamp=1436646990000&signature=GjQpEvBUoqUldgUk5bkUUrfwwUYIOcnh4IvQaDEQ4p8%3D", "8bd2952b851747e8f2c937b340fed6e1.s")
+```
+
+To sign 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/butchmarshall/jive-SignedRequest.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jive/signed_request"
+
+# 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

data/bin/setup

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

data/jive-signed_request.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jive/signed_request/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jive-signed_request"
+  spec.version       = Jive::SignedRequest::VERSION
+  spec.authors       = ["Butch Marshall"]
+  spec.email         = ["butch.a.marshall@gmail.com"]
+
+  spec.summary       = %q{Deal with signed requests sent by Jive}
+  spec.description   = %q{A library that deals with signed requests generated by Jive}
+  spec.homepage      = "https://github.com/butchmarshall/ruby-jive-signed_request"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/jive/signed_request/version.rb

@@ -0,0 +1,5 @@
+module Jive
+  module SignedRequest
+    VERSION = "0.1.0"
+  end
+end

data/lib/jive/signed_request.rb

@@ -0,0 +1,84 @@
+require "jive/signed_request/version"
+require "base64"
+require "openssl"
+require "cgi"
+require "time"
+
+module Jive # :nodoc:
+	module SignedRequest # :nodoc:
+		module_function
+
+		# Sign a string with a secret
+		#
+		# Sign a string with a secret and get the signature
+		#
+		# * *Args*    :
+		#   - +string+ -> the string to sign
+		#   - +secret+ -> the secret to use
+		# * *Returns* :
+		#   - the signature
+		# * *Raises* :
+		#   - +ArgumentError+ -> if no algorithm passed and algorithm could not be derived from the string
+		#
+		def sign(string, secret, algorithm = nil)
+			plain = ::Base64.decode64(secret.gsub(/\.s$/,''))
+			
+			# if no override algorithm passed try and extract from string
+			if algorithm.nil?
+				paramMap = ::CGI.parse string
+
+				if !paramMap.has_key?("algorithm")
+					raise ArgumentError, "missing algorithm"
+				end
+
+				algorithm = paramMap["algorithm"].first.gsub(/^hmac/i,'')
+			end
+			
+			hmac = ::OpenSSL::HMAC.digest(algorithm, plain, string)
+			Base64::encode64(hmac).gsub(/\n$/,'')
+		end
+
+		# Authenticate an authorization header
+		#
+		# Authenticates that an authorization header sent by Jive is valid given an apps secret
+		#
+		# * *Args*    :
+		#   - +authorization_header+ -> the entire Authorization header sent by Jive
+		#   - +client_secret+ -> the client secret to authenticate the header with
+		# * *Returns* :
+		#   - the signature
+		# * *Raises* :
+		#   - +ArgumentError+ -> if the authorization_header does not contain JiveEXTN
+		#   - +ArgumentError+ -> if the heauthorization_header does not contain all the required parameters
+		#   - +ArgumentError+ -> if the heauthorization_header has expired (more than 5 minutes old)
+		#
+		def authenticate(authorization_header, client_secret)
+			# Validate JiveEXTN part of header
+			if !authorization_header.match(/^JiveEXTN/)
+				raise ArgumentError, "Jive authorization header is not properly formatted, must start with JiveEXTN"
+			end
+
+			paramMap = ::CGI.parse authorization_header.gsub(/^JiveEXTN\s/,'')
+
+			# Validate all parameters are passed from header
+			if !paramMap.has_key?("algorithm") ||
+				!paramMap.has_key?("client_id") ||
+				!paramMap.has_key?("jive_url") ||
+				!paramMap.has_key?("tenant_id") ||
+				!paramMap.has_key?("timestamp") ||
+				!paramMap.has_key?("signature")
+				raise ArgumentError, "Jive authorization header is partial"
+			end
+
+			# Validate timestamp is still valid
+			timestamp = Time.at(paramMap["timestamp"].first.to_i/1000)
+			secondsPassed = Time.now - timestamp
+
+			if secondsPassed < 0 || secondsPassed > (5*60)
+				raise ArgumentError, "Jive authorization is rejected since it's #{ secondsPassed } seconds old (max. allowed is 5 minutes)"
+			end
+
+			self.sign(authorization_header.gsub(/^JiveEXTN\s/,'').gsub(/\&signature[^$]+/,''), client_secret) === paramMap["signature"].first
+		end
+ 	end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: jive-signed_request
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Butch Marshall
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A library that deals with signed requests generated by Jive
+email:
+- butch.a.marshall@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jive-signed_request.gemspec
+- lib/jive/signed_request.rb
+- lib/jive/signed_request/version.rb
+homepage: https://github.com/butchmarshall/ruby-jive-signed_request
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Deal with signed requests sent by Jive
+test_files: []