Class: Familia::Encryption::Provider

Inherits:
Object
  • Object
show all
Defined in:
lib/familia/encryption/provider.rb

Overview

Base provider class - similar to FieldType pattern

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Provider

Returns a new instance of Provider.



9
10
11
12
13
 
# File 'lib/familia/encryption/provider.rb', line 9

def initialize
  @algorithm = self.class::ALGORITHM
  @nonce_size = self.class::NONCE_SIZE
  @auth_tag_size = self.class::AUTH_TAG_SIZE
end

Instance Attribute Details

#algorithm ⇒ Object (readonly)

Returns the value of attribute algorithm.



7
8
9
 
# File 'lib/familia/encryption/provider.rb', line 7

def algorithm
  @algorithm
end

#auth_tag_size ⇒ Object (readonly)

Returns the value of attribute auth_tag_size.



7
8
9
 
# File 'lib/familia/encryption/provider.rb', line 7

def auth_tag_size
  @auth_tag_size
end

#nonce_size ⇒ Object (readonly)

Returns the value of attribute nonce_size.



7
8
9
 
# File 'lib/familia/encryption/provider.rb', line 7

def nonce_size
  @nonce_size
end

Class Method Details

.available? ⇒ Boolean

Check if this provider is available

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


39
40
41
 
# File 'lib/familia/encryption/provider.rb', line 39

def self.available?
  raise NotImplementedError
end

.priority ⇒ Object

Priority for automatic selection (higher = preferred)



44
45
46
 
# File 'lib/familia/encryption/provider.rb', line 44

def self.priority
  0
end

Instance Method Details

#decrypt(ciphertext, key, nonce, auth_tag, additional_data = nil) ⇒ Object

Raises:

  • (NotImplementedError) 


20
21
22
 
# File 'lib/familia/encryption/provider.rb', line 20

def decrypt(ciphertext, key, nonce, auth_tag, additional_data = nil)
  raise NotImplementedError
end

#derive_key(master_key, context) ⇒ Object

Raises:

  • (NotImplementedError) 


28
29
30
 
# File 'lib/familia/encryption/provider.rb', line 28

def derive_key(master_key, context)
  raise NotImplementedError
end

#encrypt(plaintext, key, additional_data = nil) ⇒ Object

Public interface methods that subclasses must implement

Raises:

  • (NotImplementedError) 


16
17
18
 
# File 'lib/familia/encryption/provider.rb', line 16

def encrypt(plaintext, key, additional_data = nil)
  raise NotImplementedError
end

#generate_nonce ⇒ Object

Raises:

  • (NotImplementedError) 


24
25
26
 
# File 'lib/familia/encryption/provider.rb', line 24

def generate_nonce
  raise NotImplementedError
end

#secure_wipe(key) ⇒ Object

Clear key from memory (best effort, no security guarantees) Ruby provides no reliable way to securely wipe memory



34
35
36
 
# File 'lib/familia/encryption/provider.rb', line 34

def secure_wipe(key)
  key&.clear if key.respond_to?(:clear)
end