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.
84a90873e9
SCConfYamlHandleInclude only accepted explicit filenames. The rule-files directive has supported shell-style glob expansion via glob(3) for years, and asymmetry with include has been blocking clean drop-in conf.d/ style configuration directories. Refactor SCConfYamlHandleInclude into a thin wrapper that resolves the path against conf_dirname and, if the input contains glob metacharacters (*, ?, [), expands it with glob(3) and includes each match in lexicographic order. A pattern that matches no files is logged as a warning and not treated as an error, so a drop-in directory can be empty without breaking startup. Literal paths skip glob() and call the existing per-file inclusion logic directly, preserving current behaviour. Glob expansion needs glob(3), which is not available everywhere. Windows builds have no glob.h, so an include pattern used to fall through and be opened as a literal filename, failing with a confusing errno. On such platforms the pattern is now logged as a warning and skipped instead. Literal includes are unaffected. The behaviour is verified by the config-includes-glob-order suricata-verify test, which checks that every file matching a pattern is loaded and that matches are included in deterministic lexicographic order. Document the new behaviour, including the platform limitation, in doc/userguide/configuration/includes.rst. Feature: #8427. |
2 months ago | |
|---|---|---|
| .. | ||
| 3rd-party-integration | ||
| _static | ||
| appendix | 1 year ago | |
| capture-hardware | 5 months ago | |
| configuration | 2 months ago | |
| devguide | 4 months ago | |
| file-extraction | 1 year ago | |
| firewall | 5 months ago | |
| install | 11 months ago | |
| ips | 10 months ago | |
| licenses | ||
| lua | 5 months ago | |
| manpages | 5 months ago | |
| output | 3 months ago | |
| partials | 5 months ago | |
| performance | 5 months ago | |
| plugins | ||
| protocols | 1 year ago | |
| reputation | ||
| rule-management | 8 months ago | |
| rules | 4 months ago | |
| upgrade | 1 year ago | |
| .gitignore | ||
| Makefile.am | 9 months ago | |
| Makefile.sphinx | ||
| README.md | ||
| acknowledgements.rst | ||
| command-line-options.rst | ||
| conf.py | 6 months ago | |
| convert.py | ||
| docutils.conf | ||
| generate-evedoc.sh | ||
| index.rst | 1 year ago | |
| initscripts.rst | ||
| install.rst | 10 months ago | |
| make-sense-alerts.rst | ||
| public-data-sets.rst | 8 months ago | |
| quickstart.rst | 4 months ago | |
| requirements.txt | ||
| security.rst | 1 year ago | |
| support-status.rst | ||
| unix-socket.rst | 1 year ago | |
| upgrade.rst | 5 months ago | |
| verifying-source-files.rst | 10 months 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.