[thirdparty/kernel/stable.git] / certs / Kconfig

# SPDX-License-Identifier: GPL-2.0
menu "Certificates for signature checking"

config MODULE_SIG_KEY
	string "File name or PKCS#11 URI of module signing key"
	default "certs/signing_key.pem"
	depends on MODULE_SIG || (IMA_APPRAISE_MODSIG && MODULES)
	help
         Provide the file name of a private key/certificate in PEM format,
         or a PKCS#11 URI according to RFC7512. The file should contain, or
         the URI should identify, both the certificate and its corresponding
         private key.

         If this option is unchanged from its default "certs/signing_key.pem",
         then the kernel will automatically generate the private key and
         certificate as described in Documentation/admin-guide/module-signing.rst

choice
	prompt "Type of module signing key to be generated"
	depends on MODULE_SIG || (IMA_APPRAISE_MODSIG && MODULES)
	help
	 The type of module signing key type to generate. This option
	 does not apply if a #PKCS11 URI is used.

config MODULE_SIG_KEY_TYPE_RSA
	bool "RSA"
	help
	 Use an RSA key for module signing.

config MODULE_SIG_KEY_TYPE_ECDSA
	bool "ECDSA"
	select CRYPTO_ECDSA
	depends on !(MODULE_SIG_SHA256 || MODULE_SIG_SHA3_256)
	help
	 Use an elliptic curve key (NIST P384) for module signing. Use
	 a strong hash of same or higher bit length, i.e. sha384 or
	 sha512 for hashing modules.

	 Note: Remove all ECDSA signing keys, e.g. certs/signing_key.pem,
	 when falling back to building Linux 5.14 and older kernels.

endchoice

config SYSTEM_TRUSTED_KEYRING
	bool "Provide system-wide ring of trusted keys"
	depends on KEYS
	depends on ASYMMETRIC_KEY_TYPE
	depends on X509_CERTIFICATE_PARSER = y
	help
	  Provide a system keyring to which trusted keys can be added.  Keys in
	  the keyring are considered to be trusted.  Keys may be added at will
	  by the kernel from compiled-in data and from hardware key stores, but
	  userspace may only add extra keys if those keys can be verified by
	  keys already in the keyring.

	  Keys in this keyring are used by module signature checking.

config SYSTEM_TRUSTED_KEYS
	string "Additional X.509 keys for default system keyring"
	depends on SYSTEM_TRUSTED_KEYRING
	help
	  If set, this option should be the filename of a PEM-formatted file
	  containing trusted X.509 certificates to be included in the default
	  system keyring. Any certificate used for module signing is implicitly
	  also trusted.

	  NOTE: If you previously provided keys for the system keyring in the
	  form of DER-encoded *.x509 files in the top-level build directory,
	  those are no longer used. You will need to set this option instead.

config SYSTEM_EXTRA_CERTIFICATE
	bool "Reserve area for inserting a certificate without recompiling"
	depends on SYSTEM_TRUSTED_KEYRING
	help
	  If set, space for an extra certificate will be reserved in the kernel
	  image. This allows introducing a trusted certificate to the default
	  system keyring without recompiling the kernel.

config SYSTEM_EXTRA_CERTIFICATE_SIZE
	int "Number of bytes to reserve for the extra certificate"
	depends on SYSTEM_EXTRA_CERTIFICATE
	default 4096
	help
	  This is the number of bytes reserved in the kernel image for a
	  certificate to be inserted.

config SECONDARY_TRUSTED_KEYRING
	bool "Provide a keyring to which extra trustable keys may be added"
	depends on SYSTEM_TRUSTED_KEYRING
	help
	  If set, provide a keyring to which extra keys may be added, provided
	  those keys are not blacklisted and are vouched for by a key built
	  into the kernel, machine keyring (if configured), or already in the
	  secondary trusted keyring.

config SECONDARY_TRUSTED_KEYRING_SIGNED_BY_BUILTIN
	bool "Only allow additional certs signed by keys on the builtin trusted keyring"
	depends on SECONDARY_TRUSTED_KEYRING
	help
	  If set, only certificates signed by keys on the builtin trusted
	  keyring may be loaded onto the secondary trusted keyring.

	  Note: The machine keyring, if configured, will be linked to the
	  secondary keyring.  When enabling this option, it is recommended
	  to also configure INTEGRITY_CA_MACHINE_KEYRING_MAX to prevent
	  linking code signing keys with imputed trust to the secondary
	  trusted keyring.

config SYSTEM_BLACKLIST_KEYRING
	bool "Provide system-wide ring of blacklisted keys"
	depends on KEYS
	help
	  Provide a system keyring to which blacklisted keys can be added.
	  Keys in the keyring are considered entirely untrusted.  Keys in this
	  keyring are used by the module signature checking to reject loading
	  of modules signed with a blacklisted key.

config SYSTEM_BLACKLIST_HASH_LIST
	string "Hashes to be preloaded into the system blacklist keyring"
	depends on SYSTEM_BLACKLIST_KEYRING
	help
	  If set, this option should be the filename of a list of hashes in the
	  form "<hash>", "<hash>", ... .  This will be included into a C
	  wrapper to incorporate the list into the kernel.  Each <hash> must be a
	  string starting with a prefix ("tbs" or "bin"), then a colon (":"), and
	  finally an even number of hexadecimal lowercase characters (up to 128).
	  Certificate hashes can be generated with
	  tools/certs/print-cert-tbs-hash.sh .

config SYSTEM_REVOCATION_LIST
	bool "Provide system-wide ring of revocation certificates"
	depends on SYSTEM_BLACKLIST_KEYRING
	depends on PKCS7_MESSAGE_PARSER=y
	help
	  If set, this allows revocation certificates to be stored in the
	  blacklist keyring and implements a hook whereby a PKCS#7 message can
	  be checked to see if it matches such a certificate.

config SYSTEM_REVOCATION_KEYS
	string "X.509 certificates to be preloaded into the system blacklist keyring"
	depends on SYSTEM_REVOCATION_LIST
	help
	  If set, this option should be the filename of a PEM-formatted file
	  containing X.509 certificates to be included in the default blacklist
	  keyring.

config SYSTEM_BLACKLIST_AUTH_UPDATE
	bool "Allow root to add signed blacklist keys"
	depends on SYSTEM_BLACKLIST_KEYRING
	depends on SYSTEM_DATA_VERIFICATION
	help
	  If set, provide the ability to load new blacklist keys at run time if
	  they are signed and vouched by a certificate from the builtin trusted
	  keyring.  The PKCS#7 signature of the description is set in the key
	  payload.  Blacklist keys cannot be removed.

endmenu
Commit	Line	Data
b2441318	1	# SPDX-License-Identifier: GPL-2.0
cfc411e7 DH	2	menu "Certificates for signature checking"
	3
	4	config MODULE_SIG_KEY
	5	string "File name or PKCS#11 URI of module signing key"
	6	default "certs/signing_key.pem"
781a5739	7	depends on MODULE_SIG \|\| (IMA_APPRAISE_MODSIG && MODULES)
cfc411e7 DH	8	help
	9	Provide the file name of a private key/certificate in PEM format,
	10	or a PKCS#11 URI according to RFC7512. The file should contain, or
	11	the URI should identify, both the certificate and its corresponding
	12	private key.
	13
	14	If this option is unchanged from its default "certs/signing_key.pem",
	15	then the kernel will automatically generate the private key and
5fb94e9c	16	certificate as described in Documentation/admin-guide/module-signing.rst
cfc411e7	17
a4aed36e SB	18	choice
a4aed36e SB	19	prompt "Type of module signing key to be generated"
be0d5fa7	20	depends on MODULE_SIG \|\| (IMA_APPRAISE_MODSIG && MODULES)
a4aed36e SB	21	help
	22	The type of module signing key type to generate. This option
	23	does not apply if a #PKCS11 URI is used.
	24
	25	config MODULE_SIG_KEY_TYPE_RSA
	26	bool "RSA"
a4aed36e SB	27	help
	28	Use an RSA key for module signing.
	29
	30	config MODULE_SIG_KEY_TYPE_ECDSA
	31	bool "ECDSA"
	32	select CRYPTO_ECDSA
446b1e0b	33	depends on !(MODULE_SIG_SHA256 \|\| MODULE_SIG_SHA3_256)
a4aed36e	34	help
d4f5bfe2 DJL	35	Use an elliptic curve key (NIST P384) for module signing. Use
	36	a strong hash of same or higher bit length, i.e. sha384 or
	37	sha512 for hashing modules.
a4aed36e SB	38
	39	Note: Remove all ECDSA signing keys, e.g. certs/signing_key.pem,
	40	when falling back to building Linux 5.14 and older kernels.
	41
	42	endchoice
	43
cfc411e7 DH	44	config SYSTEM_TRUSTED_KEYRING
	45	bool "Provide system-wide ring of trusted keys"
	46	depends on KEYS
99716b7c	47	depends on ASYMMETRIC_KEY_TYPE
2154aca2	48	depends on X509_CERTIFICATE_PARSER = y
cfc411e7 DH	49	help
	50	Provide a system keyring to which trusted keys can be added. Keys in
	51	the keyring are considered to be trusted. Keys may be added at will
	52	by the kernel from compiled-in data and from hardware key stores, but
	53	userspace may only add extra keys if those keys can be verified by
	54	keys already in the keyring.
	55
	56	Keys in this keyring are used by module signature checking.
	57
	58	config SYSTEM_TRUSTED_KEYS
	59	string "Additional X.509 keys for default system keyring"
	60	depends on SYSTEM_TRUSTED_KEYRING
	61	help
	62	If set, this option should be the filename of a PEM-formatted file
	63	containing trusted X.509 certificates to be included in the default
	64	system keyring. Any certificate used for module signing is implicitly
	65	also trusted.
	66
	67	NOTE: If you previously provided keys for the system keyring in the
	68	form of DER-encoded *.x509 files in the top-level build directory,
	69	those are no longer used. You will need to set this option instead.
	70
c4c36105 MK	71	config SYSTEM_EXTRA_CERTIFICATE
	72	bool "Reserve area for inserting a certificate without recompiling"
	73	depends on SYSTEM_TRUSTED_KEYRING
	74	help
	75	If set, space for an extra certificate will be reserved in the kernel
	76	image. This allows introducing a trusted certificate to the default
	77	system keyring without recompiling the kernel.
	78
	79	config SYSTEM_EXTRA_CERTIFICATE_SIZE
	80	int "Number of bytes to reserve for the extra certificate"
	81	depends on SYSTEM_EXTRA_CERTIFICATE
	82	default 4096
	83	help
	84	This is the number of bytes reserved in the kernel image for a
	85	certificate to be inserted.
	86
d3bfe841 DH	87	config SECONDARY_TRUSTED_KEYRING
	88	bool "Provide a keyring to which extra trustable keys may be added"
	89	depends on SYSTEM_TRUSTED_KEYRING
	90	help
	91	If set, provide a keyring to which extra keys may be added, provided
	92	those keys are not blacklisted and are vouched for by a key built
b4650306 MZ	93	into the kernel, machine keyring (if configured), or already in the
	94	secondary trusted keyring.
	95
	96	config SECONDARY_TRUSTED_KEYRING_SIGNED_BY_BUILTIN
	97	bool "Only allow additional certs signed by keys on the builtin trusted keyring"
	98	depends on SECONDARY_TRUSTED_KEYRING
	99	help
	100	If set, only certificates signed by keys on the builtin trusted
	101	keyring may be loaded onto the secondary trusted keyring.
	102
	103	Note: The machine keyring, if configured, will be linked to the
	104	secondary keyring. When enabling this option, it is recommended
	105	to also configure INTEGRITY_CA_MACHINE_KEYRING_MAX to prevent
	106	linking code signing keys with imputed trust to the secondary
	107	trusted keyring.
d3bfe841	108
734114f8 DH	109	config SYSTEM_BLACKLIST_KEYRING
	110	bool "Provide system-wide ring of blacklisted keys"
	111	depends on KEYS
	112	help
	113	Provide a system keyring to which blacklisted keys can be added.
	114	Keys in the keyring are considered entirely untrusted. Keys in this
	115	keyring are used by the module signature checking to reject loading
	116	of modules signed with a blacklisted key.
	117
	118	config SYSTEM_BLACKLIST_HASH_LIST
	119	string "Hashes to be preloaded into the system blacklist keyring"
	120	depends on SYSTEM_BLACKLIST_KEYRING
	121	help
	122	If set, this option should be the filename of a list of hashes in the
	123	form "<hash>", "<hash>", ... . This will be included into a C
addf4663 MS	124	wrapper to incorporate the list into the kernel. Each <hash> must be a
	125	string starting with a prefix ("tbs" or "bin"), then a colon (":"), and
	126	finally an even number of hexadecimal lowercase characters (up to 128).
	127	Certificate hashes can be generated with
	128	tools/certs/print-cert-tbs-hash.sh .
734114f8	129
56c58126 ES	130	config SYSTEM_REVOCATION_LIST
	131	bool "Provide system-wide ring of revocation certificates"
	132	depends on SYSTEM_BLACKLIST_KEYRING
	133	depends on PKCS7_MESSAGE_PARSER=y
	134	help
	135	If set, this allows revocation certificates to be stored in the
	136	blacklist keyring and implements a hook whereby a PKCS#7 message can
	137	be checked to see if it matches such a certificate.
	138
d1f04410 ES	139	config SYSTEM_REVOCATION_KEYS
	140	string "X.509 certificates to be preloaded into the system blacklist keyring"
	141	depends on SYSTEM_REVOCATION_LIST
	142	help
	143	If set, this option should be the filename of a PEM-formatted file
	144	containing X.509 certificates to be included in the default blacklist
	145	keyring.
	146
6364d106 MS	147	config SYSTEM_BLACKLIST_AUTH_UPDATE
	148	bool "Allow root to add signed blacklist keys"
	149	depends on SYSTEM_BLACKLIST_KEYRING
	150	depends on SYSTEM_DATA_VERIFICATION
	151	help
	152	If set, provide the ability to load new blacklist keys at run time if
	153	they are signed and vouched by a certificate from the builtin trusted
	154	keyring. The PKCS#7 signature of the description is set in the key
	155	payload. Blacklist keys cannot be removed.
	156
cfc411e7	157	endmenu