keydata.go: add doc comment for KDFAlg field

canonical · Feb 7, 2024 · 18b89e5 · 18b89e5
1 parent 8c92177
commit 18b89e5
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/keydata.go b/keydata.go
@@ -424,6 +424,9 @@ type keyData struct {
 	// the encrypted payloads.
 	PlatformHandle json.RawMessage `json:"platform_handle"`
 
+	// KDFAlg is the algorithm that is used to derive the unlock key from a primary key.
+	// It is also used to derive additional keys from the passphrase derived key in
+	// derivePassphraseKeys.
 	KDFAlg hashAlg `json:"kdf_alg,omitempty"`
 
 	// EncryptedPayload is the platform protected key payload.