From patchwork Thu Sep 12 23:16:47 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Deepak Gupta X-Patchwork-Id: 13802851 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 E7ADCEEE271 for ; Thu, 12 Sep 2024 23:19:12 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 79E586B00C3; Thu, 12 Sep 2024 19:19:12 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 74DA16B00C4; Thu, 12 Sep 2024 19:19:12 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 57A436B00C5; Thu, 12 Sep 2024 19:19:12 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0012.hostedemail.com [216.40.44.12]) by kanga.kvack.org (Postfix) with ESMTP id 340C86B00C3 for ; Thu, 12 Sep 2024 19:19:12 -0400 (EDT) Received: from smtpin18.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay08.hostedemail.com (Postfix) with ESMTP id E0FC9140C8B for ; Thu, 12 Sep 2024 23:19:11 +0000 (UTC) X-FDA: 82557654102.18.01308C8 Received: from mail-pl1-f175.google.com (mail-pl1-f175.google.com [209.85.214.175]) by imf12.hostedemail.com (Postfix) with ESMTP id 169204000A for ; Thu, 12 Sep 2024 23:19:09 +0000 (UTC) Authentication-Results: imf12.hostedemail.com; dkim=pass header.d=rivosinc-com.20230601.gappssmtp.com header.s=20230601 header.b=buAzX6He; spf=pass (imf12.hostedemail.com: domain of debug@rivosinc.com designates 209.85.214.175 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=1726183097; 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=Iyonew7njYYUDgOFlccFcLDkYmWknDQSdFdIbsgjEzE=; b=n6LuS33vzDK/1LAYDuNYJxTx+qjqwqu+7iclvvhSvNuwjazpmW3Sp5cfoxnEcftovuTTp8 Ckavo2xTzKhA6ewgjcucRn+HIo7yKfyIXgnKWjQ1SR5FEsC1WEJfoX0i12RmyMsbblEpkG CRUBqaRyeYE/r+O8Bg2FdzMrLfVWST8= ARC-Authentication-Results: i=1; imf12.hostedemail.com; dkim=pass header.d=rivosinc-com.20230601.gappssmtp.com header.s=20230601 header.b=buAzX6He; spf=pass (imf12.hostedemail.com: domain of debug@rivosinc.com designates 209.85.214.175 as permitted sender) smtp.mailfrom=debug@rivosinc.com; dmarc=none ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1726183097; a=rsa-sha256; cv=none; b=Gw9zjXunpARi+Rg8nD6z51TfFemTuUd1HHqbn5ORbau8sezCNJVebYmoOwTItMYYE6NBC1 lO+H9hZOvhmfGRPHiIedhQUgcib1KpNZIdMPCXbamG9k6OHjZbggBAU4Z5tFK89H7uxZ76 ZgMSwqZPv8yfaEmJO28X47FjE1HiF80= Received: by mail-pl1-f175.google.com with SMTP id d9443c01a7336-206aee40676so2682205ad.0 for ; Thu, 12 Sep 2024 16:19:09 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=rivosinc-com.20230601.gappssmtp.com; s=20230601; t=1726183149; x=1726787949; 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=Iyonew7njYYUDgOFlccFcLDkYmWknDQSdFdIbsgjEzE=; b=buAzX6HeVU8OkldaXeUdFdVpP2jyfgvyxtEt//bN490O3JFR8q3KtVxbIw0blUr8Ll 4/WgPRLnIAMMwlViMeihsFkcLFSwNBCQ/hRsyL8jnmFzv3V/p3zlUER2G4R5VK+3f14o IdwuKU1YFxHyFJzCpklQvWqA6eCJwwav2aallBHmZ9psQR69pNEMgEWQs8z7WK8fZMdL ldVPl9NMk/qNdveG0uXKrxv8kWtPS7/pvpI7OJxoOeZT2jTg+BPmPd+dGqZ9xcx6d2Ri oCqYum/sLxxOU7JJlM2y4mn35Tc5D6m52j5ZwjHlZoqaE1INuEU4sJIVD4+0fg9s3GvY suQA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1726183149; x=1726787949; 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=Iyonew7njYYUDgOFlccFcLDkYmWknDQSdFdIbsgjEzE=; b=ZeOncmFJBRtE1zNTc8NLHU+dvACcc+oUqoQu6udgXbYFpy2HsGW3GOvvvLd/0ApqiI VhdF7kpTLtvsTsJaInZxj4X/rlQN2Rg2Ao3gzaJ0hE3qZhI4886AsbmLMgPxX6p6TlRy plnWzpXJvbXZLlYX5lu80EVs5H8lJNdxxonl4uq8tlAFrVvZ06Ov0RVPp78szG9GOtRy O/pXuA+zIVSOvHF+y0OeMPC0kITQaugbnKyB0zAWGGY3Vn7SX+sUvecKs7K+qIJhQvUQ xG/NgYG4OXQlyhbQPmpK1d4Lg/lJILyF8QPOsGq36FQwtyJZCnXY3q90MfyIVSDW9pi7 lkWA== X-Forwarded-Encrypted: i=1; AJvYcCXUZb+QYSXtoSezhAQjfRrv5PxOmH0FbLNykZXB4JWZ3SrQ5EKjD7mkBU+Asxqm5RDpRk7krHDlCQ==@kvack.org X-Gm-Message-State: AOJu0YzKasn2HAXzGJG3ms4ZH0GA5P0DvGaxO1f+zNGagO0tfATAZdz2 zsd5pOL3M3QUy0Kd81ClE7Ow3yjAVYqynDtEvIBkmHnGQ/HjyfSGiXAiadP/jto= X-Google-Smtp-Source: AGHT+IFQFXeegIq20jMre9WaWvSrfHhLDrwK4rARP/3T0r/5M87gFpvdLVA9mkxvLCR99S6cpVQrqw== X-Received: by 2002:a17:90a:4b87:b0:2d8:f0b4:9acb with SMTP id 98e67ed59e1d1-2dbb9f08179mr1017556a91.34.1726183148685; Thu, 12 Sep 2024 16:19:08 -0700 (PDT) Received: from debug.ba.rivosinc.com ([64.71.180.162]) by smtp.gmail.com with ESMTPSA id 98e67ed59e1d1-2db6c1ac69asm3157591a91.0.2024.09.12.16.19.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 12 Sep 2024 16:19:08 -0700 (PDT) From: Deepak Gupta To: paul.walmsley@sifive.com, palmer@sifive.com, conor@kernel.org, linux-doc@vger.kernel.org, linux-riscv@lists.infradead.org, linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-mm@kvack.org, linux-arch@vger.kernel.org, linux-kselftest@vger.kernel.org Cc: corbet@lwn.net, palmer@dabbelt.com, aou@eecs.berkeley.edu, robh@kernel.org, krzk+dt@kernel.org, oleg@redhat.com, tglx@linutronix.de, mingo@redhat.com, bp@alien8.de, dave.hansen@linux.intel.com, x86@kernel.org, hpa@zytor.com, peterz@infradead.org, akpm@linux-foundation.org, arnd@arndb.de, ebiederm@xmission.com, kees@kernel.org, Liam.Howlett@oracle.com, vbabka@suse.cz, lorenzo.stoakes@oracle.com, shuah@kernel.org, brauner@kernel.org, samuel.holland@sifive.com, debug@rivosinc.com, andy.chiu@sifive.com, jerry.shih@sifive.com, greentime.hu@sifive.com, charlie@rivosinc.com, evan@rivosinc.com, cleger@rivosinc.com, xiao.w.wang@intel.com, ajones@ventanamicro.com, anup@brainfault.org, mchitale@ventanamicro.com, atishp@rivosinc.com, sameo@rivosinc.com, bjorn@rivosinc.com, alexghiti@rivosinc.com, david@redhat.com, libang.li@antgroup.com, jszhang@kernel.org, leobras@redhat.com, guoren@kernel.org, samitolvanen@google.com, songshuaishuai@tinylab.org, costa.shul@redhat.com, bhe@redhat.com, zong.li@sifive.com, puranjay@kernel.org, namcaov@gmail.com, antonb@tenstorrent.com, sorear@fastmail.com, quic_bjorande@quicinc.com, ancientmodern4@gmail.com, ben.dooks@codethink.co.uk, quic_zhonhan@quicinc.com, cuiyunhui@bytedance.com, yang.lee@linux.alibaba.com, ke.zhao@shingroup.cn, sunilvl@ventanamicro.com, tanzhasanwork@gmail.com, schwab@suse.de, dawei.li@shingroup.cn, rppt@kernel.org, willy@infradead.org, usama.anjum@collabora.com, osalvador@suse.de, ryan.roberts@arm.com, andrii@kernel.org, alx@kernel.org, catalin.marinas@arm.com, broonie@kernel.org, revest@chromium.org, bgray@linux.ibm.com, deller@gmx.de, zev@bewilderbeest.net Subject: [PATCH v4 28/30] riscv: Documentation for landing pad / indirect branch tracking Date: Thu, 12 Sep 2024 16:16:47 -0700 Message-ID: <20240912231650.3740732-29-debug@rivosinc.com> X-Mailer: git-send-email 2.45.0 In-Reply-To: <20240912231650.3740732-1-debug@rivosinc.com> References: <20240912231650.3740732-1-debug@rivosinc.com> MIME-Version: 1.0 X-Rspamd-Server: rspam03 X-Rspam-User: X-Rspamd-Queue-Id: 169204000A X-Stat-Signature: 5c68xjzb9tuhc7f1o1fmy3opj8mcbdrs X-HE-Tag: 1726183149-527378 X-HE-Meta: U2FsdGVkX18T2ZGzgbTHvy730fnmSqtuCtp0K18AFrwdgI6NWBgzjb7R3mQc2s449c8mqoZPpI/sir3Z+DDctE1kgZDDvpAX8tSxW468Cckwuv3CIhC9KwVkDbOu9J/Czg7z1vTOTFrSA0ToCkkskWuSs6PYlvoewKBn2EqLrKECv4LxvTMGGgBz/h2w/qkNn4tDwSZZhF8bxYjPEsZ523M1O5zE+3xc2I9Z2XCi7zArivf20TjeDvCwmeyaT1OSxq7j+3FNzZKs8Ih8+T+RQ61ST66SbWdfbd51wDimXE0cdmap08v5QwRRlkbrlDNFUupoJ8Tqrw5I8EEaRPTz249j9ez8S9CtvOf6tAP6gFwPYIFzhal6puNokEnLqaMQEB8IhvAT8O6iq9mlbg+daXxRjUJowr6auOQ95l2OM1BhRcmb3j6qdXvMPKgZ2N4WJposBZdELpCwuIdDddHmb9B07ZSyySjQlxuLRa/s4870XzVZVIx2OrMGzM0WnlGhmVT2JFdL+jFxHz6rcgQI7CsAqQhPMpEaJGFlrb3RwjvgzHw0tb8WxEzGH6UnSbrzSbL2P61iXcFTypB2bLZV8kSMoUidOPWMAwXbHESM1Hb0PO/QBUsfirZOZhhZ5J6HibNBwPvLTfePPKje80k2GLChXFQ1gd7UCurPoN2DHiBywkU+A8Lcv4hWGLQ3vQk1zRyH1+y3QGBccXwvX+yWrNiD7w6nkz9jLGlEqzI+1tfmmz1R+Tsty07mGpEv3xcrsYopnBJt6cVGE4+9y1IQZQbktPTXutC6KJ+X6HQxTeRdRSwwpsXre9x2G3lPc71V8g24gNLw1k8hxFLELajt0LOeBPllZoARbWhPC+Sw7+Ni+DmjM0/ts7pXbZm7oOtj6cBftwE/Ans6en4k4l0KJelV2mPj7NUsyCoECC+aAwSgObiUZo7tYyDbA+Nh/HDDYWEV55iA5rV8gH3LxiX Fgpei466 rDQRzNkP6v1Zp5xr4omJ8glWepXma8nhdSHyS8ZlRUM88Dd6vZwJVPa6rsi8S/IlZLzcSIrRbSJVw0QQBtkWJGPRadOY7LlhgD8QA9kjFpOQK5Qsy7Sv2aaBJwVbz95nPeiQp7/t3mOxsG+pziA/NrPGjok8IIp8CtWX28UDADLnw5fWWKUQTe8NF9BpaKXpC4t9y4ZDGu0f3I5bf/ulM/+PB3P32gtWOy9enWrhAqOk4SX3qQw7KvZF3c+zOa/xRI5aXHgGwRmx34/6FUPLhgk/H8RZMKLv6p31QMYZerTr1rKs+22+XRFCvviNAfENVt+R13O3zSEfZWy9kb6sSVJNSekGWRFd2Ax8JSfRpCgzLvvyp0XcRG/coSTBwEBpTt9q2D6+d5kXQhtjXplGnWZQK3URTNTQC/RmwGdgYJJIjVoH3RQ8L0AhGFBY/IdNkQLzeDGiQfzwgJuo= X-Bogosity: Ham, tests=bogofilter, spamicity=0.000499, 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..23013ee711ac --- /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, ` 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 `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.