[mirror_ubuntu-artful-kernel.git] / certs / Kconfig

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
	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/module-signing.txt

config SYSTEM_TRUSTED_KEYRING
	bool "Provide system-wide ring of trusted keys"
	depends on KEYS
	depends on ASYMMETRIC_KEY_TYPE
	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 or already in 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> should
	  be a string of hex digits.

config EFI_SIGNATURE_LIST_PARSER
	bool "EFI signature list parser"
	depends on EFI
	select X509_CERTIFICATE_PARSER
	help
	  This option provides support for parsing EFI signature lists for
	  X.509 certificates and turning them into keys.

config LOAD_UEFI_KEYS
	bool "Load certs and blacklist from UEFI db for module checking"
	depends on SYSTEM_BLACKLIST_KEYRING
	depends on SECONDARY_TRUSTED_KEYRING
	depends on EFI
	depends on EFI_SIGNATURE_LIST_PARSER
	help
	  If the kernel is booted in secure boot mode, this option will cause
	  the kernel to load the certificates from the UEFI db and MokListRT
	  into the secondary trusted keyring.  It will also load any X.509
	  SHA256 hashes in the dbx list into the blacklist.

	  The effect of this is that, if the kernel is booted in secure boot
	  mode, modules signed with UEFI-stored keys will be permitted to be
	  loaded and keys that match the blacklist will be rejected.

endmenu
Commit	Line	Data
cfc411e7 DH	1	menu "Certificates for signature checking"
	2
	3	config MODULE_SIG_KEY
	4	string "File name or PKCS#11 URI of module signing key"
	5	default "certs/signing_key.pem"
	6	depends on MODULE_SIG
	7	help
	8	Provide the file name of a private key/certificate in PEM format,
	9	or a PKCS#11 URI according to RFC7512. The file should contain, or
	10	the URI should identify, both the certificate and its corresponding
	11	private key.
	12
	13	If this option is unchanged from its default "certs/signing_key.pem",
	14	then the kernel will automatically generate the private key and
	15	certificate as described in Documentation/module-signing.txt
	16
	17	config SYSTEM_TRUSTED_KEYRING
	18	bool "Provide system-wide ring of trusted keys"
	19	depends on KEYS
99716b7c	20	depends on ASYMMETRIC_KEY_TYPE
cfc411e7 DH	21	help
	22	Provide a system keyring to which trusted keys can be added. Keys in
	23	the keyring are considered to be trusted. Keys may be added at will
	24	by the kernel from compiled-in data and from hardware key stores, but
	25	userspace may only add extra keys if those keys can be verified by
	26	keys already in the keyring.
	27
	28	Keys in this keyring are used by module signature checking.
	29
	30	config SYSTEM_TRUSTED_KEYS
	31	string "Additional X.509 keys for default system keyring"
	32	depends on SYSTEM_TRUSTED_KEYRING
	33	help
	34	If set, this option should be the filename of a PEM-formatted file
	35	containing trusted X.509 certificates to be included in the default
	36	system keyring. Any certificate used for module signing is implicitly
	37	also trusted.
	38
	39	NOTE: If you previously provided keys for the system keyring in the
	40	form of DER-encoded *.x509 files in the top-level build directory,
	41	those are no longer used. You will need to set this option instead.
	42
c4c36105 MK	43	config SYSTEM_EXTRA_CERTIFICATE
	44	bool "Reserve area for inserting a certificate without recompiling"
	45	depends on SYSTEM_TRUSTED_KEYRING
	46	help
	47	If set, space for an extra certificate will be reserved in the kernel
	48	image. This allows introducing a trusted certificate to the default
	49	system keyring without recompiling the kernel.
	50
	51	config SYSTEM_EXTRA_CERTIFICATE_SIZE
	52	int "Number of bytes to reserve for the extra certificate"
	53	depends on SYSTEM_EXTRA_CERTIFICATE
	54	default 4096
	55	help
	56	This is the number of bytes reserved in the kernel image for a
	57	certificate to be inserted.
	58
d3bfe841 DH	59	config SECONDARY_TRUSTED_KEYRING
	60	bool "Provide a keyring to which extra trustable keys may be added"
	61	depends on SYSTEM_TRUSTED_KEYRING
	62	help
	63	If set, provide a keyring to which extra keys may be added, provided
	64	those keys are not blacklisted and are vouched for by a key built
	65	into the kernel or already in the secondary trusted keyring.
	66
734114f8 DH	67	config SYSTEM_BLACKLIST_KEYRING
	68	bool "Provide system-wide ring of blacklisted keys"
	69	depends on KEYS
	70	help
	71	Provide a system keyring to which blacklisted keys can be added.
	72	Keys in the keyring are considered entirely untrusted. Keys in this
	73	keyring are used by the module signature checking to reject loading
	74	of modules signed with a blacklisted key.
	75
	76	config SYSTEM_BLACKLIST_HASH_LIST
	77	string "Hashes to be preloaded into the system blacklist keyring"
	78	depends on SYSTEM_BLACKLIST_KEYRING
	79	help
	80	If set, this option should be the filename of a list of hashes in the
	81	form "<hash>", "<hash>", ... . This will be included into a C
	82	wrapper to incorporate the list into the kernel. Each <hash> should
	83	be a string of hex digits.
	84
608fcadc DH	85	config EFI_SIGNATURE_LIST_PARSER
	86	bool "EFI signature list parser"
	87	depends on EFI
	88	select X509_CERTIFICATE_PARSER
	89	help
	90	This option provides support for parsing EFI signature lists for
	91	X.509 certificates and turning them into keys.
	92
5ba45d15 JB	93	config LOAD_UEFI_KEYS
	94	bool "Load certs and blacklist from UEFI db for module checking"
	95	depends on SYSTEM_BLACKLIST_KEYRING
	96	depends on SECONDARY_TRUSTED_KEYRING
	97	depends on EFI
	98	depends on EFI_SIGNATURE_LIST_PARSER
	99	help
	100	If the kernel is booted in secure boot mode, this option will cause
	101	the kernel to load the certificates from the UEFI db and MokListRT
	102	into the secondary trusted keyring. It will also load any X.509
	103	SHA256 hashes in the dbx list into the blacklist.
	104
	105	The effect of this is that, if the kernel is booted in secure boot
	106	mode, modules signed with UEFI-stored keys will be permitted to be
	107	loaded and keys that match the blacklist will be rejected.
	108
cfc411e7	109	endmenu