Change the way ID packets are represented

Author: Nemeras

CHANGES.md

@@ -1,3 +1,11 @@
+## 1.3.0
+
+*2021-08-05*
+
+### Changed
+
+- Change the way ID packets are represented in the PGP module
+
 ## 1.2.1
 
 *2021-07-30*

README.md

@@ -31,6 +31,7 @@ Parsers for PGP (Pretty Good Privacy) encodings of DSA, RSA and Elgamal Public a
 Private keys and user IDs as defined in [RFC 4880] (https://datatracker.ietf.org/doc/html/rfc4880)
 Note that the parsers in this module expect raw byte string. They don't handle PEM armoring
 nor decode Base64 or hex.
+This module is experimental.
 
 ### `Ltpa`
 

lib/pgp.ml

@@ -340,17 +340,9 @@ module Packet = struct
   end
 
   module Id = struct
-    type t =
-      { name : string
-      ; email : string }
-    [@@deriving ord, eq, show]
+    type t = string [@@deriving ord, eq, show]
 
-    let decode cs =
-      let id = Cstruct.to_string cs in
-      let sep_id = String.split_on_char '<' id in
-      let name = String.concat "<" (List.rev (List.tl (List.rev sep_id))) in
-      let email = List.nth sep_id (List.length sep_id - 1) in
-      {name; email = String.sub email 0 (String.length email - 1)}
+    let decode cs = Cstruct.to_string cs
   end
 
   module Public_key = struct

lib/pgp.mli

@@ -148,10 +148,7 @@ module Packet : sig
   end
 
   module Id : sig
-    type t =
-      { name : string
-      ; email : string }
-    [@@deriving ord, eq, show]
+    type t = string [@@deriving ord, eq, show]
 
     val decode : Cstruct.t -> t
   end

tests/test_pgp.ml

@@ -199,8 +199,7 @@ module Elgamal = struct
   let suite = ["Public" >:: test_public]
 end
 
-let id_packet =
-  Packet.Body.Id Packet.Id.{name = "Clement "; email = "clement@test"}
+let id_packet = Packet.Body.Id "Clement <clement@test>"
 
 module Test_errors = struct
   let test_rsa_tag0 ctxt =