Replace ServiceAddress by libsignal_protocol::ServiceId

src/account_manager.rs

@@ -7,9 +7,9 @@ use aes::cipher::{KeyIvInit, StreamCipher as _};
 use hmac::digest::Output;
 use hmac::{Hmac, Mac};
 use libsignal_protocol::{
-    kem, GenericSignedPreKey, IdentityKey, IdentityKeyPair, IdentityKeyStore,
-    KeyPair, KyberPreKeyRecord, PrivateKey, ProtocolStore, PublicKey,
-    SenderKeyStore, SignedPreKeyRecord, Timestamp,
+    kem, Aci, GenericSignedPreKey, IdentityKey, IdentityKeyPair,
+    IdentityKeyStore, KeyPair, KyberPreKeyRecord, PrivateKey, ProtocolStore,
+    PublicKey, SenderKeyStore, SignedPreKeyRecord, Timestamp,
 };
 use prost::Message;
 use serde::{Deserialize, Serialize};
@@ -33,10 +33,10 @@ use crate::push_service::{
     DEFAULT_DEVICE_ID,
 };
 use crate::sender::OutgoingPushMessage;
+use crate::service_address::ServiceIdExt;
 use crate::session_store::SessionStoreExt;
 use crate::timestamp::TimestampExt as _;
 use crate::utils::{random_length_padding, BASE64_RELAXED};
-use crate::ServiceAddress;
 use crate::{
     configuration::{Endpoint, ServiceCredentials},
     pre_keys::PreKeyState,
@@ -486,7 +486,7 @@ impl AccountManager {
 
     pub async fn retrieve_profile(
         &mut self,
-        address: ServiceAddress,
+        address: Aci,
     ) -> Result<Profile, ProfileManagerError> {
         let profile_key =
             self.profile_key.expect("set profile key in AccountManager");
@@ -628,19 +628,19 @@ impl AccountManager {
     /// Should be called as the primary device to migrate from pre-PNI to PNI.
     ///
     /// This is the equivalent of Android's PnpInitializeDevicesJob or iOS' PniHelloWorldManager.
-    #[tracing::instrument(skip(self, aci_protocol_store, pni_protocol_store, sender, local_aci, csprng), fields(local_aci = %local_aci))]
+    #[tracing::instrument(skip(self, aci_protocol_store, pni_protocol_store, sender, local_aci, csprng), fields(local_aci =% local_aci.service_id_string()))]
     pub async fn pnp_initialize_devices<
         // XXX So many constraints here, all imposed by the MessageSender
         R: rand::Rng + rand::CryptoRng,
-        Aci: PreKeysStore + SessionStoreExt,
-        Pni: PreKeysStore,
+        AciStore: PreKeysStore + SessionStoreExt,
+        PniStore: PreKeysStore,
         AciOrPni: ProtocolStore + SenderKeyStore + SessionStoreExt + Sync + Clone,
     >(
         &mut self,
-        aci_protocol_store: &mut Aci,
-        pni_protocol_store: &mut Pni,
+        aci_protocol_store: &mut AciStore,
+        pni_protocol_store: &mut PniStore,
         mut sender: MessageSender<AciOrPni, R>,
-        local_aci: ServiceAddress,
+        local_aci: Aci,
         e164: PhoneNumber,
         csprng: &mut R,
     ) -> Result<(), MessageSenderError> {
@@ -651,7 +651,7 @@ impl AccountManager {
 
         // For every linked device, we generate a new set of pre-keys, and send them to the device.
         let local_device_ids = aci_protocol_store
-            .get_sub_device_sessions(&local_aci)
+            .get_sub_device_sessions(&local_aci.into())
             .await?;
 
         let mut device_messages =
@@ -795,7 +795,7 @@ impl AccountManager {
             let content: ContentBody = msg.into();
             let msg = sender
                 .create_encrypted_message(
-                    &local_aci,
+                    &local_aci.into(),
                     None,
                     local_device_id.into(),
                     &content.into_proto().encode_to_vec(),

src/cipher.rs

@@ -9,8 +9,8 @@ use libsignal_protocol::{
     CiphertextMessageType, DeviceId, IdentityKeyStore, KyberPreKeyStore,
     PreKeySignalMessage, PreKeyStore, ProtocolAddress, ProtocolStore,
     PublicKey, SealedSenderDecryptionResult, SenderCertificate,
-    SenderKeyDistributionMessage, SenderKeyStore, SessionStore, SignalMessage,
-    SignalProtocolError, SignedPreKeyStore, Timestamp,
+    SenderKeyDistributionMessage, SenderKeyStore, ServiceId, SessionStore,
+    SignalMessage, SignalProtocolError, SignedPreKeyStore, Timestamp,
 };
 use prost::Message;
 use rand::{CryptoRng, Rng};
@@ -23,7 +23,7 @@ use crate::{
     sender::OutgoingPushMessage,
     session_store::SessionStoreExt,
     utils::BASE64_RELAXED,
-    ServiceAddress,
+    ServiceIdExt,
 };
 /// Decrypts incoming messages and encrypts outgoing messages.
 ///
@@ -277,13 +277,16 @@ where
                 )
                 .await?;
 
-                let sender = ServiceAddress::try_from(sender_uuid.as_str())
-                    .map_err(|e| {
-                        tracing::error!("{:?}", e);
-                        SignalProtocolError::InvalidSealedSenderMessage(
-                            "invalid sender UUID".to_string(),
-                        )
-                    })?;
+                let sender =
+                    ServiceId::parse_from_service_id_string(&sender_uuid)
+                        .ok_or_else(|| {
+                            tracing::error!(
+                                "failed to parse ServiceId from string"
+                            );
+                            SignalProtocolError::InvalidSealedSenderMessage(
+                                "invalid sender UUID".to_string(),
+                            )
+                        })?;
 
                 let needs_receipt = if envelope.source_service_id.is_some() {
                     tracing::warn!(?envelope, "Received an unidentified delivery over an identified channel.  Marking needs_receipt=false");
@@ -461,7 +464,7 @@ fn strip_padding(contents: &mut Vec<u8>) -> Result<(), ServiceError> {
 /// Equivalent of `SignalServiceCipher::getPreferredProtocolAddress`
 pub async fn get_preferred_protocol_address<S: SessionStore>(
     session_store: &S,
-    address: &ServiceAddress,
+    address: &ServiceId,
     device_id: DeviceId,
 ) -> Result<ProtocolAddress, libsignal_protocol::error::SignalProtocolError> {
     let address = address.to_protocol_address(device_id);

src/content.rs

@@ -1,6 +1,7 @@
-use libsignal_protocol::ProtocolAddress;
+use libsignal_protocol::{ProtocolAddress, ServiceId};
 use uuid::Uuid;
 
+use crate::ServiceIdExt;
 pub use crate::{
     proto::{
         attachment_pointer::Flags as AttachmentPointerFlags,
@@ -18,8 +19,8 @@ mod story_message;
 
 #[derive(Clone, Debug)]
 pub struct Metadata {
-    pub sender: crate::ServiceAddress,
-    pub destination: crate::ServiceAddress,
+    pub sender: ServiceId,
+    pub destination: ServiceId,
     pub sender_device: u32,
     pub timestamp: u64,
     pub needs_receipt: bool,

src/envelope.rs

@@ -1,30 +1,15 @@
-use std::convert::{TryFrom, TryInto};
-
 use aes::cipher::block_padding::Pkcs7;
 use aes::cipher::{BlockDecryptMut, KeyIvInit};
+use libsignal_protocol::ServiceId;
 use prost::Message;
 
 use crate::{
     configuration::SignalingKey, push_service::ServiceError,
-    utils::serde_optional_base64, ParseServiceAddressError, ServiceAddress,
+    utils::serde_optional_base64,
 };
 
 pub use crate::proto::Envelope;
 
-impl TryFrom<EnvelopeEntity> for Envelope {
-    type Error = ParseServiceAddressError;
-
-    fn try_from(entity: EnvelopeEntity) -> Result<Self, Self::Error> {
-        match entity.source_uuid.as_deref() {
-            Some(uuid) => {
-                let address = uuid.try_into()?;
-                Ok(Envelope::new_with_source(entity, address))
-            },
-            None => Ok(Envelope::new_from_entity(entity)),
-        }
-    }
-}
-
 impl Envelope {
     #[tracing::instrument(skip(input, signaling_key), fields(input_size = input.len()))]
     pub fn decrypt(
@@ -85,29 +70,6 @@ impl Envelope {
         }
     }
 
-    fn new_from_entity(entity: EnvelopeEntity) -> Self {
-        Envelope {
-            r#type: Some(entity.r#type),
-            timestamp: Some(entity.timestamp),
-            server_timestamp: Some(entity.server_timestamp),
-            server_guid: entity.source_uuid,
-            content: entity.content,
-            ..Default::default()
-        }
-    }
-
-    fn new_with_source(entity: EnvelopeEntity, source: ServiceAddress) -> Self {
-        Envelope {
-            r#type: Some(entity.r#type),
-            source_device: Some(entity.source_device),
-            timestamp: Some(entity.timestamp),
-            server_timestamp: Some(entity.server_timestamp),
-            source_service_id: Some(source.uuid.to_string()),
-            content: entity.content,
-            ..Default::default()
-        }
-    }
-
     pub fn is_unidentified_sender(&self) -> bool {
         self.r#type() == crate::proto::envelope::Type::UnidentifiedSender
     }
@@ -133,18 +95,22 @@ impl Envelope {
         self.story.unwrap_or(false)
     }
 
-    pub fn source_address(&self) -> ServiceAddress {
+    pub fn source_address(&self) -> ServiceId {
         match self.source_service_id.as_deref() {
-            Some(service_id) => ServiceAddress::try_from(service_id)
-                .expect("invalid source ProtocolAddress UUID or prefix"),
+            Some(service_id) => {
+                ServiceId::parse_from_service_id_string(service_id)
+                    .expect("invalid source ProtocolAddress UUID or prefix")
+            },
             None => panic!("source_service_id is set"),
         }
     }
 
-    pub fn destination_address(&self) -> ServiceAddress {
+    pub fn destination_address(&self) -> ServiceId {
         match self.destination_service_id.as_deref() {
-            Some(service_id) => ServiceAddress::try_from(service_id)
-                .expect("invalid destination ProtocolAddress UUID or prefix"),
+            Some(service_id) => ServiceId::parse_from_service_id_string(
+                service_id,
+            )
+            .expect("invalid destination ProtocolAddress UUID or prefix"),
             None => panic!("destination_address is set"),
         }
     }

src/groups_v2/model.rs

@@ -1,12 +1,11 @@
 use std::{convert::TryFrom, convert::TryInto};
 
 use derivative::Derivative;
+use libsignal_protocol::ServiceId;
 use serde::{Deserialize, Serialize};
 use uuid::Uuid;
 use zkgroup::profiles::ProfileKey;
 
-use crate::ServiceAddress;
-
 use super::GroupDecodingError;
 
 #[derive(Copy, Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
@@ -34,7 +33,7 @@ impl PartialEq for Member {
 
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub struct PendingMember {
-    pub address: ServiceAddress,
+    pub address: ServiceId,
     pub role: Role,
     pub added_by_uuid: Uuid,
     pub timestamp: u64,

src/lib.rs

@@ -49,7 +49,6 @@ pub const GROUP_UPDATE_FLAG: u32 = 1;
 pub const GROUP_LEAVE_FLAG: u32 = 2;
 
 pub mod prelude {
-    pub use super::ServiceAddress;
     pub use crate::{
         cipher::ServiceCipher,
         configuration::{

src/profile_service.rs

@@ -1,8 +1,10 @@
+use libsignal_protocol::ServiceId;
+
 use crate::{
     proto::WebSocketRequestMessage,
     push_service::{ServiceError, SignalServiceProfile},
     websocket::SignalWebSocket,
-    ServiceAddress,
+    ServiceIdExt,
 };
 
 pub struct ProfileService {
@@ -16,7 +18,7 @@ impl ProfileService {
 
     pub async fn retrieve_profile_by_id(
         &mut self,
-        address: ServiceAddress,
+        address: ServiceId,
         profile_key: Option<zkgroup::profiles::ProfileKey>,
     ) -> Result<SignalServiceProfile, ServiceError> {
         let endpoint = match profile_key {
@@ -27,10 +29,10 @@ impl ProfileService {
                     ))?;
                 let version = std::str::from_utf8(&version)
                     .expect("hex encoded profile key version");
-                format!("/v1/profile/{}/{}", address.uuid, version)
+                format!("/v1/profile/{}/{}", address.raw_uuid(), version)
             },
             None => {
-                format!("/v1/profile/{}", address.uuid)
+                format!("/v1/profile/{}", address.raw_uuid())
             },
         };
 

src/push_service/error.rs

@@ -1,7 +1,7 @@
 use libsignal_protocol::SignalProtocolError;
 use zkgroup::ZkGroupDeserializationFailure;
 
-use crate::{groups_v2::GroupDecodingError, ParseServiceAddressError};
+use crate::groups_v2::GroupDecodingError;
 
 use super::{
     MismatchedDevices, ProofRequired, RegistrationLockFailure, StaleDevices,
@@ -77,9 +77,6 @@ pub enum ServiceError {
     #[error("unsupported content")]
     UnsupportedContent,
 
-    #[error(transparent)]
-    ParseServiceAddress(#[from] ParseServiceAddressError),
-
     #[error("Not found.")]
     NotFoundError,
 

src/push_service/keys.rs

@@ -1,6 +1,8 @@
 use std::collections::HashMap;
 
-use libsignal_protocol::{IdentityKey, PreKeyBundle, SenderCertificate};
+use libsignal_protocol::{
+    IdentityKey, PreKeyBundle, SenderCertificate, ServiceId,
+};
 use serde::Deserialize;
 
 use crate::{
@@ -9,7 +11,6 @@ use crate::{
     push_service::PreKeyResponse,
     sender::OutgoingPushMessage,
     utils::serde_base64,
-    ServiceAddress,
 };
 
 use super::{
@@ -60,11 +61,14 @@ impl PushService {
 
     pub async fn get_pre_key(
         &mut self,
-        destination: &ServiceAddress,
+        destination: &ServiceId,
         device_id: u32,
     ) -> Result<PreKeyBundle, ServiceError> {
-        let path =
-            format!("/v2/keys/{}/{}?pq=true", destination.uuid, device_id);
+        let path = format!(
+            "/v2/keys/{}/{}?pq=true",
+            destination.raw_uuid(),
+            device_id
+        );
 
         let mut pre_key_response: PreKeyResponse = self
             .get_json(
@@ -83,13 +87,13 @@ impl PushService {
 
     pub(crate) async fn get_pre_keys(
         &mut self,
-        destination: &ServiceAddress,
+        destination: &ServiceId,
         device_id: u32,
     ) -> Result<Vec<PreKeyBundle>, ServiceError> {
         let path = if device_id == 1 {
-            format!("/v2/keys/{}/*?pq=true", destination.uuid)
+            format!("/v2/keys/{}/*?pq=true", destination.raw_uuid())
         } else {
-            format!("/v2/keys/{}/{}?pq=true", destination.uuid, device_id)
+            format!("/v2/keys/{}/{}?pq=true", destination.raw_uuid(), device_id)
         };
         let pre_key_response: PreKeyResponse = self
             .get_json(