署名されたカーネルモジュール - 版の履歴

Ny-a: Template:TranslationStatus を追加

2022-08-15T01:03:43Z

← 古い版		2022年8月15日 (月) 10:03時点における版
216行目:		216行目:

	*{{AUR\|zfs-dkms}} {{AUR\|nvidia-beta-dkms}} {{AUR\|lkrg-dkms}} {{Pkg\|nvidia-dkms}}		*{{AUR\|zfs-dkms}} {{AUR\|nvidia-beta-dkms}} {{AUR\|lkrg-dkms}} {{Pkg\|nvidia-dkms}}

			{{TranslationStatus\|Signed kernel modules\|2022-06-27\|734091}}

Kgx: /* 必要なことのまとめ */ ピリオド削除

2022-06-27T08:33:33Z

必要なことのまとめ: ピリオド削除

← 古い版		2022年6月27日 (月) 17:33時点における版
30行目:		30行目:
	}}		}}

	各カーネルビルドは、ツリー外モジュールの署名に使用されるキーペアを認識する必要があります。カーネル構成パラメーターを使用して、カーネルに追加の署名キーを認識させるようになりました: {{ic\|1=CONFIG_SYSTEM_TRUSTED_KEYS="/path/to/oot-signing_keys.pem"}}.		各カーネルビルドは、ツリー外モジュールの署名に使用されるキーペアを認識する必要があります。カーネル構成パラメーターを使用して、カーネルに追加の署名キーを認識させるようになりました: {{ic\|1=CONFIG_SYSTEM_TRUSTED_KEYS="/path/to/oot-signing_keys.pem"}}

	キーと署名ツールは、現在のモジュールビルドディレクトリに保存されます。削除は標準のモジュールクリーンアップによって処理されるため、これをクリーンアップするために何もする必要はありません。秘密鍵と公開鍵の両方がにインストールされています。{{ic\|/usr/lib/modules/''kernel_version''-''build''/certs-local}}		キーと署名ツールは、現在のモジュールビルドディレクトリに保存されます。削除は標準のモジュールクリーンアップによって処理されるため、これをクリーンアップするために何もする必要はありません。秘密鍵と公開鍵の両方がにインストールされています。{{ic\|/usr/lib/modules/''kernel_version''-''build''/certs-local}}

Kgx: /* Helper scripts */ 翻訳

2022-06-24T12:29:15Z

Helper scripts: 翻訳

← 古い版		2022年6月24日 (金) 21:29時点における版
192行目:		192行目:
	スクリプトが [[ヘルプ:読み方#実行可能属性の付与\|実行可能]] であることを確認してください。		スクリプトが [[ヘルプ:読み方#実行可能属性の付与\|実行可能]] であることを確認してください。

			== ヘルパースクリプト ==
	== Helper scripts ==

	{{Accuracy\|The {{AUR\|arch-sign-modules}} package comes from a fork of the [https://github.com/gene-git/Arch-SKM/tree/master Arch-SKM] repository which is used in the previous sections. It is not clear what is wrong with the original repository nor why changes resulted in a fork instead of fixing/improving the original repository.}}		{{Accuracy\|The {{AUR\|arch-sign-modules}} package comes from a fork of the [https://github.com/gene-git/Arch-SKM/tree/master Arch-SKM] repository which is used in the previous sections. It is not clear what is wrong with the original repository nor why changes resulted in a fork instead of fixing/improving the original repository.}}

	{{AUR\|arch-sign-modules}} ~~builds~~:		{{AUR\|arch-sign-modules}} ビルド:
	* {{Pkg\|linux-hardened}}		* {{Pkg\|linux-hardened}}
	* {{Pkg\|linux-lts}}		* {{Pkg\|linux-lts}}
205行目:		205行目:
	* {{AUR\|linux-libre}}		* {{AUR\|linux-libre}}

	& ~~other~~ AUR ~~kernels.~~		& 他のAURカーネル

	~~The~~ '''''abk''''' ~~helper script reduces the manual steps for building a fully signed custom kernel to~~ 3 ~~commands to~~ '''''Update''''' / '''''Build''''' & '''''Install''''' ~~the kernel:~~		'''''abk''''' ヘルパースクリプトは、完全に署名されたカスタムカーネルをビルドするための手動の手順を3つのコマンドに減らします '''''Update''''' / '''''Build''''' & '''''Install'''''

	abk -u kernel-name		abk -u kernel-name
213行目:		213行目:
	abk -i kernel-name		abk -i kernel-name

			署名されたカーネルモジュールのサポート:
	With signed kernel module support for:

	*{{AUR\|zfs-dkms}} {{AUR\|nvidia-beta-dkms}} {{AUR\|lkrg-dkms}} {{Pkg\|nvidia-dkms}}		*{{AUR\|zfs-dkms}} {{AUR\|nvidia-beta-dkms}} {{AUR\|lkrg-dkms}} {{Pkg\|nvidia-dkms}}

Kgx: /* Files required */ 翻訳

2022-06-24T12:22:54Z

Files required: 翻訳

← 古い版		2022年6月24日 (金) 21:22時点における版
175行目:		175行目:
	}}		}}

	== ~~Files required~~ ==		== 必要なファイル ==

	~~The~~ 5 ~~supporting files referenced above are available for download from the~~ [https://github.com/gene-git/Arch-SKM/tree/~~master github~~.com/gene-git/Arch-SKM] ~~repository~~:		上記で参照されている5つのサポートファイルは、[https://github.com/gene-git/Arch-SKM/tree/mastergithub.com/gene-git/Arch-SKM] リポジトリからダウンロードできます。:

	{{Note\|~~There is also an~~ aur ~~version of these files available~~ ({{AUR\|arch-sign-modules}}). ~~After building and install they can be found at~~ {{ic\|/usr/src/certs-local}}		{{Note\|これらのファイルの aur バージョンも利用できます ({{AUR\|arch-sign-modules}}) ビルドしてインストールした後、それらは {{ic\|/usr/src/certs-local}} にあります。}}
	}}

	* [https://github.com/gene-git/Arch-SKM/blob/master/certs-local/x509.oot.genkey certs-local/x509.oot.genkey]		* [https://github.com/gene-git/Arch-SKM/blob/master/certs-local/x509.oot.genkey certs-local/x509.oot.genkey]
191行目:		190行目:
	* [https://github.com/gene-git/Arch-SKM/blob/master/certs-local/dkms/kernel-sign.sh certs-local/dkms/kernel-sign.sh]		* [https://github.com/gene-git/Arch-SKM/blob/master/certs-local/dkms/kernel-sign.sh certs-local/dkms/kernel-sign.sh]

			スクリプトが [[ヘルプ:読み方#実行可能属性の付与\|実行可能]] であることを確認してください。
	Remember to ensure that the scripts are [[executable]].

	== Helper scripts ==		== Helper scripts ==

Kgx: /* Modify PKGBUILD */ 翻訳

2022-06-24T12:18:18Z

Modify PKGBUILD: 翻訳

← 古い版		2022年6月24日 (金) 21:18時点における版
127行目:		127行目:
	リンクの作成は、必要に応じてさらに単純化するために arch パッケージに簡単に追加できます。		リンクの作成は、必要に応じてさらに単純化するために arch パッケージに簡単に追加できます。

	== ~~Modify~~ PKGBUILD ==		== PKGBUILD を変更する ==

			次のようにカーネルビルドを変更する必要があります。:
	We need to make changes to kernel build as follows:

	=== prepare() ===		=== prepare() ===

			{{ic\|prepar()}} 関数の先頭に以下を追加します。:
	Add the following to the top of the {{ic\|prepare()}} function:

	{{bc\|		{{bc\|
145行目:		145行目:
	}}		}}

			デフォルトのキー再生成の更新期間は7日ですが、これはコマンドラインで変更できます。したがって、毎月新しいキーを作成する場合は、genekeys.py の引数として "--refresh 30days" を追加します。 "--refresh always" を使用すると、ビルドごとに更新できます。更新の単位は、秒、分、時間、日、または週です。
	The default key regeneration refresh period is 7 days, but this can be changed on the command line. So if you want to create new keys monthly, then add "--refresh 30days" as an argument to genekeys.py. You can refresh on every build by using "--refresh always". Refresh units can be seconds,minutes,hours,days or weeks.

	=== _package-headers() ===		=== _package-headers() ===

	~~Add the following to the bottom of the~~ {{ic\|_package-headers()}} ~~function:~~		{{ic\|_package-headers(}} 関数の下部に以下を追加します。

	{{bc\|1=		{{bc\|1=

Kgx: /* Tools needed */ 翻訳

2022-06-24T12:13:02Z

Tools needed: 翻訳

← 古い版		2022年6月24日 (金) 21:13時点における版
74行目:		74行目:
	検証済みモジュールを強制的にオンにする前に、システムログにモジュール署名の障害が報告されていないことを確認してください。		検証済みモジュールを強制的にオンにする前に、システムログにモジュール署名の障害が報告されていないことを確認してください。

	== ~~Tools needed~~ ==		== 必要なツール ==

			=== カーネルビルドパッケージ ===
	=== kernel build package ===

			カーネルパッケージがビルドされているディレクトリ:
	In the directory where the kernel package is built:

	$ mkdir certs-local		$ mkdir certs-local

			このディレクトリは、キーを作成するためのツールと、カーネルモジュールに署名するためのツールを提供します。
	This directory will provide the tools to create the keys, as well as signing kernel modules.

	~~Put these files into~~ {{ic\|certs-local}}:		これらのファイルをに入れます {{ic\|certs-local}}:

	* {{ic\|x509.oot.genkey}}		* {{ic\|x509.oot.genkey}}
93行目:		93行目:
	* {{ic\|utils.py}}		* {{ic\|utils.py}}

	~~The files~~ {{ic\|genkeys.py}} ~~and its companion configuration file~~ {{ic\|x509.oot.genkey}} ~~are used to create key pairs.~~		ファイル {{ic\|genkeys.py}} とそのコンパニオン構成ファイル {{ic\|x509.oot.genkey}} は、キーペアを作成するために使用されます。

			{{ic\|genkeys.py}} はまた、カーネルを構築するために使用される設定ファイルを更新することによって、カーネルに鍵情報を提供します。
	{{ic\|genkeys.py}} also provides the kernel with the key information by updating the configuration file(s) used to build the kernel.

			スクリプト {{ic\|sign_module.py}} はアウトオブツリーのカーネルモジュールに署名します。手動で実行することもできますし、{{ic\|dkms/kernel-sign.sh}} から呼び出されます。xz と gzip で圧縮されたモジュールを処理し、zstd で圧縮されたモジュールを処理するために python-zstandard に依存します。
	The script {{ic\|sign_module.py}} signs out-of-tree kernel modules. It can be run manually and is invoked by {{ic\|dkms/kernel-sign.sh}}. It handles modules compressed with xzand gzip and depends on python-zstandard to help handle those compressed with zstd.

			{{ic\|genkeys.py}} は --config config(s) オプションで指定されたカーネル設定をチェックし、更新します。単一の設定ファイルか、複数のファイルを指定するシェルグロブを使用します(例:-config 'conf/config.*')すべての設定は同じキーで更新されます。デフォルトのキータイプはec (楕円曲線) で、デフォルトのハッシュは sha512 です。これらはコマンドラインオプションで変更することができます。詳細は {{ic\|genkeys.py}} を参照、もしくは、-h で参照してください。
	{{ic\|genkeys.py}} will create the key pairs in a directory named by date-time

			また、現在の鍵ペアを保持している同じディレクトリにソフトリンク {{ic\|current}} を作成します。
	{{ic\|genkeys.py}} will check and update kernel configs given by the --config config(s) option. It takes either a single config file, or a shell glob for multiple files. e.g. --config 'conf/config.*'. All configs will be updated with the same key. The default keytype is ec (elliptic curve) and the default hash is sha512. These can be changed with command line options. See {{ic\|genkeys.py}} -h for more details.

			{{ic\|install-certs.py}} は PKGBUILD の package_headers() 関数から呼び出され、署名鍵をインストールするために使用されます。以下に例を示します。
	It also creates a soft link {{ic\|current}} to the same directory holding the current key pairs.

	{{ic\|install-certs.py}} is to be called from the package_headers() function of PKGBUILD to install the signing keys. Example is given below.

			これらのファイルは利用可能で、以下にリンクが張られています。
	These files are available and links are provided below.

	=== DKMS ~~support~~ ===		=== DKMS サポート ===

	$ mkdir certs-local/dkms		$ mkdir certs-local/dkms

			{{ic\|dkms}} ディレクトリに2つのファイルを追加します。
	Add 2 files to the {{ic\|dkms}} directory:

	* {{ic\|kernel-sign.conf}}		* {{ic\|kernel-sign.conf}}
	* {{ic\|kernel-sign.sh}}		* {{ic\|kernel-sign.sh}}

			これらは {{ic\|/etc/dkms}} にインストールされ、DKMS がローカルキーを使用してモジュールに自動的に署名する手段を提供します。これは、ツリー外のカーネルモジュールにサインアウトするための推奨される方法です。以下で説明するように、これがインストールされると、DKMS がモジュールに自動的に署名するために必要なのは、各モジュールのソフトリンクを構成ファイルに作成することだけです。
	These will be installed in {{ic\|/etc/dkms}} and provide the means for DKMS to automatically sign modules using the local key. This is the recommended way to sign out-of-tree kernel modules. As explained below, once this is installed, all that is needed is for DKMS to automatically sign modules is to make a soft link for each module to the configuration file.

	$ cd /etc/dkms		$ cd /etc/dkms
	# ln -s kernel-sign.conf ''module_name.conf''		# ln -s kernel-sign.conf ''module_name.conf''

			例:
	For example:

	# ln -s kernel-sign.conf vboxdrv.conf		# ln -s kernel-sign.conf vboxdrv.conf

			リンクの作成は、必要に応じてさらに単純化するために arch パッケージに簡単に追加できます。
	The link creation can easily be added to an arch package to simplify further if desired.

	== Modify PKGBUILD ==		== Modify PKGBUILD ==

Kgx: /* Kernel configuration */ 翻訳

2022-06-24T12:06:23Z

Kernel configuration: 翻訳

← 古い版		2022年6月24日 (金) 21:06時点における版
34行目:		34行目:
	キーと署名ツールは、現在のモジュールビルドディレクトリに保存されます。削除は標準のモジュールクリーンアップによって処理されるため、これをクリーンアップするために何もする必要はありません。秘密鍵と公開鍵の両方がにインストールされています。{{ic\|/usr/lib/modules/''kernel_version''-''build''/certs-local}}		キーと署名ツールは、現在のモジュールビルドディレクトリに保存されます。削除は標準のモジュールクリーンアップによって処理されるため、これをクリーンアップするために何もする必要はありません。秘密鍵と公開鍵の両方がにインストールされています。{{ic\|/usr/lib/modules/''kernel_version''-''build''/certs-local}}

	== ~~Kernel configuration~~ ==		== カーネル構成 ==

			{{ic\|CONFIG_SYSTEM_TRUSTED_KEYS}} は、以下で提供されるスクリプト {{ic\|genkeys.py}} を使って自動的に更新されます。さらに、次の構成オプションは、手動で {{ic\|.config}} ファイルを編集するか、Linuxの {{ic\|src}} ディレクトリにある {{ic\|make menuconfig}} を使って設定し、その後、ビルドファイル {{ic\|config}} に、更新した {{ic\|.config}} ファイルをコピーして戻しておく必要があります。楕円曲線型の鍵を使用し、zstd 圧縮を行うことが望ましいです。
	{{ic\|CONFIG_SYSTEM_TRUSTED_KEYS}} will be updated automatically using the script {{ic\|genkeys.py}} provided below. In addition, the following configuration options should be set either manually by editing the {{ic\|.config}} file, or via {{ic\|make menuconfig}} in the Linux {{ic\|src}} directory and subsequently copying the updated {{ic\|.config}} file back to the build file {{ic\|config}}. It is preferable to use elliptic curve type keys and zstd compression.

	CONFIG_MODULE_SIG=y		CONFIG_MODULE_SIG=y
66行目:		66行目:
	Allow loading of modules with missing namespace imports - set to no		Allow loading of modules with missing namespace imports - set to no

			=== カーネルコマンドライン ===
	=== Kernel command line ===

			モジュールが署名されており、カーネルが正常に機能していることを確認したら、次の [[カーネルパラメータ]] を有効にして、カーネルが検証済みモジュールのロードのみを許可するようにできます。
	When you have confirmed that the modules are being signed and that the kernel works as it should, you can enable the following [[kernel parameter]] to require that the kernel only permits verified modules to be loaded:

	module.sig_enforce=1		module.sig_enforce=1

			検証済みモジュールを強制的にオンにする前に、システムログにモジュール署名の障害が報告されていないことを確認してください。
	Before forcing verified modules on, please confirm that the system logs do not show any module signature failures being reported.

	== Tools needed ==		== Tools needed ==

Kgx: /* Summary of what needs to be done */ 翻訳

2022-06-24T11:58:04Z

Summary of what needs to be done: 翻訳

← 古い版		2022年6月24日 (金) 20:58時点における版
20行目:		20行目:
	カーネルは、常にモジュールを検証し、失敗した場合は標準のログに報告するようにすることができます。検証できなかったモジュールのロードと使用を許可するかどうかは、カーネルに組み込むか、以下に説明するように [[カーネルパラメータ]] を使って実行時にオンにすることができます。		カーネルは、常にモジュールを検証し、失敗した場合は標準のログに報告するようにすることができます。検証できなかったモジュールのロードと使用を許可するかどうかは、カーネルに組み込むか、以下に説明するように [[カーネルパラメータ]] を使って実行時にオンにすることができます。

			== 必要なことのまとめ ==
	== Summary of what needs to be done ==

			初めに、[[カーネル/コンパイル/Arch Build System]] で説明されているカスタムカーネルパッケージに基づいています。ビルドを変更して、標準のツリー内カーネルモジュールとツリー外モジュールに署名して検証するための前提条件を提供します。
	The starting point is based on a custom kernel package as outlined in [[Kernel/Arch Build System]]. We will modify the build to sign the standard in-tree kernel modules and to provide the prerequisites for signing and verifying out-of-tree modules.

	{{Note\|		{{Note\|
			目標は次のとおりです。
	The goal is to have:
			* 標準のカーネルビルドプロセス中に署名されたツリー内モジュール。標準のカーネルビルドは、ビルドごとに新しい公開鍵と秘密鍵のペアを作成します。
	* In-tree modules signed during the standard kernel build process. The standard kernel build creates a fresh public/private key pair on each build.
			* ツリー外モジュールは署名され、関連する公開鍵はカーネルにコンパイルされます。ビルドごとに個別の公開鍵と秘密鍵のペアを作成します。
	* Out-of-tree modules are signed and the associated public key is compiled into the kernel. We will create a separate public/private key pair on each build.
	}}		}}

	~~Each kernel build needs to made aware of the key pair to be used for signing out-of-tree modules. A kernel configuration parameter is now used to make the kernel aware of additional signing keys~~: {{ic\|1=CONFIG_SYSTEM_TRUSTED_KEYS="/path/to/oot-signing_keys.pem"}}.		各カーネルビルドは、ツリー外モジュールの署名に使用されるキーペアを認識する必要があります。カーネル構成パラメーターを使用して、カーネルに追加の署名キーを認識させるようになりました: {{ic\|1=CONFIG_SYSTEM_TRUSTED_KEYS="/path/to/oot-signing_keys.pem"}}.

			キーと署名ツールは、現在のモジュールビルドディレクトリに保存されます。削除は標準のモジュールクリーンアップによって処理されるため、これをクリーンアップするために何もする必要はありません。秘密鍵と公開鍵の両方がにインストールされています。{{ic\|/usr/lib/modules/''kernel_version''-''build''/certs-local}}
	Keys and signing tools will be stored in the current module build directory. Nothing needs to be done to clean this as removal is handled by the standard module cleanup. The private and public keys are both installed in {{ic\|/usr/lib/modules/''kernel_version''-''build''/certs-local}}.

	== Kernel configuration ==		== Kernel configuration ==

Kgx: 一部翻訳

2022-06-24T11:51:00Z

一部翻訳

← 古い版		2022年6月24日 (金) 20:51時点における版
7行目:		7行目:
	{{Related articles end}}		{{Related articles end}}

	[https://www.kernel.org/doc/html/latest/admin-guide/module-signing.html Signed] [[~~kernel modules~~]] ~~provide a mechanism for the kernel to verify the integrity of a module.~~		[https://www.kernel.org/doc/html/latest/admin-guide/module-signing.html Signed] [[カーネルモジュール]] は、カーネルがモジュールの整合性を検証するためのメカニズムを提供します。

	== ~~Overview~~ ==		== 概要 ==

			Linux カーネルは、モジュールの検証を、モジュールをロードする前に検証することを要求、または強制することと区別し、分離しています。カーネルモジュールは2つのクラスに分類されます。
	The Linux kernel distinguishes and keeps separate the verification of modules from requiring or forcing modules to verify before allowing them to be loaded. Kernel modules fall into 2 classes:

			* 標準の ''in-tree'' モジュール:カーネルのソースコードに付属しているモジュールです。これらは通常のカーネルビルドの際にコンパイルされます。
	* Standard ''in-tree'' modules which come with the kernel source code. They are compiled during the normal kernel build.
			* カーネルソースディストリビューションの一部ではない ''Out-of-tree'' モジュール。カーネルツリーの外側でビルドされ、ビルドするカーネルごとにカーネルヘッダーパッケージを必要とします。特定のカーネル用に手動でビルドしてパッケージ化することもできますし、[[DKMS]] を使って必要なときにいつでもビルドすることもできます。
	* ''Out-of-tree'' modules which are not part of the kernel source distribution. They are built outside of the kernel tree, requiring the kernel headers package for each kernel they are to be built for. They can be built manually for a specific kernel and packaged, or they can be built whenever needed using [[DKMS]].

			標準的なカーネルのコンパイルでは、カーネルビルドツールは秘密鍵と公開鍵のペアを作成し、(秘密鍵を使って) 全てのインツリーモジュールに署名します。公開鍵はカーネル自体に保存されます。その後、モジュールがロードされると、公開鍵はモジュールが変更されていないことを確認するために使用されます。
	During a standard kernel compilation, the kernel build tools create a private/public key pair and sign every in-tree module (using the private key). The public key is saved in the kernel itself. When a module is subsequently loaded, the public key can then be used to verify that the module is unchanged.

			カーネルは、常にモジュールを検証し、失敗した場合は標準のログに報告するようにすることができます。検証できなかったモジュールのロードと使用を許可するかどうかは、カーネルに組み込むか、以下に説明するように [[カーネルパラメータ]] を使って実行時にオンにすることができます。
	The kernel can be enabled to always verify modules and report any failures to standard logs. The choice to permit the loading and use of a module which could not be verified can be either compiled into kernel or turned on at runtime using a [[kernel parameter]] as explained below.

	== Summary of what needs to be done ==		== Summary of what needs to be done ==

Kgx: 英語版から転載

2022-06-24T11:46:40Z

英語版から転載

新規ページ

[[Category:カーネル]]
[[en:Signed kernel modules]]
{{Related articles start}}
{{Related|カーネル}}
{{Related|カーネルモジュール}}
{{Related|カーネル/コンパイル/Arch Build System}}
{{Related articles end}}

[https://www.kernel.org/doc/html/latest/admin-guide/module-signing.html Signed] [[kernel modules]] provide a mechanism for the kernel to verify the integrity of a module.

== Overview ==

The Linux kernel distinguishes and keeps separate the verification of modules from requiring or forcing modules to verify before allowing them to be loaded. Kernel modules fall into 2 classes:

* Standard ''in-tree'' modules which come with the kernel source code. They are compiled during the normal kernel build.
* ''Out-of-tree'' modules which are not part of the kernel source distribution. They are built outside of the kernel tree, requiring the kernel headers package for each kernel they are to be built for. They can be built manually for a specific kernel and packaged, or they can be built whenever needed using [[DKMS]].

During a standard kernel compilation, the kernel build tools create a private/public key pair and sign every in-tree module (using the private key). The public key is saved in the kernel itself. When a module is subsequently loaded, the public key can then be used to verify that the module is unchanged.

The kernel can be enabled to always verify modules and report any failures to standard logs. The choice to permit the loading and use of a module which could not be verified can be either compiled into kernel or turned on at runtime using a [[kernel parameter]] as explained below.

== Summary of what needs to be done ==

The starting point is based on a custom kernel package as outlined in [[Kernel/Arch Build System]]. We will modify the build to sign the standard in-tree kernel modules and to provide the prerequisites for signing and verifying out-of-tree modules.

{{Note|
The goal is to have:
* In-tree modules signed during the standard kernel build process. The standard kernel build creates a fresh public/private key pair on each build.
* Out-of-tree modules are signed and the associated public key is compiled into the kernel. We will create a separate public/private key pair on each build.
}}

Each kernel build needs to made aware of the key pair to be used for signing out-of-tree modules. A kernel configuration parameter is now used to make the kernel aware of additional signing keys: {{ic|1=CONFIG_SYSTEM_TRUSTED_KEYS="/path/to/oot-signing_keys.pem"}}.

Keys and signing tools will be stored in the current module build directory. Nothing needs to be done to clean this as removal is handled by the standard module cleanup. The private and public keys are both installed in {{ic|/usr/lib/modules/''kernel_version''-''build''/certs-local}}.

== Kernel configuration ==

{{ic|CONFIG_SYSTEM_TRUSTED_KEYS}} will be updated automatically using the script {{ic|genkeys.py}} provided below. In addition, the following configuration options should be set either manually by editing the {{ic|.config}} file, or via {{ic|make menuconfig}} in the Linux {{ic|src}} directory and subsequently copying the updated {{ic|.config}} file back to the build file {{ic|config}}. It is preferable to use elliptic curve type keys and zstd compression.

CONFIG_MODULE_SIG=y
Enable Loadable module suppot --->
Module Signature Verification - activate

CONFIG_MODULE_SIG_FORCE=n
Require modules to be validly signed -> leave off (for now)

This allows the decision to enforce verified modules only as boot command line.
If you are comfortable all is working then by all means change this to 'y'
Command line version of this is : module.sig_enforce=1

CONFIG_MODULE_SIG_HASH=sha512
Automatically sign all modules - activate
Which hash algorithm -> SHA-512

CONFIG_MODULE_COMPRESS_ZSTD=y
Compress modules on installation - activate
Compression algorithm (ZSTD)

CONFIG_MODULE_SIG_KEY_TYPE_ECDSA=y
Cryptographic API --->
Certificates for Signature Checking --->
Type of module signing key to be generated -> ECDSA

CONFIG_MODULE_ALLOW_MISSING_NAMESPACE_IMPORTS=n
Enable Loadable module support --->
Allow loading of modules with missing namespace imports - set to no

=== Kernel command line ===

When you have confirmed that the modules are being signed and that the kernel works as it should, you can enable the following [[kernel parameter]] to require that the kernel only permits verified modules to be loaded:

module.sig_enforce=1

Before forcing verified modules on, please confirm that the system logs do not show any module signature failures being reported.

== Tools needed ==

=== kernel build package ===

In the directory where the kernel package is built:

$ mkdir certs-local

This directory will provide the tools to create the keys, as well as signing kernel modules.

Put these files into {{ic|certs-local}}:

* {{ic|x509.oot.genkey}}
* {{ic|genkeys.py}}
* {{ic|install-certs.py}}
* {{ic|sign_module.py}}
* {{ic|signer_class.py}}
* {{ic|utils.py}}

The files {{ic|genkeys.py}} and its companion configuration file {{ic|x509.oot.genkey}} are used to create key pairs.

{{ic|genkeys.py}} also provides the kernel with the key information by updating the configuration file(s) used to build the kernel.

The script {{ic|sign_module.py}} signs out-of-tree kernel modules. It can be run manually and is invoked by {{ic|dkms/kernel-sign.sh}}. It handles modules compressed with xzand gzip and depends on python-zstandard to help handle those compressed with zstd.

{{ic|genkeys.py}} will create the key pairs in a directory named by date-time

{{ic|genkeys.py}} will check and update kernel configs given by the --config config(s) option. It takes either a single config file, or a shell glob for multiple files. e.g. --config 'conf/config.*'. All configs will be updated with the same key. The default keytype is ec (elliptic curve) and the default hash is sha512. These can be changed with command line options. See {{ic|genkeys.py}} -h for more details.

It also creates a soft link {{ic|current}} to the same directory holding the current key pairs.

{{ic|install-certs.py}} is to be called from the package_headers() function of PKGBUILD to install the signing keys. Example is given below.

These files are available and links are provided below.

=== DKMS support ===

$ mkdir certs-local/dkms

Add 2 files to the {{ic|dkms}} directory:

* {{ic|kernel-sign.conf}}
* {{ic|kernel-sign.sh}}

These will be installed in {{ic|/etc/dkms}} and provide the means for DKMS to automatically sign modules using the local key. This is the recommended way to sign out-of-tree kernel modules. As explained below, once this is installed, all that is needed is for DKMS to automatically sign modules is to make a soft link for each module to the configuration file.

$ cd /etc/dkms
# ln -s kernel-sign.conf ''module_name.conf''

For example:

# ln -s kernel-sign.conf vboxdrv.conf

The link creation can easily be added to an arch package to simplify further if desired.

== Modify PKGBUILD ==

We need to make changes to kernel build as follows:

=== prepare() ===

Add the following to the top of the {{ic|prepare()}} function:

{{bc|
prepare() {

msg2 "Rebuilding local signing key..."
../certs-local/genkeys.py -v --config config

...
}
}}

The default key regeneration refresh period is 7 days, but this can be changed on the command line. So if you want to create new keys monthly, then add "--refresh 30days" as an argument to genekeys.py. You can refresh on every build by using "--refresh always". Refresh units can be seconds,minutes,hours,days or weeks.

=== _package-headers() ===

Add the following to the bottom of the {{ic|_package-headers()}} function:

{{bc|1=
_package-headers() {

...

#
# Out-of-tree module signing
# This is run in the kernel source / build directory
#
msg2 "Local Signing certs for out-of-tree modules..."

certs_local_src="../../certs-local"
certs_local_dst="${builddir}/certs-local"
$certs_local_src/install-certs.py $certs_local_dst

# DKMS tools
dkms_src="$certs_local_src/dkms"
dkms_dst="${pkgdir}/etc/dkms"
mkdir -p $dkms_dst

rsync -a $dkms_src/{kernel-sign.conf,kernel-sign.sh} $dkms_dst/
}
}}

== Files required ==

The 5 supporting files referenced above are available for download from the [https://github.com/gene-git/Arch-SKM/tree/master github.com/gene-git/Arch-SKM] repository:

{{Note|There is also an aur version of these files available ({{AUR|arch-sign-modules}}). After building and install they can be found at {{ic|/usr/src/certs-local}}
}}

* [https://github.com/gene-git/Arch-SKM/blob/master/certs-local/x509.oot.genkey certs-local/x509.oot.genkey]
* [https://github.com/gene-git/Arch-SKM/blob/master/certs-local/genkeys.py certs-local/genkeys.py]
* [https://github.com/gene-git/Arch-SKM/blob/master/certs-local/install-certs.py certs-local/install-certs.py]
* [https://github.com/gene-git/Arch-SKM/blob/master/certs-local/sign_module.py certs-local/sign_module.py]
* [https://github.com/gene-git/Arch-SKM/blob/master/certs-local/signer_classpy certs-local/signer_class.py]
* [https://github.com/gene-git/Arch-SKM/blob/master/certs-local/utils.py certs-local/utils.py]
* [https://github.com/gene-git/Arch-SKM/blob/master/certs-local/dkms/kernel-sign.conf certs-local/dkms/kernel-sign.conf]
* [https://github.com/gene-git/Arch-SKM/blob/master/certs-local/dkms/kernel-sign.sh certs-local/dkms/kernel-sign.sh]

Remember to ensure that the scripts are [[executable]].

== Helper scripts ==

{{Accuracy|The {{AUR|arch-sign-modules}} package comes from a fork of the [https://github.com/gene-git/Arch-SKM/tree/master Arch-SKM] repository which is used in the previous sections. It is not clear what is wrong with the original repository nor why changes resulted in a fork instead of fixing/improving the original repository.}}

{{AUR|arch-sign-modules}} builds:
* {{Pkg|linux-hardened}}
* {{Pkg|linux-lts}}
* {{Pkg|linux-zen}}
* {{Pkg|linux}}
* {{AUR|linux-amd}}
* {{AUR|linux-ck}}
* {{AUR|linux-libre}}

& other AUR kernels.

The '''''abk''''' helper script reduces the manual steps for building a fully signed custom kernel to 3 commands to '''''Update''''' / '''''Build''''' & '''''Install''''' the kernel:

abk -u kernel-name
abk -b kernel-name
abk -i kernel-name

With signed kernel module support for:

*{{AUR|zfs-dkms}} {{AUR|nvidia-beta-dkms}} {{AUR|lkrg-dkms}} {{Pkg|nvidia-dkms}}