Adds details about OSSEC rule addition #199
Conversation
There was a problem hiding this comment.
@kushaldas thanks for preparing these docs, I think there's a bit of duplication with existing sections (perhaps be can update the existing sections and/or link to them, to avoid duplication). See inline for comments
docs/development/updating_ossec.rst
Outdated
|
|
||
| There are two main files involved in this. | ||
|
|
||
| - `install_files/securedrop-ossec-server/var/ossec/rules/local_rules.xml` the rules file |
There was a problem hiding this comment.
I think the natural order (as you presented it below) is decoder file and then rules file. Perhaps inverting the order makes sense here, along with a sentence to briefly describe what they do.
There was a problem hiding this comment.
reading this for the first time, i also would have found it useful to see a short description for each item listed, regardless of order
docs/development/updating_ossec.rst
Outdated
|
|
||
| You can then add a test for the `molecule/testinfra/mon/test_ossec_ruleset.py` | ||
| file. Here the test loops over different log lines mentioned in | ||
| `log_events_without_ossec_alerts` variable in |
There was a problem hiding this comment.
there's also log_events_with_ossec_alerts to tests that the alerts are correctly generated
docs/development/updating_ossec.rst
Outdated
|
|
||
| In the above example, we are creating a new `decoder` based on the | ||
| `program_name` value. We can find this `program_name` value using the | ||
| `/var/ossec/bin/ossec-logtest` command, you can paste the login as input to |
There was a problem hiding this comment.
See the section above (L26, there may be some duplicate information here. Perhaps folding it in or maintaining a reference to it makes sense here.
There was a problem hiding this comment.
+1 to including a reference to the section on how to use ossec-logtest, but it would also be useful to include the command used to obtain the output you copy-pasted below.
eloquence
moved this from In Development
to Near Term - SecureDrop Core
in SecureDrop Team Board
eloquence
moved this from Near Term - SecureDrop Core
to Next sprint candidates
in SecureDrop Team Board
eloquence
moved this from Next sprint candidates
to SecureDrop Sprint #71 (5/20-6/2)
in SecureDrop Team Board
|
hey I'm going to pick up this review to help get it over the finish line! |
docs/development/updating_ossec.rst
Outdated
|
|
||
| In the above example, we are creating a new `decoder` based on the | ||
| `program_name` value. We can find this `program_name` value using the | ||
| `/var/ossec/bin/ossec-logtest` command, you can paste the login as input to |
There was a problem hiding this comment.
+1 to including a reference to the section on how to use ossec-logtest, but it would also be useful to include the command used to obtain the output you copy-pasted below.
docs/development/updating_ossec.rst
Outdated
| </group> | ||
|
|
||
|
|
||
| Verify the configuration change |
There was a problem hiding this comment.
Could we reword to:
Verify new OSSEC rule
docs/development/updating_ossec.rst
Outdated
| Verify the configuration change | ||
| -------------------------------- | ||
|
|
||
| On the monitor server you can use the following command as `root` to verify the changes. |
There was a problem hiding this comment.
verify the changes -> verify the new rule
for more clarity?
docs/development/updating_ossec.rst
Outdated
|
|
||
| There are two main files involved in this. | ||
|
|
||
| - `install_files/securedrop-ossec-server/var/ossec/rules/local_rules.xml` the rules file |
There was a problem hiding this comment.
reading this for the first time, i also would have found it useful to see a short description for each item listed, regardless of order
|
I believe I've addressed all the substantive review feedback here. @creviera, would you be willing to re-review and resolve the individual review threads as you see fit? If you think this needs a deeper overhaul (à la freedomofpress/securedrop-dev-docs#153), I think I'd benefit from having a brief conversation about the goals and structure of this page before tinkering further with this pull request in its current form. |
Status
Ready for review
Description of Changes
Adds steps for adding new OSSEC rules. This is focused on the developers.
Testing
This is based on the wiki page at https://github.com/freedomofpress/securedrop/wiki/How-to-add-new-ossec-rules%3F
Release
Checklist (Optional)
make docs-lint) passed locallymake docs-linkcheck) passedmake docs) docs at http://localhost:8000After merge