Skip to contentSkip to conversation

security: fix documentation for the audit_* hooks

PATCH In review [email protected] 2 participants 2 messages Oct 23, 2018 Security (LSM)

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 security: fix documentation for the audit_* hooks

From: Denis Efremov <[email protected]>

This patch makes argument names equal in the documentation and declarations of the audit_* hooks.

---
 include/linux/lsm_hooks.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
include/linux/lsm_hooks.h +3 -3
index 596351f7c3d1..9fb67c212298 100644
@@ -1329,7 +1329,7 @@
  * @audit_rule_known:
  *	Specifies whether given @rule contains any fields related to
  *	current LSM.
- *	@rule contains the audit rule of interest.
+ *	@krule contains the audit rule of interest.
  *	Return 1 in case of relation found, 0 otherwise.
  *
  * @audit_rule_match:
@@ -1338,14 +1338,14 @@
  *	@secid contains the security id in question.
  *	@field contains the field which relates to current LSM.
  *	@op contains the operator that will be used for matching.
- *	@rule points to the audit rule that will be checked against.
+ *	@lsmrule points to the audit rule that will be checked against.
  *	@actx points to the audit context associated with the check.
  *	Return 1 if secid matches the rule, 0 if it does not, -ERRNO on failure.
  *
  * @audit_rule_free:
  *	Deallocate the LSM audit rule structure previously allocated by
  *	audit_rule_init.
- *	@rule contains the allocated rule
+ *	@lsmrule contains the allocated rule.
  *
  * @inode_invalidate_secctx:
  *	Notify the security module that it must revalidate the security context
Signature · 1 line
2.17.2
Reviewed-by on v1 1/1
#1 lore raw
Quoted 6 lines · On Tue, Oct 23, 2018 at 4:17 AM, <[email protected]> wrote:

From: Denis Efremov <[email protected]>

This patch makes argument names equal in the documentation and declarations of the audit_* hooks.

-Kees

Quoted 37 lines
---
 include/linux/lsm_hooks.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
include/linux/lsm_hooks.h +3 -4
index 596351f7c3d1..9fb67c212298 100644
@@ -1329,7 +1329,7 @@
  * @audit_rule_known:
  *     Specifies whether given @rule contains any fields related to
  *     current LSM.
- *     @rule contains the audit rule of interest.
+ *     @krule contains the audit rule of interest.
  *     Return 1 in case of relation found, 0 otherwise.
  *
  * @audit_rule_match:
@@ -1338,14 +1338,14 @@
  *     @secid contains the security id in question.
  *     @field contains the field which relates to current LSM.
  *     @op contains the operator that will be used for matching.
- *     @rule points to the audit rule that will be checked against.
+ *     @lsmrule points to the audit rule that will be checked against.
  *     @actx points to the audit context associated with the check.
  *     Return 1 if secid matches the rule, 0 if it does not, -ERRNO on failure.
  *
  * @audit_rule_free:
  *     Deallocate the LSM audit rule structure previously allocated by
  *     audit_rule_init.
- *     @rule contains the allocated rule
+ *     @lsmrule contains the allocated rule.
  *
  * @inode_invalidate_secctx:
  *     Notify the security module that it must revalidate the security context
--

2.17.2

Signature · 1 line
Kees Cook