[202211] Add Secure Boot Kernel configuration backport (#316)

Backport of #298 & #300 In order to support the Secure Boot feature it required some modifications when building the Linux Kernel. This PR contained the kernel configuration aggregations to support it. sonic-buildimage PR link: sonic-net/sonic-buildimage#14963 HLD: sonic-net/SONiC#1028
sonic-net · May 10, 2023 · baaa137 · baaa137
1 parent cc69246
commit baaa137
Show file tree

Hide file tree

Showing 4 changed files with 157 additions and 67 deletions.
diff --git a/Makefile b/Makefile
@@ -9,6 +9,8 @@ KERNEL_VERSION ?= 5.10.140
 KERNEL_SUBVERSION ?= 1
 kernel_procure_method ?= build
 CONFIGURED_ARCH ?= amd64
+SECURE_UPGRADE_MODE ?=
+SECURE_UPGRADE_DEV_SIGNING_CERT =?
 
 LINUX_HEADER_COMMON = linux-headers-$(KVERSION_SHORT)-common_$(KERNEL_VERSION)-$(KERNEL_SUBVERSION)_all.deb
 LINUX_HEADER_AMD64 = linux-headers-$(KVERSION)_$(KERNEL_VERSION)-$(KERNEL_SUBVERSION)_$(CONFIGURED_ARCH).deb
@@ -132,7 +134,7 @@ $(addprefix $(DEST)/, $(MAIN_TARGET)): $(DEST)/% :
 
 	# Optionally add/remove kernel options
 	if [ -f ../manage-config ]; then
-		../manage-config $(CONFIGURED_ARCH) $(CONFIGURED_PLATFORM)
+		../manage-config $(CONFIGURED_ARCH) $(CONFIGURED_PLATFORM) $(SECURE_UPGRADE_MODE) $(SECURE_UPGRADE_DEV_SIGNING_CERT)
 	fi
 
 	# Building a custom kernel from Debian kernel source

diff --git a/manage-config b/manage-config
@@ -26,12 +26,21 @@
 # Configuration file to change
 ARCH=amd64
 PLATFORM=
+SECURE_UPGRADE_MODE="no_sign"
+SECURE_UPGRADE_DEV_SIGNING_CERT=
 if [ $# -ge 1 ]; then
     ARCH=$1
 fi
 if [ $# -ge 2 ]; then
     PLATFORM=$2
 fi
+if [ $# -ge 3 ]; then
+    SECURE_UPGRADE_MODE=$3
+fi
+if [ $# -ge 4 ]; then
+    SECURE_UPGRADE_DEV_SIGNING_CERT=$4
+fi
+
 case "$ARCH" in
     amd64)
         CONFIG_FILE_LOC=debian/build/build_amd64_none_amd64
@@ -58,84 +67,123 @@ function get_section_opts(){
     echo "$opts"
 }
 
-ret=0
-exclusion_file="../patch/kconfig-exclusions"
-inclusion_file="../patch/kconfig-inclusions"
-force_inclusion_file="../patch/kconfig-force-inclusions"
-if [ -e ${exclusion_file} -o -e ${inclusion_file} -o -e ${force_inclusion_file} ]; then
-
-    # Process any exclusions in the kernel
-    if [ -f ${exclusion_file} ]; then
-        exclusion_opts=$(get_section_opts ${exclusion_file} "common" ${ARCH} ${PLATFORM})
-        while read -r opt; do
-            if [ ! -z "$opt" ] && [[ ! "$opt" =~ ^#.* ]]; then
-                scripts/config --file ${CONFIG_FILE} -d $opt
-            fi
-        done <<< ${exclusion_opts};
-    fi
+function process_inclusion_exclusion_files(){
+    echo "process_inclusion_exclusion_files Start"
+    ret=0
+    echo "debug ret=$ret 1"
+    if [ -e ${exclusion_file} -o -e ${inclusion_file} -o -e ${force_inclusion_file} ]; then
 
-    # Process any inclusions in the kernel
-    if [ -f ${inclusion_file} ]; then
-        inclusion_opts=$(get_section_opts ${inclusion_file} "common" ${ARCH} ${PLATFORM})
-        while read -r opt; do
-            if [ ! -z "$opt" ] && [[ ! "$opt" =~ ^#.* ]]; then
-                echo $opt >> ${CONFIG_FILE}
-            fi
-        done <<< ${inclusion_opts};
-    fi
+        # Process any exclusions in the kernel
+        if [ -f ${exclusion_file} ]; then
+            exclusion_opts=$(get_section_opts ${exclusion_file} "common" ${ARCH} ${PLATFORM})
+            while read -r opt; do
+                if [ ! -z "$opt" ] && [[ ! "$opt" =~ ^#.* ]]; then
+                    scripts/config --file ${CONFIG_FILE} -d $opt
+                fi
+            done <<< ${exclusion_opts};
+        fi
 
-    # Update the .config file to be sure it's consistent
-    make -C ${CONFIG_FILE_LOC} olddefconfig
+        # Process any inclusions in the kernel
+        if [ -f ${inclusion_file} ]; then
+            inclusion_opts=$(get_section_opts ${inclusion_file} "common" ${ARCH} ${PLATFORM})
+            while read -r opt; do
+                if [ ! -z "$opt" ] && [[ ! "$opt" =~ ^#.* ]]; then
+                    n=${opt%=*}
+                    v="${opt#*=}"
+                    scripts/config --file ${CONFIG_FILE} -k --set-val "$n" "$v"
+                fi
+            done <<< ${inclusion_opts};
+        fi
 
-    # Verify that the kernel options we want to remove are not in the updated configuration
-    if [ -f ${exclusion_file} ]; then
-        echo
-        echo "Checking removed kernel options..."
-        while read -r opt; do
-            if [ ! -z "$opt" ] && [[ ! "$opt" =~ ^#.* ]]; then
-                s=$(scripts/config --file ${CONFIG_FILE} -k --state $opt)
-                if [ ! "$s" = "undef" -a ! "$s" = "n" ]; then
-                    ret=1
-                    echo "Option $opt should not be set, but is set to [$s]"
+        # Update the .config file to be sure it's consistent
+        make -C ${CONFIG_FILE_LOC} olddefconfig
+
+        # Verify that the kernel options we want to remove are not in the updated configuration
+        if [ -f ${exclusion_file} ]; then
+            echo
+            echo "Checking removed kernel options..."
+            while read -r opt; do
+                if [ ! -z "$opt" ] && [[ ! "$opt" =~ ^#.* ]]; then
+                    s=$(scripts/config --file ${CONFIG_FILE} -k --state $opt)
+                    if [ ! "$s" = "undef" -a ! "$s" = "n" ]; then
+                        ret=1
+                        echo "Option $opt should not be set, but is set to [$s]"
+                    fi
                 fi
+            done <<< ${exclusion_opts};
+            if [ $ret = 0 ]; then
+                echo "No error"
             fi
-        done <<< ${exclusion_opts};
-        if [ $ret = 0 ]; then
-            echo "No error"
         fi
-    fi
 
-    # Verify that the kernel options we want to add are now in the updated configuration
-    if [ -f ${inclusion_file} ]; then
-        echo
-        echo "Checking added kernel options..."
-        while read -r opt; do
-            if [ ! -z "$opt" ] && [[ ! "$opt" =~ ^#.* ]]; then
-                n=${opt%=*}
-                v="${opt#*=}"
-                s=$(scripts/config --file ${CONFIG_FILE} -k --state $n)
-                if [ ! "$s" = "$v" ]; then
-                    ret=2
-                    echo "Option $n should be set to [$v] instead of [$s]"
+        # Verify that the kernel options we want to add are now in the updated configuration
+        if [ -f ${inclusion_file} ]; then
+            echo
+            echo "Checking added kernel options..."
+            while read -r opt; do
+                if [ ! -z "$opt" ] && [[ ! "$opt" =~ ^#.* ]]; then
+                    n=${opt%=*}
+                    v="${opt#*=}"
+                    v="${v/#\"/}"
+                    v="${v/%\"/}"
+                    s=$(scripts/config --file ${CONFIG_FILE} -k --state $n)
+                    if [ ! "$s" = "$v" ]; then
+                        ret=2
+                        echo "Option $n should be set to [$v] instead of [$s]"
+                    fi
                 fi
+            done <<< ${inclusion_opts};
+            if [ ! $ret = 2 ]; then
+                echo "No error"
             fi
-        done <<< ${inclusion_opts};
-        if [ ! $ret = 2 ]; then
-            echo "No error"
         fi
-    fi
 
-    # Process any force inclusions in the kernel
-    if [ -f ${force_inclusion_file} ]; then
-        force_inclusion_opts=$(get_section_opts ${force_inclusion_file} "common" ${ARCH} ${PLATFORM})
-        while read -r opt; do
-            if [ ! -z "$opt" ] && [[ ! "$opt" =~ ^#.* ]]; then
-                echo $opt >> ${CONFIG_FILE}
-            fi
-        done <<< ${force_inclusion_opts};
+        # Process any force inclusions in the kernel
+        if [ -f ${force_inclusion_file} ]; then
+            force_inclusion_opts=$(get_section_opts ${force_inclusion_file} "common" ${ARCH} ${PLATFORM})
+            while read -r opt; do
+                if [ ! -z "$opt" ] && [[ ! "$opt" =~ ^#.* ]]; then
+                    echo $opt >> ${CONFIG_FILE}
+                fi
+            done <<< ${force_inclusion_opts};
+        fi
+
+        echo
     fi
 
-    echo
+    echo "process_inclusion_exclusion_files Done"
+    return $ret
+}
+
+exclusion_file="../patch/kconfig-exclusions"
+inclusion_file="../patch/kconfig-inclusions"
+force_inclusion_file="../patch/kconfig-force-inclusions"
+ret_process_inc_ex=0
+ret_process_inc_ex=$(process_inclusion_exclusion_files > /dev/null; echo $?)
+
+#  Secure Boot support
+if [ $ret_process_inc_ex -eq 0 ]; then
+    echo "Secure Boot params: SECURE_UPGRADE_MODE=${SECURE_UPGRADE_MODE}, SECURE_UPGRADE_DEV_SIGNING_CERT=${SECURE_UPGRADE_DEV_SIGNING_CERT}"
+    if [ ${SECURE_UPGRADE_MODE} == "dev" -o ${SECURE_UPGRADE_MODE} == "prod" ]; then
+        echo "set kconfig-secure-boot-exclusions & kconfig-secure-boot-inclusions"
+
+        if [ ! -f "${SECURE_UPGRADE_DEV_SIGNING_CERT}" ]; then
+            echo "ERROR: SECURE_UPGRADE_DEV_SIGNING_CERT=${SECURE_UPGRADE_DEV_SIGNING_CERT} file does not exist"
+            exit 1
+        fi
+
+        exclusion_file="../patch/kconfig-secure-boot-exclusions"
+        inclusion_file="../patch/kconfig-secure-boot-inclusions"
+        force_inclusion_file="../patch/kconfig-force-secure-boot-inclusions"
+
+        # save the new pub key in kernel
+        sed -i "s|^CONFIG_SYSTEM_TRUSTED_KEYS=.*|CONFIG_SYSTEM_TRUSTED_KEYS=\"$SECURE_UPGRADE_DEV_SIGNING_CERT\"|g" ${inclusion_file}
+
+        ret_process_inc_ex=$(process_inclusion_exclusion_files > /dev/null; echo $?)
+        echo "Secure Boot kernel configuration done."
+    else
+        echo "no Secure Boot Kernel configuration required."
+    fi
 fi
 
-exit $ret
+exit $ret_process_inc_ex
diff --git a/patch/kconfig-secure-boot-exclusions b/patch/kconfig-secure-boot-exclusions
@@ -0,0 +1,21 @@
+[common]
+
+[amd64]
+CONFIG_MODULE_SIG_SHA256
+# For mellanox
+CONFIG_SECURITY_LOCKDOWN_LSM
+CONFIG_SECURITY_LOCKDOWN_LSM_EARLY
+CONFIG_LOCK_DOWN_KERNEL_FORCE_NONE
+CONFIG_LOCK_DOWN_IN_EFI_SECURE_BOOT
+
+[arm64]
+CONFIG_MODULE_SIG_SHA256
+# For mellanox
+CONFIG_SECURITY_LOCKDOWN_LSM
+CONFIG_SECURITY_LOCKDOWN_LSM_EARLY
+CONFIG_LOCK_DOWN_KERNEL_FORCE_NONE
+CONFIG_LOCK_DOWN_IN_EFI_SECURE_BOOT
+
+[armhf]
+
+[marvell-armhf]
diff --git a/patch/kconfig-secure-boot-inclusions b/patch/kconfig-secure-boot-inclusions
@@ -0,0 +1,19 @@
+[common]
+
+[amd64]
+CONFIG_SYSTEM_TRUSTED_KEYS="debian/certs/debian-uefi-certs.pem"
+CONFIG_MODULE_SIG_HASH="sha512"
+CONFIG_MODULE_SIG_SHA512=y
+CONFIG_KEXEC_SIG_FORCE=y
+CONFIG_MODULE_SIG_FORCE=y
+
+[arm64]
+CONFIG_SYSTEM_TRUSTED_KEYS="debian/certs/debian-uefi-certs.pem"
+CONFIG_MODULE_SIG_HASH="sha512"
+CONFIG_MODULE_SIG_SHA512=y
+CONFIG_KEXEC_SIG_FORCE=y
+CONFIG_MODULE_SIG_FORCE=y
+
+[armhf]
+
+[marvell-armhf]