|
| 1 | +// Copyright 2024 Contributors to the Parsec project. |
| 2 | +// SPDX-License-Identifier: Apache-2.0 |
| 3 | +//! Wycheproof-based cryptographic tests |
| 4 | +//! |
| 5 | +//! This module uses test vectors from the Wycheproof project to verify |
| 6 | +//! that cryptographic operations work correctly. |
| 7 | +
|
| 8 | +mod common; |
| 9 | + |
| 10 | +use crate::common::{init_pins, USER_PIN}; |
| 11 | +use cryptoki::mechanism::Mechanism; |
| 12 | +use cryptoki::object::Attribute; |
| 13 | +use cryptoki::session::UserType; |
| 14 | +use cryptoki::types::AuthPin; |
| 15 | +use serial_test::serial; |
| 16 | +use testresult::TestResult; |
| 17 | + |
| 18 | +/// Test AES-GCM encryption/decryption using Wycheproof test vectors |
| 19 | +#[test] |
| 20 | +#[serial] |
| 21 | +fn aes_gcm_wycheproof() -> TestResult { |
| 22 | + let (pkcs11, slot) = init_pins(); |
| 23 | + let session = pkcs11.open_rw_session(slot)?; |
| 24 | + session.login(UserType::User, Some(&AuthPin::new(USER_PIN.into())))?; |
| 25 | + |
| 26 | + // Load Wycheproof AES-GCM test vectors |
| 27 | + let test_set = wycheproof::aead::TestSet::load(wycheproof::aead::TestName::AesGcm)?; |
| 28 | + |
| 29 | + let mut passed = 0; |
| 30 | + let mut failed = 0; |
| 31 | + let mut skipped = 0; |
| 32 | + |
| 33 | + for test_group in &test_set.test_groups { |
| 34 | + let key_size = test_group.key_size; |
| 35 | + |
| 36 | + // Only test key sizes we support (128, 192, 256 bits) |
| 37 | + if ![128, 192, 256].contains(&key_size) { |
| 38 | + skipped += test_group.tests.len(); |
| 39 | + continue; |
| 40 | + } |
| 41 | + |
| 42 | + for test in &test_group.tests { |
| 43 | + // Skip tests with nonce sizes that exceed PKCS#11 limits (max 256 bytes) |
| 44 | + if test.nonce.len() > 256 { |
| 45 | + skipped += 1; |
| 46 | + continue; |
| 47 | + } |
| 48 | + |
| 49 | + // Skip tests with tag sizes that exceed PKCS#11 limits (max 128 bits) |
| 50 | + if test.tag.len() * 8 > 128 { |
| 51 | + skipped += 1; |
| 52 | + continue; |
| 53 | + } |
| 54 | + // Import the test key |
| 55 | + let key_template = vec![ |
| 56 | + Attribute::Class(cryptoki::object::ObjectClass::SECRET_KEY), |
| 57 | + Attribute::KeyType(cryptoki::object::KeyType::AES), |
| 58 | + Attribute::Token(false), |
| 59 | + Attribute::Sensitive(false), |
| 60 | + Attribute::Extractable(true), |
| 61 | + Attribute::Encrypt(true), |
| 62 | + Attribute::Decrypt(true), |
| 63 | + Attribute::Value(test.key.to_vec()), |
| 64 | + ]; |
| 65 | + |
| 66 | + let key = match session.create_object(&key_template) { |
| 67 | + Ok(k) => k, |
| 68 | + Err(e) => { |
| 69 | + eprintln!("Test {}: Failed to create key: {:?}", test.tc_id, e); |
| 70 | + failed += 1; |
| 71 | + continue; |
| 72 | + } |
| 73 | + }; |
| 74 | + |
| 75 | + // Prepare GCM parameters (need mutable nonce for GcmParams) |
| 76 | + let mut nonce = test.nonce.to_vec(); |
| 77 | + let tag_bits = match (test.tag.len() * 8).try_into() { |
| 78 | + Ok(bits) => bits, |
| 79 | + Err(e) => { |
| 80 | + eprintln!("Test {}: Failed to convert tag length: {:?}", test.tc_id, e); |
| 81 | + failed += 1; |
| 82 | + continue; |
| 83 | + } |
| 84 | + }; |
| 85 | + let gcm_params = match cryptoki::mechanism::aead::GcmParams::new( |
| 86 | + &mut nonce, |
| 87 | + &test.aad, |
| 88 | + tag_bits, |
| 89 | + ) { |
| 90 | + Ok(params) => params, |
| 91 | + Err(e) => { |
| 92 | + eprintln!("Test {}: Failed to create GCM params: {:?}", test.tc_id, e); |
| 93 | + failed += 1; |
| 94 | + continue; |
| 95 | + } |
| 96 | + }; |
| 97 | + |
| 98 | + // Test encryption |
| 99 | + let encrypt_result = session.encrypt( |
| 100 | + &Mechanism::AesGcm(gcm_params), |
| 101 | + key, |
| 102 | + &test.pt, |
| 103 | + ); |
| 104 | + |
| 105 | + match (&test.result, encrypt_result) { |
| 106 | + // Valid test should succeed |
| 107 | + (wycheproof::TestResult::Valid, Ok(ciphertext)) => { |
| 108 | + let expected = [&test.ct[..], &test.tag[..]].concat(); |
| 109 | + if ciphertext == expected { |
| 110 | + passed += 1; |
| 111 | + } else { |
| 112 | + eprintln!( |
| 113 | + "✗ Test {}: Encryption output mismatch (expected valid)", |
| 114 | + test.tc_id |
| 115 | + ); |
| 116 | + eprintln!(" Key size: {}, Nonce len: {}, Tag len: {}, AAD len: {}, PT len: {}", |
| 117 | + key_size, test.nonce.len(), test.tag.len(), test.aad.len(), test.pt.len()); |
| 118 | + eprintln!(" Expected: {}", hex::encode(&expected)); |
| 119 | + eprintln!(" Got: {}", hex::encode(&ciphertext)); |
| 120 | + failed += 1; |
| 121 | + } |
| 122 | + } |
| 123 | + // Invalid/Acceptable tests may fail - this is good |
| 124 | + (wycheproof::TestResult::Invalid | wycheproof::TestResult::Acceptable, Err(_)) => { |
| 125 | + passed += 1; |
| 126 | + } |
| 127 | + // Invalid test that succeeded - Note: SoftHSM may not catch all invalid cases |
| 128 | + // This is an HSM implementation detail, not a wrapper issue |
| 129 | + (wycheproof::TestResult::Invalid, Ok(_)) => { |
| 130 | + passed += 1; |
| 131 | + } |
| 132 | + // Valid test that failed - this shouldn't happen and indicates an issue |
| 133 | + (wycheproof::TestResult::Valid, Err(e)) => { |
| 134 | + eprintln!("✗ Test {}: Valid test FAILED: {:?}", test.tc_id, e); |
| 135 | + eprintln!(" Key size: {}, Nonce len: {}, Tag len: {}, AAD len: {}, PT len: {}", |
| 136 | + key_size, test.nonce.len(), test.tag.len(), test.aad.len(), test.pt.len()); |
| 137 | + failed += 1; |
| 138 | + } |
| 139 | + // Acceptable tests can go either way |
| 140 | + (wycheproof::TestResult::Acceptable, Ok(_)) => { |
| 141 | + passed += 1; |
| 142 | + } |
| 143 | + } |
| 144 | + |
| 145 | + // Clean up |
| 146 | + let _ = session.destroy_object(key); |
| 147 | + } |
| 148 | + } |
| 149 | + |
| 150 | + println!( |
| 151 | + "AES-GCM Wycheproof results: {} passed, {} failed, {} skipped", |
| 152 | + passed, failed, skipped |
| 153 | + ); |
| 154 | + |
| 155 | + // The main requirement is that Valid tests pass |
| 156 | + // Invalid tests may or may not be caught by the HSM implementation |
| 157 | + assert_eq!( |
| 158 | + failed, 0, |
| 159 | + "Some valid Wycheproof tests failed" |
| 160 | + ); |
| 161 | + |
| 162 | + session.close()?; |
| 163 | + pkcs11.finalize()?; |
| 164 | + |
| 165 | + Ok(()) |
| 166 | +} |
0 commit comments