landlock: Add user and kernel documentation
authorMickaël Salaün <mic@linux.microsoft.com>
Thu, 22 Apr 2021 15:41:22 +0000 (17:41 +0200)
committerJames Morris <jamorris@linux.microsoft.com>
Thu, 22 Apr 2021 19:22:11 +0000 (12:22 -0700)
commit5526b450834331d9196cae26acef0bfd5afd9fc4
tree74f98af828ca72f8c2cda9fa4eb634e6b71d3071
parentba84b0bf5a164f0f523656c1e37568c30f3f3303
landlock: Add user and kernel documentation

Add a first document describing userspace API: how to define and enforce
a Landlock security policy.  This is explained with a simple example.
The Landlock system calls are described with their expected behavior and
current limitations.

Another document is dedicated to kernel developers, describing guiding
principles and some important kernel structures.

This documentation can be built with the Sphinx framework.

Cc: James Morris <jmorris@namei.org>
Cc: Jann Horn <jannh@google.com>
Cc: Serge E. Hallyn <serge@hallyn.com>
Signed-off-by: Mickaël Salaün <mic@linux.microsoft.com>
Reviewed-by: Vincent Dagonneau <vincent.dagonneau@ssi.gouv.fr>
Reviewed-by: Kees Cook <keescook@chromium.org>
Link: https://lore.kernel.org/r/20210422154123.13086-13-mic@digikod.net
Signed-off-by: James Morris <jamorris@linux.microsoft.com>
Documentation/security/index.rst
Documentation/security/landlock.rst [new file with mode: 0644]
Documentation/userspace-api/index.rst
Documentation/userspace-api/landlock.rst [new file with mode: 0644]
MAINTAINERS