esm2markdown/README.md

31 lines
912 B
Markdown
Raw Normal View History

2018-03-15 16:40:16 +00:00
# esm2markdown
2018-03-15 16:50:41 +00:00
This python script is intended to be used to automatically generate use case / correlation rule documentation in Markdown format for the McAfee Enterprise Sceurity Manager (ESM). It accepts a XML file that has been exported from the correlation rule editor of the ESM, converts its contents to Markdown format and writes it into a new file. If you need any other format, you might want to use pandoc to convert to e.g. pdf, docx or HTML.
2018-03-16 09:32:21 +00:00
## Requirements
2018-03-21 22:07:53 +00:00
This tool requires the following:
* Python 3
* lxml
* networkx
* pydot
On Debian you can install the dependencies with "sudo apt-get install python3-lxml python3-networkxi python3-pydot"
2018-03-16 09:32:21 +00:00
2018-03-15 16:50:41 +00:00
## Usage
```
python esm2markdown <rule xml file> <markdown output file>
```
## Example
```
2018-03-22 14:48:39 +00:00
python esm2markdown demo.xml demo.mk
2018-03-15 16:50:41 +00:00
```
2018-03-22 14:48:39 +00:00
After a conversion with pandoc, the following documentation will be the result:
![screenshot](demo/demo.png "")