From patchwork Mon Nov 11 20:54:12 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Deepak Gupta X-Patchwork-Id: 13871364 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 9BE1FD3ABF5 for ; Mon, 11 Nov 2024 20:55:16 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id B93CB8D000F; Mon, 11 Nov 2024 15:55:12 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id B1B208D0001; Mon, 11 Nov 2024 15:55:12 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 96DFC8D000F; Mon, 11 Nov 2024 15:55:12 -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 670578D0001 for ; Mon, 11 Nov 2024 15:55:12 -0500 (EST) Received: from smtpin06.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay06.hostedemail.com (Postfix) with ESMTP id 2301FAD401 for ; Mon, 11 Nov 2024 20:55:12 +0000 (UTC) X-FDA: 82775017668.06.13B6A6E Received: from mail-pj1-f46.google.com (mail-pj1-f46.google.com [209.85.216.46]) by imf01.hostedemail.com (Postfix) with ESMTP id 3641D40004 for ; Mon, 11 Nov 2024 20:54:37 +0000 (UTC) Authentication-Results: imf01.hostedemail.com; dkim=pass header.d=rivosinc-com.20230601.gappssmtp.com header.s=20230601 header.b=GuL2tsqq; spf=pass (imf01.hostedemail.com: domain of debug@rivosinc.com designates 209.85.216.46 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=1731358422; 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=IhmPwONIKNZXNlLItF/RqS4Q7SWFxV+hpF07L6+CC7I=; b=ksO8SqAXJqFaIqtJzAZ8SD31dOTCRbGn0K1W12lh9q7mlBJdC3NUcHgOyKJJicJiLtn8i/ GSm5YwgNfBG8KG6iIImrn74i3kXMPX2vsHALnLW8YwMGcWfNxzJT5yZ89K8FIpkMdUjOpH rHrpyoGVdcO+enbD/7egcWkvI8OjzgU= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1731358422; a=rsa-sha256; cv=none; b=ssrVgr3vRKK319yw4rWIhmeGsZv7TlpTTkRakItL3dV9nmpa942v3zufAIGJqLqcuEYNDL IqV8hEsVPHLTKgRrSwLn4mLRfVaQauhPlvfoSX0mx/GjIjiJWJHAzZrUPNnjKxo0i6hGxQ ylR08NE+bKTlak9y6rBgRl55DVdv9jE= ARC-Authentication-Results: i=1; imf01.hostedemail.com; dkim=pass header.d=rivosinc-com.20230601.gappssmtp.com header.s=20230601 header.b=GuL2tsqq; spf=pass (imf01.hostedemail.com: domain of debug@rivosinc.com designates 209.85.216.46 as permitted sender) smtp.mailfrom=debug@rivosinc.com; dmarc=none Received: by mail-pj1-f46.google.com with SMTP id 98e67ed59e1d1-2e2ed59a35eso4020645a91.0 for ; Mon, 11 Nov 2024 12:55:09 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=rivosinc-com.20230601.gappssmtp.com; s=20230601; t=1731358509; x=1731963309; 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=IhmPwONIKNZXNlLItF/RqS4Q7SWFxV+hpF07L6+CC7I=; b=GuL2tsqqEmRZzanrdCyxh13p2SsESjcncEXwK0v1dgtm4ks7g+35wJDxJgyR+UKRDi LpoN197e+QVgbBLPAIXIPfSiLWTyKxXjiYRfNU2Ov+3L76FFLRMbkZFSkzwrjabiXRUN 2cAmTKNiD75c7DBQvDKB2WBUsybMug/m2/PB733zeSz4XbSkYUPwZyg4DIzj51zZ1HW9 p50fQDIfz1JAnFB9RAtZB7UfzmlEgMc9QItgit0b9ntsKH4rC/yA9RAtGd0qrvN0W19H bbulNLXAs04yFiZ4pQLLDCNnfpoOg8wpb48lc/GHMBuNtQ9xAzO4Au00ovbwzydtCA42 7UEQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1731358509; x=1731963309; 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=IhmPwONIKNZXNlLItF/RqS4Q7SWFxV+hpF07L6+CC7I=; b=AO8JdmLAN+tF4DHjz3hPPGjlFUfsz77HaTOjHDo1a2lAziB8yoHeLBPj7kxklw2yHD WBbiL/1QRIL9I+godLNkEozEuZWL68ZpURWwU9loA08/Qtrv0SmYrQRoLxHrm1wsEo0m ROHPV5fhGMqT1kZTAxpYIX6qtW6+CIm7OlowwRb+SYBl1cSame43aHZg1CGYEKxavLWB Gyd7X1NVOY1CliAd0QQWdSBncZG7NjBVo/WleFXR1PVPqj1FpgVkOKLwVJarD+5eStz5 SPCNoK86DSdGOTLOKFrRe08zkHb6XH9emfRsubDz3ynE0t03cd55dd4L+U2Ax1FshyVH q3Gw== X-Forwarded-Encrypted: i=1; AJvYcCWjh3v/v6uO60gAil+ahVmqr7oMiRmdyuoO5cf7jVw3+4P8MNqS7Drm5kOLKvHztgauI8M8zdvUvg==@kvack.org X-Gm-Message-State: AOJu0YxqkDecEaYBCRQWd7PUUqySGYqIbhuKqN20kUrbSwzgqAUbXIcY Ef6vhrxW76qR7zug+dCB3LsDrCt1sfhrvwoSVk4zIQa0mmeBzBEiTzeV6fSwt2A= X-Google-Smtp-Source: AGHT+IF0EBbCrqmpMhAGCsvP469pTxbIurWJLKmyeQcT28uswVwp6gE4Luabd0L5cnP4I+jH5QjLew== X-Received: by 2002:a17:90b:4a87:b0:2e2:aef9:8f60 with SMTP id 98e67ed59e1d1-2e9b14ddb3bmr18445116a91.0.1731358508607; Mon, 11 Nov 2024 12:55:08 -0800 (PST) Received: from debug.ba.rivosinc.com ([64.71.180.162]) by smtp.gmail.com with ESMTPSA id 98e67ed59e1d1-2e9a5fd1534sm9059974a91.42.2024.11.11.12.55.06 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 11 Nov 2024 12:55:08 -0800 (PST) From: Deepak Gupta Date: Mon, 11 Nov 2024 12:54:12 -0800 Subject: [PATCH v8 27/29] riscv: Documentation for landing pad / indirect branch tracking MIME-Version: 1.0 Message-Id: <20241111-v5_user_cfi_series-v8-27-dce14aa30207@rivosinc.com> References: <20241111-v5_user_cfi_series-v8-0-dce14aa30207@rivosinc.com> In-Reply-To: <20241111-v5_user_cfi_series-v8-0-dce14aa30207@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 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-Rspamd-Server: rspam10 X-Stat-Signature: mkzriijqs4ge8scs3i66b94wwcns9syg X-Rspamd-Queue-Id: 3641D40004 X-Rspam-User: X-HE-Tag: 1731358477-554377 X-HE-Meta: U2FsdGVkX18yCqfHcPPywWm7iTKA6pMGAVhawCdRpMyzXKmKj4eCK0veU8ZSZt0StyTLg5W16fkvSofdV2sx+BAJ8PHFK/OKGA0QAobIK7P2KrWPhb/Jam1yFsAcYFDnFPykCEHNw3gv/2eO0RLH80DJ4WLWYlesNfrgqjZsqomF1MjcWQSe46HaOOHUX+9wRg1jFU5lfjjM4qqZKTpAS+QqckT5Ngm9+5byJrT3ZQ+y7a4eZaSseuMYYi6LTcQAOmqt064xjK/5rbDsvyljGQZFD4fMDTgKHzt7OHrkTDuJ+ZVC3rtQLmeSTWgdnio6Qg58tr8MmZzWv4xyx/KmsgS40vPZOYnk64C7xoJJuMnsmErI6FS4Mi4AWuECpDHX6rqprN+dDAoL53t3pK8S9Uo1nxiS+4LuDoLUvazh47lOwDNsmWxOs7ri/VbGu3piMqgIz4mSmRUr8yYcWeXKr/y9fWGydWYAzuKeLyIR2UTeNO3LUmouJE3oggNSgQ02L/6+56wWHYtZMksHpiD8YeZIWdIfMpBl2azNDSkI6BhEzDkHjGjxJ2Rm/KUa7ylQPaqDoG+ympzeMGOdkkywAsSvSIpJKa4ky99bi+NWXAHk6zBLWZQgVEfR2eXVoUMwLLmZsoRF+ZYSgWoEUL9vgijkqIi0i80H+hMYwfNjGv++n6jSzjpQbRqeefbFqZH9ekVZK54l+4qZjmeKkR9LhgdvKnA1MWeahaBAhkAuSJLvGnje56yn/nQeLj7jzcaoRG0r0adMv3RoVcttQ2g4MwVraTavnWVjjX5SOqREn5Q19idNp8tqYTTTIDQaHLIfk70j+QwcWEebEy7gChFYhF+wh7Z65eIOa+AxrtwyagQ7v7T8tj8mlknIUydIyxPI0d4PcDckXDYwN3UCgobRJAO1FxP8SNHpCyXYldZoyKOfjx4ujJzYeobgKmiEImZwifyToKGKNBk8cBsdXfA IoTpqocN oY/ZP3YE/lOU0Yj6iDa9rKXTmwTat+ptXIa8JBAGBpUIKiTQVuritvMi7M6EtArcW3iopEqYmJ+82MC7I45Am42ilONKv0i9vO9mL/Mm6VClO0eRIwKDYmzEy8hmSrW1uiNMGC3SdmHEp5sg3/k0kTyu+MDfAeZWuejlL1g2SZ0LMuojOh4OQMlP4I/6/CQdZnX7rDozteU6BOxdd5BGhYEhuvsiebqZ7PIQrG2z7+RCLjni4obOlPIanhps6nuaI4O1cfb4ia/BoEWbRpxXXpKXFXxj2RNAzuXDWcP1fiGJ0GC+m2YSW68oDUzoowBKaKaHhpwDaqYE66bVDRHDWXg5Og0VO7Z3TYC9kF/QmcMa77QnJ2FeK5f9KTwsHwfF9kQEEBi/ZoeVGdkf0iGHTHezJ3Blv7rNGjbzmcewertsnjC2LjpFjghiFEiG8pTWPTIcCUBF3zB0+gRXJCtXhJIVmhQ== 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.