Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[linux-2.6-microblaze.git] / Documentation / admin-guide / hw-vuln / special-register-buffer-data-sampling.rst
1 .. SPDX-License-Identifier: GPL-2.0
2
3 SRBDS - Special Register Buffer Data Sampling
4 =============================================
5
6 SRBDS is a hardware vulnerability that allows MDS
7 Documentation/admin-guide/hw-vuln/mds.rst techniques to
8 infer values returned from special register accesses.  Special register
9 accesses are accesses to off core registers.  According to Intel's evaluation,
10 the special register reads that have a security expectation of privacy are
11 RDRAND, RDSEED and SGX EGETKEY.
12
13 When RDRAND, RDSEED and EGETKEY instructions are used, the data is moved
14 to the core through the special register mechanism that is susceptible
15 to MDS attacks.
16
17 Affected processors
18 -------------------
19 Core models (desktop, mobile, Xeon-E3) that implement RDRAND and/or RDSEED may
20 be affected.
21
22 A processor is affected by SRBDS if its Family_Model and stepping is
23 in the following list, with the exception of the listed processors
24 exporting MDS_NO while Intel TSX is available yet not enabled. The
25 latter class of processors are only affected when Intel TSX is enabled
26 by software using TSX_CTRL_MSR otherwise they are not affected.
27
28   =============  ============  ========
29   common name    Family_Model  Stepping
30   =============  ============  ========
31   IvyBridge      06_3AH        All
32
33   Haswell        06_3CH        All
34   Haswell_L      06_45H        All
35   Haswell_G      06_46H        All
36
37   Broadwell_G    06_47H        All
38   Broadwell      06_3DH        All
39
40   Skylake_L      06_4EH        All
41   Skylake        06_5EH        All
42
43   Kabylake_L     06_8EH        <= 0xC
44   Kabylake       06_9EH        <= 0xD
45   =============  ============  ========
46
47 Related CVEs
48 ------------
49
50 The following CVE entry is related to this SRBDS issue:
51
52     ==============  =====  =====================================
53     CVE-2020-0543   SRBDS  Special Register Buffer Data Sampling
54     ==============  =====  =====================================
55
56 Attack scenarios
57 ----------------
58 An unprivileged user can extract values returned from RDRAND and RDSEED
59 executed on another core or sibling thread using MDS techniques.
60
61
62 Mitigation mechanism
63 --------------------
64 Intel will release microcode updates that modify the RDRAND, RDSEED, and
65 EGETKEY instructions to overwrite secret special register data in the shared
66 staging buffer before the secret data can be accessed by another logical
67 processor.
68
69 During execution of the RDRAND, RDSEED, or EGETKEY instructions, off-core
70 accesses from other logical processors will be delayed until the special
71 register read is complete and the secret data in the shared staging buffer is
72 overwritten.
73
74 This has three effects on performance:
75
76 #. RDRAND, RDSEED, or EGETKEY instructions have higher latency.
77
78 #. Executing RDRAND at the same time on multiple logical processors will be
79    serialized, resulting in an overall reduction in the maximum RDRAND
80    bandwidth.
81
82 #. Executing RDRAND, RDSEED or EGETKEY will delay memory accesses from other
83    logical processors that miss their core caches, with an impact similar to
84    legacy locked cache-line-split accesses.
85
86 The microcode updates provide an opt-out mechanism (RNGDS_MITG_DIS) to disable
87 the mitigation for RDRAND and RDSEED instructions executed outside of Intel
88 Software Guard Extensions (Intel SGX) enclaves. On logical processors that
89 disable the mitigation using this opt-out mechanism, RDRAND and RDSEED do not
90 take longer to execute and do not impact performance of sibling logical
91 processors memory accesses. The opt-out mechanism does not affect Intel SGX
92 enclaves (including execution of RDRAND or RDSEED inside an enclave, as well
93 as EGETKEY execution).
94
95 IA32_MCU_OPT_CTRL MSR Definition
96 --------------------------------
97 Along with the mitigation for this issue, Intel added a new thread-scope
98 IA32_MCU_OPT_CTRL MSR, (address 0x123). The presence of this MSR and
99 RNGDS_MITG_DIS (bit 0) is enumerated by CPUID.(EAX=07H,ECX=0).EDX[SRBDS_CTRL =
100 9]==1. This MSR is introduced through the microcode update.
101
102 Setting IA32_MCU_OPT_CTRL[0] (RNGDS_MITG_DIS) to 1 for a logical processor
103 disables the mitigation for RDRAND and RDSEED executed outside of an Intel SGX
104 enclave on that logical processor. Opting out of the mitigation for a
105 particular logical processor does not affect the RDRAND and RDSEED mitigations
106 for other logical processors.
107
108 Note that inside of an Intel SGX enclave, the mitigation is applied regardless
109 of the value of RNGDS_MITG_DS.
110
111 Mitigation control on the kernel command line
112 ---------------------------------------------
113 The kernel command line allows control over the SRBDS mitigation at boot time
114 with the option "srbds=".  The option for this is:
115
116   ============= =============================================================
117   off           This option disables SRBDS mitigation for RDRAND and RDSEED on
118                 affected platforms.
119   ============= =============================================================
120
121 SRBDS System Information
122 ------------------------
123 The Linux kernel provides vulnerability status information through sysfs.  For
124 SRBDS this can be accessed by the following sysfs file:
125 /sys/devices/system/cpu/vulnerabilities/srbds
126
127 The possible values contained in this file are:
128
129  ============================== =============================================
130  Not affected                   Processor not vulnerable
131  Vulnerable                     Processor vulnerable and mitigation disabled
132  Vulnerable: No microcode       Processor vulnerable and microcode is missing
133                                 mitigation
134  Mitigation: Microcode          Processor is vulnerable and mitigation is in
135                                 effect.
136  Mitigation: TSX disabled       Processor is only vulnerable when TSX is
137                                 enabled while this system was booted with TSX
138                                 disabled.
139  Unknown: Dependent on
140  hypervisor status              Running on virtual guest processor that is
141                                 affected but with no way to know if host
142                                 processor is mitigated or vulnerable.
143  ============================== =============================================
144
145 SRBDS Default mitigation
146 ------------------------
147 This new microcode serializes processor access during execution of RDRAND,
148 RDSEED ensures that the shared buffer is overwritten before it is released for
149 reuse.  Use the "srbds=off" kernel command line to disable the mitigation for
150 RDRAND and RDSEED.