oauth-provider 0.5.0rc1

data/lib/generators/test_unit/templates/oauth_tokens.yml

@@ -0,0 +1,17 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+one:
+  id: 1
+  user_id: 1
+  client_application_id: 1
+  token: one
+  secret: MyString
+  created_at: 2007-11-19 07:31:46
+  updated_at: 2007-11-19 07:31:46
+two:
+  id: 2
+  user_id: 1
+  client_application_id: 1
+  token: two
+  secret: MyString
+  created_at: 2007-11-19 07:31:46
+  updated_at: 2007-11-19 07:31:46

data/lib/oauth-provider.rb

@@ -0,0 +1,24 @@
+require 'oauth'
+require 'oauth/signature/hmac/sha1'
+require 'oauth/request_proxy/rack_request'
+require 'oauth/server'
+require 'oauth/controllers/application_controller_methods'
+if Rails.version =~ /^3\./
+  require 'oauth/request_proxy/rack_request'
+else
+  require 'oauth/request_proxy/action_controller_request'
+  ActionController::Base.send :include, OAuth::Controllers::ApplicationControllerMethods
+end
+
+
+if Rails.version =~ /^3\./
+  module OAuth
+    module Provider
+      class OAuthRailtie < Rails::Railtie
+        initializer "oauth-plugin.configure_rails_initialization" do |app|
+          ActionController::Base.send :include, OAuth::Controllers::ApplicationControllerMethods
+        end
+      end
+    end
+  end
+end

data/lib/oauth-provider/version.rb

@@ -0,0 +1,5 @@
+module Oauth
+  module Provider
+    VERSION = "0.5.0rc1"
+  end
+end

data/lib/oauth/controllers/application_controller_methods.rb

@@ -0,0 +1,136 @@
+module OAuth
+  module Controllers
+
+    module ApplicationControllerMethods
+
+      def self.included(controller)
+        controller.class_eval do
+          extend ClassMethods
+        end
+      end
+
+      module ClassMethods
+        def oauthenticate(options={})
+          filter_options = {}
+          filter_options[:only]   = options.delete(:only) if options[:only]
+          filter_options[:except] = options.delete(:except) if options[:except]
+          before_filter Filter.new(options), filter_options
+        end
+      end
+
+      class Filter
+        def initialize(options={})
+          @options={
+              :interactive=>true,
+              :strategies => [:token,:two_legged]
+            }.merge(options)
+          @strategies = Array(@options[:strategies])
+          @strategies << :interactive if @options[:interactive]
+        end
+
+        def filter(controller)
+          Authenticator.new(controller,@strategies).allow?
+        end
+      end
+
+      class Authenticator
+        attr_accessor :controller, :strategies, :strategy
+        def initialize(controller,strategies)
+          @controller = controller
+          @strategies = strategies
+        end
+
+        def allow?
+          if @strategies.include?(:interactive) && interactive
+            true
+          elsif !(@strategies & env["oauth.strategies"].to_a).empty?
+            @controller.send :current_user=, token.user if token
+            true
+          else
+            if @strategies.include?(:interactive)
+              controller.send :access_denied
+            else
+              controller.send :invalid_oauth_response
+            end
+          end
+        end
+
+        def oauth20_token
+           env["oauth.version"]==2 && env["oauth.token"]
+        end
+
+        def oauth10_token
+          env["oauth.version"]==1 && env["oauth.token"]
+        end
+
+        def oauth10_request_token
+          oauth10_token && oauth10_token.is_a?(::RequestToken) ? oauth10_token : nil
+        end
+
+        def oauth10_access_token
+          oauth10_token && oauth10_token.is_a?(::AccessToken) ? oauth10_token : nil
+        end
+
+        def token
+          oauth20_token || oauth10_access_token || nil
+        end
+
+        def client_application
+          env["oauth.version"]==1 && env["oauth.client_application"] || oauth20_token.try(:client_application)
+        end
+
+        def two_legged
+           env["oauth.version"]==1 && client_application
+        end
+
+        def interactive
+          @controller.send :logged_in?
+        end
+
+        def env
+          request.env
+        end
+
+        def request
+          controller.send :request
+        end
+
+      end
+
+      protected
+
+      def current_token
+        request.env["oauth.token"]
+      end
+
+      def current_client_application
+        request.env["oauth.version"]==1 && request.env["oauth.client_application"] || current_token.try(:client_application)
+      end
+
+      def oauth?
+        current_token
+      end
+
+      # use in a before_filter. Note this is for compatibility purposes. Better to use oauthenticate now
+      def oauth_required
+        Authenticator.new(self,[:oauth10_access_token]).allow?
+      end
+
+      # use in before_filter. Note this is for compatibility purposes. Better to use oauthenticate now
+      def login_or_oauth_required
+        Authenticator.new(self,[:oauth10_access_token,:interactive]).allow?
+      end
+
+      def invalid_oauth_response(code=401,message="Invalid OAuth Request")
+        render :text => message, :status => code
+        false
+      end
+
+      # override this in your controller
+      def access_denied
+        head 401
+      end
+
+    end
+  end
+end

data/lib/oauth/controllers/provider_controller.rb

@@ -0,0 +1,181 @@
+require 'oauth/provider/authorizer'
+module OAuth
+  module Controllers
+
+    module ProviderController
+      def self.included(controller)
+        controller.class_eval do
+          before_filter :login_required, :only => [:authorize,:revoke]
+          oauthenticate :only => [:test_request]
+          oauthenticate :strategies => :token, :interactive => false, :only => [:invalidate,:capabilities]
+          oauthenticate :strategies => :two_legged, :interactive => false, :only => [:request_token]
+          oauthenticate :strategies => :oauth10_request_token, :interactive => false, :only => [:access_token]
+          skip_before_filter :verify_authenticity_token, :only=>[:request_token, :access_token, :invalidate, :test_request, :token]
+        end
+      end
+
+      def request_token
+        @token = current_client_application.create_request_token params
+        if @token
+          render :text => @token.to_query
+        else
+          render :nothing => true, :status => 401
+        end
+      end
+
+      def access_token
+        @token = current_token && current_token.exchange!
+        if @token
+          render :text => @token.to_query
+        else
+          render :nothing => true, :status => 401
+        end
+      end
+
+      def token
+        @client_application = ClientApplication.find_by_key! params[:client_id]
+        if @client_application.secret != params[:client_secret]
+          oauth2_error "invalid_client"
+          return
+        end
+        # older drafts used none for client_credentials
+        params[:grant_type] = 'client_credentials' if params[:grant_type] == 'none'
+        logger.info "grant_type=#{params[:grant_type]}"
+        if ["authorization_code", "password", "client_credentials"].include?(params[:grant_type])
+          send "oauth2_token_#{params[:grant_type].underscore}"
+        else
+          oauth2_error "unsupported_grant_type"
+        end
+      end
+
+      def test_request
+        render :text => params.collect{|k,v|"#{k}=#{v}"}.join("&")
+      end
+
+      def authorize
+        if params[:oauth_token]
+          @token = ::RequestToken.find_by_token! params[:oauth_token]
+          oauth1_authorize
+        else
+          if request.post?
+            @authorizer = OAuth::Provider::Authorizer.new current_user, user_authorizes_token?, params
+            redirect_to @authorizer.redirect_uri
+          else
+            @client_application = ClientApplication.find_by_key! params[:client_id]
+            render :action => "oauth2_authorize"
+          end
+        end
+      end
+
+      def revoke
+        @token = current_user.tokens.find_by_token! params[:token]
+        if @token
+          @token.invalidate!
+          flash[:notice] = "You've revoked the token for #{@token.client_application.name}"
+        end
+        redirect_to oauth_clients_url
+      end
+
+      # Invalidate current token
+      def invalidate
+        current_token.invalidate!
+        head :status=>410
+      end
+
+      # Capabilities of current_token
+      def capabilities
+        if current_token.respond_to?(:capabilities)
+          @capabilities=current_token.capabilities
+        else
+          @capabilities={:invalidate=>url_for(:action=>:invalidate)}
+        end
+
+        respond_to do |format|
+          format.json {render :json=>@capabilities}
+          format.xml {render :xml=>@capabilities}
+        end
+      end
+
+      protected
+
+      def oauth1_authorize
+        unless @token
+          render :action=>"authorize_failure"
+          return
+        end
+
+        unless @token.invalidated?
+          if request.post?
+            if user_authorizes_token?
+              @token.authorize!(current_user)
+              callback_url  = @token.oob? ? @token.client_application.callback_url : @token.callback_url
+              @redirect_url = URI.parse(callback_url) unless callback_url.blank?
+
+              unless @redirect_url.to_s.blank?
+                @redirect_url.query = @redirect_url.query.blank? ?
+                                      "oauth_token=#{@token.token}&oauth_verifier=#{@token.verifier}" :
+                                      @redirect_url.query + "&oauth_token=#{@token.token}&oauth_verifier=#{@token.verifier}"
+                redirect_to @redirect_url.to_s
+              else
+                render :action => "authorize_success"
+              end
+            else
+              @token.invalidate!
+              render :action => "authorize_failure"
+            end
+          end
+        else
+          render :action => "authorize_failure"
+        end
+      end
+
+
+      # http://tools.ietf.org/html/draft-ietf-oauth-v2-22#section-4.1.1
+      def oauth2_token_authorization_code
+        @verification_code =  @client_application.oauth2_verifiers.find_by_token params[:code]
+        unless @verification_code
+          oauth2_error
+          return
+        end
+        if @verification_code.redirect_url != params[:redirect_uri]
+          oauth2_error
+          return
+        end
+        @token = @verification_code.exchange!
+        render :json=>@token
+      end
+
+      # http://tools.ietf.org/html/draft-ietf-oauth-v2-22#section-4.1.2
+      def oauth2_token_password
+        @user = authenticate_user( params[:username], params[:password])
+        unless @user
+          oauth2_error
+          return
+        end
+        @token = Oauth2Token.create :client_application=>@client_application, :user=>@user, :scope=>params[:scope]
+        render :json=>@token
+      end
+
+      # should authenticate and return a user if valid password. Override in your own controller
+      def authenticate_user(username,password)
+        User.authenticate(username,password)
+      end
+
+      # autonomous authorization which creates a token for client_applications user
+      def oauth2_token_client_credentials
+        @token = Oauth2Token.create :client_application=>@client_application, :user=>@client_application.user, :scope=>params[:scope]
+        render :json=>@token
+      end
+
+      # Override this to match your authorization page form
+      def user_authorizes_token?
+        params[:authorize] == '1'
+      end
+
+      def oauth2_error(error="invalid_grant")
+        render :json=>{:error=>error}.to_json, :status => 400
+      end
+
+    end
+  end
+end

data/lib/oauth/provider/authorizer.rb

@@ -0,0 +1,83 @@
+require 'uri'
+
+module OAuth
+  module Provider
+    class Authorizer
+      attr_accessor :user, :params, :app
+
+      def initialize(user, authorized, params = {})
+        @user = user
+        @params = params
+        @authorized = authorized
+      end
+
+      def app
+        @app ||= ::ClientApplication.find_by_key!(params[:client_id])
+      end
+
+      def code
+        @code ||= ::Oauth2Verifier.create! :client_application => app,
+                                      :user => @user,
+                                      :scope => @params[:scope],
+                                      :callback_url => @params[:redirect_uri]
+      end
+
+      def token
+        @token ||= ::Oauth2Token.create! :client_application => app,
+                                      :user => @user,
+                                      :scope => @params[:scope],
+                                      :callback_url => @params[:redirect_uri]
+      end
+
+      def authorized?
+        @authorized == true
+      end
+
+      def redirect_uri
+        uri = base_uri
+        if params[:response_type] == 'code'
+          if uri.query
+            uri.query << '&'
+          else
+            uri.query = ''
+          end
+          uri.query << encode_response
+        else
+          uri.fragment = encode_response
+        end
+        uri.to_s
+      end
+
+      def response
+        r = {}
+        if ['token','code'].include? params[:response_type]
+          if authorized?
+            if params[:response_type] == 'code'
+              r[:code] = code.token
+            else
+              r[:access_token] = token.token
+            end
+          else
+            r[:error] = 'access_denied'
+          end
+        else
+          r[:error] = 'unsupported_response_type'
+        end
+        r[:state] = params[:state] if params[:state]
+        r
+      end
+
+      def encode_response
+        response.map do |k, v|
+          [URI.escape(k.to_s),URI.escape(v)] * "="
+        end * "&"
+      end
+
+      protected
+
+        def base_uri
+          URI.parse(params[:redirect_uri] || app.callback_url)
+        end
+    end
+  end
+end