google-apis-firebaseappcheck_v1beta 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96a6052442b11b703b4100b639f875aa9b6ad9235b92398c85b18325b3ad82d1
-  data.tar.gz: c0a11a4175a9204428279c2e00ca9d3adc50987a814d5a21027a9597a51f4743
+  metadata.gz: 55357d11e61c1b555ee8665ab6a3831da635fc3cbec4801b03859fd5b0541189
+  data.tar.gz: a6bb12fed9bccdad2ca9255169b0730c8a12b271943006ecceba709fb9d6521f
 SHA512:
-  metadata.gz: 56765b45a714fcc5dfd58b542c256c120493f3534d799fd3733f16980627301da3905d155c45119992207522949aa067ce00207c15add58dc35e965061f2239d
-  data.tar.gz: 61a3f44fc51902c98a35185ca70287555e1b18458d1da04ff9967523c19e47caba898e5c749f44a23bd3ccc2ae5be88cc5d8c20792854b564420f131c94c8f8b
+  metadata.gz: 7e1aa826c37ef0110fec226c54cd4691dd8e6e7d56b4766436c1dc0a04dde0488e1b460bbe858a8fdf98c2f63770989fc20b7826423c84e00b69c170792b01d6
+  data.tar.gz: a959ab466a02247f2d4e7aa0ffcf781c54b7171809a2dbe9fdd291feaf57603c89eabe1d72bb5a97a82eb89f367d7af34723bc94523e3b22bcfd387204341016

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release history for google-apis-firebaseappcheck_v1beta
 
+### v0.2.0 (2021-06-24)
+
+* Regenerated from discovery document revision 20210621
+* Regenerated using generator version 0.3.0
+
 ### v0.1.0 (2021-05-27)
 
 * Regenerated from discovery document revision 20210524

data/lib/google/apis/firebaseappcheck_v1beta/classes.rb

@@ -22,6 +22,36 @@ module Google
   module Apis
     module FirebaseappcheckV1beta
       
+      # Response object for GenerateAppAttestChallenge
+      class GoogleFirebaseAppcheckV1betaAppAttestChallengeResponse
+        include Google::Apis::Core::Hashable
+      
+        # A one time use challenge for the client to pass to Apple's App Attest API.
+        # Corresponds to the JSON property `challenge`
+        # NOTE: Values are automatically base64 encoded/decoded in the client library.
+        # @return [String]
+        attr_accessor :challenge
+      
+        # The duration from the time this challenge is minted until it is expired. This
+        # field is intended to ease client-side token management, since the device may
+        # have clock skew, but is still able to accurately measure a duration. This
+        # expiration is intended to minimize the replay window within which a single
+        # challenge may be reused. See AIP 142 for naming of this field.
+        # Corresponds to the JSON property `ttl`
+        # @return [String]
+        attr_accessor :ttl
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @challenge = args[:challenge] if args.key?(:challenge)
+          @ttl = args[:ttl] if args.key?(:ttl)
+        end
+      end
+      
       # Encapsulates an *App Check token*, which are used to access Firebase services
       # protected by App Check.
       class GoogleFirebaseAppcheckV1betaAttestationTokenResponse
@@ -224,6 +254,103 @@ module Google
         end
       end
       
+      # Request message for ExchangeAppAttestAssertion
+      class GoogleFirebaseAppcheckV1betaExchangeAppAttestAssertionRequest
+        include Google::Apis::Core::Hashable
+      
+        # The artifact previously returned by ExchangeAppAttestAttestation.
+        # Corresponds to the JSON property `artifact`
+        # NOTE: Values are automatically base64 encoded/decoded in the client library.
+        # @return [String]
+        attr_accessor :artifact
+      
+        # The CBOR encoded assertion provided by the Apple App Attest SDK.
+        # Corresponds to the JSON property `assertion`
+        # NOTE: Values are automatically base64 encoded/decoded in the client library.
+        # @return [String]
+        attr_accessor :assertion
+      
+        # A one time challenge returned by GenerateAppAttestChallenge.
+        # Corresponds to the JSON property `challenge`
+        # NOTE: Values are automatically base64 encoded/decoded in the client library.
+        # @return [String]
+        attr_accessor :challenge
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @artifact = args[:artifact] if args.key?(:artifact)
+          @assertion = args[:assertion] if args.key?(:assertion)
+          @challenge = args[:challenge] if args.key?(:challenge)
+        end
+      end
+      
+      # Request message for ExchangeAppAttestAttestation
+      class GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationRequest
+        include Google::Apis::Core::Hashable
+      
+        # The App Attest statement as returned by Apple's client-side App Attest API.
+        # This is the CBOR object returned by Apple, which will be Base64 encoded in the
+        # JSON API.
+        # Corresponds to the JSON property `attestationStatement`
+        # NOTE: Values are automatically base64 encoded/decoded in the client library.
+        # @return [String]
+        attr_accessor :attestation_statement
+      
+        # The challenge previously generated by the FAC backend.
+        # Corresponds to the JSON property `challenge`
+        # NOTE: Values are automatically base64 encoded/decoded in the client library.
+        # @return [String]
+        attr_accessor :challenge
+      
+        # The key ID generated by App Attest for the client app.
+        # Corresponds to the JSON property `keyId`
+        # NOTE: Values are automatically base64 encoded/decoded in the client library.
+        # @return [String]
+        attr_accessor :key_id
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @attestation_statement = args[:attestation_statement] if args.key?(:attestation_statement)
+          @challenge = args[:challenge] if args.key?(:challenge)
+          @key_id = args[:key_id] if args.key?(:key_id)
+        end
+      end
+      
+      # Response message for ExchangeAppAttestAttestation
+      class GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationResponse
+        include Google::Apis::Core::Hashable
+      
+        # An artifact that should be passed back during the Assertion flow.
+        # Corresponds to the JSON property `artifact`
+        # NOTE: Values are automatically base64 encoded/decoded in the client library.
+        # @return [String]
+        attr_accessor :artifact
+      
+        # Encapsulates an *App Check token*, which are used to access Firebase services
+        # protected by App Check.
+        # Corresponds to the JSON property `attestationToken`
+        # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAttestationTokenResponse]
+        attr_accessor :attestation_token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @artifact = args[:artifact] if args.key?(:artifact)
+          @attestation_token = args[:attestation_token] if args.key?(:attestation_token)
+        end
+      end
+      
       # Request message for the ExchangeCustomToken method.
       class GoogleFirebaseAppcheckV1betaExchangeCustomTokenRequest
         include Google::Apis::Core::Hashable
@@ -325,6 +452,19 @@ module Google
         end
       end
       
+      # Request message for GenerateAppAttestChallenge
+      class GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeRequest
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # Response message for the ListDebugTokens method.
       class GoogleFirebaseAppcheckV1betaListDebugTokensResponse
         include Google::Apis::Core::Hashable

data/lib/google/apis/firebaseappcheck_v1beta/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module FirebaseappcheckV1beta
       # Version of the google-apis-firebaseappcheck_v1beta gem
-      GEM_VERSION = "0.1.0"
+      GEM_VERSION = "0.2.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.2.0"
+      GENERATOR_VERSION = "0.3.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20210524"
+      REVISION = "20210621"
     end
   end
 end

data/lib/google/apis/firebaseappcheck_v1beta/representations.rb

@@ -22,6 +22,12 @@ module Google
   module Apis
     module FirebaseappcheckV1beta
       
+      class GoogleFirebaseAppcheckV1betaAppAttestChallengeResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleFirebaseAppcheckV1betaAttestationTokenResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -64,6 +70,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleFirebaseAppcheckV1betaExchangeAppAttestAssertionRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleFirebaseAppcheckV1betaExchangeCustomTokenRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -94,6 +118,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleFirebaseAppcheckV1betaListDebugTokensResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -142,6 +172,14 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleFirebaseAppcheckV1betaAppAttestChallengeResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :challenge, :base64 => true, as: 'challenge'
+          property :ttl, as: 'ttl'
+        end
+      end
+      
       class GoogleFirebaseAppcheckV1betaAttestationTokenResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -202,6 +240,33 @@ module Google
         end
       end
       
+      class GoogleFirebaseAppcheckV1betaExchangeAppAttestAssertionRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :artifact, :base64 => true, as: 'artifact'
+          property :assertion, :base64 => true, as: 'assertion'
+          property :challenge, :base64 => true, as: 'challenge'
+        end
+      end
+      
+      class GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :attestation_statement, :base64 => true, as: 'attestationStatement'
+          property :challenge, :base64 => true, as: 'challenge'
+          property :key_id, :base64 => true, as: 'keyId'
+        end
+      end
+      
+      class GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :artifact, :base64 => true, as: 'artifact'
+          property :attestation_token, as: 'attestationToken', class: Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAttestationTokenResponse, decorator: Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAttestationTokenResponse::Representation
+      
+        end
+      end
+      
       class GoogleFirebaseAppcheckV1betaExchangeCustomTokenRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -237,6 +302,12 @@ module Google
         end
       end
       
+      class GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class GoogleFirebaseAppcheckV1betaListDebugTokensResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/firebaseappcheck_v1beta/service.rb

@@ -94,6 +94,80 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Accepts a AppAttest Artifact and Assertion, and uses the developer's
+        # preconfigured auth token to verify the token with Apple. Returns an
+        # AttestationToken with the App ID as specified by the `app` field included as
+        # attested claims.
+        # @param [String] app
+        #   Required. The full resource name to the iOS App. Format: "projects/`project_id`
+        #   /apps/`app_id`"
+        # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeAppAttestAssertionRequest] google_firebase_appcheck_v1beta_exchange_app_attest_assertion_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAttestationTokenResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAttestationTokenResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def exchange_project_app_app_attest_assertion(app, google_firebase_appcheck_v1beta_exchange_app_attest_assertion_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta/{+app}:exchangeAppAttestAssertion', options)
+          command.request_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeAppAttestAssertionRequest::Representation
+          command.request_object = google_firebase_appcheck_v1beta_exchange_app_attest_assertion_request_object
+          command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAttestationTokenResponse::Representation
+          command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAttestationTokenResponse
+          command.params['app'] = app unless app.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Accepts a AppAttest CBOR Attestation, and uses the developer's preconfigured
+        # team and bundle IDs to verify the token with Apple. Returns an Attestation
+        # Artifact that can later be exchanged for an AttestationToken in
+        # ExchangeAppAttestAssertion.
+        # @param [String] app
+        #   Required. The full resource name to the iOS App. Format: "projects/`project_id`
+        #   /apps/`app_id`"
+        # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationRequest] google_firebase_appcheck_v1beta_exchange_app_attest_attestation_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def exchange_project_app_app_attest_attestation(app, google_firebase_appcheck_v1beta_exchange_app_attest_attestation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta/{+app}:exchangeAppAttestAttestation', options)
+          command.request_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationRequest::Representation
+          command.request_object = google_firebase_appcheck_v1beta_exchange_app_attest_attestation_request_object
+          command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationResponse::Representation
+          command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationResponse
+          command.params['app'] = app unless app.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Validates a custom token signed using your project's Admin SDK service account
         # credentials. If valid, returns an App Check token encapsulated in an
         # AttestationTokenResponse.
@@ -291,6 +365,41 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Initiates the App Attest flow by generating a challenge which will be used as
+        # a type of nonce for this attestation.
+        # @param [String] app
+        #   Required. The full resource name to the iOS App. Format: "projects/`project_id`
+        #   /apps/`app_id`"
+        # @param [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeRequest] google_firebase_appcheck_v1beta_generate_app_attest_challenge_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAppAttestChallengeResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAppAttestChallengeResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def generate_project_app_app_attest_challenge(app, google_firebase_appcheck_v1beta_generate_app_attest_challenge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta/{+app}:generateAppAttestChallenge', options)
+          command.request_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeRequest::Representation
+          command.request_object = google_firebase_appcheck_v1beta_generate_app_attest_challenge_request_object
+          command.response_representation = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAppAttestChallengeResponse::Representation
+          command.response_class = Google::Apis::FirebaseappcheckV1beta::GoogleFirebaseAppcheckV1betaAppAttestChallengeResponse
+          command.params['app'] = app unless app.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Creates a new DebugToken for the specified app. For security reasons, after
         # the creation operation completes, the `token` field cannot be updated or
         # retrieved, but you can revoke the debug token using DeleteDebugToken. Each app

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-firebaseappcheck_v1beta
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-31 00:00:00.000000000 Z
+date: 2021-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 2.a
 description: This is the simple REST client for Firebase App Check API V1beta. Simple
   REST clients are Ruby client libraries that provide access to Google services via
   their HTTP REST API endpoints. These libraries are generated and updated automatically
@@ -52,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-firebaseappcheck_v1beta/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-firebaseappcheck_v1beta/v0.1.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firebaseappcheck_v1beta/v0.2.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-firebaseappcheck_v1beta
 post_install_message: 
 rdoc_options: []