From patchwork Wed Apr 3 23:35:15 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Deepak Gupta X-Patchwork-Id: 13616822 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 1FCA9CD1292 for ; Wed, 3 Apr 2024 23:42:54 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 6C5798D0008; Wed, 3 Apr 2024 19:42:53 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 64FB78D0001; Wed, 3 Apr 2024 19:42:53 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 392BA8D0008; Wed, 3 Apr 2024 19:42:53 -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 1329E8D0001 for ; Wed, 3 Apr 2024 19:42:53 -0400 (EDT) Received: from smtpin22.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay07.hostedemail.com (Postfix) with ESMTP id D3BC1160392 for ; Wed, 3 Apr 2024 23:42:52 +0000 (UTC) X-FDA: 81969848184.22.3E07543 Received: from mail-pf1-f176.google.com (mail-pf1-f176.google.com [209.85.210.176]) by imf29.hostedemail.com (Postfix) with ESMTP id 23912120020 for ; Wed, 3 Apr 2024 23:42:50 +0000 (UTC) Authentication-Results: imf29.hostedemail.com; dkim=pass header.d=rivosinc-com.20230601.gappssmtp.com header.s=20230601 header.b=MCp+bsnZ; dmarc=none; spf=pass (imf29.hostedemail.com: domain of debug@rivosinc.com designates 209.85.210.176 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=1712187771; 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-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=f5ifazHbpOl/UA3v79b+PzDDuljcd/dBpmVrUfFdj7c=; b=uUhzNqFH615pxYtDXJqIw1KYQZW4Zl5Hbz1kz+jwqO0hO6ZE/lhlJI3CQMOZJvrj4vLOpj VohQ+VoKOrRgTqhmh2brVu0UsSyITzngDXp2y51o/39yg8JjN+ZljvCiHlspWFEgXJf5On UCyCgCdZa8+9L2TjDgJyFpkmR8lnxnI= ARC-Authentication-Results: i=1; imf29.hostedemail.com; dkim=pass header.d=rivosinc-com.20230601.gappssmtp.com header.s=20230601 header.b=MCp+bsnZ; dmarc=none; spf=pass (imf29.hostedemail.com: domain of debug@rivosinc.com designates 209.85.210.176 as permitted sender) smtp.mailfrom=debug@rivosinc.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1712187771; a=rsa-sha256; cv=none; b=CdL3sWDnriX4o1RojkOR42/zv/xo3to09z/6VW8cMdKloZ62d6rAc4IqK0ptvI2jS9Dmzt r18losXFhNW0UPtPIXY6+84tz637WumPvUPhbRUKh3lkYSbOR5v3PiCVekPHoy6VniT63E Ee6LE3qX/VhACEgsZtDtlgjY6+Yqaic= Received: by mail-pf1-f176.google.com with SMTP id d2e1a72fcca58-6ece8991654so153640b3a.3 for ; Wed, 03 Apr 2024 16:42:50 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=rivosinc-com.20230601.gappssmtp.com; s=20230601; t=1712187770; x=1712792570; darn=kvack.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=f5ifazHbpOl/UA3v79b+PzDDuljcd/dBpmVrUfFdj7c=; b=MCp+bsnZfQZShyQ8EmY3ML3yLO/Ca7axCG9Xhm/iWt5DxwGw3GUG+VTPRAJjk39520 oF3RNoOXaHnnGgWmvkcHGwyxkG42Pj+wQ6W4lim7K453DbFS1UZ0eUX2aUWjuBh0j0yU 9XMU1KCBACCO5bUPp35CyrxYHNHUpMTFosmGj0p3pk+3eugv9Of8+LL0d5GKKKHL5QS8 Kbqn9hjgduC3wuYFMMbkTkm9gsboVKFk3umyoxO3KNeKRdXI6eUwF6YntjDucLRr72zj 4LxCv0wQxoqpVKLEk+cbbAW6KCCBijqTE/+AY5SaA7biRPbpM/VB4GcscuL95/LDgb0o mqiw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1712187770; x=1712792570; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=f5ifazHbpOl/UA3v79b+PzDDuljcd/dBpmVrUfFdj7c=; b=Fd/RYvsQsqqGoMz2OwFLNuXHJe8zjMLxmYKXrdvs7hpCvCETuSkxzB3EKGDCuv4hSm nJaBN0+JZ76LfCQsnOgChnyYWHbVAORAwRRHNFAKzavzWEHPomEy6p5pRoycGbW2s8Dy txFf4rbVk/3eEUl6kNMar1PYxZbofJzaz0F/eWM1sLX9rB0hFHwzAePwW0bUdl5rYUW8 U3lGNCT0cP3MWggWRsEk33P/7jbD7gbOZkvSvMM1twDReBHtSCA2yM6cewAoddCqGdsA UaKCHsCvz6rsgfILcj1+V4KWUuOTPYrem3g/oeg5BSeF8UbWi1nK8pdnSNPcphdi/rLB IttQ== X-Forwarded-Encrypted: i=1; AJvYcCVKAXKQNoSM1kY+xNxeycmJ3AuaGC5pZ7ZJkhy+YnUUZ63hKqMwraMB3qr50wdhK1r8ftTj6Tvsuw6ONLwW0QIe0q0= X-Gm-Message-State: AOJu0YyFenLyW+iS5DFUk1OucSpiCUgRGc+HwG0wNO7xEDK3eoh/bowv Br9vTV5pw9zFquJhjJvIIk4asapS9/QAWzey1f1llnt1yeUWMA6ApShSHakuvKQ= X-Google-Smtp-Source: AGHT+IFOcGirbQfLQaLb5+nO2ahsn6EhtiBDapL2BrJtt/8rvvrO0dXtCiXExOYOg70SFiumQnh5iA== X-Received: by 2002:a05:6a20:3d03:b0:1a3:3fbd:f859 with SMTP id y3-20020a056a203d0300b001a33fbdf859mr1489558pzi.2.1712187769990; Wed, 03 Apr 2024 16:42:49 -0700 (PDT) Received: from debug.ba.rivosinc.com ([64.71.180.162]) by smtp.gmail.com with ESMTPSA id b18-20020a170902d51200b001deeac592absm13899117plg.180.2024.04.03.16.42.47 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 03 Apr 2024 16:42:49 -0700 (PDT) From: Deepak Gupta To: paul.walmsley@sifive.com, rick.p.edgecombe@intel.com, broonie@kernel.org, Szabolcs.Nagy@arm.com, kito.cheng@sifive.com, keescook@chromium.org, ajones@ventanamicro.com, conor.dooley@microchip.com, cleger@rivosinc.com, atishp@atishpatra.org, alex@ghiti.fr, bjorn@rivosinc.com, alexghiti@rivosinc.com, samuel.holland@sifive.com, conor@kernel.org Cc: linux-doc@vger.kernel.org, linux-riscv@lists.infradead.org, linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, linux-mm@kvack.org, linux-arch@vger.kernel.org, linux-kselftest@vger.kernel.org, corbet@lwn.net, palmer@dabbelt.com, aou@eecs.berkeley.edu, robh+dt@kernel.org, krzysztof.kozlowski+dt@linaro.org, oleg@redhat.com, akpm@linux-foundation.org, arnd@arndb.de, ebiederm@xmission.com, Liam.Howlett@oracle.com, vbabka@suse.cz, lstoakes@gmail.com, shuah@kernel.org, brauner@kernel.org, debug@rivosinc.com, andy.chiu@sifive.com, jerry.shih@sifive.com, hankuan.chen@sifive.com, greentime.hu@sifive.com, evan@rivosinc.com, xiao.w.wang@intel.com, charlie@rivosinc.com, apatel@ventanamicro.com, mchitale@ventanamicro.com, dbarboza@ventanamicro.com, sameo@rivosinc.com, shikemeng@huaweicloud.com, willy@infradead.org, vincent.chen@sifive.com, guoren@kernel.org, samitolvanen@google.com, songshuaishuai@tinylab.org, gerg@kernel.org, heiko@sntech.de, bhe@redhat.com, jeeheng.sia@starfivetech.com, cyy@cyyself.name, maskray@google.com, ancientmodern4@gmail.com, mathis.salmen@matsal.de, cuiyunhui@bytedance.com, bgray@linux.ibm.com, mpe@ellerman.id.au, baruch@tkos.co.il, alx@kernel.org, david@redhat.com, catalin.marinas@arm.com, revest@chromium.org, josh@joshtriplett.org, shr@devkernel.io, deller@gmx.de, omosnace@redhat.com, ojeda@kernel.org, jhubbard@nvidia.com Subject: [PATCH v3 27/29] riscv: Documentation for landing pad / indirect branch tracking Date: Wed, 3 Apr 2024 16:35:15 -0700 Message-ID: <20240403234054.2020347-28-debug@rivosinc.com> X-Mailer: git-send-email 2.43.2 In-Reply-To: <20240403234054.2020347-1-debug@rivosinc.com> References: <20240403234054.2020347-1-debug@rivosinc.com> MIME-Version: 1.0 X-Rspam-User: X-Stat-Signature: qfwsm391m9ptsdy64tfiqby1bxxzbr8n X-Rspamd-Server: rspam07 X-Rspamd-Queue-Id: 23912120020 X-HE-Tag: 1712187770-262865 X-HE-Meta: U2FsdGVkX189KFlaDZ5q+31enPfz2V4duT6WhMUa5JF9uWl9vpsC5eE1t9WfLDlbHITPLBvybK7rdchRbgGFHX6Y0OTxpPQ+LbPlA3ne2v/C00iouQkLeRFUmRkkG6GoO2i59dTumwL6yLTZslHdUcunQetn9B+hjWD7/aLeS7N6zZRXi6shixfvKBhITfRw4uhGeQc5p7NhQZ5TxC4M9G9KrtSz2d/cz9YD1+1CcMcrh88fG70fNl4TBV3ZaakxSdQlp7FZ0QVSeHCxpU+fsZXchOC0dIOzWUsYxcQExnEQyO6q2WkHK/hIdYBbYu2qFZPCLfuD9XizS2Xq0jUqIMorbBonNeW3thVz8FJFC8g9d6rg7GO9I0FsOiDGwXbYWNU2XLVx2kDCVCf8cvjaZ04QNY5jgyKqqKwnebgj3rFlrGYgoKapkVBPWKEv/3v7QiG8p1kzZY575/Nq9T3l1hYqTy6GiN909h1Ehx38stf7cyfmVBpG2vWTB3CQ0kI/+8IbaB1EpG4xcdjmQfJjg7sV4GohjWTmoQ4jDyRJepb2y7tr2xcTRZ9YqvFcVWER7OIneVtJFudjfQ7O4o+bg7oC1q1VnBECrJYnQKrG8bBOLH2xZnnfmrHby2ew0KYg7PP/CuSN8PThvEUjeU4x1tmcDjO9yqgQjl9J7c6LQxmB9+0XYXHl3GzOq6cNm4EPdFcfw6coPzyrpPKpXZAaUlw/G5V5cPvNMTQ0DCCXeOig4LIiMFkriYgOjOgmn7PgLDKO0In3IOXY6qYQZuvCl8NmTQ2sxcZdGfKbHBfhGBGSkIF3tEcjktTA4ar2diqRFgN1qYOWugpGkgjoKBbqpUtKBS+oMx7O/oWUvNRG7gmbRMYFqiyCPbb/acfomccVEbUO5SBQnSTnQJlkSFfTqYWtbp8NZ5UWPaL1MJF14V1RrmyXO6bJv5BkfY+Sv1fcpraDnoHqDEyVf/NX9A5 CVjErvRV a//PH2VP3iZ8GUC/sVJULl7tIRMSfdCdwbSmWxzUACWFSpRRkL3bB/5vun0hUjvBhk9cAvxhDL6/QG7YDpeJQ3vAhRch/A0O1i4iorWP8NiTkYtJKuDxdBgQwZHMpum75fqlmENlbK402PNMVQkkXdrqxOKKPnD3VJARwGIoS33r88UFafWmkuhWaSRG7zV1khVrygk96SgnLMB+NDJdrVKIYbqd6tgbE67PTvDx7uCncz6U= X-Bogosity: Ham, tests=bogofilter, spamicity=0.000002, 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/zicfilp.rst | 104 +++++++++++++++++++++++++++ 1 file changed, 104 insertions(+) create mode 100644 Documentation/arch/riscv/zicfilp.rst diff --git a/Documentation/arch/riscv/zicfilp.rst b/Documentation/arch/riscv/zicfilp.rst new file mode 100644 index 000000000000..3007c81f0465 --- /dev/null +++ b/Documentation/arch/riscv/zicfilp.rst @@ -0,0 +1,104 @@ +.. 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, ` 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 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 proglogs 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 `GNU_PROPERTY_RISCV_FEATURE_1_FCFI` for property +`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 +-------------------- + +`PR_SET_INDIR_BR_LP_STATUS` / `PR_GET_INDIR_BR_LP_STATUS` / +`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. + +`PR_SET_INDIR_BR_LP_STATUS`: If arg1 `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 `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. `PR_INDIR_BR_LP_ENABLE` being clear) + +`PR_GET_INDIR_BR_LP_STATUS`: Returns current status of indirect branch tracking. +If enabled it'll return `PR_INDIR_BR_LP_ENABLE` + +`PR_LOCK_INDIR_BR_LP_STATUS`: 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 `SIGSEV`` with code = `SEGV_CPERR` and follow +normal course of signal delivery.