UA-.NETStandard/fuzzing/Opc.Ua.Encoders.Fuzz/FuzzableCode.XmlDecoder.cs

/* ========================================================================
 * 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
{
    /// <summary>
    /// Fuzzing code for the Xml decoder and encoder.
    /// </summary>
    public static partial class FuzzableCode
    {
        /// <summary>
        /// The Xml decoder fuzz target for afl-fuzz.
        /// </summary>
        public static void AflfuzzXmlDecoder(Stream stream)
        {
            _ = FuzzXmlDecoderCore(stream);
        }

        /// <summary>
        /// The Xml encoder fuzz target for afl-fuzz.
        /// </summary>
        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();
            }
        }

        /// <summary>
        /// The Xml encoder idempotent fuzz target for afl-fuzz.
        /// </summary>
        public static void AflfuzzXmlEncoderIndempotent(Stream stream)
        {
            IEncodeable? encodeable = FuzzXmlDecoderCore(stream);
            if (encodeable != null)
            {
                string serialized = EncodeXmlMessage(encodeable);
                FuzzXmlEncoderIndempotentCore(serialized, encodeable);
            }
        }

        /// <summary>
        /// The Xml decoder fuzz target for libfuzzer.
        /// </summary>
        public static void LibfuzzXmlDecoder(ReadOnlySpan<byte> input)
        {
            using var memoryStream = new MemoryStream(input.ToArray());
            _ = FuzzXmlDecoderCore(memoryStream);
        }

        /// <summary>
        /// The Xml encoder fuzz target for afl-fuzz.
        /// </summary>
        public static void LibfuzzXmlEncoder(ReadOnlySpan<byte> input)
        {
            using var memoryStream = new MemoryStream(input.ToArray());
            AflfuzzXmlEncoder(memoryStream);
        }

        /// <summary>
        /// The Xml encoder idempotent fuzz target for libfuzzer.
        /// </summary>
        public static void LibfuzzXmlEncoderIndempotent(ReadOnlySpan<byte> input)
        {
            using var memoryStream = new MemoryStream(input.ToArray());
            AflfuzzXmlEncoderIndempotent(memoryStream);
        }

        /// <summary>
        /// The idempotent fuzz target core for the XmlEncoder.
        /// </summary>
        /// <exception cref="InvalidOperationException"></exception>
        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;
        }

        /// <summary>
        /// The fuzz target for the XmlDecoder.
        /// </summary>
        /// <param name="stream">A stream with fuzz content.</param>
        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<IEncodeable>();
                });
            }
            catch (XmlException exception)
            {
                if (!throwAll)
                {
                    return null;
                }
                throw new ServiceResultException(StatusCodes.BadDecodingError, exception.Message, exception);
            }
            catch (ServiceResultException exception) when (!throwAll && IsExpectedDecodingError(exception))
            {
                return null;
            }
        }
    }
}