Better errors

Author: TaeHagen

src/aps.rs

@@ -528,7 +528,7 @@ impl APSConnectionResource {
     }
 
     pub async fn get_token(&self) -> [u8; 32] {
-        self.state.read().await.token.expect("Token not found!")
+        self.state.read().await.token.expect("Token not found; re-enter device details if persistent")
     }
 
     pub async fn request_topics(&self, topics: &[&str]) -> APSInterestToken {

src/error.rs

@@ -10,7 +10,7 @@ use plist::Value;
 use thiserror::Error;
 use tokio::{sync::{broadcast::{self, error::SendError}, Mutex}, time::error::Elapsed};
 
-use crate::{aps::APSMessage, ids::user::SupportAlert, util::ResourceFailure};
+use crate::{aps::APSMessage, ids::user::{IDSError, SupportAlert}, util::ResourceFailure};
 
 
 #[derive(Error, Debug)]
@@ -25,17 +25,17 @@ pub enum PushError {
     AuthError(plist::Value),
     #[error("Authentication establishment error {0:?}")]
     CertError(plist::Dictionary),
-    #[error("Error registering with IDS: {0}")]
-    RegisterFailed(u64),
+    #[error("Registration Error {0}")]
+    RegisterFailed(IDSError),
     #[error("IO error: {0}")]
     IoError(#[from] io::Error),
-    #[error("IDS Lookup failed {0}")]
-    LookupFailed(u64),
+    #[error("Lookup Error {0}")]
+    LookupFailed(IDSError),
     #[error("AES key error: {0:?}")]
     KeyError(KeyError),
     #[error("IDS key missing for {0}")]
     KeyNotFound(String),
-    #[error("No valid IDS targets for message")]
+    #[error("Could not deliver message. The recipient does not have iMessage or you are being rate-limited.")]
     NoValidTargets,
     #[error("Failed to connect to APS {0}")]
     APSConnectError(u8),
@@ -48,9 +48,9 @@ pub enum PushError {
     #[cfg(feature = "macos-validation-data")]
     #[error("Absinthe error {0}")]
     AbsintheError(#[from] AbsintheError),
-    #[error("{0}")]
+    #[error("Your iMessage access is temporarily disabled. Try again later, or ask Apple to allow you to use iMessage: https://apple.co/IMFT-mac. Apple left a message: {0}")]
     CustomerMessage(SupportAlert),
-    #[error("Send timeout")]
+    #[error("Send timeout; try again")]
     SendTimedOut,
     #[error("Send error {0}")]
     SendErr(i64),
@@ -63,7 +63,7 @@ pub enum PushError {
     #[error("Failed to authenticate. Try logging in to account.apple.com to fix your Apple Account or create a new one: {1:?} {0}")]
     MobileMeError(String, Option<String>),
     #[error("Bad auth cert {0}")]
-    AuthInvalid(u64),
+    AuthInvalid(IDSError),
     #[error("APS parse error {0}")]
     APSParseError(#[from] DekuError),
     #[error("Other side hung up! {0}")]
@@ -118,7 +118,7 @@ pub enum PushError {
     ProtobufError(#[from] prost::DecodeError),
     #[error("Alias error {0}")]
     AliasError(u32),
-    #[error("Handle not found {0}")]
+    #[error("The handle {0} no longer exists on your account. Did you lose your number? Go to the new chat creator to use a different handle.")]
     HandleNotFound(String),
     #[error("AES GCM error")]
     AESGCMError,

src/ids/identity_manager.rs

@@ -16,7 +16,7 @@ use uuid::Uuid;
 use std::str::FromStr;
 use std::fmt::Debug;
 
-use crate::{APSConnectionResource, APSMessage, IDSUser, MessageInst, OSConfig, PushError, aps::{APSConnection, APSInterestToken, get_message}, ids::{MessageBody, user::{IDSLookupUser}}, register, util::{Resource, ResourceManager, base64_decode, base64_encode, bin_deserialize, bin_deserialize_sha, bin_serialize, duration_since_epoch, encode_hex, plist_to_bin, plist_to_string, ungzip}};
+use crate::{APSConnectionResource, APSMessage, IDSUser, MessageInst, OSConfig, PushError, aps::{APSConnection, APSInterestToken, get_message}, ids::{MessageBody, user::{IDSError, IDSLookupUser}}, register, util::{Resource, ResourceManager, base64_decode, base64_encode, bin_deserialize, bin_deserialize_sha, bin_serialize, duration_since_epoch, encode_hex, plist_to_bin, plist_to_string, ungzip}};
 
 use super::{user::{IDSDeliveryData, IDSNGMIdentity, IDSPublicIdentity, IDSService, IDSUserIdentity, IDSUserType, PrivateDeviceInfo, QueryOptions, ReportMessage}, CertifiedContext, IDSRecvMessage};
 
@@ -368,7 +368,7 @@ impl Resource for IdentityResource {
             debug!("Register failed {}!", err);
             drop(users_lock);
 
-            let needs_relog = matches!(err, PushError::AuthInvalid(6005) | PushError::RegisterFailed(6005));
+            let needs_relog = matches!(err, PushError::AuthInvalid(IDSError(6005)) | PushError::RegisterFailed(IDSError(6005)));
             return Err(if needs_relog {
                 info!("Auth returns 6005, relog required!");
                 PushError::DoNotRetry(Box::new(err))
@@ -690,7 +690,7 @@ impl IdentityResource {
            let results = match self.user_by_handle(topic, &users, handle).await?.query(&*self.config, &self.aps, topic, self.get_main_service(topic), handle, chunk, meta).await {
                Ok(results) => results,
                Err(err) => {
-                   if let PushError::LookupFailed(6005) = err {
+                   if let PushError::LookupFailed(IDSError(6005)) = err {
                        warn!("IDS returned 6005; attempting to re-register");
                        drop(users);
                        drop(id_lock);

src/ids/user.rs

@@ -830,7 +830,7 @@ impl IDSUser {
 
         let parsed: HandleResult = plist::from_bytes(&request)?;
         let Some(handles) = parsed.handles else {
-            return Err(PushError::AuthInvalid(parsed.status))
+            return Err(PushError::AuthInvalid(IDSError(parsed.status)))
         };
 
         Ok(handles)
@@ -851,7 +851,7 @@ impl IDSUser {
 
         let status = parsed.as_dictionary().unwrap()["status"].as_unsigned_integer().unwrap();
         if status != 0 {
-            return Err(PushError::AuthInvalid(status))
+            return Err(PushError::AuthInvalid(IDSError(status)))
         }
 
         let devices = parsed.as_dictionary().unwrap().get("registrations").unwrap().as_array().unwrap();
@@ -992,13 +992,28 @@ impl IDSUser {
 
         let loaded: IDSLookupResp = plist::from_bytes(&request)?;
         if loaded.status != 0 || loaded.results.is_none() {
-            return Err(PushError::LookupFailed(loaded.status))
+            return Err(PushError::LookupFailed(IDSError(loaded.status)))
         }
 
         Ok(loaded.results.unwrap())
     }
 }
 
+#[derive(Debug)]
+pub struct IDSError(pub u64);
+
+impl Display for IDSError {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        match self.0 {
+            6001 => write!(f, "Incompatible; Make sure Contact Key Verification and Advanced Data Protection are off. (6001)"),
+            6004 => write!(f, "Please try again (6004)"),
+            6005 => write!(f, "Bad authentication, try again and re-enter device details if persistent. (6005)"),
+            6009 => write!(f, "Your iMessage access is temporarily disabled. Try again later, or ask Apple to allow you to use iMessage: https://apple.co/IMFT-mac (6009)"),
+            _unk => write!(f, "Unknown IDS error {_unk}")
+        }
+    }
+}
+
 pub struct IDSService {
     pub name: &'static str,
     pub sub_services: &'static [&'static str],
@@ -1110,7 +1125,7 @@ pub async fn register(config: &dyn OSConfig, aps: &APSState, id_services: &[&'st
 
     let status = resp.as_dictionary().unwrap().get("status").unwrap().as_unsigned_integer().unwrap();
     if status != 0 {
-        return Err(PushError::RegisterFailed(status))
+        return Err(PushError::RegisterFailed(IDSError(status)))
     }
 
     // update registrations
@@ -1119,7 +1134,7 @@ pub async fn register(config: &dyn OSConfig, aps: &APSState, id_services: &[&'st
     for service in service_list {
         let dict = service.as_dictionary().unwrap();
         let service_name = dict.get("service").unwrap().as_string().unwrap();
-        let users_list = dict.get("users").ok_or(PushError::RegisterFailed(u64::MAX))?.as_array().unwrap();
+        let users_list = dict.get("users").ok_or(PushError::RegisterFailed(IDSError(u64::MAX)))?.as_array().unwrap();
 
         let service = id_services.iter().find(|service| service.name == service_name).expect("Service not found??");
 
@@ -1134,7 +1149,7 @@ pub async fn register(config: &dyn OSConfig, aps: &APSState, id_services: &[&'st
                         return Err(PushError::CustomerMessage(plist::from_value(alert)?))
                     }
                 }
-                return Err(PushError::RegisterFailed(status));
+                return Err(PushError::RegisterFailed(IDSError(status)));
             }
 
             let mut my_handles = vec![];
@@ -1145,7 +1160,7 @@ pub async fn register(config: &dyn OSConfig, aps: &APSState, id_services: &[&'st
                 let uri = uri.as_dictionary().unwrap().get("uri").unwrap().as_string().unwrap();
                 if status != 0 {
                     error!("Failed to register {uri} status {}", status);
-                    return Err(PushError::RegisterFailed(status));
+                    return Err(PushError::RegisterFailed(IDSError(status)));
                 }
                 my_handles.push(uri.to_string());
             }