Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="4q0FYxB+" Received: from mail-ed1-x54a.google.com (mail-ed1-x54a.google.com [IPv6:2a00:1450:4864:20::54a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7008FA5 for ; Fri, 17 Nov 2023 07:49:51 -0800 (PST) Received: by mail-ed1-x54a.google.com with SMTP id 4fb4d7f45d1cf-547dd379955so1746565a12.3 for ; Fri, 17 Nov 2023 07:49:51 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1700236190; x=1700840990; darn=vger.kernel.org; h=content-transfer-encoding:cc:to:from:subject:references :mime-version:message-id:in-reply-to:date:from:to:cc:subject:date :message-id:reply-to; bh=UjpIRKfLH4jxjWvtSwMRZAc4j0fbDDTVnVDRRUKAiaw=; b=4q0FYxB+JHPRuurLdHFzsdt5ynaF0J6xcBuXoLKdeTeD9I+U5qbeRJ7zGdmYSa04N9 j34o9St+Me0YWNT1iQ/Z1QZpEtvIsDquYkfP+Updu7jV2D2DprQL8X0eoky24Tdi3azA /jhO+EQU8T66MHzARjHOaC2jGw/2lT1+wSfXlIlpAbMaRLZzBxotgNACH+NiW613RyoQ V1Q33bKWy72Q8EXo0y/Yo19kYxqmAdFkqIgW6ps6aB/NX86raEuAxhUFe2owgKz9Y/O8 U87eMDexuww36w+7a5mo0zmxWD0I+r/W796Exk1oYAJunFbPk8C4jMacOAUj7z13SaC8 0R0Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1700236190; x=1700840990; h=content-transfer-encoding:cc:to:from:subject:references :mime-version:message-id:in-reply-to:date:x-gm-message-state:from:to :cc:subject:date:message-id:reply-to; bh=UjpIRKfLH4jxjWvtSwMRZAc4j0fbDDTVnVDRRUKAiaw=; b=M8HqFKHYKcwqjt884OhSOYRbnYgqcQRTHoWlyEXRJkoT8DUSk0SqzsnbKN7Bqq8eSM fpGH9Cz20lOB0wWdi4G3k2/+3qr9C4ElWCTKkCRV60Srq1r6efuOZx/a75C3E2rkwHqg 9im51wy2VXSEaqq1tD9C9cdL9V5LmHeBrrJK4lLSkTRvofBt2eCf4sFvEdtrfu2joTJU bSA2shuF12GSiIAdsPdP33EfIns9e1VW49aIIwdOMwxeN2WJySsR8EqpoWC6aITtY6/Q otwxgrxnwElBGkMrO8tXkb2l+qRnsVdr9Aib3dUhuvUqpQmsNB2EwNASa3nQQMXtNSca nYXg== X-Gm-Message-State: AOJu0Yweb59LYZiwxblfIjuaI9T2WoMZPbPBtjDqnZwgoI9smsBDRIL5 QzWmsZpY6UDFe6un8g3/TAOPINJvMHI= X-Google-Smtp-Source: AGHT+IGOr7JS3OmrIUTFmVrM7kdzj2BjRwq2nLdiM/Wq4pwI2An3HLV7XC8kWDvEHLue+J7oiBdRkw9pyfY= X-Received: from sport.zrh.corp.google.com ([2a00:79e0:9d:4:2ae5:2882:889e:d0cf]) (user=gnoack job=sendgmr) by 2002:a05:6402:60f:b0:542:e967:bfe5 with SMTP id n15-20020a056402060f00b00542e967bfe5mr211782edv.7.1700236189937; Fri, 17 Nov 2023 07:49:49 -0800 (PST) Date: Fri, 17 Nov 2023 16:49:20 +0100 In-Reply-To: <20231117154920.1706371-1-gnoack@google.com> Message-Id: <20231117154920.1706371-8-gnoack@google.com> Precedence: bulk X-Mailing-List: linux-fsdevel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20231117154920.1706371-1-gnoack@google.com> X-Mailer: git-send-email 2.43.0.rc0.421.g78406f8d94-goog Subject: [PATCH v5 7/7] landlock: Document IOCTL support From: "=?UTF-8?q?G=C3=BCnther=20Noack?=" To: linux-security-module@vger.kernel.org, "=?UTF-8?q?Micka=C3=ABl=20Sala=C3=BCn?=" Cc: Jeff Xu , Jorge Lucangeli Obes , Allen Webb , Dmitry Torokhov , Paul Moore , Konstantin Meskhidze , Matt Bobrowski , linux-fsdevel@vger.kernel.org, "=?UTF-8?q?G=C3=BCnther=20Noack?=" Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable In the paragraph above the fallback logic, use the shorter phrasing from the landlock(7) man page. Signed-off-by: G=C3=BCnther Noack --- Documentation/userspace-api/landlock.rst | 74 +++++++++++++++++++----- 1 file changed, 59 insertions(+), 15 deletions(-) diff --git a/Documentation/userspace-api/landlock.rst b/Documentation/users= pace-api/landlock.rst index 2e3822677061..68498ca64dc9 100644 --- a/Documentation/userspace-api/landlock.rst +++ b/Documentation/userspace-api/landlock.rst @@ -75,7 +75,8 @@ to be explicit about the denied-by-default access rights. LANDLOCK_ACCESS_FS_MAKE_BLOCK | LANDLOCK_ACCESS_FS_MAKE_SYM | LANDLOCK_ACCESS_FS_REFER | - LANDLOCK_ACCESS_FS_TRUNCATE, + LANDLOCK_ACCESS_FS_TRUNCATE | + LANDLOCK_ACCESS_FS_IOCTL, .handled_access_net =3D LANDLOCK_ACCESS_NET_BIND_TCP | LANDLOCK_ACCESS_NET_CONNECT_TCP, @@ -84,10 +85,10 @@ to be explicit about the denied-by-default access right= s. Because we may not know on which kernel version an application will be executed, it is safer to follow a best-effort security approach. Indeed, = we should try to protect users as much as possible whatever the kernel they a= re -using. To avoid binary enforcement (i.e. either all security features or -none), we can leverage a dedicated Landlock command to get the current ver= sion -of the Landlock ABI and adapt the handled accesses. Let's check if we sho= uld -remove access rights which are only supported in higher versions of the AB= I. +using. + +To be compatible with older Linux versions, we detect the available Landlo= ck ABI +version, and only use the available subset of access rights: =20 .. code-block:: c =20 @@ -113,6 +114,10 @@ remove access rights which are only supported in highe= r versions of the ABI. ruleset_attr.handled_access_net &=3D ~(LANDLOCK_ACCESS_NET_BIND_TCP | LANDLOCK_ACCESS_NET_CONNECT_TCP); + __attribute__((fallthrough)); + case 4: + /* Removes LANDLOCK_ACCESS_FS_IOCTL for ABI < 5 */ + ruleset_attr.handled_access_fs &=3D ~LANDLOCK_ACCESS_FS_IOCTL; } =20 This enables to create an inclusive ruleset that will contain our rules. @@ -224,6 +229,7 @@ access rights per directory enables to change the locat= ion of such directory without relying on the destination directory access rights (except those t= hat are required for this operation, see ``LANDLOCK_ACCESS_FS_REFER`` documentation). + Having self-sufficient hierarchies also helps to tighten the required acce= ss rights to the minimal set of data. This also helps avoid sinkhole directo= ries, i.e. directories where data can be linked to but not linked from. Howeve= r, @@ -317,18 +323,24 @@ It should also be noted that truncating files does no= t require the system call, this can also be done through :manpage:`open(2)` with the fla= gs ``O_RDONLY | O_TRUNC``. =20 -When opening a file, the availability of the ``LANDLOCK_ACCESS_FS_TRUNCATE= `` -right is associated with the newly created file descriptor and will be use= d for -subsequent truncation attempts using :manpage:`ftruncate(2)`. The behavio= r is -similar to opening a file for reading or writing, where permissions are ch= ecked -during :manpage:`open(2)`, but not during the subsequent :manpage:`read(2)= ` and +The truncate right is associated with the opened file (see below). + +Rights associated with file descriptors +--------------------------------------- + +When opening a file, the availability of the ``LANDLOCK_ACCESS_FS_TRUNCATE= `` and +``LANDLOCK_ACCESS_FS_IOCTL`` rights is associated with the newly created f= ile +descriptor and will be used for subsequent truncation and ioctl attempts u= sing +:manpage:`ftruncate(2)` and :manpage:`ioctl(2)`. The behavior is similar = to +opening a file for reading or writing, where permissions are checked durin= g +:manpage:`open(2)`, but not during the subsequent :manpage:`read(2)` and :manpage:`write(2)` calls. =20 -As a consequence, it is possible to have multiple open file descriptors fo= r the -same file, where one grants the right to truncate the file and the other d= oes -not. It is also possible to pass such file descriptors between processes, -keeping their Landlock properties, even when these processes do not have a= n -enforced Landlock ruleset. +As a consequence, it is possible to have multiple open file descriptors +referring to the same file, where one grants the truncate or ioctl right a= nd the +other does not. It is also possible to pass such file descriptors between +processes, keeping their Landlock properties, even when these processes do= not +have an enforced Landlock ruleset. =20 Compatibility =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D @@ -457,6 +469,28 @@ Memory usage Kernel memory allocated to create rulesets is accounted and can be restric= ted by the Documentation/admin-guide/cgroup-v1/memory.rst. =20 +IOCTL support +------------- + +The ``LANDLOCK_ACCESS_FS_IOCTL`` access right restricts the use of +:manpage:`ioctl(2)`, but it only applies to newly opened files. This mean= s +specifically that pre-existing file descriptors like stdin, stdout and std= err +are unaffected. + +Users should be aware that TTY devices have traditionally permitted to con= trol +other processes on the same TTY through the ``TIOCSTI`` and ``TIOCLINUX`` = IOCTL +commands. It is therefore recommended to close inherited TTY file descrip= tors, +or to reopen them from ``/proc/self/fd/*`` without the +``LANDLOCK_ACCESS_FS_IOCTL`` right, if possible. The :manpage:`isatty(3)` +function checks whether a given file descriptor is a TTY. + +Landlock's IOCTL support is coarse-grained at the moment, but may become m= ore +fine-grained in the future. Until then, users are advised to establish th= e +guarantees that they need through the file hierarchy, by only permitting t= he +``LANDLOCK_ACCESS_FS_IOCTL`` right on files where it is really harmless. = In +cases where you can control the mounts, the ``nodev`` mount option can hel= p to +rule out that device files can be accessed. + Previous limitations =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 @@ -494,6 +528,16 @@ bind and connect actions to only a set of allowed port= s thanks to the new ``LANDLOCK_ACCESS_NET_BIND_TCP`` and ``LANDLOCK_ACCESS_NET_CONNECT_TCP`` access rights. =20 +IOCTL (ABI < 5) +--------------- + +IOCTL operations could not be denied before the fifth Landlock ABI, so +:manpage:`ioctl(2)` is always allowed when using a kernel that only suppor= ts an +earlier ABI. + +Starting with the Landlock ABI version 5, it is possible to restrict the u= se of +:manpage:`ioctl(2)` using the new ``LANDLOCK_ACCESS_FS_IOCTL`` access righ= t. + .. _kernel_support: =20 Kernel support --=20 2.43.0.rc1.413.gea7ed67945-goog