/* ========================================================================
* Copyright (c) 2005-2025 The OPC Foundation, Inc. All rights reserved.
*
* OPC Foundation MIT License 1.00
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*
* The complete license agreement can be found here:
* http://opcfoundation.org/License/MIT/1.00/
* ======================================================================*/
using System;
using System.IO;
using System.Linq;
using System.Xml;
namespace Opc.Ua.Fuzzing
{
///
/// Fuzzing code for the Xml decoder and encoder.
///
public static partial class FuzzableCode
{
///
/// The Xml decoder fuzz target for afl-fuzz.
///
public static void AflfuzzXmlDecoder(Stream stream)
{
_ = FuzzXmlDecoderCore(stream);
}
///
/// The Xml encoder fuzz target for afl-fuzz.
///
public static void AflfuzzXmlEncoder(Stream stream)
{
IEncodeable? encodeable = FuzzXmlDecoderCore(stream);
if (encodeable != null)
{
using var encoder = new XmlEncoder(MessageContext);
encoder.EncodeMessage(encodeable, encodeable.TypeId);
encoder.Close();
}
}
///
/// The Xml encoder idempotent fuzz target for afl-fuzz.
///
public static void AflfuzzXmlEncoderIndempotent(Stream stream)
{
IEncodeable? encodeable = FuzzXmlDecoderCore(stream);
if (encodeable != null)
{
string serialized = EncodeXmlMessage(encodeable);
FuzzXmlEncoderIndempotentCore(serialized, encodeable);
}
}
///
/// The Xml decoder fuzz target for libfuzzer.
///
public static void LibfuzzXmlDecoder(ReadOnlySpan input)
{
using var memoryStream = new MemoryStream(input.ToArray());
_ = FuzzXmlDecoderCore(memoryStream);
}
///
/// The Xml encoder fuzz target for afl-fuzz.
///
public static void LibfuzzXmlEncoder(ReadOnlySpan input)
{
using var memoryStream = new MemoryStream(input.ToArray());
AflfuzzXmlEncoder(memoryStream);
}
///
/// The Xml encoder idempotent fuzz target for libfuzzer.
///
public static void LibfuzzXmlEncoderIndempotent(ReadOnlySpan input)
{
using var memoryStream = new MemoryStream(input.ToArray());
AflfuzzXmlEncoderIndempotent(memoryStream);
}
///
/// The idempotent fuzz target core for the XmlEncoder.
///
///
internal static void FuzzXmlEncoderIndempotentCore(
string serialized,
IEncodeable encodeable)
{
if (serialized == null || encodeable == null)
{
return;
}
using var memoryStream = new MemoryStream(System.Text.Encoding.UTF8.GetBytes(serialized));
IEncodeable encodeable2 = FuzzXmlDecoderCore(memoryStream, true)!;
string serialized2 = EncodeXmlMessage(encodeable2);
using var memoryStream2 = new MemoryStream(System.Text.Encoding.UTF8.GetBytes(serialized2));
IEncodeable encodeable3 = FuzzXmlDecoderCore(memoryStream2, true)!;
string encodeableTypeName = encodeable2?.GetType().Name ?? "unknown type";
if (serialized2 == null || !serialized.SequenceEqual(serialized2))
{
throw new EncodingFidelityException(
Utils.Format("Idempotent XML encoding failed. Type={0}.", encodeableTypeName));
}
if (!Utils.IsEqual(encodeable2, encodeable3))
{
throw new EncodingFidelityException(Utils.Format(
"Idempotent XML 3rd gen decoding failed. Type={0}.",
encodeableTypeName));
}
}
private static string EncodeXmlMessage(IEncodeable encodeable)
{
using var encoder = new XmlEncoder(MessageContext);
encoder.EncodeMessage(encodeable, encodeable.TypeId);
return encoder.CloseAndReturnText() ?? string.Empty;
}
///
/// The fuzz target for the XmlDecoder.
///
/// A stream with fuzz content.
internal static IEncodeable? FuzzXmlDecoderCore(Stream stream, bool throwAll = false)
{
try
{
return DecodeWithOracles(nameof(XmlDecoder), GetRemainingLength(stream), () =>
{
using XmlReader reader = XmlReader.Create(stream, Utils.DefaultXmlReaderSettings());
reader.MoveToContent();
using var decoder = new XmlDecoder(reader, MessageContext);
return decoder.DecodeMessage();
});
}
catch (XmlException exception)
{
if (!throwAll)
{
return null;
}
throw new ServiceResultException(StatusCodes.BadDecodingError, exception.Message, exception);
}
catch (ServiceResultException exception) when (!throwAll && IsExpectedDecodingError(exception))
{
return null;
}
}
}
}