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]) by smtp.lore.kernel.org (Postfix) with ESMTP id 854F3C3ABAC for ; Fri, 2 May 2025 23:32:08 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 42C766B00CD; Fri, 2 May 2025 19:32:01 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 3D8D16B00CE; Fri, 2 May 2025 19:32:01 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 22D936B00CF; Fri, 2 May 2025 19:32:01 -0400 (EDT) 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 F06E56B00CD for ; Fri, 2 May 2025 19:32:00 -0400 (EDT) Received: from smtpin23.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay07.hostedemail.com (Postfix) with ESMTP id EDF601607B4 for ; Fri, 2 May 2025 23:32:01 +0000 (UTC) X-FDA: 83399568042.23.C6CA362 Received: from mail-pl1-f177.google.com (mail-pl1-f177.google.com [209.85.214.177]) by imf04.hostedemail.com (Postfix) with ESMTP id 0969B40006 for ; Fri, 2 May 2025 23:31:59 +0000 (UTC) Authentication-Results: imf04.hostedemail.com; dkim=pass header.d=rivosinc-com.20230601.gappssmtp.com header.s=20230601 header.b=QS4IylHp; dmarc=none; spf=pass (imf04.hostedemail.com: domain of debug@rivosinc.com designates 209.85.214.177 as permitted sender) smtp.mailfrom=debug@rivosinc.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1746228720; a=rsa-sha256; cv=none; b=Gl3Tw2R+x21EER51WY4u3f0s1sbqvmuFWX4fF3UN6nuUG/egkHU1iZ1m73p6M5TT4eX6zq NYdkVx2R+xUQor6g0lNbRzAn3oOM7t0aOEP11HDdXt5cn4xx5NENtiB0ysK0LPbZIJGPgz UlDJ26PZiYM9/1DoSM+fVh1wupITZM8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1746228720; 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=VgTX5jh6pXjtEDHfXrNgVX78ota6UPFjSNVgqZFbeUU=; b=zYArK40UujCjgWeoi0uEIxaNAxpUiRGabEwErnTHy4I8zo77b1YVMTY5hvzGIkhT1tyQOD S7R3BWcALBNTCbnKDsKhIy2pDYqV35Xg+WMIrWOH/yGud71gWdVpoVac+zwiOzOCgzHM4t wDSQhcO0afksdh56UmncAR6YMVmeVmI= ARC-Authentication-Results: i=1; imf04.hostedemail.com; dkim=pass header.d=rivosinc-com.20230601.gappssmtp.com header.s=20230601 header.b=QS4IylHp; dmarc=none; spf=pass (imf04.hostedemail.com: domain of debug@rivosinc.com designates 209.85.214.177 as permitted sender) smtp.mailfrom=debug@rivosinc.com Received: by mail-pl1-f177.google.com with SMTP id d9443c01a7336-223fb0f619dso32027245ad.1 for ; Fri, 02 May 2025 16:31:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=rivosinc-com.20230601.gappssmtp.com; s=20230601; t=1746228719; x=1746833519; darn=kvack.org; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:from:to:cc:subject:date:message-id :reply-to; bh=VgTX5jh6pXjtEDHfXrNgVX78ota6UPFjSNVgqZFbeUU=; b=QS4IylHp2GDQG70WDA1hWlI3dl88ZMfW3BR87oNOQcUqaT+J/83A+705IzSLA3GPXg tGsVEie5BaMWdtcIUMvE4y1SaAT87VodUAlx1IeNItrK2DQZsjRjA0wPA0K1qNnBVkt9 AJ3nHpiykaBU4swnWt7JcRbbGXB9NSKv4pv958FzQ1WiLrIS/8gn3g0ia3uZiynV+/e7 NCY29+Fqg5H27dnOnLXHUjpqnMCg6ApirX0b3+GMSzCUIWnRt5xk4WClaEOu3GlASZUJ 8WmVAm4XnbB0g+Po687wR7+tvv2tPcDE4c0Odabi+Tkf2nv7swGA9y8OCJa2w+dbJ+rT JRbg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1746228719; x=1746833519; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=VgTX5jh6pXjtEDHfXrNgVX78ota6UPFjSNVgqZFbeUU=; b=qIDQk1HA/Yw0pUL5tlonjGQmPRBO8owp1oAJPSL6B8+O10G5U9//gM8hToN+rk9kM8 XpqDlISHdAlTskpG4ims7VU1/oAwXqF5lFLCIXp5I0H9fdNoGSce7CLN3eH1HQA1C5Xc y1OGjg/d4i3ImWXtOVcJj3qeWCyrSU2F1lsPbhpKlZBwbHt2w5ztdlTpGUP01MouMjh7 UJnTdcCSM0KaPn6zn1NxwYaw90UTmRxUJmf8/X9nDETsnhuImY0s8MRBpSTVrKcYFbpn Nr8zxhwqT3Ni/ON6lgzse6GnyTJiingx5+3u4wuGjl2mDCL0XZRwHqejkzMno01YiHqY 9n0g== X-Forwarded-Encrypted: i=1; AJvYcCXaMauNG7eqWdY0h6ahR6CqsWqyLPK7k+IjmmxcHAH1V7oqiYjLS3sKAQDgQ7cg/8zHpQXX4vTThg==@kvack.org X-Gm-Message-State: AOJu0YyMn/fZyRwdzXqxsWByxiaFFCXmSKNrAWYSsMV4lCiRIYtbzS5B 3s3DGxSaqfTHNzH59ImQ22M/unt0oB5Z+b6HDFArtCq33hO19IfGiC8qtMrVfdq1djg3kdPhIYf e X-Gm-Gg: ASbGncuBIGdDpzbDaqukf8CZbupnnqGew/Y+JSVB7Umkh9ns+BMj0AJYkBeMH6IXS5E IUJsLfoxeh69SY0s/7pXPy1Ps04p930iE5ts9QlhWVIgOZmjh7kc5oMP6HWh3/i9rYnzQ+/zc9z EnwCg5Th4wKK3bgqDYG4LGXAZPWY6GqKEKzfXAUN8KaObHPH6AHPwZ2vaYwpSVwVYK400I4uS5y rmLkXv4eh1tBXXE3BMXc5r7BVgHvvlBxvj7qI//Vy0oI49mYlfw8h4EzDhjDRMyBeVSd87NEM0y TlRgIzCpb303S8fWZHIgxBK8XXHc5WqODlx2gFO6sN7nD34VG64= X-Google-Smtp-Source: AGHT+IEgR89S/gYaOsv0ZH5pczElROtOq3JZHzHHnIzCduQ60W05rYrZmUXWMMpGBQfKDM5MvWPlvA== X-Received: by 2002:a17:902:dace:b0:22d:e575:9eb2 with SMTP id d9443c01a7336-22e10357051mr79092195ad.34.1746228718782; Fri, 02 May 2025 16:31:58 -0700 (PDT) Received: from debug.ba.rivosinc.com ([64.71.180.162]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-22e15228ff2sm13367055ad.180.2025.05.02.16.31.56 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 02 May 2025 16:31:58 -0700 (PDT) From: Deepak Gupta Date: Fri, 02 May 2025 16:30:57 -0700 Subject: [PATCH v15 26/27] riscv: Documentation for shadow stack on riscv MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Message-Id: <20250502-v5_user_cfi_series-v15-26-914966471885@rivosinc.com> References: <20250502-v5_user_cfi_series-v15-0-914966471885@rivosinc.com> In-Reply-To: <20250502-v5_user_cfi_series-v15-0-914966471885@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?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , Trevor Gross 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 , Deepak Gupta X-Mailer: b4 0.13.0 X-Rspamd-Server: rspam06 X-Rspamd-Queue-Id: 0969B40006 X-Stat-Signature: yifhhi9zihp14qkng6xwdhcymduisddq X-Rspam-User: X-HE-Tag: 1746228719-205599 X-HE-Meta: U2FsdGVkX1/vy+huMWwnot8IIiiDgK4ogWQzf745mK8E+RctHe+u9k0CMMcqLqgN/ETv6c9fS98GLU3iaeKj6/OT0q4/5yTbVl/Ryf43jkZ2W7nNMnwjoH5mUnQBT9+YHBn4+OklPGkNVRM7oQ9XVYug0yKnyot8XULzcxMdCQDAty8RFfC/Yet120E+SRuKXA+5DF0Wk8xFsupHM5N/JTb7090+pwlmhjTxypkO3W6wpR1pAUX/0YHlkN+bkToXpv4XcgIzjfbx0+iEHnXohPcuw+SbedBkigGSOkNjZtRNrf1pCa+pudbl1zcYuq/w7sW6r5Mtnko12tU0XtcAmDChAUueS7beAK/OkK504IeH6+PoKhNEYwRtCcJ4J73qKTayOC4YhJFP/68j5Z3mRgwZefqqzA7qswF65OhHYxbGM/0hPhLHWX7nMRQWQQuJLQZ+FvxUGcG7U3AgbIIJGDciBu3ynPXESH0avIJgPTIqJAsmP12WKiXrYLps7rI0IGT2VRE/whkU+y+2JMCKr3njyn8XQd/s7+31N+0VVGwRV9JAOd+B5DdK3JALFl1BooA+tzNXQp4VckjSjqDxv+0x/2Erqaaeu1oG/37aifOjoepm3rhUoseg9kGuBWt7/7GiSqS0BbK5TQu8Ec7yl2P8pARKHYj4GserM3jSkuyxPRK7fAP6PY9CaV+ig1jFYuk8YlPPVEIJQvPhm+QsQKbRFNPRRQEqseNNF9bLzAQfXEVPEmsW5m8BhrvBSXP7craPPdLaxn0UIFZEUtCO1OL3vxCjCFdog/Ojm6Ss70v5Y4clFdsjqpcNgDUE8Sd74nHVpyzLMfo+BA9qxmZTyA49TxEV41OE7ubIuMyn38THHAC3As+GKUl8yEwkzaVI5j9x/te9gTyqXijDoPezOT6OYpn9Q01qdCCpEdJDw76HW7u2n5cEgPn6sPZ1PW0H00YaeF7Fm6eQXpSMpHS gJTa9HBu wF5+9cz8CnfnzGOMvgeqRROGcIYlfZWZhQi4hyAX98dVO5fFu17KygcO4SDqno/ucVTL9rWJ1oXqQ7mwFdpquLIiczFbOpRYEwieYOobkjsZhyvPiNlpFpiy4mQf5Gd6e8HawX7B1dUxkQ8IC9Y2cTS2o4BOOY1H/gZOWb7EjQU/QuwhAdpESACsz2XgoCQVthyqah8+bUlfazPG+HIJgGbCeji45oELejFKWRocVMpQaLBxykZ9MrkQuKpJ4/BOH8ZdOjF1htUaCdx/FvuZLHdeprhnpua5zMRoeMhuq6MLhbiwqnhJP517oZvvrI6ONba2o4bwiBTeOpKjRxu/BCch0JVPuAmeDCr7gvO8lppPuB+iuU3qGSTumt4PUc+dZxJF/vw5u25wtG5rLVmorOTXSEoCuZN0f3A31nYGi531RqbljIxWDXlEG/FRUWGna6LVK/o6jvsqzU7Cv8gmTxOmVydpMCrfLkbk+c9+cugVTQWhgy0q5NCmYNdsrfac1nVKr5ZuFi5JtwZM= 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: 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 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..b50089e6a52b --- /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:`SIGSEV`` 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