From patchwork Mon Jan 22 15:28:50 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Jeff Xu X-Patchwork-Id: 13525660 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 17543C47DDB for ; Mon, 22 Jan 2024 15:29:24 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 4BF0D8D000A; Mon, 22 Jan 2024 10:29:15 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 41D858D0008; Mon, 22 Jan 2024 10:29:15 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 222318D000A; Mon, 22 Jan 2024 10:29:15 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0013.hostedemail.com [216.40.44.13]) by kanga.kvack.org (Postfix) with ESMTP id 0A5658D0008 for ; Mon, 22 Jan 2024 10:29:15 -0500 (EST) Received: from smtpin05.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay03.hostedemail.com (Postfix) with ESMTP id D5211A0A27 for ; Mon, 22 Jan 2024 15:29:14 +0000 (UTC) X-FDA: 81707330628.05.D71D8D6 Received: from mail-pf1-f178.google.com (mail-pf1-f178.google.com [209.85.210.178]) by imf18.hostedemail.com (Postfix) with ESMTP id EB4D11C001A for ; Mon, 22 Jan 2024 15:29:12 +0000 (UTC) Authentication-Results: imf18.hostedemail.com; dkim=pass header.d=chromium.org header.s=google header.b=eygoeqmE; spf=pass (imf18.hostedemail.com: domain of jeffxu@chromium.org designates 209.85.210.178 as permitted sender) smtp.mailfrom=jeffxu@chromium.org; dmarc=pass (policy=none) header.from=chromium.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1705937353; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=mkL2/JBu7Xm4fXV2SaZyo6nhyEe635LV1RL9ITVGXBc=; b=nqHphefv2l4G9xNpZpo9q6n9LCARlKPDmtT1Vr/npnIcckohToJYT1IXLqMlHA92taES/G GxzcgYvWbv4AB+uMtDqMGnu6lfFem9fsCs7iqqjEVB7LYf3iM4LRHrSo4WEIMQfunDkmaF oiTLF0ZgXCyt62z3mLqsJMlT6aLfnyk= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1705937353; a=rsa-sha256; cv=none; b=oVB1xq1awCmPY4bS68M2HZfxaTfdav744tVOiZRRf/c6ySEX1FD1ww7LHkddxz6Ye0GfQ9 PnMM2uTO94/gFXKKgOPxXZROtby+6ygnk09MjM0pntVxPSTOUEkF+ElXj1AvashGEgWGrs sBfF3I1m0+1qO+e0cIZTuznTo5DF2kQ= ARC-Authentication-Results: i=1; imf18.hostedemail.com; dkim=pass header.d=chromium.org header.s=google header.b=eygoeqmE; spf=pass (imf18.hostedemail.com: domain of jeffxu@chromium.org designates 209.85.210.178 as permitted sender) smtp.mailfrom=jeffxu@chromium.org; dmarc=pass (policy=none) header.from=chromium.org Received: by mail-pf1-f178.google.com with SMTP id d2e1a72fcca58-6db0fdd2b8fso1459911b3a.2 for ; Mon, 22 Jan 2024 07:29:12 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1705937352; x=1706542152; darn=kvack.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=mkL2/JBu7Xm4fXV2SaZyo6nhyEe635LV1RL9ITVGXBc=; b=eygoeqmE4GvcQfcSRzhWzO8rZWR8g2G6cNx93HvD2EfwGMsUonL0hcxKZJaPfpwYur B05B4O6fQuQJU2Ec7MrBzYgaPmqauzxAHfuNYykMFsRy8pbB5rCjhL9kOuXlpQITQGMW Fzg2fGNM4v/RlpMpvO2esWd34+XPeLK9VFHYU= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1705937352; x=1706542152; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=mkL2/JBu7Xm4fXV2SaZyo6nhyEe635LV1RL9ITVGXBc=; b=g35nc7yrMN4IGgnqo62bJUGq1w3stowYVPhlh3DooiIfnhtZ3t4Uovfs6Eko/IYW84 sxk4aSj61h28D337MWWz1OKZrIb/yL1nGZNZao2T+ts4E8Ewvg//w6+acOqFDh7nSl4Y zv52BwfDljG7a2ytAH5vKa5Ts+kUhbovVkSZkF0tEcQSZlNc8Z1sbgTT1Itj0kjETeni lsokHNdrAs2PSbQIr/rKyUHrR3IdHR41JSTYe3YqYTfQbweIZvsWY+mcpUK/6L5XLAB2 iGXsAtTPejeEWJ0JNubmT2sswnGTthE3isv4vVc49cxNFwMEzHpdjwqWoZmAXjc61CbV lpiw== X-Gm-Message-State: AOJu0YxJcwcXFSP3FWqcuODdgkzcv5usr8iZNKJ0nG+ss8VXkR1vchnL QIu90qutkXrm0u5E7V0Tl/77dUA/OJDI3YZKgjrGrwIotyJrgNS/yjnxS4AHKw== X-Google-Smtp-Source: AGHT+IEojaweEqOqB9iixvGtj85QUL1W2QLrCxvGYzSIRt4xieXc2D9OQdVdixqSGP+kissYVTN+GQ== X-Received: by 2002:a17:902:d489:b0:1d6:fbab:d409 with SMTP id c9-20020a170902d48900b001d6fbabd409mr2261821plg.58.1705937351561; Mon, 22 Jan 2024 07:29:11 -0800 (PST) Received: from localhost (34.85.168.34.bc.googleusercontent.com. [34.168.85.34]) by smtp.gmail.com with UTF8SMTPSA id h30-20020a056a00001e00b006d9ac70682bsm9638639pfk.167.2024.01.22.07.29.11 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Mon, 22 Jan 2024 07:29:11 -0800 (PST) From: jeffxu@chromium.org To: akpm@linux-foundation.org, keescook@chromium.org, jannh@google.com, sroettger@google.com, willy@infradead.org, gregkh@linuxfoundation.org, torvalds@linux-foundation.org, usama.anjum@collabora.com, rdunlap@infradead.org Cc: jeffxu@google.com, jorgelo@chromium.org, groeck@chromium.org, linux-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org, linux-mm@kvack.org, pedro.falcato@gmail.com, dave.hansen@intel.com, linux-hardening@vger.kernel.org, deraadt@openbsd.org, Jeff Xu Subject: [PATCH v7 4/4] mseal:add documentation Date: Mon, 22 Jan 2024 15:28:50 +0000 Message-ID: <20240122152905.2220849-5-jeffxu@chromium.org> X-Mailer: git-send-email 2.43.0.429.g432eaa2c6b-goog In-Reply-To: <20240122152905.2220849-1-jeffxu@chromium.org> References: <20240122152905.2220849-1-jeffxu@chromium.org> MIME-Version: 1.0 X-Stat-Signature: 7dn7bsdxt5f8q7qfrz5d1xzgyejjkmny X-Rspamd-Server: rspam10 X-Rspamd-Queue-Id: EB4D11C001A X-Rspam-User: X-HE-Tag: 1705937352-122209 X-HE-Meta: U2FsdGVkX19Vty1yS65EQjjvJUWCsltIJy5Yve17p3L/sBmr5wxNBGcXohNSEMjY5iXSDD0KN638YwVnuTnijDeAIMWyTXMI9y4nNpWwczXR0CLPy5lwqWr6VBddXX8v22jZjdAw8mcRZU3iLGJqSfao6t7IQ/p2DQH+VBcmxGRN1kf6gcAvGlm2F0QRdhK1ddm/VZfDNvBOah2darVc407c1ETZbDUycFPCc0bhIa8njoAJ9+4oKm+S1l2ErK6C3Yw8CNqXpkZXUzA4A8vGBV5p1IXMBCK+kVmaWfZGjP3JzOqB1+FZI851+T+LphDlvAAibOVu9sevOojTgc9UZ9iz+l7G46EehO61Vl4t4lgqjYJf61gJBN9LU4XcVyUyAnHOK4D7yceIVoOsgft9nHWxvZckCQCDYymms2vtgthnH3K5VYu3qSzVRytxuIHN6PnRcPSMQqb+v/uPF/29Kv2jILqJxIxKmSpLbu3iZ7nJzLATLX6TXJrtGcbX/hgliwSBhZOfiqq7xaOF87tG9XDv9dtPJ9//YAhomOmv11mymO4hprGBf8RhncDDD/Ixtdec60KXPUCGkybkiS1mrekUDKqDHNDpn5WKHcIAEBRubvIKbixB6uZQ86cDil/H4ONJ7XD7/qNH1WLYXzAnZifdEKb6iUSLBZAwjzyty8fjkk8EctpkCt9kcAiT47dI5yM3wUune1AaiqxD18aubQiwEnFxtbdjBEE511JRkOnEo2uV4nvYAPmvJYVQMmypOZYfqWe6DXhZWI3b6VmwmiMV5yNs73be6ClgvAAid4a7OeRUumMJR1t14xbtkCbcjMRd9h73JRC3skkSl41dYw8DxlbuwnbbfT2PrvCSMh3zpdHhpwUrCFzZGx4AWXGpIBVQTEro0zbXT4UjIYTdsiS2K16BG3m8pLsHgW0CxIND6xTxMvMANxXKS0GRrBegHJXr30cj54rN5HdPebB weWJ9ZHB 8SYrzyYVc4OQyUADPY8hRG8t790b7KQB5Kj0a4G84xTA6JXrd86MsvQMu9P+QNsvT8kNL364ayWwQu/aJwj25HFL2TaKIvV9qK6FRo1ahzxLHnJsuut3VsbIYALr1SGCfReeq6YjleZSnUaXf5luizjFYcx3hR2ZHWkMpfatH7gIKvuj4bMRzXDB1pVbCDvNiGSxjECJWQa7/vJZxgpefsj6LkSAYJvhkAdBowqisFnyr03nXYMs4FBMnr49EphJ1nxxKJv7/r43hgShUZdLYhIhxvbvXpRIJdZEfHW1GfJ+xfkjGy4ut/qBlf7Xi0FoQ/g+auriaY3S+IK9QigJYKDQP563zcM3bp4pF1jzAqmzLlkuLyVTgLlgrAC/FAyYRY49Q7RP44fYS8Yn/IGW/n/Zx76f+ThIs6PSmhD9qo0wc2D+/i7pWprifet6RFpCRD7Ca0M9puQodq2mCTCP5J7xF4TQV5nJBljXN5TydjQxSntW1QBZgawNPpnBfQM/ZBYwDPA3/etVqCTEsnHtYKKHDlRZsgQwXn/qD5xZoTEm7l+0Gvv6ilVKGNsbWP8SQyhuGmnmPy7wmuweuPBsR54i42soEZWubSUqqT/zvYiB/DsUmXRJa9Gwi9IpuJUecz4go X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: List-Subscribe: List-Unsubscribe: From: Jeff Xu Add documentation for mseal(). Signed-off-by: Jeff Xu --- Documentation/userspace-api/index.rst | 1 + Documentation/userspace-api/mseal.rst | 183 ++++++++++++++++++++++++++ 2 files changed, 184 insertions(+) create mode 100644 Documentation/userspace-api/mseal.rst diff --git a/Documentation/userspace-api/index.rst b/Documentation/userspace-api/index.rst index 09f61bd2ac2e..178f6a1d79cb 100644 --- a/Documentation/userspace-api/index.rst +++ b/Documentation/userspace-api/index.rst @@ -26,6 +26,7 @@ place where this information is gathered. iommu iommufd media/index + mseal netlink/index sysfs-platform_profile vduse diff --git a/Documentation/userspace-api/mseal.rst b/Documentation/userspace-api/mseal.rst new file mode 100644 index 000000000000..929a706b70eb --- /dev/null +++ b/Documentation/userspace-api/mseal.rst @@ -0,0 +1,183 @@ +.. SPDX-License-Identifier: GPL-2.0 + +===================== +Introduction of mseal +===================== + +:Author: Jeff Xu + +Modern CPUs support memory permissions such as RW and NX bits. The memory +permission feature improves security stance on memory corruption bugs, i.e. +the attacker can’t just write to arbitrary memory and point the code to it, +the memory has to be marked with X bit, or else an exception will happen. + +Memory sealing additionally protects the mapping itself against +modifications. This is useful to mitigate memory corruption issues where a +corrupted pointer is passed to a memory management system. For example, +such an attacker primitive can break control-flow integrity guarantees +since read-only memory that is supposed to be trusted can become writable +or .text pages can get remapped. Memory sealing can automatically be +applied by the runtime loader to seal .text and .rodata pages and +applications can additionally seal security critical data at runtime. + +A similar feature already exists in the XNU kernel with the +VM_FLAGS_PERMANENT flag [1] and on OpenBSD with the mimmutable syscall [2]. + +User API +======== +Two system calls are involved in virtual memory sealing, mseal() and mmap(). + +mseal() +----------- +The mseal() syscall has the following signature: + +``int mseal(void addr, size_t len, unsigned long flags)`` + +**addr/len**: virtual memory address range. + +The address range set by ``addr``/``len`` must meet: + - The start address must be in an allocated VMA. + - The start address must be page aligned. + - The end address (``addr`` + ``len``) must be in an allocated VMA. + - no gap (unallocated memory) between start and end address. + +The ``len`` will be paged aligned implicitly by the kernel. + +**flags**: reserved for future use. + +**return values**: + +- ``0``: Success. + +- ``-EINVAL``: + - Invalid input ``flags``. + - The start address (``addr``) is not page aligned. + - Address range (``addr`` + ``len``) overflow. + +- ``-ENOMEM``: + - The start address (``addr``) is not allocated. + - The end address (``addr`` + ``len``) is not allocated. + - A gap (unallocated memory) between start and end address. + +- ``-EACCES``: + - ``MAP_SEALABLE`` is not set during mmap(). + +- ``-EPERM``: + - sealing is supported only on 64-bit CPUs, 32-bit is not supported. + +- For above error cases, users can expect the given memory range is + unmodified, i.e. no partial update. + +- There might be other internal errors/cases not listed here, e.g. + error during merging/splitting VMAs, or the process reaching the max + number of supported VMAs. In those cases, partial updates to the given + memory range could happen. However, those cases should be rare. + +**Blocked operations after sealing**: + Unmapping, moving to another location, and shrinking the size, + via munmap() and mremap(), can leave an empty space, therefore + can be replaced with a VMA with a new set of attributes. + + Moving or expanding a different VMA into the current location, + via mremap(). + + Modifying a VMA via mmap(MAP_FIXED). + + Size expansion, via mremap(), does not appear to pose any + specific risks to sealed VMAs. It is included anyway because + the use case is unclear. In any case, users can rely on + merging to expand a sealed VMA. + + mprotect() and pkey_mprotect(). + + Some destructive madvice() behaviors (e.g. MADV_DONTNEED) + for anonymous memory, when users don't have write permission to the + memory. Those behaviors can alter region contents by discarding pages, + effectively a memset(0) for anonymous memory. + + Kernel will return -EPERM for blocked operations. + +**Note**: + +- mseal() only works on 64-bit CPUs, not 32-bit CPU. + +- users can call mseal() multiple times, mseal() on an already sealed memory + is a no-action (not error). + +- munseal() is not supported. + +mmap() +---------- +``void *mmap(void* addr, size_t length, int prot, int flags, int fd, +off_t offset);`` + +We add two changes in ``prot`` and ``flags`` of mmap() related to +memory sealing. + +**prot** + +The ``PROT_SEAL`` bit in ``prot`` field of mmap(). + +When present, it marks the memory is sealed since creation. + +This is useful as optimization because it avoids having to make two +system calls: one for mmap() and one for mseal(). + +It's worth noting that even though the sealing is set via the +``prot`` field in mmap(), it can't be set in the ``prot`` +field in later mprotect(). This is unlike the ``PROT_READ``, +``PROT_WRITE``, ``PROT_EXEC`` bits, e.g. if ``PROT_WRITE`` is not set in +mprotect(), it means that the region is not writable. + +Setting ``PROT_SEAL`` implies setting ``MAP_SEALABLE`` below. + +**flags** + +The ``MAP_SEALABLE`` bit in the ``flags`` field of mmap(). + +When present, it marks the map as sealable. A map created +without ``MAP_SEALABLE`` will not support sealing. In other words, +mseal() will fail for such a map. + + +Applications that don't care about sealing will expect their +behavior unchanged. For those that need sealing support, opt in +by adding ``MAP_SEALABLE`` in mmap(). + +Note: for a map created without ``MAP_SEALABLE`` or a map created +with ``MAP_SEALABLE`` but not sealed yet, mmap(MAP_FIXED) can +change the sealable or sealing bit. + +Use Case: +========= +- glibc: + The dynamic linker, during loading ELF executables, can apply sealing to + non-writable memory segments. + +- Chrome browser: protect some security sensitive data-structures. + +Additional notes: +================= +As Jann Horn pointed out in [3], there are still a few ways to write +to RO memory, which is, in a way, by design. Those cases are not covered +by mseal(). If applications want to block such cases, sandbox tools (such as +seccomp, LSM, etc) might be considered. + +Those cases are: + +- Write to read-only memory through /proc/self/mem interface. +- Write to read-only memory through ptrace (such as PTRACE_POKETEXT). +- userfaultfd. + +The idea that inspired this patch comes from Stephen Röttger’s work in V8 +CFI [4]. Chrome browser in ChromeOS will be the first user of this API. + +Reference: +========== +[1] https://github.com/apple-oss-distributions/xnu/blob/1031c584a5e37aff177559b9f69dbd3c8c3fd30a/osfmk/mach/vm_statistics.h#L274 + +[2] https://man.openbsd.org/mimmutable.2 + +[3] https://lore.kernel.org/lkml/CAG48ez3ShUYey+ZAFsU2i1RpQn0a5eOs2hzQ426FkcgnfUGLvA@mail.gmail.com + +[4] https://docs.google.com/document/d/1O2jwK4dxI3nRcOJuPYkonhTkNQfbmwdvxQMyXgeaRHo/edit#heading=h.bvaojj9fu6hc