Refactor protobuf validation exceptions.

signalapp · Aug 6, 2021 · 0762a93 · 0762a93
1 parent 570b4d7
commit 0762a93
Show file tree

Hide file tree

Showing 5 changed files with 98 additions and 50 deletions.
diff --git a/app/src/main/java/org/thoughtcrime/securesms/messages/MessageDecryptionUtil.java b/app/src/main/java/org/thoughtcrime/securesms/messages/MessageDecryptionUtil.java
@@ -47,6 +47,7 @@
 import org.whispersystems.libsignal.protocol.DecryptionErrorMessage;
 import org.whispersystems.libsignal.state.SignalProtocolStore;
 import org.whispersystems.libsignal.util.guava.Optional;
+import org.whispersystems.signalservice.api.InvalidMessageStructureException;
 import org.whispersystems.signalservice.api.crypto.ContentHint;
 import org.whispersystems.signalservice.api.crypto.SignalServiceCipher;
 import org.whispersystems.signalservice.api.messages.SignalServiceContent;
@@ -110,7 +111,7 @@ private MessageDecryptionUtil() {}
       } catch (ProtocolDuplicateMessageException e) {
         Log.w(TAG, String.valueOf(envelope.getTimestamp()), e);
         return DecryptionResult.forError(MessageState.DUPLICATE_MESSAGE, toExceptionMetadata(e), jobs);
-      } catch (InvalidMetadataVersionException | InvalidMetadataMessageException e) {
+      } catch (InvalidMetadataVersionException | InvalidMetadataMessageException | InvalidMessageStructureException e) {
         Log.w(TAG, String.valueOf(envelope.getTimestamp()), e);
         return DecryptionResult.forNoop(jobs);
       } catch (SelfSendException e) {

diff --git a/.../src/main/java/org/whispersystems/signalservice/api/InvalidMessageStructureException.java b/.../src/main/java/org/whispersystems/signalservice/api/InvalidMessageStructureException.java
@@ -0,0 +1,44 @@
+package org.whispersystems.signalservice.api;
+
+import org.whispersystems.libsignal.util.guava.Optional;
+
+/**
+ * An exception thrown when something about the proto is malformed. e.g. one of the fields has an invalid value.
+ */
+public final class InvalidMessageStructureException extends Exception {
+
+  private final Optional<String>  sender;
+  private final Optional<Integer> device;
+
+  public InvalidMessageStructureException(String message) {
+    super(message);
+    this.sender = Optional.absent();
+    this.device = Optional.absent();
+  }
+
+  public InvalidMessageStructureException(String message, String sender, int device) {
+    super(message);
+    this.sender = Optional.fromNullable(sender);
+    this.device = Optional.of(device);
+  }
+
+  public InvalidMessageStructureException(Exception e, String sender, int device) {
+    super(e);
+    this.sender = Optional.fromNullable(sender);
+    this.device = Optional.of(device);
+  }
+
+  public InvalidMessageStructureException(Exception e) {
+    super(e);
+    this.sender = Optional.absent();
+    this.device = Optional.absent();
+  }
+
+  public Optional<String> getSender() {
+    return sender;
+  }
+
+  public Optional<Integer> getDevice() {
+    return device;
+  }
+}
diff --git a/...ervice/src/main/java/org/whispersystems/signalservice/api/crypto/SignalServiceCipher.java b/...ervice/src/main/java/org/whispersystems/signalservice/api/crypto/SignalServiceCipher.java
@@ -41,6 +41,7 @@
 import org.whispersystems.libsignal.protocol.SignalMessage;
 import org.whispersystems.libsignal.state.SignalProtocolStore;
 import org.whispersystems.libsignal.util.guava.Optional;
+import org.whispersystems.signalservice.api.InvalidMessageStructureException;
 import org.whispersystems.signalservice.api.SignalSessionLock;
 import org.whispersystems.signalservice.api.messages.SignalServiceContent;
 import org.whispersystems.signalservice.api.messages.SignalServiceEnvelope;
@@ -135,7 +136,7 @@ public SignalServiceContent decrypt(SignalServiceEnvelope envelope)
       ProtocolUntrustedIdentityException, ProtocolNoSessionException,
       ProtocolInvalidVersionException, ProtocolInvalidMessageException,
       ProtocolInvalidKeyException, ProtocolDuplicateMessageException,
-      SelfSendException, UnsupportedDataMessageException
+      SelfSendException, UnsupportedDataMessageException, InvalidMessageStructureException
   {
     try {
       if (envelope.hasLegacyMessage()) {
@@ -174,15 +175,15 @@ private Plaintext decrypt(SignalServiceEnvelope envelope, byte[] ciphertext)
       ProtocolLegacyMessageException, ProtocolInvalidKeyException,
       ProtocolInvalidVersionException, ProtocolInvalidMessageException,
       ProtocolInvalidKeyIdException, ProtocolNoSessionException,
-      SelfSendException
+      SelfSendException, InvalidMessageStructureException
   {
     try {
 
       byte[]                paddedMessage;
       SignalServiceMetadata metadata;
 
       if (!envelope.hasSource() && !envelope.isUnidentifiedSender()) {
-        throw new ProtocolInvalidMessageException(new InvalidMessageException("Non-UD envelope is missing a source!"), null, 0);
+        throw new InvalidMessageStructureException("Non-UD envelope is missing a source!");
       }
 
       if (envelope.isPreKeySignalMessage()) {

diff --git a/...n/java/org/whispersystems/signalservice/api/messages/SignalServiceAttachmentRemoteId.java b/...n/java/org/whispersystems/signalservice/api/messages/SignalServiceAttachmentRemoteId.java
@@ -3,6 +3,7 @@
 import org.signal.libsignal.metadata.ProtocolInvalidMessageException;
 import org.whispersystems.libsignal.InvalidMessageException;
 import org.whispersystems.libsignal.util.guava.Optional;
+import org.whispersystems.signalservice.api.InvalidMessageStructureException;
 import org.whispersystems.signalservice.internal.push.SignalServiceProtos.AttachmentPointer;
 
 /**
@@ -43,14 +44,14 @@ public String toString() {
         }
     }
 
-    public static SignalServiceAttachmentRemoteId from(AttachmentPointer attachmentPointer) throws ProtocolInvalidMessageException {
+    public static SignalServiceAttachmentRemoteId from(AttachmentPointer attachmentPointer) throws InvalidMessageStructureException {
         switch (attachmentPointer.getAttachmentIdentifierCase()) {
             case CDNID:
                 return new SignalServiceAttachmentRemoteId(attachmentPointer.getCdnId());
             case CDNKEY:
                 return new SignalServiceAttachmentRemoteId(attachmentPointer.getCdnKey());
             case ATTACHMENTIDENTIFIER_NOT_SET:
-                throw new ProtocolInvalidMessageException(new InvalidMessageException("AttachmentPointer CDN location not set"), null, 0);
+                throw new InvalidMessageStructureException("AttachmentPointer CDN location not set");
         }
         return null;
     }