Received-SPF: pass (google.com: domain of linux-kernel+bounces-83609-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.48.161 as permitted sender) client-ip=147.75.48.161;
Date: Tue, 27 Feb 2024 17:32:20 +0100
In-Reply-To: <20240227110550.3702236-1-mic@digikod.net>
Message-Id: <Zd4OlL1G3t1D3TgC@google.com>
Precedence: bulk
Mime-Version: 1.0
References: <20240227110550.3702236-1-mic@digikod.net>
Subject: Re: [PATCH v2 1/2] landlock: Extend documentation for kernel support
From: "=?utf-8?Q?G=C3=BCnther?= Noack" <gnoack@google.com>
To: "=?utf-8?Q?Micka=C3=ABl_Sala=C3=BCn?=" <mic@digikod.net>
Cc: Paul Moore <paul@paul-moore.com>, "Serge E . Hallyn" <serge@hallyn.com>, 
	Konstantin Meskhidze <konstantin.meskhidze@huawei.com>, Shervin Oloumi <enlightened@chromium.org>, 
	linux-hardening@vger.kernel.org, linux-kernel@vger.kernel.org, 
	linux-security-module@vger.kernel.org, Kees Cook <keescook@chromium.org>
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable

On Tue, Feb 27, 2024 at 12:05:49PM +0100, Micka=C3=ABl Sala=C3=BCn wrote:
> Extend the kernel support section with one subsection for build time
> configuration and another for boot time configuration.
>=20
> Extend the boot time subsection with a concrete example.
>=20
> Update the journalctl command to include the boot option.
>=20
> Cc: G=C3=BCnther Noack <gnoack@google.com>
> Cc: Kees Cook <keescook@chromium.org>
> Signed-off-by: Micka=C3=ABl Sala=C3=BCn <mic@digikod.net>
> ---
>=20
> Changes since v1:
> * New patch, suggested by Kees Cook.
> ---
>  Documentation/userspace-api/landlock.rst | 57 +++++++++++++++++++++---
>  1 file changed, 51 insertions(+), 6 deletions(-)
>=20
> diff --git a/Documentation/userspace-api/landlock.rst b/Documentation/use=
rspace-api/landlock.rst
> index 2e3822677061..838cc27db232 100644
> --- a/Documentation/userspace-api/landlock.rst
> +++ b/Documentation/userspace-api/landlock.rst
> +Boot time configuration
> +-----------------------
> +
>  If the running kernel does not have ``landlock`` in ``CONFIG_LSM``, then=
 we can
> -still enable it by adding ``lsm=3Dlandlock,[...]`` to
> +enable Landlock by adding ``lsm=3Dlandlock,[...]`` to
>  Documentation/admin-guide/kernel-parameters.rst thanks to the bootloader
>  configuration.

I would suggest: s/thanks to/in/

> +For example, if the current built-in configuration is:
> +
> +.. code-block:: console
> +
> +    $ zgrep -h "^CONFIG_LSM=3D" "/boot/config-$(uname -r)" /proc/config.=
gz 2>/dev/null
> +    CONFIG_LSM=3D"lockdown,yama,integrity,apparmor"
> +
> +...and if the cmdline doesn't contain ``landlock`` either:
> +
> +.. code-block:: console
> +
> +    $ sed -n 's/.*\(\<lsm=3D\S\+\).*/\1/p' /proc/cmdline
> +    lsm=3Dlockdown,yama,integrity,apparmor
> +
> +...we should configure the bootloader to set a cmdline extending the ``l=
sm``
> +list with the ``landlock,`` prefix::

Nit: Is the double colon at the end of this line accidental?
(It does not appear before the previous code block.)

> +
> +  lsm=3Dlandlock,lockdown,yama,integrity,apparmor
> +
> +After a reboot, we can check that Landlock is up and running by looking =
at
> +kernel logs:
> +
> +.. code-block:: console
> +
> +    # dmesg | grep landlock || journalctl -kb -g landlock
> +    [    0.000000] Command line: [...] lsm=3Dlandlock,lockdown,yama,inte=
grity,apparmor
> +    [    0.000000] Kernel command line: [...] lsm=3Dlandlock,lockdown,ya=
ma,integrity,apparmor
> +    [    0.000000] LSM: initializing lsm=3Dlockdown,capability,landlock,=
yama,integrity,apparmor
> +    [    0.000000] landlock: Up and running.
> +
> +Note that according to the built time kernel configuration,

s/built time/build time/
                 ^

It feels like the phrase "according to" could be slightly more specific her=
e.

To paraphrase Alejandro Colomar, "Note that" is usually redundant.
https://lore.kernel.org/all/0aafcdd6-4ac7-8501-c607-9a24a98597d7@gmail.com/

I'd suggest:

  The kernel may be configured at build time to always load the ``lockdown`=
` and
  ``capability`` LSMs.  In that case, these LSMs will appear at the beginni=
ng of
  the ``LSM: initializing`` log line as well, even if they are not configur=
ed in
  the boot loader.

> +``lockdown,capability,`` may always stay at the beginning of the ``LSM:
> +initializing lsm=3D`` list even if they are not configured with the boot=
loader,

Nit: The man pages spell this in two words as "boot loader".


> +which is OK.
> +
> +Network support
> +---------------
> +
>  To be able to explicitly allow TCP operations (e.g., adding a network ru=
le with
>  ``LANDLOCK_ACCESS_NET_BIND_TCP``), the kernel must support TCP
>  (``CONFIG_INET=3Dy``).  Otherwise, sys_landlock_add_rule() returns an
>=20
> base-commit: b4007fd27206c478a4b76e299bddf4a71787f520
> --=20
> 2.44.0
>=20

Reviewed-by: G=C3=BCnther Noack <gnoack@google.com>