XML Developers Guide
Are you looking at developing an XSLT or integrating the report output from Nipper into another system somehow? Then this page is what you are looking for. This section describes each XML element and anything else that you wanted to know about it.
The Nipper project policy is that no significant interface changes are made to Nipper in the maintenance releases. Any significant changes will go into the feature releases. If you develop a solution that makes use of Nipper 0.10.x it will work with all the 0.10.x releases. Furthermore, very few changes are usually made between feature releases, usually they are additions that extend functionality.
Index of XML Tags:
Index of no longer supported XML Tags:
XML Tags
| Description | Used to describe an abbreviation within the text. |
|---|
| Tag | <abbrev expand="" long="" short="" /> |
|---|
| Tag Data | - expand (enum) - Should the abbreviation be expanded. Possible values are true or false
- long (string) - The expanded abbreviation.
- short (string) - The abbreviation.
|
|---|
| Example | <abbrev expand="true" long="Internet Protocol" short="IP" /> |
|---|
| History | Introduced with Nipper 0.9.1. |
|---|
| Description | The caption tag is used to specify a table caption. |
|---|
| Start Tag | <caption> |
|---|
| End Tag | </caption> |
|---|
| Example | <table number="1" ref="TABLEREF1">
<caption>A table full of data</caption>
<tableheadings>
<tableheading>Column 1 Heading</tableheading>
<tableheading>Column 2 Heading</tableheading>
</tableheadings>
<tablebody>
<tablerow>
<tableentry><item>Column 1 Row 1 Data 1</item>
<item>Column 1 Row 1 Data 2</item></tableentry>
<tableentry><item>Column 2 Row 1 Data</item></tableentry>
</tablerow>
<tablerow>
<tableentry><item>Column 1 Row 2 Data</item></tableentry>
<tableentry><item>Column 2 Row 2 Data</item></tableentry>
</tablerow>
</tablebody>
</table> |
|---|
| History | Introduced with Nipper 0.9.2. |
|---|
| See Also | item, reference, table, tablebody, tableentry, tableheading, tableheadings, tablerow |
|---|
| Description | Used to describe a CLI command. |
|---|
| Start Tag | <command> |
|---|
| End Tag | </command> |
|---|
| Example | <text><command>ip name-server <cmdoption>IP address</cmdoption></command></text> |
|---|
| History | Introduced with Nipper 0.9.2. |
|---|
| See Also | cmdoption, cmdrequire, cmduser, text |
|---|
| Description | Used to describe a device command option within a command. |
|---|
| Start Tag | <cmdoption> |
|---|
| End Tag | </cmdoption> |
|---|
| Example | <text><command>ip name-server <cmdoption>IP address</cmdoption></command></text> |
|---|
| History | Introduced with Nipper 0.10.3. |
|---|
| See Also | command, cmdrequire, cmduser, text |
|---|
| Description | Used to describe a device command requirement within a command. |
|---|
| Start Tag | <cmdrequire> |
|---|
| End Tag | </cmdrequire> |
|---|
| Example | <command>ip rip authentication key-chain <cmdrequire><cmduser>Key Chain</cmduser></cmdrequire></command> |
|---|
| History | Introduced with Nipper 0.10.3. |
|---|
| See Also | command, cmdoption, cmduser, text |
|---|
| Description | Used to describe a part of a command that the user must supply. |
|---|
| Start Tag | <cmduser> |
|---|
| End Tag | </cmduser> |
|---|
| Example | <command>ip rip authentication key-chain <cmdrequire><cmduser>Key Chain</cmduser></cmdrequire></command> |
|---|
| History | Introduced with Nipper 0.10.3. |
|---|
| See Also | command, cmdoption, cmdrequire, text |
|---|
| Description | Used to describe the report document. |
|---|
| Start Tag | <document> |
|---|
| End Tag | </document> |
|---|
| Tag Data | - title (string) - The report title.
- device (string) - The name of the device audited.
|
|---|
| Example | <document title="Security Audit" device="insecure01"> |
|---|
| History | Introduced with Nipper 0.9.0. |
|---|
| Description | Used to describe an item in a table cell. |
|---|
| Start Tag | <item> |
|---|
| End Tag | </item> |
|---|
| Example | <table number="1" ref="TABLEREF1">
<caption>A table full of data</caption>
<tableheadings>
<tableheading>Column 1 Heading</tableheading>
<tableheading>Column 2 Heading</tableheading>
</tableheadings>
<tablebody>
<tablerow>
<tableentry><item>Column 1 Row 1 Data 1</item>
<item>Column 1 Row 1 Data 2</item></tableentry>
<tableentry><item>Column 2 Row 1 Data</item></tableentry>
</tablerow>
<tablerow>
<tableentry><item>Column 1 Row 2 Data</item></tableentry>
<tableentry><item>Column 2 Row 2 Data</item></tableentry>
</tablerow>
</tablebody>
</table> |
|---|
| History | Introduced with Nipper 0.11.0. |
|---|
| See Also | caption, reference, table, tablebody, tableentry, tableheading, tableheadings, tablerow |
|---|
| Description | List tags are used to create a list and will contain one or more list items. |
|---|
| Start Tag | <list> |
|---|
| End Tag | </list> |
|---|
| Example | <list>
<listitem>Item 1</listitem>
<listitem>Item 2</listitem>
</list> |
|---|
| History | Introduced with Nipper 0.9.0 |
|---|
| See Also | listitem |
|---|
| Description | List items are used within the list tags to specify a list item. |
|---|
| Start Tag | <listitem> |
|---|
| End Tag | </listitem> |
|---|
| Example | <list>
<listitem>Item 1</listitem>
<listitem>Item 2</listitem>
</list> |
|---|
| History | Introduced with Nipper 0.9.0 |
|---|
| See Also | list |
|---|
| Description | Used to reference a table within the text. It will match the ref data used within the table tag. |
|---|
| Tag | <reference name="" /> |
|---|
| Tag Data | - name (string) - The reference string.
|
|---|
| Example | <text>See Table <reference name="TABREF1" /> for more details.</text> |
|---|
| History | Introduced with Nipper 0.9.4. |
|---|
| See Also | caption, item, table, tablebody, tableentry, tableheading, tableheadings, tablerow |
|---|
| Description | The section tag is used to contain a defined part of the report. |
|---|
| Start Tag | <section type="" title="" ref="" rate=""> |
|---|
| End Tag | </section> |
|---|
| Tag Data | - type (enum) - the section type will be one of "security", "configuration" or "appendix".
- title (string) - a title for the section.
- ref (string) - a unique section reference.
- rate (enum) - A security rating for a subsection will be one of "low", "lowmed", "med", "medhigh" or "high"
|
|---|
| Example | <section type="appendix" title="Appendix" ref="APPREF1">
<subsection type="appendix" title="Some Appendix Text" ref="APPREFSUB1">
<text>This is some appendix text.</text>
</subsection>
</section> |
|---|
| History | Introduced with Nipper 0.9.0.
Reference added with 0.9.2 release.
Rate is likely to disapear with Nipper 0.12.0. |
|---|
| See Also | subsection |
|---|
| Description | The subsection tag is used to define a subsection of the report. |
|---|
| Start Tag | <subsection type="" title="" ref=""> |
|---|
| End Tag | </subsection> |
|---|
| Tag Data | - type (enum) - the report subsection type is one of "security", "configuration", "appendix" or "report"
- title (string) - a title for the subsection.
- ref (string) - a unique section reference
|
|---|
| Example | <section type="appendix" title="Appendix" ref="APPREF1">
<subsection type="appendix" title="Some Appendix Text" ref="APPREFSUB1">
<text>This is some appendix text.</text>
</subsection>
</section> |
|---|
| History | Introduced with Nipper 0.9.0.
Reference added with 0.9.2 release.
"report" type added with 0.10.0 release. |
|---|
| See Also | section |
|---|
| Description | Table is used to describe a table within the XML document and will contain a number of other XML tags. The table tag has two parameters, number and ref. |
|---|
| Start Tag | <table number="" ref=""> |
|---|
| End Tag | </table> |
|---|
| Tag Data | - number (int) - the table number.
- ref (string) - a table reference
|
|---|
| Example | <table number="1" ref="TABLEREF1">
<caption>A table full of data</caption>
<tableheadings>
<tableheading>Column 1 Heading</tableheading>
<tableheading>Column 2 Heading</tableheading>
</tableheadings>
<tablebody>
<tablerow>
<tableentry><item>Column 1 Row 1 Data 1</item>
<item>Column 1 Row 1 Data 2</item></tableentry>
<tableentry><item>Column 2 Row 1 Data</item></tableentry>
</tablerow>
<tablerow>
<tableentry><item>Column 1 Row 2 Data</item></tableentry>
<tableentry><item>Column 2 Row 2 Data</item></tableentry>
</tablerow>
</tablebody>
</table> |
|---|
| History | Introduced with Nipper 0.9.0.
Table reference was added with Nipper 0.9.3. |
|---|
| See Also | caption, item, reference, tablebody, tableentry, tableheading, tableheadings, tablerow |
|---|
| Description | Table Body contains the content of the table, enclosed in a number of table row tags. |
|---|
| Start Tag | <tablebody> |
|---|
| End Tag | </tablebody> |
|---|
| Example | <table number="1" ref="TABLEREF1">
<caption>A table full of data</caption>
<tableheadings>
<tableheading>Column 1 Heading</tableheading>
<tableheading>Column 2 Heading</tableheading>
</tableheadings>
<tablebody>
<tablerow>
<tableentry><item>Column 1 Row 1 Data 1</item>
<item>Column 1 Row 1 Data 2</item></tableentry>
<tableentry><item>Column 2 Row 1 Data</item></tableentry>
</tablerow>
<tablerow>
<tableentry><item>Column 1 Row 2 Data</item></tableentry>
<tableentry><item>Column 2 Row 2 Data</item></tableentry>
</tablerow>
</tablebody>
</table> |
|---|
| History | Introduced with Nipper 0.9.0. |
|---|
| See Also | caption, item, reference, table, tableentry, tableheading, tableheadings, tablerow |
|---|
| Description | Table entry specifies the content of a table cell. |
|---|
| Start Tag | <tableentry> |
|---|
| End Tag | </tableentry> |
|---|
| Example | <table number="1" ref="TABLEREF1">
<caption>A table full of data</caption>
<tableheadings>
<tableheading>Column 1 Heading</tableheading>
<tableheading>Column 2 Heading</tableheading>
</tableheadings>
<tablebody>
<tablerow>
<tableentry><item>Column 1 Row 1 Data 1</item>
<item>Column 1 Row 1 Data 2</item></tableentry>
<tableentry><item>Column 2 Row 1 Data</item></tableentry>
</tablerow>
<tablerow>
<tableentry><item>Column 1 Row 2 Data</item></tableentry>
<tableentry><item>Column 2 Row 2 Data</item></tableentry>
</tablerow>
</tablebody>
</table> |
|---|
| History | Introduced with Nipper 0.9.0. |
|---|
| See Also | caption, item, reference, table, tablebody, tableheading, tableheadings, tablerow |
|---|
| Description | Table Heading is used to specify a table column title. |
|---|
| Start Tag | <tableheading> |
|---|
| End Tag | </tableheading> |
|---|
| Example | <table number="1" ref="TABLEREF1">
<caption>A table full of data</caption>
<tableheadings>
<tableheading>Column 1 Heading</tableheading>
<tableheading>Column 2 Heading</tableheading>
</tableheadings>
<tablebody>
<tablerow>
<tableentry><item>Column 1 Row 1 Data 1</item>
<item>Column 1 Row 1 Data 2</item></tableentry>
<tableentry><item>Column 2 Row 1 Data</item></tableentry>
</tablerow>
<tablerow>
<tableentry><item>Column 1 Row 2 Data</item></tableentry>
<tableentry><item>Column 2 Row 2 Data</item></tableentry>
</tablerow>
</tablebody>
</table> |
|---|
| History | Introduced with Nipper 0.9.0. |
|---|
| See Also | caption, item, reference, table, tablebody, tableentry, tableheadings, tablerow |
|---|
| Description | Table Headings is used to contain one or more column headings for a table, specified using the tableheading tag. |
|---|
| Start Tag | <tableheadings> |
|---|
| End Tag | </tableheadings> |
|---|
| Example | <table number="1" ref="TABLEREF1">
<caption>A table full of data</caption>
<tableheadings>
<tableheading>Column 1 Heading</tableheading>
<tableheading>Column 2 Heading</tableheading>
</tableheadings>
<tablebody>
<tablerow>
<tableentry><item>Column 1 Row 1 Data 1</item>
<item>Column 1 Row 1 Data 2</item></tableentry>
<tableentry><item>Column 2 Row 1 Data</item></tableentry>
</tablerow>
<tablerow>
<tableentry><item>Column 1 Row 2 Data</item></tableentry>
<tableentry><item>Column 2 Row 2 Data</item></tableentry>
</tablerow>
</tablebody>
</table> |
|---|
| History | Introduced with Nipper 0.9.0. |
|---|
| See Also | caption, item, reference, table, tablebody, tableentry, tableheading, tablerow |
|---|
| Description | Table row tags contain a number of table entry tags equivilent to the number of table headings. |
|---|
| Start Tag | <tablerow> |
|---|
| End Tag | </tablerow> |
|---|
| Example | <table number="1" ref="TABLEREF1">
<caption>A table full of data</caption>
<tableheadings>
<tableheading>Column 1 Heading</tableheading>
<tableheading>Column 2 Heading</tableheading>
</tableheadings>
<tablebody>
<tablerow>
<tableentry><item>Column 1 Row 1 Data 1</item>
<item>Column 1 Row 1 Data 2</item></tableentry>
<tableentry><item>Column 2 Row 1 Data</item></tableentry>
</tablerow>
<tablerow>
<tableentry><item>Column 1 Row 2 Data</item></tableentry>
<tableentry><item>Column 2 Row 2 Data</item></tableentry>
</tablerow>
</tablebody>
</table> |
|---|
| History | Introduced with Nipper 0.9.0. |
|---|
| See Also | caption, item, reference, table, tablebody, tableentry, tableheading, tableheadings |
|---|
| Description | Define a paragraph of text content. |
|---|
| Start Tag | <text> |
|---|
| End Tag | </text> |
|---|
| Example | <section type="appendix" title="Appendix" ref="APPREF1">
<subsection type="appendix" title="Some Appendix Text" ref="APPREFSUB1">
<text>This is some appendix text.</text>
</subsection>
</section> |
|---|
| History | Introduced with Nipper 0.9.0. |
|---|
| See Also | textsection |
|---|
| Description | Used to group a section of text and possibly tables. |
|---|
| Start Tag | <textsection type="" rate=""> |
|---|
| End Tag | </textsection> |
|---|
| Tag Data | - type (enum) - Define a type of text section, one of "observation", "impact", "ease" or "recommendation"
- rate (enum) - A rating, based on the type for "impact" type, one of "low", "lowmed", "med", "medhigh" or "high" and for "ease" type, one of "noease", "trivial", "moderate" or "difficult"
|
|---|
| Example | <section type="security" title="Security Related Issues" ref="SECREF1">
<subsection type="security" rate="low" title="Classless Routing"
ref="ClasslessRouting51">
<textsection type="observation">
<text>Classless routing is...</text>
<text>nipper determined that...</text>
</textsection>
<textsection type="impact" rate="low">
<text>Network traffic...</text>
</textsection>
<textsection type="ease" rate="noease ">
<text></text>
</textsection>
<textsection type="recommendation">
<text>nipper recommends that...</text>
</textsection>
</subsection>
</section> |
|---|
| History | Introduced with Nipper 0.9.0.
The ratings are likely to change with Nipper 0.12.0. |
|---|
| See Also | text |
|---|
