identity: improve the documentation for Principal.Name()

Clarify that the must match proof of possession Signed-off-by: Nathan Smith <[email protected]>
sigstore · May 12, 2022 · 3b7c790 · 3b7c790
1 parent 8d307b5
commit 3b7c790
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/pkg/identity/principal.go b/pkg/identity/principal.go
@@ -20,7 +20,8 @@ import (
 )
 
 type Principal interface {
-	// URI, email etc of principal
+	// Name is the email or subject of OIDC ID token. This value must match the
+	// value signed in the proof of private key possession challenge.
 	Name(ctx context.Context) string
 
 	// Embed all SubjectAltName and custom x509 extension information into