Module: Quickjs::SubtleCrypto

Defined in:
lib/quickjs/subtle_crypto.rb

Constant Summary collapse

DIGEST_ALGORITHMS = 
{
  "SHA-1"   => "SHA1",
  "SHA-256" => "SHA256",
  "SHA-384" => "SHA384",
  "SHA-512" => "SHA512",
}.freeze
AES_ALGORITHMS = 
%w[AES-GCM AES-CBC AES-CTR AES-KW].freeze
AES_VALID_LENGTHS = 
[128, 192, 256].freeze
HMAC_HASH_OUTPUT_LENGTHS = 
{
  "SHA-1" => 160, "SHA-256" => 256, "SHA-384" => 384, "SHA-512" => 512,
}.freeze
EC_CURVE_MAP = 
{
  "P-256" => "prime256v1",
  "P-384" => "secp384r1",
  "P-521" => "secp521r1",
}.freeze
EC_COORD_SIZES = 
{
  "P-256" => 32, "P-384" => 48, "P-521" => 66,
}.freeze
RSA_ALGORITHMS = 
%w[RSASSA-PKCS1-v1_5 RSA-PSS RSA-OAEP].freeze
ECDSA_ALGORITHMS = 
%w[ECDSA].freeze
ECDH_ALGORITHMS = 
%w[ECDH X25519].freeze
KDF_ALGORITHMS = 
%w[PBKDF2 HKDF].freeze

Class Method Summary collapse

Class Method Details

.decrypt(name, key, data, params = {}) ⇒ Object 



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/quickjs/subtle_crypto.rb', line 223

def self.decrypt(name, key, data, params = {})
  case name
  when "AES-GCM"
    aes_gcm_decrypt(key, data, params)
  when "AES-CBC"
    aes_cbc_crypt(key, data, params, :decrypt)
  when "AES-CTR"
    aes_ctr_crypt(key, data, params, :decrypt)
  when "AES-KW"
    aes_kw_crypt(key, data, :decrypt)
  when "RSA-OAEP"
    rsa_oaep_crypt(key, data, params, :decrypt)
  else
    raise ArgumentError, "SubtleCrypto: unsupported decrypt algorithm '#{name}'"
  end
end

.derive_bits(name, key, length_bits, params = {}) ⇒ Object 



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/quickjs/subtle_crypto.rb', line 300

def self.derive_bits(name, key, length_bits, params = {})
  case name
  when "PBKDF2"
    hash_name = ossl_digest_name(params[:hash]) or raise ArgumentError, "SubtleCrypto: PBKDF2 requires hash"
    salt = params[:salt] or raise ArgumentError, "SubtleCrypto: PBKDF2 requires salt"
    iterations = params[:iterations] or raise ArgumentError, "SubtleCrypto: PBKDF2 requires iterations"
    OpenSSL::KDF.pbkdf2_hmac(key.key_data, salt: salt, iterations: iterations, length: length_bits / 8, hash: hash_name)
  when "HKDF"
    hash_name = ossl_digest_name(params[:hash]) or raise ArgumentError, "SubtleCrypto: HKDF requires hash"
    salt = params[:salt] || ""
    info = params[:info] || ""
    OpenSSL::KDF.hkdf(key.key_data, salt: salt, info: info, length: length_bits / 8, hash: hash_name)
  when "ECDH"
    peer_key = params[:public] or raise ArgumentError, "SubtleCrypto: ECDH requires public key"
    shared = key.key_data.dh_compute_key(peer_key.key_data.public_key)
    shared.byteslice(0, length_bits / 8)
  when "X25519"
    peer_key = params[:public] or raise ArgumentError, "SubtleCrypto: X25519 requires public key"
    shared = key.key_data.derive(peer_key.key_data)
    shared.byteslice(0, length_bits / 8)
  else
    raise ArgumentError, "SubtleCrypto: unsupported deriveBits algorithm '#{name}'"
  end
end

.derive_key(name, key, derived_algo, extractable, usages, params = {}) ⇒ Object 



325
326
327
328
329
330
331
332
333
334
 
# File 'lib/quickjs/subtle_crypto.rb', line 325

def self.derive_key(name, key, derived_algo, extractable, usages, params = {})
  derived_name = derived_algo[:name] or raise ArgumentError, "SubtleCrypto: derived key algorithm name is required"
  derived_length = case derived_name
                   when *AES_ALGORITHMS then derived_algo[:length] or raise ArgumentError, "SubtleCrypto: derived AES key requires length"
                   when "HMAC" then derived_algo[:length] || HMAC_HASH_OUTPUT_LENGTHS[derived_algo[:hash]]
                   else raise ArgumentError, "SubtleCrypto: unsupported derived key algorithm '#{derived_name}'"
                   end
  key_bytes = derive_bits(name, key, derived_length, params)
  import_key("raw", key_bytes, derived_algo, extractable, usages)
end

.digest(algorithm_name, data) ⇒ Object 



36
37
38
39
40
 
# File 'lib/quickjs/subtle_crypto.rb', line 36

def self.digest(algorithm_name, data)
  ossl_name = DIGEST_ALGORITHMS[algorithm_name] or
    raise ArgumentError, "SubtleCrypto: unsupported digest algorithm '#{algorithm_name}'"
  OpenSSL::Digest.digest(ossl_name, data)
end

.encrypt(name, key, data, params = {}) ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/quickjs/subtle_crypto.rb', line 206

def self.encrypt(name, key, data, params = {})
  case name
  when "AES-GCM"
    aes_gcm_encrypt(key, data, params)
  when "AES-CBC"
    aes_cbc_crypt(key, data, params, :encrypt)
  when "AES-CTR"
    aes_ctr_crypt(key, data, params, :encrypt)
  when "AES-KW"
    aes_kw_crypt(key, data, :encrypt)
  when "RSA-OAEP"
    rsa_oaep_crypt(key, data, params, :encrypt)
  else
    raise ArgumentError, "SubtleCrypto: unsupported encrypt algorithm '#{name}'"
  end
end

.export_key(format, key) ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/quickjs/subtle_crypto.rb', line 170

def self.export_key(format, key)
  name = key.algorithm["name"]
  case format
  when "raw"
    raise ArgumentError, "SubtleCrypto: key is not extractable" unless key.extractable
    case name
    when *AES_ALGORITHMS, "HMAC"
      key.key_data
    when "ECDSA", "ECDH"
      raise ArgumentError, "SubtleCrypto: raw export only for public EC keys" unless key.type == "public"
      key.key_data.public_to_der.then { |spki_der| ec_spki_to_raw(spki_der) }
    when "Ed25519", "X25519"
      raise ArgumentError, "SubtleCrypto: raw export only for public OKP keys" unless key.type == "public"
      if key.key_data.respond_to?(:raw_public_key)
        key.key_data.raw_public_key
      else
        # raw_public_key added in openssl gem 3.2.0 (Ruby 3.3): https://github.com/ruby/openssl/blob/master/History.md
        # Ed25519/X25519 SPKI DER is 44 bytes with the 32-byte key at the end
        key.key_data.public_to_der[-32..]
      end
    else
      raise ArgumentError, "SubtleCrypto: raw export not supported for '#{name}'"
    end
  when "spki"
    raise ArgumentError, "SubtleCrypto: key is not extractable" unless key.extractable
    raise ArgumentError, "SubtleCrypto: spki export requires public key" unless key.type == "public"
    key.key_data.public_to_der
  when "pkcs8"
    raise ArgumentError, "SubtleCrypto: key is not extractable" unless key.extractable
    raise ArgumentError, "SubtleCrypto: pkcs8 export requires private key" unless key.type == "private"
    key.key_data.private_to_der
  else
    raise ArgumentError, "SubtleCrypto: unsupported exportKey format '#{format}'"
  end
end

.generate_key(algo, extractable, usages) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
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
95
 
# File 'lib/quickjs/subtle_crypto.rb', line 42

def self.generate_key(algo, extractable, usages)
  name = algo[:name] or raise ArgumentError, "SubtleCrypto: algorithm name is required"
  case name
  when *AES_ALGORITHMS
    length = algo[:length] or raise ArgumentError, "SubtleCrypto: AES key requires length"
    raise ArgumentError, "SubtleCrypto: invalid AES key length #{length}" unless AES_VALID_LENGTHS.include?(length)
    key_data = OpenSSL::Random.random_bytes(length / 8)
    Quickjs::CryptoKey.new("secret", extractable, { "name" => name, "length" => length }, usages, key_data)
  when "HMAC"
    hash = algo[:hash] or raise ArgumentError, "SubtleCrypto: HMAC requires hash"
    length = algo[:length] || HMAC_HASH_OUTPUT_LENGTHS[hash] or
      raise ArgumentError, "SubtleCrypto: unsupported HMAC hash '#{hash}'"
    key_data = OpenSSL::Random.random_bytes(length / 8)
    Quickjs::CryptoKey.new("secret", extractable, { "name" => "HMAC", "hash" => hash, "length" => length }, usages, key_data)
  when *RSA_ALGORITHMS
    modulus_length = algo[:modulus_length] or raise ArgumentError, "SubtleCrypto: RSA key requires modulusLength"
    public_exponent_bytes = algo[:public_exponent] or raise ArgumentError, "SubtleCrypto: RSA key requires publicExponent"
    hash = algo[:hash] or raise ArgumentError, "SubtleCrypto: RSA key requires hash"
    exponent = public_exponent_bytes.bytes.reduce(0) { |acc, b| (acc << 8) | b }
    pkey = OpenSSL::PKey::RSA.generate(modulus_length, exponent)
    algo_hash = { "name" => name, "modulusLength" => modulus_length, "publicExponent" => public_exponent_bytes, "hash" => hash }
    {
      private_key: Quickjs::CryptoKey.new("private", extractable, algo_hash, usages.select { |u| %w[sign decrypt unwrapKey].include?(u) }, pkey),
      public_key: Quickjs::CryptoKey.new("public", true, algo_hash, usages.select { |u| %w[verify encrypt wrapKey].include?(u) }, pkey),
    }
  when "ECDSA", "ECDH"
    named_curve = algo[:named_curve] or raise ArgumentError, "SubtleCrypto: EC key requires namedCurve"
    ossl_curve = EC_CURVE_MAP[named_curve] or raise ArgumentError, "SubtleCrypto: unsupported curve '#{named_curve}'"
    pkey = OpenSSL::PKey::EC.generate(ossl_curve)
    algo_hash = { "name" => name, "namedCurve" => named_curve }
    private_usages = name == "ECDSA" ? %w[sign] : %w[deriveKey deriveBits]
    public_usages = name == "ECDSA" ? %w[verify] : []
    {
      private_key: Quickjs::CryptoKey.new("private", extractable, algo_hash, usages.select { |u| private_usages.include?(u) }, pkey),
      public_key: Quickjs::CryptoKey.new("public", true, algo_hash, usages.select { |u| public_usages.include?(u) }, pkey),
    }
  when "Ed25519"
    pkey = OpenSSL::PKey.generate_key("ED25519")
    algo_hash = { "name" => "Ed25519" }
    {
      private_key: Quickjs::CryptoKey.new("private", extractable, algo_hash, usages.select { |u| u == "sign" }, pkey),
      public_key: Quickjs::CryptoKey.new("public", true, algo_hash, usages.select { |u| u == "verify" }, pkey),
    }
  when "X25519"
    pkey = OpenSSL::PKey.generate_key("X25519")
    algo_hash = { "name" => "X25519" }
    {
      private_key: Quickjs::CryptoKey.new("private", extractable, algo_hash, usages.select { |u| %w[deriveKey deriveBits].include?(u) }, pkey),
      public_key: Quickjs::CryptoKey.new("public", true, algo_hash, [], pkey),
    }
  else
    raise ArgumentError, "SubtleCrypto: unsupported generateKey algorithm '#{name}'"
  end
end

.import_key(format, key_data, algo, extractable, usages) ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/quickjs/subtle_crypto.rb', line 97

def self.import_key(format, key_data, algo, extractable, usages)
  name = algo[:name] or raise ArgumentError, "SubtleCrypto: algorithm name is required"
  case format
  when "raw"
    case name
    when *AES_ALGORITHMS
      length = key_data.bytesize * 8
      raise ArgumentError, "SubtleCrypto: invalid AES key length #{length}" unless AES_VALID_LENGTHS.include?(length)
      Quickjs::CryptoKey.new("secret", extractable, { "name" => name, "length" => length }, usages, key_data)
    when "HMAC"
      hash = algo[:hash] or raise ArgumentError, "SubtleCrypto: HMAC requires hash"
      length = key_data.bytesize * 8
      Quickjs::CryptoKey.new("secret", extractable, { "name" => "HMAC", "hash" => hash, "length" => length }, usages, key_data)
    when "PBKDF2"
      Quickjs::CryptoKey.new("secret", false, { "name" => "PBKDF2" }, usages, key_data)
    when "HKDF"
      Quickjs::CryptoKey.new("secret", false, { "name" => "HKDF" }, usages, key_data)
    when "ECDSA", "ECDH"
      named_curve = algo[:named_curve] or raise ArgumentError, "SubtleCrypto: EC import requires namedCurve"
      pkey = import_raw_ec_public(key_data, named_curve)
      Quickjs::CryptoKey.new("public", extractable, { "name" => name, "namedCurve" => named_curve }, usages, pkey)
    when "Ed25519"
      pkey = import_raw_okp_public(key_data, "ED25519")
      Quickjs::CryptoKey.new("public", extractable, { "name" => "Ed25519" }, usages, pkey)
    when "X25519"
      pkey = import_raw_okp_public(key_data, "X25519")
      Quickjs::CryptoKey.new("public", extractable, { "name" => "X25519" }, usages, pkey)
    else
      raise ArgumentError, "SubtleCrypto: unsupported raw importKey algorithm '#{name}'"
    end
  when "spki"
    pkey = OpenSSL::PKey.read(key_data)
    case name
    when *RSA_ALGORITHMS
      rsa = pkey.is_a?(OpenSSL::PKey::RSA) ? pkey : raise(ArgumentError, "SubtleCrypto: key is not RSA")
      hash = algo[:hash] or raise ArgumentError, "SubtleCrypto: RSA import requires hash"
      pub_exp_bytes = [rsa.e.to_s(16)].pack("H*")
      algo_hash = { "name" => name, "modulusLength" => rsa.n.num_bits, "publicExponent" => pub_exp_bytes, "hash" => hash }
      Quickjs::CryptoKey.new("public", extractable, algo_hash, usages, pkey)
    when "ECDSA", "ECDH"
      named_curve = algo[:named_curve] or raise ArgumentError, "SubtleCrypto: EC import requires namedCurve"
      Quickjs::CryptoKey.new("public", extractable, { "name" => name, "namedCurve" => named_curve }, usages, pkey)
    when "Ed25519"
      Quickjs::CryptoKey.new("public", extractable, { "name" => "Ed25519" }, usages, pkey)
    when "X25519"
      Quickjs::CryptoKey.new("public", extractable, { "name" => "X25519" }, usages, pkey)
    else
      raise ArgumentError, "SubtleCrypto: unsupported spki importKey algorithm '#{name}'"
    end
  when "pkcs8"
    pkey = OpenSSL::PKey.read(key_data)
    case name
    when *RSA_ALGORITHMS
      hash = algo[:hash] or raise ArgumentError, "SubtleCrypto: RSA import requires hash"
      rsa = pkey.is_a?(OpenSSL::PKey::RSA) ? pkey : raise(ArgumentError, "SubtleCrypto: key is not RSA")
      pub_exp_bytes = [rsa.e.to_s(16)].pack("H*")
      algo_hash = { "name" => name, "modulusLength" => rsa.n.num_bits, "publicExponent" => pub_exp_bytes, "hash" => hash }
      Quickjs::CryptoKey.new("private", extractable, algo_hash, usages, pkey)
    when "ECDSA", "ECDH"
      named_curve = algo[:named_curve] or raise ArgumentError, "SubtleCrypto: EC import requires namedCurve"
      Quickjs::CryptoKey.new("private", extractable, { "name" => name, "namedCurve" => named_curve }, usages, pkey)
    when "Ed25519"
      Quickjs::CryptoKey.new("private", extractable, { "name" => "Ed25519" }, usages, pkey)
    when "X25519"
      Quickjs::CryptoKey.new("private", extractable, { "name" => "X25519" }, usages, pkey)
    else
      raise ArgumentError, "SubtleCrypto: unsupported pkcs8 importKey algorithm '#{name}'"
    end
  else
    raise ArgumentError, "SubtleCrypto: unsupported importKey format '#{format}'"
  end
end

.sign(name, key, data, params = {}) ⇒ Object 



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/quickjs/subtle_crypto.rb', line 240

def self.sign(name, key, data, params = {})
  case name
  when "HMAC"
    hash_name = ossl_digest_name(key.algorithm["hash"])
    OpenSSL::HMAC.digest(hash_name, key.key_data, data)
  when "RSASSA-PKCS1-v1_5"
    hash_name = ossl_digest_name(key.algorithm["hash"])
    key.key_data.sign(hash_name, data)
  when "RSA-PSS"
    hash_name = ossl_digest_name(key.algorithm["hash"])
    salt_length = params[:salt_length] || :digest
    key.key_data.sign_pss(hash_name, data, salt_length: salt_length, mgf1_hash: hash_name)
  when "ECDSA"
    hash_name = ossl_digest_name(params[:hash] || key.algorithm["hash"])
    named_curve = key.algorithm["namedCurve"]
    coord_size = EC_COORD_SIZES[named_curve] or raise ArgumentError, "SubtleCrypto: unsupported curve '#{named_curve}'"
    der_sig = key.key_data.sign(hash_name, data)
    der_to_p1363(der_sig, coord_size)
  when "Ed25519"
    key.key_data.sign(nil, data)
  else
    raise ArgumentError, "SubtleCrypto: unsupported sign algorithm '#{name}'"
  end
end

.unwrap_key(format, wrapped, unwrapping_key, unwrap_algo_hash, unwrapped_algo_hash, extractable, usages, unwrap_name) ⇒ Object 



341
342
343
344
 
# File 'lib/quickjs/subtle_crypto.rb', line 341

def self.unwrap_key(format, wrapped, unwrapping_key, unwrap_algo_hash, unwrapped_algo_hash, extractable, usages, unwrap_name)
  key_data = decrypt(unwrap_name, unwrapping_key, wrapped, unwrap_algo_hash)
  import_key(format, key_data, unwrapped_algo_hash, extractable, usages)
end

.verify(name, key, signature, data, params = {}) ⇒ Object 



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/quickjs/subtle_crypto.rb', line 265

def self.verify(name, key, signature, data, params = {})
  case name
  when "HMAC"
    hash_name = ossl_digest_name(key.algorithm["hash"])
    expected = OpenSSL::HMAC.digest(hash_name, key.key_data, data)
    OpenSSL::HMAC.hexdigest(hash_name, key.key_data, data) == OpenSSL::HMAC.hexdigest(hash_name, key.key_data, data) &&
      secure_compare(expected, signature)
  when "RSASSA-PKCS1-v1_5"
    hash_name = ossl_digest_name(key.algorithm["hash"])
    key.key_data.verify(hash_name, signature, data)
  when "RSA-PSS"
    hash_name = ossl_digest_name(key.algorithm["hash"])
    salt_length = params[:salt_length] || :digest
    key.key_data.verify_pss(hash_name, signature, data, salt_length: salt_length, mgf1_hash: hash_name)
  when "ECDSA"
    hash_name = ossl_digest_name(params[:hash] || key.algorithm["hash"])
    named_curve = key.algorithm["namedCurve"]
    coord_size = EC_COORD_SIZES[named_curve] or raise ArgumentError, "SubtleCrypto: unsupported curve '#{named_curve}'"
    begin
      der_sig = p1363_to_der(signature, coord_size)
      key.key_data.verify(hash_name, der_sig, data)
    rescue OpenSSL::PKey::PKeyError
      false
    end
  when "Ed25519"
    begin
      key.key_data.verify(nil, signature, data)
    rescue OpenSSL::PKey::PKeyError
      false
    end
  else
    raise ArgumentError, "SubtleCrypto: unsupported verify algorithm '#{name}'"
  end
end

.wrap_key(format, key, wrapping_key, wrap_algo_hash, wrap_name) ⇒ Object 



336
337
338
339
 
# File 'lib/quickjs/subtle_crypto.rb', line 336

def self.wrap_key(format, key, wrapping_key, wrap_algo_hash, wrap_name)
  key_data = export_key(format, key)
  encrypt(wrap_name, wrapping_key, key_data, wrap_algo_hash)
end