class Gitlab::License
Constants
- VERSION
Attributes
encryption_key[R]
fallback_decryption_keys[R]
activated_at[RW]
auto_renew_enabled[RW]
block_changes_at[RW]
cloud_licensing_enabled[RW]
contract_overages_allowed[RW]
expires_at[RW]
generated_from_cancellation[RW]
generated_from_customers_dot[RW]
issued_at[RW]
issued_at=[RW]
last_synced_at[RW]
licensee[RW]
next_sync_at[RW]
notify_admins_at[RW]
notify_users_at[RW]
offline_cloud_licensing_enabled[RW]
operational_metrics_enabled[RW]
restrictions[RW]
seat_reconciliation_enabled[RW]
starts_at[RW]
temporary_extension[RW]
version[R]
Public Class Methods
decrypt_with_fallback_keys(data)
click to toggle source
# File lib/gitlab/license.rb, line 61 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
encryption_key=(key)
click to toggle source
# File lib/gitlab/license.rb, line 21 def encryption_key=(key) raise ArgumentError, 'No RSA encryption key provided.' if key && !key.is_a?(OpenSSL::PKey::RSA) @encryption_key = key @encryptor = nil end
encryptor()
click to toggle source
# File lib/gitlab/license.rb, line 41 def encryptor @encryptor ||= Encryptor.new(encryption_key) end
fallback_decryption_keys=(keys)
click to toggle source
# File lib/gitlab/license.rb, line 28 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
import(data)
click to toggle source
# File lib/gitlab/license.rb, line 45 def import(data) raise ImportError, 'No license data.' if data.nil? data = Boundary.remove_boundary(data) license_json = decrypt_with_fallback_keys(data) begin attributes = JSON.parse(license_json) rescue JSON::ParseError raise ImportError, 'License data is invalid JSON.' end new(attributes) end
new(attributes = {})
click to toggle source
# File lib/gitlab/license.rb, line 87 def initialize(attributes = {}) load_attributes(attributes) end
Public Instance Methods
activated?()
click to toggle source
# File lib/gitlab/license.rb, line 145 def activated? activated_at end
attributes()
click to toggle source
# File lib/gitlab/license.rb, line 217 def attributes hash = {} hash['version'] = version hash['licensee'] = licensee # `issued_at` is the legacy name for starts_at. # TODO: Move to starts_at in a next version. hash['issued_at'] = starts_at hash['expires_at'] = expires_at if will_expire? hash['notify_admins_at'] = notify_admins_at if will_notify_admins? hash['notify_users_at'] = notify_users_at if will_notify_users? hash['block_changes_at'] = block_changes_at if will_block_changes? hash['next_sync_at'] = next_sync_at if will_sync? hash['last_synced_at'] = last_synced_at if will_sync? hash['activated_at'] = activated_at if activated? hash['cloud_licensing_enabled'] = cloud_licensing? hash['offline_cloud_licensing_enabled'] = offline_cloud_licensing? 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? hash end
auto_renew?()
click to toggle source
# File lib/gitlab/license.rb, line 177 def auto_renew? auto_renew_enabled == true end
block_changes?()
click to toggle source
# File lib/gitlab/license.rb, line 161 def block_changes? will_block_changes? && Date.today >= block_changes_at end
cloud_licensing?()
click to toggle source
# File lib/gitlab/license.rb, line 165 def cloud_licensing? cloud_licensing_enabled == true end
contract_overages_allowed?()
click to toggle source
# File lib/gitlab/license.rb, line 173 def contract_overages_allowed? contract_overages_allowed == true end
expired?()
click to toggle source
# File lib/gitlab/license.rb, line 149 def expired? will_expire? && Date.today >= expires_at end
export(boundary: nil)
click to toggle source
# File lib/gitlab/license.rb, line 257 def export(boundary: nil) validate! data = self.class.encryptor.encrypt(to_json) data = Boundary.add_boundary(data, boundary) if boundary data end
generated_from_cancellation?()
click to toggle source
# File lib/gitlab/license.rb, line 193 def generated_from_cancellation? generated_from_cancellation == true end
generated_from_customers_dot?()
click to toggle source
# File lib/gitlab/license.rb, line 189 def generated_from_customers_dot? generated_from_customers_dot == true end
gl_team_license?()
click to toggle source
# File lib/gitlab/license.rb, line 197 def gl_team_license? licensee['Company'].to_s.match?(/GitLab/i) && licensee['Email'].to_s.end_with?('@gitlab.com') end
jh_team_license?()
click to toggle source
# File lib/gitlab/license.rb, line 201 def jh_team_license? licensee['Company'].to_s.match?(/GitLab/i) && licensee['Email'].to_s.end_with?('@jihulab.com') end
notify_admins?()
click to toggle source
# File lib/gitlab/license.rb, line 153 def notify_admins? will_notify_admins? && Date.today >= notify_admins_at end
notify_users?()
click to toggle source
# File lib/gitlab/license.rb, line 157 def notify_users? will_notify_users? && Date.today >= notify_users_at end
offline_cloud_licensing?()
click to toggle source
# File lib/gitlab/license.rb, line 169 def offline_cloud_licensing? offline_cloud_licensing_enabled == true end
operational_metrics?()
click to toggle source
# File lib/gitlab/license.rb, line 185 def operational_metrics? operational_metrics_enabled == true end
restricted?(key = nil)
click to toggle source
# File lib/gitlab/license.rb, line 209 def restricted?(key = nil) if key restricted? && restrictions.has_key?(key) else restrictions && restrictions.length >= 1 end end
seat_reconciliation?()
click to toggle source
# File lib/gitlab/license.rb, line 181 def seat_reconciliation? seat_reconciliation_enabled == true end
temporary_extension?()
click to toggle source
# File lib/gitlab/license.rb, line 205 def temporary_extension? temporary_extension == true end
to_json(*_args)
click to toggle source
# File lib/gitlab/license.rb, line 253 def to_json(*_args) JSON.dump(attributes) end
valid?()
click to toggle source
# File lib/gitlab/license.rb, line 91 def valid? if !licensee || !licensee.is_a?(Hash) || licensee.empty? false elsif !starts_at || !starts_at.is_a?(Date) false elsif !expires_at && !gl_team_license? && !jh_team_license? false elsif expires_at && !expires_at.is_a?(Date) false elsif notify_admins_at && !notify_admins_at.is_a?(Date) false elsif notify_users_at && !notify_users_at.is_a?(Date) false elsif block_changes_at && !block_changes_at.is_a?(Date) false elsif last_synced_at && !last_synced_at.is_a?(DateTime) false elsif next_sync_at && !next_sync_at.is_a?(DateTime) false elsif activated_at && !activated_at.is_a?(DateTime) false elsif restrictions && !restrictions.is_a?(Hash) false elsif !cloud_licensing? && offline_cloud_licensing? false else true end end
validate!()
click to toggle source
# File lib/gitlab/license.rb, line 121 def validate! raise ValidationError, 'License is invalid' unless valid? end
will_block_changes?()
click to toggle source
# File lib/gitlab/license.rb, line 137 def will_block_changes? block_changes_at end
will_expire?()
click to toggle source
# File lib/gitlab/license.rb, line 125 def will_expire? expires_at end
will_notify_admins?()
click to toggle source
# File lib/gitlab/license.rb, line 129 def will_notify_admins? notify_admins_at end
will_notify_users?()
click to toggle source
# File lib/gitlab/license.rb, line 133 def will_notify_users? notify_users_at end
will_sync?()
click to toggle source
# File lib/gitlab/license.rb, line 141 def will_sync? next_sync_at end
Private Instance Methods
load_attributes(attributes)
click to toggle source
# File lib/gitlab/license.rb, line 269 def load_attributes(attributes) attributes = attributes.transform_keys(&:to_s) version = attributes['version'] || 1 raise ArgumentError, 'Version is too new' unless version && version == 1 @version = version @licensee = attributes['licensee'] # `issued_at` is the legacy name for starts_at. # TODO: Move to starts_at in a next version. %w[issued_at expires_at notify_admins_at notify_users_at block_changes_at].each do |attr_name| set_date_attribute(attr_name, attributes[attr_name]) end %w[last_synced_at next_sync_at activated_at].each do |attr_name| set_datetime_attribute(attr_name, attributes[attr_name]) end %w[ cloud_licensing_enabled offline_cloud_licensing_enabled auto_renew_enabled 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) @restrictions = restrictions end end
set_date_attribute(attr_name, value, date_class = Date)
click to toggle source
# File lib/gitlab/license.rb, line 311 def set_date_attribute(attr_name, value, date_class = Date) value = date_class.parse(value) rescue nil if value.is_a?(String) return unless value public_send("#{attr_name}=", value) end
set_datetime_attribute(attr_name, value)
click to toggle source
# File lib/gitlab/license.rb, line 319 def set_datetime_attribute(attr_name, value) set_date_attribute(attr_name, value, DateTime) end