chef-licensing 0.4.43

data/lib/chef-licensing/context.rb

@@ -0,0 +1,98 @@
+# Context defines the interface for state management in chef-licensing
+# Different states : local or global
+
+# Licensing service detection
+require_relative "licensing_service/local"
+
+module ChefLicensing
+  class Context
+
+    attr_accessor :state
+    attr_reader :logger, :options
+
+    class << self
+      attr_writer :current_context
+
+      def local_licensing_service?
+        ChefLicensing::Config.is_local_license_service ||= LicensingService::Local.detected?
+      end
+
+      # Implement methods on current context
+      # Current context changes the state determined using LicensingService module
+
+      # Return license keys from current context
+      def license_keys(options = {})
+        current_context(options).license_keys
+      end
+
+      private
+
+      def current_context(options)
+        return @current_context if @current_context
+
+        @current_context = context_based_on_state(options)
+      end
+
+      def context_based_on_state(options)
+        if local_licensing_service?
+          new(Local.new, options)
+        else
+          new(Global.new, options)
+        end
+      end
+
+    end
+
+    # @param [State] state
+    def initialize(state, options = {})
+      @options = options
+      @logger = ChefLicensing::Config.logger
+      transition_to(state)
+    end
+
+    # The Context allows changing the State object
+    def transition_to(state)
+      logger.debug "Chef Licensing Context: Transition to #{state.class}"
+      @state = state
+      @state.context = self
+      @state.options = options
+    end
+
+    # The Context delegates part of its behavior to the current State object.
+    def license_keys
+      @state.license_keys
+    end
+
+    class State
+      attr_accessor :context, :options
+
+      # @abstract
+      def license_keys
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+    end
+
+    # Implement various behaviors, associated with a state of the Context.
+
+    class Local < State
+      def license_keys
+        @license_keys ||= ChefLicensing::Api::ListLicenses.info || []
+      end
+    end
+
+    class Global < State
+      def license_keys
+        @license_keys ||= fetch_license_keys_from_file || []
+      end
+
+      def fetch_license_keys_from_file
+        file_fetcher = LicenseKeyFetcher::File.new(options)
+        if file_fetcher.persisted?
+          # This could be useful if the file was writable in past but is not writable in current scenario and new keys are not persisted in the file
+          file_fetcher.fetch
+        end
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,9 @@
+require_relative "error"
+
+module ChefLicensing
+  class ClientError < Error
+    def message
+      super || "License Client API failure"
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+require_relative "error"
+
+module ChefLicensing
+  class DescribeError < Error
+    def message
+      super || "License Describe API failure"
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+module ChefLicensing
+  class Error < StandardError
+  end
+end

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

@@ -0,0 +1,9 @@
+require_relative "error"
+
+module ChefLicensing
+  class FeatureNotEntitled < Error
+    def message
+      super || "Feature not entitled"
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+require_relative "error"
+
+module ChefLicensing
+  class InvalidLicense < Error
+    def message
+      super || "Invalid License"
+    end
+  end
+end
+

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

@@ -0,0 +1,9 @@
+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

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

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

@@ -0,0 +1,12 @@
+require_relative "error"
+
+module ChefLicensing
+  class ListLicensesError < Error
+    attr_reader :status_code
+
+    def initialize(message, status_code)
+      @status_code = status_code
+      super(message)
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module ChefLicensing
+  class MissingAPICredentialsError < Error
+    def message
+      super || "Missing API credentials. Check README for more details."
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+require_relative "error"
+
+module ChefLicensing
+  class RestfulClientConnectionError < Error
+    def message
+      super || "Restful Client Connection Error"
+    end
+  end
+end

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

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

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

@@ -0,0 +1,9 @@
+require_relative "error"
+
+module ChefLicensing
+  class SoftwareNotEntitled < Error
+    def message
+      super || "Software not entitled"
+    end
+  end
+end

data/lib/chef-licensing/license.rb

@@ -0,0 +1,151 @@
+require_relative "api/parser/client" unless defined?(ChefLicensing::Api::Parser::Client)
+require_relative "api/parser/describe" unless defined?(ChefLicensing::Api::Parser::Describe)
+require_relative "config"
+
+# License data model has an id, status, type of license, entitlements and limits.
+
+module ChefLicensing
+  class License
+
+    attr_reader :id, :license_type , :status, :expiration_date, :expiration_status
+    attr_accessor :number_of_days_in_expiration
+
+    def initialize(opts = {})
+      # API parser based on the API call
+      @parser = opts[:api_parser].new(opts[:data])
+      @product_name = ChefLicensing::Config.chef_product_name
+
+      @id = @parser.parse_id
+      @status = @parser.parse_status
+      @license_type = @parser.parse_license_type
+
+      # expiration details
+      @expiration_date = @parser.parse_expiration_date
+      @expiration_status = @parser.parse_license_expiration_status
+
+      # usage details
+      @limits = []
+
+      # Entitlements
+      @feature_entitlements = []
+      @software_entitlements = []
+      @asset_entitlements = []
+    end
+
+    def feature_entitlements
+      return @feature_entitlements unless @feature_entitlements.empty?
+
+      feat_entitlements = []
+      feat_entitlements_data = @parser.parse_feature_entitlements
+      feat_entitlements_data.each do |data|
+        feat_entitlements << FeatureEntitlement.new(data)
+      end
+      @feature_entitlements = feat_entitlements
+    end
+
+    def software_entitlements
+      return @software_entitlements unless @software_entitlements.empty?
+
+      sw_entitlements = []
+      sw_entitlements_data = @parser.parse_software_entitlements
+      sw_entitlements_data.each do |data|
+        sw_entitlements << SoftwareEntitlement.new(data)
+      end
+      @software_entitlements = sw_entitlements
+    end
+
+    def asset_entitlements
+      return @asset_entitlements unless @asset_entitlements.empty?
+
+      asset_entitlements = []
+      asset_entitlements_data = @parser.parse_asset_entitlements
+      asset_entitlements_data.each do |data|
+        asset_entitlements << AssetEntitlement.new(data)
+      end
+      @asset_entitlements = asset_entitlements
+    end
+
+    def limits
+      return @limits unless @limits.empty?
+
+      limits = []
+      limits_data = @parser.parse_limits
+      limits_data.each do |data|
+        limits << Limit.new(data, { product_name: @product_name })
+      end
+      @limits = limits
+    end
+
+    # License has list of limits for different softwares which includes usage details.
+    class Limit
+      attr_reader :usage_status, :usage_limit, :usage_measure, :used, :software
+
+      def initialize(limit_data, opts = {})
+        @usage_status = limit_data["usage_status"]
+        @usage_limit = limit_data["usage_limit"]
+        @usage_measure = limit_data["usage_measure"]
+        @used = limit_data["used"]
+        @software = limit_data["software"] || opts[:product_name]
+      end
+    end
+
+    # License can be entitled to list of features.
+    class FeatureEntitlement
+      attr_reader :id, :name, :entitled, :status
+
+      def initialize(entitlement_data)
+        @id = entitlement_data["id"]
+        @name = entitlement_data["name"]
+        @entitled = entitlement_data["entitled"]
+        @status = entitlement_data["status"]
+      end
+    end
+
+    # License can be entitled to list of softwares.
+    class SoftwareEntitlement
+      attr_reader :id, :name, :entitled, :status
+
+      def initialize(entitlement_data)
+        @id = entitlement_data["id"]
+        @name = entitlement_data["name"]
+        @entitled = entitlement_data["entitled"]
+        @status = entitlement_data["status"]
+      end
+    end
+
+    # License can be entitled to list of assets.
+    class AssetEntitlement
+      attr_reader :id, :name, :entitled, :status
+
+      def initialize(entitlement_data)
+        @id = entitlement_data["id"]
+        @name = entitlement_data["name"]
+        @entitled = entitlement_data["entitled"]
+        @status = entitlement_data["status"]
+      end
+    end
+
+    def have_grace?
+      status.eql?("Grace")
+    end
+
+    def expired?
+      status.eql?("Expired")
+    end
+
+    def active?
+      status.eql?("Active")
+    end
+
+    def expiring_or_expired?
+      have_grace? || expired? || about_to_expire?
+    end
+
+    def about_to_expire?
+      require "Date" unless defined?(Date)
+      self.number_of_days_in_expiration = (Date.parse(expiration_date) - Date.today).to_i
+      # starts to nag before a week when about to expire
+      status.eql?("Active") && expiration_status.eql?("Expired") && ((1..7).include? number_of_days_in_expiration)
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require_relative "../exceptions/invalid_license"
+module ChefLicensing
+  class LicenseKeyFetcher
+    class Base
+      # @example LICENSE UUID: tmns-58555821-925e-4a27-8fdc-e79dae5a425b-9763
+      # @example SERIAL NUMBER: A8BCD1XS2B4F6FYBWG8TE0N490
+      # @example COMMERCIAL KEY: e0b8f309-6abd-4668-909b-ef2d5fc043a1
+      # 4[license type]-(8-4-4-4-12)[GUID]-4[timestamp]
+      LICENSE_KEY_REGEX = "([a-z]{4}-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}-[0-9]{1,4})".freeze
+      LICENSE_KEY_PATTERN_DESC = "Hexadecimal".freeze
+      # Serial number is a 26 character alphanumeric string
+      SERIAL_KEY_REGEX = "([A-Z0-9]{26})".freeze
+      SERIAL_KEY_PATTERN_DESC = "26 character alphanumeric string".freeze
+      COMMERCIAL_KEY_REGEX = "([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})".freeze
+      QUIT_KEY_REGEX = "(q|Q)".freeze
+
+      def self.verify_and_extract_license(license_key)
+        if license_key && (match = license_key.match(/^#{LICENSE_KEY_REGEX}$/) || license_key.match(/^#{SERIAL_KEY_REGEX}$/) || license_key.match(/^#{COMMERCIAL_KEY_REGEX}$/))
+          match[1]
+        else
+          raise InvalidLicenseKeyFormat, "Malformed License Key passed on command line - should be #{LICENSE_KEY_PATTERN_DESC} or #{SERIAL_KEY_PATTERN_DESC}"
+        end
+      end
+
+      class InvalidLicenseKeyFormat < InvalidLicense; end
+    end
+  end
+end