Ruzzy
Ruzzy ist ein coverage-gesteuerter Fuzzer für Ruby, der auf libFuzzer basiert. Er ermöglicht das Fuzzen sowohl von reinem Ruby-Code als auch von Ruby-C-Erweiterungen mit Sanitizer-Unterstützung zur Erkennung von Speicherkorruption und undefiniertem Verhalten.
Wann verwenden
Ruzzy ist derzeit der einzige produktionsreife coverage-gesteuerte Fuzzer für Ruby.
Wählen Sie Ruzzy, wenn:
- Sie Ruby-Anwendungen oder -Bibliotheken fuzzen möchten
- Sie Ruby-C-Erweiterungen auf Speichersicherheitsprobleme testen möchten
- Sie coverage-gesteuertes Fuzzing für Ruby-Code benötigen
- Sie mit Ruby-Gems arbeiten, die native Erweiterungen haben
Schnellstart
Umgebung einrichten:
export ASAN_OPTIONS="allocator_may_return_null=1:detect_leaks=0:use_sigaltstack=0"
Test mit dem mitgelieferten Beispiel:
LD_PRELOAD=$(ruby -e 'require "ruzzy"; print Ruzzy::ASAN_PATH') \
ruby -e 'require "ruzzy"; Ruzzy.dummy'
Dies sollte schnell einen Absturz finden, der zeigt, dass Ruzzy korrekt funktioniert.
Installation
Plattformunterstützung
Ruzzy unterstützt Linux x86-64 und AArch64/ARM64. Verwenden Sie für macOS oder Windows das Dockerfile oder die Entwicklungsumgebung.
Voraussetzungen
- Linux x86-64 oder AArch64/ARM64
- Aktuelle Version von clang (getestet ab 14.0.0, neueste Version empfohlen)
- Ruby mit installiertem gem
Installationsbefehl
Installieren Sie Ruzzy mit clang-Compiler-Flags:
MAKE="make --environment-overrides V=1" \
CC="/pfad/zu/clang" \
CXX="/pfad/zu/clang++" \
LDSHARED="/pfad/zu/clang -shared" \
LDSHAREDXX="/pfad/zu/clang++ -shared" \
gem install ruzzy
Erklärung der Umgebungsvariablen:
MAKE: Überschreibt make, um nachfolgende Umgebungsvariablen zu respektierenCC,CXX,LDSHARED,LDSHAREDXX: Stellen sicher, dass die richtigen clang-Binärdateien für die neuesten Funktionen verwendet werden
Fehlerbehebung bei der Installation
Wenn die Installation fehlschlägt, aktivieren Sie die Debug-Ausgabe:
RUZZY_DEBUG=1 gem install --verbose ruzzy
Überprüfung
Überprüfen Sie die Installation, indem Sie das Beispiel aus dem Schnellstart ausführen.
Schreiben eines Harness
Fuzzing von reinem Ruby-Code
Reines Ruby-Fuzzing erfordert aufgrund der Implementierung des Ruby-Interpreters zwei Skripte.
Tracer-Skript (test_tracer.rb):
# frozen_string_literal: true
require 'ruzzy'
Ruzzy.trace('test_harness.rb')
Harness-Skript (test_harness.rb):
# frozen_string_literal: true
require 'ruzzy'
def fuzzing_target(input)
# Ihr zu fuzzender Code hier
if input.length == 4
if input[0] == 'F'
if input[1] == 'U'
if input[2] == 'Z'
if input[3] == 'Z'
raise
end
end
end
end
end
end
test_one_input = lambda do |data|
fuzzing_target(data)
return 0
end
Ruzzy.fuzz(test_one_input)
Ausführen mit:
LD_PRELOAD=$(ruby -e 'require "ruzzy"; print Ruzzy::ASAN_PATH') \
ruby test_tracer.rb
Fuzzing von Ruby-C-Erweiterungen
C-Erweiterungen können mit einer einzigen Harness-Datei gefuzzt werden, ohne Tracer.
Beispiel-Harness für msgpack (fuzz_msgpack.rb):
# frozen_string_literal: true
require 'msgpack'
require 'ruzzy'
test_one_input = lambda do |data|
begin
MessagePack.unpack(data)
rescue Exception
# Wir suchen nach Speicherkorruption, nicht nach Ruby-Ausnahmen
end
return 0
end
Ruzzy.fuzz(test_one_input)
Ausführen mit:
LD_PRELOAD=$(ruby -e 'require "ruzzy"; print Ruzzy::ASAN_PATH') \
ruby fuzz_msgpack.rb
Harness-Regeln
| Tun | Nicht tun |
|---|---|
| Ruby-Ausnahmen abfangen, wenn Sie C-Erweiterungen testen | Ruby-Ausnahmen den Fuzzer abstürzen lassen |
return 0 aus der test_one_input-Lambda-Funktion | Andere Werte zurückgeben |
| Harness deterministisch halten | Zufälligkeit oder zeitbasierte Logik verwenden |
| Tracer-Skript für reines Ruby verwenden | Tracer für reinen Ruby-Code überspringen |
Siehe auch: Detaillierte Techniken zum Schreiben von Harnesses, Muster für die Verarbeitung komplexer Eingaben und fortgeschrittene Strategien finden Sie im Technik-Skill fuzz-harness-writing.
Kompilierung
Installieren von Gems mit Sanitizern
Wenn Sie Ruby-Gems mit C-Erweiterungen zum Fuzzen installieren, kompilieren Sie mit Sanitizer-Flags:
MAKE="make --environment-overrides V=1" \
CC="/pfad/zu/clang" \
CXX="/pfad/zu/clang++" \
LDSHARED="/pfad/zu/clang -shared" \
LDSHAREDXX="/pfad/zu/clang++ -shared" \
CFLAGS="-fsanitize=address,fuzzer-no-link -fno-omit-frame-pointer -fno-common -fPIC -g" \
CXXFLAGS="-fsanitize=address,fuzzer-no-link -fno-omit-frame-pointer -fno-common -fPIC -g" \
gem install <gem-name>
Build-Flags
| Flag | Zweck |
|---|---|
-fsanitize=address,fuzzer-no-link | AddressSanitizer und Fuzzer-Instrumentierung aktivieren |
-fno-omit-frame-pointer | Verbesserung der Stack-Trace-Qualität |
-fno-common | Bessere Kompatibilität mit Sanitizern |
-fPIC | Positionsunabhängiger Code für Shared Libraries |
-g | Debug-Symbole einschließen |
Ausführen von Kampagnen
Umgebungseinrichtung
Setzen Sie vor dem Start einer Fuzzing-Kampagne ASAN_OPTIONS:
export ASAN_OPTIONS="allocator_may_return_null=1:detect_leaks=0:use_sigaltstack=0"
Erklärung der Optionen:
allocator_may_return_null=1: Überspringt häufige, wenig folgenreiche Allokationsfehler (DoS)detect_leaks=0: Der Ruby-Interpreter verliert Daten – ignorieren Sie dies vorerstuse_sigaltstack=0: Ruby empfiehlt, sigaltstack mit ASan zu deaktivieren
Grundlegender Aufruf
LD_PRELOAD=$(ruby -e 'require "ruzzy"; print Ruzzy::ASAN_PATH') \
ruby harness.rb
Hinweis: LD_PRELOAD wird für die Sanitizer-Injektion benötigt. Exportieren Sie es nicht, da es andere Programme stören kann.
Mit Korpus
LD_PRELOAD=$(ruby -e 'require "ruzzy"; print Ruzzy::ASAN_PATH') \
ruby harness.rb /pfad/zu/korpus
Übergeben von libFuzzer-Optionen
Alle libFuzzer-Optionen können als Argumente übergeben werden:
LD_PRELOAD=$(ruby -e 'require "ruzzy"; print Ruzzy::ASAN_PATH') \
ruby harness.rb /pfad/zu/korpus -max_len=1024 -timeout=10
Die vollständige Referenz finden Sie unter libFuzzer-Optionen.
Reproduzieren von Abstürzen
Führen Sie einen Absturzfall erneut aus, indem Sie die Absturzdatei übergeben:
LD_PRELOAD=$(ruby -e 'require "ruzzy"; print Ruzzy::ASAN_PATH') \
ruby harness.rb ./crash-253420c1158bc6382093d409ce2e9cff5806e980
Interpretieren der Ausgabe
| Ausgabe | Bedeutung |
|---|---|
INFO: Running with entropic power schedule | Fuzzing-Kampagne gestartet |
ERROR: AddressSanitizer: heap-use-after-free | Speicherkorruption erkannt |
SUMMARY: libFuzzer: fuzz target exited | Ruby-Ausnahme aufgetreten |
artifact_prefix='./'; Test unit written to ./crash-* | Absturz-Eingabe gespeichert |
Base64: ... | Base64-Kodierung der Absturz-Eingabe |
Sanitizer-Integration
AddressSanitizer (ASan)
Ruzzy enthält eine vorkompilierte AddressSanitizer-Bibliothek:
LD_PRELOAD=$(ruby -e 'require "ruzzy"; print Ruzzy::ASAN_PATH') \
ruby harness.rb
ASan wird verwendet zur Erkennung von:
- Heap-Pufferüberläufen
- Stack-Pufferüberläufen
- Use-after-free
- Double-free
- Speicherlecks (in Ruzzy standardmäßig deaktiviert)
UndefinedBehaviorSanitizer (UBSan)
Ruzzy enthält auch UBSan:
LD_PRELOAD=$(ruby -e 'require "ruzzy"; print Ruzzy::UBSAN_PATH') \
ruby harness.rb
UBSan wird verwendet zur Erkennung von:
- Vorzeichenbehaftetem Integer-Überlauf
- Nullzeiger-Dereferenzierungen
- Fehlausgerichteten Speicherzugriffen
- Division durch Null
Häufige Sanitizer-Probleme
| Problem | Lösung |
|---|---|
| Warnungen wegen Lecks im Ruby-Interpreter | ASAN_OPTIONS=detect_leaks=0 verwenden |
| Konflikte mit Sigaltstack | ASAN_OPTIONS=use_sigaltstack=0 verwenden |
| Spam durch Allokationsfehler | ASAN_OPTIONS=allocator_may_return_null=1 verwenden |
| LD_PRELOAD stört Werkzeuge | Nicht exportieren; inline mit ruby-Befehl setzen |
Siehe auch: Detaillierte Konfiguration der Sanitizer, häufige Probleme und erweiterte Flags finden Sie in den Technik-Skills address-sanitizer und undefined-behavior-sanitizer.
Beispiele aus der Praxis
Beispiel: msgpack-ruby
Fuzzing des msgpack MessagePack-Parsers auf Speicherkorruption.
Installation mit Sanitizern:
MAKE="make --environment-overrides V=1" \
CC="/pfad/zu/clang" \
CXX="/pfad/zu/clang++" \
LDSHARED="/pfad/zu/clang -shared" \
LDSHAREDXX="/pfad/zu/clang++ -shared" \
CFLAGS="-fsanitize=address,fuzzer-no-link -fno-omit-frame-pointer -fno-common -fPIC -g" \
CXXFLAGS="-fsanitize=address,fuzzer-no-link -fno-omit-frame-pointer -fno-common -fPIC -g" \
gem install msgpack
Harness (fuzz_msgpack.rb):
# frozen_string_literal: true
require 'msgpack'
require 'ruzzy'
test_one_input = lambda do |data|
begin
MessagePack.unpack(data)
rescue Exception
# Wir suchen nach Speicherkorruption, nicht nach Ruby-Ausnahmen
end
return 0
end
Ruzzy.fuzz(test_one_input)
Ausführen:
export ASAN_OPTIONS="allocator_may_return_null=1:detect_leaks=0:use_sigaltstack=0"
LD_PRELOAD=$(ruby -e 'require "ruzzy"; print Ruzzy::ASAN_PATH') \
ruby fuzz_msgpack.rb
Beispiel: Reines Ruby-Ziel
Fuzzing von reinem Ruby-Code mit einem benutzerdefinierten Parser.
Tracer (test_tracer.rb):
# frozen_string_literal: true
require 'ruzzy'
Ruzzy.trace('test_harness.rb')
Harness (test_harness.rb):
# frozen_string_literal: true
require 'ruzzy'
require_relative 'my_parser'
test_one_input = lambda do |data|
begin
MyParser.parse(data)
rescue StandardError
# Erwartete Ausnahmen aufgrund fehlerhafter Eingaben
end
return 0
end
Ruzzy.fuzz(test_one_input)
Ausführen:
export ASAN_OPTIONS="allocator_may_return_null=1:detect_leaks=0:use_sigaltstack=0"
LD_PRELOAD=$(ruby -e 'require "ruzzy"; print Ruzzy::ASAN_PATH') \
ruby test_tracer.rb
Fehlerbehebung
| Problem | Ursache | Lösung |
|---|---|---|
| Installation schlägt fehl | Falsche clang-Version oder -Pfad | clang-Pfad überprüfen, clang 14.0.0+ verwenden |
cannot open shared object file | LD_PRELOAD nicht gesetzt | LD_PRELOAD inline mit ruby-Befehl setzen |
| Fuzzer beendet sofort | Fehlendes Korpus-Verzeichnis | Korpus-Verzeichnis erstellen oder als Argument übergeben |
| Kein Coverage-Fortschritt | Reines Ruby benötigt Tracer | Tracer-Skript für reinen Ruby-Code verwenden |
| Spam durch Lecksuche | Ruby-Interpreter leckt | ASAN_OPTIONS=detect_leaks=0 setzen |
| Debug bei Installation erforderlich | Kompilierungsfehler | RUZZY_DEBUG=1 gem install --verbose ruzzy verwenden |
Verwandte Skills
Technik-Skills
| Skill | Verwendungszweck |
|---|---|
| fuzz-harness-writing | Detaillierte Anleitung zum Schreiben effektiver Harnesses |
| address-sanitizer | Erkennung von Speicherfehlern während des Fuzzings |
| undefined-behavior-sanitizer | Erkennung von undefiniertem Verhalten in C-Erweiterungen |
| libfuzzer | Verstehen der libFuzzer-Optionen (Ruzzy basiert auf libFuzzer) |
Verwandte Fuzzer
| Skill | Wann in Betracht ziehen |
|---|---|
| libfuzzer | Wenn Sie Ruby-C-Erweiterungscode direkt in C/C++ fuzzen |
| aflpp | Alternativer Ansatz zum Fuzzen von Ruby durch Instrumentierung des Ruby-Interpreters |
Ressourcen
Wichtige externe Ressourcen
Einführung von Ruzzy, einem coverage-gesteuerten Ruby-Fuzzer Offizieller Blogbeitrag von Trail of Bits, der Ruzzy ankündigt, mit Motivation, Architektur und ersten Ergebnissen.
Ruzzy GitHub-Repository Quellcode, zusätzliche Beispiele und Entwicklungsanleitungen.
libFuzzer-Dokumentation Da Ruzzy auf libFuzzer basiert, ist das Verständnis der libFuzzer-Optionen und des Verhaltens wertvoll.
Fuzzing von Ruby-C-Erweiterungen Detaillierte Anleitung zum Fuzzen von C-Erweiterungen mit Compiler-Flags und Beispielen.
Fuzzing von reinem Ruby-Code Detaillierte Anleitung zum Tracer-Muster, das für reines Ruby-Fuzzing erforderlich ist.