proletarian-oauth 0.3.2

data/History.txt

@@ -0,0 +1,48 @@
+== 0.3.1
+
+* Michael Wood identified a problem with relative and absolute token request paths. This should now be fixed and is tested for both cases.
+
+== 0.3.0
+
+* Support ActionController::Request from Edge Rails (László Bácsi)
+* Correctly handle multi-valued parameters (Seth)
+* Added #normalized_parameters to OAuth::RequestProxy::Base (Pelle)
+* OAuth::Signature.sign and friends now yield the RequestProxy instead of the
+  token when the passed block's arity is 1. (Seth)
+* Token requests are made to the configured URL rather than generating a
+  potentially incorrect one.  (Kellan Elliott-McCrea)
+* Command-line app for generating signatures. (Seth)
+* Improved test-cases and compatibility for encoding issues. (Pelle)
+
+== 0.2.7 2008-9-10 The lets fix the last release release
+Fix in plain text signatures to bug found by Andrew Arrow. Who contributed new new unit tests for plain text sigs.
+
+There was an error in the RSA requests using oauth tokens. Thanks to Philip Lipu Tsai for noticing this.
+
+== 0.2.6 2008-9-9 The lets RSA release
+
+- Bill Kocik's fix for Ruby 1.8.7
+- Fixed rsa verification, so you can actually create an OAuth server yourself now using Ruby and RSA
+- Added better testing for RSA
+- Fixed issue where token was being included for rsa signatures
+- Chris Mear added support for a private_key_file option for rsa signatures 
+- Scott Hill fixed several edge cases where parameters were incorrectly being signed
+- Patch from choonkeat fixing a problem with rsa signing.
+
+== 0.2.2 2008-2-22 Lets actually support SSL release
+
+It didn't actually use https when required.
+
+== 0.2 2008-1-19 All together now release
+
+This is a big release, where we have merged the efforts of various parties into one common library. This means there are definitely some API changes you should be aware of. They should be minimal but please have a look at the unit tests.
+
+== 0.1.2 2007-12-1
+
+* 1 Fixed a problem where incoming request didn't check whether oauth parameters where missing. While not giving unauthorized access it did cause extra processing where not necessary.
+* 2 Includes Pat's fix for getting the realm out.
+
+== 0.1.1 2007-11-26
+
+* 1 First release as a GEM
+  * Moved all non rails functions into this GEM from the Rails plugin http://code.google.com/p/oauth-plugin/

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Blaine Cook, Larry Halff, Pelle Braendgaard
+
+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/Manifest.txt

@@ -0,0 +1,71 @@
+History.txt
+License.txt
+Manifest.txt
+README.rdoc
+Rakefile
+TODO
+bin/oauth
+lib/oauth.rb
+lib/oauth/cli.rb
+lib/oauth/client.rb
+lib/oauth/client/action_controller_request.rb
+lib/oauth/client/helper.rb
+lib/oauth/client/net_http.rb
+lib/oauth/consumer.rb
+lib/oauth/helper.rb
+lib/oauth/oauth_test_helper.rb
+lib/oauth/request_proxy.rb
+lib/oauth/request_proxy/action_controller_request.rb
+lib/oauth/request_proxy/base.rb
+lib/oauth/request_proxy/jabber_request.rb
+lib/oauth/request_proxy/mock_request.rb
+lib/oauth/request_proxy/net_http.rb
+lib/oauth/request_proxy/rack_request.rb
+lib/oauth/server.rb
+lib/oauth/signature.rb
+lib/oauth/signature/base.rb
+lib/oauth/signature/hmac/base.rb
+lib/oauth/signature/hmac/md5.rb
+lib/oauth/signature/hmac/rmd160.rb
+lib/oauth/signature/hmac/sha1.rb
+lib/oauth/signature/hmac/sha2.rb
+lib/oauth/signature/md5.rb
+lib/oauth/signature/plaintext.rb
+lib/oauth/signature/rsa/sha1.rb
+lib/oauth/signature/sha1.rb
+lib/oauth/token.rb
+lib/oauth/version.rb
+oauth.gemspec
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+specs.txt
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/cases/oauth_case.rb
+test/cases/spec/1_0-final/test_construct_request_url.rb
+test/cases/spec/1_0-final/test_normalize_request_parameters.rb
+test/cases/spec/1_0-final/test_parameter_encodings.rb
+test/cases/spec/1_0-final/test_signature_base_strings.rb
+test/keys/rsa.cert
+test/keys/rsa.pem
+test/test_action_controller_request_proxy.rb
+test/test_consumer.rb
+test/test_helper.rb
+test/test_hmac_sha1.rb
+test/test_net_http_client.rb
+test/test_net_http_request_proxy.rb
+test/test_rack_request_proxy.rb
+test/test_rsa_sha1.rb
+test/test_server.rb
+test/test_signature.rb
+test/test_signature_base.rb
+test/test_signature_plain_text.rb
+test/test_token.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.rdoc

@@ -0,0 +1,73 @@
+= Ruby OAuth GEM
+
+== What
+
+This is a RubyGem for implementing both OAuth clients and servers in Ruby applications.
+
+See the OAuth specs http://oauth.net/core/1.0/
+
+== Installing
+
+  sudo gem install oauth
+
+You can also install it from the oauth rubyforge project http://rubyforge.org/projects/oauth/.
+
+The source code is now hosted on the OAuth GitHub Project http://github.com/pelle/oauth/tree/master
+
+== The basics
+
+This is a ruby library which is intended to be used in creating Ruby Consumer and Service Provider applications. It is NOT a Rails plugin, but could easily be used for the foundation for such a Rails plugin.
+
+As a matter of fact it has been pulled out from an OAuth Rails Plugin http://code.google.com/p/oauth-plugin/ which now requires this GEM.
+
+== Demonstration of usage
+
+Create a new consumer instance by passing it a configuration hash:
+
+  @consumer=OAuth::Consumer.new( "key","secret", {
+    :site=>"https://agree2"
+    })
+
+Start the process by requesting a token
+
+  @request_token=@consumer.get_request_token
+  session[:request_token]=@request_token
+  redirect_to @request_token.authorize_url
+
+When user returns create an access_token
+
+  @access_token=@request_token.get_access_token
+  @photos=@access_token.get('/photos.xml')
+
+For more detailed instructions I have written this OAuth Client Tutorial http://stakeventures.com/articles/2008/02/23/developing-oauth-clients-in-ruby and "How to turn your rails site into an OAuth Provider ":http://stakeventures.com/articles/2007/11/26/how-to-turn-your-rails-site-into-an-oauth-provider .
+
+Finally be sure to check out the OAuth RDoc Manual http://oauth.rubyforge.org/rdoc/ .
+
+== Documentation Wiki
+
+There is some documentation on the Google Code project for the "OAuth Rails Plugin":http://code.google.com/p/oauth-plugin/ :
+
+* RequestToken http://code.google.com/p/oauth-plugin/wiki/RequestToken
+* AccessToken http://code.google.com/p/oauth-plugin/wiki/AccessToken
+
+== Forum
+
+http://groups.google.com/group/oauth-ruby
+
+
+== How to submit patches
+
+Read the "8 steps for fixing other people's code" http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/.
+
+The source code is now hosted on the OAuth GitHub Project http://github.com/pelle/oauth/tree/master
+
+To submit a patch, please fork the oauth project and create a patch with tests. Once you're happy with it send a pull request and post a message to the google group.
+
+== License
+
+This code is free to use under the terms of the MIT license. 
+
+== Contact
+
+Comments are welcome. Send an email to "Pelle Braendgaard" pelleb@gmail.com email via the OAuth Ruby mailing list http://groups.google.com/group/oauth-ruby
+

data/Rakefile

@@ -0,0 +1,34 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+$LOAD_PATH << File.dirname(__FILE__) + '/lib'
+require 'oauth'
+require 'oauth/version'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('oauth', OAuth::VERSION) do |p|
+  p.author = ['Pelle Braendgaard','Blaine Cook','Larry Halff','Jesse Clark','Jon Crosby', 'Seth Fitzsimmons']  
+  p.email = "pelleb@gmail.com"
+  p.description = "OAuth Core Ruby implementation"
+  p.summary = p.description
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.url = "http://oauth.rubyforge.org"
+  
+  p.extra_deps         = [
+    ['ruby-hmac','>= 0.3.1']
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log **/.*.sw? *.gem .config **/.DS_Store]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/TODO

@@ -0,0 +1,14 @@
+Common use-cases should be streamlined:
+
+* I have a URL that I want to sign (given consumer key/secret, optional
+  token/secret, optional nonce/timestamp).
+* I have a URL that I want to sign AND I want to see what the components
+  (e.g. signature base string, etc.) are while it's being signed (i.e. verbose
+  signing).
+* I have a URL that I want to sign and I only want the signature.
+* I have a URL that I want to sign and I want something suitable to put in
+  {the header, the querystring, XMPP}.
+* I want to make a query to an OAuth-enabled web service (with sensible
+  errors, if available).
+* I want to host an OAuth-enabled web service.
+* I want to test my OAuth-enabled web service (i.e. test helpers)

data/bin/oauth

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "oauth/cli"
+
+OAuth::CLI.execute(STDOUT, ARGV)

data/lib/oauth/cli.rb

@@ -0,0 +1,130 @@
+require 'optparse'
+require 'oauth'
+
+module OAuth
+  class CLI
+    SUPPORTED_COMMANDS = %w(sign)
+
+    attr_reader :command
+    attr_reader :options
+    attr_reader :stdout
+
+    def self.execute(stdout, arguments = [])
+      self.new.execute(stdout, arguments)
+    end
+
+    def execute(stdout, arguments = [])
+      @stdout = stdout
+      extract_command_and_parse_options(arguments)
+
+      if sufficient_options? && valid_command?
+        case command
+        when "sign"
+          request = OAuth::RequestProxy.proxy \
+             "method"     => options[:method],
+             "uri"        => options[:uri],
+             "parameters" => prepare_parameters
+
+          # can't pass options unless they respond to :secret, so use this alternative
+          signature = OAuth::Signature.sign \
+            request,
+            :consumer_secret => options[:oauth_consumer_secret],
+            :token_secret    => options[:oauth_token_secret] do |request|
+
+            # while we have access to the request being signed, display some internals
+            if verbose?
+              stdout.puts "Method: #{request.method}"
+              stdout.puts "URI: #{request.uri}"
+              stdout.puts "Normalized params: #{request.normalized_parameters}"
+              stdout.puts "Signature base string: #{request.signature_base_string}"
+            end
+          end
+
+          if verbose?
+            stdout.puts "Signature:         #{signature}"
+            stdout.puts "Escaped signature: #{OAuth::Helper.escape(signature)}"
+          else
+            stdout.puts signature
+          end
+        end
+      else
+        usage
+      end
+    end
+
+    def extract_command_and_parse_options(arguments)
+      @command = arguments[-1]
+      parse_options(arguments[0..-1])
+    end
+
+    def parse_options(arguments)
+      @options = {}
+      OptionParser.new do |opts|
+        opts.banner = "Usage: #{$0} [options] <command>"
+
+        # defaults
+        options[:oauth_signature_method] = "HMAC-SHA1"
+
+        opts.on("--consumer-key KEY", "Specifies the consumer key to use.") do |v|
+          options[:oauth_consumer_key] = v
+        end
+
+        opts.on("--consumer-secret SECRET", "Specifies the consumer secret to use.") do |v|
+          options[:oauth_consumer_secret] = v
+        end
+
+        opts.on("--method METHOD", "Specifies the method (e.g. GET) to use when signing.") do |v|
+          options[:method] = v
+        end
+
+        opts.on("--parameters PARAMS", "Specifies the parameters to use when signing.") do |v|
+          options[:params] = v
+        end
+
+        opts.on("--signature-method METHOD", "Specifies the signature method to use; defaults to HMAC-SHA1.") do |v|
+          options[:oauth_signature_method] = v
+        end
+
+        opts.on("--secret SECRET", "Specifies the token secret to use.") do |v|
+          options[:oauth_token_secret] = v
+        end
+
+        opts.on("--token TOKEN", "Specifies the token to use.") do |v|
+          options[:oauth_token] = v
+        end
+
+        opts.on("--uri URI", "Specifies the URI to use when signing.") do |v|
+          options[:uri] = v
+        end
+
+        opts.on("-v", "--verbose", "Be verbose.") do
+          options[:verbose] = true
+        end
+      end.parse!(arguments)
+    end
+
+    def prepare_parameters
+      {
+        "oauth_consumer_key"     => options[:oauth_consumer_key],
+        "oauth_token"            => options[:oauth_token],
+        "oauth_signature_method" => options[:oauth_signature_method]
+      }.merge(CGI.parse(options[:params]))
+    end
+
+    def sufficient_options?
+      options[:oauth_consumer_key] && options[:oauth_consumer_secret] && options[:method] && options[:uri]
+    end
+
+    def usage
+      stdout.puts "Should be generated by OptionParser"
+    end
+
+    def valid_command?
+      SUPPORTED_COMMANDS.include?(command)
+    end
+
+    def verbose?
+      options[:verbose]
+    end
+  end
+end

data/lib/oauth/client/action_controller_request.rb

@@ -0,0 +1,52 @@
+require 'oauth/client/helper'
+require 'oauth/request_proxy/action_controller_request'
+require 'action_controller/test_process'
+
+module ActionController
+  class Base
+    def process_with_oauth(request,response=nil)
+      request.apply_oauth!
+      process_without_oauth(request,response)
+    end
+
+    alias_method_chain :process, :oauth
+  end
+
+  class TestRequest
+    def self.use_oauth=(bool)
+      @use_oauth = bool
+    end
+
+    def self.use_oauth?
+      @use_oauth 
+    end
+
+    def configure_oauth(consumer = nil, token = nil, options = {})
+      @oauth_options = { :consumer => consumer,
+                   :token => token,
+                   :scheme => 'header',
+                   :signature_method => nil,
+                   :nonce => nil,
+                   :timestamp => nil }.merge(options)
+    end
+
+    def apply_oauth!
+      return unless ActionController::TestRequest.use_oauth? && @oauth_options
+      @oauth_helper = OAuth::Client::Helper.new(self, @oauth_options.merge( { :request_uri => request_uri } ))
+
+      self.send("set_oauth_#{@oauth_options[:scheme]}")
+    end
+
+    def set_oauth_header
+      env['Authorization'] = @oauth_helper.header
+    end
+
+    def set_oauth_parameters
+      @query_parameters = @oauth_helper.parameters_with_oauth
+      @query_parameters.merge!( { :oauth_signature => @oauth_helper.signature } )
+    end
+    
+    def set_oauth_query_string
+    end
+  end
+end

data/lib/oauth/client/helper.rb

@@ -0,0 +1,75 @@
+require 'oauth/client'
+require 'oauth/consumer'
+require 'oauth/helper'
+require 'oauth/token'
+require 'oauth/signature/hmac/sha1'
+
+module OAuth::Client
+  class Helper
+    include OAuth::Helper
+    
+    def initialize(request, options = {})
+      @request = request
+      @options = options
+      @options[:signature_method] ||= 'HMAC-SHA1'
+    end
+
+    def options
+      @options
+    end
+
+    def nonce
+      options[:nonce] ||= generate_key
+    end
+
+    def timestamp
+      options[:timestamp] ||= generate_timestamp
+    end
+
+    def generate_timestamp
+      Time.now.to_i.to_s
+    end
+
+    def oauth_parameters
+      {
+        'oauth_consumer_key'     => options[:consumer].key,
+        'oauth_token'            => options[:token] ? options[:token].token : '',
+        'oauth_signature_method' => options[:signature_method],
+        'oauth_timestamp'        => timestamp,
+        'oauth_nonce'            => nonce,
+        'oauth_version'          => '1.0'
+      }.reject { |k,v| v == "" }
+    end
+
+    def signature(extra_options = {})
+      OAuth::Signature.sign(@request, { :uri      => options[:request_uri],
+                                                    :consumer => options[:consumer],
+                                                    :token    => options[:token] }.merge(extra_options) )
+    end
+
+    def signature_base_string(extra_options = {})
+      OAuth::Signature.signature_base_string(@request, { :uri      => options[:request_uri],
+                                                    :consumer => options[:consumer],
+                                                    :token    => options[:token],
+                                                    :parameters => oauth_parameters}.merge(extra_options) )
+    end
+
+    def header
+      parameters = oauth_parameters
+      parameters.merge!( { 'oauth_signature' => signature( options.merge({ :parameters => parameters }) ) } )
+
+      header_params_str = parameters.map { |k,v| "#{k}=\"#{escape(v)}\"" }.join(', ')
+
+      realm = "realm=\"#{options[:realm]}\", " if options[:realm]
+      "OAuth #{realm}#{header_params_str}"
+    end
+
+    def parameters
+      OAuth::RequestProxy.proxy(@request).parameters
+    end
+
+    def parameters_with_oauth
+      oauth_parameters.merge( parameters )
+    end
+  end
+end

data/lib/oauth/client/net_http.rb

@@ -0,0 +1,75 @@
+require 'oauth/helper'
+require 'oauth/client/helper'
+require 'oauth/request_proxy/net_http'
+
+class Net::HTTPRequest
+  include OAuth::Helper
+
+  def oauth!(http, consumer = nil, token = nil, options = {})
+    options = { :request_uri => oauth_full_request_uri(http),
+                :consumer => consumer,
+                :token => token,
+                :scheme => 'header',
+                :signature_method => nil,
+                :nonce => nil,
+                :timestamp => nil }.merge(options)
+
+    @oauth_helper = OAuth::Client::Helper.new(self, options)
+    self.send("set_oauth_#{options[:scheme]}")
+  end
+
+  def signature_base_string(http, consumer = nil, token = nil, options = {})
+    options = { :request_uri => oauth_full_request_uri(http),
+                :consumer => consumer,
+                :token => token,
+                :scheme => 'header',
+                :signature_method => nil,
+                :nonce => nil,
+                :timestamp => nil }.merge(options)
+
+    OAuth::Client::Helper.new(self, options).signature_base_string
+  end
+  
+  def oauth_helper
+    @oauth_helper
+  end
+  private
+
+  def oauth_full_request_uri(http)
+    uri = URI.parse(self.path)
+    uri.host = http.address
+    uri.port = http.port
+    if http.respond_to?(:use_ssl?)
+      uri.scheme = http.use_ssl? ? 'https' : 'http'
+    end
+    uri.to_s
+  end
+
+  def set_oauth_header
+    self['Authorization'] = @oauth_helper.header
+  end
+
+  # FIXME: if you're using a POST body and query string parameters, using this
+  # method will convert those parameters on the query string into parameters in
+  # the body. this is broken, and should be fixed.
+  def set_oauth_body
+    self.set_form_data(@oauth_helper.parameters_with_oauth)
+    params_with_sig = @oauth_helper.parameters.merge(:oauth_signature => @oauth_helper.signature)
+    self.set_form_data(params_with_sig)
+  end
+
+  def set_oauth_query_string
+    oauth_params_str = @oauth_helper.oauth_parameters.map { |k,v| "#{k}=#{v}" }.join("&")
+
+    uri = URI.parse(path)
+    if !uri.query || uri.query == ''
+      uri.query = oauth_params_str
+    else
+      uri.query = uri.query + "&" + oauth_params_str
+    end
+
+    @path = uri.to_s
+
+    @path << "&oauth_signature=#{escape(@oauth_helper.signature)}"
+  end
+end

data/lib/oauth/client.rb

@@ -0,0 +1,4 @@
+module OAuth
+  module Client
+  end
+end