legion-crypt 1.5.37 → 1.5.42

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ci.yml +30 -3
  3. data/.rspec +2 -0
  4. data/AGENTS.md +2 -0
  5. data/CHANGELOG.md +34 -0
  6. data/CLAUDE.md +64 -192
  7. data/CODEOWNERS +4 -4
  8. data/Gemfile +4 -1
  9. data/README.md +66 -16
  10. data/legion-crypt.gemspec +1 -0
  11. data/lib/legion/crypt/cert_rotation.rb +7 -21
  12. data/lib/legion/crypt/cluster_secret.rb +3 -14
  13. data/lib/legion/crypt/ed25519.rb +2 -10
  14. data/lib/legion/crypt/erasure.rb +3 -13
  15. data/lib/legion/crypt/jwks_client.rb +4 -4
  16. data/lib/legion/crypt/kerberos_auth.rb +2 -2
  17. data/lib/legion/crypt/ldap_auth.rb +2 -2
  18. data/lib/legion/crypt/lease_manager.rb +191 -26
  19. data/lib/legion/crypt/mtls.rb +8 -46
  20. data/lib/legion/crypt/partition_keys.rb +2 -6
  21. data/lib/legion/crypt/settings.rb +24 -21
  22. data/lib/legion/crypt/spiffe/svid_rotation.rb +6 -9
  23. data/lib/legion/crypt/spiffe.rb +14 -39
  24. data/lib/legion/crypt/token_renewer.rb +6 -6
  25. data/lib/legion/crypt/vault/client.rb +355 -0
  26. data/lib/legion/crypt/vault/cluster.rb +330 -0
  27. data/lib/legion/crypt/vault/entity.rb +80 -0
  28. data/lib/legion/crypt/vault/jwt_auth.rb +99 -0
  29. data/lib/legion/crypt/vault/kerberos_auth.rb +53 -0
  30. data/lib/legion/crypt/vault/operation.rb +29 -0
  31. data/lib/legion/crypt/vault.rb +6 -11
  32. data/lib/legion/crypt/version.rb +1 -1
  33. data/lib/legion/crypt.rb +69 -80
  34. metadata +23 -8
  35. data/lib/legion/crypt/vault_client.rb +0 -355
  36. data/lib/legion/crypt/vault_cluster.rb +0 -331
  37. data/lib/legion/crypt/vault_entity.rb +0 -78
  38. data/lib/legion/crypt/vault_jwt_auth.rb +0 -97
  39. data/lib/legion/crypt/vault_kerberos_auth.rb +0 -51
  40. data/lib/legion/crypt/vault_operation.rb +0 -27
  41. /data/lib/legion/crypt/{vault_renewer.rb → vault/renewer.rb} +0 -0
data/lib/legion/crypt.rb CHANGED
@@ -3,14 +3,16 @@
3
3
  require 'openssl'
4
4
  require 'base64'
5
5
  require 'legion/logging/helper'
6
+ require 'legion/settings'
7
+
6
8
  require 'legion/crypt/version'
7
9
  require 'legion/crypt/settings'
8
10
  require 'legion/crypt/cipher'
9
11
  require 'legion/crypt/jwt'
10
- require 'legion/crypt/vault_jwt_auth'
12
+ require 'legion/crypt/vault/jwt_auth'
11
13
  require 'legion/crypt/lease_manager'
12
- require 'legion/crypt/vault_operation'
13
- require 'legion/crypt/vault_cluster'
14
+ require 'legion/crypt/vault/operation'
15
+ require 'legion/crypt/vault/cluster'
14
16
  require 'legion/crypt/vault'
15
17
  require 'legion/crypt/ldap_auth'
16
18
  require 'legion/crypt/token_renewer'
@@ -18,13 +20,10 @@ require 'legion/crypt/helper'
18
20
  require 'legion/crypt/mtls'
19
21
  require 'legion/crypt/cert_rotation'
20
22
  require 'legion/crypt/spiffe'
21
- require 'legion/crypt/spiffe/workload_api_client'
22
- require 'legion/crypt/spiffe/svid_rotation'
23
- require 'legion/crypt/spiffe/identity_helpers'
24
23
 
25
24
  module Legion
26
25
  module Crypt
27
- extend Legion::Crypt::VaultCluster
26
+ extend Legion::Crypt::Vault::Cluster
28
27
  extend Legion::Crypt::LdapAuth
29
28
 
30
29
  RMQ_ROLE_MAP = {
@@ -33,6 +32,10 @@ module Legion
33
32
  infra: 'legionio-infra'
34
33
  }.freeze
35
34
 
35
+ POSTGRES_ROLE_MAP = {
36
+ infra: 'infra'
37
+ }.freeze
38
+
36
39
  class << self
37
40
  attr_reader :sessions, :stopping
38
41
 
@@ -41,29 +44,25 @@ module Legion
41
44
 
42
45
  include Legion::Crypt::Vault
43
46
 
44
- def vault_settings
45
- Legion::Settings[:crypt][:vault]
46
- end
47
-
48
- def kerberos_principal
49
- KerberosAuth.kerberos_principal
47
+ def kerberos_principal(**)
48
+ Legion::Crypt::KerberosAuth.kerberos_principal
50
49
  end
51
50
 
52
51
  def spiffe_svid
53
52
  @svid_rotation&.current_svid
54
53
  end
55
54
 
56
- def fetch_svid
57
- @workload_client ||= Spiffe::WorkloadApiClient.new
55
+ def fetch_svid(**)
56
+ @workload_client ||= Legion::Crypt::Spiffe::WorkloadApiClient.new
58
57
  @workload_client.fetch_x509_svid
59
58
  end
60
59
 
61
- def fetch_jwt_svid(audience:)
62
- @workload_client ||= Spiffe::WorkloadApiClient.new
60
+ def fetch_jwt_svid(audience:, **)
61
+ @workload_client ||= Legion::Crypt::Spiffe::WorkloadApiClient.new
63
62
  @workload_client.fetch_jwt_svid(audience: audience)
64
63
  end
65
64
 
66
- def start
65
+ def start(mode: nil, **)
67
66
  lifecycle_mutex.synchronize do
68
67
  if @started || @stopping
69
68
  log.info 'Legion::Crypt start ignored because the lifecycle is running or stopping'
@@ -72,7 +71,7 @@ module Legion
72
71
 
73
72
  log.info 'Legion::Crypt startup initiated'
74
73
  log.debug 'Legion::Crypt start requested'
75
- if settings[:save_private_key]
74
+ if Legion::Settings[:crypt][:save_private_key]
76
75
  key = private_key
77
76
  ::File.open('./legionio.key', ::File::WRONLY | ::File::CREAT, 0o600) do |file|
78
77
  file.chmod(0o600)
@@ -83,15 +82,15 @@ module Legion
83
82
  @token_renewers ||= []
84
83
  start_session_tracking
85
84
 
86
- if vault_settings[:clusters]&.any?
87
- log.info "Legion::Crypt connecting #{vault_settings[:clusters].size} Vault cluster(s)"
85
+ if Legion::Settings[:crypt][:vault][:clusters].any?
86
+ log.info "Legion::Crypt connecting #{Legion::Settings[:crypt][:vault][:clusters].size} Vault cluster(s)"
88
87
  connect_all_clusters
89
88
  else
90
- log.info 'Legion::Crypt connecting primary Vault client' unless settings[:vault][:token].nil?
91
- connect_vault unless settings[:vault][:token].nil?
89
+ log.info 'Legion::Crypt connecting primary Vault client' unless Legion::Settings[:crypt][:vault][:token].nil?
90
+ connect_vault unless Legion::Settings[:crypt][:vault][:token].nil?
92
91
  end
93
92
  start_token_renewers
94
- start_lease_manager
93
+ start_lease_manager(mode: mode)
95
94
  start_svid_rotation
96
95
  @started = true
97
96
  log.info 'Legion::Crypt startup completed'
@@ -121,31 +120,19 @@ module Legion
121
120
  end
122
121
  end
123
122
 
124
- def settings
125
- if Legion.const_defined?('Settings')
126
- Legion::Settings[:crypt]
127
- else
128
- Legion::Crypt::Settings.default
129
- end
130
- end
131
-
132
- def jwt_settings
133
- settings[:jwt] || Legion::Crypt::Settings.jwt
134
- end
135
-
136
123
  def dynamic_rmq_creds?
137
- Legion::Settings.dig(:crypt, :vault, :dynamic_rmq_creds) == true
124
+ Legion::Settings[:crypt][:vault][:dynamic_rmq_creds] == true
138
125
  end
139
126
 
140
- def fetch_bootstrap_rmq_creds
127
+ def fetch_bootstrap_rmq_creds(**)
141
128
  return unless vault_connected? && dynamic_rmq_creds?
142
129
 
143
130
  Legion::Settings.merge_settings('transport', Legion::Transport::Settings.default) if defined?(Legion::Transport::Settings)
144
131
 
145
- response = LeaseManager.instance.vault_logical.read(path: 'rabbitmq/creds/legionio-bootstrap')
132
+ response = Legion::Crypt::LeaseManager.instance.vault_logical.read(path: 'rabbitmq/creds/legionio-bootstrap')
146
133
  return unless response&.data
147
134
 
148
- bootstrap_lease_ttl = Legion::Settings.dig(:crypt, :vault, :bootstrap_lease_ttl).to_i
135
+ bootstrap_lease_ttl = Legion::Settings[:crypt][:vault][:bootstrap_lease_ttl].to_i
149
136
  bootstrap_lease_ttl = 300 if bootstrap_lease_ttl <= 0
150
137
 
151
138
  @bootstrap_lease_id = response.lease_id
@@ -167,18 +154,17 @@ module Legion
167
154
  conn[:password] = password
168
155
 
169
156
  log.info "Bootstrap RMQ credentials acquired (lease: #{@bootstrap_lease_id[0..7]}...)"
170
- rescue StandardError => e
157
+ rescue IOError, SystemCallError, Timeout::Error, Faraday::Error, Legion::Crypt::Vault::HTTPError => e
171
158
  handle_exception(e, level: :warn, operation: 'crypt.fetch_bootstrap_rmq_creds')
172
- log.warn "Bootstrap RMQ credential fetch failed: #{e.message}"
173
159
  end
174
160
 
175
- def swap_to_identity_creds(mode:)
161
+ def swap_to_identity_creds(mode:, **)
176
162
  return unless vault_connected? && dynamic_rmq_creds?
177
163
  return if mode == :lite
178
164
 
179
165
  role = RMQ_ROLE_MAP.fetch(mode, "legionio-#{mode}")
180
- manager = LeaseManager.instance
181
- response = Legion::Crypt::VaultOperation.with_timeout { manager.vault_logical.read(path: "rabbitmq/creds/#{role}") }
166
+ manager = Legion::Crypt::LeaseManager.instance
167
+ response = Legion::Crypt::Vault::Operation.with_timeout { manager.vault_logical.read(path: "rabbitmq/creds/#{role}") }
182
168
  raise "Failed to fetch identity-scoped RMQ creds for role #{role}" unless response
183
169
 
184
170
  settings = Legion::Settings.loader.settings
@@ -199,56 +185,47 @@ module Legion
199
185
  )
200
186
  raise 'Identity credential handoff failed — bootstrap lease NOT revoked' unless installed
201
187
 
202
- Legion::Crypt::VaultOperation.with_timeout { revoke_bootstrap_lease }
188
+ Legion::Crypt::Vault::Operation.with_timeout { revoke_bootstrap_lease }
203
189
  end
204
190
 
205
- def revoke_bootstrap_lease
191
+ def revoke_bootstrap_lease(**)
206
192
  return unless @bootstrap_lease_id
207
193
 
208
- LeaseManager.instance.vault_sys.revoke(lease_id: @bootstrap_lease_id)
194
+ Legion::Crypt::LeaseManager.instance.vault_sys.revoke(lease_id: @bootstrap_lease_id)
209
195
  log.info "Bootstrap RMQ lease revoked (#{@bootstrap_lease_id[0..7]}...)"
210
196
  @bootstrap_lease_id = nil
211
197
  @bootstrap_lease_expires = nil
212
- rescue StandardError => e
198
+ rescue IOError, SystemCallError, Timeout::Error, Faraday::Error, Legion::Crypt::Vault::HTTPError => e
213
199
  handle_exception(e, level: :warn, operation: 'crypt.revoke_bootstrap_lease')
214
- log.warn "Bootstrap lease revocation failed: #{e.message} — lease will expire naturally"
215
200
  @bootstrap_lease_id = nil
216
201
  @bootstrap_lease_expires = nil
217
202
  end
218
203
 
219
- def vault_connected?
220
- return connected_clusters.any? if settings.dig(:vault, :clusters)&.any?
204
+ def vault_connected?(**)
205
+ return connected_clusters.any? if Legion::Settings[:crypt][:vault][:clusters].any?
221
206
 
222
- return true if settings.dig(:vault, :connected) == true
223
- return true if respond_to?(:connected_clusters) && connected_clusters.any?
224
-
225
- false
226
- rescue StandardError => e
227
- handle_exception(e, level: :debug, operation: 'crypt.vault_connected?')
228
- false
207
+ Legion::Settings[:crypt][:vault][:connected] == true
229
208
  end
230
209
 
231
210
  def issue_token(payload = {}, ttl: nil, algorithm: nil)
232
- jwt = jwt_settings
211
+ jwt = Legion::Settings[:crypt][:jwt]
233
212
  algo = algorithm || jwt[:default_algorithm]
234
213
  token_ttl = ttl || jwt[:default_ttl]
214
+ signing_key = algo == 'RS256' ? private_key : Legion::Settings[:crypt][:cluster_secret]
235
215
 
236
- signing_key = algo == 'RS256' ? private_key : settings[:cluster_secret]
237
-
238
- Legion::Crypt::JWT.issue(payload, signing_key: signing_key, algorithm: algo, ttl: token_ttl,
239
- issuer: jwt[:issuer])
216
+ Legion::Crypt::JWT.issue(payload, signing_key: signing_key, algorithm: algo, ttl: token_ttl, issuer: jwt[:issuer])
240
217
  end
241
218
 
242
219
  def verify_token(token, algorithm: nil)
243
- jwt = jwt_settings
220
+ jwt = Legion::Settings[:crypt][:jwt]
244
221
  algo = algorithm || jwt[:default_algorithm]
245
222
 
246
- verification_key = algo == 'RS256' ? OpenSSL::PKey::RSA.new(public_key) : settings[:cluster_secret]
223
+ verification_key = algo == 'RS256' ? OpenSSL::PKey::RSA.new(public_key) : Legion::Settings[:crypt][:cluster_secret]
247
224
 
248
225
  Legion::Crypt::JWT.verify(token, verification_key: verification_key, algorithm: algo,
249
- verify_expiration: jwt[:verify_expiration],
250
- verify_issuer: jwt[:verify_issuer],
251
- issuer: jwt[:issuer])
226
+ verify_expiration: jwt[:verify_expiration],
227
+ verify_issuer: jwt[:verify_issuer],
228
+ issuer: jwt[:issuer])
252
229
  end
253
230
 
254
231
  def verify_external_token(token, jwks_url:, **)
@@ -265,7 +242,7 @@ module Legion
265
242
  @started = false
266
243
  true
267
244
  end
268
- deadline = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC) + Legion::Crypt::VaultOperation::SHUTDOWN_TIMEOUT
245
+ deadline = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC) + Legion::Crypt::Vault::Operation::SHUTDOWN_TIMEOUT
269
246
  manager = Legion::Crypt::LeaseManager.instance
270
247
  [manager, *(@token_renewers || [])].each do |worker|
271
248
  worker.request_stop
@@ -298,9 +275,9 @@ module Legion
298
275
 
299
276
  private
300
277
 
301
- def start_lease_manager
302
- leases = settings.dig(:vault, :leases) || {}
303
- vault_ok = connected_clusters.any? || settings.dig(:vault, :connected)
278
+ def start_lease_manager(mode: nil)
279
+ leases = postgresql_leases_for_mode(leases: Legion::Settings[:crypt][:vault][:leases], mode: mode)
280
+ vault_ok = connected_clusters.any? || Legion::Settings[:crypt][:vault][:connected]
304
281
 
305
282
  return if leases.empty? && !dynamic_rmq_creds?
306
283
  return unless vault_ok
@@ -310,7 +287,7 @@ module Legion
310
287
  if connected_clusters.any?
311
288
  selected_cluster = selected_connected_cluster_name
312
289
  client = selected_cluster ? vault_client(selected_cluster) : nil
313
- elsif settings.dig(:vault, :connected)
290
+ elsif Legion::Settings[:crypt][:vault][:connected]
314
291
  client = vault_client
315
292
  end
316
293
 
@@ -327,13 +304,25 @@ module Legion
327
304
  log.warn "LeaseManager: #{fetched}/#{defined} lease(s) initialized (#{defined - fetched} failed)"
328
305
  end
329
306
  end
330
- rescue StandardError => e
307
+ rescue IOError, SystemCallError, Timeout::Error, Faraday::Error, Legion::Crypt::Vault::HTTPError => e
331
308
  handle_exception(e, level: :warn, operation: 'crypt.start_lease_manager')
332
309
  end
333
310
 
311
+ def postgresql_leases_for_mode(leases:, mode:)
312
+ role = POSTGRES_ROLE_MAP[mode]
313
+ return leases unless role
314
+
315
+ postgresql_key = leases.key?(:postgresql) ? :postgresql : 'postgresql'
316
+ definition = leases[postgresql_key]
317
+ return leases unless definition.is_a?(Hash)
318
+
319
+ path_key = definition.key?(:path) ? :path : 'path'
320
+ leases.merge(postgresql_key => definition.merge(path_key => "postgresql/creds/#{role}"))
321
+ end
322
+
334
323
  def start_token_renewers
335
324
  started = 0
336
- configurations = clusters.empty? ? { nil => vault_settings } : clusters
325
+ configurations = clusters.empty? ? { nil => Legion::Settings[:crypt][:vault] } : clusters
337
326
  configurations.each do |name, config|
338
327
  next unless %w[kerberos ldap jwt].include?(config[:auth_method].to_s) && config[:connected]
339
328
 
@@ -364,19 +353,19 @@ module Legion
364
353
  end
365
354
 
366
355
  def start_svid_rotation
367
- return unless Spiffe.enabled?
356
+ return unless Legion::Crypt::Spiffe.enabled?
368
357
 
369
358
  log.info 'Legion::Crypt starting SPIFFE SVID rotation'
370
- @svid_rotation = Spiffe::SvidRotation.new
359
+ @svid_rotation = Legion::Crypt::Spiffe::SvidRotation.new
371
360
  @svid_rotation.start
372
- rescue StandardError => e
361
+ rescue IOError, SystemCallError, Timeout::Error, Legion::Crypt::Spiffe::Error => e
373
362
  handle_exception(e, level: :warn, operation: 'crypt.start_svid_rotation')
374
363
  end
375
364
 
376
365
  def stop_svid_rotation(deadline: nil)
377
366
  return unless @svid_rotation
378
367
 
379
- Legion::Crypt::VaultOperation.with_timeout(deadline: deadline) { @svid_rotation.stop }
368
+ Legion::Crypt::Vault::Operation.with_timeout(deadline: deadline) { @svid_rotation.stop }
380
369
  ensure
381
370
  @svid_rotation = nil
382
371
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: legion-crypt
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.5.37
4
+ version: 1.5.42
5
5
  platform: ruby
6
6
  authors:
7
7
  - Esity
@@ -93,6 +93,20 @@ dependencies:
93
93
  - - ">="
94
94
  - !ruby/object:Gem::Version
95
95
  version: 1.5.0
96
+ - !ruby/object:Gem::Dependency
97
+ name: legion-settings
98
+ requirement: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - ">="
101
+ - !ruby/object:Gem::Version
102
+ version: 1.4.2
103
+ type: :runtime
104
+ prerelease: false
105
+ version_requirements: !ruby/object:Gem::Requirement
106
+ requirements:
107
+ - - ">="
108
+ - !ruby/object:Gem::Version
109
+ version: 1.4.2
96
110
  description: A gem used by the LegionIO framework for encryption
97
111
  email:
98
112
  - matthewdiverson@gmail.com
@@ -108,6 +122,7 @@ files:
108
122
  - ".github/workflows/ci.yml"
109
123
  - ".gitignore"
110
124
  - ".pre-commit-config.yaml"
125
+ - ".rspec"
111
126
  - ".rubocop.yml"
112
127
  - AGENTS.md
113
128
  - CHANGELOG.md
@@ -141,13 +156,13 @@ files:
141
156
  - lib/legion/crypt/tls.rb
142
157
  - lib/legion/crypt/token_renewer.rb
143
158
  - lib/legion/crypt/vault.rb
144
- - lib/legion/crypt/vault_client.rb
145
- - lib/legion/crypt/vault_cluster.rb
146
- - lib/legion/crypt/vault_entity.rb
147
- - lib/legion/crypt/vault_jwt_auth.rb
148
- - lib/legion/crypt/vault_kerberos_auth.rb
149
- - lib/legion/crypt/vault_operation.rb
150
- - lib/legion/crypt/vault_renewer.rb
159
+ - lib/legion/crypt/vault/client.rb
160
+ - lib/legion/crypt/vault/cluster.rb
161
+ - lib/legion/crypt/vault/entity.rb
162
+ - lib/legion/crypt/vault/jwt_auth.rb
163
+ - lib/legion/crypt/vault/kerberos_auth.rb
164
+ - lib/legion/crypt/vault/operation.rb
165
+ - lib/legion/crypt/vault/renewer.rb
151
166
  - lib/legion/crypt/version.rb
152
167
  - scripts/pre-commit-rubocop.sh
153
168
  - sonar-project.properties