From patchwork Mon Feb 10 20:26:58 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Deepak Gupta X-Patchwork-Id: 13968617 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 B9084C021A2 for ; Mon, 10 Feb 2025 20:27:48 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 4CCF0280028; Mon, 10 Feb 2025 15:27:48 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 453B9280029; Mon, 10 Feb 2025 15:27:48 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 27FDD280028; Mon, 10 Feb 2025 15:27:48 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0011.hostedemail.com [216.40.44.11]) by kanga.kvack.org (Postfix) with ESMTP id 0201528001E for ; Mon, 10 Feb 2025 15:27:47 -0500 (EST) Received: from smtpin22.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay09.hostedemail.com (Postfix) with ESMTP id 963AE80588 for ; Mon, 10 Feb 2025 20:27:47 +0000 (UTC) X-FDA: 83105170974.22.B148EF5 Received: from mail-pl1-f172.google.com (mail-pl1-f172.google.com [209.85.214.172]) by imf21.hostedemail.com (Postfix) with ESMTP id 973431C0009 for ; Mon, 10 Feb 2025 20:27:45 +0000 (UTC) Authentication-Results: imf21.hostedemail.com; dkim=pass header.d=rivosinc-com.20230601.gappssmtp.com header.s=20230601 header.b=a8bn8vtU; spf=pass (imf21.hostedemail.com: domain of debug@rivosinc.com designates 209.85.214.172 as permitted sender) smtp.mailfrom=debug@rivosinc.com; dmarc=none ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1739219265; a=rsa-sha256; cv=none; b=d6WktZ8bnlRYNLP92HJrEVgCr0jjZaN/s88SqqiEhV1q/1cE5KKjWegHU1i7CzHE9D8ZgW htNmKlVj3weoFIkgxFWt3Rl2CyRmlrpc9HPMflDnF5xygFQ23HcCBySa/3LM9YfOlmsb3l S0WYHeTsA4n1bVS8uWQwNFtTl8SHKy4= ARC-Authentication-Results: i=1; imf21.hostedemail.com; dkim=pass header.d=rivosinc-com.20230601.gappssmtp.com header.s=20230601 header.b=a8bn8vtU; spf=pass (imf21.hostedemail.com: domain of debug@rivosinc.com designates 209.85.214.172 as permitted sender) smtp.mailfrom=debug@rivosinc.com; dmarc=none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1739219265; 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=vh4CUvpz/fzJO7m3g4Lrx30VWLQNLgBESiJnDVTGIvg=; b=HrwTB5P9UvEKKDWd3tkdOo6rpbElll3fYPShvh7Cdz3EDYKS0XQqu3zO5e6ZENl44Afyls rstxBa2SdRgJZJYibVixrhGnAZd9zDRHvzW0Vb1Ont5JSvY3WntI7VemLz3WvcMOQLE6I5 HY8FYrk2Qt/h0So1ooO6GfpHHl6gNdo= Received: by mail-pl1-f172.google.com with SMTP id d9443c01a7336-21f55fbb72bso56910505ad.2 for ; Mon, 10 Feb 2025 12:27:45 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=rivosinc-com.20230601.gappssmtp.com; s=20230601; t=1739219264; x=1739824064; 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=vh4CUvpz/fzJO7m3g4Lrx30VWLQNLgBESiJnDVTGIvg=; b=a8bn8vtUBzYAJ/7fUHxiBzPN5Opebsjpx3IWH7vbaCiSVmy8AvyOgHuHft+LVnwPTE jOYWCuCsAa79lEpIxCY2f+SM3x5oTWvIrHRh6DhibIQmXe2AmdZJRKtEMNILMUCaam9r AS9kEmE3OXOmyz9qGUg2L6dsMuMPWcSTw2jzFobdKJJwNP40U8WV8cZrjUauZqiBY3IE /jTGf2RdXXBe785Yu96SB2URjokx0NX69ZI6kH1UCMybJ/iL/zc8ReK2ntJ2fGclLpQA YmziSdKUu213jMTe8U3wNKhcc+L5DkCB8uQ78uBpnEzZKGdXLzyLBBLHMf/+vc0fr8zU 77sA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1739219264; x=1739824064; 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=vh4CUvpz/fzJO7m3g4Lrx30VWLQNLgBESiJnDVTGIvg=; b=gUaSmFZPdRHmbYcwUBHzc+NTf6SQU+datUTWRSfw8nK3J+mJYozKdUXwYWpeYCWKIF dJudKN4gpCAeSvaxvfu9OEfA9a8I2jAo2MHkUUaqjvBWDvWHOW9m9Q86wK6Irotqgla7 WmlMR1wGoXXdfbUn0yMf/phxkBPm+CbPFzHiHWh7VvU2G2FL30i+9B0eyZKI3AvNte3n Yf91jUoVttjDBvk6do/L4BnJNTHBb+lavYWWenrJC8EvS/BwQ1Jckiknk6DHzo8onM+/ PsDtaDvNd6vzJBE00fzbBzTKmvb12mZTf/c/XV6XEB2rjQt0Arj9r6LYlx/q2Yn8FFuw C7Sg== X-Forwarded-Encrypted: i=1; AJvYcCXgQ1/jy2mpkB6Q4NrwTuffEkVlGKwxSw82ncHk3csTDePRRbdiacCGwj6QzT76uIMxozECMNAP1w==@kvack.org X-Gm-Message-State: AOJu0YypXd7SrMAjmMGgkSWLUcJEpc7/y1mdYFswcRIR0/TSZmhtbCR3 RZJnTlLtf525K5MDGQKESqylb9Pj2gPrB9WeXYf+gQLiZGAh3gCN4zCnEvI+JU0= X-Gm-Gg: ASbGncv8qlwT4JyT+F5BN9Uud6hKHpqqwoZRJv6e7ElYezJTLfTRCISACeGjl8to0yy 12daIR1uGdqj0joSrExC2oxnGEcPoQC2kM0EjiDHEYRMMUJCOQ/9LYK6neR2zxagGYqjwW8piMw 30L4H62I1Jy6rL0EYF2GoGOivWlslHXN0P0BYwh3XNnLdXffakJEOOzlLKKv8dwyLC5WRvZ/JK6 TTN2AP8mxSUF4+01wOT0IJy6nwEDTnEwSZxPL72eZByju7soHCKLl33XvTOpUyYpP5qvwRHKUPo DBpOcp+f/lZoZHHEv/wfKZcltQ== X-Google-Smtp-Source: AGHT+IHONYQapq26xKI/Nlqt2sawgQ5ST7q18FCOtyS0Axv9TidoEnrL+FFU0G/ytCjykvg19tyLYQ== X-Received: by 2002:a17:902:d4cc:b0:21f:6a36:7bf3 with SMTP id d9443c01a7336-21f6a369009mr211502955ad.12.1739219264447; Mon, 10 Feb 2025 12:27:44 -0800 (PST) Received: from debug.ba.rivosinc.com ([64.71.180.162]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-21f3687c187sm83711555ad.168.2025.02.10.12.27.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 10 Feb 2025 12:27:44 -0800 (PST) From: Deepak Gupta Date: Mon, 10 Feb 2025 12:26:58 -0800 Subject: [PATCH v10 25/27] riscv: Documentation for landing pad / indirect branch tracking MIME-Version: 1.0 Message-Id: <20250210-v5_user_cfi_series-v10-25-163dcfa31c60@rivosinc.com> References: <20250210-v5_user_cfi_series-v10-0-163dcfa31c60@rivosinc.com> In-Reply-To: <20250210-v5_user_cfi_series-v10-0-163dcfa31c60@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 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, Deepak Gupta X-Mailer: b4 0.14.0 X-Stat-Signature: 1r6iuyzyyanym8izfafr6icu9ssuecab X-Rspamd-Server: rspam06 X-Rspamd-Queue-Id: 973431C0009 X-Rspam-User: X-HE-Tag: 1739219265-392791 X-HE-Meta: U2FsdGVkX19VEeydKlwQBMUbXIq6m4nUK2dKXDXWqwEjgoxhBWFErgBlJJfkNfNbO9FfEzhN8IY/rROOotkMqu0pSQYNHFvWOvMS2J0sxMJ2nkMaLkYefHZsU6d1QxjbXJ/QHvfkpqT09RAYVrHfUm/p0H0CFSukGtoBKDJeokuwYSCX2fwLRQ8LyG/iWBKWLr6RJzpaUMNyFomWHKp5IHz8qfJ4atIPRhIu84XxvOeXf0jjyKCb0gYnK/0t1z5ziPvIAs6E2VZSHdLCnV29nLj2kICHyqqNYP+RYmlTobq6eAWoQoekOToLG8h8jQQm1rl9f3/BTui1OPCCXhwwJzh+5ZsoLkne58UVLlti6a/NVHn4Sa5kRzsjoaR4PG1S+82AHOkZRpYPNsGXsT+Y2+Z9vO6L7TZOkql5qCwhLTp2fANrK9v6ZGbmJmEy1+y41zcN6NSkFTlnDqVzcewE4EPd5HwO9af+vyvIGgL7Xp58mccDxFvrOHHWdilEq+tq8LIXCaMzP3f4e8v399tR2x4D7r9draxDnPI2ia81bDqdtxw9ezdmHEl+226mKwhEvl0Cxzvv82hxqWdzh2tIQfk3JnQ1bjZe8uaSijYEVMmEB0wHR1An9I7sHxKd5lhoOR1Y+JO+KVXbCZLx7nRUdKZ0TvkXo7W8ZhaHeiFRP8eVl5/BHZ5whikdVOADQglY3npm+RAXORQ9e17TccxQSVF8vOp043ZLB/qI7edHNQsnJAPOWJHh/io5l9lChDZaPAOWhf98gOYBWkGfB99yHUCwe1Oi9W26bDBAnUCTy6fxBf181JIN02qv8IDXRmPe2yUO9j6Maux7/eyWJ6RWNeFxW7i7iLs2PEVBidANOd5ntRB3lfl/yMKYi3H8KV9ckbCfWKeYF3VN+pGUMjEpryKXLZ66O54p3nFUHu/COpG9EmEGMs8lNs3cc+GgAjNATPekdaZWMpTMGkDGxrH h1TbvzD2 lVS3V37q+JkyPt10vcixqlO0myIP1VyHbrgk0GRwbL5eniCw/Ah9p5fNgUrLHwwz8mUt3zDq5WDmQVm/yeDeS9wVQgn1H5En6QUXab2kuC9IuGUbdUlirWSVMYzJfaC80cQ60uVPuZaV3XHWfgBwwwxzB855U7GKJ4YsAhhm+oZTCM73it3tkElsuCoqj/FyX5t8NC1Cn6GR95UNl8GMoC+eC83gbFMYNHTNkD5jfNgY5WisIE9WxfTebbsbe8jK04h8NScmxQakCUU4fx+ZbDZ0CQk1fs19kzD8bFMdqRvFOKSewYRBEeAL8iWkjDiME6MQE/c6KeoyaXOOxh7VQti00Ll3MmBt1REXhitRDA1XNrrn9tMsHw6auUFO7h2BzxH4KALKY5AYXSv0q+uCm9zx3BKQTzQX3zzrmVd6ZDBZu824LfdZWaPKxNL6cdodVRdeAYpffVPeWL+o= 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. 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..a188d78fcde6 --- /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 RISV-V + +1. Feature Overview +-------------------- + +Memory corruption issues usually result in to crashes, however when in hands of +an adversary and if used creatively can result into 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 withx7. If ``imm_20bit`` == 0, CPU don'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 enabled 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.