XMLWF(1)

NAME
xmlwf - Determines if an XML document is well-formed

SYNOPSIS
xmlwf
[OPTIONS] [FILE ...]
xmlwf
-h | --help
xmlwf
-v | --version

DESCRIPTION
xmlwf uses the Expat library to determine if an XML document is well-formed. It is non-validating.

If you do not specify any files on the command-line, and you have a recent version of xmlwf, the input file will be read from standard input.

WELL-FORMED DOCUMENTS
A well-formed document must adhere to the following rules:

•   The file begins with an XML declaration. For instance, \FC<?xml version="1.0" standalone="yes"?>\F[]. NOTE: xmlwf does not currently check for a valid XML declaration.

•   Every start tag is either empty (<tag/>) or has a corresponding end tag.

•   There is exactly one root element. This element must contain all other elements in the document. Only comments, white space, and processing instructions may come after the close of the root element.

•   All elements nest properly.

•   All attribute values are enclosed in quotes (either single or double).

If the document has a DTD, and it strictly complies with that DTD, then the document is also considered valid. xmlwf is a non-validating parser -- it does not check the DTD. However, it does support external entities (see the \FC-x\F[] option).

OPTIONS
When an option includes an argument, you may specify the argument either separately ("\FC-d\F[] output") or concatenated with the option ("\FC-d\F[]output"). xmlwf supports both.

\FC-a\F[] factor
    Sets the maximum tolerated amplification factor for protection against amplification attacks like the billion laughs attack (default: 100.0 for the sum of direct and indirect output and also for allocations of dynamic memory). The amplification factor is calculated as ..

        amplification := (direct + indirect) / direct

    .. with regard to use of entities and ..

        amplification := allocated / direct

    .. with regard to dynamic memory while parsing. <direct> is the number of bytes read from the primary document in parsing, <indirect> is the number of bytes added by expanding entities and reading of external DTD files, combined, and <allocated> is the total number of bytes of dynamic memory allocated (and not freed) per hierarchy of parsers.

    NOTE: If you ever need to increase this value for non-attack payload, please file a bug report.

\FC-b\F[] bytes
    Sets the number of output bytes (including amplification) needed to activate protection against amplification attacks like billion laughs (default: 8 MiB for the sum of direct and indirect output, and 64 MiB for allocations of dynamic memory). This can be thought of as an "activation threshold".

    NOTE: If you ever need to increase this value for non-attack payload, please file a bug report.

\FC-c\F[]
    If the input file is well-formed and xmlwf doesn't encounter any errors, the input file is simply copied to the output directory unchanged. This implies no namespaces (turns off \FC-n\F[]) and requires \FC-d\F[] to specify an output directory.

\FC-d\F[] output-dir
    Specifies a directory to contain transformed representations of the input files. By default, \FC-d\F[] outputs a canonical representation (described below). You can select different output formats using \FC-c\F[], \FC-m\F[] and \FC-N\F[].

    The output filenames will be exactly the same as the input filenames or "STDIN" if the input is coming from standard input. Therefore, you must be careful that the output file does not go into the same directory as the input file. Otherwise, xmlwf will delete the input file before it generates the output file (just like running \FCcat < file > file\F[] in most shells).

    Two structurally equivalent XML documents have a byte-for-byte identical canonical XML representation. Note that ignorable white space is considered significant and is treated equivalently to data. More on canonical XML can be found at http://www.jclark.com/xml/canonxml.html .

\FC-e\F[] encoding
    Specifies the character encoding for the document, overriding any document encoding declaration. xmlwf supports four built-in encodings: \FCUS-ASCII\F[], \FCUTF-8\F[], \FCUTF-16\F[], and \FCISO-8859-1\F[]. Also see the \FC-w\F[] option.

\FC-g\F[] bytes
    Sets the buffer size to request per call pair to \FCXML_GetBuffer\F[] and \FCread\F[] (default: 8 KiB).

\FC-h\F[], \FC--help\F[]
    Prints short usage information on command xmlwf, and then exits. Similar to this man page but more concise.

\FC-k\F[]
    When processing multiple files, xmlwf by default halts after the the first file with an error. This tells xmlwf to report the error but to keep processing. This can be useful, for example, when testing a filter that converts many files to XML and you want to quickly find out which conversions failed.

\FC-m\F[]
    Outputs some strange sort of XML file that completely describes the input file, including character positions. Requires \FC-d\F[] to specify an output file.

\FC-n\F[]
    Turns on namespace processing. (describe namespaces) \FC-c\F[] disables namespaces.

\FC-N\F[]
    Adds a doctype and notation declarations to canonical XML output. This matches the example output used by the formal XML test cases. Requires \FC-d\F[] to specify an output file.

\FC-p\F[]
    Tells xmlwf to process external DTDs and parameter entities.

    Normally xmlwf never parses parameter entities. \FC-p\F[] tells it to always parse them. \FC-p\F[] implies \FC-x\F[].

\FC-q\F[]
    Disable reparse deferral, and allow quadratic parse runtime on large tokens (default: reparse deferral enabled).

\FC-r\F[]
    Normally xmlwf memory-maps the XML file before parsing; this can result in faster parsing on many platforms. \FC-r\F[] turns off memory-mapping and uses normal file IO calls instead. Of course, memory-mapping is automatically turned off when reading from standard input.

    Use of memory-mapping can cause some platforms to report substantially higher memory usage for xmlwf, but this appears to be a matter of the operating system reporting memory in a strange way; there is not a leak in xmlwf.

\FC-s\F[]
    Prints an error if the document is not standalone. A document is standalone if it has no external subset and no references to parameter entities.

\FC-t\F[]
    Turns on timings. This tells Expat to parse the entire file, but not perform any processing. This gives a fairly accurate idea of the raw speed of Expat itself without client overhead. \FC-t\F[] turns off most of the output options (\FC-d\F[], \FC-m\F[], \FC-c\F[], ...).

\FC-v\F[], \FC--version\F[]
    Prints the version of the Expat library being used, including some information on the compile-time configuration of the library, and then exits.

\FC-w\F[]
    Enables support for Windows code pages. Normally, xmlwf will throw an error if it runs across an encoding that it is not equipped to handle itself. With \FC-w\F[], xmlwf will try to use a Windows code page. See also \FC-e\F[].

\FC-x\F[]
    Turns on parsing external entities. (CAREFUL! This makes xmlwf vulnerable to external entity attacks (XXE).)

    Non-validating parsers are not required to resolve external entities, or even expand entities at all. Expat always expands internal entities (?), but external entity parsing must be enabled explicitly.

    External entities are simply entities that obtain their data from outside the XML file currently being parsed.

    This is an example of an internal entity:

    <!ENTITY vers '1.0.2'>

    And here are some examples of external entities:

    <!ENTITY header SYSTEM "header-&vers;.xml">  (parsed)
    <!ENTITY logo SYSTEM "logo.png" PNG>         (unparsed)

\FC--\F[]
    (Two hyphens.) Terminates the list of options. This is only needed if a filename starts with a hyphen. For example:

    xmlwf -- -myfile.xml

    will run xmlwf on the file \FC-myfile.xml\F[].

Older versions of xmlwf do not support reading from standard input.

OUTPUT
xmlwf outputs nothing for files which are problem-free. If any input file is not well-formed, or if the output for any input file cannot be opened, xmlwf prints a single line describing the problem to standard output.

If the \FC-k\F[] option is not provided, xmlwf halts upon encountering a well-formedness or output-file error. If \FC-k\F[] is provided, xmlwf continues processing the remaining input files, describing problems found with any of them.

EXIT STATUS
For options \FC-v\F[]|\FC--version\F[] or \FC-h\F[]|\FC--help\F[], xmlwf always exits with status code 0. For other cases, the following exit status codes are returned:

\FC0\F[]
    The input files are well-formed and the output (if requested) was written successfully.

\FC1\F[]
    An internal error occurred.

\FC2\F[]
    One or more input files were not well-formed or could not be parsed.

\FC3\F[]
    If using the \FC-d\F[] option, an error occurred opening an output file.

\FC4\F[]
    There was a command-line argument error in how xmlwf was invoked.

BUGS
The errors should go to standard error, not standard output.

There should be a way to get \FC-d\F[] to send its output to standard output rather than forcing the user to send it to a file.

I have no idea why anyone would want to use the \FC-d\F[], \FC-c\F[], and \FC-m\F[] options. If someone could explain it to me, I'd like to add this information to this manpage.

SEE ALSO

The Expat home page:                            https://libexpat.github.io/
The W3 XML 1.0 specification (fourth edition):  https://www.w3.org/TR/2006/REC-xml-20060816/
Billion laughs attack:                          https://en.wikipedia.org/wiki/Billion_laughs_attack

AUTHOR
This manual page was originally written by Scott Bronson <\FCbronson@rinspin.com\F[]> in December 2001 for the Debian GNU/Linux system (but may be used by others). Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1.