bump to v0.27

We were saying unknown instead of vulnerable when the count of lfence opcodes was low
This was not impacting batch mode or the final decision, just the human-readable output of the script.

README.md

@@ -1,16 +1,16 @@
 Spectre & Meltdown Checker
 ==========================
 
-A simple shell script to tell if your Linux installation is vulnerable against the 3 "speculative execution" CVEs.
+A simple shell script to tell if your Linux installation is vulnerable against the 3 "speculative execution" CVEs that were made public early 2018.
 
-Without options, it'll inspect you currently running kernel. 
+Without options, it'll inspect your currently running kernel. 
 You can also specify a kernel image on the command line, if you'd like to inspect a kernel you're not running.
 
 The script will do its best to detect mitigations, including backported non-vanilla patches, regardless of the advertised kernel version number.
 
 ## Example of script output
 
-![checker](https://framapic.org/FjroIZximyoM/EO5msoSMKb6L.png)
+![checker](https://framapic.org/6O4v4AAwMenv/M6J4CFWwsB3z.png)
 
 ## Quick summary of the CVEs
 
@@ -32,3 +32,14 @@ The script will do its best to detect mitigations, including backported non-vani
    - Impact: Kernel
    - Mitigation: updated kernel (with PTI/KPTI patches), updating the kernel is enough
    - Performance impact of the mitigation: low to medium
+
+## Disclaimer
+
+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. Whatever processor one uses, one might seek more information from the manufacturer of that processor and/or of the device in which it runs.
+
+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 explicitely stated otherwise in a verifiable public announcement.
+
+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.

spectre-meltdown-checker.sh

@@ -8,7 +8,7 @@
 #
 # Stephane Lesimple
 #
-VERSION=0.22
+VERSION=0.27
 
 # Script configuration
 show_usage()
@@ -33,8 +33,10 @@ show_usage()
 
 	Options:
 		--no-color			Don't use color codes
-		-v, --verbose			Increase verbosity level
+		--verbose, -v			Increase verbosity level
+		--no-sysfs			Don't use the /sys interface even if present
 		--batch text			Produce machine readable output, this is the default if --batch is specified alone
+		--batch json			Produce JSON output formatted for Puppet, Ansible, Chef...
 		--batch nrpe			Produce machine readable output formatted for NRPE
 		--variant [1,2,3]		Specify which variant you'd like to check, by default all variants are checked
 						Can be specified multiple times (e.g. --variant 2 --variant 3)
@@ -85,6 +87,7 @@ opt_variant1=0
 opt_variant2=0
 opt_variant3=0
 opt_allvariants=1
+opt_no_sysfs=0
 
 nrpe_critical=0
 nrpe_unknown=0
@@ -94,13 +97,13 @@ __echo()
 {
 	opt="$1"
 	shift
-	msg="$@"
+	_msg="$@"
 	if [ "$opt_no_color" = 1 ] ; then
 		# strip ANSI color codes
-		msg=$(/bin/echo -e  "$msg" | sed -r "s/\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]//g")
+		_msg=$(/bin/echo -e  "$_msg" | sed -r "s/\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]//g")
 	fi
 	# explicitely call /bin/echo to avoid shell builtins that might not take options
-	/bin/echo $opt -e "$msg"
+	/bin/echo $opt -e "$_msg"
 }
 
 _echo()
@@ -121,7 +124,7 @@ _echo_nol()
 
 _warn()
 {
-	_echo 0 "\033[31m${@}\033[0m"
+	_echo 0 "\033[31m${@}\033[0m" >&2
 }
 
 _info()
@@ -139,6 +142,11 @@ _verbose()
 	_echo 2 "$@"
 }
 
+_debug()
+{
+	_echo 3 "(debug) $@"
+}
+
 is_cpu_vulnerable()
 {
 	# param: 1, 2 or 3 (variant)
@@ -213,7 +221,7 @@ parse_opt_file()
 		show_header
 		echo "$0: error: $option_value is not a file" >&2
 		exit 1
-	elif [ ! -e "$option_value" ]; then
+	elif [ ! -r "$option_value" ]; then
 		show_header
 		echo "$0: error: couldn't read $option_value (are you root?)" >&2
 		exit 1
@@ -244,17 +252,20 @@ while [ -n "$1" ]; do
 	elif [ "$1" = "--no-color" ]; then
 		opt_no_color=1
 		shift
+	elif [ "$1" = "--no-sysfs" ]; then
+		opt_no_sysfs=1
+		shift
 	elif [ "$1" = "--batch" ]; then
 		opt_batch=1
 		opt_verbose=0
 		shift
 		case "$1" in
-			text|nrpe) opt_batch_format="$1"; shift;;
+			text|nrpe|json) opt_batch_format="$1"; shift;;
 			--*) ;;    # allow subsequent flags
 			'') ;;     # allow nothing at all
 			*)
 				echo "$0: error: unknown batch format '$1'"
-				echo "$0: error: --batch expects a format from: text, nrpe"
+				echo "$0: error: --batch expects a format from: text, nrpe, json"
 				exit 1 >&2
 				;;
 		esac
@@ -325,6 +336,19 @@ pvulnstatus()
                                        VULN) nrpe_critical="1"; nrpe_vuln="$nrpe_vuln $1";;
                               esac
                               ;;
+                        json)
+                              case "$1" in
+                                       CVE-2017-5753) aka="SPECTRE VARIANT 1";;
+                                       CVE-2017-5715) aka="SPECTRE VARIANT 2";;
+                                       CVE-2017-5754) aka="MELTDOWN";;
+                              esac
+                              case "$2" in
+                                       UKN)  is_vuln="unknown";;
+                                       VULN) is_vuln="true";;
+                                       OK)   is_vuln="false";;
+                              esac
+                              json_output="${json_output:-[}{\"NAME\":\""$aka"\",\"CVE\":\""$1"\",\"VULNERABLE\":$is_vuln,\"INFOS\":\""$3"\"},"
+                              ;;
 		esac
 	fi
 
@@ -359,7 +383,7 @@ vmlinux=''
 vmlinux_err=''
 check_vmlinux()
 {
-	readelf -h $1 > /dev/null 2>&1 || return 1
+	readelf -h "$1" > /dev/null 2>&1 || return 1
 	return 0
 }
 
@@ -369,15 +393,22 @@ try_decompress()
 	# "grep" that report the byte offset of the line instead of the pattern.
 
 	# Try to find the header ($1) and decompress from here
-	for     pos in `tr "$1\n$2" "\n$2=" < "$5" | grep -abo "^$2"`
+	for     pos in `tr "$1\n$2" "\n$2=" < "$6" | grep -abo "^$2"`
 	do
-		if ! which $3 >/dev/null 2>&1; then
-			vmlinux_err="missing '$3' tool, please install it, usually it's in the '$4' package"
+		_debug "try_decompress: magic for $3 found at offset $pos"
+		if ! which "$3" >/dev/null 2>&1; then
+			vmlinux_err="missing '$3' tool, please install it, usually it's in the '$5' package"
 			return 0
 		fi
 		pos=${pos%%:*}
-		tail -c+$pos "$5" | $3 > $vmlinuxtmp 2> /dev/null
-		check_vmlinux "$vmlinuxtmp" && vmlinux=$vmlinuxtmp && return 0
+		tail -c+$pos "$6" 2>/dev/null | $3 $4 > $vmlinuxtmp 2>/dev/null
+		if check_vmlinux "$vmlinuxtmp"; then
+			vmlinux="$vmlinuxtmp"
+			_debug "try_decompress: decompressed with $3 successfully!"
+			return 0
+		else
+			_debug "try_decompress: decompression with $3 did not work"
+		fi
 	done
 	return 1
 }
@@ -397,11 +428,12 @@ extract_vmlinux()
 	fi
 
 	# That didn't work, so retry after decompression.
-	try_decompress '\037\213\010' xy    gunzip     gunzip	"$1" && return 0
-	try_decompress '\3757zXZ\000' abcde unxz       xz-utils	"$1" && return 0
-	try_decompress 'BZh'          xy    bunzip2    bzip2	"$1" && return 0
-	try_decompress '\135\0\0\0'   xxx   unlzma     xz-utils	"$1" && return 0
-	try_decompress '\211\114\132' xy    'lzop -d'  lzop	"$1" && return 0
+	try_decompress '\037\213\010'     xy    gunzip  ''      gunzip      "$1" && return 0
+	try_decompress '\3757zXZ\000'     abcde unxz    ''      xz-utils    "$1" && return 0
+	try_decompress 'BZh'              xy    bunzip2 ''      bzip2       "$1" && return 0
+	try_decompress '\135\0\0\0'       xxx   unlzma  ''      xz-utils    "$1" && return 0
+	try_decompress '\211\114\132'     xy    'lzop'  '-d'    lzop        "$1" && return 0
+	try_decompress '\002\041\114\030' xyy   'lz4'   '-d -l' liblz4-tool "$1" && return 0
 	return 1
 }
 
@@ -428,12 +460,25 @@ if [ "$opt_live" = 1 ]; then
 	_info "Checking for vulnerabilities against live running kernel \033[35m"$(uname -s) $(uname -r) $(uname -v) $(uname -m)"\033[0m"
 
 	# try to find the image of the current running kernel
+	# first, look for the BOOT_IMAGE hint in the kernel cmdline
+	if [ -r /proc/cmdline ] && grep -q 'BOOT_IMAGE=' /proc/cmdline; then
+		opt_kernel=$(grep -Eo 'BOOT_IMAGE=[^ ]+' /proc/cmdline | cut -d= -f2)
+		_debug "found opt_kernel=$opt_kernel in /proc/cmdline"
+		# if we have a dedicated /boot partition, our bootloader might have just called it /
+		# so try to prepend /boot and see if we find anything
+		[ -e "/boot/$opt_kernel" ] && opt_kernel="/boot/$opt_kernel"
+		_debug "opt_kernel is now $opt_kernel"
+		# else, the full path is already there (most probably /boot/something)
+	fi
+	# if we didn't find a kernel, default to guessing
+	if [ ! -e "$opt_kernel" ]; then
 		[ -e /boot/vmlinuz-linux       ] && opt_kernel=/boot/vmlinuz-linux
 		[ -e /boot/vmlinuz-linux-libre ] && opt_kernel=/boot/vmlinuz-linux-libre
 		[ -e /boot/vmlinuz-$(uname -r) ] && opt_kernel=/boot/vmlinuz-$(uname -r)
 		[ -e /boot/kernel-$( uname -r) ] && opt_kernel=/boot/kernel-$( uname -r)
 		[ -e /boot/bzImage-$(uname -r) ] && opt_kernel=/boot/bzImage-$(uname -r)
 		[ -e /boot/kernel-genkernel-$(uname -m)-$(uname -r) ] && opt_kernel=/boot/kernel-genkernel-$(uname -m)-$(uname -r)
+	fi
 
 	# system.map
 	if [ -e /proc/kallsyms ] ; then
@@ -508,46 +553,83 @@ umount_debugfs()
 	fi
 }
 
+sys_interface_check()
+{
+	[ "$opt_live" = 1 -a "$opt_no_sysfs" = 0 -a -r "$1" ] || return 1
+	_info_nol "* Checking wheter we're safe according to the /sys interface: "
+	if grep -qi '^not affected' "$1"; then
+		# Not affected
+		status=OK
+		pstatus green YES "kernel confirms that your CPU is unaffected"
+	elif grep -qi '^mitigation' "$1"; then
+		# Mitigation: PTI
+		status=OK
+		pstatus green YES "kernel confirms that the mitigation is active"
+	elif grep -qi '^vulnerable' "$1"; then
+		# Vulnerable
+		status=VULN
+		pstatus red NO "kernel confirms your system is vulnerable"
+	else
+		status=UNK
+		pstatus yellow UNKNOWN "unknown value reported by kernel"
+	fi
+	msg=$(cat "$1")
+	return 0
+}
+
 ###################
 # SPECTRE VARIANT 1
 check_variant1()
 {
 	_info "\033[1;34mCVE-2017-5753 [bounds check bypass] aka 'Spectre Variant 1'\033[0m"
-	_info_nol "* Checking count of LFENCE opcodes in kernel: "
 
-	status=0
+	status=UNK
+	sys_interface_available=0
+	msg=''
+	if sys_interface_check "/sys/devices/system/cpu/vulnerabilities/spectre_v1"; then
+		# this kernel has the /sys interface, trust it over everything
+		sys_interface_available=1
+	else
+		# no /sys interface (or offline mode), fallback to our own ways
+		_info_nol "* Checking count of LFENCE opcodes in kernel: "
 		if [ -n "$vmlinux_err" ]; then
-		pstatus yellow UNKNOWN "$vmlinux_err"
+			msg="couldn't check ($vmlinux_err)"
+			status=UNK
+			pstatus yellow UNKNOWN
 		else
 			if ! which objdump >/dev/null 2>&1; then
-			pstatus yellow UNKNOWN "missing 'objdump' tool, please install it, usually it's in the binutils package"
+				msg="missing 'objdump' tool, please install it, usually it's in the binutils package"
+				status=UNK
+				pstatus yellow UNKNOWN
 			else
 				# here we disassemble the kernel and count the number of occurences of the LFENCE opcode
 				# in non-patched kernels, this has been empirically determined as being around 40-50
 				# in patched kernels, this is more around 70-80, sometimes way higher (100+)
 				# v0.13: 68 found in a 3.10.23-xxxx-std-ipv6-64 (with lots of modules compiled-in directly), which doesn't have the LFENCE patches,
 				# so let's push the threshold to 70.
-			# TODO LKML patch is starting to dump LFENCE in favor of the PAUSE opcode, we might need to check that (patch not stabilized yet)
-			nb_lfence=$(objdump -D "$vmlinux" | grep -wc lfence)
+				nb_lfence=$(objdump -d "$vmlinux" | grep -wc lfence)
 				if [ "$nb_lfence" -lt 70 ]; then
-				pstatus red NO "only $nb_lfence opcodes found, should be >= 70"
-				status=1
+					msg="only $nb_lfence opcodes found, should be >= 70, heuristic to be improved when official patches become available"
+					status=VULN
+					pstatus red NO
 				else
-				pstatus green YES "$nb_lfence opcodes found, which is >= 70"
-				status=2
+					msg="$nb_lfence opcodes found, which is >= 70, heuristic to be improved when official patches become available"
+					status=OK
+					pstatus green YES
+				fi
 			fi
 		fi
 	fi
 
-	if ! is_cpu_vulnerable 1; then
-		pvulnstatus CVE-2017-5753 OK "your CPU vendor reported your CPU model as not vulnerable"
-	else
-		case "$status" in
-			0) pvulnstatus CVE-2017-5753 UNK "impossible to check ${vmlinux}";;
-			1) pvulnstatus CVE-2017-5753 VULN 'heuristic to be improved when official patches become available';;
-			2) pvulnstatus CVE-2017-5753 OK 'heuristic to be improved when official patches become available';;
-		esac
+	# if we have the /sys interface, don't even check is_cpu_vulnerable ourselves, the kernel already does it
+	if [ "$sys_interface_available" = 0 ] && ! is_cpu_vulnerable 1; then
+		# override status & msg in case CPU is not vulnerable after all
+		msg="your CPU vendor reported your CPU model as not vulnerable"
+		status=OK
 	fi
+
+	# report status
+	pvulnstatus CVE-2017-5753 "$status" "$msg"
 }
 
 ###################
@@ -555,6 +637,14 @@ check_variant1()
 check_variant2()
 {
 	_info "\033[1;34mCVE-2017-5715 [branch target injection] aka 'Spectre Variant 2'\033[0m"
+
+	status=UNK
+	sys_interface_available=0
+	msg=''
+	if sys_interface_check "/sys/devices/system/cpu/vulnerabilities/spectre_v2"; then
+		# this kernel has the /sys interface, trust it over everything
+		sys_interface_available=1
+	else
 		_info "* Mitigation 1"
 		_info_nol "*   Hardware (CPU microcode) support for mitigation: "
 		if [ ! -e /dev/cpu/0/msr ]; then
@@ -583,17 +673,21 @@ check_variant2()
 		_info_nol "*   Kernel support for IBRS: "
 		if [ "$opt_live" = 1 ]; then
 			mount_debugfs
-		if [ -e /sys/kernel/debug/ibrs_enabled ]; then
+			for ibrs_file in \
+				/sys/kernel/debug/ibrs_enabled \
+				/sys/kernel/debug/x86/ibrs_enabled \
+				/proc/sys/kernel/ibrs_enabled; do
+				if [ -e "$ibrs_file" ]; then
 					# if the file is there, we have IBRS compiled-in
+					# /sys/kernel/debug/ibrs_enabled: vanilla
+					# /sys/kernel/debug/x86/ibrs_enabled: RedHat (see https://access.redhat.com/articles/3311301)
+					# /proc/sys/kernel/ibrs_enabled: OpenSUSE tumbleweed
 					pstatus green YES
 					ibrs_supported=1
-			ibrs_enabled=$(cat /sys/kernel/debug/ibrs_enabled 2>/dev/null)
-		elif [ -e /sys/kernel/debug/x86/ibrs_enabled ]; then
-			# RedHat uses a different path (see https://access.redhat.com/articles/3311301)
-			pstatus green YES
-			ibrs_supported=1
-			ibrs_enabled=$(cat /sys/kernel/debug/x86/ibrs_enabled 2>/dev/null)
+					ibrs_enabled=$(cat "$ibrs_file" 2>/dev/null)
+					break
 				fi
+			done
 		fi
 		if [ "$ibrs_supported" != 1 -a -n "$opt_map" ]; then
 			if grep -q spec_ctrl "$opt_map"; then
@@ -681,10 +775,15 @@ check_variant2()
 		else
 			pstatus yellow UNKNOWN "couldn't find your kernel image or System.map"
 		fi
+	fi
 
-	if ! is_cpu_vulnerable 2; then
+	# if we have the /sys interface, don't even check is_cpu_vulnerable ourselves, the kernel already does it
+	if [ "$sys_interface_available" = 0 ] && ! is_cpu_vulnerable 2; then
+		# override status & msg in case CPU is not vulnerable after all
 		pvulnstatus CVE-2017-5715 OK "your CPU vendor reported your CPU model as not vulnerable"
-	elif [ "$retpoline" = 1 -a "$retpoline_compiler" = 1 ]; then
+	elif [ -z "$msg" ]; then
+		# if msg is empty, sysfs check didn't fill it, rely on our own test
+		if [ "$retpoline" = 1 -a "$retpoline_compiler" = 1 ]; then
 			pvulnstatus CVE-2017-5715 OK "retpoline mitigate the vulnerability"
 		elif [ "$opt_live" = 1 ]; then
 			if [ "$ibrs_enabled" = 1 -o "$ibrs_enabled" = 2 ]; then
@@ -699,6 +798,9 @@ check_variant2()
 				pvulnstatus CVE-2017-5715 VULN "IBRS hardware + kernel support OR kernel with retpoline are needed to mitigate the vulnerability"
 			fi
 		fi
+	else
+		pvulnstatus CVE-2017-5715 "$status" "$msg"
+	fi
 }
 
 ########################
@@ -706,6 +808,14 @@ check_variant2()
 check_variant3()
 {
 	_info "\033[1;34mCVE-2017-5754 [rogue data cache load] aka 'Meltdown' aka 'Variant 3'\033[0m"
+
+	status=UNK
+	sys_interface_available=0
+	msg=''
+	if sys_interface_check "/sys/devices/system/cpu/vulnerabilities/meltdown"; then
+		# this kernel has the /sys interface, trust it over everything
+		sys_interface_available=1
+	else
 		_info_nol "* Kernel supports Page Table Isolation (PTI): "
 		kpti_support=0
 		kpti_can_tell=0
@@ -747,6 +857,9 @@ check_variant3()
 		mount_debugfs
 		_info_nol "* PTI enabled and active: "
 		if [ "$opt_live" = 1 ]; then
+			dmesg_grep="Kernel/User page tables isolation: enabled"
+			dmesg_grep="$dmesg_grep|Kernel page table isolation enabled"
+			dmesg_grep="$dmesg_grep|x86/pti: Unmapping kernel while in userspace"
 			if grep ^flags /proc/cpuinfo | grep -qw pti; then
 				# vanilla PTI patch sets the 'pti' flag in cpuinfo
 				kpti_enabled=1
@@ -756,10 +869,10 @@ check_variant3()
 			elif [ -e /sys/kernel/debug/x86/pti_enabled ]; then
 				# RedHat Backport creates a dedicated file, see https://access.redhat.com/articles/3311301
 				kpti_enabled=$(cat /sys/kernel/debug/x86/pti_enabled 2>/dev/null)
-		elif dmesg | grep -Eq 'Kernel/User page tables isolation: enabled|Kernel page table isolation enabled'; then
+			elif dmesg | grep -Eq "$dmesg_grep"; then
 				# if we can't find the flag, grep dmesg output
 				kpti_enabled=1
-		elif [ -r /var/log/dmesg ] && grep -Eq 'Kernel/User page tables isolation: enabled|Kernel page table isolation enabled' /var/log/dmesg; then
+			elif [ -r /var/log/dmesg ] && grep -Eq "$dmesg_grep" /var/log/dmesg; then
 				# if we can't find the flag in dmesg output, grep in /var/log/dmesg when readable
 				kpti_enabled=1
 			else
@@ -773,22 +886,31 @@ check_variant3()
 		else
 			pstatus blue N/A "can't verify if PTI is enabled in offline mode"
 		fi
+	fi
 
-	if ! is_cpu_vulnerable 3; then
-		pvulnstatus CVE-2017-5754 OK "your CPU vendor reported your CPU model as not vulnerable"
-	elif [ "$opt_live" = 1 ]; then
+	# if we have the /sys interface, don't even check is_cpu_vulnerable ourselves, the kernel already does it
+	cve='CVE-2017-5754'
+	if [ "$sys_interface_available" = 0 ] && ! is_cpu_vulnerable 3; then
+		# override status & msg in case CPU is not vulnerable after all
+		pvulnstatus $cve OK "your CPU vendor reported your CPU model as not vulnerable"
+	elif [ -z "$msg" ]; then
+		# if msg is empty, sysfs check didn't fill it, rely on our own test
+		if [ "$opt_live" = 1 ]; then
 			if [ "$kpti_enabled" = 1 ]; then
-			pvulnstatus CVE-2017-5754 OK "PTI mitigates the vulnerability"
+				pvulnstatus $cve OK "PTI mitigates the vulnerability"
 			else
-			pvulnstatus CVE-2017-5754 VULN "PTI is needed to mitigate the vulnerability"
+				pvulnstatus $cve VULN "PTI is needed to mitigate the vulnerability"
 			fi
 		else
 			if [ "$kpti_support" = 1 ]; then
-			pvulnstatus CVE-2017-5754 OK "offline mode: PTI will mitigate the vulnerability if enabled at runtime"
+				pvulnstatus $cve OK "offline mode: PTI will mitigate the vulnerability if enabled at runtime"
 			else
-			pvulnstatus CVE-2017-5754 VULN "PTI is needed to mitigate the vulnerability"
+				pvulnstatus $cve VULN "PTI is needed to mitigate the vulnerability"
 			fi
 		fi
+	else
+		pvulnstatus $cve "$status" "$msg"
+	fi
 }
 
 # now run the checks the user asked for
@@ -823,3 +945,7 @@ if [ "$opt_batch" = 1 -a "$opt_batch_format" = "nrpe" ]; then
 	[ "$nrpe_unknown" = 1 ] && exit 3  # unknown
 	exit 0  # ok
 fi
+
+if [ "$opt_batch" = 1 -a "$opt_batch_format" = "json" ]; then
+	_echo 0 ${json_output%?}]
+fi