Module: PQCrypto

Defined in:
lib/pq_crypto.rb,
lib/pq_crypto/kem.rb,
lib/pq_crypto/errors.rb,
lib/pq_crypto/version.rb,
lib/pq_crypto/signature.rb,
lib/pq_crypto/hybrid_kem.rb,
lib/pq_crypto/serialization.rb,
ext/pqcrypto/pqcrypto_ruby_secure.c

Defined Under Namespace

Modules: HybridKEM, KEM, Serialization, Signature, Testing Classes: Error, InvalidCiphertextError, InvalidKeyError, SerializationError, UnsupportedAlgorithmError, VerificationError

Constant Summary collapse

SUITES = 
{
  kem: [:ml_kem_768].freeze,
  hybrid_kem: [:ml_kem_768_x25519_hkdf_sha256].freeze,
  signature: [:ml_dsa_65].freeze,
}.freeze
NATIVE_EXTENSION_LOADED = 
true
VERSION = 
"0.1.0"
ML_KEM_PUBLIC_KEY_BYTES = 
INT2NUM(PQ_MLKEM_PUBLICKEYBYTES)
ML_KEM_SECRET_KEY_BYTES = 
INT2NUM(PQ_MLKEM_SECRETKEYBYTES)
ML_KEM_CIPHERTEXT_BYTES = 
INT2NUM(PQ_MLKEM_CIPHERTEXTBYTES)
ML_KEM_SHARED_SECRET_BYTES = 
INT2NUM(PQ_MLKEM_SHAREDSECRETBYTES)
HYBRID_KEM_PUBLIC_KEY_BYTES = 
INT2NUM(PQ_HYBRID_PUBLICKEYBYTES)
HYBRID_KEM_SECRET_KEY_BYTES = 
INT2NUM(PQ_HYBRID_SECRETKEYBYTES)
HYBRID_KEM_CIPHERTEXT_BYTES = 
INT2NUM(PQ_HYBRID_CIPHERTEXTBYTES)
HYBRID_KEM_SHARED_SECRET_BYTES = 
INT2NUM(PQ_HYBRID_SHAREDSECRETBYTES)
SIGN_PUBLIC_KEY_BYTES = 
INT2NUM(PQ_MLDSA_PUBLICKEYBYTES)
SIGN_SECRET_KEY_BYTES = 
INT2NUM(PQ_MLDSA_SECRETKEYBYTES)
SIGN_BYTES = 
INT2NUM(PQ_MLDSA_BYTES)

Class Method Summary collapse

Class Method Details

.__test_ml_kem_encapsulate_from_seed(public_key, seed) ⇒ Object 



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 477

static VALUE pqcrypto__test_ml_kem_encapsulate_from_seed(VALUE self, VALUE public_key, VALUE seed) {
    (void)self;
    StringValue(public_key);
    StringValue(seed);

    if ((size_t)RSTRING_LEN(public_key) != PQ_MLKEM_PUBLICKEYBYTES) {
        rb_raise(rb_eArgError, "Invalid public key length");
    }
    if ((size_t)RSTRING_LEN(seed) != 32) {
        rb_raise(rb_eArgError, "Deterministic test seed must be 32 bytes");
    }

    kem_encapsulate_call_t call = {0};
    size_t public_key_len = 0;
    size_t seed_len = 0;
    call.public_key = pq_copy_ruby_string(public_key, &public_key_len);
    call.ciphertext = pq_alloc_buffer(PQ_MLKEM_CIPHERTEXTBYTES);
    call.shared_secret = pq_alloc_buffer(PQ_MLKEM_SHAREDSECRETBYTES);
    call.seed = pq_copy_ruby_string(seed, &seed_len);
    call.seed_len = seed_len;

    rb_thread_call_without_gvl(pq_testing_ml_kem_encapsulate_nogvl, &call, NULL, NULL);
    pq_wipe_and_free((uint8_t *)call.public_key, public_key_len);
    pq_wipe_and_free((uint8_t *)call.seed, call.seed_len);

    if (call.result != PQ_SUCCESS) {
        pq_wipe_and_free(call.shared_secret, PQ_MLKEM_SHAREDSECRETBYTES);
        free(call.ciphertext);
        pq_raise_general_error(call.result);
    }

    VALUE result = rb_ary_new2(2);
    rb_ary_push(result, pq_string_from_buffer(call.ciphertext, PQ_MLKEM_CIPHERTEXTBYTES));
    rb_ary_push(result, pq_string_from_buffer(call.shared_secret, PQ_MLKEM_SHAREDSECRETBYTES));

    free(call.ciphertext);
    pq_wipe_and_free(call.shared_secret, PQ_MLKEM_SHAREDSECRETBYTES);
    return result;
}

.__test_ml_kem_keypair_from_seed(seed) ⇒ Object 



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 444

static VALUE pqcrypto__test_ml_kem_keypair_from_seed(VALUE self, VALUE seed) {
    (void)self;
    StringValue(seed);

    if ((size_t)RSTRING_LEN(seed) != 32 && (size_t)RSTRING_LEN(seed) != 64) {
        rb_raise(rb_eArgError, "Deterministic ML-KEM test seed must be 32 or 64 bytes");
    }

    kem_keypair_call_t call = {0};
    size_t seed_len = 0;
    call.public_key = pq_alloc_buffer(PQ_MLKEM_PUBLICKEYBYTES);
    call.secret_key = pq_alloc_buffer(PQ_MLKEM_SECRETKEYBYTES);
    call.seed = pq_copy_ruby_string(seed, &seed_len);
    call.seed_len = seed_len;

    rb_thread_call_without_gvl(pq_testing_ml_kem_keypair_nogvl, &call, NULL, NULL);
    pq_wipe_and_free((uint8_t *)call.seed, call.seed_len);

    if (call.result != PQ_SUCCESS) {
        pq_wipe_and_free(call.secret_key, PQ_MLKEM_SECRETKEYBYTES);
        free(call.public_key);
        pq_raise_general_error(call.result);
    }

    VALUE result = rb_ary_new2(2);
    rb_ary_push(result, pq_string_from_buffer(call.public_key, PQ_MLKEM_PUBLICKEYBYTES));
    rb_ary_push(result, pq_string_from_buffer(call.secret_key, PQ_MLKEM_SECRETKEYBYTES));

    free(call.public_key);
    pq_wipe_and_free(call.secret_key, PQ_MLKEM_SECRETKEYBYTES);
    return result;
}

.__test_sign_from_seed(message, secret_key, seed) ⇒ Object 



550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 550

static VALUE pqcrypto__test_sign_from_seed(VALUE self, VALUE message, VALUE secret_key,
                                           VALUE seed) {
    (void)self;
    StringValue(secret_key);
    StringValue(seed);

    if ((size_t)RSTRING_LEN(secret_key) != PQ_MLDSA_SECRETKEYBYTES) {
        rb_raise(rb_eArgError, "Invalid secret key length");
    }
    if ((size_t)RSTRING_LEN(seed) != 32) {
        rb_raise(rb_eArgError, "Deterministic test seed must be 32 bytes");
    }

    sign_call_t call = {0};
    size_t secret_key_len = 0;
    size_t seed_len = 0;
    call.secret_key = pq_copy_ruby_string(secret_key, &secret_key_len);
    call.signature_len = PQ_MLDSA_BYTES;
    call.signature = pq_alloc_buffer(PQ_MLDSA_BYTES);
    call.message = pq_copy_ruby_string(message, &call.message_len);
    call.seed = pq_copy_ruby_string(seed, &seed_len);
    call.seed_len = seed_len;

    rb_thread_call_without_gvl(pq_testing_sign_nogvl, &call, NULL, NULL);

    pq_wipe_and_free(call.message, call.message_len);
    pq_wipe_and_free((uint8_t *)call.secret_key, secret_key_len);
    pq_wipe_and_free((uint8_t *)call.seed, call.seed_len);

    if (call.result != PQ_SUCCESS) {
        pq_wipe_and_free(call.signature, PQ_MLDSA_BYTES);
        pq_raise_general_error(call.result);
    }

    VALUE result = pq_string_from_buffer(call.signature, call.signature_len);
    pq_wipe_and_free(call.signature, PQ_MLDSA_BYTES);
    return result;
}

.__test_sign_keypair_from_seed(seed) ⇒ Object 



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 517

static VALUE pqcrypto__test_sign_keypair_from_seed(VALUE self, VALUE seed) {
    (void)self;
    StringValue(seed);

    if ((size_t)RSTRING_LEN(seed) != 32) {
        rb_raise(rb_eArgError, "Deterministic test seed must be 32 bytes");
    }

    sign_keypair_call_t call = {0};
    size_t seed_len = 0;
    call.public_key = pq_alloc_buffer(PQ_MLDSA_PUBLICKEYBYTES);
    call.secret_key = pq_alloc_buffer(PQ_MLDSA_SECRETKEYBYTES);
    call.seed = pq_copy_ruby_string(seed, &seed_len);
    call.seed_len = seed_len;

    rb_thread_call_without_gvl(pq_testing_sign_keypair_nogvl, &call, NULL, NULL);
    pq_wipe_and_free((uint8_t *)call.seed, call.seed_len);

    if (call.result != PQ_SUCCESS) {
        pq_wipe_and_free(call.secret_key, PQ_MLDSA_SECRETKEYBYTES);
        free(call.public_key);
        pq_raise_general_error(call.result);
    }

    VALUE result = rb_ary_new2(2);
    rb_ary_push(result, pq_string_from_buffer(call.public_key, PQ_MLDSA_PUBLICKEYBYTES));
    rb_ary_push(result, pq_string_from_buffer(call.secret_key, PQ_MLDSA_SECRETKEYBYTES));

    free(call.public_key);
    pq_wipe_and_free(call.secret_key, PQ_MLDSA_SECRETKEYBYTES);
    return result;
}

.backend ⇒ Object 



120
121
122
 
# File 'lib/pq_crypto.rb', line 120

def backend
  :native_pqclean
end

.hybrid_kem_decapsulate(ciphertext, secret_key) ⇒ Object 



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 411

static VALUE pqcrypto_hybrid_kem_decapsulate(VALUE self, VALUE ciphertext, VALUE secret_key) {
    (void)self;
    StringValue(ciphertext);
    StringValue(secret_key);

    if ((size_t)RSTRING_LEN(ciphertext) != PQ_HYBRID_CIPHERTEXTBYTES) {
        rb_raise(rb_eArgError, "Invalid ciphertext length");
    }
    if ((size_t)RSTRING_LEN(secret_key) != PQ_HYBRID_SECRETKEYBYTES) {
        rb_raise(rb_eArgError, "Invalid secret key length");
    }

    kem_decapsulate_call_t call = {0};
    size_t ciphertext_len = 0;
    size_t secret_key_len = 0;
    call.ciphertext = pq_copy_ruby_string(ciphertext, &ciphertext_len);
    call.secret_key = pq_copy_ruby_string(secret_key, &secret_key_len);
    call.shared_secret = pq_alloc_buffer(PQ_HYBRID_SHAREDSECRETBYTES);

    rb_thread_call_without_gvl(pq_hybrid_kem_decapsulate_nogvl, &call, NULL, NULL);
    pq_wipe_and_free((uint8_t *)call.ciphertext, ciphertext_len);
    pq_wipe_and_free((uint8_t *)call.secret_key, secret_key_len);

    if (call.result != PQ_SUCCESS) {
        pq_wipe_and_free(call.shared_secret, PQ_HYBRID_SHAREDSECRETBYTES);
        pq_raise_general_error(call.result);
    }

    VALUE result = pq_string_from_buffer(call.shared_secret, PQ_HYBRID_SHAREDSECRETBYTES);
    pq_wipe_and_free(call.shared_secret, PQ_HYBRID_SHAREDSECRETBYTES);
    return result;
}

.hybrid_kem_encapsulate(public_key) ⇒ Object 



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 379

static VALUE pqcrypto_hybrid_kem_encapsulate(VALUE self, VALUE public_key) {
    (void)self;
    StringValue(public_key);

    if ((size_t)RSTRING_LEN(public_key) != PQ_HYBRID_PUBLICKEYBYTES) {
        rb_raise(rb_eArgError, "Invalid public key length");
    }

    kem_encapsulate_call_t call = {0};
    size_t public_key_len = 0;
    call.public_key = pq_copy_ruby_string(public_key, &public_key_len);
    call.ciphertext = pq_alloc_buffer(PQ_HYBRID_CIPHERTEXTBYTES);
    call.shared_secret = pq_alloc_buffer(PQ_HYBRID_SHAREDSECRETBYTES);

    rb_thread_call_without_gvl(pq_hybrid_kem_encapsulate_nogvl, &call, NULL, NULL);
    pq_wipe_and_free((uint8_t *)call.public_key, public_key_len);

    if (call.result != PQ_SUCCESS) {
        pq_wipe_and_free(call.shared_secret, PQ_HYBRID_SHAREDSECRETBYTES);
        free(call.ciphertext);
        pq_raise_general_error(call.result);
    }

    VALUE result = rb_ary_new2(2);
    rb_ary_push(result, pq_string_from_buffer(call.ciphertext, PQ_HYBRID_CIPHERTEXTBYTES));
    rb_ary_push(result, pq_string_from_buffer(call.shared_secret, PQ_HYBRID_SHAREDSECRETBYTES));

    free(call.ciphertext);
    pq_wipe_and_free(call.shared_secret, PQ_HYBRID_SHAREDSECRETBYTES);
    return result;
}

.hybrid_kem_keypair ⇒ Object 



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 355

static VALUE pqcrypto_hybrid_kem_keypair(VALUE self) {
    (void)self;

    kem_keypair_call_t call = {0};
    call.public_key = pq_alloc_buffer(PQ_HYBRID_PUBLICKEYBYTES);
    call.secret_key = pq_alloc_buffer(PQ_HYBRID_SECRETKEYBYTES);

    rb_thread_call_without_gvl(pq_hybrid_kem_keypair_nogvl, &call, NULL, NULL);

    if (call.result != PQ_SUCCESS) {
        pq_wipe_and_free(call.secret_key, PQ_HYBRID_SECRETKEYBYTES);
        free(call.public_key);
        pq_raise_general_error(call.result);
    }

    VALUE result = rb_ary_new2(2);
    rb_ary_push(result, pq_string_from_buffer(call.public_key, PQ_HYBRID_PUBLICKEYBYTES));
    rb_ary_push(result, pq_string_from_buffer(call.secret_key, PQ_HYBRID_SECRETKEYBYTES));

    free(call.public_key);
    pq_wipe_and_free(call.secret_key, PQ_HYBRID_SECRETKEYBYTES);
    return result;
}

.ml_kem_decapsulate(ciphertext, secret_key) ⇒ Object 



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 322

static VALUE pqcrypto_ml_kem_decapsulate(VALUE self, VALUE ciphertext, VALUE secret_key) {
    (void)self;
    StringValue(ciphertext);
    StringValue(secret_key);

    if ((size_t)RSTRING_LEN(ciphertext) != PQ_MLKEM_CIPHERTEXTBYTES) {
        rb_raise(rb_eArgError, "Invalid ciphertext length");
    }
    if ((size_t)RSTRING_LEN(secret_key) != PQ_MLKEM_SECRETKEYBYTES) {
        rb_raise(rb_eArgError, "Invalid secret key length");
    }

    kem_decapsulate_call_t call = {0};
    size_t ciphertext_len = 0;
    size_t secret_key_len = 0;
    call.ciphertext = pq_copy_ruby_string(ciphertext, &ciphertext_len);
    call.secret_key = pq_copy_ruby_string(secret_key, &secret_key_len);
    call.shared_secret = pq_alloc_buffer(PQ_MLKEM_SHAREDSECRETBYTES);

    rb_thread_call_without_gvl(pq_ml_kem_decapsulate_nogvl, &call, NULL, NULL);
    pq_wipe_and_free((uint8_t *)call.ciphertext, ciphertext_len);
    pq_wipe_and_free((uint8_t *)call.secret_key, secret_key_len);

    if (call.result != PQ_SUCCESS) {
        pq_wipe_and_free(call.shared_secret, PQ_MLKEM_SHAREDSECRETBYTES);
        pq_raise_general_error(call.result);
    }

    VALUE result = pq_string_from_buffer(call.shared_secret, PQ_MLKEM_SHAREDSECRETBYTES);
    pq_wipe_and_free(call.shared_secret, PQ_MLKEM_SHAREDSECRETBYTES);
    return result;
}

.ml_kem_encapsulate(public_key) ⇒ Object 



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 290

static VALUE pqcrypto_ml_kem_encapsulate(VALUE self, VALUE public_key) {
    (void)self;
    StringValue(public_key);

    if ((size_t)RSTRING_LEN(public_key) != PQ_MLKEM_PUBLICKEYBYTES) {
        rb_raise(rb_eArgError, "Invalid public key length");
    }

    kem_encapsulate_call_t call = {0};
    size_t public_key_len = 0;
    call.public_key = pq_copy_ruby_string(public_key, &public_key_len);
    call.ciphertext = pq_alloc_buffer(PQ_MLKEM_CIPHERTEXTBYTES);
    call.shared_secret = pq_alloc_buffer(PQ_MLKEM_SHAREDSECRETBYTES);

    rb_thread_call_without_gvl(pq_ml_kem_encapsulate_nogvl, &call, NULL, NULL);
    pq_wipe_and_free((uint8_t *)call.public_key, public_key_len);

    if (call.result != PQ_SUCCESS) {
        pq_wipe_and_free(call.shared_secret, PQ_MLKEM_SHAREDSECRETBYTES);
        free(call.ciphertext);
        pq_raise_general_error(call.result);
    }

    VALUE result = rb_ary_new2(2);
    rb_ary_push(result, pq_string_from_buffer(call.ciphertext, PQ_MLKEM_CIPHERTEXTBYTES));
    rb_ary_push(result, pq_string_from_buffer(call.shared_secret, PQ_MLKEM_SHAREDSECRETBYTES));

    free(call.ciphertext);
    pq_wipe_and_free(call.shared_secret, PQ_MLKEM_SHAREDSECRETBYTES);
    return result;
}

.ml_kem_keypair ⇒ Object 



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 266

static VALUE pqcrypto_ml_kem_keypair(VALUE self) {
    (void)self;

    kem_keypair_call_t call = {0};
    call.public_key = pq_alloc_buffer(PQ_MLKEM_PUBLICKEYBYTES);
    call.secret_key = pq_alloc_buffer(PQ_MLKEM_SECRETKEYBYTES);

    rb_thread_call_without_gvl(pq_ml_kem_keypair_nogvl, &call, NULL, NULL);

    if (call.result != PQ_SUCCESS) {
        pq_wipe_and_free(call.secret_key, PQ_MLKEM_SECRETKEYBYTES);
        free(call.public_key);
        pq_raise_general_error(call.result);
    }

    VALUE result = rb_ary_new2(2);
    rb_ary_push(result, pq_string_from_buffer(call.public_key, PQ_MLKEM_PUBLICKEYBYTES));
    rb_ary_push(result, pq_string_from_buffer(call.secret_key, PQ_MLKEM_SECRETKEYBYTES));

    free(call.public_key);
    pq_wipe_and_free(call.secret_key, PQ_MLKEM_SECRETKEYBYTES);
    return result;
}

.native_extension_loaded? ⇒ Boolean

Returns:

  • (Boolean) 


124
125
126
 
# File 'lib/pq_crypto.rb', line 124

def native_extension_loaded?
  true
end

.public_key_from_pqc_container_der(der) ⇒ Object 



769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 769

static VALUE pqcrypto_public_key_from_pqc_container_der(VALUE self, VALUE der) {
    char *algorithm = NULL;
    uint8_t *key = NULL;
    size_t key_len = 0;
    VALUE ary;
    StringValue(der);
    int ret = pq_public_key_from_pqc_container_der(
        &algorithm, &key, &key_len, (const uint8_t *)RSTRING_PTR(der), (size_t)RSTRING_LEN(der));
    if (ret != PQ_SUCCESS)
        pq_raise_general_error(ret);
    ary = rb_ary_new_capa(2);
    rb_ary_push(ary, pq_algorithm_cstr_to_symbol(algorithm));
    rb_ary_push(ary, pq_string_from_buffer(key, key_len));
    free(algorithm);
    pq_secure_wipe(key, key_len);
    free(key);
    return ary;
}

.public_key_from_pqc_container_pem(pem) ⇒ Object 



788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 788

static VALUE pqcrypto_public_key_from_pqc_container_pem(VALUE self, VALUE pem) {
    char *algorithm = NULL;
    uint8_t *key = NULL;
    size_t key_len = 0;
    VALUE ary;
    StringValue(pem);
    int ret = pq_public_key_from_pqc_container_pem(&algorithm, &key, &key_len, RSTRING_PTR(pem),
                                                   (size_t)RSTRING_LEN(pem));
    if (ret != PQ_SUCCESS)
        pq_raise_general_error(ret);
    ary = rb_ary_new_capa(2);
    rb_ary_push(ary, pq_algorithm_cstr_to_symbol(algorithm));
    rb_ary_push(ary, pq_string_from_buffer(key, key_len));
    free(algorithm);
    pq_secure_wipe(key, key_len);
    free(key);
    return ary;
}

.public_key_to_pqc_container_der(algorithm, key_bytes) ⇒ Object 



701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 701

static VALUE pqcrypto_public_key_to_pqc_container_der(VALUE self, VALUE algorithm,
                                                      VALUE key_bytes) {
    uint8_t *out = NULL;
    size_t out_len = 0;
    VALUE result;
    StringValue(key_bytes);
    int ret = pq_public_key_to_pqc_container_der(
        &out, &out_len, (const uint8_t *)RSTRING_PTR(key_bytes), (size_t)RSTRING_LEN(key_bytes),
        pq_algorithm_symbol_to_cstr(algorithm));
    if (ret != PQ_SUCCESS)
        pq_raise_general_error(ret);
    result = pq_string_from_buffer(out, out_len);
    pq_secure_wipe(out, out_len);
    free(out);
    return result;
}

.public_key_to_pqc_container_pem(algorithm, key_bytes) ⇒ Object 



718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 718

static VALUE pqcrypto_public_key_to_pqc_container_pem(VALUE self, VALUE algorithm,
                                                      VALUE key_bytes) {
    char *out = NULL;
    size_t out_len = 0;
    VALUE result;
    StringValue(key_bytes);
    int ret = pq_public_key_to_pqc_container_pem(
        &out, &out_len, (const uint8_t *)RSTRING_PTR(key_bytes), (size_t)RSTRING_LEN(key_bytes),
        pq_algorithm_symbol_to_cstr(algorithm));
    if (ret != PQ_SUCCESS)
        pq_raise_general_error(ret);
    result = rb_utf8_str_new(out, (long)out_len);
    pq_secure_wipe(out, out_len);
    free(out);
    return result;
}

.secret_key_from_pqc_container_der(der) ⇒ Object 



807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 807

static VALUE pqcrypto_secret_key_from_pqc_container_der(VALUE self, VALUE der) {
    char *algorithm = NULL;
    uint8_t *key = NULL;
    size_t key_len = 0;
    VALUE ary;
    StringValue(der);
    int ret = pq_secret_key_from_pqc_container_der(
        &algorithm, &key, &key_len, (const uint8_t *)RSTRING_PTR(der), (size_t)RSTRING_LEN(der));
    if (ret != PQ_SUCCESS)
        pq_raise_general_error(ret);
    ary = rb_ary_new_capa(2);
    rb_ary_push(ary, pq_algorithm_cstr_to_symbol(algorithm));
    rb_ary_push(ary, pq_string_from_buffer(key, key_len));
    free(algorithm);
    pq_secure_wipe(key, key_len);
    free(key);
    return ary;
}

.secret_key_from_pqc_container_pem(pem) ⇒ Object 



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 826

static VALUE pqcrypto_secret_key_from_pqc_container_pem(VALUE self, VALUE pem) {
    char *algorithm = NULL;
    uint8_t *key = NULL;
    size_t key_len = 0;
    VALUE ary;
    StringValue(pem);
    int ret = pq_secret_key_from_pqc_container_pem(&algorithm, &key, &key_len, RSTRING_PTR(pem),
                                                   (size_t)RSTRING_LEN(pem));
    if (ret != PQ_SUCCESS)
        pq_raise_general_error(ret);
    ary = rb_ary_new_capa(2);
    rb_ary_push(ary, pq_algorithm_cstr_to_symbol(algorithm));
    rb_ary_push(ary, pq_string_from_buffer(key, key_len));
    free(algorithm);
    pq_secure_wipe(key, key_len);
    free(key);
    return ary;
}

.secret_key_to_pqc_container_der(algorithm, key_bytes) ⇒ Object 



735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 735

static VALUE pqcrypto_secret_key_to_pqc_container_der(VALUE self, VALUE algorithm,
                                                      VALUE key_bytes) {
    uint8_t *out = NULL;
    size_t out_len = 0;
    VALUE result;
    StringValue(key_bytes);
    int ret = pq_secret_key_to_pqc_container_der(
        &out, &out_len, (const uint8_t *)RSTRING_PTR(key_bytes), (size_t)RSTRING_LEN(key_bytes),
        pq_algorithm_symbol_to_cstr(algorithm));
    if (ret != PQ_SUCCESS)
        pq_raise_general_error(ret);
    result = pq_string_from_buffer(out, out_len);
    pq_secure_wipe(out, out_len);
    free(out);
    return result;
}

.secret_key_to_pqc_container_pem(algorithm, key_bytes) ⇒ Object 



752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 752

static VALUE pqcrypto_secret_key_to_pqc_container_pem(VALUE self, VALUE algorithm,
                                                      VALUE key_bytes) {
    char *out = NULL;
    size_t out_len = 0;
    VALUE result;
    StringValue(key_bytes);
    int ret = pq_secret_key_to_pqc_container_pem(
        &out, &out_len, (const uint8_t *)RSTRING_PTR(key_bytes), (size_t)RSTRING_LEN(key_bytes),
        pq_algorithm_symbol_to_cstr(algorithm));
    if (ret != PQ_SUCCESS)
        pq_raise_general_error(ret);
    result = rb_utf8_str_new(out, (long)out_len);
    pq_secure_wipe(out, out_len);
    free(out);
    return result;
}

.secure_wipe(str) ⇒ Object

Raises:

  • (ArgumentError) 


673
674
675
676
677
678
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 673

def secure_wipe(string)
  string = String(string)
  raise ArgumentError, "secure_wipe requires a mutable String" if string.frozen?

  native_secure_wipe(string)
end

.sign(message, secret_key) ⇒ Object 



613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 613

static VALUE pqcrypto_sign(VALUE self, VALUE message, VALUE secret_key) {
    (void)self;
    StringValue(secret_key);

    if ((size_t)RSTRING_LEN(secret_key) != PQ_MLDSA_SECRETKEYBYTES) {
        rb_raise(rb_eArgError, "Invalid secret key length");
    }

    sign_call_t call = {0};
    size_t secret_key_len = 0;
    call.secret_key = pq_copy_ruby_string(secret_key, &secret_key_len);
    call.signature_len = PQ_MLDSA_BYTES;
    call.signature = pq_alloc_buffer(PQ_MLDSA_BYTES);
    call.message = pq_copy_ruby_string(message, &call.message_len);

    rb_thread_call_without_gvl(pq_sign_nogvl, &call, NULL, NULL);

    pq_wipe_and_free(call.message, call.message_len);
    pq_wipe_and_free((uint8_t *)call.secret_key, secret_key_len);

    if (call.result != PQ_SUCCESS) {
        pq_wipe_and_free(call.signature, PQ_MLDSA_BYTES);
        pq_raise_general_error(call.result);
    }

    VALUE result = pq_string_from_buffer(call.signature, call.signature_len);
    free(call.signature);
    return result;
}

.sign_keypair ⇒ Object 



589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 589

static VALUE pqcrypto_sign_keypair(VALUE self) {
    (void)self;

    sign_keypair_call_t call = {0};
    call.public_key = pq_alloc_buffer(PQ_MLDSA_PUBLICKEYBYTES);
    call.secret_key = pq_alloc_buffer(PQ_MLDSA_SECRETKEYBYTES);

    rb_thread_call_without_gvl(pq_sign_keypair_nogvl, &call, NULL, NULL);

    if (call.result != PQ_SUCCESS) {
        pq_wipe_and_free(call.secret_key, PQ_MLDSA_SECRETKEYBYTES);
        free(call.public_key);
        pq_raise_general_error(call.result);
    }

    VALUE result = rb_ary_new2(2);
    rb_ary_push(result, pq_string_from_buffer(call.public_key, PQ_MLDSA_PUBLICKEYBYTES));
    rb_ary_push(result, pq_string_from_buffer(call.secret_key, PQ_MLDSA_SECRETKEYBYTES));

    free(call.public_key);
    pq_wipe_and_free(call.secret_key, PQ_MLDSA_SECRETKEYBYTES);
    return result;
}

.supported_hybrid_kems ⇒ Object 



132
133
134
 
# File 'lib/pq_crypto.rb', line 132

def supported_hybrid_kems
  SUITES.fetch(:hybrid_kem).dup
end

.supported_kems ⇒ Object 



128
129
130
 
# File 'lib/pq_crypto.rb', line 128

def supported_kems
  SUITES.fetch(:kem).dup
end

.supported_signatures ⇒ Object 



136
137
138
 
# File 'lib/pq_crypto.rb', line 136

def supported_signatures
  SUITES.fetch(:signature).dup
end

.verify(message, signature, public_key) ⇒ Object 



643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 643

static VALUE pqcrypto_verify(VALUE self, VALUE message, VALUE signature, VALUE public_key) {
    (void)self;
    StringValue(signature);
    StringValue(public_key);

    if ((size_t)RSTRING_LEN(public_key) != PQ_MLDSA_PUBLICKEYBYTES) {
        rb_raise(rb_eArgError, "Invalid public key length");
    }

    verify_call_t call = {0};
    size_t public_key_len = 0;
    size_t signature_len = 0;
    call.public_key = pq_copy_ruby_string(public_key, &public_key_len);
    call.signature = pq_copy_ruby_string(signature, &signature_len);
    call.signature_len = signature_len;
    call.message = pq_copy_ruby_string(message, &call.message_len);

    rb_thread_call_without_gvl(pq_verify_nogvl, &call, NULL, NULL);

    pq_wipe_and_free(call.message, call.message_len);
    pq_wipe_and_free((uint8_t *)call.public_key, public_key_len);
    pq_wipe_and_free((uint8_t *)call.signature, signature_len);

    if (call.result != PQ_SUCCESS) {
        pq_raise_verification_error(call.result);
    }

    return Qtrue;
}

.version ⇒ Object 



681
682
683
 
# File 'ext/pqcrypto/pqcrypto_ruby_secure.c', line 681

def version
  native_version
end