googleauth 0.8.1 → 0.13.0

data/spec/googleauth/service_account_spec.rb

@@ -112,12 +112,13 @@ describe Google::Auth::ServiceAccountCredentials do
   let(:client_email) { "app@developer.gserviceaccount.com" }
   let :cred_json do
     {
-      private_key_id: "a_private_key_id",
-      private_key:    @key.to_pem,
-      client_email:   client_email,
-      client_id:      "app.apps.googleusercontent.com",
-      type:           "service_account",
-      project_id:     "a_project_id"
+      private_key_id:   "a_private_key_id",
+      private_key:      @key.to_pem,
+      client_email:     client_email,
+      client_id:        "app.apps.googleusercontent.com",
+      type:             "service_account",
+      project_id:       "a_project_id",
+      quota_project_id: "b_project_id"
     }
   end
 
@@ -127,24 +128,28 @@ describe Google::Auth::ServiceAccountCredentials do
       json_key_io: StringIO.new(cred_json_text),
       scope:       "https://www.googleapis.com/auth/userinfo.profile"
     )
+    @id_client = ServiceAccountCredentials.make_creds(
+      json_key_io:     StringIO.new(cred_json_text),
+      target_audience: "https://pubsub.googleapis.com/"
+    )
   end
 
-  def make_auth_stubs opts = {}
-    access_token = opts[:access_token] || ""
-    body = MultiJson.dump("access_token" => access_token,
-                          "token_type"   => "Bearer",
-                          "expires_in"   => 3600)
+  def make_auth_stubs opts
+    body_fields = { "token_type" => "Bearer", "expires_in" => 3600 }
+    body_fields["access_token"] = opts[:access_token] if opts[:access_token]
+    body_fields["id_token"] = opts[:id_token] if opts[:id_token]
+    body = MultiJson.dump body_fields
     blk = proc do |request|
       params = Addressable::URI.form_unencode request.body
-      _claim, _header = JWT.decode(params.assoc("assertion").last,
-                                   @key.public_key, true,
-                                   algorithm: "RS256")
+      claim, _header = JWT.decode(params.assoc("assertion").last,
+                                  @key.public_key, true,
+                                  algorithm: "RS256")
+      !opts[:id_token] || claim["target_audience"] == "https://pubsub.googleapis.com/"
     end
     stub_request(:post, "https://www.googleapis.com/oauth2/v4/token")
       .with(body: hash_including(
         "grant_type" => "urn:ietf:params:oauth:grant-type:jwt-bearer"
-      ),
-            &blk)
+      ), &blk)
       .to_return(body:    body,
                  status:  200,
                  headers: { "Content-Type" => "application/json" })
@@ -285,6 +290,7 @@ describe Google::Auth::ServiceAccountCredentials do
         ENV["APPDATA"] = dir
         credentials = @clz.from_well_known_path @scope
         expect(credentials.project_id).to eq(cred_json[:project_id])
+        expect(credentials.quota_project_id).to eq(cred_json[:quota_project_id])
       end
     end
 
@@ -476,6 +482,7 @@ describe Google::Auth::ServiceAccountJwtHeaderCredentials do
         ENV["APPDATA"] = dir
         credentials = clz.from_well_known_path @scope
         expect(credentials.project_id).to eq(cred_json[:project_id])
+        expect(credentials.quota_project_id).to be_nil
       end
     end
   end

data/spec/googleauth/signet_spec.rb

@@ -47,18 +47,26 @@ describe Signet::OAuth2::Client do
       audience:             "https://oauth2.googleapis.com/token",
       signing_key:          @key
     )
+    @id_client = Signet::OAuth2::Client.new(
+      token_credential_uri: "https://oauth2.googleapis.com/token",
+      target_audience:      "https://pubsub.googleapis.com/",
+      issuer:               "app@example.com",
+      audience:             "https://oauth2.googleapis.com/token",
+      signing_key:          @key
+    )
   end
 
   def make_auth_stubs opts
-    access_token = opts[:access_token] || ""
-    body = MultiJson.dump("access_token" => access_token,
-                          "token_type"   => "Bearer",
-                          "expires_in"   => 3600)
+    body_fields = { "token_type" => "Bearer", "expires_in" => 3600 }
+    body_fields["access_token"] = opts[:access_token] if opts[:access_token]
+    body_fields["id_token"] = opts[:id_token] if opts[:id_token]
+    body = MultiJson.dump body_fields
     blk = proc do |request|
       params = Addressable::URI.form_unencode request.body
-      _claim, _header = JWT.decode(params.assoc("assertion").last,
-                                   @key.public_key, true,
-                                   algorithm: "RS256")
+      claim, _header = JWT.decode(params.assoc("assertion").last,
+                                  @key.public_key, true,
+                                  algorithm: "RS256")
+      !opts[:id_token] || claim["target_audience"] == "https://pubsub.googleapis.com/"
     end
     with_params = { body: hash_including(
       "grant_type" => "urn:ietf:params:oauth:grant-type:jwt-bearer"
@@ -100,4 +108,35 @@ describe Signet::OAuth2::Client do
       expect(stub).to have_been_requested
     end
   end
+
+  describe "#fetch_access_token!" do
+    it "retries when orig_fetch_access_token! raises Signet::RemoteServerError" do
+      mocked_responses = [:raise, :raise, "success"]
+      allow(@client).to receive(:orig_fetch_access_token!).exactly(3).times do
+        response = mocked_responses.shift
+        response == :raise ? raise(Signet::RemoteServerError) : response
+      end
+      expect(@client.fetch_access_token!).to eq("success")
+    end
+
+    it "raises when the max retry count is exceeded" do
+      mocked_responses = [:raise, :raise, :raise, :raise, :raise, :raise, "success"]
+      allow(@client).to receive(:orig_fetch_access_token!).exactly(6).times do
+        response = mocked_responses.shift
+        response == :raise ? raise(Signet::RemoteServerError) : response
+      end
+      expect { @client.fetch_access_token! }.to raise_error Signet::AuthorizationError
+    end
+
+    it "does not retry and raises right away if it encounters a Signet::AuthorizationError" do
+      allow(@client).to receive(:orig_fetch_access_token!).at_most(:once)
+        .and_raise(Signet::AuthorizationError.new("Some Message"))
+      expect { @client.fetch_access_token! }.to raise_error Signet::AuthorizationError
+    end
+
+    it "does not retry and raises right away if it encounters a Signet::ParseError" do
+      allow(@client).to receive(:orig_fetch_access_token!).at_most(:once).and_raise(Signet::ParseError)
+      expect { @client.fetch_access_token! }.to raise_error Signet::ParseError
+    end
+  end
 end

data/spec/googleauth/user_authorizer_spec.rb

@@ -80,7 +80,7 @@ describe Google::Auth::UserAuthorizer do
       expect(URI(uri).query).to_not match(/client_secret/)
     end
 
-    it "should include the callback uri" do
+    it "should include the redirect_uri" do
       expect(URI(uri).query).to match(
         %r{redirect_uri=https://www.example.com/oauth/callback}
       )
@@ -91,6 +91,25 @@ describe Google::Auth::UserAuthorizer do
     end
   end
 
+  context "when generating authorization URLs and callback_uri is 'postmessage'" do
+    let(:callback_uri) { "postmessage" }
+    let :authorizer do
+      Google::Auth::UserAuthorizer.new(client_id,
+                                       scope,
+                                       token_store,
+                                       callback_uri)
+    end
+    let :uri do
+      authorizer.get_authorization_url login_hint: "user1", state: "mystate"
+    end
+
+    it "should include the redirect_uri 'postmessage'" do
+      expect(URI(uri).query).to match(
+        %r{redirect_uri=postmessage}
+      )
+    end
+  end
+
   context "when generating authorization URLs with user ID & state" do
     let :uri do
       authorizer.get_authorization_url login_hint: "user1", state: "mystate"
@@ -253,6 +272,7 @@ describe Google::Auth::UserAuthorizer do
         user_id: "user1", code: "code"
       )
       expect(credentials.access_token).to eq "1/abc123"
+      expect(credentials.redirect_uri.to_s).to eq "https://www.example.com/oauth/callback"
     end
 
     it "should not store credentials when get only requested" do

data/spec/googleauth/user_refresh_spec.rb

@@ -64,7 +64,7 @@ describe Google::Auth::UserRefreshCredentials do
     )
   end
 
-  def make_auth_stubs opts = {}
+  def make_auth_stubs opts
     access_token = opts[:access_token] || ""
     body = MultiJson.dump("access_token" => access_token,
                           "token_type"   => "Bearer",

data/spec/googleauth/web_user_authorizer_spec.rb

@@ -63,6 +63,12 @@ describe Google::Auth::WebUserAuthorizer do
       )
     end
 
+    it "should allow adding custom state key-value pairs" do
+      url = authorizer.get_authorization_url request: request, state: { james: "bond", kind: 1 }
+      expect(url).to match(%r{%22james%22:%22bond%22})
+      expect(url).to match(%r{%22kind%22:1})
+    end
+
     it "should include request forgery token in state" do
       expect(SecureRandom).to receive(:base64).and_return("aGVsbG8=")
       url = authorizer.get_authorization_url request: request

data/test/helper.rb

@@ -0,0 +1,33 @@
+# Copyright 2020 Google LLC
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#     * Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above
+# copyright notice, this list of conditions and the following disclaimer
+# in the documentation and/or other materials provided with the
+# distribution.
+#     * Neither the name of Google Inc. nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+require "minitest/autorun"
+require "minitest/focus"
+require "webmock/minitest"
+
+require "googleauth"

data/test/id_tokens/key_sources_test.rb

@@ -0,0 +1,240 @@
+# Copyright 2020 Google LLC
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#     * Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above
+# copyright notice, this list of conditions and the following disclaimer
+# in the documentation and/or other materials provided with the
+# distribution.
+#     * Neither the name of Google Inc. nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+require "helper"
+
+require "openssl"
+
+describe Google::Auth::IDTokens do
+  describe "StaticKeySource" do
+    let(:key1) { Google::Auth::IDTokens::KeyInfo.new id: "1234", key: :key1, algorithm: "RS256" }
+    let(:key2) { Google::Auth::IDTokens::KeyInfo.new id: "5678", key: :key2, algorithm: "ES256" }
+    let(:keys) { [key1, key2] }
+    let(:source) { Google::Auth::IDTokens::StaticKeySource.new keys }
+
+    it "returns a static set of keys" do
+      assert_equal keys, source.current_keys
+    end
+
+    it "does not change on refresh" do
+      assert_equal keys, source.refresh_keys
+    end
+  end
+
+  describe "HttpKeySource" do
+    let(:certs_uri) { "https://example.com/my-certs" }
+    let(:certs_body) { "{}" }
+
+    it "raises an error when failing to parse json from the site" do
+      source = Google::Auth::IDTokens::HttpKeySource.new certs_uri
+      stub = stub_request(:get, certs_uri).to_return(body: "whoops")
+      error = assert_raises Google::Auth::IDTokens::KeySourceError do
+        source.refresh_keys
+      end
+      assert_equal "Unable to parse JSON", error.message
+      assert_requested stub
+    end
+
+    it "downloads data but gets no keys" do
+      source = Google::Auth::IDTokens::HttpKeySource.new certs_uri
+      stub = stub_request(:get, certs_uri).to_return(body: certs_body)
+      keys = source.refresh_keys
+      assert_empty keys
+      assert_requested stub
+    end
+  end
+
+  describe "X509CertHttpKeySource" do
+    let(:certs_uri) { "https://example.com/my-certs" }
+    let(:key1) { OpenSSL::PKey::RSA.new 2048 }
+    let(:key2) { OpenSSL::PKey::RSA.new 2048 }
+    let(:cert1) { generate_cert key1 }
+    let(:cert2) { generate_cert key2 }
+    let(:id1) { "1234" }
+    let(:id2) { "5678" }
+    let(:certs_body) { JSON.dump({ id1 => cert1.to_pem, id2 => cert2.to_pem }) }
+
+    after do
+      WebMock.reset!
+    end
+
+    def generate_cert key
+      cert = OpenSSL::X509::Certificate.new
+      cert.subject = cert.issuer = OpenSSL::X509::Name.parse "/C=BE/O=Test/OU=Test/CN=Test"
+      cert.not_before = Time.now
+      cert.not_after = Time.now + 365 * 24 * 60 * 60
+      cert.public_key = key.public_key
+      cert.serial = 0x0
+      cert.version = 2
+      cert.sign key, OpenSSL::Digest::SHA1.new
+      cert
+    end
+
+    it "raises an error when failing to reach the site" do
+      source = Google::Auth::IDTokens::X509CertHttpKeySource.new certs_uri
+      stub = stub_request(:get, certs_uri).to_return(body: "whoops", status: 404)
+      error = assert_raises Google::Auth::IDTokens::KeySourceError do
+        source.refresh_keys
+      end
+      assert_equal "Unable to retrieve data from #{certs_uri}", error.message
+      assert_requested stub
+    end
+
+    it "raises an error when failing to parse json from the site" do
+      source = Google::Auth::IDTokens::X509CertHttpKeySource.new certs_uri
+      stub = stub_request(:get, certs_uri).to_return(body: "whoops")
+      error = assert_raises Google::Auth::IDTokens::KeySourceError do
+        source.refresh_keys
+      end
+      assert_equal "Unable to parse JSON", error.message
+      assert_requested stub
+    end
+
+    it "raises an error when failing to parse x509 from the site" do
+      source = Google::Auth::IDTokens::X509CertHttpKeySource.new certs_uri
+      stub = stub_request(:get, certs_uri).to_return(body: '{"hi": "whoops"}')
+      error = assert_raises Google::Auth::IDTokens::KeySourceError do
+        source.refresh_keys
+      end
+      assert_equal "Unable to parse X509 certificates", error.message
+      assert_requested stub
+    end
+
+    it "gets the right certificates" do
+      source = Google::Auth::IDTokens::X509CertHttpKeySource.new certs_uri
+      stub = stub_request(:get, certs_uri).to_return(body: certs_body)
+      keys = source.refresh_keys
+      assert_equal id1, keys[0].id
+      assert_equal id2, keys[1].id
+      assert_equal key1.public_key.to_pem, keys[0].key.to_pem
+      assert_equal key2.public_key.to_pem, keys[1].key.to_pem
+      assert_equal "RS256", keys[0].algorithm
+      assert_equal "RS256", keys[1].algorithm
+      assert_requested stub
+    end
+  end
+
+  describe "JwkHttpKeySource" do
+    let(:jwk_uri) { "https://example.com/my-jwk" }
+    let(:id1) { "fb8ca5b7d8d9a5c6c6788071e866c6c40f3fc1f9" }
+    let(:id2) { "LYyP2g" }
+    let(:jwk1) {
+      {
+        alg: "RS256",
+        e:   "AQAB",
+        kid: id1,
+        kty: "RSA",
+        n:   "zK8PHf_6V3G5rU-viUOL1HvAYn7q--dxMoUkt7x1rSWX6fimla-lpoYAKhFTLU" \
+             "ELkRKy_6UDzfybz0P9eItqS2UxVWYpKYmKTQ08HgUBUde4GtO_B0SkSk8iLtGh" \
+             "653UBBjgXmfzdfQEz_DsaWn7BMtuAhY9hpMtJye8LQlwaS8ibQrsC0j0GZM5KX" \
+             "RITHwfx06_T1qqC_MOZRA6iJs-J2HNlgeyFuoQVBTY6pRqGXa-qaVsSG3iU-vq" \
+             "NIciFquIq-xydwxLqZNksRRer5VAsSHf0eD3g2DX-cf6paSy1aM40svO9EfSvG" \
+             "_07MuHafEE44RFvSZZ4ubEN9U7ALSjdw",
+        use: "sig"
+      }
+    }
+    let(:jwk2) {
+      {
+        alg: "ES256",
+        crv: "P-256",
+        kid: id2,
+        kty: "EC",
+        use: "sig",
+        x:   "SlXFFkJ3JxMsXyXNrqzE3ozl_0913PmNbccLLWfeQFU",
+        y:   "GLSahrZfBErmMUcHP0MGaeVnJdBwquhrhQ8eP05NfCI"
+      }
+    }
+    let(:bad_type_jwk) {
+      {
+        alg: "RS256",
+        kid: "hello",
+        kty: "blah",
+        use: "sig"
+      }
+    }
+    let(:jwk_body) { JSON.dump({ keys: [jwk1, jwk2] }) }
+    let(:bad_type_body) { JSON.dump({ keys: [bad_type_jwk] }) }
+
+    after do
+      WebMock.reset!
+    end
+
+    it "raises an error when failing to reach the site" do
+      source = Google::Auth::IDTokens::JwkHttpKeySource.new jwk_uri
+      stub = stub_request(:get, jwk_uri).to_return(body: "whoops", status: 404)
+      error = assert_raises Google::Auth::IDTokens::KeySourceError do
+        source.refresh_keys
+      end
+      assert_equal "Unable to retrieve data from #{jwk_uri}", error.message
+      assert_requested stub
+    end
+
+    it "raises an error when failing to parse json from the site" do
+      source = Google::Auth::IDTokens::JwkHttpKeySource.new jwk_uri
+      stub = stub_request(:get, jwk_uri).to_return(body: "whoops")
+      error = assert_raises Google::Auth::IDTokens::KeySourceError do
+        source.refresh_keys
+      end
+      assert_equal "Unable to parse JSON", error.message
+      assert_requested stub
+    end
+
+    it "raises an error when the json structure is malformed" do
+      source = Google::Auth::IDTokens::JwkHttpKeySource.new jwk_uri
+      stub = stub_request(:get, jwk_uri).to_return(body: '{"hi": "whoops"}')
+      error = assert_raises Google::Auth::IDTokens::KeySourceError do
+        source.refresh_keys
+      end
+      assert_equal "No keys found in jwk set", error.message
+      assert_requested stub
+    end
+
+    it "raises an error when an unrecognized key type is encountered" do
+      source = Google::Auth::IDTokens::JwkHttpKeySource.new jwk_uri
+      stub = stub_request(:get, jwk_uri).to_return(body: bad_type_body)
+      error = assert_raises Google::Auth::IDTokens::KeySourceError do
+        source.refresh_keys
+      end
+      assert_equal "Cannot use key type blah", error.message
+      assert_requested stub
+    end
+
+    it "gets the right keys" do
+      source = Google::Auth::IDTokens::JwkHttpKeySource.new jwk_uri
+      stub = stub_request(:get, jwk_uri).to_return(body: jwk_body)
+      keys = source.refresh_keys
+      assert_equal id1, keys[0].id
+      assert_equal id2, keys[1].id
+      assert_kind_of OpenSSL::PKey::RSA, keys[0].key
+      assert_kind_of OpenSSL::PKey::EC, keys[1].key
+      assert_equal "RS256", keys[0].algorithm
+      assert_equal "ES256", keys[1].algorithm
+      assert_requested stub
+    end
+  end
+end