-
Notifications
You must be signed in to change notification settings - Fork 4.1k
THRIFT-5855: Add netstd fuzzers #3402
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
108 changes: 108 additions & 0 deletions
108
lib/netstd/Tests/Thrift.FuzzTests/ProtocolFuzzerBase.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| // Licensed to the Apache Software Foundation(ASF) under one | ||
| // or more contributor license agreements.See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership.The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| using System; | ||
| using System.IO; | ||
| using SharpFuzz; | ||
| using Thrift.Protocol; | ||
| using Thrift.Transport; | ||
| using Thrift.Transport.Client; | ||
|
|
||
| namespace Thrift.Tests.Protocols.Fuzzers | ||
| { | ||
| /// <summary> | ||
| /// Base class for protocol fuzzers that handles the common fuzzing logic. | ||
| /// </summary> | ||
| /// <typeparam name="FuzzProtocol">The type of protocol to use for deserialization.</typeparam> | ||
| public abstract class ProtocolFuzzerBase<FuzzProtocol> where FuzzProtocol : TProtocol | ||
| { | ||
| /// <summary> | ||
| /// Environment variable that controls whether to use in-process fuzzing for AFL. | ||
| /// When set to "1", uses Fuzzer.Run instead of Fuzzer.OutOfProcess.Run. | ||
| /// </summary> | ||
| protected const string UseInProcessFuzzingEnvVar = "THRIFT_AFL_IN_PROCESS"; | ||
|
|
||
| /// <summary> | ||
| /// 10MB message size limit to prevent over-allocation during fuzzing | ||
| /// </summary> | ||
| protected const int FUZZ_MAX_MESSAGE_SIZE = 10 * 1024 * 1024; | ||
|
|
||
| /// <summary> | ||
| /// Creates a new instance of the protocol for the given transport. | ||
| /// </summary> | ||
| protected abstract FuzzProtocol CreateProtocol(TTransport transport); | ||
|
|
||
| /// <summary> | ||
| /// Helper method that contains the core fuzzing logic. | ||
| /// </summary> | ||
| private void ProcessFuzzStream(Stream stream) | ||
| { | ||
| try | ||
| { | ||
| var config = new TConfiguration(); | ||
| config.MaxMessageSize = FUZZ_MAX_MESSAGE_SIZE; | ||
| var transport = new TStreamTransport(stream, null, config); | ||
| var protocol = CreateProtocol(transport); | ||
|
|
||
| var obj = new FuzzTest(); | ||
| obj.ReadAsync(protocol, default).GetAwaiter().GetResult(); | ||
| } | ||
| // Narrow catch list: these are the exception families we expect from the | ||
| // protocol/transport layer on malformed fuzzer input. Do NOT widen to | ||
| // catch (Exception) — a broad catch would swallow legitimate bugs and | ||
| // defeat the purpose of fuzzing. | ||
| catch (TProtocolException) { /* Expected for malformed fuzzer input */ } | ||
| catch (TTransportException) { /* Expected for malformed fuzzer input */ } | ||
| catch (TException) { /* Expected for malformed fuzzer input */ } | ||
| catch (EndOfStreamException) { /* Expected for malformed fuzzer input */ } | ||
| catch (IOException) { /* Expected for malformed fuzzer input */ } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// The core fuzzing logic that processes a single input. | ||
| /// </summary> | ||
| protected void ProcessFuzzInput(ReadOnlySpan<byte> span) | ||
| { | ||
| using var stream = new MemoryStream(span.ToArray()); | ||
| ProcessFuzzStream(stream); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Runs the fuzzer with LibFuzzer. | ||
| /// </summary> | ||
| protected void RunLibFuzzer() | ||
| { | ||
| Fuzzer.LibFuzzer.Run(ProcessFuzzInput); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Runs the fuzzer with AFL. | ||
| /// </summary> | ||
| protected void RunAFL() | ||
| { | ||
| var useInProcess = Environment.GetEnvironmentVariable(UseInProcessFuzzingEnvVar) == "1"; | ||
| if (useInProcess) | ||
| { | ||
| Fuzzer.Run(ProcessFuzzStream); | ||
| } | ||
| else | ||
| { | ||
| Fuzzer.OutOfProcess.Run(ProcessFuzzStream); | ||
| } | ||
| } | ||
| } | ||
| } |
133 changes: 133 additions & 0 deletions
133
lib/netstd/Tests/Thrift.FuzzTests/ProtocolRoundtripFuzzerBase.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| // Licensed to the Apache Software Foundation(ASF) under one | ||
| // or more contributor license agreements.See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership.The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| using System; | ||
| using System.IO; | ||
| using SharpFuzz; | ||
| using Thrift.Protocol; | ||
| using Thrift.Transport; | ||
| using Thrift.Transport.Client; | ||
|
|
||
| namespace Thrift.Tests.Protocols.Fuzzers | ||
| { | ||
| /// <summary> | ||
| /// Base class for protocol round-trip fuzzers that handles the common fuzzing logic. | ||
| /// </summary> | ||
| /// <typeparam name="FuzzProtocol">The type of protocol to use for serialization/deserialization.</typeparam> | ||
| public abstract class ProtocolRoundtripFuzzerBase<FuzzProtocol> where FuzzProtocol : TProtocol | ||
| { | ||
| /// <summary> | ||
| /// Environment variable that controls whether to use in-process fuzzing for AFL. | ||
| /// When set to "1", uses Fuzzer.Run instead of Fuzzer.OutOfProcess.Run. | ||
| /// </summary> | ||
| protected const string UseInProcessFuzzingEnvVar = "THRIFT_AFL_IN_PROCESS"; | ||
|
|
||
| /// <summary> | ||
| /// 10MB message size limit to prevent over-allocation during fuzzing | ||
| /// </summary> | ||
| protected const int FUZZ_MAX_MESSAGE_SIZE = 10 * 1024 * 1024; | ||
|
|
||
| /// <summary> | ||
| /// Creates a new instance of the protocol for the given transport. | ||
| /// </summary> | ||
| protected abstract FuzzProtocol CreateProtocol(TTransport transport); | ||
|
|
||
| /// <summary> | ||
| /// Helper method that contains the core fuzzing logic. | ||
| /// </summary> | ||
| private void ProcessFuzzStream(Stream stream) | ||
| { | ||
| try | ||
| { | ||
| // First deserialize the input | ||
| var config = new TConfiguration(); | ||
| config.MaxMessageSize = FUZZ_MAX_MESSAGE_SIZE; | ||
| var inputTransport = new TStreamTransport(stream, null, config); | ||
| var inputProtocol = CreateProtocol(inputTransport); | ||
|
|
||
| var inputObj = new FuzzTest(); | ||
| inputObj.ReadAsync(inputProtocol, default).GetAwaiter().GetResult(); | ||
|
|
||
| // Now serialize it back | ||
| using var outputStream = new MemoryStream(); | ||
| var outputTransport = new TStreamTransport(null, outputStream, config); | ||
| var outputProtocol = CreateProtocol(outputTransport); | ||
| inputObj.WriteAsync(outputProtocol, default).GetAwaiter().GetResult(); | ||
| outputTransport.FlushAsync(default).GetAwaiter().GetResult(); | ||
|
|
||
| // Get the serialized bytes and deserialize again | ||
| var serialized = outputStream.ToArray(); | ||
| using var reStream = new MemoryStream(serialized); | ||
| var reTransport = new TStreamTransport(reStream, null, config); | ||
| var reProtocol = CreateProtocol(reTransport); | ||
|
|
||
| var outputObj = new FuzzTest(); | ||
| outputObj.ReadAsync(reProtocol, default).GetAwaiter().GetResult(); | ||
|
|
||
| // Compare the objects | ||
| if (!inputObj.Equals(outputObj)) | ||
| { | ||
| throw new Exception("Round-trip objects are not equal"); | ||
| } | ||
| } | ||
| // Narrow catch list: these are the exception families we expect from the | ||
| // protocol/transport layer on malformed fuzzer input. Do NOT widen to | ||
| // catch (Exception) — a broad catch would swallow the | ||
| // "Round-trip objects are not equal" System.Exception thrown above, | ||
| // which is exactly the round-trip divergence the fuzzer is supposed to | ||
| // surface as a finding. | ||
| catch (TProtocolException) { /* Expected for malformed fuzzer input */ } | ||
| catch (TTransportException) { /* Expected for malformed fuzzer input */ } | ||
| catch (TException) { /* Expected for malformed fuzzer input */ } | ||
| catch (EndOfStreamException) { /* Expected for malformed fuzzer input */ } | ||
| catch (IOException) { /* Expected for malformed fuzzer input */ } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// The core fuzzing logic that processes a single input. | ||
| /// </summary> | ||
| protected void ProcessFuzzInput(ReadOnlySpan<byte> span) | ||
| { | ||
| using var stream = new MemoryStream(span.ToArray()); | ||
| ProcessFuzzStream(stream); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Runs the fuzzer with LibFuzzer. | ||
| /// </summary> | ||
| protected void RunLibFuzzer() | ||
| { | ||
| Fuzzer.LibFuzzer.Run(ProcessFuzzInput); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Runs the fuzzer with AFL. | ||
| /// </summary> | ||
| protected void RunAFL() | ||
| { | ||
| var useInProcess = Environment.GetEnvironmentVariable(UseInProcessFuzzingEnvVar) == "1"; | ||
| if (useInProcess) | ||
| { | ||
| Fuzzer.Run(ProcessFuzzStream); | ||
| } | ||
| else | ||
| { | ||
| Fuzzer.OutOfProcess.Run(ProcessFuzzStream); | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lowpri: is it possible to have a mode where they are built by make check (without fuzz instrumentation)?
the reason I ask is e.g. to avoid cases where we make some change to the code that breaks the fuzzer build, and then we don't realize it because compilation doesn't run in CI