omniauth-googlefederated 0.1.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gem 'omniauth'
+gem 'ruby-openid', :git => 'git://github.com/liuhenry/ruby-openid.git'
+gem 'omniauth-openid'
+
+# Specify your gem's dependencies in omniauth-googlefederated.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Henry Liu
+
+MIT License
+
+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,45 @@
+# OmniAuth Google Federated (Hybrid OpenID+OAuth) #
+
+Hybrid authentication and authorization strategy for Google APIs. Combines the process for obtaining an authorized OAuth request token along with an OpenID authentication request. Based on the work of [Boy van Amstel](http://blog.boyvanamstel.nl/2011/07/omniauth-strategy-for-google-openidoauth-hybrid-protocol-login/). Unfortunately, OmniAuth 1.0 introduced significant [infrastructure changes](https://github.com/intridea/omniauth/wiki/Upgrading-to-1.0), so some modifications and updates were needed.
+
+From the [Google API Docs](http://code.google.com/apis/accounts/docs/OpenID.html):
+
+> The goal of OAuth is to acquire an access token from Google, which can then be used to exchange user-specific data with a Google service (such as calendar information or an address book). The regular OAuth process is a four-step sequence: (1) ask for a "request" token, (2) ask for the token to be authorized, which triggers user approval, (3) exchange the authorized request token for an "access" token, and (4) use the access token to interact with the user's Google service data. For a more detailed description, see OAuth for Web Applications.
+> With OpenID+OAuth, this sequence remains essentially the same. The difference is that getting an authorized OAuth request token (steps 1 and 2) is wrapped up in the OpenID authentication request. In this way, the user can approve login and service access at the same time.
+
+## Installation ##
+Add to `Gemfile`:
+
+```ruby
+gem 'omniauth-googlefederated'
+```
+
+In Ruby 1.9.2, there is a bug in the interpreter that causes a segfault when using 'zip' on enumerables of bytes. As of January 30, 2012, this hasn't been fixed yet, so you need to use a fork of ruby-openid instead:
+
+```ruby
+gem 'ruby-openid', :git => 'git://github.com/liuhenry/ruby-openid.git'
+```
+Then run `bundle install`.
+
+## Usage ##
+
+For Devise, you need to configure `app/config/initializers/devise.rb`.
+
+```ruby
+config.omniauth :GoogleFederated, 
+                :store => OpenID::Store::Filesystem.new('/tmp'), 
+                :name => 'GoogleFederated', 
+                :identifier => 'https://www.google.com/accounts/o8/id', 
+                :consumer_key => GMAIL_KEY, 
+                :consumer_secret => GMAIL_SECRET, 
+                :scope => ["http(s)://www.google.com/calendar/feeds/", "https://www.google.com/m8/feeds/"], 
+                :require => 'omniauth-googlefederated', 
+                :client_options => {:ssl => {:ca_file => '/usr/lib/ssl/certs/ca-certificates.crt'}}
+```
+
+The returned information is accessible in the omniauth.auth hash: 
+
+```ruby
+data = request.env["omniauth.auth"].info # OpenID login information
+oauth = request.env["omniauth.auth"].credentials # OAuth credentials
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rubygems'
+require 'bundler'
+begin
+    Bundler.setup(:default)
+rescue Bundler::BundlerError => e
+    $stderr.puts e.message
+    $stderr.puts "Run 'bundle install' to install missing gems"
+    exit e.status_code
+end

data/lib/omniauth-googlefederated.rb

@@ -0,0 +1,2 @@
+require "omniauth-googlefederated/version"
+require "omniauth/strategies/google_federated"

data/lib/omniauth-googlefederated/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Googlefederated
+    VERSION = "0.1.2"
+  end
+end

data/lib/omniauth/strategies/google_federated.rb

@@ -0,0 +1,58 @@
+require 'omniauth'
+require 'rack/openid'
+require 'omniauth-openid'
+
+module OmniAuth
+  module Strategies
+    class GoogleFederated < OmniAuth::Strategies::OpenID
+      include OmniAuth::Strategy
+
+
+      protected
+
+      def dummy_app
+        lambda{|env| [401, {"WWW-Authenticate" => Rack::OpenID.build_header(
+          :identifier => identifier,
+          :return_to => callback_url,
+          :required => @options[:required],
+          :optional => @options[:optional],
+          :"oauth[consumer]" => @options[:consumer_key],
+          :"oauth[scope]" => @options[:scope], 
+          :method => 'post'
+        )}, []]}
+      end
+
+      def auth_hash
+        # Based on https://gist.github.com/569650 by nov
+        oauth_response = ::OpenID::OAuth::Response.from_success_response(@openid_response)
+
+        consumer = ::OAuth::Consumer.new(
+          @options[:consumer_key],
+          @options[:consumer_secret],
+          :site => 'https://www.google.com',
+          :access_token_path  => '/accounts/OAuthGetAccessToken'
+        )
+        request_token = ::OAuth::RequestToken.new(
+          consumer,
+          oauth_response.request_token,
+          "" # OAuth request token secret is also blank in OpenID/OAuth Hybrid
+        )
+        @access_token = request_token.get_access_token
+        
+        OmniAuth::Utils.deep_merge(super(), {
+          'uid' => @openid_response.display_identifier,
+          'user_info' => user_info,
+          'credentials' => {
+            'scope' => @options[:scope], 
+            'token' => @access_token.token,
+            'secret' => @access_token.secret
+          }
+        })
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'googlefederated', 'GoogleFederated'
+OmniAuth.config.add_camelization 'google_fedreated', 'GoogleFederated'
+OmniAuth.config.add_camelization 'Google_Federated', 'GoogleFederated'

data/lib/omniauth/strategies/google_federated.rb.backup

@@ -0,0 +1,168 @@
+require 'omniauth'
+require 'openid'
+require 'rack/openid'
+require 'openid/extensions/sreg'
+require 'openid/extensions/ax'
+require 'openid/extensions/oauth'
+require 'openid/store/memory'
+
+module OmniAuth
+  module Strategies
+    class GoogleFederated
+      include OmniAuth::Strategy
+
+      AX = {
+          :email => 'http://axschema.org/contact/email',
+          :name => 'http://axschema.org/namePerson',
+          :nickname => 'http://axschema.org/namePerson/friendly',
+          :first_name => 'http://axschema.org/namePerson/first',
+          :last_name => 'http://axschema.org/namePerson/last',
+          :city => 'http://axschema.org/contact/city/home',
+          :state => 'http://axschema.org/contact/state/home',
+          :website => 'http://axschema.org/contact/web/default',
+          :image => 'http://axschema.org/media/image/aspect11'
+      }
+
+      option :name, :google_federated
+      option :required, [AX[:email], AX[:name], AX[:first_name], AX[:last_name], 'email', 'fullname']
+      option :optional, [AX[:nickname], AX[:city], AX[:state], AX[:website], AX[:image], 'postcode', 'nickname']
+      option :store, ::OpenID::Store::Memory.new
+      option :identifier, nil
+      option :identifier_param, 'openid_url'
+      option :consumer_key, nil
+      option :consumer_key_param, 'openid_oauth_consumer'
+      option :consumer_secret, nil
+      option :scope, nil
+      option :scope_param, 'openid_oauth_scope'
+
+      def identifier
+        i = options.identifier || request.params[options.identifier_param.to_s]
+        i = nil if i == ''
+        i
+      end
+
+      def consumer_key
+        i = options.consumer_key || request.params[options.consumer_key_param.to_s]
+        i = nil if i == ''
+        i
+      end
+
+      def consumer_secret
+        i = options.consumer_secret || request.params[options.consumer_secret_params.to_s]
+        i = nil if i == ''
+        i
+      end
+
+      def scope
+        i = options.scope || request.params[options.consumer_secret_param.to_s]
+        i = nil if i == ''
+        i
+      end
+
+      def dummy_app
+        lambda{|env| [401, {"WWW-Authenticate" => Rack::OpenID.build_header(
+          :identifier => identifier,
+          :return_to => callback_url,
+          :required => options.required,
+          :optional => options.optional,
+          :"oauth[consumer]" => consumer_key,
+          :"oauth[scope]" => scope,
+          :method => 'post'
+        )}, []]}
+      end
+
+      def request_phase
+        identifier ? start : get_identifier
+      end
+
+      def start
+        openid = Rack::OpenID.new(dummy_app, options[:store])
+        response = openid.call(env)
+        case env['rack.openid.response']
+        when Rack::OpenID::MissingResponse, Rack::OpenID::TimeoutResponse
+          fail!(:connection_failed)
+        else
+          oauth_response = ::OpenID::OAuth::Response.from_success_response(env['rack.openid.response'])
+          p oauth_response
+          if oauth_response.request_token
+            consumer = OAuth::Consumer.new(
+              consumer_key,
+              consumer_secret,
+              :site => 'https://www.google.com',
+              :access_token_path => '/accounts/OAuthGetAccessToken'
+            )
+            request_token = OAuth::RequestToken.new(
+              consumer,
+              oauth_response.reqest_token,
+              "" # OAuth request token secret is also blank in OpenID/OAuth Hybrid
+            )
+            access_token = request_token.get_access_token
+          else
+            fail!(:connection_failed)
+          end
+        end
+      end
+
+      def get_identifier
+        f = OmniAuth::Form.new(:title => 'OpenID Authentication')
+        f.label_field('OpenID Identifier', options.identifier_param)
+        f.input_field('url', options.identifier_param)
+        f.to_response
+      end
+
+      uid { openid_response.display_identifier } 
+
+      info do
+        sreg_user_info.merge(ax_user_info)
+      end
+
+      extra do
+        {'response' => openid_response}
+      end
+
+      def callback_phase
+        return fail!(:invalid_credentials) unless openid_response && openid_response.status == :success
+        super
+      end
+
+      def openid_response
+        unless @openid_response
+          openid = Rack::OpenID.new(lambda{|env| [200,{},[]]}, options[:store])
+          openid.call(env)
+          @openid_response = env.delete('rack.openid.response')
+        end
+        @openid_response
+      end
+
+      def sreg_user_info
+        sreg = ::OpenID::SReg::Response.from_success_response(openid_response)
+        return {} unless sreg
+        {
+          'email' => sreg['email'],
+          'name' => sreg['fullname'],
+          'location' => sreg['postcode'],
+          'nickname' => sreg['nickname']
+        }.reject{|k,v| v.nil? || v == ''}
+      end
+
+      def ax_user_info
+        ax = ::OpenID::AX::FetchResponse.from_success_response(openid_response)
+        return {} unless ax
+        {
+          'email' => ax.get_single(AX[:email]),
+          'first_name' => ax.get_single(AX[:first_name]),
+          'last_name' => ax.get_single(AX[:last_name]),
+          'name' => (ax.get_single(AX[:name]) || [ax.get_single(AX[:first_name]), ax.get_single(AX[:last_name])].join(' ')).strip,
+          'location' => ("#{ax.get_single(AX[:city])}, #{ax.get_single(AX[:state])}" if Array(ax.get_single(AX[:city])).any? && Array(ax.get_single(AX[:state])).any?),
+          'nickname' => ax.get_single(AX[:nickname]),
+          'urls' => ({'Website' => Array(ax.get_single(AX[:website])).first} if Array(ax.get_single(AX[:website])).any?)
+        }.inject({}){|h,(k,v)| h[k] = Array(v).first; h}.reject{|k,v| v.nil? || v == ''}  
+      end
+    end
+  end
+end
+
+
+OmniAuth.config.add_camelization 'googlefederated', 'GoogleFederated'
+OmniAuth.config.add_camelization 'google_federated', 'GoogleFederated'
+OmniAuth.config.add_camelization 'Google_Federated', 'GoogleFederated'

data/omniauth-googlefederated.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniauth-googlefederated/version"
+
+Gem::Specification.new do |s|
+  s.name        = "omniauth-googlefederated"
+  s.version     = Omniauth::Googlefederated::VERSION
+  s.authors     = ["Henry Liu"]
+  s.email       = ["henry@liuhenry.com"]
+  s.homepage    = ""
+  s.summary     = %q{Google OAuth/OpenID Federated Login strategy for OmniAuth 1.0}
+  s.description = %q{Hybrid authentication and authorization strategy for Google APIs. Combines the process for obtaining an authorized OAuth request token along with an OpenID authentication request.}
+
+  s.rubyforge_project = "omniauth-googlefederated"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-googlefederated
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- Henry Liu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-08 00:00:00.000000000 Z
+dependencies: []
+description: Hybrid authentication and authorization strategy for Google APIs. Combines
+  the process for obtaining an authorized OAuth request token along with an OpenID
+  authentication request.
+email:
+- henry@liuhenry.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-googlefederated.rb
+- lib/omniauth-googlefederated/version.rb
+- lib/omniauth/strategies/google_federated.rb
+- lib/omniauth/strategies/google_federated.rb.backup
+- omniauth-googlefederated.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: omniauth-googlefederated
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Google OAuth/OpenID Federated Login strategy for OmniAuth 1.0
+test_files: []