diff --git a/cmd/talosctl/cmd/mgmt/cluster/create.go b/cmd/talosctl/cmd/mgmt/cluster/create.go
index 73bff7b42..52950ffd4 100644
--- a/cmd/talosctl/cmd/mgmt/cluster/create.go
+++ b/cmd/talosctl/cmd/mgmt/cluster/create.go
@@ -563,7 +563,9 @@ func create(ctx context.Context) error {
provisionOptions = append(provisionOptions, provision.WithKMS(nethelpers.JoinHostPort("0.0.0.0", port)))
case "tpm":
keys = append(keys, &v1alpha1.EncryptionKey{
- KeyTPM: &v1alpha1.EncryptionKeyTPM{},
+ KeyTPM: &v1alpha1.EncryptionKeyTPM{
+ TPMCheckSecurebootStatusOnEnroll: pointer.To(true),
+ },
KeySlot: i,
})
default:
diff --git a/internal/pkg/encryption/keys/keys.go b/internal/pkg/encryption/keys/keys.go
index 0e38169f4..d53ca2cf1 100644
--- a/internal/pkg/encryption/keys/keys.go
+++ b/internal/pkg/encryption/keys/keys.go
@@ -48,7 +48,7 @@ func NewHandler(cfg config.EncryptionKey, options ...KeyOption) (Handler, error)
return NewKMSKeyHandler(key, cfg.KMS().Endpoint(), opts.GetSystemInformation)
case cfg.TPM() != nil:
- return NewTPMKeyHandler(key)
+ return NewTPMKeyHandler(key, cfg.TPM().CheckSecurebootOnEnroll())
}
return nil, errors.New("malformed config: no key handler can be created")
diff --git a/internal/pkg/encryption/keys/tpm2.go b/internal/pkg/encryption/keys/tpm2.go
index ca21e49a7..601c9d1fb 100644
--- a/internal/pkg/encryption/keys/tpm2.go
+++ b/internal/pkg/encryption/keys/tpm2.go
@@ -8,8 +8,10 @@ import (
"context"
"crypto/rand"
"encoding/base64"
+ "fmt"
"io"
+ "github.com/foxboron/go-uefi/efi"
"github.com/siderolabs/go-blockdevice/blockdevice/encryption"
"github.com/siderolabs/go-blockdevice/blockdevice/encryption/luks"
"github.com/siderolabs/go-blockdevice/blockdevice/encryption/token"
@@ -32,17 +34,30 @@ type TPMToken struct {
// TPMKeyHandler seals token using TPM.
type TPMKeyHandler struct {
KeyHandler
+
+ checkSecurebootOnEnroll bool
}
// NewTPMKeyHandler creates new TPMKeyHandler.
-func NewTPMKeyHandler(key KeyHandler) (*TPMKeyHandler, error) {
+func NewTPMKeyHandler(key KeyHandler, checkSecurebootOnEnroll bool) (*TPMKeyHandler, error) {
return &TPMKeyHandler{
- KeyHandler: key,
+ KeyHandler: key,
+ checkSecurebootOnEnroll: checkSecurebootOnEnroll,
}, nil
}
// NewKey implements Handler interface.
func (h *TPMKeyHandler) NewKey(ctx context.Context) (*encryption.Key, token.Token, error) {
+ if h.checkSecurebootOnEnroll {
+ if !efi.GetSecureBoot() {
+ return nil, nil, fmt.Errorf("failed to enroll the TPM2 key, as SecureBoot is disabled (and checkSecurebootOnEnroll is enabled)")
+ }
+
+ if efi.GetSetupMode() {
+ return nil, nil, fmt.Errorf("failed to enroll the TPM2 key, as the system is in SecureBoot setup mode (and checkSecurebootOnEnroll is enabled)")
+ }
+ }
+
key := make([]byte, 32)
if _, err := io.ReadFull(rand.Reader, key); err != nil {
return nil, nil, err
diff --git a/pkg/machinery/config/config/machine.go b/pkg/machinery/config/config/machine.go
index 227164859..f6b0a302c 100644
--- a/pkg/machinery/config/config/machine.go
+++ b/pkg/machinery/config/config/machine.go
@@ -396,6 +396,7 @@ type EncryptionKeyNodeID interface {
// EncryptionKeyTPM encryption key sealed by TPM.
type EncryptionKeyTPM interface {
+ CheckSecurebootOnEnroll() bool
String() string
}
diff --git a/pkg/machinery/config/schemas/config.schema.json b/pkg/machinery/config/schemas/config.schema.json
index fd59dd296..dd06d807a 100644
--- a/pkg/machinery/config/schemas/config.schema.json
+++ b/pkg/machinery/config/schemas/config.schema.json
@@ -1649,7 +1649,15 @@
"type": "object"
},
"v1alpha1.EncryptionKeyTPM": {
- "properties": {},
+ "properties": {
+ "checkSecurebootStatusOnEnroll": {
+ "type": "boolean",
+ "title": "checkSecurebootStatusOnEnroll",
+ "description": "Check that Secureboot is enabled in the EFI firmware.\nIf Secureboot is not enabled, the enrollment of the key will fail. As the TPM key is anyways bound to the value of PCR 7, changing Secureboot status or configuration after the initial enrollment will make the key unusable.\n",
+ "markdownDescription": "Check that Secureboot is enabled in the EFI firmware.\nIf Secureboot is not enabled, the enrollment of the key will fail. As the TPM key is anyways bound to the value of PCR 7, changing Secureboot status or configuration after the initial enrollment will make the key unusable.",
+ "x-intellij-html-description": "\u003cp\u003eCheck that Secureboot is enabled in the EFI firmware.\nIf Secureboot is not enabled, the enrollment of the key will fail. As the TPM key is anyways bound to the value of PCR 7, changing Secureboot status or configuration after the initial enrollment will make the key unusable.\u003c/p\u003e\n"
+ }
+ },
"additionalProperties": false,
"type": "object"
},
diff --git a/pkg/machinery/config/types/v1alpha1/v1alpha1_provider.go b/pkg/machinery/config/types/v1alpha1/v1alpha1_provider.go
index 9b6c9c3b2..d7f06f05f 100644
--- a/pkg/machinery/config/types/v1alpha1/v1alpha1_provider.go
+++ b/pkg/machinery/config/types/v1alpha1/v1alpha1_provider.go
@@ -1456,6 +1456,15 @@ func (e *EncryptionKeyTPM) String() string {
return "tpm"
}
+// CheckSecurebootOnEnroll implements the config.Provider interface.
+func (e *EncryptionKeyTPM) CheckSecurebootOnEnroll() bool {
+ if e == nil {
+ return false
+ }
+
+ return pointer.SafeDeref(e.TPMCheckSecurebootStatusOnEnroll)
+}
+
// Slot implements the config.Provider interface.
func (e *EncryptionKey) Slot() int {
return e.KeySlot
diff --git a/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go b/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go
index 7ce7209ea..419ed04ba 100644
--- a/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go
+++ b/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go
@@ -1621,7 +1621,16 @@ type EncryptionKeyKMS struct {
}
// EncryptionKeyTPM represents a key that is generated and then sealed/unsealed by the TPM.
-type EncryptionKeyTPM struct{}
+type EncryptionKeyTPM struct {
+ // description: >
+ // Check that Secureboot is enabled in the EFI firmware.
+ //
+ // If Secureboot is not enabled, the enrollment of the key will fail.
+ // As the TPM key is anyways bound to the value of PCR 7,
+ // changing Secureboot status or configuration
+ // after the initial enrollment will make the key unusable.
+ TPMCheckSecurebootStatusOnEnroll *bool `yaml:"checkSecurebootStatusOnEnroll,omitempty"`
+}
// EncryptionKeyNodeID represents deterministically generated key from the node UUID and PartitionLabel.
type EncryptionKeyNodeID struct{}
diff --git a/pkg/machinery/config/types/v1alpha1/v1alpha1_types_doc.go b/pkg/machinery/config/types/v1alpha1/v1alpha1_types_doc.go
index e985d777c..beb95fbd3 100644
--- a/pkg/machinery/config/types/v1alpha1/v1alpha1_types_doc.go
+++ b/pkg/machinery/config/types/v1alpha1/v1alpha1_types_doc.go
@@ -2183,7 +2183,15 @@ func (EncryptionKeyTPM) Doc() *encoder.Doc {
FieldName: "tpm",
},
},
- Fields: []encoder.Doc{},
+ Fields: []encoder.Doc{
+ {
+ Name: "checkSecurebootStatusOnEnroll",
+ Type: "bool",
+ Note: "",
+ Description: "Check that Secureboot is enabled in the EFI firmware.\nIf Secureboot is not enabled, the enrollment of the key will fail. As the TPM key is anyways bound to the value of PCR 7, changing Secureboot status or configuration after the initial enrollment will make the key unusable.",
+ Comments: [3]string{"" /* encoder.HeadComment */, "Check that Secureboot is enabled in the EFI firmware." /* encoder.LineComment */, "" /* encoder.FootComment */},
+ },
+ },
}
return doc
diff --git a/website/content/v1.8/reference/configuration/v1alpha1/config.md b/website/content/v1.8/reference/configuration/v1alpha1/config.md
index c39532517..9e2df8809 100644
--- a/website/content/v1.8/reference/configuration/v1alpha1/config.md
+++ b/website/content/v1.8/reference/configuration/v1alpha1/config.md
@@ -2397,6 +2397,10 @@ EncryptionKeyTPM represents a key that is generated and then sealed/unsealed by
+| Field | Type | Description | Value(s) |
+|-------|------|-------------|----------|
+|`checkSecurebootStatusOnEnroll` |bool |Check that Secureboot is enabled in the EFI firmware.
If Secureboot is not enabled, the enrollment of the key will fail. As the TPM key is anyways bound to the value of PCR 7, changing Secureboot status or configuration after the initial enrollment will make the key unusable.Check that Secureboot is enabled in the EFI firmware.
If Secureboot is not enabled, the enrollment of the key will fail. As the TPM key is anyways bound to the value of PCR 7, changing Secureboot status or configuration after the initial enrollment will make the key unusable.