backup: add avatarColor/svrPin support

indutny-signal · andrew-signal · web-flow · commit bb077db21e7a · 2025-03-04T18:08:42.000-05:00
Co-authored-by: andrew-signal &lt;andrew@signal.org&gt;
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -6,3 +6,4 @@ v0.67.2
 - Abstract Server(Private/Public)Params from endorsements. Reduces dependencies in clients and issuing servers.
 - Add EndorsementPublicRootKey accessor to ServerPublicParams.
 - Node: ChatListener has a new optional callback for server alerts. (iOS and Android coming later.)
+- Add support for avatarColor/svrPin fields in backup protos
diff --git a/rust/message-backup/src/backup/account_data.rs b/rust/message-backup/src/backup/account_data.rs
@@ -41,6 +41,7 @@ pub struct AccountData<M: Method + ReferencedTypes> {
     pub avatar_url_path: M::Value<String>,
     pub donation_subscription: M::Value<Option<Subscription>>,
     pub backup_subscription: M::Value<Option<IapSubscriberData>>,
+    pub svr_pin: M::Value<String>,
 }
 
 #[derive(Debug, serde::Serialize)]
@@ -181,6 +182,7 @@ impl<M: Method + ReferencedTypes, C: ReportUnusualTimestamp> TryFromWith<proto::
             avatarUrlPath,
             donationSubscriberData,
             backupsSubscriberData,
+            svrPin,
             special_fields: _,
         } = proto;
 
@@ -222,6 +224,7 @@ impl<M: Method + ReferencedTypes, C: ReportUnusualTimestamp> TryFromWith<proto::
             avatar_url_path: M::value(avatarUrlPath),
             donation_subscription: M::value(donation_subscription),
             backup_subscription: M::value(backup_subscription),
+            svr_pin: M::value(svrPin),
         })
     }
 }
@@ -538,6 +541,7 @@ mod test {
                     subscription_id: IapSubscriptionId::IosAppStoreOriginalTransactionId(5),
                 }),
                 donation_subscription: None,
+                svr_pin: "".to_string(),
             }
         }
     }
diff --git a/rust/message-backup/src/backup/expected_serialized_backup.json b/rust/message-backup/src/backup/expected_serialized_backup.json
@@ -61,7 +61,8 @@
       "subscription_id": {
         "IosAppStoreOriginalTransactionId": 5
       }
-    }
+    },
+    "svr_pin": ""
   },
   "recipients": [],
   "chats": [],
diff --git a/rust/message-backup/src/backup/recipient.rs b/rust/message-backup/src/backup/recipient.rs
@@ -236,7 +236,7 @@ pub enum Destination<R> {
     Group(GroupData),
     #[serde(bound(serialize = "DistributionListItem<R>: serde::Serialize"))]
     DistributionList(DistributionListItem<R>),
-    Self_,
+    Self_(SelfData),
     ReleaseNotes,
     CallLink(CallLink),
 }
@@ -300,6 +300,8 @@ pub struct ContactData {
     pub system_given_name: String,
     pub system_family_name: String,
     pub system_nickname: String,
+    #[serde(serialize_with = "serialize::optional_enum_as_string")]
+    pub avatar_color: Option<proto::AvatarColor>,
 }
 
 #[derive(Clone, Debug, serde::Serialize)]
@@ -309,6 +311,13 @@ pub struct ContactName {
     pub family_name: String,
 }
 
+#[derive(Clone, Debug, serde::Serialize)]
+#[cfg_attr(test, derive(PartialEq))]
+pub struct SelfData {
+    #[serde(serialize_with = "serialize::optional_enum_as_string")]
+    pub avatar_color: Option<proto::AvatarColor>,
+}
+
 #[derive(Clone, Debug, serde::Serialize)]
 #[cfg_attr(test, derive(PartialEq))]
 pub enum DistributionListItem<Recipient> {
@@ -378,7 +387,7 @@ impl<R> From<Destination<R>> for MinimalRecipientData {
                     distribution_id, ..
                 },
             ) => Self::DistributionList { distribution_id },
-            Destination::Self_ => Self::Self_,
+            Destination::Self_(_) => Self::Self_,
             Destination::ReleaseNotes => Self::ReleaseNotes,
             Destination::CallLink(CallLink { root_key, .. }) => Self::CallLink { root_key },
         }
@@ -431,7 +440,7 @@ impl<R> AsRef<DestinationKind> for Destination<R> {
             Destination::Contact(_) => &DestinationKind::Contact,
             Destination::Group(_) => &DestinationKind::Group,
             Destination::DistributionList(_) => &DestinationKind::DistributionList,
-            Destination::Self_ => &DestinationKind::Self_,
+            Destination::Self_(_) => &DestinationKind::Self_,
             Destination::ReleaseNotes => &DestinationKind::ReleaseNotes,
             Destination::CallLink(_) => &DestinationKind::CallLink,
         }
@@ -459,7 +468,14 @@ impl<R: Clone, C: LookupPair<RecipientId, MinimalRecipientData, R> + ReportUnusu
             RecipientDestination::DistributionList(list) => {
                 Destination::DistributionList(list.try_into_with(context)?)
             }
-            RecipientDestination::Self_(proto::Self_ { special_fields: _ }) => Destination::Self_,
+            RecipientDestination::Self_(proto::Self_ {
+                avatarColor,
+                special_fields: _,
+            }) => {
+                // The color is allowed to be unset.
+                let avatar_color = avatarColor.map(|v| v.enum_value_or_default());
+                Destination::Self_(SelfData { avatar_color })
+            }
             RecipientDestination::ReleaseNotes(proto::ReleaseNotes { special_fields: _ }) => {
                 Destination::ReleaseNotes
             }
@@ -493,6 +509,7 @@ impl<C: ReportUnusualTimestamp> TryFromWith<proto::Contact, C> for ContactData {
             systemGivenName,
             systemFamilyName,
             systemNickname,
+            avatarColor,
             special_fields: _,
         } = value;
 
@@ -595,6 +612,9 @@ impl<C: ReportUnusualTimestamp> TryFromWith<proto::Contact, C> for ContactData {
             )
             .transpose()?;
 
+        // The color is allowed to be unset.
+        let avatar_color = avatarColor.map(|v| v.enum_value_or_default());
+
         Ok(Self {
             aci,
             pni,
@@ -615,6 +635,7 @@ impl<C: ReportUnusualTimestamp> TryFromWith<proto::Contact, C> for ContactData {
             system_given_name: systemGivenName,
             system_family_name: systemFamilyName,
             system_nickname: systemNickname,
+            avatar_color,
         })
     }
 }
@@ -859,6 +880,7 @@ mod test {
                 system_family_name: "FamilySystemName".to_owned(),
                 system_nickname: "SystemNickName".to_owned(),
                 note: "nb".into(),
+                avatar_color: None,
             }
         }
     }
@@ -882,7 +904,7 @@ mod test {
 
         assert_eq!(
             Destination::try_from_with(recipient, &TestContext::default()),
-            Ok(Destination::Self_)
+            Ok(Destination::Self_(SelfData { avatar_color: None }))
         )
     }
 
diff --git a/rust/message-backup/src/backup/recipient/group.rs b/rust/message-backup/src/backup/recipient/group.rs
@@ -291,6 +291,8 @@ pub struct GroupData {
     pub story_send_mode: proto::group::StorySendMode,
     pub snapshot: GroupSnapshot,
     pub blocked: bool,
+    #[serde(serialize_with = "serialize::optional_enum_as_string")]
+    pub avatar_color: Option<proto::AvatarColor>,
     _limit_construction_to_module: (),
 }
 
@@ -304,6 +306,7 @@ impl<C: ReportUnusualTimestamp> TryFromWith<proto::Group, C> for GroupData {
             storySendMode,
             snapshot,
             blocked,
+            avatarColor,
             special_fields: _,
         } = value;
 
@@ -317,6 +320,9 @@ impl<C: ReportUnusualTimestamp> TryFromWith<proto::Group, C> for GroupData {
             | proto::group::StorySendMode::ENABLED) => s,
         };
 
+        // The color is allowed to be unset.
+        let avatar_color = avatarColor.map(|v| v.enum_value_or_default());
+
         let snapshot = snapshot
             .into_option()
             .ok_or(GroupError::MissingSnapshot)?
@@ -329,6 +335,7 @@ impl<C: ReportUnusualTimestamp> TryFromWith<proto::Group, C> for GroupData {
             story_send_mode,
             snapshot,
             blocked,
+            avatar_color,
             _limit_construction_to_module: (),
         })
     }
@@ -434,6 +441,7 @@ mod test {
                     _limit_construction_to_module: (),
                 },
                 blocked: false,
+                avatar_color: None,
                 _limit_construction_to_module: (),
             }
         }
diff --git a/rust/message-backup/src/backup/serialize.rs b/rust/message-backup/src/backup/serialize.rs
@@ -109,6 +109,14 @@ pub(crate) fn enum_as_string<S: Serializer>(
     format!("{source:?}").serialize(serializer)
 }
 
+/// Serializes [`protobuf::Enum`] types as strings.
+pub(crate) fn optional_enum_as_string<S: Serializer>(
+    source: &Option<impl protobuf::Enum>,
+    serializer: S,
+) -> Result<S::Ok, S::Error> {
+    (*source).map(|v| format!("{v:?}")).serialize(serializer)
+}
+
 /// Serializes an optional bytestring as hex.
 pub(crate) fn optional_hex<S: Serializer>(
     value: &Option<impl AsRef<[u8]>>,
@@ -216,15 +224,15 @@ impl SerializeOrder for FullRecipientData {
                 (Destination::CallLink(lhs), Destination::CallLink(rhs)) => {
                     lhs.root_key.cmp(&rhs.root_key)
                 }
-                (Destination::Self_, Destination::Self_)
+                (Destination::Self_(_), Destination::Self_(_))
                 | (Destination::ReleaseNotes, Destination::ReleaseNotes) => {
                     std::cmp::Ordering::Equal
                 }
                 _ => unreachable!("discriminants are equal"),
             }
         } else {
             let discriminant = |value: &Destination<_>| match value {
-                Destination::Self_ => 0,
+                Destination::Self_(_) => 0,
                 Destination::ReleaseNotes => 1,
                 Destination::Contact(_) => 2,
                 Destination::Group(_) => 3,
diff --git a/rust/message-backup/src/backup/testutil.rs b/rust/message-backup/src/backup/testutil.rs
@@ -12,7 +12,7 @@ use crate::backup::chat::PinOrder;
 use crate::backup::frame::RecipientId;
 use crate::backup::method::{Lookup, LookupPair};
 use crate::backup::recipient::group::GroupData;
-use crate::backup::recipient::{self, ContactData, Destination, FullRecipientData};
+use crate::backup::recipient::{self, ContactData, Destination, FullRecipientData, SelfData};
 use crate::backup::time::{ReportUnusualTimestamp, Timestamp, TimestampIssue};
 use crate::backup::{BackupMeta, Purpose};
 use crate::proto::backup as proto;
@@ -40,7 +40,7 @@ impl BackupMeta {
     }
 }
 static SELF_RECIPIENT: LazyLock<FullRecipientData> =
-    LazyLock::new(|| FullRecipientData::new(Destination::Self_));
+    LazyLock::new(|| FullRecipientData::new(Destination::Self_(SelfData { avatar_color: None })));
 static CONTACT_RECIPIENT: LazyLock<FullRecipientData> = LazyLock::new(|| {
     FullRecipientData::new(Destination::Contact(ContactData::from_proto_test_data()))
 });
@@ -64,6 +64,7 @@ static E164_ONLY_RECIPIENT: LazyLock<FullRecipientData> = LazyLock::new(|| {
         system_given_name: "".to_owned(),
         system_family_name: "".to_owned(),
         system_nickname: "".to_owned(),
+        avatar_color: None,
         note: "".into(),
     }))
 });
@@ -89,6 +90,7 @@ static PNI_ONLY_RECIPIENT: LazyLock<FullRecipientData> = LazyLock::new(|| {
         system_family_name: "".to_owned(),
         system_nickname: "".to_owned(),
         nickname: None,
+        avatar_color: None,
         note: "".into(),
     }))
 });
diff --git a/rust/message-backup/src/proto/backup.proto b/rust/message-backup/src/proto/backup.proto
@@ -117,6 +117,7 @@ message AccountData {
   reserved /*backupsSubscriberData*/ 8; // A deprecated format
   AccountSettings accountSettings = 9;
   IAPSubscriberData backupsSubscriberData = 10;
+  string svrPin = 11;
 }
 
 message Recipient {
@@ -132,6 +133,30 @@ message Recipient {
   }
 }
 
+// If unset - computed as the value of the first byte of SHA-256(msg=CONTACT_ID)
+// modulo the count of colors. Once set the avatar color for a recipient is
+// never recomputed or changed.
+//
+// `CONTACT_ID` is the first available identifier from the list:
+// - ServiceIdToBinary(ACI)
+// - E164
+// - ServiceIdToBinary(PNI)
+// - Group Id
+enum AvatarColor {
+  A100 = 0;
+  A110 = 1;
+  A120 = 2;
+  A130 = 3;
+  A140 = 4;
+  A150 = 5;
+  A160 = 6;
+  A170 = 7;
+  A180 = 8;
+  A190 = 9;
+  A200 = 10;
+  A210 = 11;
+}
+
 message Contact {
   enum IdentityState {
     DEFAULT = 0; // A valid value -- indicates unset by the user
@@ -180,6 +205,7 @@ message Contact {
   string systemGivenName = 18;
   string systemFamilyName = 19;
   string systemNickname = 20;
+  optional AvatarColor avatarColor = 21;
 }
 
 message Group {
@@ -195,6 +221,7 @@ message Group {
   StorySendMode storySendMode = 4;
   GroupSnapshot snapshot = 5;
   bool blocked = 6;
+  optional AvatarColor avatarColor = 7;
 
   // These are simply plaintext copies of the groups proto from Groups.proto.
   // They should be kept completely in-sync with Groups.proto.
@@ -274,7 +301,9 @@ message Group {
   }
 }
 
-message Self {}
+message Self {
+  optional AvatarColor avatarColor = 1;
+}
 
 message ReleaseNotes {}
 
diff --git a/rust/message-backup/src/scramble.rs b/rust/message-backup/src/scramble.rs
@@ -223,6 +223,7 @@ impl Visit<Scrambler> for proto::AccountData {
             donationSubscriberData,
             accountSettings,
             backupsSubscriberData,
+            svrPin,
             special_fields: _,
         } = self;
 
@@ -239,6 +240,7 @@ impl Visit<Scrambler> for proto::AccountData {
         donationSubscriberData.accept(visitor);
         accountSettings.accept(visitor);
         backupsSubscriberData.accept(visitor);
+        svrPin.randomize(&mut visitor.rng);
     }
 }
 
@@ -489,6 +491,7 @@ impl Visit<Scrambler> for proto::Contact {
             systemFamilyName,
             systemNickname,
             note,
+            avatarColor: _,
             special_fields: _,
         } = self;
 
@@ -570,6 +573,7 @@ impl Visit<Scrambler> for proto::Group {
             storySendMode: _,
             snapshot,
             blocked: _,
+            avatarColor: _,
             special_fields: _,
         } = self;
         masterKey.randomize(&mut visitor.rng);
@@ -724,7 +728,10 @@ impl Visit<Scrambler> for proto::DistributionListItem {
 
 impl Visit<Scrambler> for proto::Self_ {
     fn accept(&mut self, _visitor: &mut Scrambler) {
-        let Self { special_fields: _ } = self;
+        let Self {
+            avatarColor: _,
+            special_fields: _,
+        } = self;
     }
 }
 
diff --git a/rust/message-backup/tests/res/canonical-backup.expected.json b/rust/message-backup/tests/res/canonical-backup.expected.json
@@ -46,10 +46,15 @@
       "currency_code": "USD",
       "manually_canceled": true
     },
-    "backup_subscription": null
+    "backup_subscription": null,
+    "svr_pin": ""
   },
   "recipients": [
-    "Self_",
+    {
+      "Self_": {
+        "avatar_color": null
+      }
+    },
     "ReleaseNotes",
     {
       "DistributionList": {
diff --git a/rust/message-backup/tests/res/canonical-backup.scrambled.expected.json b/rust/message-backup/tests/res/canonical-backup.scrambled.expected.json

Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,7 @@ pub struct AccountData<M: Method + ReferencedTypes> {`
`41`	`41`	`pub avatar_url_path: M::Value<String>,`
`42`	`42`	`pub donation_subscription: M::Value<Option<Subscription>>,`
`43`	`43`	`pub backup_subscription: M::Value<Option<IapSubscriberData>>,`
	`44`	`+ pub svr_pin: M::Value<String>,`
`44`	`45`	`}`
`45`	`46`
`46`	`47`	`#[derive(Debug, serde::Serialize)]`
`@@ -181,6 +182,7 @@ impl<M: Method + ReferencedTypes, C: ReportUnusualTimestamp> TryFromWith<proto::`
`181`	`182`	`avatarUrlPath,`
`182`	`183`	`donationSubscriberData,`
`183`	`184`	`backupsSubscriberData,`
	`185`	`+ svrPin,`
`184`	`186`	`special_fields: _,`
`185`	`187`	`} = proto;`
`186`	`188`
`@@ -222,6 +224,7 @@ impl<M: Method + ReferencedTypes, C: ReportUnusualTimestamp> TryFromWith<proto::`
`222`	`224`	`avatar_url_path: M::value(avatarUrlPath),`
`223`	`225`	`donation_subscription: M::value(donation_subscription),`
`224`	`226`	`backup_subscription: M::value(backup_subscription),`
	`227`	`+ svr_pin: M::value(svrPin),`
`225`	`228`	`})`
`226`	`229`	`}`
`227`	`230`	`}`
`@@ -538,6 +541,7 @@ mod test {`
`538`	`541`	`subscription_id: IapSubscriptionId::IosAppStoreOriginalTransactionId(5),`
`539`	`542`	`}),`
`540`	`543`	`donation_subscription: None,`
	`544`	`+ svr_pin: "".to_string(),`
`541`	`545`	`}`
`542`	`546`	`}`
`543`	`547`	`}`