Project Wycheproof

Project Wycheproof ist ein von der Community verwaltetes Repository mit Testvektoren, die von Entwicklern von Kryptografiebibliotheken genutzt werden können, um gegen bekannte Angriffe, Spezifikationsinkonsistenzen und andere Implementierungsfehler zu testen.

Testvektoren werden als JSON-Testvektordaten mit begleitenden JSON-Schema-Dateien gepflegt, die die Struktur der Testvektordaten dokumentieren.

Erste Schritte

1. Klonen Sie dieses Repository. Möglicherweise möchten Sie Wycheproof auch als Git-Submodul integrieren oder anderweitig eine Automatisierung einrichten, um Änderungen im Laufe der Zeit zu verfolgen.
2. Schreiben Sie (oder generieren Sie aus den JSON-Schema-Dateien) Code, um die Vektordaten entsprechend Ihrer Implementierungssprache/Ihres Projekts zu laden.
3. Identifizieren Sie für jeden interessierenden Algorithmus die Eingaben für Ihre Kryptografie-APIs und die erzeugten Ausgaben, die auf die Testvektoren abbilden.
4. Durchlaufen Sie die zutreffenden Testvektoren und stellen Sie sicher, dass die von Ihrer API bei Eingabe der relevanten Daten erzeugten Ergebnisse mit den erwarteten Ergebnissen der Testvektoren übereinstimmen.
5. Integrieren Sie diesen Prozess für beste Ergebnisse in Ihren Continuous-Integration (CI)-Prozess, sodass Tests für alle neuen Beiträge/Änderungen ausgeführt werden.

Es kann hilfreich sein zu untersuchen, wie andere Projekte wie pyca/cryptography Wycheproofs Testvektoren integriert haben.

Abdeckung

Project Wycheproof hat Testvektoren für die gängigsten Kryptoalgorithmen, darunter

• AEGIS
• AES-EAX
• AES-FF1
• AES-GCM
• AES-SIV
• ARIA
• ASCON v1.2 (noch nicht SP 800-232)
• Camellia
• ChaCha20-Poly1305
• Chunked-Verschlüsselung (Cobblestone)
• XChaCha20-Poly1305
• DH
• DHIES
• DSA
• ECDH
• ECDSA
• EdDSA
• ECIES
• HKDF
• HMAC
• KMAC
• MORUS
• PBKDF2
• RSA
• SEED
• SipHash
• SM4
• VMAC
• X25519, X448
• BLS-12-381
• ML-KEM (CRYSTALS-Kyber)
• ML-DSA (CRYSTALS-Dilithium)

Die Testvektoren erkennen, ob eine Bibliothek anfällig für viele Angriffe ist, darunter

• Angriffe auf ungültige Kurven
• Verzerrte Nonces in digitalen Signaturschemata
• Natürlich alle Bleichenbacher-Angriffe
• Und viele weitere – wir haben über 80 Testfälle

Wir freuen uns über Beiträge neuer Testvektordaten und Algorithmen.

Mitwirken

Wenn Sie mitwirken möchten, lesen Sie bitte CONTRIBUTING und senden Sie uns Pull-Requests. Sie können auch Fehler melden oder neue Tests als GitHub Issues anfordern.

Entwicklungsprioritäten

Wir sind dabei, die Entwicklung und Wartung von Project Wycheproof als C2SP-Projekt wiederzubeleben, mit einem erneuten Fokus auf die Testvektordaten. Unsere unmittelbaren Prioritäten sind:

1. Vervollständigen der JSON-Schema-Beschreibungen aller Testvektoren.
2. Verbesserung der Dokumentation und Tooling-Unterstützung für externe Mitwirkende, um neue Testdaten zu bestehenden Vektordateien bereitzustellen.
3. Aufbau einer Community von nachgelagerten Konsumenten, die bei der Wartung und Überprüfung neuer Testvektordaten helfen können.
4. Hinzufügen weiterer Algorithmen- und Testfallabdeckung zu den Testvektordaten.

FAQ

Warum heißt das Projekt „Wycheproof“?

Project Wycheproof ist nach dem Mount Wycheproof benannt, dem kleinsten Berg der Welt. Die Hauptmotivation für das Projekt zum Zeitpunkt seiner Erstellung war es, ein erreichbares Ziel zu haben. Je kleiner der Berg, desto wahrscheinlicher ist es, ihn besteigen zu können.

Welche nachgelagerten Projekte verwenden Wycheproof-Testvektoren?

Wycheproof-Testvektoren werden in irgendeiner Form von einer Reihe wichtiger Kryptografieprojekte und -bibliotheken verwendet. In keiner bestimmten Reihenfolge umfassen diese:

• OpenSSL
• BoringSSL
• aws-lc
• LibreSSL
• NSS
• pyca/cryptography
• Botan
• Go cryptography
• swift-crypto
• RustCrypto
• Graviola
• Tink
• PyCryptdome
• OpenTitan
• Zig
• liboqs
• bc-rust
• leancrypto
• Odin

Falls Ihr Projekt Testvektoren von Wycheproof verwendet, können Sie gerne einen PR eröffnen, um es zur obigen Liste hinzuzufügen!

Hat das Wycheproof-Testen bemerkenswerte Fehler gefunden?

Siehe doc/bugs.md für einige bemerkenswerte historische Fehler, die mit Wycheproofs Test-Harnesses oder Testvektordaten gefunden wurden.

Wo ist das testvectors/-Verzeichnis?

Wir haben kürzlich die Verzeichnisse testvectors/ und testvectors_v1/ zu einem einzigen vereinheitlichten Verzeichnis mit einem einheitlichen Schema-Ansatz zusammengeführt.

Benutzer, die die ursprünglichen ("v0") Testvektordaten benötigen, können dieses Repository vom wycheproof-v0-vectors Tag klonen, werden aber ermutigt, auf die Verwendung von testvectors_v1/ umzusteigen, um von zukünftigen Aktualisierungen zu profitieren. Falls Funktionen/Testabdeckungen aus testvectors/ in testvectors_v1/ fehlen oder ein anderes Problem Ihre Aktualisierung blockiert, eröffnen Sie bitte ein Issue, das Ihre Anforderungen beschreibt.

Haben alle Vektoren Schemas?

Zum Zeitpunkt der Erstellung dieses Dokuments fehlen den folgenden testvectors_v1-Dateien Schemas:

• testvectors_v1/aes_ff1_base*_test.json
• testvectors_v1/aes_ff1_radix*_test.json
• testvectors_v1/ecdsa_secp256k1_sha256_bitcoin_test.json
• testvectors_v1/pbes2_hmacsha*_aes_*_test.json
• testvectors_v1/pbkdf2_hmacsha*_test.json
• testvectors_v1/rsa_pss_*_sha*_mgf*_params_test.json
• testvectors_v1/rsa_pss_misc_params_test.json

Beiträge von Schemas für die obigen Vektoren wären sehr willkommen.

Gibt es zusätzliche Dokumentation zu Testvektoren?

Einige ältere Dokumentationen zu Dateien, Formaten und Typen sind verfügbar, aber nicht unbedingt auf dem aktuellen Stand der Testvektoren.

Im Allgemeinen ist es vorzuziehen, auf die Schema-Dateien zu verweisen, da diese in CI getestet werden, um sicherzustellen, dass die Vektordateiinhalte mit ihrem angegebenen Schema übereinstimmen.

Wo ist der Test-Harness-Code?