Class: Neb::Key
- Inherits:
-
Object
- Object
- Neb::Key
- Defined in:
- lib/neb/key.rb
Constant Summary collapse
- KDF =
"scrypt".freeze
- CIPHER_NAME =
"aes-128-ctr".freeze
- MACHASH =
"sha3256".freeze
- KDF_N =
1 << 12
- KDF_R =
8
- KDF_P =
1
- DKLEN =
32
- KEY_CURRENT_VERSION =
4
- KEY_VERSION_3 =
3
Instance Attribute Summary collapse
-
#address ⇒ Object
Returns the value of attribute address.
-
#iv ⇒ Object
Returns the value of attribute iv.
-
#mac ⇒ Object
Returns the value of attribute mac.
-
#password ⇒ Object
Returns the value of attribute password.
-
#private_key ⇒ Object
Returns the value of attribute private_key.
-
#salt ⇒ Object
Returns the value of attribute salt.
Class Method Summary collapse
- .convert_iv(iv) ⇒ Object
- .convert_salt(salt) ⇒ Object
- .decrypt(key_data, password) ⇒ Object
- .encrypt(address, private_key, password) ⇒ Object
- .validate?(key_data) ⇒ Boolean
Instance Method Summary collapse
- #encrypt ⇒ Object
-
#initialize(address: nil, private_key: nil, password: nil, salt: nil, iv: nil) ⇒ Key
constructor
A new instance of Key.
Constructor Details
#initialize(address: nil, private_key: nil, password: nil, salt: nil, iv: nil) ⇒ Key
Returns a new instance of Key.
20 21 22 23 24 25 26 |
# File 'lib/neb/key.rb', line 20 def initialize(address: nil, private_key: nil, password: nil, salt: nil, iv: nil) @address = Address.new(address) if address @private_key = PrivateKey.new(private_key) if private_key @password = password @salt = self.class.convert_salt(salt || Utils.random_bytes(32)) @iv = self.class.convert_iv(iv || Utils.random_bytes(16)) end |
Instance Attribute Details
#address ⇒ Object
Returns the value of attribute address.
18 19 20 |
# File 'lib/neb/key.rb', line 18 def address @address end |
#iv ⇒ Object
Returns the value of attribute iv.
18 19 20 |
# File 'lib/neb/key.rb', line 18 def iv @iv end |
#mac ⇒ Object
Returns the value of attribute mac.
18 19 20 |
# File 'lib/neb/key.rb', line 18 def mac @mac end |
#password ⇒ Object
Returns the value of attribute password.
18 19 20 |
# File 'lib/neb/key.rb', line 18 def password @password end |
#private_key ⇒ Object
Returns the value of attribute private_key.
18 19 20 |
# File 'lib/neb/key.rb', line 18 def private_key @private_key end |
#salt ⇒ Object
Returns the value of attribute salt.
18 19 20 |
# File 'lib/neb/key.rb', line 18 def salt @salt end |
Class Method Details
.convert_iv(iv) ⇒ Object
125 126 127 128 129 130 |
# File 'lib/neb/key.rb', line 125 def convert_iv(iv) return iv if iv.length == 16 return Utils.hex_to_bin(iv) if iv.length == 32 raise ArgumentError.new("iv must be 16 bytes") end |
.convert_salt(salt) ⇒ Object
118 119 120 121 122 123 |
# File 'lib/neb/key.rb', line 118 def convert_salt(salt) return salt if salt.length == 32 return Utils.hex_to_bin(salt) if salt.length == 64 raise ArgumentError.new("salt must be 32 bytes") end |
.decrypt(key_data, password) ⇒ Object
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/neb/key.rb', line 63 def decrypt(key_data, password) key_data = Utils.from_json(key_data) if key_data.is_a?(String) key_data = key_data.deep_symbolize_keys! raise InvalidJSONKeyError("key data validate failed") if !validate?(key_data) version = key_data[:version] address = key_data[:address] crypto = key_data[:crypto] cipher = crypto[:cipher] salt = convert_salt(crypto[:kdfparams][:salt]) dklen = crypto[:kdfparams][:dklen] kdf_n = crypto[:kdfparams][:n] kdf_r = crypto[:kdfparams][:r] kdf_p = crypto[:kdfparams][:p] iv = convert_iv(crypto[:cipherparams][:iv]) derived_key = Utils.scrypt(password, salt, kdf_n, kdf_r, kdf_p, dklen) ciphertext_bin = Utils.hex_to_bin(crypto[:ciphertext]) if version == KEY_CURRENT_VERSION mac = Utils.keccak256([derived_key[16, 16], ciphertext_bin, iv, cipher].join) else mac = Utils.keccak256([derived_key[16, 16], ciphertext_bin].join) # KeyVersion3 end raise InvalidJSONKeyError.new("mac is wrong") if Utils.bin_to_hex(mac) != crypto[:mac] private_key = Utils.aes_decrypt(ciphertext_bin, derived_key[0, 16], iv) Utils.bin_to_hex(private_key) end |
.encrypt(address, private_key, password) ⇒ Object
59 60 61 |
# File 'lib/neb/key.rb', line 59 def encrypt(address, private_key, password) new(address: address, private_key: private_key, password: password).encrypt end |
.validate?(key_data) ⇒ Boolean
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
# File 'lib/neb/key.rb', line 96 def validate?(key_data) key_data = Utils.from_json(key_data) if key_data.is_a?(String) [:version, :id, :address, :crypto].each do |k| return false if !key_data.keys.include?(k) end return false if key_data[:version] != KEY_CURRENT_VERSION && key_data[:version] != KEY_VERSION_3 [:ciphertext, :cipherparams, :cipher, :kdf, :kdfparams, :mac, :machash].each do |k| return false if !key_data[:crypto].keys.include?(k) end return false if !key_data[:crypto][:cipherparams].keys.include?(:iv) [:dklen, :salt, :n, :r, :p].each do |k| return false if !key_data[:crypto][:kdfparams].keys.include?(k) end true end |
Instance Method Details
#encrypt ⇒ Object
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
# File 'lib/neb/key.rb', line 28 def encrypt derived_key = Utils.scrypt(password, salt, KDF_N, KDF_R, KDF_P, DKLEN) ciphertext_bin = Utils.aes_encrypt(private_key.encode(:bin), derived_key[0, 16], iv) mac_bin = Utils.keccak256([derived_key[16, 16], ciphertext_bin, iv, CIPHER_NAME].join) { version: KEY_CURRENT_VERSION, id: Utils.uuid, address: address.to_s, crypto: { ciphertext: Utils.bin_to_hex(ciphertext_bin), cipherparams: { iv: Utils.bin_to_hex(iv) }, cipher: CIPHER_NAME, kdf: KDF, kdfparams: { dklen: DKLEN, salt: Utils.bin_to_hex(salt), n: KDF_N, r: KDF_R, p: KDF_P }, mac: Utils.bin_to_hex(mac_bin), machash: MACHASH } } end |