Prohibits XML documents to be passed through that look like XML attacks on older parsers. Too many attributes, too long element names are such indications. DTD definitions will simply be removed.
XML documents carried inside a multipart body are inspected part by part, so a document uploaded as an attachment is checked like a plain XML body. A part the plugin had to take a DTD out of is written back into the body; the other parts pass through unchanged.
Example Configuration
- xmlProtection:
maxAttributeCount: 1000
maxElementNameLength: 1000
maxAttributeNameLength: 1000
maxDepth: 50
maxSize: 10000000
removeDTD: true
otherContentTypes: SKIP
- xmlProtection:
maxAttributeCount: 1000
maxElementNameLength: 1000
maxAttributeNameLength: 1000
maxDepth: 50
maxSize: 10000000
removeDTD: true
otherContentTypes: SKIP
Syntax
xmlProtection:
maxAttributeCount: <int>
maxAttributeNameLength: <int>
maxDepth: <int>
maxElementNameLength: <int>
maxSize: <int>
otherContentTypes: reject
removeDTD: <boolean>xmlProtection: maxAttributeCount: <int> maxAttributeNameLength: <int> maxDepth: <int> maxElementNameLength: <int> maxSize: <int> otherContentTypes: reject removeDTD: <boolean>
Attributes
| Name | Required | Default | Description | Examples |
|---|---|---|---|---|
| maxAttributeCount | false | 1000 | If an incoming request exceeds this limit, it will be discarded. | - |
| maxAttributeNameLength | false | 1000 | Maximum length of an attribute name, counted as the document spells it, so a qualified name like ns:id counts its prefix and colon too. If an incoming request exceeds this limit, it will be discarded. A value of -1 disables the limit. | - |
| maxDepth | false | -1 (unlimited) | Maximum nesting depth of XML elements. If an incoming request exceeds this limit, it will be discarded. A value of -1 disables the limit. | - |
| maxElementNameLength | false | 1000 | Maximum length of an element name, counted as the document spells it, so a qualified name like ns:order counts its prefix and colon too. If an incoming request exceeds this limit, it will be discarded. A value of -1 disables the limit. | - |
| maxSize | false | 104857600 | Maximum size in bytes of a single XML document. The limit is per document, so in a multipart body it applies to each XML part separately rather than to the whole upload. To cap the size of the entire request, use the limit plugin with its maxBodyLength attribute. A value of -1 disables the limit. | - |
| otherContentTypes | false | REJECT | What to do with content this plugin does not inspect. This applies both to the body of a request of another type and to the individual parts of a multipart body, so skip allows e.g. an image to be uploaded alongside the document that is checked.Values: REJECT, SKIP | SKIP |
| removeDTD | false | true | Whether to remove the DTD from incoming requests. | - |