chore: add PkeskVersion, SkeskVersion types

hko-s · hko-s · commit bc7946032241 · 2024-09-23T16:24:35.000+02:00
diff --git a/src/composed/message/types.rs b/src/composed/message/types.rs
@@ -24,8 +24,8 @@ use crate::packet::{
 };
 use crate::ser::Serialize;
 use crate::types::{
-    CompressionAlgorithm, EskType, Fingerprint, KeyId, KeyVersion, PublicKeyTrait, SecretKeyTrait,
-    StringToKey, Tag,
+    CompressionAlgorithm, EskType, Fingerprint, KeyId, KeyVersion, PkeskVersion, PublicKeyTrait,
+    SecretKeyTrait, StringToKey, Tag,
 };
 
 /// An [OpenPGP message](https://www.rfc-editor.org/rfc/rfc9580.html#name-openpgp-messages)
@@ -702,9 +702,11 @@ impl Message {
                     .iter()
                     .map(|(pkesk, encoding_key, encoding_subkey)| {
                         let typ = match pkesk.version() {
-                            3 => EskType::V3_4,
-                            6 => EskType::V6,
-                            v => unimplemented_err!("Unexpected PKESK version {}", v),
+                            PkeskVersion::V3 => EskType::V3_4,
+                            PkeskVersion::V6 => EskType::V6,
+                            PkeskVersion::Other(v) => {
+                                unimplemented_err!("Unexpected PKESK version {}", v)
+                            }
                         };
 
                         if let Some(ek) = encoding_key {
diff --git a/src/packet/public_key_encrypted_session_key.rs b/src/packet/public_key_encrypted_session_key.rs
@@ -15,8 +15,8 @@ use crate::errors::{IResult, Result};
 use crate::packet::PacketTrait;
 use crate::ser::Serialize;
 use crate::types::{
-    mpi, EskType, Fingerprint, KeyId, KeyVersion, PkeskBytes, PublicKeyTrait, PublicParams, Tag,
-    Version,
+    mpi, EskType, Fingerprint, KeyId, KeyVersion, PkeskBytes, PkeskVersion, PublicKeyTrait,
+    PublicParams, Tag, Version,
 };
 
 /// Public Key Encrypted Session Key Packet (PKESK)
@@ -197,11 +197,11 @@ impl PublicKeyEncryptedSessionKey {
     }
 
     /// The version of this PKESK (currently "3" and "6" are expected values)
-    pub fn version(&self) -> u8 {
+    pub fn version(&self) -> PkeskVersion {
         match self {
-            Self::V3 { .. } => 3,
-            Self::V6 { .. } => 6,
-            Self::Other { version, .. } => *version,
+            Self::V3 { .. } => PkeskVersion::V3,
+            Self::V6 { .. } => PkeskVersion::V6,
+            Self::Other { version, .. } => PkeskVersion::Other(*version),
         }
     }
 }
@@ -378,7 +378,7 @@ fn parse(
 
 impl Serialize for PublicKeyEncryptedSessionKey {
     fn to_writer<W: io::Write>(&self, writer: &mut W) -> Result<()> {
-        writer.write_u8(self.version())?;
+        writer.write_u8(self.version().into())?;
 
         match self {
             PublicKeyEncryptedSessionKey::V3 { id, .. } => writer.write_all(id.as_ref())?,
@@ -460,7 +460,7 @@ impl Serialize for PublicKeyEncryptedSessionKey {
                 if let Some(sym_alg) = sym_alg {
                     ensure!(
                         matches!(self, PublicKeyEncryptedSessionKey::V3 { .. }),
-                        "Inconsistent: X25519 SymmetricKeyAlgorithm is set for v{} PKESK",
+                        "Inconsistent: X25519 SymmetricKeyAlgorithm is set for {:?} PKESK",
                         self.version()
                     );
 
@@ -471,7 +471,7 @@ impl Serialize for PublicKeyEncryptedSessionKey {
                 } else {
                     ensure!(
                         matches!(self, PublicKeyEncryptedSessionKey::V6 { .. }),
-                        "Inconsistent: X25519 SymmetricKeyAlgorithm is unset for v{} PKESK",
+                        "Inconsistent: X25519 SymmetricKeyAlgorithm is unset for {:?} PKESK",
                         self.version()
                     );
 
@@ -500,7 +500,7 @@ impl Serialize for PublicKeyEncryptedSessionKey {
                 if let Some(sym_alg) = sym_alg {
                     ensure!(
                         matches!(self, PublicKeyEncryptedSessionKey::V3 { .. }),
-                        "Inconsistent: X448 SymmetricKeyAlgorithm is set for v{} PKESK",
+                        "Inconsistent: X448 SymmetricKeyAlgorithm is set for {:?} PKESK",
                         self.version()
                     );
 
@@ -511,7 +511,7 @@ impl Serialize for PublicKeyEncryptedSessionKey {
                 } else {
                     ensure!(
                         matches!(self, PublicKeyEncryptedSessionKey::V6 { .. }),
-                        "Inconsistent: X448 SymmetricKeyAlgorithm is unset for v{} PKESK",
+                        "Inconsistent: X448 SymmetricKeyAlgorithm is unset for {:?} PKESK",
                         self.version()
                     );
 
diff --git a/src/packet/sym_key_encrypted_session_key.rs b/src/packet/sym_key_encrypted_session_key.rs
@@ -13,7 +13,7 @@ use crate::crypto::sym::SymmetricKeyAlgorithm;
 use crate::errors::{Error, IResult, Result};
 use crate::packet::PacketTrait;
 use crate::ser::Serialize;
-use crate::types::{s2k_parser, StringToKey, Tag, Version};
+use crate::types::{s2k_parser, SkeskVersion, StringToKey, Tag, Version};
 use crate::util::rest_len;
 use crate::PlainSessionKey;
 
@@ -84,17 +84,17 @@ impl SymKeyEncryptedSessionKey {
         }
     }
 
-    pub fn version(&self) -> u8 {
+    pub fn version(&self) -> SkeskVersion {
         // TODO: use enum
         match self {
-            Self::V4 { .. } => 4,
-            Self::V5 { .. } => 5,
-            Self::V6 { .. } => 6,
+            Self::V4 { .. } => SkeskVersion::V4,
+            Self::V5 { .. } => SkeskVersion::Other(5),
+            Self::V6 { .. } => SkeskVersion::V6,
         }
     }
 
     pub fn decrypt(&self, key: &[u8]) -> Result<PlainSessionKey> {
-        debug!("decrypt session key V{}", self.version());
+        debug!("decrypt session key {:?}", self.version());
 
         let mut decrypted_key = self.encrypted_key().map(|v| v.to_vec()).unwrap_or_default();
 
diff --git a/src/types/packet.rs b/src/types/packet.rs
@@ -182,6 +182,26 @@ impl Default for KeyVersion {
     }
 }
 
+#[derive(Debug, PartialEq, Eq, Clone, Copy, FromPrimitive, IntoPrimitive)]
+#[repr(u8)]
+pub enum PkeskVersion {
+    V3 = 3,
+    V6 = 6,
+
+    #[num_enum(catch_all)]
+    Other(u8),
+}
+
+#[derive(Debug, PartialEq, Eq, Clone, Copy, FromPrimitive, IntoPrimitive)]
+#[repr(u8)]
+pub enum SkeskVersion {
+    V4 = 4,
+    V6 = 6,
+
+    #[num_enum(catch_all)]
+    Other(u8),
+}
+
 #[cfg(test)]
 mod tests {
     #![allow(clippy::unwrap_used)]
