bump to v0.37

A report of all vulnerable machines to be produced with a query such as:

    spexec_vuln_status{status!="OK"}

README.md

@@ -1,12 +1,57 @@
 Spectre & Meltdown Checker
 ==========================
 
-A simple shell script to tell if your Linux installation is vulnerable against the 3 "speculative execution" CVEs.
+A shell script to tell if your system is vulnerable against the 3 "speculative execution" CVEs that were made public early 2018.
 
-Without options, it'll inspect you currently running kernel. 
+Supported operating systems:
-You can also specify a kernel image on the command line, if you'd like to inspect a kernel you're not running.
+- Linux (all versions, flavors and distros)
+- BSD (FreeBSD, NetBSD, DragonFlyBSD)
 
-The script will do its best to detect mitigations, including backported non-vanilla patches, regardless of the advertised kernel version number.
+Supported architectures:
+- x86 (32 bits)
+- amd64/x86_64 (64 bits)
+- ARM and ARM64
+- other architectures will work, but mitigations (if they exist) might not always be detected
+
+For Linux systems, the script will detect mitigations, including backported non-vanilla patches, regardless of the advertised kernel version number and the distribution (such as Debian, Ubuntu, CentOS, RHEL, Fedora, openSUSE, Arch, ...), it also works if you've compiled your own kernel.
+
+For BSD systems, the detection will work as long as the BSD you're using supports `cpuctl` and `linprocfs` (this is not the case of OpenBSD for example).
+
+## Easy way to run the script
+
+- Get the latest version of the script using `curl` *or* `wget`
+
+```bash
+curl -L https://meltdown.ovh -o spectre-meltdown-checker.sh
+wget https://meltdown.ovh -O spectre-meltdown-checker.sh
+```
+
+- Inspect the script. You never blindly run scripts you downloaded from the Internet, do you?
+
+```bash
+vim spectre-meltdown-checker.sh
+```
+
+- When you're ready, run the script as root
+
+```bash
+chmod +x spectre-meltdown-checker.sh
+sudo ./spectre-meltdown-checker.sh
+```
+
+## Example of script output
+
+- Intel Haswell CPU running under Ubuntu 16.04 LTS
+
+![haswell](https://framapic.org/1kWmNwE6ll0p/ayTRX9JRlHJ7.png)
+
+- AMD Ryzen running under OpenSUSE Tumbleweed
+
+![ryzen](https://framapic.org/TkWbuh421YQR/6MAGUP3lL6Ne.png)
+
+- Batch mode (JSON flavor)
+
+![batch](https://framapic.org/HEcWFPrLewbs/om1LdufspWTJ.png)
 
 ## Quick summary of the CVEs
 
@@ -29,68 +74,15 @@ The script will do its best to detect mitigations, including backported non-vani
    - Mitigation: updated kernel (with PTI/KPTI patches), updating the kernel is enough
    - Performance impact of the mitigation: low to medium
 
-## Example of script output
+## Disclaimer
 
-### Ubuntu LTS (before official patches)
+This tool does its best to determine whether your system is immune (or has proper mitigations in place) for the collectively named "speculative execution" vulnerabilities. It doesn't attempt to run any kind of exploit, and can't guarantee that your system is secure, but rather helps you verifying whether your system has the known correct mitigations in place.
+However, some mitigations could also exist in your kernel that this script doesn't know (yet) how to detect, or it might falsely detect mitigations that in the end don't work as expected (for example, on backported or modified kernels).
 
-```
+Your system exposure also depends on your CPU. As of now, AMD and ARM processors are marked as immune to some or all of these vulnerabilities (except some specific ARM models). All Intel processors manufactured since circa 1995 are thought to be vulnerable, except some specific/old models, such as some early Atoms. Whatever processor one uses, one might seek more information from the manufacturer of that processor and/or of the device in which it runs.
-$ sudo ./spectre-and-meltdown.sh
-Spectre and Meltdown mitigation detection tool v0.16
 
-Checking for vulnerabilities against live running kernel Linux 4.4.0-104-generic #127-Ubuntu SMP Mon Dec 11 12:16:42 UTC 2017 x86_64
+The nature of the discovered vulnerabilities being quite new, the landscape of vulnerable processors can be expected to change over time, which is why this script makes the assumption that all CPUs are vulnerable, except if the manufacturer explicitly stated otherwise in a verifiable public announcement.
-Will use vmlinux image /boot/vmlinuz-4.4.0-104-generic
-Will use kconfig /boot/config-4.4.0-104-generic
-Will use System.map file /boot/System.map-4.4.0-104-generic
 
-CVE-2017-5753 [bounds check bypass] aka 'Spectre Variant 1'
+Please also note that for Spectre vulnerabilities, all software can possibly be exploited, this tool only verifies that the kernel (which is the core of the system) you're using has the proper protections in place. Verifying all the other software is out of the scope of this tool. As a general measure, ensure you always have the most up to date stable versions of all the software you use, especially for those who are exposed to the world, such as network daemons and browsers.
-* Kernel compiled with LFENCE opcode inserted at the proper places:  NO  (only 38 opcodes found, should be >= 70)
-> STATUS:  VULNERABLE 
 
-CVE-2017-5715 [branch target injection] aka 'Spectre Variant 2'
+This tool has been released in the hope that it'll be useful, but don't use it to jump to conclusions about your security.
-* Mitigation 1
-*   Hardware (CPU microcode) support for mitigation:  NO 
-*   Kernel support for IBRS:  NO 
-*   IBRS enabled for Kernel space:  NO 
-*   IBRS enabled for User space:  NO 
-* Mitigation 2
-*   Kernel compiled with retpoline option:  NO 
-*   Kernel compiled with a retpoline-aware compiler:  NO 
-> STATUS:  VULNERABLE  (IBRS hardware + kernel support OR kernel with retpoline are needed to mitigate the vulnerability)
-
-CVE-2017-5754 [rogue data cache load] aka 'Meltdown' aka 'Variant 3'
-* Kernel supports Page Table Isolation (PTI):  NO 
-* PTI enabled and active:  NO 
-> STATUS:  VULNERABLE  (PTI is needed to mitigate the vulnerability)
-```
-
-### First patched kernel of RHEL6
-
-```
-$ sudo ./spectre-meltdown-checker.sh --kernel /tmp/vmlinuz-2.6.32-696.18.7.el6.x86_64 --config /tmp/config-2.6.32-696.18.7.el6.x86_64 --map /tmp/System.map-2.6.32-696.18.7.el6.x86_64
-Spectre and Meltdown mitigation detection tool v0.16
-
-Checking for vulnerabilities against specified kernel
-Will use vmlinux image /tmp/vmlinuz-2.6.32-696.18.7.el6.x86_64
-Will use kconfig /tmp/config-2.6.32-696.18.7.el6.x86_64
-Will use System.map file /tmp/System.map-2.6.32-696.18.7.el6.x86_64
-
-CVE-2017-5753 [bounds check bypass] aka 'Spectre Variant 1'
-* Kernel compiled with LFENCE opcode inserted at the proper places:  YES  (84 opcodes found, which is >= 70)
-> STATUS:  NOT VULNERABLE 
-
-CVE-2017-5715 [branch target injection] aka 'Spectre Variant 2'
-* Mitigation 1
-*   Hardware (CPU microcode) support for mitigation:  NO 
-*   Kernel support for IBRS:  YES 
-*   IBRS enabled for Kernel space:  N/A  (not testable in offline mode)
-*   IBRS enabled for User space:  N/A  (not testable in offline mode)
-* Mitigation 2
-*   Kernel compiled with retpoline option:  NO 
-*   Kernel compiled with a retpoline-aware compiler:  NO 
-> STATUS:  NOT VULNERABLE  (offline mode: IBRS will mitigate the vulnerability if enabled at runtime)
-
-CVE-2017-5754 [rogue data cache load] aka 'Meltdown' aka 'Variant 3'
-* Kernel supports Page Table Isolation (PTI):  YES 
-* PTI enabled and active:  N/A  (can't verify if PTI is enabled in offline mode)
-> STATUS:  NOT VULNERABLE  (offline mode: PTI will mitigate the vulnerability if enabled at runtime)
-```