mirror of https://github.com/OISF/suricata
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
f46f895e8d
This patch updates the NT status code definition to use the status
definition used on Microsoft documentation website. A first python
script is building JSON object with code definition.
```
import json
from bs4 import BeautifulSoup
import requests
ntstatus = requests.get('https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-erref/596a1078-e883-4972-9bbc-49e60bebca55')
ntstatus_parsed = BeautifulSoup(ntstatus.text, 'html.parser')
ntstatus_parsed = ntstatus_parsed.find('tbody')
ntstatus_dict = {}
for item in ntstatus_parsed.find_all('tr'):
cell = item.find_all('td')
if len(cell) == 0:
continue
code = cell[0].find_all('p')
description_ps = cell[1].find_all('p')
description_list = []
if len(description_ps):
for desc in description_ps:
if not desc.string is None:
description_list.append(desc.string.replace('\n ', ''))
else:
description_list = ['Description not available']
if not code[0].string.lower() in ntstatus_dict:
ntstatus_dict[code[0].string.lower()] = {"text": code[1].string, "desc": ' '.join(description_list)}
print(json.dumps(ntstatus_dict))
```
The second one is generating the code that is ready to be inserted into the
source file:
```
import json
ntstatus_file = open('ntstatus.json', 'r')
ntstatus = json.loads(ntstatus_file.read())
declaration_format = 'pub const SMB_NT%s:%su32 = %s;\n'
resolution_format = ' SMB_NT%s%s=> "%s",\n'
declaration = ""
resolution = ""
text_max = len(max([ntstatus[x]['text'] for x in ntstatus.keys()], key=len))
for code in ntstatus.keys():
text = ntstatus[code]['text']
text_spaces = ' ' * (4 + text_max - len(text))
declaration += declaration_format % (text, text_spaces, code)
resolution += resolution_format % (text, text_spaces, text)
print(declaration)
print('\n')
print('''
pub fn smb_ntstatus_string(c: u32) -> String {
match c {
''')
print(resolution)
print('''
_ => { return (c).to_string(); },
}.to_string()
}
''')
```
Bug #5412.
|
3 years ago | |
|---|---|---|
| .. | ||
| 3rd-party-integration | ||
| _static | ||
| capture-hardware | 5 years ago | |
| configuration | 3 years ago | |
| devguide | 3 years ago | |
| file-extraction | 5 years ago | |
| licenses | ||
| lua | 3 years ago | |
| manpages | 4 years ago | |
| output | 3 years ago | |
| partials | 3 years ago | |
| performance | 3 years ago | |
| reputation | ||
| rule-management | ||
| rules | 3 years ago | |
| setting-up-ipsinline-for-linux | ||
| upgrade | 5 years ago | |
| .gitignore | ||
| Makefile.am | 3 years ago | |
| Makefile.sphinx | ||
| README.md | 3 years ago | |
| acknowledgements.rst | ||
| command-line-options.rst | ||
| conf.py | 3 years ago | |
| convert.py | ||
| index.rst | 3 years ago | |
| initscripts.rst | ||
| install.rst | 4 years ago | |
| make-sense-alerts.rst | ||
| public-data-sets.rst | 4 years ago | |
| quickstart.rst | 4 years ago | |
| setting-up-ipsinline-for-linux.rst | 3 years ago | |
| setting-up-ipsinline-for-windows.rst | ||
| unix-socket.rst | 5 years ago | |
| upgrade.rst | 3 years ago | |
| what-is-suricata.rst | ||
README.md
Suricata User Guide
This directory contains the Suricata Guide. The Suricata Developer's guide is included as a chapter of the Guide. The Sphinx Document Generator is used to build the documentation. For a primer os reStructuredText see the reStructuredText Primer.
Verifying Changes
There are a number of output formats to choose from when making the source documentation locally (e.g. html, pdf, man).
The documentation source can be built with make -f Makefile.sphinx html. Substitute the 'html' word for desired output format.
There are different application dependencies based on the output desired.