Clase System.Xml.Schema.XmlSchemaSet
En este artículo se proporcionan comentarios adicionales a la documentación de referencia de esta API.
Importante
- No use esquemas de orígenes o ubicaciones desconocidos o que no sean de confianza. Si lo hace, se pondrá en peligro la seguridad del código.
- Los esquemas XML (incluidos los esquemas insertados) son inherentemente vulnerables a ataques por denegación de servicio; no los acepte en escenarios que no son de confianza.
- Las excepciones y los mensajes de error de validación de esquemas pueden exponer información confidencial sobre el modelo de contenido o las rutas de acceso de URI al archivo de esquema. Tenga cuidado de no exponer esta información a personas que no sean de confianza.
- En la sección "Consideraciones de seguridad" se tratan consideraciones de seguridad adicionales.
XmlSchemaSet es una memoria caché o biblioteca donde puede almacenar esquemas del lenguaje de definición de esquemas XML (XSD). XmlSchemaSet mejora el rendimiento al almacenar en memoria caché los esquemas, en lugar obtener acceso a ellos desde un archivo o dirección URL. Cada esquema se identifica mediante el URI del espacio de nombres y la ubicación que se especificó cuando se agregó el esquema al conjunto. Use la propiedad XmlReaderSettings.Schemas para asignar el objeto XmlSchemaSet que debe usar un lector XML para la validación de datos.
Consideraciones sobre la seguridad
No use esquemas de orígenes desconocidos o que no sean de confianza. Si lo hace, se pondrá en peligro la seguridad del código. Los espacios de nombres o las ubicaciones externas a los que se hace referencia en los elementos include, import y redefine de un esquema se resuelven con respecto al URI base del esquema que los incluye o importa. Por ejemplo, si el URI base del esquema de inclusión o importación está vacío o
null, las ubicaciones externas se resuelven con respecto al directorio actual. La clase XmlUrlResolver se usa para resolver esquemas externos de forma predeterminada. Para deshabilitar la resolución de elementos de inclusión, importación y redefinición de un esquema, establezca la propiedad XmlSchemaSet.XmlResolver ennull.La clase XmlSchemaSet usa la clase System.Text.RegularExpressions.Regex para analizar y combinar expresiones regulares en un esquema XML. La validación de facetas de patrón con expresiones regulares en un esquema XML puede implicar un mayor uso de CPU y debe evitarse en escenarios de alta disponibilidad.
Las excepciones generadas como resultado del uso de la clase XmlSchemaSet, como la clase XmlSchemaException, pueden contener información confidencial que no se debe exponer en escenarios que no son de confianza. Por ejemplo, la propiedad SourceUri de XmlSchemaException devuelve la ruta de acceso del identificador URI al archivo de esquema que provocó la excepción. La propiedad SourceUri no se debe exponer en escenarios que no sean de confianza. Las excepciones deben manipularse correctamente para que esta información confidencial no se exponga en escenarios que no son de confianza.
Ejemplos
El siguiente ejemplo valida un archivo XML utilizando los esquemas almacenados en el XmlSchemaSet. El espacio de nombres del archivo XML, urn:bookstore-schema, identifica qué esquema del XmlSchemaSet se va a utilizar para la validación. La salida del ejemplo muestra que el archivo XML tiene dos infracciones de esquema:
El primer elemento <book> contiene un elemento <author>, pero ningún elemento <title> o <price>.
El elemento <author> en el elemento <book> carece de un elemento <first-name> y <last-name> y en su lugar tiene un elemento <name> no válido.
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'.
Entrada
En el ejemplo se utilizan los dos archivos de entrada siguientes.
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>
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de