From patchwork Fri Mar 14 21:39:45 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Deepak Gupta X-Patchwork-Id: 14017513 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 4A401C282EC for ; Fri, 14 Mar 2025 21:40:43 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 8FF5028002B; Fri, 14 Mar 2025 17:40:38 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 88AAA28001D; Fri, 14 Mar 2025 17:40:38 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 6B7B528002B; Fri, 14 Mar 2025 17:40:38 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0016.hostedemail.com [216.40.44.16]) by kanga.kvack.org (Postfix) with ESMTP id 47DB228001D for ; Fri, 14 Mar 2025 17:40:38 -0400 (EDT) Received: from smtpin12.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay02.hostedemail.com (Postfix) with ESMTP id 766E112158B for ; Fri, 14 Mar 2025 21:40:39 +0000 (UTC) X-FDA: 83221476198.12.2E2BA4D Received: from mail-pl1-f177.google.com (mail-pl1-f177.google.com [209.85.214.177]) by imf04.hostedemail.com (Postfix) with ESMTP id 8951440007 for ; Fri, 14 Mar 2025 21:40:37 +0000 (UTC) Authentication-Results: imf04.hostedemail.com; dkim=pass header.d=rivosinc-com.20230601.gappssmtp.com header.s=20230601 header.b=Z1zAUVNZ; 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=1741988437; a=rsa-sha256; cv=none; b=d71N0ttFdviThFSYUpwss/hgYKC/guEcI4RYPxG2+gjx7otjfDWIZX3rU4UOyEZ46wiRO9 sUt44Wor/g/vXVYOElan8z7ewtRifgB70vpxCJ4Uf5EW/dE9vIkYlwmOU81Qubz1VQ1giJ 68vSTLw5rQkmpTNdxl4kor22SKO0q5c= ARC-Authentication-Results: i=1; imf04.hostedemail.com; dkim=pass header.d=rivosinc-com.20230601.gappssmtp.com header.s=20230601 header.b=Z1zAUVNZ; 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-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1741988437; 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=S58lE55A7IFUYe9923mKAAObQ+TwOi1jWkuglFq4t0Q=; b=IxQ+rKpQIlKDvfpBtkcqtTm2Fpz5DN5AZ5O8dpRc63H2HSzfS+58vJQuFa1eYyGcDgf6P0 thvrGXXpNs2eyD65OwebRzNkXRKvbqi3W97A8J25hhFcRWjMYEocK1bNBIHWNlNzPVqrOs GfLWstOqtLvb9xarFTtsfrUASp2/1aI= Received: by mail-pl1-f177.google.com with SMTP id d9443c01a7336-22349bb8605so56814925ad.0 for ; Fri, 14 Mar 2025 14:40:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=rivosinc-com.20230601.gappssmtp.com; s=20230601; t=1741988436; x=1742593236; 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=S58lE55A7IFUYe9923mKAAObQ+TwOi1jWkuglFq4t0Q=; b=Z1zAUVNZJFZv3HNGM+h17apDpTERCv6FCD1SQMmHlh4Y35nuBVdhHiuGptsF71N6MQ p4e8J5147jIe6Ws/RV2+xlTkvrpWRRs4Xs8kmvLourEN1za6grG8MxwZa1IwW2xUakDS A4nPfo/oAVOS1h4gdkusxR6ZR1ksc2bcxf/hf7xGn8lSCoFpjtWZAwywIgaaCHBpMudw WbTZYbciQ6UV+IEPadCZ37CWEbHejp8p0RjhabMCpCTlAew7trIAl0msWqCNm+b0uPCL qADPBuK2/tcjssjqE/YyTbr6+dYFAvYjazNFdjcGcASjNHA9nWl8kTEYMezaS/O0qAhz GphA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1741988436; x=1742593236; 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=S58lE55A7IFUYe9923mKAAObQ+TwOi1jWkuglFq4t0Q=; b=mFMToU/3VNXN9Hmk2lLnoThUD6NA48ld1eoynAOnWkt074eBAbIYR8F0kBJLftdPPr iR59oBYcCmOkIs3h/GW9qTs2aXyhws8wMu8zgm0WNTj3KQMhBpgg7rUviCgmoq8H6l5u QvXSsZEtUEfd2dcBQdLraY0cgkfs2vqd4LsK7410h3w3NP3c8v2gQyNeZbOJL8+p70jm pTN3HWfqeczW+0HDHxv2SvfDmZg+VUwUBauYtsDucwUSM3AUpzA/QGZrqUcYXCrzaQuc OkNOKmyKqex0p7QzvcaSuBqdEgoypzyEOKgi6MgeLqfhWpxvG3REJyp2n1TjuKos5I0l +kUQ== X-Forwarded-Encrypted: i=1; AJvYcCVIvN5uBuUiOL6ZyCyFucW6Wk6X4tXxuwrJdP44PXQ6j8z0z4wpGxiVH5GJJGsn6tb5x1R+9jAiAA==@kvack.org X-Gm-Message-State: AOJu0YwCs6kPol87YwLIWzhP74oxT46V+eBLeWSKBZs+hh/znHLfz0x0 EvBks9x/b2g746/qMJ7CT7LLe1GAhUGAvGWYQhHoEE4GsaFrSn5nijqM5AqnITQ= X-Gm-Gg: ASbGncttQO6/ObW01Mw6ycMTMNU1gtCBlZG2M2u6P7PsmporuCtbjc3P4HC62aq2Ymz zApqeOYNhWL0fRlYHW4PdYFTiyGvg9MJk6YEBrj3aWJwY36zzBzNJP0xt85BOdGP1duuLZX8pJz VxfZkGZDSoLbsNUUC+x4aIc0i5hYozRGAaZ7h/seUZmu9Gs/qhE02cdGC5iPYLCD6sgQ8c1WbQG g5Q4qbDwMmEPVK5D8Yq6l1EjfHxUwBGDQkxm8wiosfQ9Pnk0fKao5mJSg1E0bMgOUmvW04Usbp/ Ub/j0AhqGwDGii5UvPsv4y3N70TSYD6oHhrKdGt/invY6GjOh4j5t62ms8d5KpK8IQ== X-Google-Smtp-Source: AGHT+IHxioJjWTqWYTnSKNhIGhNEZD+Fw6H3+v9MmF1O2GdMnurdCyxzj4vsKuZgW7kLmsjMSOe+qA== X-Received: by 2002:a17:902:da90:b0:224:10a2:cae7 with SMTP id d9443c01a7336-225e0af9d92mr50203725ad.40.1741988436457; Fri, 14 Mar 2025 14:40:36 -0700 (PDT) Received: from debug.ba.rivosinc.com ([64.71.180.162]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-225c68a6e09sm33368855ad.55.2025.03.14.14.40.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 14 Mar 2025 14:40:36 -0700 (PDT) From: Deepak Gupta Date: Fri, 14 Mar 2025 14:39:45 -0700 Subject: [PATCH v12 26/28] riscv: Documentation for landing pad / indirect branch tracking MIME-Version: 1.0 Message-Id: <20250314-v5_user_cfi_series-v12-26-e51202b53138@rivosinc.com> References: <20250314-v5_user_cfi_series-v12-0-e51202b53138@rivosinc.com> In-Reply-To: <20250314-v5_user_cfi_series-v12-0-e51202b53138@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, Zong Li , Deepak Gupta X-Mailer: b4 0.14.0 X-Stat-Signature: bs49uaqmjgcpsx46tozdh5dao783s35p X-Rspamd-Server: rspam12 X-Rspamd-Queue-Id: 8951440007 X-Rspam-User: X-HE-Tag: 1741988437-393781 X-HE-Meta: U2FsdGVkX1+1ivcggAxzAdqFakn8KYC7xTa1Nmli9a8+GhAdtxmAMfucHbV+YXR3d+7oBXgJuSVreHi/+ZD3TYrBfE+acQ8BACmP8072nPyd6T6icVRDKQ9ol4E5dpBzjrGsfitgtKnURawhvUNURZ90ornHZMMCGVeSlewa4W6uFZSA8XATfn4kLZwPVaWBb9Hfy1Fe7Z34kk+UVoe5Nu6nwxgUKm2ZxAkZvqklwN9LCQ+ev8k4smo7nEgZYYtk6ObhpoorByBygXVLKPuZDw36ItaYOQFkrbngEEZSUHmN8QI4Hq2+biu4hQBdah+17ffJ56OGR/CFkZYGegAK+zBVaTL5i62liBBqPrTkhxeu69mraEBhNYi05kNvAo/Gj7dPXU7LzzMUYFjspNUtTyLFeGIiEOhq5cCmqcXpa97b5hTajm/73KmNtQrSeIGS3o33mT0o4PrLMQYe1FdzuUW0I36PaSAECrKt1hq2yE1z+ON93BnEae9d51yDz/VC5jXh4OnwGx5s/x9EIQ9N9QYHtYBZiSitG/f3p+TLjJehWSwcY6e8GpC37f1HfK65MADOLcw5yqxGwhhq6zA8XNVueXMkNP5zedDRamtB+I4CHUxjQz8jNIFdeflyBgbYNy4Qb8BFj0W+to40KVps8B/UQBafJFHHgvH+iGF2cyS5Xh+PYBtu39AgeAwShu+iPMICkjOK5vtG3JHZlh9Q1HZEzpSprGfIPttpVFug92zHWMBFS4G1984U4SnFzQ9fZKInJkHZOMaVEdxqekV0pxAD6jjHkqtkqmvO7/T+ec1myyzmKBj79HzcWYhBL3f4NO5Qj+Ns2gy1cxTrclrKz3EUs8H1jd6bU9Ax0FSU8Zi5GaYW1nqE6I4JgWsFIB7oOjOjHHQL3LGYvxfyiFuYjoL15m3oXEAhSwgstNWNWyKJ/C7Kxdxm/SMxeSSulwVKOs9AegHQCCQuYYmuVgc w8XVCYuc Mmp5P1CbpUM8ga+bLtUQU3eeCmKsVZLRN/9MOGWMhvpyM4tLqyzyuv5TvVHvnU9PVzc4PkoOUSnLJLByhGyPGzAUUJY5EFSiD7eZjrkuETad3x8BM8lXA4YyaRNJYAfnASE3akPAk1DQDhjbElt43yzmYwMENKcwXM7vvHfCFEqwIjTcASTCljrUNfadnA2hFo17IYiYa9+jLSpa81RNkfjXtJl1PPS7oBb0wCjLGOp+dyGXAxikg+eJoOe5r5DCxsWM7PeYldVs/NrERe3TQGYJSumcaujfy7A5iw1XcUiqnyxEM0HyD8RNadmQ9o5XZnoNKNvqkDYSEXcYIELxB9NJD6p2VGRtjicra6E+lt3WgtqjtHfGTer2a6b56yqDVZlyEZ2NSW82bf4NvO7gy1rWWGnkJlaKMdZhHJwCjT38iXglCfWbzU1usJ8RdQXxUw1d5ZcnPXuowsVsHhprKMhMsrD2uFQJYgCkxiaUd1Z4qxMXBD175dDhpC5m6FozdMxdrQeo/zTYe/cw= 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..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.