Skip to content

Commit bd1a5a5

Browse files
rddunlapJames Morris
authored andcommitted
security: <linux/lsm_hooks.h>: fix all kernel-doc warnings
Fix all kernel-doc warnings in <linux/lsm_hooks.h>. Fixes the following warnings: ../include/linux/lsm_hooks.h:1830: warning: Function parameter or member 'quotactl' not described in 'security_list_options' ../include/linux/lsm_hooks.h:1830: warning: Function parameter or member 'quota_on' not described in 'security_list_options' ../include/linux/lsm_hooks.h:1830: warning: Function parameter or member 'sb_free_mnt_opts' not described in 'security_list_options' ../include/linux/lsm_hooks.h:1830: warning: Function parameter or member 'sb_eat_lsm_opts' not described in 'security_list_options' ../include/linux/lsm_hooks.h:1830: warning: Function parameter or member 'sb_kern_mount' not described in 'security_list_options' ../include/linux/lsm_hooks.h:1830: warning: Function parameter or member 'sb_show_options' not described in 'security_list_options' ../include/linux/lsm_hooks.h:1830: warning: Function parameter or member 'sb_add_mnt_opt' not described in 'security_list_options' ../include/linux/lsm_hooks.h:1830: warning: Function parameter or member 'd_instantiate' not described in 'security_list_options' ../include/linux/lsm_hooks.h:1830: warning: Function parameter or member 'getprocattr' not described in 'security_list_options' ../include/linux/lsm_hooks.h:1830: warning: Function parameter or member 'setprocattr' not described in 'security_list_options' ../include/linux/lsm_hooks.h:1830: warning: Function parameter or member 'locked_down' not described in 'security_list_options' ../include/linux/lsm_hooks.h:1830: warning: Function parameter or member 'perf_event_open' not described in 'security_list_options' ../include/linux/lsm_hooks.h:1830: warning: Function parameter or member 'perf_event_alloc' not described in 'security_list_options' ../include/linux/lsm_hooks.h:1830: warning: Function parameter or member 'perf_event_free' not described in 'security_list_options' ../include/linux/lsm_hooks.h:1830: warning: Function parameter or member 'perf_event_read' not described in 'security_list_options' ../include/linux/lsm_hooks.h:1830: warning: Function parameter or member 'perf_event_write' not described in 'security_list_options' Signed-off-by: Randy Dunlap <[email protected]> Cc: John Johansen <[email protected]> Cc: Kees Cook <[email protected]> Cc: Micah Morton <[email protected]> Cc: James Morris <[email protected]> Cc: "Serge E. Hallyn" <[email protected]> Cc: [email protected] Cc: Paul Moore <[email protected]> Cc: Stephen Smalley <[email protected]> Cc: Eric Paris <[email protected]> Cc: Casey Schaufler <[email protected]> Cc: Kentaro Takeda <[email protected]> Cc: Tetsuo Handa <[email protected]> Acked-by: Casey Schaufler <[email protected]> Acked-by: Kees Cook <[email protected]> Signed-off-by: James Morris <[email protected]>
1 parent 10c2d11 commit bd1a5a5

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

include/linux/lsm_hooks.h

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,10 @@
103103
* @sb_free_security:
104104
* Deallocate and clear the sb->s_security field.
105105
* @sb contains the super_block structure to be modified.
106+
* @sb_free_mnt_opts:
107+
* Free memory associated with @mnt_ops.
108+
* @sb_eat_lsm_opts:
109+
* Eat (scan @orig options) and save them in @mnt_opts.
106110
* @sb_statfs:
107111
* Check permission before obtaining filesystem statistics for the @mnt
108112
* mountpoint.
@@ -136,6 +140,10 @@
136140
* @sb superblock being remounted
137141
* @data contains the filesystem-specific data.
138142
* Return 0 if permission is granted.
143+
* @sb_kern_mount:
144+
* Mount this @sb if allowed by permissions.
145+
* @sb_show_options:
146+
* Show (print on @m) mount options for this @sb.
139147
* @sb_umount:
140148
* Check permission before the @mnt file system is unmounted.
141149
* @mnt contains the mounted file system.
@@ -155,6 +163,8 @@
155163
* Copy all security options from a given superblock to another
156164
* @oldsb old superblock which contain information to clone
157165
* @newsb new superblock which needs filled in
166+
* @sb_add_mnt_opt:
167+
* Add one mount @option to @mnt_opts.
158168
* @sb_parse_opts_str:
159169
* Parse a string of security data filling in the opts structure
160170
* @options string containing all mount options known by the LSM
@@ -451,6 +461,12 @@
451461
* security module does not know about attribute or a negative error code
452462
* to abort the copy up. Note that the caller is responsible for reading
453463
* and writing the xattrs as this hook is merely a filter.
464+
* @d_instantiate:
465+
* Fill in @inode security information for a @dentry if allowed.
466+
* @getprocattr:
467+
* Read attribute @name for process @p and store it into @value if allowed.
468+
* @setprocattr:
469+
* Write (set) attribute @name to @value, size @size if allowed.
454470
*
455471
* Security hooks for kernfs node operations
456472
*
@@ -1113,6 +1129,7 @@
11131129
* In case of failure, @secid will be set to zero.
11141130
*
11151131
* Security hooks for individual messages held in System V IPC message queues
1132+
*
11161133
* @msg_msg_alloc_security:
11171134
* Allocate and attach a security structure to the msg->security field.
11181135
* The security field is initialized to NULL when the structure is first
@@ -1302,6 +1319,10 @@
13021319
* @cap contains the capability <include/linux/capability.h>.
13031320
* @opts contains options for the capable check <include/linux/security.h>
13041321
* Return 0 if the capability is granted for @tsk.
1322+
* @quotactl:
1323+
* Check whether the quotactl syscall is allowed for this @sb.
1324+
* @quota_on:
1325+
* Check whether QUOTAON is allowed for this @dentry.
13051326
* @syslog:
13061327
* Check permission before accessing the kernel message ring or changing
13071328
* logging to the console.
@@ -1449,11 +1470,24 @@
14491470
* @bpf_prog_free_security:
14501471
* Clean up the security information stored inside bpf prog.
14511472
*
1452-
* @locked_down
1473+
* @locked_down:
14531474
* Determine whether a kernel feature that potentially enables arbitrary
14541475
* code execution in kernel space should be permitted.
14551476
*
14561477
* @what: kernel feature being accessed
1478+
*
1479+
* Security hooks for perf events
1480+
*
1481+
* @perf_event_open:
1482+
* Check whether the @type of perf_event_open syscall is allowed.
1483+
* @perf_event_alloc:
1484+
* Allocate and save perf_event security info.
1485+
* @perf_event_free:
1486+
* Release (free) perf_event security info.
1487+
* @perf_event_read:
1488+
* Read perf_event security info if allowed.
1489+
* @perf_event_write:
1490+
* Write perf_event security info if allowed.
14571491
*/
14581492
union security_list_options {
14591493
int (*binder_set_context_mgr)(struct task_struct *mgr);

0 commit comments

Comments
 (0)