Replace reason uint8 with packet.ReasonForRevocation enum

Author: twiss

openpgp/keys.go

@@ -634,36 +634,17 @@ func (e *Entity) SignIdentity(identity string, signer *Entity, config *packet.Co
 	return nil
 }
 
-// validRevocationReason reports whether the given revocation reason code is valid
-// as per RFC4880 section-5.2.3.23.
-func validRevocationReason(r uint8) bool {
-	switch r {
-	// Defined in RFC4880 section-5.2.3.23
-	case 0, 1, 2, 3, 32:
-		return true
-	default:
-		// Private use (RFC4880 section-5.2.3.23)
-		if 100 <= r && r <= 110 {
-			return true
-		}
-		return false
-	}
-}
-
 // RevokeKey generates a key revocation signature (packet.SigTypeKeyRevocation) with the
 // specified reason code and text (RFC4880 section-5.2.3.23).
 // If config is nil, sensible defaults will be used.
-func (e *Entity) RevokeKey(reason uint8, reasonText string, config *packet.Config) error {
-	if !validRevocationReason(reason) {
-		return errors.InvalidArgumentError("invalid reason code")
-	}
-
+func (e *Entity) RevokeKey(reason packet.ReasonForRevocation, reasonText string, config *packet.Config) error {
+	reasonCode := uint8(reason)
 	revSig := &packet.Signature{
 		CreationTime:         config.Now(),
 		SigType:              packet.SigTypeKeyRevocation,
 		PubKeyAlgo:           packet.PubKeyAlgoRSA,
 		Hash:                 config.Hash(),
-		RevocationReason:     &reason,
+		RevocationReason:     &reasonCode,
 		RevocationReasonText: reasonText,
 		IssuerKeyId:          &e.PrimaryKey.KeyId,
 	}
@@ -678,21 +659,18 @@ func (e *Entity) RevokeKey(reason uint8, reasonText string, config *packet.Confi
 // RevokeSubkey generates a subkey revocation signature (packet.SigTypeSubkeyRevocation) for
 // a subkey with the specified reason code and text (RFC4880 section-5.2.3.23).
 // If config is nil, sensible defaults will be used.
-func (e *Entity) RevokeSubkey(sk *Subkey, reason uint8, reasonText string, config *packet.Config) error {
-	if !validRevocationReason(reason) {
-		return errors.InvalidArgumentError("invalid reason code")
-	}
-
+func (e *Entity) RevokeSubkey(sk *Subkey, reason packet.ReasonForRevocation, reasonText string, config *packet.Config) error {
 	if err := e.PrimaryKey.VerifyKeySignature(sk.PublicKey, sk.Sig); err != nil {
 		return errors.InvalidArgumentError("given subkey is not associated with this key")
 	}
 
+	reasonCode := uint8(reason)
 	revSig := &packet.Signature{
 		CreationTime:         config.Now(),
 		SigType:              packet.SigTypeSubkeyRevocation,
 		PubKeyAlgo:           packet.PubKeyAlgoRSA,
 		Hash:                 config.Hash(),
-		RevocationReason:     &reason,
+		RevocationReason:     &reasonCode,
 		RevocationReasonText: reasonText,
 		IssuerKeyId:          &e.PrimaryKey.KeyId,
 	}

openpgp/keys_test.go

@@ -749,7 +749,7 @@ func TestRevokeKey(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	err = entity.RevokeKey(0, "Key revocation", nil)
+	err = entity.RevokeKey(packet.NoReason, "Key revocation", nil)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -776,7 +776,7 @@ func TestRevokeKeyWithConfig(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	err = entity.RevokeKey(0, "Key revocation", c)
+	err = entity.RevokeKey(packet.NoReason, "Key revocation", c)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -805,7 +805,7 @@ func TestRevokeSubkey(t *testing.T) {
 	}
 
 	sk := &entity.Subkeys[0]
-	err = entity.RevokeSubkey(sk, 0, "Key revocation", nil)
+	err = entity.RevokeSubkey(sk, packet.NoReason, "Key revocation", nil)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -852,7 +852,7 @@ func TestRevokeSubkeyWithAnotherEntity(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	err = newEntity.RevokeSubkey(&sk, 0, "Key revocation", nil)
+	err = newEntity.RevokeSubkey(&sk, packet.NoReason, "Key revocation", nil)
 	if err == nil {
 		t.Fatal("Entity was able to revoke a subkey owned by a different entity")
 	}
@@ -867,7 +867,7 @@ func TestRevokeSubkeyWithInvalidSignature(t *testing.T) {
 	sk := entity.Subkeys[0]
 	sk.Sig = &packet.Signature{}
 
-	err = entity.RevokeSubkey(&sk, 0, "Key revocation", nil)
+	err = entity.RevokeSubkey(&sk, packet.NoReason, "Key revocation", nil)
 	if err == nil {
 		t.Fatal("Entity was able to revoke a subkey with invalid signature")
 	}
@@ -884,7 +884,7 @@ func TestRevokeSubkeyWithConfig(t *testing.T) {
 	}
 
 	sk := entity.Subkeys[0]
-	err = entity.RevokeSubkey(&sk, 0, "Key revocation", c)
+	err = entity.RevokeSubkey(&sk, packet.NoReason, "Key revocation", c)
 	if err != nil {
 		t.Fatal(err)
 	}

openpgp/packet/packet.go

@@ -540,3 +540,14 @@ func (mode AEADMode) TagLength() int {
 func (mode AEADMode) new(block cipher.Block) cipher.AEAD {
 	return algorithm.AEADMode(mode).New(block)
 }
+
+// ReasonForRevocation represents a revocation reason code as per RFC4880
+// section 5.2.3.23.
+type ReasonForRevocation uint8
+
+const (
+	NoReason       ReasonForRevocation = 0
+	KeySuperseded  ReasonForRevocation = 1
+	KeyCompromised ReasonForRevocation = 2
+	KeyRetired     ReasonForRevocation = 3
+)