comet_backup_ruby_sdk 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1351a43776da0134fbbc0f29301c07bf21684f24fad024a2b24311c6c5f1993b
-  data.tar.gz: a21014914d06619f590dce35f990036d4369a76287a6d654a5565fb373ebf003
+  metadata.gz: 6d320abff24079c6c63042f2319ab6bf85895df807ae4e3c64e28f124931439d
+  data.tar.gz: 54992cd97acfdea46b281ec833bd6b42a5ee56968ca0f6a9a59a2dfaee4ee97b
 SHA512:
-  metadata.gz: 6c1267509de43041f58a02f46edd7aeb2d57eb7a464b5ba018d86398132bff04f94a5cc75bd6f04942a04fdd08a3a7e558c31cea467aae5090f192a75cb11a07
-  data.tar.gz: 8f5b8df8f2d55019e6ca2efd9ad5025d5d31e9bb00babd2fc82c3aeb3a434f4e6f790385cd8643170b4eb69ba2f30cb6d6fc4f59460f5177865f01678ec0ac08
+  metadata.gz: 3554197606a2d10499e981d642f7b2ad5645b2a424f13be88cf0be3d118da6c6df0caf9a784cc1d0c2536f9b591ef8320b1a04e46fffe0e42c4372c677dafa87
+  data.tar.gz: '0921fc302340b38c77bb6f7733c447d274347dc7379a8916b7f5a4fea0b97c666cdc126d793075be180ea40d431db1449659f279779bf965513c7e5af1235cb2'

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # CHANGELOG
 
-## 2021-11-24 v3.18.0
+## 2021-12-22 v1.11.0
+- Based on 21.12.1
+- Add `AdminAccountWebauthnRegistration` endpoint for new webauthn support.
+- Deprecate `AdminACcountU2fSubmitChallenge` as U2F is ending browser support in February 2022.
+
+## 2021-11-24 v1.10.0
 - Based on 21.9.12
 - Add support for Thai and Danish localizations
 - Add From and To fields to the EmailReportGenerated API

data/comet_backup_ruby_sdk.gemspec

@@ -12,7 +12,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'comet_backup_ruby_sdk'
-  spec.version       = '1.10.0'
+  spec.version       = '1.11.0'
   spec.authors       = ['Comet Licensing Ltd.']
   spec.email         = ['hello@cometbackup.com']
 

data/lib/comet/comet_server.rb

@@ -96,7 +96,7 @@ module Comet
     #
     # You must supply administrator authentication credentials to use this API.
     #
-    # @param [String] self_address (Optional) External URL of this server (used for U2F AppID)
+    # @param [String] self_address (Optional) External URL of this server
     # @return [Comet::SessionKeyRegeneratedResponse]
     def admin_account_session_start(self_address = nil)
       submit_params = {}
@@ -166,6 +166,9 @@ module Comet
     # AdminAccountU2fRequestRegistrationChallenge
     #
     # Register a new FIDO U2F token.
+    # Browser support for U2F is ending in February 2022. WebAuthn is backwards
+    # compatible with U2F keys, and Comet will automatically migrate existing U2F keys
+    # to allow their use with the WebAuthn endpoints.
     #
     # You must supply administrator authentication credentials to use this API.
     #
@@ -188,6 +191,9 @@ module Comet
     # AdminAccountU2fSubmitChallengeResponse
     #
     # Register a new FIDO U2F token.
+    # Browser support for U2F is ending in February 2022. WebAuthn is backwards
+    # compatible with U2F keys, and Comet will automatically migrate existing U2F keys
+    # to allow their use with the WebAuthn endpoints.
     #
     # You must supply administrator authentication credentials to use this API.
     #
@@ -245,6 +251,58 @@ module Comet
       ret
     end
 
+    # AdminAccountWebauthnRequestRegistrationChallenge
+    #
+    # Register a new FIDO2 WebAuthn token.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @param [String] self_address External URL of this server, used as WebAuthn ID
+    # @return [Comet::WebAuthnRegistrationChallengeResponse]
+    def admin_account_webauthn_request_registration_challenge(self_address)
+      submit_params = {}
+      raise TypeError, "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String
+
+      submit_params['SelfAddress'] = self_address
+
+      body = perform_request('api/v1/admin/account/webauthn/request-registration-challenge', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::WebAuthnRegistrationChallengeResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminAccountWebauthnSubmitChallengeResponse
+    #
+    # Register a new FIDO2 WebAuthn token.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    #
+    # @param [String] self_address External URL of this server, used as WebAuthn ID
+    # @param [String] challenge_id Associated value from AdminAccountWebAuthnRequestRegistrationChallenge API
+    # @param [String] credential JSON-encoded credential
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_account_webauthn_submit_challenge_response(self_address, challenge_id, credential)
+      submit_params = {}
+      raise TypeError, "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String
+
+      submit_params['SelfAddress'] = self_address
+      raise TypeError, "'challenge_id' expected String, got #{challenge_id.class}" unless challenge_id.is_a? String
+
+      submit_params['ChallengeID'] = challenge_id
+      raise TypeError, "'credential' expected String, got #{credential.class}" unless credential.is_a? String
+
+      submit_params['Credential'] = credential
+
+      body = perform_request('api/v1/admin/account/webauthn/submit-challenge-response', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminAddUser
     #
     # Add a new user account.
@@ -3593,7 +3651,7 @@ module Comet
 
       ret_error = Comet::CometAPIResponseMessage.new
       ret_error.from_hash(obj)
-      raise Comet::APIResponseError.new(ret_error), 'Comet API response status was not OK'
+      raise Comet::APIResponseError.new(ret_error)
     end
 
     # Perform a synchronous HTTP request.
@@ -3630,7 +3688,7 @@ module Comet
 
       form_params = []
       params.each do |k, v|
-        form_params.append [k, v, { :filename => k }]
+        form_params.append [k, v, {:filename => k}]
       end
       req.set_form(form_params, 'multipart/form-data')
 

data/lib/comet/definitions.rb

@@ -430,13 +430,13 @@ module Comet
 
   DEFAULT_TIMEZONE = 'UTC'
 
-  APPLICATION_VERSION = '21.9.12'
+  APPLICATION_VERSION = '21.12.1'
 
   APPLICATION_VERSION_MAJOR = 21
 
-  APPLICATION_VERSION_MINOR = 9
+  APPLICATION_VERSION_MINOR = 12
 
-  APPLICATION_VERSION_REVISION = 12
+  APPLICATION_VERSION_REVISION = 1
 
   RELEASE_CODENAME = 'Voyager'
 

data/lib/comet/models/admin_security_options.rb

@@ -29,9 +29,15 @@ module Comet
     # @type [Boolean] allow_password_and_u2flogin
     attr_accessor :allow_password_and_u2flogin
 
+    # @type [Boolean] allow_password_and_web_authn_login
+    attr_accessor :allow_password_and_web_authn_login
+
     # @type [Array<Comet::AdminU2FRegistration>] u2fregistrations
     attr_accessor :u2fregistrations
 
+    # @type [Array<Comet::AdminWebAuthnRegistration>] web_authn_registrations
+    attr_accessor :web_authn_registrations
+
     # @type [Number] totpkey_encryption_format
     attr_accessor :totpkey_encryption_format
 
@@ -52,6 +58,7 @@ module Comet
       @password_format = 0
       @password = ''
       @u2fregistrations = []
+      @web_authn_registrations = []
       @totpkey_encryption_format = 0
       @totpkey = ''
       @ipwhitelist = ''
@@ -85,6 +92,8 @@ module Comet
           @allow_password_and_totplogin = v
         when 'AllowPasswordAndU2FLogin'
           @allow_password_and_u2flogin = v
+        when 'AllowPasswordAndWebAuthnLogin'
+          @allow_password_and_web_authn_login = v
         when 'U2FRegistrations'
           if v.nil?
             @u2fregistrations = []
@@ -95,6 +104,16 @@ module Comet
               @u2fregistrations[i1].from_hash(v1)
             end
           end
+        when 'WebAuthnRegistrations'
+          if v.nil?
+            @web_authn_registrations = []
+          else
+            @web_authn_registrations = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @web_authn_registrations[i1] = Comet::AdminWebAuthnRegistration.new
+              @web_authn_registrations[i1].from_hash(v1)
+            end
+          end
         when 'TOTPKeyEncryptionFormat'
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
@@ -121,9 +140,13 @@ module Comet
       ret['AllowPasswordLogin'] = @allow_password_login
       ret['AllowPasswordAndTOTPLogin'] = @allow_password_and_totplogin
       ret['AllowPasswordAndU2FLogin'] = @allow_password_and_u2flogin
+      ret['AllowPasswordAndWebAuthnLogin'] = @allow_password_and_web_authn_login
       unless @u2fregistrations.nil?
         ret['U2FRegistrations'] = @u2fregistrations
       end
+      unless @web_authn_registrations.nil?
+        ret['WebAuthnRegistrations'] = @web_authn_registrations
+      end
       unless @totpkey_encryption_format.nil?
         ret['TOTPKeyEncryptionFormat'] = @totpkey_encryption_format
       end

data/lib/comet/models/admin_web_authn_registration.rb

@@ -0,0 +1,112 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'base64'
+require 'json'
+
+module Comet
+
+  # AdminWebAuthnRegistration is a typed class wrapper around the underlying Comet Server API data structure.
+  class AdminWebAuthnRegistration
+
+    # @type [String] description
+    attr_accessor :description
+
+    # @type [Number] register_time
+    attr_accessor :register_time
+
+    # @type [Boolean] is_legacy_u2f
+    attr_accessor :is_legacy_u2f
+
+    # @type [Array<Object>] id
+    attr_accessor :id
+
+    # @type [Comet::WebAuthnCredential] credential
+    attr_accessor :credential
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @description = ''
+      @register_time = 0
+      @id = []
+      @credential = Comet::WebAuthnCredential.new
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Description'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @description = v
+        when 'RegisterTime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @register_time = v
+        when 'IsLegacyU2F'
+          @is_legacy_u2f = v
+        when 'ID'
+          @id = Base64.decode64(v)
+        when 'Credential'
+          @credential = Comet::WebAuthnCredential.new
+          @credential.from_hash(v)
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Description'] = @description
+      ret['RegisterTime'] = @register_time
+      unless @is_legacy_u2f.nil?
+        ret['IsLegacyU2F'] = @is_legacy_u2f
+      end
+      unless @id.nil?
+        ret['ID'] = @id
+      end
+      unless @credential.nil?
+        ret['Credential'] = @credential
+      end
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/allowed_admin_user.rb

@@ -0,0 +1,212 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # AllowedAdminUser is a typed class wrapper around the underlying Comet Server API data structure.
+  class AllowedAdminUser
+
+    # @type [String] username
+    attr_accessor :username
+
+    # @type [String] organization_id
+    attr_accessor :organization_id
+
+    # @type [String] external_authentication_source
+    attr_accessor :external_authentication_source
+
+    # @type [Number] password_format
+    attr_accessor :password_format
+
+    # @type [String] password
+    attr_accessor :password
+
+    # @type [Boolean] allow_password_login
+    attr_accessor :allow_password_login
+
+    # @type [Boolean] allow_password_and_totplogin
+    attr_accessor :allow_password_and_totplogin
+
+    # @type [Boolean] allow_password_and_u2flogin
+    attr_accessor :allow_password_and_u2flogin
+
+    # @type [Boolean] allow_password_and_web_authn_login
+    attr_accessor :allow_password_and_web_authn_login
+
+    # @type [Array<Comet::AdminU2FRegistration>] u2fregistrations
+    attr_accessor :u2fregistrations
+
+    # @type [Array<Comet::AdminWebAuthnRegistration>] web_authn_registrations
+    attr_accessor :web_authn_registrations
+
+    # @type [Number] totpkey_encryption_format
+    attr_accessor :totpkey_encryption_format
+
+    # @type [String] totpkey
+    attr_accessor :totpkey
+
+    # @type [String] ipwhitelist
+    attr_accessor :ipwhitelist
+
+    # @type [Comet::AdminUserPermissions] permissions
+    attr_accessor :permissions
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @username = ''
+      @organization_id = ''
+      @external_authentication_source = ''
+      @password_format = 0
+      @password = ''
+      @u2fregistrations = []
+      @web_authn_registrations = []
+      @totpkey_encryption_format = 0
+      @totpkey = ''
+      @ipwhitelist = ''
+      @permissions = Comet::AdminUserPermissions.new
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Username'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @username = v
+        when 'OrganizationID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @organization_id = v
+        when 'ExternalAuthenticationSource'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @external_authentication_source = v
+        when 'PasswordFormat'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @password_format = v
+        when 'Password'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @password = v
+        when 'AllowPasswordLogin'
+          @allow_password_login = v
+        when 'AllowPasswordAndTOTPLogin'
+          @allow_password_and_totplogin = v
+        when 'AllowPasswordAndU2FLogin'
+          @allow_password_and_u2flogin = v
+        when 'AllowPasswordAndWebAuthnLogin'
+          @allow_password_and_web_authn_login = v
+        when 'U2FRegistrations'
+          if v.nil?
+            @u2fregistrations = []
+          else
+            @u2fregistrations = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @u2fregistrations[i1] = Comet::AdminU2FRegistration.new
+              @u2fregistrations[i1].from_hash(v1)
+            end
+          end
+        when 'WebAuthnRegistrations'
+          if v.nil?
+            @web_authn_registrations = []
+          else
+            @web_authn_registrations = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @web_authn_registrations[i1] = Comet::AdminWebAuthnRegistration.new
+              @web_authn_registrations[i1].from_hash(v1)
+            end
+          end
+        when 'TOTPKeyEncryptionFormat'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @totpkey_encryption_format = v
+        when 'TOTPKey'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @totpkey = v
+        when 'IPWhitelist'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @ipwhitelist = v
+        when 'Permissions'
+          @permissions = Comet::AdminUserPermissions.new
+          @permissions.from_hash(v)
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Username'] = @username
+      ret['OrganizationID'] = @organization_id
+      unless @external_authentication_source.nil?
+        ret['ExternalAuthenticationSource'] = @external_authentication_source
+      end
+      ret['PasswordFormat'] = @password_format
+      ret['Password'] = @password
+      ret['AllowPasswordLogin'] = @allow_password_login
+      ret['AllowPasswordAndTOTPLogin'] = @allow_password_and_totplogin
+      ret['AllowPasswordAndU2FLogin'] = @allow_password_and_u2flogin
+      ret['AllowPasswordAndWebAuthnLogin'] = @allow_password_and_web_authn_login
+      unless @u2fregistrations.nil?
+        ret['U2FRegistrations'] = @u2fregistrations
+      end
+      unless @web_authn_registrations.nil?
+        ret['WebAuthnRegistrations'] = @web_authn_registrations
+      end
+      unless @totpkey_encryption_format.nil?
+        ret['TOTPKeyEncryptionFormat'] = @totpkey_encryption_format
+      end
+      unless @totpkey.nil?
+        ret['TOTPKey'] = @totpkey
+      end
+      unless @ipwhitelist.nil?
+        ret['IPWhitelist'] = @ipwhitelist
+      end
+      ret['Permissions'] = @permissions
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/browse_office_365list_virtual_accounts_response.rb

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # BrowseOffice365ListVirtualAccountsResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class BrowseOffice365ListVirtualAccountsResponse
+
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [Array<Comet::Office365MixedVirtualAccount>] objects
+    attr_accessor :objects
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @status = 0
+      @message = ''
+      @objects = []
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Status'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @status = v
+        when 'Message'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @message = v
+        when 'Objects'
+          if v.nil?
+            @objects = []
+          else
+            @objects = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @objects[i1] = Comet::Office365MixedVirtualAccount.new
+              @objects[i1].from_hash(v1)
+            end
+          end
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Status'] = @status
+      ret['Message'] = @message
+      ret['Objects'] = @objects
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end