gitlab-license 2.2.2 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a061df608a1fce9d44d099ca2ec27c78f57954560d014ea3810a6a104d84e76c
-  data.tar.gz: fc39825338f1e87996be207d2d16c0ad0fe809217614b91edd10b3df0a102a13
+  metadata.gz: 22b0a5d5cec617462fad10a954e69a8ab0cbf2234c4c666b2bce3962387627b4
+  data.tar.gz: 5c74cb614cca7a0501188c219fa4dd716d6158fd79cae2a9aeef698d08d90ff9
 SHA512:
-  metadata.gz: ef5ee9e933e196a77dee538f4222fe42eb9b68b5d8b6520e6a32e99fd5186eed592eef7062bfb55702e747b780488dfaf42d7f1e99ca6b8a6a7462c23fd9a7d8
-  data.tar.gz: dbb5a8a59e70b4d315115a622118987c718e19f0df7686026cb43bbd189c3d22a98ed64b9f155d4c41f9e7bda656ccd306eb1060a39e72270993d390fbd329d4
+  metadata.gz: 8cbae440edf6fa10bb5944b63957e204e3fe6213d66d338b1cb7ce0428e2bdfc65a56b634a16c5832cd0039c568108a34c9f9c8b2da1f15e1427332355a2535a
+  data.tar.gz: ee7e2deda0d8f42d5453455a9d9d6d88f1b3a53d908f87323928151587a3640bdf3ad4fa7cb9d792639f88df00c0b934491d54e20233d0513b884135ea789ef1

data/.gitlab-ci.yml

@@ -0,0 +1,25 @@
+default:
+  image: "ruby:${RUBY_VERSION}"
+
+cache:
+  key: "${CI_JOB_IMAGE}"
+  paths:
+    - vendor/ruby
+
+before_script:
+  - ruby -v
+  - gem update --system --no-document
+  - bundle install -j $(nproc) --path vendor
+
+test:
+  script:
+    - bundle exec rspec
+  parallel:
+    matrix:
+      - RUBY_VERSION: [ "3.0", "3.1", "3.2" ]
+
+rubocop:
+  script:
+    - bundle exec rubocop
+  variables:
+    RUBY_VERSION: "3.0"

data/.rubocop.yml

@@ -1,6 +1,8 @@
 inherit_from: .rubocop_todo.yml
 
 require: rubocop-rspec
+AllCops:
+  TargetRubyVersion: 2.7
 
 Metrics/BlockLength:
   ExcludedMethods: ['describe', 'context']

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-03-02 14:37:54 -0500 using RuboCop version 0.80.1.
+# on 2023-12-21 18:05:17 -0500 using RuboCop version 0.80.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -8,25 +8,31 @@
 
 # Offense count: 6
 Metrics/AbcSize:
-  Max: 36
+  Max: 60
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 26
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 129
+  Max: 223
 
 # Offense count: 3
 Metrics/CyclomaticComplexity:
-  Max: 16
+  Max: 27
 
-# Offense count: 5
+# Offense count: 6
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
-  Max: 38
+  Max: 36
 
 # Offense count: 3
 Metrics/PerceivedComplexity:
-  Max: 16
+  Max: 28
 
 # Offense count: 3
 Style/Documentation:
@@ -76,7 +82,7 @@ Style/RescueModifier:
   Exclude:
     - 'lib/gitlab/license.rb'
 
-# Offense count: 14
+# Offense count: 28
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https

data/README.md

@@ -27,7 +27,9 @@ To release a new version of this gem, follow these steps:
 1. [Build the gem](https://guides.rubygems.org/command-reference/#gem-build) to be published: `gem build gitlab-license.gemspec`
 1. [Publish the gem](https://guides.rubygems.org/publishing) to Rubygems: `gem push gitlab-license-2.1.0.gem`
    - Note you will need to be added as an owner in Rubygems in order to publish.
-   - Once this is published, the new version of the gem can be installed in other projects like CustomersDot or GitLab via bundler or using `gem install` directly.
+1. Once published, the new version of the gem can be installed in projects that depend on `gitlab-license` like [CustomersDot](https://gitlab.com/gitlab-org/customers-gitlab-com) and [GitLab](https://gitlab.com/gitlab-org/gitlab).
+   - It is recommended to install the new version in both GitLab and CustomersDot to keep the versions aligned.
+   - This can be installed via bundler or using `gem install` directly.
 
 ## Usage
 
@@ -82,6 +84,10 @@ license.notify_users_at   = Date.new(2016, 4, 23)
 # Not required.
 license.block_changes_at  = Date.new(2016, 5, 7)
 
+# If this license was created due to a subscription cancellation
+# Not required.
+license.generated_from_cancellation? = false
+
 # Restrictions bundled with this license.
 # Not required, to allow unlimited-user licenses for things like educational organizations.
 license.restrictions  = {

data/lib/gitlab/license/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   class License
-    VERSION = '2.2.2'.freeze
+    VERSION = '2.6.0'.freeze
   end
 end

data/lib/gitlab/license.rb

@@ -8,13 +8,14 @@ require 'gitlab/license/encryptor'
 require 'gitlab/license/boundary'
 
 module Gitlab
-  class License
+  class License # rubocop:disable Metrics/ClassLength
     class Error < StandardError; end
     class ImportError < Error; end
     class ValidationError < Error; end
 
     class << self
       attr_reader :encryption_key
+      attr_reader :fallback_decryption_keys
       @encryption_key = nil
 
       def encryption_key=(key)
@@ -24,6 +25,19 @@ module Gitlab
         @encryptor = nil
       end
 
+      def fallback_decryption_keys=(keys)
+        unless keys
+          @fallback_decryption_keys = nil
+          return
+        end
+
+        unless keys.is_a?(Enumerable) && keys.all? { |key| key.is_a?(OpenSSL::PKey::RSA) }
+          raise ArgumentError, 'Invalid fallback RSA encryption keys provided.'
+        end
+
+        @fallback_decryption_keys = Array(keys)
+      end
+
       def encryptor
         @encryptor ||= Encryptor.new(encryption_key)
       end
@@ -33,11 +47,7 @@ module Gitlab
 
         data = Boundary.remove_boundary(data)
 
-        begin
-          license_json = encryptor.decrypt(data)
-        rescue Encryptor::Error
-          raise ImportError, 'License data could not be decrypted.'
-        end
+        license_json = decrypt_with_fallback_keys(data)
 
         begin
           attributes = JSON.parse(license_json)
@@ -47,6 +57,20 @@ module Gitlab
 
         new(attributes)
       end
+
+      def decrypt_with_fallback_keys(data)
+        keys_to_try = Array(encryption_key)
+        keys_to_try += fallback_decryption_keys if fallback_decryption_keys
+
+        keys_to_try.each do |decryption_key|
+          decryptor = Encryptor.new(decryption_key)
+          return decryptor.decrypt(data)
+        rescue Encryptor::Error
+          next
+        end
+
+        raise ImportError, 'License data could not be decrypted.'
+      end
     end
 
     attr_reader :version
@@ -54,7 +78,8 @@ module Gitlab
                   :notify_users_at, :block_changes_at, :last_synced_at, :next_sync_at,
                   :activated_at, :restrictions, :cloud_licensing_enabled,
                   :offline_cloud_licensing_enabled, :auto_renew_enabled, :seat_reconciliation_enabled,
-                  :operational_metrics_enabled, :generated_from_customers_dot
+                  :operational_metrics_enabled, :generated_from_customers_dot,
+                  :generated_from_cancellation, :temporary_extension, :contract_overages_allowed
 
     alias_method :issued_at, :starts_at
     alias_method :issued_at=, :starts_at=
@@ -145,6 +170,10 @@ module Gitlab
       offline_cloud_licensing_enabled == true
     end
 
+    def contract_overages_allowed?
+      contract_overages_allowed == true
+    end
+
     def auto_renew?
       auto_renew_enabled == true
     end
@@ -161,6 +190,10 @@ module Gitlab
       generated_from_customers_dot == true
     end
 
+    def generated_from_cancellation?
+      generated_from_cancellation == true
+    end
+
     def gl_team_license?
       licensee['Company'].to_s.match?(/GitLab/i) && licensee['Email'].to_s.end_with?('@gitlab.com')
     end
@@ -169,6 +202,10 @@ module Gitlab
       licensee['Company'].to_s.match?(/GitLab/i) && licensee['Email'].to_s.end_with?('@jihulab.com')
     end
 
+    def temporary_extension?
+      temporary_extension == true
+    end
+
     def restricted?(key = nil)
       if key
         restricted? && restrictions.has_key?(key)
@@ -201,8 +238,12 @@ module Gitlab
       hash['auto_renew_enabled'] = auto_renew?
       hash['seat_reconciliation_enabled'] = seat_reconciliation?
       hash['operational_metrics_enabled'] = operational_metrics?
+      hash['contract_overages_allowed'] = contract_overages_allowed?
 
       hash['generated_from_customers_dot'] = generated_from_customers_dot?
+      hash['generated_from_cancellation'] = generated_from_cancellation?
+
+      hash['temporary_extension'] = temporary_extension?
 
       hash['restrictions'] = restrictions if restricted?
 
@@ -252,10 +293,14 @@ module Gitlab
         seat_reconciliation_enabled
         operational_metrics_enabled
         generated_from_customers_dot
+        generated_from_cancellation
+        temporary_extension
       ].each do |attr_name|
         public_send("#{attr_name}=", attributes[attr_name] == true)
       end
 
+      @contract_overages_allowed = attributes['contract_overages_allowed'] != false
+
       restrictions = attributes['restrictions']
       if restrictions&.is_a?(Hash)
         restrictions = restrictions.transform_keys(&:to_sym)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-license
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.6.0
 platform: ruby
 authors:
 - Douwe Maan
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-05 00:00:00.000000000 Z
+date: 2024-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,6 +106,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"