chef-licensing 0.4.44 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daba1b4af5298de677c11ea6bdfa10fe560e94f3dc26ba60e68f887be5d3d187
-  data.tar.gz: c45e92d1bba749e0aff95328df2b35bcba959022584cc07ad2e475f8a89be945
+  metadata.gz: 1bc6490da547bbded96f9eae129f488d1be7178feae66dc02dad8acba71fff0b
+  data.tar.gz: 16f191bd6102f08be159bb73c88f1e992657e829248b54ecdd0c5743982f65d2
 SHA512:
-  metadata.gz: c0ff4a1cf85a1155badc2f18f1e31be42745c8952c495b87ab9af8067d13a3b2568e009c6a9bb0b1abf7812317994cf38d388c0220673e0a2027b590dbab26a8
-  data.tar.gz: bf7296fdb8806695442b1b19d9968853984def094d126134e03774ec9bfed481cf8a66306848743a8b2c970f35b05dc6708583fe01a8222907435ce96da96ec2
+  metadata.gz: 873ad985ccfc6cf42478d5e0deceb001d85f6ed74d6b62b0bb9355db66da9ad7f707f5a3d1f2aa2cece612f688321757d8c406c331c8e8ab543d1c12fbe4b794
+  data.tar.gz: 155632f6ced920a84a6700c58bad75534e34c85fbf10b4f262b5cea030fecb291de9e429e41b4108b17e97e6f3ba744bc8cefbb1b15729a43bf89e75a0e8656f

data/chef-licensing.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.version       = ChefLicensing::VERSION
   spec.authors       = ["Inspec Team"]
   spec.email         = ["inspec@progress.com"]
-  spec.license       = "LicenseRef-LICENSE"
+  spec.license       = "Apache-2.0"
 
   spec.summary       = %q{Chef License storage, generation, and entitlement}
   spec.description   = %q{Ruby library to support CLI tools that use Progress Chef license storage, generation, and entitlement.}
@@ -30,6 +30,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "tty-prompt", "~> 0.23"
   spec.add_dependency "faraday", ">= 1", "< 3"
   spec.add_dependency "faraday-http-cache"
-  spec.add_dependency "activesupport", "~> 7.0", ">= 7.0.4.2"
+  # Note: 7.1.0 does not defaults its cache_format_version to 7.1 but 6.1 instead which gives deprecation warnings
+  # Remove the version constraint when we can upgrade to 7.1.1 post stable release of Activesupport 7.1
+  # Similar issue with 7.0 existed: https://github.com/rails/rails/pull/45293
+  spec.add_dependency "activesupport", "~> 7.0", "< 7.1"
   spec.add_dependency "tty-spinner", "~> 0.9.3"
 end

data/lib/chef-licensing/exceptions/invalid_file_format_version.rb

@@ -0,0 +1,10 @@
+require_relative "error"
+
+module ChefLicensing
+  class InvalidFileFormatVersion < Error
+    def message
+      super || "Invalid File Format Version"
+    end
+  end
+end
+

data/lib/chef-licensing/exceptions/license_file_corrupted.rb

@@ -0,0 +1,9 @@
+require_relative "error"
+
+module ChefLicensing
+  class LicenseFileCorrupted < Error
+    def message
+      super || "License file contents are corrupted"
+    end
+  end
+end

data/lib/chef-licensing/license_key_fetcher/chef_licensing_interactions.yaml

@@ -7,13 +7,13 @@ interactions:
         License ID Validation
 
         To continue using Chef <%= input[:chef_product_name] %>, a license ID is required.
-        (Free, Trial, or Commercial)
+        (Free Tier, Trial, or Commercial)
 
         If you generated a license previously, you might
         have received it in an email.
 
         If you are a commercial user, you can also find it in the
-        <%= input[:pastel].underline.green("supportlink.chef.io")%> portal.
+        <%= input[:pastel].underline.green("https://community.progress.com/s/products/chef")%> portal.
       ------------------------------------------------------------
     prompt_type: "say"
     paths: [ask_if_user_has_license_id]
@@ -46,7 +46,7 @@ interactions:
     paths: [add_license_info_in_restriction_flow]
 
   free_license_already_exist_message:
-    messages: "A Free License already exists with following details: \n"
+    messages: "A Free Tier License already exists with following details: \n"
     prompt_type: "say"
     paths: [add_license_info_in_restriction_flow]
 
@@ -70,7 +70,7 @@ interactions:
   trial_restriction_message:
     prompt_type: "say"
     messages:
-      Please generate a Free or Commercial License by running <%= input[:pastel].bold("#{ChefLicensing::Config.chef_executable_name} license add")%>.
+      Please generate a Free Tier or Commercial License by running <%= input[:pastel].bold("#{ChefLicensing::Config.chef_executable_name} license add")%>.
     paths: [exit_with_message]
 
   free_restriction_message:
@@ -92,7 +92,7 @@ interactions:
 
         Get a Commercial License to receive bug fixes, updates
         and new features.
-        Get a Free License to scan limited <%= input[:unit_measure] %>.
+        Get a Free Tier License to scan limited <%= input[:unit_measure] %>.
 
         To get a new license, run <%= input[:pastel].bold("#{ChefLicensing::Config.chef_executable_name} license add")%>
         and select a license type.
@@ -107,7 +107,7 @@ interactions:
 
         Get a Commercial License to receive bug fixes, updates
         and new features.
-        Get a Free License to scan limited <%= input[:unit_measure] %>.
+        Get a Free Tier License to scan limited <%= input[:unit_measure] %>.
       ------------------------------------------------------------
     prompt_type: "say"
     paths: [fetch_license_id]
@@ -257,14 +257,14 @@ interactions:
     prompt_type: "select"
     messages: ["Select the type of license below and then enter user details\n" ,
       [
-      "1. Free License\n     Validity: Unlimited\n     No. of units: 10 <%= input[:unit_measure] %>\n",
+      "1. Free Tier License\n     Validity: Unlimited\n     No. of units: 10 <%= input[:unit_measure] %>\n",
       "2. Commercial License\n",
       "3. Quit license generation"
       ]]
-    paths: [free_license_disclaimer, commercial_license_selection, exit]
+    paths: [free_trial_license_selection, commercial_license_selection, exit]
     response_path_map:
-      "1. Free License\n     Validity: Unlimited\n     No. of units: 10 nodes\n": free_license_disclaimer
-      "1. Free License\n     Validity: Unlimited\n     No. of units: 10 targets\n": free_license_disclaimer
+      "1. Free Tier License\n     Validity: Unlimited\n     No. of units: 10 nodes\n": free_trial_license_selection
+      "1. Free Tier License\n     Validity: Unlimited\n     No. of units: 10 targets\n": free_trial_license_selection
       "2. Commercial License\n": commercial_license_selection
       "3. Quit license generation": exit
 
@@ -276,10 +276,10 @@ interactions:
       "2. Commercial License\n",
       "3. Quit license generation"
       ]]
-    paths: [trial_license_selection, commercial_license_selection, exit]
+    paths: [free_trial_license_selection, commercial_license_selection, exit]
     response_path_map:
-      "1. Trial License\n     Validity: 30 Days\n     No. of units: Unlimited nodes\n": trial_license_selection
-      "1. Trial License\n     Validity: 30 Days\n     No. of units: Unlimited targets\n": trial_license_selection
+      "1. Trial License\n     Validity: 30 Days\n     No. of units: Unlimited nodes\n": free_trial_license_selection
+      "1. Trial License\n     Validity: 30 Days\n     No. of units: Unlimited targets\n": free_trial_license_selection
       "2. Commercial License\n": commercial_license_selection
       "3. Quit license generation": exit
 
@@ -287,34 +287,41 @@ interactions:
     prompt_type: "select"
     messages: ["Select the type of license below and then enter user details\n" ,
       [
-      "1. Free License\n     Validity: Unlimited\n     No. of units: 10 <%= input[:unit_measure] %>\n",
+      "1. Free Tier License\n     Validity: Unlimited\n     No. of units: 10 <%= input[:unit_measure] %>\n",
       "2. Trial License\n     Validity: 30 Days\n     No. of units: Unlimited <%= input[:unit_measure] %>\n",
       "3. Commercial License\n",
       "4. Quit license generation"
       ]]
-    paths: [free_license_disclaimer, commercial_license_selection, trial_license_selection, exit]
+    paths: [free_trial_license_selection, commercial_license_selection, exit]
     response_path_map:
-      "1. Free License\n     Validity: Unlimited\n     No. of units: 10 nodes\n": free_license_disclaimer
-      "1. Free License\n     Validity: Unlimited\n     No. of units: 10 targets\n": free_license_disclaimer
-      "2. Trial License\n     Validity: 30 Days\n     No. of units: Unlimited nodes\n": trial_license_selection
-      "2. Trial License\n     Validity: 30 Days\n     No. of units: Unlimited targets\n": trial_license_selection
+      "1. Free Tier License\n     Validity: Unlimited\n     No. of units: 10 nodes\n": free_trial_license_selection
+      "1. Free Tier License\n     Validity: Unlimited\n     No. of units: 10 targets\n": free_trial_license_selection
+      "2. Trial License\n     Validity: 30 Days\n     No. of units: Unlimited nodes\n": free_trial_license_selection
+      "2. Trial License\n     Validity: 30 Days\n     No. of units: Unlimited targets\n": free_trial_license_selection
       "3. Commercial License\n": commercial_license_selection
       "4. Quit license generation": exit
 
-  free_license_disclaimer:
-    messages: '<%= input[:pastel].bold("A Free License can be used for personal, non-commercial use only.\n")%>'
-    prompt_type: "warn"
-    paths: [free_license_selection]
-
-  free_license_selection:
-    messages: "Type: Free License\n  Validity: Unlimited\n  No. of units: 10 <%= input[:unit_measure] %>\n"
-    prompt_type: "silent"
-    paths: [check_if_user_details_are_present]
+  # Note: The below link is specific to InSpec; as per PO there will be different link for other products.
+  #       We need to update the link for other products once we have the link or update to a common link.
+  free_trial_license_selection:
+    messages: ["<%= input[:pastel].yellow(\"!\") %> Kindly complete the user registration at <%= input[:pastel].blue.underline.blue(\"https://www.chef.io/license-generation-free-trial\") %>\nOnce you submit the details, you will receive the license ID on the email id you provided.\n\nSelect an option",
+      [
+      Validate license now,
+      Quit and validate license later
+      ]
+    ]
+    prompt_type: "select"
+    paths: [validate_license_later_message, ask_for_license_id]
+    response_path_map:
+      "Validate license now": ask_for_license_id
+      "Quit and validate license later": validate_license_later_message
 
-  trial_license_selection:
-    messages: "Type: Trial License\n  Validity: 30 days\n  No. of units: Unlimited <%= input[:unit_measure] %>\n"
-    prompt_type: "silent"
-    paths: [check_if_user_details_are_present]
+  # TODO: Update the link for other ways to validate the license document.
+  validate_license_later_message:
+    messages: |
+      You can enter the license later on by selecting <%= input[:pastel].bold("'I already have a license ID'") %> when prompted for license.
+      To learn about more ways to enter the license, kindly visit <%= input[:pastel].blue.underline.blue("www.docs.chef.io") %>.
+    paths: [exit]
 
   commercial_license_selection:
     messages: ["Get in touch with the Sales Team by filling out the form available at <%= input[:pastel].blue.underline.blue(\"https://www.chef.io/contact-us\") %>\n",
@@ -323,213 +330,10 @@ interactions:
     prompt_type: "select"
     paths: [exit_with_message]
 
-  check_if_user_details_are_present:
-    action: are_user_details_present?
-    paths: [ask_for_user_details, print_to_review_details]
-    response_path_map:
-      "true": "print_to_review_details"
-      "false": "ask_for_user_details"
-
-  ask_for_user_details:
-    messages: |
-      Please enter the following details:
-      First Name, Last Name, Email, Company, Phone
-
-    paths: [gather_user_first_name_for_license_generation]
-
-  gather_user_first_name_for_license_generation:
-    messages: "Enter First Name: "
-    prompt_type: "ask"
-    paths: [validate_user_first_name_for_license_generation]
-
-  validate_user_first_name_for_license_generation:
-    action: is_user_name_valid?
-    paths: [gather_user_last_name_for_license_generation, user_first_name_validation_failure]
-    response_path_map:
-      "true": gather_user_last_name_for_license_generation
-      "false": user_first_name_validation_failure
-
-  user_first_name_validation_failure:
-    messages: "Invalid name. It should contain only A-Z/a-z alphabets."
-    prompt_type: "error"
-    paths: [gather_user_first_name_for_license_generation]
-
-  gather_user_last_name_for_license_generation:
-    messages: "Enter Last Name: "
-    prompt_type: "ask"
-    paths: [validate_user_last_name_for_license_generation]
-
-  validate_user_last_name_for_license_generation:
-    action: is_user_name_valid?
-    paths: [gather_user_email_for_license_generation, user_last_name_validation_failure]
-    response_path_map:
-      "true": gather_user_email_for_license_generation
-      "false": user_last_name_validation_failure
-
-  user_last_name_validation_failure:
-    messages: "Invalid name. It should contain only A-Z/a-z alphabets."
-    prompt_type: "error"
-    paths: [gather_user_last_name_for_license_generation]
-
-  gather_user_email_for_license_generation:
-    messages: "Enter Email Address: "
-    prompt_type: "ask"
-    paths: [validate_user_email_for_license_generation]
-
-  validate_user_email_for_license_generation:
-    action: is_email_valid?
-    paths: [gather_user_company_for_license_generation, user_email_validation_failure]
-    response_path_map:
-      "true": gather_user_company_for_license_generation
-      "false": user_email_validation_failure
-
-  user_email_validation_failure:
-    messages: "Invalid email address."
-    prompt_type: "error"
-    paths: [gather_user_email_for_license_generation]
-
-  gather_user_company_for_license_generation:
-    messages: "Enter Company Name: "
-    prompt_type: "ask"
-    paths: [validate_user_company_name_for_license_generation]
-
-  validate_user_company_name_for_license_generation:
-    action: is_company_name_valid?
-    paths: [gather_user_phone_no_for_license_generation, user_company_name_validation_failure]
-    response_path_map:
-      "true": gather_user_phone_no_for_license_generation
-      "false": user_company_name_validation_failure
-
-  user_company_name_validation_failure:
-    messages: "Invalid company name. It should contain only A-Z/a-z alphabets, numbers or special characters."
-    prompt_type: "error"
-    paths: [gather_user_company_for_license_generation]
-
-  gather_user_phone_no_for_license_generation:
-    messages: "Enter phone number: "
-    prompt_type: "ask"
-    paths: [validate_user_phone_no]
-
-  validate_user_phone_no:
-    action: is_phone_no_valid?
-    paths: [print_to_review_details, user_phone_no_validation_failure]
-    response_path_map:
-      "true": print_to_review_details
-      "false": user_phone_no_validation_failure
-
-  user_phone_no_validation_failure:
-    messages: "Please enter a valid phone number."
-    prompt_type: "error"
-    paths: [gather_user_phone_no_for_license_generation]
-
-  print_to_review_details:
-    messages: |
-      ------------------------------------------------------------
-      Review the details below and confirm to proceed.
-      ------------------------------------------------------------
-      License Details
-
-        <%= input[:free_license_selection] || input[:trial_license_selection] %>
-      User Details
-
-        First Name: <%= input[:gather_user_first_name_for_license_generation] %>
-        Last Name: <%= input[:gather_user_last_name_for_license_generation] %>
-        Email: <%= input[:gather_user_email_for_license_generation] %>
-        Company: <%= input[:gather_user_company_for_license_generation] %>
-        Phone number: <%= input[:gather_user_phone_no_for_license_generation] %>
-      ------------------------------------------------------------
-    prompt_type: "say"
-    paths: [ask_for_review_confirmation]
-
-  ask_for_review_confirmation:
-    prompt_type: "select"
-    messages: ["Please select", ["Confirm the details and proceed", "Reselect the license type", "Edit user details", "Quit the license generation process"]]
-    paths: [pre_license_generation, clear_current_license_type_selection, ask_for_user_details, exit]
-    response_path_map:
-      "Confirm the details and proceed": pre_license_generation
-      "Reselect the license type": clear_current_license_type_selection
-      "Edit user details": ask_for_user_details
-      "Quit the license generation process": exit
-
-  clear_current_license_type_selection:
-    action: clear_license_type_selection
-    paths: [info_of_license_types]
-
-  pre_license_generation:
-    action: select_license_generation_based_on_type
-    paths: [generate_free_license, generate_trial_license]
-    response_path_map:
-      "free": generate_free_license
-      "trial": generate_trial_license
-
-  generate_free_license:
-    action: generate_free_license
-    paths: [free_license_generation_success, license_generation_failure]
-    response_path_map:
-      "true": free_license_generation_success
-      "false": license_generation_failure
-
-  generate_trial_license:
-    action: generate_trial_license
-    paths: [trial_license_generation_success, license_generation_failure]
-    response_path_map:
-      "true": trial_license_generation_success
-      "false": license_generation_failure
-
-  free_license_generation_success:
-    messages: |
-      <%= input[:pastel].green("✔ [Success] License generated successfully") %>
-
-      The license ID has been sent to <%= input[:gather_user_email_for_license_generation] %>.
-    paths: [ask_for_license_id]
-
-  trial_license_generation_success:
-    messages: |
-      <%= input[:pastel].green("✔ [Success] License generated successfully") %>
-
-      The license ID has been sent to <%= input[:gather_user_email_for_license_generation] %>.
-    paths: [ask_for_license_id]
-
   fetch_license_id:
     action: fetch_license_id
     paths: [exit]
 
-  license_generation_failure:
-    messages: "✖ [Error] License generation failed."
-    prompt_type: "error"
-    paths: [check_failure_reason]
-
-  check_failure_reason:
-    action: license_generation_rejected?
-    paths: [fetch_license_failure_error_msg, fetch_license_failure_rejection_msg]
-    response_path_map:
-      "true": fetch_license_failure_rejection_msg
-      "false": fetch_license_failure_error_msg
-
-  fetch_license_failure_error_msg:
-    action: fetch_license_failure_error_msg
-    paths: [license_generation_with_errors]
-
-  fetch_license_failure_rejection_msg:
-    action: fetch_license_failure_rejection_msg
-    paths: [license_generation_rejected]
-
-  license_generation_rejected:
-    messages: ["Your request for a license was denied for the following reason: <%= input[:fetch_license_failure_rejection_msg] %>. Please select one of the following options:", ["Try again", "Skip"]]
-    prompt_type: "select"
-    paths: [pre_license_generation, skip_message]
-    response_path_map:
-      "Try again": pre_license_generation
-      "Skip": skip_message
-
-  license_generation_with_errors:
-    messages: ["\nAn error occurred while generating your license.\nError message: <%= input[:fetch_license_failure_error_msg] %>\n", ["Try again", "Skip"]]
-    prompt_type: "select"
-    paths: [pre_license_generation, skip_message]
-    response_path_map:
-      "Try again": pre_license_generation
-      "Skip": skip_message
-
   exit:
     messages: ""
 

data/lib/chef-licensing/license_key_fetcher/file.rb

@@ -5,6 +5,10 @@ require "date"
 require "fileutils" unless defined?(FileUtils)
 require_relative "../license_key_fetcher"
 require_relative "../config"
+require_relative "../exceptions/license_file_corrupted"
+require_relative "license_file/v4"
+require_relative "license_file/v3"
+require_relative "../exceptions/invalid_file_format_version"
 
 module ChefLicensing
   class LicenseKeyFetcher
@@ -118,15 +122,15 @@ module ChefLicensing
 
         @contents = load_license_file(license_key_file_path)
 
+        # Two possible cases:
+        # 1. If contents is nil, load basic license data with the latest structure.
+        # 2. If contents is not nil, but the license server URL in contents is different from the system's,
+        #    update the license server URL in contents and licenses.yaml file.
         if @contents.nil?
-          @contents = {
-            file_format_version: LICENSE_FILE_FORMAT_VERSION,
-            license_server_url: license_server_url_from_system || license_server_url_from_config,
-          }
-        else
-          if license_server_url_from_system && license_server_url_from_system != @contents[:license_server_url]
-            @contents[:license_server_url] = license_server_url_from_system
-          end
+          url = license_server_url_from_system || license_server_url_from_config
+          load_basic_license_data_to_contents(url, [])
+        elsif @contents && license_server_url_from_system && license_server_url_from_system != @contents[:license_server_url]
+          @contents[:license_server_url] = license_server_url_from_system
         end
 
         # Ensure the license server URL is returned to the caller in all cases
@@ -207,11 +211,27 @@ module ChefLicensing
 
         # only checking for major version for file format for breaking changes
         @contents ||= YAML.load(::File.read(path))
+
+        # raise error if the file_format_version key is missing
+        raise LicenseFileCorrupted.new("Unrecognized license file; :file_format_version missing.") unless @contents.key?(:file_format_version)
+
+        # Three possible cases after loading the license file contents:
+        # 1. If the file format version is the same as the current version (latest), verify the structure and return the contents.
+        # 2. If the file format version is different but supported, migrate the contents to the current version and return them.
+        # 3. If the file format version is different and not supported, raise an error.
         if major_version(@contents[:file_format_version]) == major_version(LICENSE_FILE_FORMAT_VERSION)
+          current_version_class_name = get_license_file_class(LICENSE_FILE_FORMAT_VERSION)
+          # we ignore any additional keys in the license file during verification
+          raise LicenseFileCorrupted.new("Invalid data found in the license file.") unless current_version_class_name.send(:verify_structure, @contents)
+
+          @contents
+        elsif license_file_class_exists?(@contents[:file_format_version])
+          @contents = migrate_license_file_content_to_current_version(@contents)
+          write_license_file(path) # update the license file contents to the latest version
           @contents
         else
           logger.debug "License File version #{@contents[:file_format_version]} not supported."
-          raise LicenseKeyNotFetchedError.new("License File version #{@contents[:file_format_version]} not supported.")
+          raise ChefLicensing::InvalidFileFormatVersion.new("Unable to read licenses. License File version #{@contents[:file_format_version]} not supported.")
         end
       end
 
@@ -244,11 +264,7 @@ module ChefLicensing
 
         logger.debug "Loading license data to contents"
         if @contents.nil? || @contents.empty? # this case is likely to happen only during testing
-          @contents = {
-            file_format_version: LICENSE_FILE_FORMAT_VERSION,
-            license_server_url: @license_server_url,
-            licenses: [license_data],
-          }
+          load_basic_license_data_to_contents(@license_server_url, [license_data])
         elsif @contents[:licenses].nil?
           @contents[:licenses] = [license_data]
         elsif fetch_license_keys(@contents[:licenses])&.include?(license_data[:license_key])
@@ -270,6 +286,38 @@ module ChefLicensing
         logger.debug "#{e.backtrace.join("\n\t")}"
         e
       end
+
+      # Returns the license file class for the given version.
+      def get_license_file_class(version)
+        Object.const_get("ChefLicensing::LicenseFile::V#{major_version(version)}")
+      end
+
+      # Returns true if the license file class for the given version exists.
+      def license_file_class_exists?(version)
+        Object.const_defined?("ChefLicensing::LicenseFile::V#{major_version(version)}")
+      end
+
+      # Loads the basic license data to contents in the current version's structure.
+      def load_basic_license_data_to_contents(url, license_data = [])
+        current_version_class_name = get_license_file_class(LICENSE_FILE_FORMAT_VERSION)
+        @contents = current_version_class_name.send(:load_primary_structure)
+        @contents[:file_format_version] = LICENSE_FILE_FORMAT_VERSION
+        @contents[:license_server_url] = url || ""
+        @contents[:licenses] = license_data
+      end
+
+      # Migrates the license file content to the current version and returns the migrated contents.
+      def migrate_license_file_content_to_current_version(contents)
+        logger.warn "License File version #{contents[:file_format_version]} is deprecated."
+        logger.warn "Automatically migrating license file to version #{LICENSE_FILE_FORMAT_VERSION}."
+        given_version_class_name = get_license_file_class(contents[:file_format_version])
+        # we ignore any additional keys in the license file during verification
+        raise LicenseFileCorrupted.new("Invalid data found in the license file.") unless given_version_class_name.send(:verify_structure, contents)
+
+        current_version_class_name = get_license_file_class(LICENSE_FILE_FORMAT_VERSION)
+        contents = current_version_class_name.send(:migrate_structure, contents, major_version(contents[:file_format_version]))
+        contents
+      end
     end
   end
 end

data/lib/chef-licensing/license_key_fetcher/license_file/base.rb

@@ -0,0 +1,63 @@
+module ChefLicensing
+  module LicenseFile
+    class Base
+      EXPECTED_STRUCTURE = {
+        file_format_version: "0.0.0",
+        licenses: [
+          {
+            license_key: String,
+            license_type: Symbol,
+            update_time: String,
+          },
+        ],
+      }.freeze
+
+      # @param [Hash] data: The data to verify
+      # @param [Hash] expected_structure: The structure to verify against
+      # @return [Boolean] true if the data matches the expected structure, false otherwise
+      # @note This method ignores extra keys in the data that are not in the expected structure
+      def self.verify_structure(data, expected_structure = self::EXPECTED_STRUCTURE)
+        return false unless data.is_a?(Hash)
+
+        expected_structure.each do |key, value|
+          return false unless data.key?(key)
+
+          if value.is_a?(Hash)
+            return false unless verify_structure(data[key], value)
+          elsif value.is_a?(Array)
+            return false unless data[key].is_a?(Array)
+
+            data[key].each do |item|
+              return false unless verify_structure(item, value[0])
+            end
+          elsif value.is_a?(Class)
+            return false unless data[key].is_a?(value)
+          else
+            return false unless data[key] == value
+          end
+        end
+
+        true
+      end
+
+      # @return [Hash] The primary structure of the license file, without nested structures
+      def self.load_primary_structure
+        expected_structure_dup = self::EXPECTED_STRUCTURE.dup
+        expected_structure_dup[:licenses] = []
+        expected_structure_dup
+      end
+
+      # @return [Hash] The complete structure of the license file, including nested structures
+      def self.load_structure
+        self::EXPECTED_STRUCTURE
+      end
+
+      # @param [Hash] contents: The contents of the license file
+      # @param [Integer] version: The version of the license file
+      # @return [Hash] The contents of the license file after migration
+      def self.migrate_structure(contents, version)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+    end
+  end
+end

data/lib/chef-licensing/license_key_fetcher/license_file/v3.rb

@@ -0,0 +1,12 @@
+require_relative "base"
+
+module ChefLicensing
+  module LicenseFile
+    class V3 < Base
+      LICENSE_FILE_FORMAT_VERSION = "3.0.0".freeze
+      EXPECTED_STRUCTURE = EXPECTED_STRUCTURE.merge({
+        file_format_version: V3::LICENSE_FILE_FORMAT_VERSION,
+      }).freeze
+    end
+  end
+end

data/lib/chef-licensing/license_key_fetcher/license_file/v4.rb

@@ -0,0 +1,27 @@
+require_relative "base"
+require_relative "../../config"
+
+module ChefLicensing
+  module LicenseFile
+    class V4 < Base
+      LICENSE_FILE_FORMAT_VERSION = "4.0.0".freeze
+
+      EXPECTED_STRUCTURE = EXPECTED_STRUCTURE.merge({
+        file_format_version: V4::LICENSE_FILE_FORMAT_VERSION,
+        license_server_url: String,
+      }).freeze
+
+      # @param [Hash] contents: The contents of the license file
+      # @param [Integer] version: The version of the license file
+      # @return [Hash] The contents of the license file after migration
+      def self.migrate_structure(contents, version)
+        # Backwards compatibility for version 3 license files
+        if version == 3
+          contents[:license_server_url] = ChefLicensing::Config.license_server_url || ""
+          contents[:file_format_version] = V4::LICENSE_FILE_FORMAT_VERSION
+        end
+        contents
+      end
+    end
+  end
+end

data/lib/chef-licensing/license_key_fetcher.rb

@@ -71,7 +71,9 @@ module ChefLicensing
 
       unless @license_keys.empty?
         # Licenses expiration check
-        if licenses_active?
+        # Client API possible errors will be handled in software entitlement check call (made after this)
+        # client_api_call_error is set to true when there is an error in licenses_active? call
+        if licenses_active? || client_api_call_error
           return @license_keys
         else
           # Prompts if the keys are expired or expiring
@@ -116,6 +118,7 @@ module ChefLicensing
       # Return keys if license keys are active and not expired or expiring
       # Return keys if there is any error in /client API call, and do not block the flow.
       # Client API possible errors will be handled in software entitlement check call (made after this)
+      # client_api_call_error is set to true when there is an error in licenses_active? call
       return @license_keys if (!@license_keys.empty? && licenses_active?) || client_api_call_error
 
       # Lowest priority is to interactively prompt if we have a TTY
@@ -283,7 +286,7 @@ module ChefLicensing
     def prompt_license_addition_restricted(license_type, existing_license_keys_in_file)
       logger.debug "License Key fetcher - prompting license addition restriction"
       # For trial license
-      # TODO for free license
+      # TODO for Free Tier License
       config[:start_interaction] = :prompt_license_addition_restriction
       prompt_fetcher.config = config
       # Existing license keys are needed to show details of existing license of license type which is restricted.
@@ -294,7 +297,7 @@ module ChefLicensing
     def unrestricted_license_added?(new_keys, license_type)
       if license_restricted?(license_type)
         # Existing license keys of same license type are fetched to compare if old license key or a new one is added.
-        # However, if user is trying to add free license, and user has active trial license, we fetch the trial license key
+        # However, if user is trying to add Free Tier License, and user has active trial license, we fetch the trial license key
         if license_type == :free && file_fetcher.user_has_active_trial_license?
           existing_license_keys_in_file = file_fetcher.fetch_license_keys_based_on_type(:trial)
         else
@@ -313,4 +316,4 @@ module ChefLicensing
       end
     end
   end
-end
+end

data/lib/chef-licensing/list_license_keys.rb

@@ -28,8 +28,11 @@ module ChefLicensing
 
       licenses_metadata.each do |license|
         puts_bold "License Key     : #{license.id}"
+        # Note: The license type is returned as "free" for Free Tier Licenses from the server.
+        # This is capitalized to "Free Tier" for display purposes as recommended by the product team.
+        license_type = license.license_type == "free" ? "Free Tier" : license.license_type.capitalize
         output.puts <<~LICENSE
-          Type            : #{license.license_type}
+          Type            : #{license_type}
           Status          : #{license.status}
           Expiration Date : #{license.expiration_date}
 
@@ -57,7 +60,10 @@ module ChefLicensing
     def display_overview
       output.puts "------------------------------------------------------------"
       licenses_metadata.each do |license|
-        # Sets the validity text for a free license as "Unlimited" and displays the number of days for others.
+        # Note: The license type is returned as "free" for Free Tier Licenses from the server.
+        # This is capitalized to "Free Tier" for display purposes as recommended by the product team.
+        license_type = license.license_type == "free" ? "Free Tier" : license.license_type.capitalize
+        # Sets the validity text for a Free Tier License as "Unlimited" and displays the number of days for others.
         validity = if license.license_type == "free"
                      "Unlimited"
                    else
@@ -72,7 +78,7 @@ module ChefLicensing
             #{pastel.bold("License Details")}
               Asset Name       : #{license.limits.first.software}
               License ID       : #{license.id}
-              Type             : #{license.license_type.capitalize}
+              Type             : #{license_type}
               Status           : #{license.status.capitalize}
               Validity         : #{validity}
               No. Of Units     : #{num_of_units} #{unit_measure.capitalize.pluralize(num_of_units)}

data/lib/chef-licensing/restful_client/base.rb

@@ -22,6 +22,7 @@ module ChefLicensing
       }.freeze
 
       CURRENT_ENDPOINT_VERSION = 2
+      REQUEST_LIMIT = 5
 
       def initialize
         raise MissingAPICredentialsError, "Missing credential in config: Set in block chef_license_server or use environment variable CHEF_LICENSE_SERVER or pass through argument --chef-license-server" if ChefLicensing::Config.license_server_url.nil?
@@ -33,14 +34,6 @@ module ChefLicensing
         invoke_get_api(self.class::END_POINTS[:VALIDATE], { licenseId: license, version: CURRENT_ENDPOINT_VERSION })
       end
 
-      def generate_trial_license(payload)
-        invoke_post_api(self.class::END_POINTS[:GENERATE_TRIAL_LICENSE], payload)
-      end
-
-      def generate_free_license(payload)
-        invoke_post_api(self.class::END_POINTS[:GENERATE_FREE_LICENSE], payload)
-      end
-
       def feature_by_name(payload)
         invoke_post_api(self.class::END_POINTS[:FEATURE_BY_NAME], payload)
       end
@@ -75,43 +68,71 @@ module ChefLicensing
 
       # a common method to handle the get API calls
       def invoke_get_api(endpoint, params = {})
-        handle_get_connection do |connection|
-          connection.get(endpoint, params).body
-        end
+        response = invoke_api(ChefLicensing::Config.license_server_url.split(","), endpoint, :get, nil, params)
+        response.body
       end
 
       # a common method to handle the post API calls
       def invoke_post_api(endpoint, payload, headers = {})
-        handle_post_connection do |connection|
-          response = connection.post(endpoint) do |request|
-            request.body = payload.to_json
-            request.headers = headers
+        response = invoke_api(ChefLicensing::Config.license_server_url.split(","), endpoint, :post, payload, nil, headers)
+        raise RestfulClientError, format_error_from(response) unless response.success?
+
+        response.body
+      end
+
+      def invoke_api(urls, endpoint, http_method, payload = nil, params = {}, headers = {})
+        handle_connection = http_method == :get ? method(:handle_get_connection) : method(:handle_post_connection)
+        response = nil
+        attempted_urls = []
+
+        logger.warn "Only the first #{REQUEST_LIMIT} urls will be tried." if urls.size > REQUEST_LIMIT
+        urls.each_with_index do |url, i|
+          url = url.strip
+          attempted_urls << url
+          break if i == REQUEST_LIMIT - 1
+
+          logger.debug "Trying to connect to #{url}"
+          handle_connection.call(url) do |connection|
+            response = connection.send(http_method, endpoint) do |request|
+              request.body = payload.to_json if payload
+              request.params = params if params
+              request.headers = headers if headers
+            end
           end
-          raise RestfulClientError, format_error_from(response) unless response.success?
-
-          response.body
+          # At this point, we have a successful connection
+          # Update the value of license server url in config
+          ChefLicensing::Config.license_server_url = url
+          logger.debug "Connection succeeded to #{url}"
+          break response
+        rescue RestfulClientConnectionError
+          logger.warn "Connection failed to #{url}"
+        rescue URI::InvalidURIError
+          logger.warn "Invalid URI #{url}"
         end
+
+        raise_restful_client_conn_error(attempted_urls) if response.nil?
+        response
       end
 
-      def handle_get_connection
+      def handle_get_connection(url = nil)
         # handle faraday errors
-        yield get_connection
+        yield get_connection(url)
       rescue Faraday::ClientError => e
         logger.debug "Restful Client Error #{e.message}"
         raise RestfulClientError, e.message
       end
 
-      def handle_post_connection
+      def handle_post_connection(url = nil)
         # handle faraday errors
-        yield post_connection
+        yield post_connection(url)
       rescue Faraday::ClientError => e
         logger.debug "Restful Client Error #{e.message}"
         raise RestfulClientError, e.message
       end
 
-      def get_connection
+      def get_connection(url = nil)
         store = ::ActiveSupport::Cache.lookup_store(:file_store, Dir.tmpdir)
-        Faraday.new(url: ChefLicensing::Config.license_server_url) do |config|
+        Faraday.new(url: url) do |config|
           config.request :json
           config.response :json, parser_options: { object_class: OpenStruct }
           config.use Faraday::HttpCache, shared_cache: false, logger: logger, store: store
@@ -120,8 +141,8 @@ module ChefLicensing
         end
       end
 
-      def post_connection
-        Faraday.new(url: ChefLicensing::Config.license_server_url) do |config|
+      def post_connection(url = nil)
+        Faraday.new(url: url) do |config|
           config.request :json
           config.response :json, parser_options: { object_class: OpenStruct }
           config.use Middleware::ExceptionsHandler
@@ -134,6 +155,19 @@ module ChefLicensing
 
         error_details
       end
+
+      def raise_restful_client_conn_error(urls)
+        error_message = <<~EOM
+          Unable to connect to the licensing server. #{ChefLicensing::Config.chef_product_name} requires server communication to operate.
+          The following URL(s) were tried:\n#{
+            urls.each_with_index.map do |url, index|
+              "#{index + 1}. #{url}"
+            end.join("\n")
+          }
+        EOM
+
+        raise RestfulClientConnectionError, error_message
+      end
     end
   end
 end

data/lib/chef-licensing/restful_client/middleware/exceptions_handler.rb

@@ -8,9 +8,7 @@ module Middleware
     def call(env)
       @app.call(env)
     rescue Faraday::ConnectionFailed => e
-      ChefLicensing::Config.logger.debug("Connection failed to #{ChefLicensing::Config.license_server_url} with error: #{e.message}")
-      error_message = "Unable to connect to the licensing server at #{ChefLicensing::Config.license_server_url}.\nPlease check if the server is reachable and try again. #{ChefLicensing::Config.chef_product_name} requires server communication to operate."
-      raise ChefLicensing::RestfulClientConnectionError, error_message
+      raise ChefLicensing::RestfulClientConnectionError, e.message
     end
   end
 end

data/lib/chef-licensing/restful_client/v1.rb

@@ -6,8 +6,6 @@ module ChefLicensing
     class V1 < Base
       END_POINTS = END_POINTS.merge({
         VALIDATE: "v1/validate",
-        GENERATE_TRIAL_LICENSE: "v1/trial",
-        GENERATE_FREE_LICENSE: "v1/free",
         CLIENT: "v1/client",
         DESCRIBE: "v1/desc",
         LIST_LICENSES: "v1/listLicenses",

data/lib/chef-licensing/tui_engine/tui_actions.rb

@@ -1,8 +1,5 @@
 require_relative "../license_key_validator"
-require_relative "../license_key_generator"
 require_relative "../exceptions/invalid_license"
-require_relative "../exceptions/license_generation_failed"
-require_relative "../exceptions/license_generation_rejected"
 require_relative "../license_key_fetcher/base"
 require_relative "../config"
 require_relative "../context"
@@ -48,7 +45,7 @@ module ChefLicensing
         self.license_type = get_license_type
         if license_restricted?(license_type)
           # Existing license keys needs to be fetcher to show details of existing license of license type which is restricted.
-          # However, if user is trying to add free license, and user has active trial license, we fetch the trial license key
+          # However, if user is trying to add Free Tier License, and user has active trial license, we fetch the trial license key
           if license_type == :free && LicenseKeyFetcher::File.user_has_active_trial_license?(@opts)
             existing_license_keys_in_file = LicenseKeyFetcher::File.fetch_license_keys_based_on_type(:trial, @opts)
           else
@@ -74,62 +71,10 @@ module ChefLicensing
         end
       end
 
-      def is_user_name_valid?(input)
-        user_name = input[:gather_user_last_name_for_license_generation] || input[:gather_user_first_name_for_license_generation]
-        (user_name =~ /\A[a-zA-Z]{1,16}\Z/) == 0
-      end
-
-      def is_email_valid?(input)
-        (input[:gather_user_email_for_license_generation] =~ URI::MailTo::EMAIL_REGEXP) == 0
-      end
-
-      def is_company_name_valid?(input)
-        (input[:gather_user_company_for_license_generation] =~ /\A[a-zA-Z0-9][a-zA-Z0-9\W_]{2,15}\z/) == 0
-      end
-
-      def is_phone_no_valid?(input)
-        # No validation
-        # Optional field
-        true
-      end
-
-      def generate_trial_license(input)
-        generate_license(input, :trial)
-      end
-
-      def generate_free_license(input)
-        generate_license(input, :free)
-      end
-
       def fetch_license_id(input)
         license_id
       end
 
-      def fetch_license_failure_error_msg(input)
-        error_msg
-      end
-
-      def fetch_license_failure_rejection_msg(input)
-        rejection_msg
-      end
-
-      def select_license_generation_based_on_type(inputs)
-        if inputs.key? :free_license_selection
-          inputs[:license_type] = :free
-          "free"
-        elsif inputs.key? :trial_license_selection
-          inputs[:license_type] = :trial
-          "trial"
-        else
-          inputs[:license_type] = :commercial
-          "commercial"
-        end
-      end
-
-      def license_generation_rejected?(inputs)
-        !!rejection_msg
-      end
-
       def fetch_invalid_license_msg(input)
         invalid_license_msg
       end
@@ -138,20 +83,6 @@ module ChefLicensing
         ChefLicensing::ListLicenseKeys.display_overview({ license_keys: [license_id] })
       end
 
-      def clear_license_type_selection(inputs)
-        inputs.delete(:free_license_selection)
-        inputs.delete(:trial_license_selection)
-        inputs.delete(:commercial_license_selection)
-      end
-
-      def are_user_details_present?(inputs)
-        inputs.key?(:gather_user_first_name_for_license_generation) &&
-          inputs.key?(:gather_user_last_name_for_license_generation) &&
-          inputs.key?(:gather_user_email_for_license_generation) &&
-          inputs.key?(:gather_user_company_for_license_generation) &&
-          inputs.key?(:gather_user_phone_no_for_license_generation)
-      end
-
       def set_license_info(input)
         self.license_id = input[:license_id]
         self.license_type = input[:license_type]
@@ -191,28 +122,6 @@ module ChefLicensing
 
       attr_accessor :opts
 
-      def generate_license(inputs, license_type)
-        spinner = TTY::Spinner.new(":spinner [Running] License generation in progress...", format: :dots, clear: true, output: output)
-        spinner.auto_spin # Start the spinner
-        self.license_id = ChefLicensing::LicenseKeyGenerator.send("generate_#{license_type}_license!",
-          first_name: inputs[:gather_user_first_name_for_license_generation],
-          last_name: inputs[:gather_user_last_name_for_license_generation],
-          email_id: inputs[:gather_user_email_for_license_generation],
-          product: ChefLicensing::Config.chef_product_name&.capitalize,
-          company: inputs[:gather_user_company_for_license_generation],
-          phone: inputs[:gather_user_phone_no_for_license_generation])
-        spinner.success # Stop the spinner
-        true
-      rescue ChefLicensing::LicenseGenerationFailed => e
-        spinner.error # Stop the spinner
-        self.error_msg = e.message
-        false
-      rescue ChefLicensing::LicenseGenerationRejected => e
-        spinner.error # Stop the spinner
-        self.rejection_msg = e.message
-        false
-      end
-
       def get_license(license_key)
         spinner = TTY::Spinner.new(":spinner [Running] License validation in progress...", format: :dots, clear: true, output: output)
         spinner.auto_spin # Start the spinner

data/lib/chef-licensing/version.rb

@@ -1,3 +1,3 @@
 module ChefLicensing
-  VERSION = "0.4.44".freeze
+  VERSION = "0.7.5".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-licensing
 version: !ruby/object:Gem::Version
-  version: 0.4.44
+  version: 0.7.5
 platform: ruby
 authors:
 - Inspec Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-11 00:00:00.000000000 Z
+date: 2023-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-config
@@ -79,9 +79,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7.0'
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 7.0.4.2
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -89,9 +89,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7.0'
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 7.0.4.2
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +114,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
 - chef-licensing.gemspec
 - lib/chef-licensing.rb
 - lib/chef-licensing/api/client.rb
@@ -134,9 +133,9 @@ files:
 - lib/chef-licensing/exceptions/describe_error.rb
 - lib/chef-licensing/exceptions/error.rb
 - lib/chef-licensing/exceptions/feature_not_entitled.rb
+- lib/chef-licensing/exceptions/invalid_file_format_version.rb
 - lib/chef-licensing/exceptions/invalid_license.rb
-- lib/chef-licensing/exceptions/license_generation_failed.rb
-- lib/chef-licensing/exceptions/license_generation_rejected.rb
+- lib/chef-licensing/exceptions/license_file_corrupted.rb
 - lib/chef-licensing/exceptions/list_licenses_error.rb
 - lib/chef-licensing/exceptions/missing_api_credentials_error.rb
 - lib/chef-licensing/exceptions/restful_client_connection_error.rb
@@ -147,8 +146,10 @@ files:
 - lib/chef-licensing/license_key_fetcher/base.rb
 - lib/chef-licensing/license_key_fetcher/chef_licensing_interactions.yaml
 - lib/chef-licensing/license_key_fetcher/file.rb
+- lib/chef-licensing/license_key_fetcher/license_file/base.rb
+- lib/chef-licensing/license_key_fetcher/license_file/v3.rb
+- lib/chef-licensing/license_key_fetcher/license_file/v4.rb
 - lib/chef-licensing/license_key_fetcher/prompt.rb
-- lib/chef-licensing/license_key_generator.rb
 - lib/chef-licensing/license_key_validator.rb
 - lib/chef-licensing/licensing_service/local.rb
 - lib/chef-licensing/list_license_keys.rb
@@ -165,7 +166,7 @@ files:
 - lib/chef-licensing/version.rb
 homepage: https://github.com/chef/chef-licensing
 licenses:
-- LicenseRef-LICENSE
+- Apache-2.0
 metadata:
   homepage_uri: https://github.com/chef/chef-licensing
   source_code_uri: https://github.com/chef/chef-licensing

data/LICENSE

@@ -1 +0,0 @@
-Proprietary code. All rights reserved.

data/lib/chef-licensing/exceptions/license_generation_failed.rb

@@ -1,9 +0,0 @@
-require_relative "error"
-
-module ChefLicensing
-  class LicenseGenerationFailed < Error
-    def message
-      super || "License Generation Failed"
-    end
-  end
-end

data/lib/chef-licensing/exceptions/license_generation_rejected.rb

@@ -1,7 +0,0 @@
-module ChefLicensing
-  class LicenseGenerationRejected < Error
-    def message
-      super || "License Generation Rejected"
-    end
-  end
-end

data/lib/chef-licensing/license_key_generator.rb

@@ -1,47 +0,0 @@
-require_relative "restful_client/v1"
-require_relative "exceptions/license_generation_failed"
-
-module ChefLicensing
-  class LicenseKeyGenerator
-    attr_reader :payload
-
-    class << self
-      # @param [Hash] KWARGS keys accepted are [first_name, last_name, email_id, product, company, phone]
-      def generate_trial_license!(kwargs)
-        new(kwargs).generate_trial_license!
-      end
-
-      def generate_free_license!(kwargs)
-        new(kwargs).generate_free_license!
-      end
-    end
-
-    def initialize(kwargs, restful_client: ChefLicensing::RestfulClient::V1)
-      # TODO: validate kwargs
-      @payload = build_payload_from(kwargs)
-      @restful_client = restful_client.new
-    end
-
-    def generate_trial_license!
-      response = @restful_client.generate_trial_license(payload)
-      # need some logic around delivery
-      # how the delivery is decided?
-      response.licenseId
-    rescue RestfulClientError => e
-      raise ChefLicensing::LicenseGenerationFailed, e.message
-    end
-
-    def generate_free_license!
-      response = @restful_client.generate_free_license(payload)
-      response.licenseId
-    rescue RestfulClientError => e
-      raise ChefLicensing::LicenseGenerationFailed, e.message
-    end
-
-    private
-
-    def build_payload_from(kwargs)
-      kwargs.slice(:first_name, :last_name, :email_id, :product, :company, :phone)
-    end
-  end
-end