-
-
Notifications
You must be signed in to change notification settings - Fork 621
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix up B109 and B111 removed plugins docs (#864)
The B109 and B111 plugins were removed in 1.5.0 and the docs only referenced them for historical information. This change fixes the titles to be what they were originally and adds the complete doc and indicates deprecated and removed in 1.5.0. Closes #367 Signed-off-by: Eric Brown <[email protected]>
- Loading branch information
Showing
2 changed files
with
91 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
49 changes: 46 additions & 3 deletions
49
doc/source/plugins/b111_execute_with_run_as_root_equals_true.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,54 @@ | ||
-------------------------------------------------- | ||
B111: Test for the use of rootwrap running as root | ||
-------------------------------------------------- | ||
------------------------------------------ | ||
B111: execute_with_run_as_root_equals_true | ||
------------------------------------------ | ||
|
||
This plugin has been removed. | ||
|
||
B111: Test for the use of rootwrap running as root | ||
|
||
Running commands as root dramatically increase their potential risk. Running | ||
commands with restricted user privileges provides defense in depth against | ||
command injection attacks, or developer and configuration error. This plugin | ||
test checks for specific methods being called with a keyword parameter | ||
`run_as_root` set to True, a common OpenStack idiom. | ||
|
||
|
||
**Config Options:** | ||
|
||
This test plugin takes a similarly named configuration block, | ||
`execute_with_run_as_root_equals_true`, providing a list, `function_names`, of | ||
function names. A call to any of these named functions will be checked for a | ||
`run_as_root` keyword parameter, and if True, will report a Low severity | ||
issue. | ||
|
||
.. code-block:: yaml | ||
execute_with_run_as_root_equals_true: | ||
function_names: | ||
- ceilometer.utils.execute | ||
- cinder.utils.execute | ||
- neutron.agent.linux.utils.execute | ||
- nova.utils.execute | ||
- nova.utils.trycmd | ||
:Example: | ||
|
||
.. code-block:: none | ||
>> Issue: Execute with run_as_root=True identified, possible security | ||
issue. | ||
Severity: Low Confidence: Medium | ||
Location: ./examples/exec-as-root.py:26 | ||
25 nova_utils.trycmd('gcc --version') | ||
26 nova_utils.trycmd('gcc --version', run_as_root=True) | ||
27 | ||
.. seealso:: | ||
|
||
- https://security.openstack.org/guidelines/dg_rootwrap-recommendations-and-plans.html | ||
- https://security.openstack.org/guidelines/dg_use-oslo-rootwrap-securely.html | ||
|
||
.. versionadded:: 0.10.0 | ||
|
||
.. deprecated:: 1.5.0 | ||
This plugin was removed |