mbox series

[v2,0/2] lsm: Improve LSM hooks documentation

Message ID 20221128144240.210110-1-roberto.sassu@huaweicloud.com
Headers
Series lsm: Improve LSM hooks documentation |

Message

Roberto Sassu Nov. 28, 2022, 2:42 p.m. UTC 
  From: Roberto Sassu <roberto.sassu@huawei.com>

The recent discussion about return values from LSM hooks, available here:

https://lore.kernel.org/bpf/20221115175652.3836811-1-roberto.sassu@huaweicloud.com/

motivated revisiting the documentation in include/linux/lsm_hooks.h, to
ensure that it is complete and accurate. It was also a good occasion to fix
discovered formatting issues.

Changelog:

v1 (security: Ensure LSMs return expected values):
- A positive value, not only 1 can cause cap_set_admin to be set when
  calling __vm_enough_memory() (reported by Paul)
- Improve description of the vm_enough_memory hook
- Remove documentation of the sb_add_mnt_opt hook, as it was removed
  (reported by Paul)
- Add more periods in the parameters description
- Adjust mmap_addr and mmap_file semicolon
- Move description of gfp parameter of xfrm_policy_alloc_security together
  with the others
- Add missing return value description for binder_transaction,
  binder_transfer_binder, binder_transfer_file, quotactl and quota_on
- Improve return value description for sb_eat_lsm_opts, sb_show_options,
  dentry_init_security, dentry_create_files_as and sctp_assoc_established

Roberto Sassu (2):
  lsm: Clarify documentation of vm_enough_memory hook
  lsm: Add/fix return values in lsm_hooks.h and fix formatting

 include/linux/lsm_hooks.h | 227 ++++++++++++++++++++++++--------------
 1 file changed, 143 insertions(+), 84 deletions(-)

Comments

Casey Schaufler Nov. 29, 2022, 4:48 p.m. UTC | #1 
On 11/28/2022 6:42 AM, Roberto Sassu wrote:
> From: Roberto Sassu <roberto.sassu@huawei.com>

For the series:

Reviewed-by: Casey Schaufler <casey@schaufler-ca.com>

>
> The recent discussion about return values from LSM hooks, available here:
>
> https://lore.kernel.org/bpf/20221115175652.3836811-1-roberto.sassu@huaweicloud.com/
>
> motivated revisiting the documentation in include/linux/lsm_hooks.h, to
> ensure that it is complete and accurate. It was also a good occasion to fix
> discovered formatting issues.
>
> Changelog:
>
> v1 (security: Ensure LSMs return expected values):
> - A positive value, not only 1 can cause cap_set_admin to be set when
>   calling __vm_enough_memory() (reported by Paul)
> - Improve description of the vm_enough_memory hook
> - Remove documentation of the sb_add_mnt_opt hook, as it was removed
>   (reported by Paul)
> - Add more periods in the parameters description
> - Adjust mmap_addr and mmap_file semicolon
> - Move description of gfp parameter of xfrm_policy_alloc_security together
>   with the others
> - Add missing return value description for binder_transaction,
>   binder_transfer_binder, binder_transfer_file, quotactl and quota_on
> - Improve return value description for sb_eat_lsm_opts, sb_show_options,
>   dentry_init_security, dentry_create_files_as and sctp_assoc_established
>
> Roberto Sassu (2):
>   lsm: Clarify documentation of vm_enough_memory hook
>   lsm: Add/fix return values in lsm_hooks.h and fix formatting
>
>  include/linux/lsm_hooks.h | 227 ++++++++++++++++++++++++--------------
>  1 file changed, 143 insertions(+), 84 deletions(-)
>