From mboxrd@z Thu Jan 1 00:00:00 1970 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]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 2D29ED339BA for ; Fri, 5 Dec 2025 18:42:59 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 9FD716B009E; Fri, 5 Dec 2025 13:42:08 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 95F526B00A1; Fri, 5 Dec 2025 13:42:08 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 7D6616B00A0; Fri, 5 Dec 2025 13:42:08 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0015.hostedemail.com [216.40.44.15]) by kanga.kvack.org (Postfix) with ESMTP id 64CED6B00A0 for ; Fri, 5 Dec 2025 13:42:08 -0500 (EST) Received: from smtpin16.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay10.hostedemail.com (Postfix) with ESMTP id 227E7C02E2 for ; Fri, 5 Dec 2025 18:42:08 +0000 (UTC) X-FDA: 84186287136.16.627BA38 Received: from sea.source.kernel.org (sea.source.kernel.org [172.234.252.31]) by imf17.hostedemail.com (Postfix) with ESMTP id 186644000B for ; Fri, 5 Dec 2025 18:42:05 +0000 (UTC) Authentication-Results: imf17.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b="H/HOTaOf"; dmarc=pass (policy=quarantine) header.from=kernel.org; spf=pass (imf17.hostedemail.com: domain of devnull+debug.rivosinc.com@kernel.org designates 172.234.252.31 as permitted sender) smtp.mailfrom=devnull+debug.rivosinc.com@kernel.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1764960126; h=from:from:sender:reply-to: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=UUyu0Bsvs+ejfvbMVuIeKEoFBGMTpbE4PscppAJYZ/A=; b=x25Dv6T3IVYmvuWrz4IxvFMDQKLzHfz3lSbB8E120jezM0WbL5PJC4ADKxazVuo8dme+2F 7PTAnQIQ7zqX9aoUdauyEW9gG6KS8sNwubY9IBaaOy7s7WJXczxRuLv1vuxbrsEF5E6kBt tqSrkxd5DD21rfZWd3KcfC8QUdy/hkg= ARC-Authentication-Results: i=1; imf17.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b="H/HOTaOf"; dmarc=pass (policy=quarantine) header.from=kernel.org; spf=pass (imf17.hostedemail.com: domain of devnull+debug.rivosinc.com@kernel.org designates 172.234.252.31 as permitted sender) smtp.mailfrom=devnull+debug.rivosinc.com@kernel.org ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1764960126; a=rsa-sha256; cv=none; b=daVuCyFLk95qdHOAauVECgw8CDIuqCWm7jHsYEDUdXUly4Ta1ylBqzOvxMquQjG8RyHkqH 6gD5hl5Lz3H8s91s/RYexZHhVOMoImUa9ZoIySfYWjX/BjnxX8dtm7MrekqrTeCnRnZZxi 8yPVqTGoZVjnF3Dq4gh6G1iVgUoRv7k= Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by sea.source.kernel.org (Postfix) with ESMTP id CF1554467B; Fri, 5 Dec 2025 18:41:52 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPS id 9CA9AC4AF17; Fri, 5 Dec 2025 18:41:52 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1764960112; bh=SRDdTPo45Eh4KAhtLdSMyTcxO3kIazO1CNVPlhVQPIY=; h=From:Date:Subject:References:In-Reply-To:To:Cc:Reply-To:From; b=H/HOTaOf65roPsnbRxWHfXbaMj3BCHBfSkEAI7tzCuRtNDi6vGK4csWHJIgYitkbh zJovxb7jbc4DjFeH38GNyZMRuP5YMW9HeV13vTqsxYyHmF4/Rd+l9dnWtfCl50k1za ovGXyadb7G/V5JRhEkc2DCnpRX2xvTfExr1rXghAI1ZOFkzLMXHxJfMHRWB4JLJzc+ 18+cmowLtRxpkrYf1NQ8U0v1ySfM6JSvWyu3yZA3zr0evK8DUE44wjGLfjlTQZ9be4 I6pjfZzLJRxLkvNwUMWxI22S+161++C7jVFkq/3+uQCLCQymoJ8VDuZOnAu96op2+M QX5+yCP9qNeVw== Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 8BDBBD339AE; Fri, 5 Dec 2025 18:41:52 +0000 (UTC) From: Deepak Gupta via B4 Relay Date: Fri, 05 Dec 2025 10:42:05 -0800 Subject: [PATCH v25 27/28] riscv: Documentation for shadow stack on riscv MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Message-Id: <20251205-v5_user_cfi_series-v25-27-1a07c0127361@rivosinc.com> References: <20251205-v5_user_cfi_series-v25-0-1a07c0127361@rivosinc.com> In-Reply-To: <20251205-v5_user_cfi_series-v25-0-1a07c0127361@rivosinc.com> To: Thomas Gleixner , Ingo Molnar , Borislav Petkov , Dave Hansen , x86@kernel.org, "H. Peter Anvin" , Andrew Morton , "Liam R. Howlett" , Vlastimil Babka , Lorenzo Stoakes , Paul Walmsley , Palmer Dabbelt , Albert Ou , Conor Dooley , Rob Herring , Krzysztof Kozlowski , Arnd Bergmann , Christian Brauner , Peter Zijlstra , Oleg Nesterov , Eric Biederman , Kees Cook , Jonathan Corbet , Shuah Khan , Jann Horn , Conor Dooley , Miguel Ojeda , Alex Gaynor , Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Andreas Hindborg , Alice Ryhl , Trevor Gross , Benno Lossin Cc: linux-kernel@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-mm@kvack.org, linux-riscv@lists.infradead.org, devicetree@vger.kernel.org, linux-arch@vger.kernel.org, linux-doc@vger.kernel.org, linux-kselftest@vger.kernel.org, alistair.francis@wdc.com, richard.henderson@linaro.org, jim.shu@sifive.com, andybnac@gmail.com, kito.cheng@sifive.com, charlie@rivosinc.com, atishp@rivosinc.com, evan@rivosinc.com, cleger@rivosinc.com, alexghiti@rivosinc.com, samitolvanen@google.com, broonie@kernel.org, rick.p.edgecombe@intel.com, rust-for-linux@vger.kernel.org, Zong Li , Valentin Haudiquet , Deepak Gupta X-Mailer: b4 0.13.0 X-Developer-Signature: v=1; a=ed25519-sha256; t=1764960107; l=9746; i=debug@rivosinc.com; s=20251023; h=from:subject:message-id; bh=dl8IGrDyRpX9wV0qapA7pYJaY0jITlk53J3uwRpcyyU=; b=Z4w9/1uuGmE54oIUkFnlU/D5XCpALtfk+0AP1SGiazruURMep2cobb2/7BtEMO9JgSOvRUqbx tpqsZVtnQEbCoikXt4cc+w96OI8vxpmFlRWNRTUUkbqJYQ68I5BVZB+ X-Developer-Key: i=debug@rivosinc.com; a=ed25519; pk=O37GQv1thBhZToXyQKdecPDhtWVbEDRQ0RIndijvpjk= X-Endpoint-Received: by B4 Relay for debug@rivosinc.com/20251023 with auth_id=553 X-Original-From: Deepak Gupta Reply-To: debug@rivosinc.com X-Rspam-User: X-Stat-Signature: z19afa5bgcs19gx3g7r7tbetkac1rho4 X-Rspamd-Queue-Id: 186644000B X-Rspamd-Server: rspam06 X-HE-Tag: 1764960125-895450 X-HE-Meta: U2FsdGVkX1+/vTD7ieAkVc4DHtz0EIxb7VKrUVWJAwIITBZgHnpd+2l6W/tOzoD7mYie7IVkj1KcdENKIYGc9g5CmzC7lLGqKQKWKL43VT9eYcwYgxN5ppFWqIh9Fp92m2EHGE0YbhBZ+Ls3K8ZrYdoYTIOn8dyrFz02MCjO354lUo8dqHf2yjs0lIOUvIXJTqHdZChtEIxebZRnfYvW59oFJQZfpcJusOkggoB8ihcSneXR5ZdiVsH5W8bcyRbii3nc3RYeON1MQwKhc2k3VrkctVS8dOdS05MeLh+6Um3ovSv9Z7WhUD7PGSMH78AH1JndA2eTZQOMu6/AUqwHpsx4WWJh1GTf1UXrVnP11HPlBFf4c2oim/xX9lIX8Ii8Ku1BUkcZT/TAj2ivYGpdyUnPWTNt5gt+dgT70LJLd47i5H1sw06k/lokadluzQ4h7+ymWRV10vf1U6M6KNl1hh8Dl3+zDWLW4tAaTSuZEybMxzQ+h3iocax30jboolT9K4RMAc+5R2Ng6DSw2uGIPfqAi4goEI6y+3BySRVEPqnnIjzkNFfZIfX4RPySXrl6goS7k9Ljh1MB9qBkN63FWXzDid4ceYFrdx2fO/E5NKR51a/HaGF9jBVWHRXT1FcMYApVh9VZTZBoB9YOrulIs0bFu4JNJwYJF46/PslA7Bi4ejy9Mo5zGeT7ICOAeHuTsWidvAXh9lXhAYq3bnPtenZfnxtBHctrYmpjD7oe/0CX6dfDNu7yUPtJ4rvIdhc229TSc3LXUANFKWD02KWzbD2spjs52Su7zzdpjqMRrftT8zmSVc7fnXzLrlpXD47qibam4KEaeAd/gMxDd2zuFaxBIjojd8Z6bZV0LOxJ1NdbQNRm6q+RP/16V6Q1ez7R7XqpUi1NcPaJZtXZnBUennCqBbFWU1vrydF4H5GKQuNGdENVLUBViBlmarnNCiep+UrODvkowyYE3Vr+9CT wkVPpbDB wk3I8zA73HdbqLqtqeghw4bdoD6+ysT69zxpPMTnnyhPYMuqFIXnRLWIaH/d3VEp3E+wyTyIiL90cr0MbyWEL3kF63qVtiYluv88bVAMoFkw2TbZul+3FXGlHFu1Ejr2Owdje3Wjb6JRMsEO+LRrcBsUtHujNP3iKgXtsKmP2a34PoyLNtguw1E5fww6icH/Q5Ks4wmIg54pRszd9kbJgMvAlQALTCRf/1Ib0HVLsY9jrtT1QD6OiTDxcfYd6//FEzfvVdQ/ekigh5hWotvQ5jAJzRPJKs8JsOpWt6RQy+D7nr3MFcU9CAbbapGlMD2ti/hrdzkKBACrOaS203+cCTJTs+YhVAMPcreIEc06JVvfggZzH8Dv9rRc2MIy8xck9qEvt0M/6V6asqyL9XTrJJ/zjOqvsOwhMFKzVAkWiNHfNSTgqwRgk1F+YUHpPf8Eb6++PzfbfKXpOqy7o15Ck9Njn7fKbTiDi++normnSBKm0V0EmLVGtCBB1db9Hj0uIrYOt5y8mon0SCUJtbMid0gB4Q0EtvzEizL9Ah0PMzqQHeL8mxkaZexSBU0P/UWu1DA+Ts0zHLcLeZwlzx1E80KWJqklrYnxfLpBU 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: Deepak Gupta Adding documentation on shadow stack for user mode on riscv and kernel interfaces exposed so that user tasks can enable it. Reviewed-by: Zong Li Tested-by: Valentin Haudiquet Signed-off-by: Deepak Gupta --- Documentation/arch/riscv/index.rst | 1 + Documentation/arch/riscv/zicfiss.rst | 179 +++++++++++++++++++++++++++++++++++ 2 files changed, 180 insertions(+) diff --git a/Documentation/arch/riscv/index.rst b/Documentation/arch/riscv/index.rst index be7237b69682..e240eb0ceb70 100644 --- a/Documentation/arch/riscv/index.rst +++ b/Documentation/arch/riscv/index.rst @@ -15,6 +15,7 @@ RISC-V architecture vector cmodx zicfilp + zicfiss features diff --git a/Documentation/arch/riscv/zicfiss.rst b/Documentation/arch/riscv/zicfiss.rst new file mode 100644 index 000000000000..7fb86d5ba120 --- /dev/null +++ b/Documentation/arch/riscv/zicfiss.rst @@ -0,0 +1,179 @@ +.. SPDX-License-Identifier: GPL-2.0 + +:Author: Deepak Gupta +:Date: 12 January 2024 + +========================================================= +Shadow stack to protect function returns on RISC-V Linux +========================================================= + +This document briefly describes the interface provided to userspace by Linux +to enable shadow stack for user mode applications on RISC-V + +1. Feature Overview +-------------------- + +Memory corruption issues usually result into crashes, however when in hands of +an adversary and if used creatively can result into a variety security issues. + +One of those security issues can be code re-use attacks on program where +adversary can use corrupt return addresses present on stack and chain them +together to perform return oriented programming (ROP) and thus compromising +control flow integrity (CFI) of the program. + +Return addresses live on stack and thus in read-write memory and thus are +susceptible to corruption and which allows an adversary to reach any program +counter (PC) in address space. On RISC-V ``zicfiss`` extension provides an +alternate stack termed as shadow stack on which return addresses can be safely +placed in prolog of the function and retrieved in epilog. ``zicfiss`` extension +makes following changes: + +- PTE encodings for shadow stack virtual memory + An earlier reserved encoding in first stage translation i.e. + PTE.R=0, PTE.W=1, PTE.X=0 becomes PTE encoding for shadow stack pages. + +- ``sspush x1/x5`` instruction pushes (stores) ``x1/x5`` to shadow stack. + +- ``sspopchk x1/x5`` instruction pops (loads) from shadow stack and compares + with ``x1/x5`` and if un-equal, CPU raises ``software check exception`` with + ``*tval = 3`` + +Compiler toolchain makes sure that function prologue have ``sspush x1/x5`` to +save return address on shadow stack in addition to regular stack. Similarly +function epilogs have ``ld x5, offset(x2)`` followed by ``sspopchk x5`` to +ensure that popped value from regular stack matches with popped value from +shadow stack. + +2. Shadow stack protections and linux memory manager +----------------------------------------------------- + +As mentioned earlier, shadow stacks get new page table encodings and thus have +some special properties assigned to them and instructions that operate on them +as below: + +- Regular stores to shadow stack memory raises access store faults. This way + shadow stack memory is protected from stray inadvertent writes. + +- Regular loads to shadow stack memory are allowed. This allows stack trace + utilities or backtrace functions to read true callstack (not tampered). + +- Only shadow stack instructions can generate shadow stack load or shadow stack + store. + +- Shadow stack load / shadow stack store on read-only memory raises AMO/store + page fault. Thus both ``sspush x1/x5`` and ``sspopchk x1/x5`` will raise AMO/ + store page fault. This simplies COW handling in kernel during fork, kernel + can convert shadow stack pages into read-only memory (as it does for regular + read-write memory) and as soon as subsequent ``sspush`` or ``sspopchk`` in + userspace is encountered, then kernel can perform COW. + +- Shadow stack load / shadow stack store on read-write, read-write-execute + memory raises an access fault. This is a fatal condition because shadow stack + should never be operating on read-write, read-write-execute memory. + +3. ELF and psABI +----------------- + +Toolchain sets up :c:macro:`GNU_PROPERTY_RISCV_FEATURE_1_BCFI` for property +:c:macro:`GNU_PROPERTY_RISCV_FEATURE_1_AND` in notes section of the object file. + +4. Linux enabling +------------------ + +User space programs can have multiple shared objects loaded in its address space +and it's a difficult task to make sure all the dependencies have been compiled +with support of shadow stack. Thus it's left to dynamic loader to enable +shadow stack for the program. + +5. prctl() enabling +-------------------- + +:c:macro:`PR_SET_SHADOW_STACK_STATUS` / :c:macro:`PR_GET_SHADOW_STACK_STATUS` / +:c:macro:`PR_LOCK_SHADOW_STACK_STATUS` are three prctls added to manage shadow +stack enabling for tasks. prctls are arch agnostic and returns -EINVAL on other +arches. + +* prctl(PR_SET_SHADOW_STACK_STATUS, unsigned long arg) + +If arg1 :c:macro:`PR_SHADOW_STACK_ENABLE` and if CPU supports ``zicfiss`` then +kernel will enable shadow stack for the task. Dynamic loader can issue this +:c:macro:`prctl` once it has determined that all the objects loaded in address +space have support for shadow stack. Additionally if there is a +:c:macro:`dlopen` to an object which wasn't compiled with ``zicfiss``, dynamic +loader can issue this prctl with arg1 set to 0 (i.e. +:c:macro:`PR_SHADOW_STACK_ENABLE` being clear) + +* prctl(PR_GET_SHADOW_STACK_STATUS, unsigned long * arg) + +Returns current status of indirect branch tracking. If enabled it'll return +:c:macro:`PR_SHADOW_STACK_ENABLE`. + +* prctl(PR_LOCK_SHADOW_STACK_STATUS, unsigned long arg) + +Locks current status of shadow stack enabling on the task. User space may want +to run with strict security posture and wouldn't want loading of objects +without ``zicfiss`` support in it and thus would want to disallow disabling of +shadow stack on current task. In that case user space can use this prctl to +lock current settings. + +5. violations related to returns with shadow stack enabled +----------------------------------------------------------- + +Pertaining to shadow stack, CPU raises software check exception in following +condition: + +- On execution of ``sspopchk x1/x5``, ``x1/x5`` didn't match top of shadow + stack. If mismatch happens then cpu does ``*tval = 3`` and raise software + check exception. + +Linux kernel will treat this as :c:macro:`SIGSEGV` with code = +:c:macro:`SEGV_CPERR` and follow normal course of signal delivery. + +6. Shadow stack tokens +----------------------- +Regular stores on shadow stacks are not allowed and thus can't be tampered +with via arbitrary stray writes due to bugs. However method of pivoting / +switching to shadow stack is simply writing to csr ``CSR_SSP`` and that will +change active shadow stack for the program. Instances of writes to ``CSR_SSP`` +in the address space of the program should be mostly limited to context +switching, stack unwind, longjmp or similar mechanisms (like context switching +of green threads) in languages like go, rust. This can be problematic because +an attacker can use memory corruption bugs and eventually use such context +switching routines to pivot to any shadow stack. Shadow stack tokens can help +mitigate this problem by making sure that: + +- When software is switching away from a shadow stack, shadow stack pointer + should be saved on shadow stack itself and call it ``shadow stack token`` + +- When software is switching to a shadow stack, it should read the + ``shadow stack token`` from shadow stack pointer and verify that + ``shadow stack token`` itself is pointer to shadow stack itself. + +- Once the token verification is done, software can perform the write to + ``CSR_SSP`` to switch shadow stack. + +Here software can be user mode task runtime itself which is managing various +contexts as part of single thread. Software can be kernel as well when kernel +has to deliver a signal to user task and must save shadow stack pointer. Kernel +can perform similar procedure by saving a token on user shadow stack itself. +This way whenever :c:macro:`sigreturn` happens, kernel can read the token and +verify the token and then switch to shadow stack. Using this mechanism, kernel +helps user task so that any corruption issue in user task is not exploited by +adversary by arbitrarily using :c:macro:`sigreturn`. Adversary will have to +make sure that there is a ``shadow stack token`` in addition to invoking +:c:macro:`sigreturn` + +7. Signal shadow stack +----------------------- +Following structure has been added to sigcontext for RISC-V:: + + struct __sc_riscv_cfi_state { + unsigned long ss_ptr; + }; + +As part of signal delivery, shadow stack token is saved on current shadow stack +itself and updated pointer is saved away in :c:macro:`ss_ptr` field in +:c:macro:`__sc_riscv_cfi_state` under :c:macro:`sigcontext`. Existing shadow +stack allocation is used for signal delivery. During :c:macro:`sigreturn`, +kernel will obtain :c:macro:`ss_ptr` from :c:macro:`sigcontext` and verify the +saved token on shadow stack itself and switch shadow stack. -- 2.43.0