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 6F15AC369DC for ; Wed, 30 Apr 2025 00:25:25 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 6D24A6B00B4; Tue, 29 Apr 2025 20:25:07 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 657E26B00B5; Tue, 29 Apr 2025 20:25:07 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 411D06B00B6; Tue, 29 Apr 2025 20:25:07 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0010.hostedemail.com [216.40.44.10]) by kanga.kvack.org (Postfix) with ESMTP id 0A3E96B00B4 for ; Tue, 29 Apr 2025 20:25:07 -0400 (EDT) Received: from smtpin04.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay02.hostedemail.com (Postfix) with ESMTP id B49A412147A for ; Wed, 30 Apr 2025 00:17:48 +0000 (UTC) X-FDA: 83388797016.04.0C558E7 Received: from mail-pl1-f172.google.com (mail-pl1-f172.google.com [209.85.214.172]) by imf24.hostedemail.com (Postfix) with ESMTP id D1A22180013 for ; Wed, 30 Apr 2025 00:17:46 +0000 (UTC) Authentication-Results: imf24.hostedemail.com; dkim=pass header.d=rivosinc-com.20230601.gappssmtp.com header.s=20230601 header.b=uwV2BHun; dmarc=none; spf=pass (imf24.hostedemail.com: domain of debug@rivosinc.com designates 209.85.214.172 as permitted sender) smtp.mailfrom=debug@rivosinc.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1745972266; a=rsa-sha256; cv=none; b=SK0KyAxDXatGXPtA1zBIlAlRJpLTCrHmz1O4WV3WwD2M/JfvDveRvNcYWmIiBhrJm8j/3i m+tXYTD0UAMsyXmcJ2WsQKcVmXUpX12eR5SB3ueUoXX2av/TXSRrt1DBp5su+p7b1ylmjV i9A4Dh/Q8R/JIEScQkXixvtdEbkGZIc= ARC-Authentication-Results: i=1; imf24.hostedemail.com; dkim=pass header.d=rivosinc-com.20230601.gappssmtp.com header.s=20230601 header.b=uwV2BHun; dmarc=none; spf=pass (imf24.hostedemail.com: domain of debug@rivosinc.com designates 209.85.214.172 as permitted sender) smtp.mailfrom=debug@rivosinc.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1745972266; 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=04baGaWIOcpAM10BsvDKc2YnzV44Y+9Sv7IQZJnFcq0=; b=6o0uPh049NFBHpGZl6OrYnahebV8wuj6YbmK2GrwYx2h3DzGMc94Ze5/QC6j2cdL4sffen T4O7IEDyKfrbonviCOBwPdVtxc7JSfVJK1MPHjPFCLy06g60XrQyTW1fxrMJgaz+YkZOZB I1cyENpUb/b77fpuMHJlE3orZHyUECg= Received: by mail-pl1-f172.google.com with SMTP id d9443c01a7336-227a8cdd241so91221635ad.3 for ; Tue, 29 Apr 2025 17:17:46 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=rivosinc-com.20230601.gappssmtp.com; s=20230601; t=1745972266; x=1746577066; 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=04baGaWIOcpAM10BsvDKc2YnzV44Y+9Sv7IQZJnFcq0=; b=uwV2BHunTsWnisCFNPc8sqt/pUTjJg9+PqwibFENbFnEmU3Eo7+9HcMSERNKxBerlV 4BsEWohu6i33uFS6hsbhxPViREU2+ng8L65BD4dgNaou120oVT8imFP7M6tBRWxosdh2 1HGvLDT1G8IObz4kaks+w1Czu5ijSYi/OTCFYKHJWTnrDZCubxxTwpTyeuTgv11dEgur 4SqJQkZaArGxQaNXE343SflkZbsJUmukL4U4OAvV5UCkoIGqZ+an1Q+0+vAIixTVnCBb Cj6//P2wOoZFKB0AhNO8GzguYeGpTkw3BIBjE2vlt/IP+xkqEpJMhSP1vZ6T5l6+WfjG r+lQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1745972266; x=1746577066; 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=04baGaWIOcpAM10BsvDKc2YnzV44Y+9Sv7IQZJnFcq0=; b=k5VjSsYE6w/ytQN89U5IJWvxtmvM+kWCP5Np8qOw1fGX+8CC30YQ7d8NAylpo/ZweI wGtK6Qoa4kNdSbHJSQmMpbA7CLIVrkOY83Nac1FPewi2rLa+SW5PkJirmUjM7OMbzezg ffpohlCdcHvJHUwW6W+ACo/3F/TXkl/YIIoNUlAlMra3Xpb2PsORATRgBs0qc0fV8TNK q8UgN07FJCf0hdSBrDc37WaPYZeksqnEtWAeDDfM5/luwC9yviMImHEpr3wmUwHThg9T UM1YIfbFiF2l3LZ+mmGG3sp745mlnMdpQZRKerzO2DtjkTZ51cIYcyPA/G5S3j3QQi2G SPhA== X-Forwarded-Encrypted: i=1; AJvYcCVlwBh2kIxQ+LShLVIqyr4UzRNrpr0kUDqqjCiuOlM/tNPLI6Qu9dBeWE26PxqlCfCWtrCI5Lxcgw==@kvack.org X-Gm-Message-State: AOJu0Yy7TKFwki4HZbMYRFmDG9NxIBADsfmXzNEbKdPvMB8nnriZh//l Klmng6I5CgYwR6J3A0FQQRI1ukJXPEkQtu5XWYRTau2VYzpGL1niZLc2hrlngaw= X-Gm-Gg: ASbGncukmVXs3adEKRExWAhad/W//Jcpxw+L1helrGWH8x9t1uWyaJ46Y4yS2GLudVC W2Ol9NmGsc7InWaxHOjeR8b6G7MTQ8q0daaRJ14Sg0bvKih2kw25iaGQ0CyibayAi1iAZ3WTpdO LtNdfIzMvbjiZq+dg1BJoV8XGLbB2AbuS78c/Uyj5X5J0TaDJCnYLDQ5WQNKebpNiLvyhw3BrWa s0RW/YGWeykWaOokOa0SF86ae1/hOCqHRv4yu6sUnYgt/ZO/CsEBmNBKGCQa/6j5VwHSnUUS5t8 WaSpQtGY8GLL7V79LHjZpFnUq7p4jMj8FioU8gahStXfmeUxWC8= X-Google-Smtp-Source: AGHT+IElsYHuL6uNpuF98grZ32cMaP4x/B+n9NaNOM+GYOmHv0lBJAPxppghFLiR02kYnVeXaWC46g== X-Received: by 2002:a17:902:e80d:b0:224:76f:9e44 with SMTP id d9443c01a7336-22df34b848cmr16103735ad.8.1745972265738; Tue, 29 Apr 2025 17:17:45 -0700 (PDT) Received: from debug.ba.rivosinc.com ([64.71.180.162]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-22db4d770d6sm109386035ad.17.2025.04.29.17.17.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 29 Apr 2025 17:17:45 -0700 (PDT) From: Deepak Gupta Date: Tue, 29 Apr 2025 17:16:42 -0700 Subject: [PATCH v14 25/27] riscv: Documentation for landing pad / indirect branch tracking MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Message-Id: <20250429-v5_user_cfi_series-v14-25-5239410d012a@rivosinc.com> References: <20250429-v5_user_cfi_series-v14-0-5239410d012a@rivosinc.com> In-Reply-To: <20250429-v5_user_cfi_series-v14-0-5239410d012a@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-Queue-Id: D1A22180013 X-Rspam-User: X-Rspamd-Server: rspam07 X-Stat-Signature: kjt66gjbqa16dsab8g6drbz4y5fcpibe X-HE-Tag: 1745972266-18394 X-HE-Meta: U2FsdGVkX18IvJdbXaNcVVqkF4fhdUj5tIDwv8hsbAinBjGF5o17Mxn2pwUd3LoGySDqFbA7J2ZTFnPupHm1lz8khzdJikoyj3BlYKOYgHBAa/s2Jsn2xrFo1qukCx7PuoqVwosiW405cfOSYtuiaeyGdW+NT/KSbFyx2jRXcmWeREWJQGIgewZV5MmWkMYA86DZZZmr71LN4VJ27OXo6qdTJNC9dVtEP1Pd0nb6lD45W1UcNMnwBJTYc+v0kpOfWfB4+YZsegFOm6CMFrUdVk0vP5Un8/5IXP4xkpewzFK/wolKuBcXh3HMlGrZUc/EzmUBjNvX7P4IM1CorMkoBr168iUj0ITXLe1nB/OQzgI5srDDQGU9bEB4vJQY3fjnppc6StK5nOPatlNg6TAZbQNiuzBWfl4O2cDJVd7FivIBAmFGjBw7L/dyK+mYP3hFfC2EMb06tRgDQvsipTCVEjqLQ4Ik2Vvbr926z7+idVqo1CfqcjZC78mgrBLAvg+Ow0qH3hc3EARkevoe68oeqd3pTtOF25c08+MuAEumoiqriI9DqpC74s6uvqjO2Zv8liR6wFi/orl5nY40DPAqWtmIbJFiM5EtUKUNEiUt8DgngWIUCvE2odoNaiPaHB9iboPM5KHsw/Ac8R23eYgeti8HjvFZWSC0CGFjJ8UdTa6HzSEDsoFABlalXyCmyPvMhA+1D6YQ1NUuoOnyHDNqM86+7CrCHB3d+41MXHYYNpQjzO/TrHodhNJLrspfJJnE0Pr8GLAong2Hs+7KI9qWUKtsTEW88ITV3GCAq8BNE3rJ+Gc3YYwrmXWQgMdKO81tl8HZE2Gz3GExdtyCX9BcrJttwrcxCZkeVf88Hw+XrYBDtb50XbHX0d0qLvUDcs/Vp2dP+CgDpAsWnKfn8xFU75CvB+s7k0TilABNb6mDsBtL9i8OsaG2ipz4b6dfkdpyqrpfQB1VEQxBBx7eiIU SZLVM8db MDYnsdoid+MsoqTp8CGLpZpS18dkfutWAtBS/F+VhEPnswlJcySbWTOkbPp2wEvPGj9xWxhhypXe2brhR7GEjY/nvacWda5CbNBaJvU9h/YNmclKNjjL+Jwv97BzW970qTTRErqulSG0dFJ6eqbyLL7SVRBkxfnKi9V1jTzEqCniwUpfGtSuWGmDQBSN1pvdBJ9UFWiqdSmdfRBZvTpgNlP8NX2CrJ+5bwBE5WidtqEtVQCNrUI5Gfge6QB6y2wBx0qwKIPp/La/ZAXl0ZkKtZyLc5RWrBcoHrLHIA1L1Jl2SN4YEzuFTTuMvUS7aKfbS/oW5T4WaJsG5EGul96pj1fqGz2/JrEYK9ZcDXnGcwy2CXuNq/2Kd+AWWljw+VLa+gWI8g2Qax3YQhbmJJIoK8ZExBLYZY0qO3S4fhd/2t3huOq2TwvHJge5N/hv4vsEPSZ/gpyX+AoRyWXCPep2vKky8+fzMaKOIsPIAYUvcmYjxPaNfG9BXIYcaweKNZPEyGJIy6E5XofbBz04= 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 landing pad aka indirect branch tracking 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/zicfilp.rst | 115 +++++++++++++++++++++++++++++++++++ 2 files changed, 116 insertions(+) diff --git a/Documentation/arch/riscv/index.rst b/Documentation/arch/riscv/index.rst index eecf347ce849..be7237b69682 100644 --- a/Documentation/arch/riscv/index.rst +++ b/Documentation/arch/riscv/index.rst @@ -14,6 +14,7 @@ RISC-V architecture uabi vector cmodx + zicfilp features diff --git a/Documentation/arch/riscv/zicfilp.rst b/Documentation/arch/riscv/zicfilp.rst new file mode 100644 index 000000000000..dcf43de73a06 --- /dev/null +++ b/Documentation/arch/riscv/zicfilp.rst @@ -0,0 +1,115 @@ +.. SPDX-License-Identifier: GPL-2.0 + +:Author: Deepak Gupta +:Date: 12 January 2024 + +==================================================== +Tracking indirect control transfers on RISC-V Linux +==================================================== + +This document briefly describes the interface provided to userspace by Linux +to enable indirect branch tracking 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 function pointers and chain them together to perform jump oriented +programming (JOP) or call oriented programming (COP) and thus compromising control +flow integrity (CFI) of the program. + +Function pointers live in read-write memory and thus are susceptible to corruption +and allows an adversary to reach any program counter (PC) in address space. On +RISC-V zicfilp extension enforces a restriction on such indirect control +transfers: + +- indirect control transfers must land on a landing pad instruction ``lpad``. + There are two exception to this rule: + + - rs1 = x1 or rs1 = x5, i.e. a return from a function and returns are + protected using shadow stack (see zicfiss.rst) + + - rs1 = x7. On RISC-V compiler usually does below to reach function + which is beyond the offset possible J-type instruction:: + + auipc x7, + jalr (x7) + + Such form of indirect control transfer are still immutable and don't rely + on memory and thus rs1=x7 is exempted from tracking and considered software + guarded jumps. + +``lpad`` instruction is pseudo of ``auipc rd, `` with ``rd=x0`` and +is a HINT nop. ``lpad`` instruction must be aligned on 4 byte boundary and +compares 20 bit immediate with x7. If ``imm_20bit`` == 0, CPU doesn't perform +any comparision with ``x7``. If ``imm_20bit`` != 0, then ``imm_20bit`` must +match ``x7`` else CPU will raise ``software check exception`` (``cause=18``) +with ``*tval = 2``. + +Compiler can generate a hash over function signatures and setup them (truncated +to 20bit) in x7 at callsites and function prologues can have ``lpad`` with same +function hash. This further reduces number of program counters a call site can +reach. + +2. ELF and psABI +----------------- + +Toolchain sets up :c:macro:`GNU_PROPERTY_RISCV_FEATURE_1_FCFI` for property +:c:macro:`GNU_PROPERTY_RISCV_FEATURE_1_AND` in notes section of the object file. + +3. 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 indirect branch. Thus it's left to dynamic loader to enable +indirect branch tracking for the program. + +4. prctl() enabling +-------------------- + +:c:macro:`PR_SET_INDIR_BR_LP_STATUS` / :c:macro:`PR_GET_INDIR_BR_LP_STATUS` / +:c:macro:`PR_LOCK_INDIR_BR_LP_STATUS` are three prctls added to manage indirect +branch tracking. prctls are arch agnostic and returns -EINVAL on other arches. + +* prctl(PR_SET_INDIR_BR_LP_STATUS, unsigned long arg) + +If arg1 is :c:macro:`PR_INDIR_BR_LP_ENABLE` and if CPU supports ``zicfilp`` +then kernel will enable indirect branch tracking for the task. Dynamic loader +can issue this :c:macro:`prctl` once it has determined that all the objects +loaded in address space support indirect branch tracking. Additionally if there +is a `dlopen` to an object which wasn't compiled with ``zicfilp``, dynamic +loader can issue this prctl with arg1 set to 0 (i.e. +:c:macro:`PR_INDIR_BR_LP_ENABLE` being clear) + +* prctl(PR_GET_INDIR_BR_LP_STATUS, unsigned long arg) + +Returns current status of indirect branch tracking. If enabled it'll return +:c:macro:`PR_INDIR_BR_LP_ENABLE` + +* prctl(PR_LOCK_INDIR_BR_LP_STATUS, unsigned long arg) + +Locks current status of indirect branch tracking on the task. User space may +want to run with strict security posture and wouldn't want loading of objects +without ``zicfilp`` support in it and thus would want to disallow disabling of +indirect branch tracking. In that case user space can use this prctl to lock +current settings. + +5. violations related to indirect branch tracking +-------------------------------------------------- + +Pertaining to indirect branch tracking, CPU raises software check exception in +following conditions: + +- missing ``lpad`` after indirect call / jmp +- ``lpad`` not on 4 byte boundary +- ``imm_20bit`` embedded in ``lpad`` instruction doesn't match with ``x7`` + +In all 3 cases, ``*tval = 2`` is captured and software check exception is +raised (``cause=18``) + +Linux kernel will treat this as :c:macro:`SIGSEV`` with code = +:c:macro:`SEGV_CPERR` and follow normal course of signal delivery. -- 2.43.0