Received: by 10.223.176.5 with SMTP id f5csp2838467wra; Mon, 5 Feb 2018 10:42:51 -0800 (PST) X-Google-Smtp-Source: AH8x226mDIPFS5TGJ44Zlw1fdDdVbJpxqVzuOnCGu1hC3/7W9Emkc6cDs3nBvRoSU4GotTq2Ir1e X-Received: by 10.101.74.68 with SMTP id a4mr278185pgu.176.1517856171168; Mon, 05 Feb 2018 10:42:51 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1517856171; cv=none; d=google.com; s=arc-20160816; b=J+aw+Lkjtdl4I/9rUQMzH+CcwjF7S0G8LsjEftrzZInq4974CaF4GcY4BXR0wGkm9v LZ5vCw2aYmRVr+mX8Qat0WDqA25aeR157ZKEjtAyBZ+ZgoPmZuN3w2gtToslbEmFrljb 9dvUJ++y+Y4YhxH+1TSZAeXm4KNNR/iiR+CbUbT+2F0mYMEe4HRQk+3uJzrf1fPR42ay slm+pYJNvgqoZpY3DJOAX5lSSAke/EJoAqHtdLl0ToQODVI9eE+cgFvG//Gta1eYKT/W yuGRllWbYSU2yQFTHNWHNJfgL6fEnxOqu+Btp8bFoImq6NV9FVfdoXrgWmtKLVoLQzwV xmbg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:mime-version:user-agent:references :in-reply-to:message-id:date:subject:cc:to:from :arc-authentication-results; bh=ZHt1iEDDAiDX0hkb4AQJ236JTwHif7x3jhAEA78QzxI=; b=hKFoy4Aq17UxkPda1Oxqsu7rjqkoxA+mjBMDFvKt29i6NMwvFdy1ptCOP1nJURbf8Z IfbpS2nt6tX0cPP+C+5r0XgDsvmUTgconIEjfaC89EBRUYf+OoaMqj3w5CoCLxosqS2l 0QWvY5Yb9S2X2z7Jpj4fq7OJqbB5/fKgj2OLyURvbE5yNkGjq1/JbpI0hJ7rMW0Y8miT rHWDksRPmfZeVhjrEJkCMn1PY8eJAmknR6N3NpKpA+7GNsp1xdLru7XSeDCuyqIWswE5 0hkTUpR3Kgwkny//XwQxOFOwZbjezpj1taxa0ZUKfESzwwj/0pIfNEtSRYgy8aUUSvUU d+yw== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id 9-v6si7294202plb.509.2018.02.05.10.42.37; Mon, 05 Feb 2018 10:42:51 -0800 (PST) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753916AbeBES0a (ORCPT + 99 others); Mon, 5 Feb 2018 13:26:30 -0500 Received: from mail.linuxfoundation.org ([140.211.169.12]:51494 "EHLO mail.linuxfoundation.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753512AbeBESYO (ORCPT ); Mon, 5 Feb 2018 13:24:14 -0500 Received: from localhost (unknown [104.132.1.108]) by mail.linuxfoundation.org (Postfix) with ESMTPSA id 5E200109E; Mon, 5 Feb 2018 18:24:06 +0000 (UTC) From: Greg Kroah-Hartman To: linux-kernel@vger.kernel.org Cc: Greg Kroah-Hartman , stable@vger.kernel.org, Mark Rutland , Will Deacon , Dan Williams , Thomas Gleixner , Kees Cook , linux-arch@vger.kernel.org, Jonathan Corbet , Peter Zijlstra , kernel-hardening@lists.openwall.com, torvalds@linux-foundation.org, alan@linux.intel.com Subject: [PATCH 4.14 36/64] Documentation: Document array_index_nospec Date: Mon, 5 Feb 2018 10:22:55 -0800 Message-Id: <20180205182140.060710592@linuxfoundation.org> X-Mailer: git-send-email 2.16.1 In-Reply-To: <20180205182138.571333346@linuxfoundation.org> References: <20180205182138.571333346@linuxfoundation.org> User-Agent: quilt/0.65 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 4.14-stable review patch. If anyone has any objections, please let me know. ------------------ From: Mark Rutland mark.rutland@arm.com commit f84a56f73dddaeac1dba8045b007f742f61cd2da Document the rationale and usage of the new array_index_nospec() helper. Signed-off-by: Mark Rutland Signed-off-by: Will Deacon Signed-off-by: Dan Williams Signed-off-by: Thomas Gleixner Reviewed-by: Kees Cook Cc: linux-arch@vger.kernel.org Cc: Jonathan Corbet Cc: Peter Zijlstra Cc: gregkh@linuxfoundation.org Cc: kernel-hardening@lists.openwall.com Cc: torvalds@linux-foundation.org Cc: alan@linux.intel.com Link: https://lkml.kernel.org/r/151727413645.33451.15878817161436755393.stgit@dwillia2-desk3.amr.corp.intel.com Signed-off-by: Greg Kroah-Hartman --- Documentation/speculation.txt | 90 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 90 insertions(+) --- /dev/null +++ b/Documentation/speculation.txt @@ -0,0 +1,90 @@ +This document explains potential effects of speculation, and how undesirable +effects can be mitigated portably using common APIs. + +=========== +Speculation +=========== + +To improve performance and minimize average latencies, many contemporary CPUs +employ speculative execution techniques such as branch prediction, performing +work which may be discarded at a later stage. + +Typically speculative execution cannot be observed from architectural state, +such as the contents of registers. However, in some cases it is possible to +observe its impact on microarchitectural state, such as the presence or +absence of data in caches. Such state may form side-channels which can be +observed to extract secret information. + +For example, in the presence of branch prediction, it is possible for bounds +checks to be ignored by code which is speculatively executed. Consider the +following code: + + int load_array(int *array, unsigned int index) + { + if (index >= MAX_ARRAY_ELEMS) + return 0; + else + return array[index]; + } + +Which, on arm64, may be compiled to an assembly sequence such as: + + CMP , #MAX_ARRAY_ELEMS + B.LT less + MOV , #0 + RET + less: + LDR , [, ] + RET + +It is possible that a CPU mis-predicts the conditional branch, and +speculatively loads array[index], even if index >= MAX_ARRAY_ELEMS. This +value will subsequently be discarded, but the speculated load may affect +microarchitectural state which can be subsequently measured. + +More complex sequences involving multiple dependent memory accesses may +result in sensitive information being leaked. Consider the following +code, building on the prior example: + + int load_dependent_arrays(int *arr1, int *arr2, int index) + { + int val1, val2, + + val1 = load_array(arr1, index); + val2 = load_array(arr2, val1); + + return val2; + } + +Under speculation, the first call to load_array() may return the value +of an out-of-bounds address, while the second call will influence +microarchitectural state dependent on this value. This may provide an +arbitrary read primitive. + +==================================== +Mitigating speculation side-channels +==================================== + +The kernel provides a generic API to ensure that bounds checks are +respected even under speculation. Architectures which are affected by +speculation-based side-channels are expected to implement these +primitives. + +The array_index_nospec() helper in can be used to +prevent information from being leaked via side-channels. + +A call to array_index_nospec(index, size) returns a sanitized index +value that is bounded to [0, size) even under cpu speculation +conditions. + +This can be used to protect the earlier load_array() example: + + int load_array(int *array, unsigned int index) + { + if (index >= MAX_ARRAY_ELEMS) + return 0; + else { + index = array_index_nospec(index, MAX_ARRAY_ELEMS); + return array[index]; + } + }