System.Xml.Schema.XmlSchemaSet – třída

  • Článek

Tento článek obsahuje doplňující poznámky k referenční dokumentaci pro toto rozhraní API.

Důležité

  • Nepoužívejte schémata z neznámých nebo nedůvěryhodných zdrojů nebo umístění. Tím dojde k ohrožení zabezpečení vašeho kódu.
  • Schémata XML (včetně vložených schémat) jsou ze své podstaty zranitelná vůči útokům na odepření služeb; nepřijímají je v nedůvěryhodných scénářích.
  • Chybové zprávy a výjimky ověřování schématu mohou vystavit citlivé informace o cestě con režim stanu l nebo URI k souboru schématu. Dávejte pozor, abyste tyto informace nezpřístupnil nedůvěryhodným volajícím.
  • Další aspekty zabezpečení jsou popsané v části Důležité informace o zabezpečení.

XmlSchemaSet je mezipaměť nebo knihovna, ve které můžete ukládat schémata XSD (XML Schema Definition Language). XmlSchemaSet zlepšuje výkon díky ukládání schémat do mezipaměti v paměti místo přístupu k nim ze souboru nebo adresy URL. Každé schéma je identifikováno identifikátorem URI oboru názvů a umístěním, které bylo zadáno při přidání schématu do sady. Vlastnost použijete XmlReaderSettings.Schemas k přiřazení objektu XmlSchemaSet , který má čtenář XML použít k ověření dat.

Bezpečnostní aspekty

  • Nepoužívejte schémata z neznámých nebo nedůvěryhodných zdrojů. Tím dojde k ohrožení zabezpečení vašeho kódu. Externí obory názvů nebo umístění odkazované v zahrnutí, importu a předefinování prvků schématu jsou vyřešeny s ohledem na základní identifikátor URI schématu, který je obsahuje nebo importuje. Pokud je například základní identifikátor URI schématu zahrnutí nebo importu prázdný, nulljsou externí umístění vyřešena s ohledem na aktuální adresář. Třída XmlUrlResolver se používá k překladu externích schémat ve výchozím nastavení. Chcete-li zakázat rozlišení zahrnutí, importu a předefinování prvků schématu, nastavte XmlSchemaSet.XmlResolver vlastnost na nullhodnotu .

  • Třída XmlSchemaSet používá System.Text.RegularExpressions.Regex třídu k analýze a porovnávání regulárních výrazů ve schématu XML. Ověření omezujících vlastností vzorů s regulárními výrazy ve schématu XML může zahrnovat zvýšené využití procesoru a mělo by se jim vyhnout ve scénářích s vysokou dostupností.

  • Výjimky vyvolané v důsledku použití XmlSchemaSet třídy, jako XmlSchemaException je například třída, mohou obsahovat citlivé informace, které by neměly být vystaveny v nedůvěryhodných scénářích. SourceUri Například vlastnost XmlSchemaException vrací cestu URI k souboru schématu, který způsobil výjimku. Vlastnost SourceUri by neměla být vystavena v nedůvěryhodných scénářích. Výjimky by se měly správně zpracovat, aby tyto citlivé informace nebyly zpřístupněny v nedůvěryhodných scénářích.

Příklady

Následující příklad ověří soubor XML pomocí schémat uložených v souboru XmlSchemaSet. Obor názvů v souboru XML určuje, urn:bookstore-schemakteré schéma XmlSchemaSet se má použít k ověření. Výstup z příkladu ukazuje, že soubor XML má dvě porušení schématu:

  • První <prvek knihy> obsahuje <prvek autora> , ale žádný <název> ani <cenový> prvek.

  • Element <author> v posledním <prvku knihy> chybí element s křestním jménem> a příjmením <> a <místo toho má neplatný <element name>.

using System;
using System.Xml;
using System.Xml.Schema;
using System.IO;

public class Sample
{
  public static void Main() {

    // Create the XmlSchemaSet class.
    XmlSchemaSet sc = new XmlSchemaSet();

    // Add the schema to the collection.
    sc.Add("urn:bookstore-schema", "books.xsd");

    // Set the validation settings.
    XmlReaderSettings settings = new XmlReaderSettings();
    settings.ValidationType = ValidationType.Schema;
    settings.Schemas = sc;
    settings.ValidationEventHandler += ValidationCallBack;

    // Create the XmlReader object.
    XmlReader reader = XmlReader.Create("booksSchemaFail.xml", settings);

    // Parse the file.
    while (reader.Read());
  }

  // Display any validation errors.
  private static void ValidationCallBack(object sender, ValidationEventArgs e) {
    Console.WriteLine($"Validation Error:\n   {e.Message}\n");
  }
}
// The example displays output like the following:
//   Validation Error:
//        The element 'book' in namespace 'urn:bookstore-schema' has invalid child element 'author'
//        in namespace 'urn:bookstore-schema'. List of possible elements expected: 'title' in
//        namespace 'urn:bookstore-schema'.
//
//    Validation Error:
//       The element 'author' in namespace 'urn:bookstore-schema' has invalid child element 'name'
//       in namespace 'urn:bookstore-schema'. List of possible elements expected: 'first-name' in
//       namespace 'urn:bookstore-schema'.

Imports System.Xml
Imports System.Xml.Schema
Imports System.IO

Public Module Sample 
  Public Sub Main() 

    ' Create the XmlSchemaSet class.
    Dim sc as XmlSchemaSet = new XmlSchemaSet()

    ' Add the schema to the collection.
    sc.Add("urn:bookstore-schema", "books.xsd")

    ' Set the validation settings.
    Dim settings as XmlReaderSettings = new XmlReaderSettings()
    settings.ValidationType = ValidationType.Schema
    settings.Schemas = sc
    AddHandler settings.ValidationEventHandler, AddressOf ValidationCallBack
 
    ' Create the XmlReader object.
    Dim reader as XmlReader = XmlReader.Create("booksSchemaFail.xml", settings)

    ' Parse the file. 
    While reader.Read()
    End While
    
  End Sub

  ' Display any validation errors.
  Private Sub ValidationCallBack(sender as object, e as ValidationEventArgs) 
    Console.WriteLine($"Validation Error:{vbCrLf}   {e.Message}")
    Console.WriteLine()
  End Sub
End Module
' The example displays output like the following:
'   Validation Error: 
'        The element 'book' in namespace 'urn:bookstore-schema' has invalid child element 'author' 
'        in namespace 'urn:bookstore-schema'. List of possible elements expected: 'title' in 
'        namespace 'urn:bookstore-schema'.
'
'    Validation Error: 
'       The element 'author' in namespace 'urn:bookstore-schema' has invalid child element 'name' 
'       in namespace 'urn:bookstore-schema'. List of possible elements expected: 'first-name' in 
'       namespace 'urn:bookstore-schema'.

Vstup

Ukázka používá následující dva vstupní soubory.

booksSchemaFail.xml:

<?xml version='1.0'?>
<bookstore xmlns="urn:bookstore-schema">
  <book>
    <author>
      <first-name>Benjamin</first-name>
      <last-name>Franklin</last-name>
    </author>
  </book>
  <book genre="novel">
    <title>The Confidence Man</title>
    <author>
      <first-name>Herman</first-name>
      <last-name>Melville</last-name>
    </author>
    <price>11.99</price>
  </book>
  <book genre="philosophy">
    <title>The Gorgias</title>
    <author>
      <name>Plato</name>
    </author>
    <price>9.99</price>
  </book>
</bookstore>

books.xsd:

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns="urn:bookstore-schema"
    elementFormDefault="qualified"
    targetNamespace="urn:bookstore-schema">

 <xsd:element name="bookstore" type="bookstoreType"/>

 <xsd:complexType name="bookstoreType">
  <xsd:sequence maxOccurs="unbounded">
   <xsd:element name="book"  type="bookType"/>
  </xsd:sequence>
 </xsd:complexType>

 <xsd:complexType name="bookType">
  <xsd:sequence>
   <xsd:element name="title" type="xsd:string"/>
   <xsd:element name="author" type="authorName"/>
   <xsd:element name="price"  type="xsd:decimal"/>
  </xsd:sequence>
  <xsd:attribute name="genre" type="xsd:string"/>
 </xsd:complexType>

 <xsd:complexType name="authorName">
  <xsd:sequence>
   <xsd:element name="first-name"  type="xsd:string"/>
   <xsd:element name="last-name" type="xsd:string"/>
  </xsd:sequence>
 </xsd:complexType>

</xsd:schema>