Class: ConcealedString

Inherits:
Object
  • Object
show all
Defined in:
lib/familia/features/encrypted_fields/concealed_string.rb

Overview

ConcealedString

A secure wrapper for encrypted field values that prevents accidental plaintext leakage through serialization, logging, or debugging.

Unlike RedactedString (which wraps plaintext), ConcealedString wraps encrypted data and provides controlled decryption through the .reveal API.

Security Model: - Contains encrypted JSON data, never plaintext - Requires explicit .reveal { } for decryption and plaintext access - ALL serialization methods return ‘[CONCEALED]’ to prevent leakage - Maintains encryption context for proper AAD handling - Thread-safe and supports concurrent access

Key Security Features: 1. Universal Serialization Safety - ALL to_* methods protected 2. Debugging Safety - inspect, logging, console output shows [CONCEALED] 3. Exception Safety - never leaks plaintext in error messages 4. Future-proof - any new serialization method automatically safe 5. Memory Clearing - best-effort encrypted data clearing

Critical Design Principles: - Secure by default - no auto-decryption anywhere - Explicit decryption - .reveal required for plaintext access - Comprehensive protection - covers ALL serialization paths - Auditable access - easy to grep for .reveal usage

Example Usage: user = User.new user.secret_data = “sensitive info” # Encrypts and wraps user.secret_data # Returns ConcealedString user.secret_data.reveal { |plain| … } # Explicit decryption user.to_h # Safe - contains [CONCEALED] user.to_json # Safe - contains [CONCEALED]

Instance Method Summary collapse

Constructor Details

#initialize(encrypted_data, record, field_type) ⇒ ConcealedString

Create a concealed string wrapper

Parameters:

  • encrypted_data (String) —

    The encrypted JSON data

  • record (Familia::Horreum) —

    The record instance for context

  • field_type (EncryptedFieldType) —

    The field type for decryption



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 46

def initialize(encrypted_data, record, field_type)
  @encrypted_data = encrypted_data.freeze
  @record = record
  @field_type = field_type
  @cleared = false

  # Parse and validate the encrypted data structure
  if @encrypted_data
    begin
      @encrypted_data_obj = Familia::Encryption::EncryptedData.from_json(@encrypted_data)
      # Validate that the encrypted data is decryptable (algorithm supported, etc.)
      @encrypted_data_obj.validate_decryptable!
    rescue Familia::EncryptionError => e
      raise Familia::EncryptionError, e.message
    rescue StandardError => e
      raise Familia::EncryptionError, "Invalid encrypted data: #{e.message}"
    end
  end

  ObjectSpace.define_finalizer(self, self.class.finalizer_proc(@encrypted_data))
end

Instance Method Details

#+(other) ⇒ Object

String concatenation operations return concealed result



199
200
201
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 199

def +(other)
  '[CONCEALED]'
end

#==(other) ⇒ Object Also known as: eql?

Returns true when it’s literally the same object, otherwise false. This prevents timing attacks where an attacker could potentially infer information about the secret value through comparison timing



143
144
145
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 143

def ==(other)
  object_id.equal?(other.object_id) # same object
end

#as_json(*args) ⇒ Object

Prevent exposure in Rails serialization (as_json -> to_json)



274
275
276
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 274

def as_json(*args)
  '[CONCEALED]'
end

#belongs_to_context?(expected_record, expected_field_name) ⇒ Boolean

Validate that this ConcealedString belongs to the given record context

This prevents cross-context attacks where encrypted data is moved between different records or field contexts. While moving ConcealedString objects manually is not a normal use case, this provides defense in depth.

Parameters:

  • expected_record (Familia::Horreum) —

    The record that should own this data

  • expected_field_name (Symbol) —

    The field name that should own this data

Returns:

  • (Boolean) —

    true if contexts match, false otherwise



105
106
107
108
109
110
111
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 105

def belongs_to_context?(expected_record, expected_field_name)
  return false if @record.nil? || @field_type.nil?

  @record.class.name == expected_record.class.name &&
    @record.identifier == expected_record.identifier &&
    @field_type.instance_variable_get(:@name) == expected_field_name
end

#blank? ⇒ Boolean

Returns:

  • (Boolean) 


194
195
196
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 194

def blank?
  false  # Never blank if encrypted data exists
end

#clear! ⇒ Object

Clear the encrypted data from memory

Safe to call multiple times. This provides best-effort memory clearing within Ruby’s limitations.



118
119
120
121
122
123
124
125
126
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 118

def clear!
  return if @cleared

  @encrypted_data = nil
  @record = nil
  @field_type = nil
  @cleared = true
  freeze
end

#cleared? ⇒ Boolean

Check if the encrypted data has been cleared

Returns:

  • (Boolean) —

    true if cleared, false otherwise



132
133
134
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 132

def cleared?
  @cleared
end

#coerce(other) ⇒ Object

Handle coercion for concatenation like “string” + concealed



208
209
210
211
212
213
214
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 208

def coerce(other)
  if other.is_a?(String)
    ['[CONCEALED]', '[CONCEALED]']
  else
    [other, '[CONCEALED]']
  end
end

#concat(other) ⇒ Object 



203
204
205
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 203

def concat(other)
  '[CONCEALED]'
end

#deconstruct ⇒ Object

Pattern matching safety (Ruby 3.0+)



260
261
262
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 260

def deconstruct
  ['[CONCEALED]']
end

#deconstruct_keys(keys) ⇒ Object 



264
265
266
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 264

def deconstruct_keys(keys)
  { concealed: true }
end

#downcase ⇒ Object 



178
179
180
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 178

def downcase
  '[CONCEALED]'
end

#each {|'[CONCEALED]'| ... } ⇒ Object

Yields:

  • ('[CONCEALED]') 


235
236
237
238
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 235

def each
  yield '[CONCEALED]' if block_given?
  self
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


136
137
138
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 136

def empty?
  @encrypted_data.to_s.empty?
end

#encrypted_value ⇒ String?

Access the encrypted data for database storage

This method is used internally by the field type system for persisting the encrypted data to the database.

Returns:

  • (String, nil) —

    The encrypted JSON data



155
156
157
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 155

def encrypted_value
  @encrypted_data
end

#gsub(*args) ⇒ Object 



221
222
223
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 221

def gsub(*args)
  '[CONCEALED]'
end

#hash ⇒ Object

Consistent hash to prevent timing attacks



255
256
257
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 255

def hash
  ConcealedString.hash
end

#include?(substring) ⇒ Boolean

Returns:

  • (Boolean) 


225
226
227
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 225

def include?(substring)
  false  # Never reveal substring presence
end

#inspect ⇒ Object

Safe representation for debugging and console output



241
242
243
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 241

def inspect
  '[CONCEALED]'
end

#length ⇒ Object 



182
183
184
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 182

def length
  11  # Fixed concealed length to match '[CONCEALED]' length
end

#map {|'[CONCEALED]'| ... } ⇒ Object

Enumerable methods for safety

Yields:

  • ('[CONCEALED]') 


230
231
232
233
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 230

def map
  yield '[CONCEALED]' if block_given?
  ['[CONCEALED]']
end

#present? ⇒ Boolean

Returns:

  • (Boolean) 


190
191
192
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 190

def present?
  true  # Always return true since encrypted data exists
end

#reveal {|String| ... } ⇒ Object

Primary API: reveal the decrypted plaintext in a controlled block

This is the ONLY way to access plaintext from encrypted fields. The plaintext is decrypted fresh each time using the current record state and AAD context.

Security Warning: Avoid operations inside the block that create uncontrolled copies of the plaintext (dup, interpolation, etc.)

Example: user.api_token.reveal do |token| HTTP.post(‘/api’, headers: { ‘X-Token’ => token }) end

Yields:

  • (String) —

    The decrypted plaintext value

Returns:

  • (Object) —

    The return value of the block

Raises:

  • (ArgumentError) 


85
86
87
88
89
90
91
92
93
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 85

def reveal
  raise ArgumentError, 'Block required for reveal' unless block_given?
  raise SecurityError, 'Encrypted data already cleared' if cleared?
  raise SecurityError, 'No encrypted data to reveal' if @encrypted_data.nil?

  # Decrypt using current record context and AAD
  plaintext = @field_type.decrypt_value(@record, @encrypted_data)
  yield plaintext
end

#size ⇒ Object 



186
187
188
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 186

def size
  length
end

#strip ⇒ Object

String pattern matching methods



217
218
219
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 217

def strip
  '[CONCEALED]'
end

#to_a ⇒ Object 



250
251
252
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 250

def to_a
  ['[CONCEALED]']
end

#to_h ⇒ Object

Hash/Array serialization safety



246
247
248
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 246

def to_h
  '[CONCEALED]'
end

#to_json(*args) ⇒ Object

Prevent exposure in JSON serialization



269
270
271
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 269

def to_json(*args)
  '"[CONCEALED]"'
end

#to_s ⇒ Object

Prevent accidental exposure through string conversion and serialization

Ruby has two string conversion methods with different purposes: - to_s: explicit conversion (obj.to_s, string interpolation “#obj”) - to_str: implicit coercion (File.read(obj), “prefix” + obj)

We implement to_s for safe logging/debugging but deliberately omit to_str to prevent encrypted data from being used where strings are expected.



168
169
170
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 168

def to_s
  '[CONCEALED]'
end

#upcase ⇒ Object

String methods that should return safe concealed values



174
175
176
 
# File 'lib/familia/features/encrypted_fields/concealed_string.rb', line 174

def upcase
  '[CONCEALED]'
end