CA5369: Verwenden Sie XmlReader zur Deserialisierung.

  • Artikel
Eigenschaft Wert
Regel-ID CA5369
Titel Verwenden Sie XmlReader zur Deserialisierung.
Kategorie Security
Fix führt oder führt nicht zur Unterbrechung Nicht unterbrechend
Standardmäßig in .NET 8 aktiviert Nein

Ursache

Das Deserialisieren nicht vertrauenswürdiger XML-Eingaben mit XmlSerializer.Deserialize, instanziiert ohne ein XmlReader-Objekt, kann potenziell zu Denial-of-Service, Offenlegung von Informationen und serverseitigen Anforderungsfälschungsangriffen führen. Diese Angriffe werden durch nicht vertrauenswürdige DTD-und XML-Schemaverarbeitung ermöglicht, sodass XML-Bomben und schädliche externe Entitäten in den XML-Code eingefügt werden können. Nur mit XmlReader kann DTD deaktiviert werden. Bei der Inline-XML-Schemaverarbeitung als XmlReader, ist die ProhibitDtd- und ProcessInlineSchema-Eigenschaft standardmäßig auf false in der .NET Framework-Version 4.0 und später festgelegt. Die anderen Optionen, wie z. b. Stream, TextReader und XmlSerializationReader, können die DTD-Verarbeitung nicht deaktivieren.

Regelbeschreibung

Die Verarbeitung nicht vertrauenswürdiger DTD- und XML-Schemas kann das Laden gefährlicher externer Verweise ermöglichen. Dies sollte eingeschränkt werden, indem ein XmlReader mit einem sicheren Konfliktlöser oder deaktivierter Inline-Schemaverarbeitung für DTD und XML verwendet wird. Mit dieser Regel wird Code erkannt, der die XmlSerializer.Deserialize-Methode und nicht XmlReader als Konstruktorparameter verwendet.

Behandeln von Verstößen

Verwenden Sie keine XmlSerializer.Deserialize-Überladungen außer Deserialize(XmlReader), Deserialize(XmlReader, String), Deserialize(XmlReader, XmlDeserializationEvents) oder Deserialize(XmlReader, String, XmlDeserializationEvents).

Wann sollten Warnungen unterdrückt werden?

Sie können diese Warnung möglicherweise unterdrücken, wenn die analysierte XML von einer vertrauenswürdigen Quelle stammt und daher nicht manipuliert werden kann.

Unterdrücken einer Warnung

Um nur eine einzelne Verletzung zu unterdrücken, fügen Sie der Quelldatei Präprozessoranweisungen hinzu, um die Regel zu deaktivieren und dann wieder zu aktivieren.

#pragma warning disable CA5369
// The code that's violating the rule is on this line.
#pragma warning restore CA5369

Um die Regel für eine Datei, einen Ordner oder ein Projekt zu deaktivieren, legen Sie den Schweregrad in der Konfigurationsdatei auf none fest.

[*.{cs,vb}]
dotnet_diagnostic.CA5369.severity = none

Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.

Pseudocodebeispiele

Verletzung

Das folgende Pseudocodebeispiel veranschaulicht das von dieser Regel erkannte Muster. Der Typ des ersten Parameters von XmlSerializer.Deserialize ist nicht XmlReader oder eine abgeleitete Klasse davon.

using System.IO;
using System.Xml.Serialization;
...
new XmlSerializer(typeof(TestClass).Deserialize(new FileStream("filename", FileMode.Open));

Lösung

using System.IO;
using System.Xml;
using System.Xml.Serialization;
...
new XmlSerializer(typeof(TestClass)).Deserialize(XmlReader.Create (new FileStream("filename", FileMode.Open)));