Class: Gitlab::License

Inherits:
Object
  • Object
show all
Defined in:
lib/gitlab/license.rb,
lib/gitlab/license/version.rb,
lib/gitlab/license/boundary.rb,
lib/gitlab/license/encryptor.rb

Defined Under Namespace

Modules: Boundary Classes: Encryptor, Error, ImportError, ValidationError

Constant Summary collapse

VERSION = 
'2.3.0'.freeze

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ License

Returns a new instance of License.



88
89
90
 
# File 'lib/gitlab/license.rb', line 88

def initialize(attributes = {})
  load_attributes(attributes)
end

Class Attribute Details

.encryption_key ⇒ Object

Returns the value of attribute encryption_key.



17
18
19
 
# File 'lib/gitlab/license.rb', line 17

def encryption_key
  @encryption_key
end

.fallback_decryption_keys ⇒ Object

Returns the value of attribute fallback_decryption_keys.



18
19
20
 
# File 'lib/gitlab/license.rb', line 18

def fallback_decryption_keys
  @fallback_decryption_keys
end

Instance Attribute Details

#activated_at ⇒ Object

Returns the value of attribute activated_at.



79
80
81
 
# File 'lib/gitlab/license.rb', line 79

def activated_at
  @activated_at
end

#auto_renew_enabled ⇒ Object

Returns the value of attribute auto_renew_enabled.



79
80
81
 
# File 'lib/gitlab/license.rb', line 79

def auto_renew_enabled
  @auto_renew_enabled
end

#block_changes_at ⇒ Object

Returns the value of attribute block_changes_at.



79
80
81
 
# File 'lib/gitlab/license.rb', line 79

def block_changes_at
  @block_changes_at
end

#cloud_licensing_enabled ⇒ Object

Returns the value of attribute cloud_licensing_enabled.



79
80
81
 
# File 'lib/gitlab/license.rb', line 79

def cloud_licensing_enabled
  @cloud_licensing_enabled
end

#expires_at ⇒ Object

Returns the value of attribute expires_at.



79
80
81
 
# File 'lib/gitlab/license.rb', line 79

def expires_at
  @expires_at
end

#generated_from_customers_dot ⇒ Object

Returns the value of attribute generated_from_customers_dot.



79
80
81
 
# File 'lib/gitlab/license.rb', line 79

def generated_from_customers_dot
  @generated_from_customers_dot
end

#last_synced_at ⇒ Object

Returns the value of attribute last_synced_at.



79
80
81
 
# File 'lib/gitlab/license.rb', line 79

def last_synced_at
  @last_synced_at
end

#licensee ⇒ Object

Returns the value of attribute licensee.



79
80
81
 
# File 'lib/gitlab/license.rb', line 79

def licensee
  @licensee
end

#next_sync_at ⇒ Object

Returns the value of attribute next_sync_at.



79
80
81
 
# File 'lib/gitlab/license.rb', line 79

def next_sync_at
  @next_sync_at
end

#notify_admins_at ⇒ Object

Returns the value of attribute notify_admins_at.



79
80
81
 
# File 'lib/gitlab/license.rb', line 79

def notify_admins_at
  @notify_admins_at
end

#notify_users_at ⇒ Object

Returns the value of attribute notify_users_at.



79
80
81
 
# File 'lib/gitlab/license.rb', line 79

def notify_users_at
  @notify_users_at
end

#offline_cloud_licensing_enabled ⇒ Object

Returns the value of attribute offline_cloud_licensing_enabled.



79
80
81
 
# File 'lib/gitlab/license.rb', line 79

def offline_cloud_licensing_enabled
  @offline_cloud_licensing_enabled
end

#operational_metrics_enabled ⇒ Object

Returns the value of attribute operational_metrics_enabled.



79
80
81
 
# File 'lib/gitlab/license.rb', line 79

def operational_metrics_enabled
  @operational_metrics_enabled
end

#restrictions ⇒ Object

Returns the value of attribute restrictions.



79
80
81
 
# File 'lib/gitlab/license.rb', line 79

def restrictions
  @restrictions
end

#seat_reconciliation_enabled ⇒ Object

Returns the value of attribute seat_reconciliation_enabled.



79
80
81
 
# File 'lib/gitlab/license.rb', line 79

def seat_reconciliation_enabled
  @seat_reconciliation_enabled
end

#starts_at ⇒ Object Also known as: issued_at

Returns the value of attribute starts_at.



79
80
81
 
# File 'lib/gitlab/license.rb', line 79

def starts_at
  @starts_at
end

#version ⇒ Object (readonly)

Returns the value of attribute version.



78
79
80
 
# File 'lib/gitlab/license.rb', line 78

def version
  @version
end

Class Method Details

.decrypt_with_fallback_keys(data) ⇒ Object

Raises:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# 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|
    begin
      decryptor = Encryptor.new(decryption_key)
      return decryptor.decrypt(data)
    rescue Encryptor::Error
      next
    end
  end

  raise ImportError, 'License data could not be decrypted.'
end

.encryptor ⇒ Object 



41
42
43
 
# File 'lib/gitlab/license.rb', line 41

def encryptor
  @encryptor ||= Encryptor.new(encryption_key)
end

.import(data) ⇒ Object

Raises:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# 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

Instance Method Details

#activated? ⇒ Boolean

Returns:

  • (Boolean) 


146
147
148
 
# File 'lib/gitlab/license.rb', line 146

def activated?
  activated_at
end

#attributes ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/gitlab/license.rb', line 206

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['generated_from_customers_dot'] = generated_from_customers_dot?

  hash['restrictions'] = restrictions if restricted?

  hash
end

#auto_renew? ⇒ Boolean

Returns:

  • (Boolean) 


174
175
176
 
# File 'lib/gitlab/license.rb', line 174

def auto_renew?
  auto_renew_enabled == true
end

#block_changes? ⇒ Boolean

Returns:

  • (Boolean) 


162
163
164
 
# File 'lib/gitlab/license.rb', line 162

def block_changes?
  will_block_changes? && Date.today >= block_changes_at
end

#cloud_licensing? ⇒ Boolean

Returns:

  • (Boolean) 


166
167
168
 
# File 'lib/gitlab/license.rb', line 166

def cloud_licensing?
  cloud_licensing_enabled == true
end

#expired? ⇒ Boolean

Returns:

  • (Boolean) 


150
151
152
 
# File 'lib/gitlab/license.rb', line 150

def expired?
  will_expire? && Date.today >= expires_at
end

#export(boundary: nil) ⇒ Object 



242
243
244
245
246
247
248
249
250
 
# File 'lib/gitlab/license.rb', line 242

def export(boundary: nil)
  validate!

  data = self.class.encryptor.encrypt(to_json)

  data = Boundary.add_boundary(data, boundary) if boundary

  data
end

#generated_from_customers_dot? ⇒ Boolean

Returns:

  • (Boolean) 


186
187
188
 
# File 'lib/gitlab/license.rb', line 186

def generated_from_customers_dot?
  generated_from_customers_dot == true
end

#gl_team_license? ⇒ Boolean

Returns:

  • (Boolean) 


190
191
192
 
# File 'lib/gitlab/license.rb', line 190

def gl_team_license?
  licensee['Company'].to_s.match?(/GitLab/i) && licensee['Email'].to_s.end_with?('@gitlab.com')
end

#jh_team_license? ⇒ Boolean

Returns:

  • (Boolean) 


194
195
196
 
# File 'lib/gitlab/license.rb', line 194

def jh_team_license?
  licensee['Company'].to_s.match?(/GitLab/i) && licensee['Email'].to_s.end_with?('@jihulab.com')
end

#notify_admins? ⇒ Boolean

Returns:

  • (Boolean) 


154
155
156
 
# File 'lib/gitlab/license.rb', line 154

def notify_admins?
  will_notify_admins? && Date.today >= notify_admins_at
end

#notify_users? ⇒ Boolean

Returns:

  • (Boolean) 


158
159
160
 
# File 'lib/gitlab/license.rb', line 158

def notify_users?
  will_notify_users? && Date.today >= notify_users_at
end

#offline_cloud_licensing? ⇒ Boolean

Returns:

  • (Boolean) 


170
171
172
 
# File 'lib/gitlab/license.rb', line 170

def offline_cloud_licensing?
  offline_cloud_licensing_enabled == true
end

#operational_metrics? ⇒ Boolean

Returns:

  • (Boolean) 


182
183
184
 
# File 'lib/gitlab/license.rb', line 182

def operational_metrics?
  operational_metrics_enabled == true
end

#restricted?(key = nil) ⇒ Boolean

Returns:

  • (Boolean) 


198
199
200
201
202
203
204
 
# File 'lib/gitlab/license.rb', line 198

def restricted?(key = nil)
  if key
    restricted? && restrictions.has_key?(key)
  else
    restrictions && restrictions.length >= 1
  end
end

#seat_reconciliation? ⇒ Boolean

Returns:

  • (Boolean) 


178
179
180
 
# File 'lib/gitlab/license.rb', line 178

def seat_reconciliation?
  seat_reconciliation_enabled == true
end

#to_json(*_args) ⇒ Object 



238
239
240
 
# File 'lib/gitlab/license.rb', line 238

def to_json(*_args)
  JSON.dump(attributes)
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/gitlab/license.rb', line 92

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! ⇒ Object

Raises:



122
123
124
 
# File 'lib/gitlab/license.rb', line 122

def validate!
  raise ValidationError, 'License is invalid' unless valid?
end

#will_block_changes? ⇒ Boolean

Returns:

  • (Boolean) 


138
139
140
 
# File 'lib/gitlab/license.rb', line 138

def will_block_changes?
  block_changes_at
end

#will_expire? ⇒ Boolean

Returns:

  • (Boolean) 


126
127
128
 
# File 'lib/gitlab/license.rb', line 126

def will_expire?
  expires_at
end

#will_notify_admins? ⇒ Boolean

Returns:

  • (Boolean) 


130
131
132
 
# File 'lib/gitlab/license.rb', line 130

def will_notify_admins?
  notify_admins_at
end

#will_notify_users? ⇒ Boolean

Returns:

  • (Boolean) 


134
135
136
 
# File 'lib/gitlab/license.rb', line 134

def will_notify_users?
  notify_users_at
end

#will_sync? ⇒ Boolean

Returns:

  • (Boolean) 


142
143
144
 
# File 'lib/gitlab/license.rb', line 142

def will_sync?
  next_sync_at
end