fix: update comment

Signed-off-by: Junjie Gao <[email protected]>
JeyJeyGao · Sep 20, 2022 · 0af93b2 · 0af93b2
1 parent cd5cadf
commit 0af93b2
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/signature/jws/jws.go b/signature/jws/jws.go
@@ -31,7 +31,7 @@ func parseProtectedHeaders(encoded string) (*jwsProtectedHeader, error) {
 	}
 
 	// delete attributes that are already defined in jwsProtectedHeader.
-	for _, headerKey := range knownHeaderKeys {
+	for _, headerKey := range headerKeys {
 		delete(protected.ExtendedAttributes, headerKey)
 	}
 	return &protected, nil

diff --git a/signature/jws/types.go b/signature/jws/types.go
@@ -17,7 +17,9 @@ const (
 	headerKeyAuthenticSigningTime = "io.cncf.notary.authenticSigningTime"
 )
 
-var knownHeaderKeys = []string{
+// headerKeys includes all system aware keys for JWS protected header
+// [JWS envelope]: https://github.com/notaryproject/notaryproject/blob/main/signature-envelope-jws.md#protected-headers
+var headerKeys = []string{
 	headerKeyAlg,
 	headerKeyCty,
 	headerKeyCrit,