mbox series

[v2,00/11] LSM documentation update

Message ID cover.1551213058.git.efremov@ispras.ru (mailing list archive)
Headers show
Series LSM documentation update | expand

Message

Denis Efremov Feb. 26, 2019, 8:49 p.m. UTC
Recent "New LSM Hooks" discussion has led me to the
thought that it might be a good idea to slightly
update the current documentation. The patchset adds
nothing new to the documentation, only fixes the old
description of hooks to reflect their current state.

V2 adds the clarification on arguments for some hooks.
The format of the documentation is also slightly updated
for better html. However, there are still 10 hooks without
documentation at all. I think that this should be fixed
separatedly.

Denis Efremov (11):
  LSM: fix documentation for sb_copy_data hook
  LSM: fix documentation for the syslog hook
  LSM: fix documentation for the socket_post_create hook
  LSM: fix documentation for the task_setscheduler hook
  LSM: fix documentation for the socket_getpeersec_dgram hook
  LSM: fix documentation for the path_chmod hook
  LSM: fix documentation for the audit_* hooks
  LSM: fix documentation for the msg_queue_* hooks
  LSM: fix documentation for the sem_* hooks
  LSM: fix documentation for the shm_* hooks
  LSM: lsm_hooks.h: fix documentation format

 include/linux/lsm_hooks.h | 170 ++++++++++++++++++--------------------
 1 file changed, 81 insertions(+), 89 deletions(-)

Comments

Casey Schaufler Feb. 26, 2019, 11:34 p.m. UTC | #1
On 2/26/2019 12:49 PM, Denis Efremov wrote:
> Recent "New LSM Hooks" discussion has led me to the
> thought that it might be a good idea to slightly
> update the current documentation. The patchset adds
> nothing new to the documentation, only fixes the old
> description of hooks to reflect their current state.
>
> V2 adds the clarification on arguments for some hooks.
> The format of the documentation is also slightly updated
> for better html. However, there are still 10 hooks without
> documentation at all. I think that this should be fixed
> separatedly.
>
> Denis Efremov (11):
>    LSM: fix documentation for sb_copy_data hook
>    LSM: fix documentation for the syslog hook
>    LSM: fix documentation for the socket_post_create hook
>    LSM: fix documentation for the task_setscheduler hook
>    LSM: fix documentation for the socket_getpeersec_dgram hook
>    LSM: fix documentation for the path_chmod hook
>    LSM: fix documentation for the audit_* hooks
>    LSM: fix documentation for the msg_queue_* hooks
>    LSM: fix documentation for the sem_* hooks
>    LSM: fix documentation for the shm_* hooks
>    LSM: lsm_hooks.h: fix documentation format
>
>   include/linux/lsm_hooks.h | 170 ++++++++++++++++++--------------------
>   1 file changed, 81 insertions(+), 89 deletions(-)

You can mark the series

Acked-by: Casey Schaufler <casey@schaufler-ca.com>
Kees Cook Feb. 27, 2019, 12:09 a.m. UTC | #2
On Tue, Feb 26, 2019 at 12:49 PM Denis Efremov <efremov@ispras.ru> wrote:
> Recent "New LSM Hooks" discussion has led me to the
> thought that it might be a good idea to slightly
> update the current documentation. The patchset adds
> nothing new to the documentation, only fixes the old
> description of hooks to reflect their current state.
>
> V2 adds the clarification on arguments for some hooks.
> The format of the documentation is also slightly updated
> for better html. However, there are still 10 hooks without
> documentation at all. I think that this should be fixed
> separatedly.
>
> Denis Efremov (11):
>   LSM: fix documentation for sb_copy_data hook
>   LSM: fix documentation for the syslog hook
>   LSM: fix documentation for the socket_post_create hook
>   LSM: fix documentation for the task_setscheduler hook
>   LSM: fix documentation for the socket_getpeersec_dgram hook
>   LSM: fix documentation for the path_chmod hook
>   LSM: fix documentation for the audit_* hooks
>   LSM: fix documentation for the msg_queue_* hooks
>   LSM: fix documentation for the sem_* hooks
>   LSM: fix documentation for the shm_* hooks
>   LSM: lsm_hooks.h: fix documentation format
>
>  include/linux/lsm_hooks.h | 170 ++++++++++++++++++--------------------
>  1 file changed, 81 insertions(+), 89 deletions(-)

Awesome; thanks! This fixes several warnings in "make htmldocs":

./include/linux/lsm_hooks.h:1783: warning: Function parameter or
member 'task_setioprio' not described in 'security_list_options'
./include/linux/lsm_hooks.h:1783: warning: Function parameter or
member 'task_getioprio' not described in 'security_list_options'
./include/linux/lsm_hooks.h:1783: warning: Function parameter or
member 'task_movememory' not described in 'security_list_options'
./include/linux/lsm_hooks.h:1783: warning: Function parameter or
member 'secmark_refcount_inc' not described in 'security_list_options'
./include/linux/lsm_hooks.h:1783: warning: Function parameter or
member 'secmark_refcount_dec' not described in 'security_list_options'

So, for the series:

Acked-by: Kees Cook <keescook@chromium.org>

If you want more work, I do notice the following warnings are still present:

./include/linux/lsm_hooks.h:1775: warning: Function parameter or
member 'quotactl' not described in 'security_list_options'
./include/linux/lsm_hooks.h:1775: warning: Function parameter or
member 'quota_on' not described in 'security_list_options'
./include/linux/lsm_hooks.h:1775: warning: Function parameter or
member 'sb_free_mnt_opts' not described in 'security_list_options'
./include/linux/lsm_hooks.h:1775: warning: Function parameter or
member 'sb_eat_lsm_opts' not described in 'security_list_options'
./include/linux/lsm_hooks.h:1775: warning: Function parameter or
member 'sb_kern_mount' not described in 'security_list_options'
./include/linux/lsm_hooks.h:1775: warning: Function parameter or
member 'sb_show_options' not described in 'security_list_options'
./include/linux/lsm_hooks.h:1775: warning: Function parameter or
member 'sb_add_mnt_opt' not described in 'security_list_options'
./include/linux/lsm_hooks.h:1775: warning: Function parameter or
member 'd_instantiate' not described in 'security_list_options'
./include/linux/lsm_hooks.h:1775: warning: Function parameter or
member 'getprocattr' not described in 'security_list_options'
./include/linux/lsm_hooks.h:1775: warning: Function parameter or
member 'setprocattr' not described in 'security_list_options'

:)
Denis Efremov Feb. 27, 2019, 3:10 p.m. UTC | #3
The rest of the warnings are about undocumented hooks. This patchset
fixes the existing documentation. I will try to document the hooks from
warnings in a separate patch. Some of the hooks are trivial enough, but
others require me digging into the code and mailing lists. Can't promise
to do it quickly.

27.02.2019 1:09, Kees Cook пишет:
> If you want more work, I do notice the following warnings are still present:
Kees Cook Feb. 27, 2019, 4:27 p.m. UTC | #4
On Wed, Feb 27, 2019 at 7:10 AM Denis Efremov <efremov@ispras.ru> wrote:
> The rest of the warnings are about undocumented hooks. This patchset
> fixes the existing documentation. I will try to document the hooks from
> warnings in a separate patch. Some of the hooks are trivial enough, but
> others require me digging into the code and mailing lists. Can't promise
> to do it quickly.

No worries! What you've added already helps a lot. :)
Denis Efremov March 26, 2019, 2:38 p.m. UTC | #5
Is there something more I could do so that these changes are accepted?
At least this patchset fixes the documentation format for better html
generation.

Denis

26.02.2019 21:49, Denis Efremov пишет:
> Recent "New LSM Hooks" discussion has led me to the
> thought that it might be a good idea to slightly
> update the current documentation. The patchset adds
> nothing new to the documentation, only fixes the old
> description of hooks to reflect their current state.
>
> V2 adds the clarification on arguments for some hooks.
> The format of the documentation is also slightly updated
> for better html. However, there are still 10 hooks without
> documentation at all. I think that this should be fixed
> separatedly.
>
> Denis Efremov (11):
>   LSM: fix documentation for sb_copy_data hook
>   LSM: fix documentation for the syslog hook
>   LSM: fix documentation for the socket_post_create hook
>   LSM: fix documentation for the task_setscheduler hook
>   LSM: fix documentation for the socket_getpeersec_dgram hook
>   LSM: fix documentation for the path_chmod hook
>   LSM: fix documentation for the audit_* hooks
>   LSM: fix documentation for the msg_queue_* hooks
>   LSM: fix documentation for the sem_* hooks
>   LSM: fix documentation for the shm_* hooks
>   LSM: lsm_hooks.h: fix documentation format
>
>  include/linux/lsm_hooks.h | 170 ++++++++++++++++++--------------------
>  1 file changed, 81 insertions(+), 89 deletions(-)
>
Jonathan Corbet March 26, 2019, 2:53 p.m. UTC | #6
On Tue, 26 Mar 2019 15:38:21 +0100
Denis Efremov <efremov@ispras.ru> wrote:

> Is there something more I could do so that these changes are accepted?
> At least this patchset fixes the documentation format for better html
> generation.

I had assumed that this would go through the security tree, but can
certainly pick it up if that works better.

jon
James Morris March 26, 2019, 6:16 p.m. UTC | #7
On Tue, 26 Mar 2019, Jonathan Corbet wrote:

> On Tue, 26 Mar 2019 15:38:21 +0100
> Denis Efremov <efremov@ispras.ru> wrote:
> 
> > Is there something more I could do so that these changes are accepted?
> > At least this patchset fixes the documentation format for better html
> > generation.
> 
> I had assumed that this would go through the security tree, but can
> certainly pick it up if that works better.

I'll take them for 5.2.

> 
> jon
>
James Morris March 27, 2019, 2:22 a.m. UTC | #8
On Tue, 26 Feb 2019, Denis Efremov wrote:

> Recent "New LSM Hooks" discussion has led me to the
> thought that it might be a good idea to slightly
> update the current documentation. The patchset adds
> nothing new to the documentation, only fixes the old
> description of hooks to reflect their current state.
> 
> V2 adds the clarification on arguments for some hooks.
> The format of the documentation is also slightly updated
> for better html. However, there are still 10 hooks without
> documentation at all. I think that this should be fixed
> separatedly.

Applied to
git://git.kernel.org/pub/scm/linux/kernel/git/jmorris/linux-security.git next-general

Thanks!