Remove LOCK in OmemoManager and use Manager instance instead

smack-integration-test/src/main/java/org/jivesoftware/smackx/omemo/MessageEncryptionIntegrationTest.java

@@ -55,6 +55,7 @@ public class MessageEncryptionIntegrationTest extends AbstractTwoUsersOmemoInteg
      * Bob still has B2
      * @throws Exception
      */
+    @SuppressWarnings("SynchronizeOnNonFinalField")
     @SmackIntegrationTest
     public void messageTest() throws Exception {
         OmemoBundleElement a1 = alice.getOmemoService().getOmemoStoreBackend().packOmemoBundle(alice.getOwnDevice());
@@ -74,7 +75,7 @@ public class MessageEncryptionIntegrationTest extends AbstractTwoUsersOmemoInteg
         OmemoBundleElement a1_ = alice.getOmemoService().getOmemoStoreBackend().packOmemoBundle(alice.getOwnDevice());
         OmemoBundleElement b2;
 
-        synchronized (bob.LOCK) { // Circumvent race condition where bundle gets replenished after getting stored in b2
+        synchronized (bob) { // Circumvent race condition where bundle gets replenished after getting stored in b2
             b2 = bob.getOmemoService().getOmemoStoreBackend().packOmemoBundle(bob.getOwnDevice());
         }
 

smack-integration-test/src/main/java/org/jivesoftware/smackx/omemo/SessionRenegotiationIntegrationTest.java

@@ -31,6 +31,7 @@ public class SessionRenegotiationIntegrationTest extends AbstractTwoUsersOmemoIn
         super(environment);
     }
 
+    @SuppressWarnings("SynchronizeOnNonFinalField")
     @SmackIntegrationTest
     public void sessionRenegotiationTest() throws Exception {
 
@@ -50,7 +51,7 @@ public class SessionRenegotiationIntegrationTest extends AbstractTwoUsersOmemoIn
         bob.removeOmemoMessageListener(listener1);
 
         // Remove the session on Bobs side.
-        synchronized (bob.LOCK) {
+        synchronized (bob) {
             bob.getOmemoService().getOmemoStoreBackend().removeRawSession(bob.getOwnDevice(), alice.getOwnDevice());
         }
 

smack-omemo/src/main/java/org/jivesoftware/smackx/omemo/OmemoManager.java

@@ -97,7 +97,6 @@ public final class OmemoManager extends Manager {
     private static final Logger LOGGER = Logger.getLogger(OmemoManager.class.getName());
 
     private static final Integer UNKNOWN_DEVICE_ID = -1;
-    final Object LOCK = new Object();
 
     private static final WeakHashMap<XMPPConnection, TreeMap<Integer, OmemoManager>> INSTANCES = new WeakHashMap<>();
     private final OmemoService<?, ?, ?, ?, ?, ?, ?, ?, ?> service;
@@ -237,22 +236,20 @@ public final class OmemoManager extends Manager {
      * @throws PubSubException.NotALeafNodeException
      * @throws IOException
      */
-    public void initialize()
+    public synchronized void initialize()
             throws SmackException.NotLoggedInException, CorruptedOmemoKeyException, InterruptedException,
             SmackException.NoResponseException, SmackException.NotConnectedException, XMPPException.XMPPErrorException,
             PubSubException.NotALeafNodeException, IOException {
-        synchronized (LOCK) {
+        if (!connection().isAuthenticated()) {
-            if (!connection().isAuthenticated()) {
+            throw new SmackException.NotLoggedInException();
-                throw new SmackException.NotLoggedInException();
-            }
-
-            if (getTrustCallback() == null) {
-                throw new IllegalStateException("No TrustCallback set.");
-            }
-
-            getOmemoService().init(new LoggedInOmemoManager(this));
-            ServiceDiscoveryManager.getInstanceFor(connection()).addFeature(PEP_NODE_DEVICE_LIST_NOTIFY);
         }
+
+        if (getTrustCallback() == null) {
+            throw new IllegalStateException("No TrustCallback set.");
+        }
+
+        getOmemoService().init(new LoggedInOmemoManager(this));
+        ServiceDiscoveryManager.getInstanceFor(connection()).addFeature(PEP_NODE_DEVICE_LIST_NOTIFY);
     }
 
     /**
@@ -313,11 +310,9 @@ public final class OmemoManager extends Manager {
             throws CryptoFailedException, UndecidedOmemoIdentityException,
             InterruptedException, SmackException.NotConnectedException,
             SmackException.NoResponseException, SmackException.NotLoggedInException, IOException {
-        synchronized (LOCK) {
             Set<BareJid> recipients = new HashSet<>();
             recipients.add(recipient);
             return encrypt(recipients, message);
-        }
     }
 
     /**
@@ -334,18 +329,16 @@ public final class OmemoManager extends Manager {
      * @throws SmackException.NotLoggedInException
      * @throws IOException
      */
-    public OmemoMessage.Sent encrypt(Set<BareJid> recipients, String message)
+    public synchronized OmemoMessage.Sent encrypt(Set<BareJid> recipients, String message)
             throws CryptoFailedException, UndecidedOmemoIdentityException,
             InterruptedException, SmackException.NotConnectedException,
             SmackException.NoResponseException, SmackException.NotLoggedInException, IOException {
-        synchronized (LOCK) {
+        LoggedInOmemoManager guard = new LoggedInOmemoManager(this);
-            LoggedInOmemoManager guard = new LoggedInOmemoManager(this);
+        Set<OmemoDevice> devices = getDevicesOf(getOwnJid());
-            Set<OmemoDevice> devices = getDevicesOf(getOwnJid());
+        for (BareJid recipient : recipients) {
-            for (BareJid recipient : recipients) {
+            devices.addAll(getDevicesOf(recipient));
-                devices.addAll(getDevicesOf(recipient));
-            }
-            return service.createOmemoMessage(guard, devices, message);
         }
+        return service.createOmemoMessage(guard, devices, message);
     }
 
     /**
@@ -364,23 +357,21 @@ public final class OmemoManager extends Manager {
      * @throws SmackException.NotLoggedInException
      * @throws IOException
      */
-    public OmemoMessage.Sent encrypt(MultiUserChat muc, String message)
+    public synchronized OmemoMessage.Sent encrypt(MultiUserChat muc, String message)
             throws UndecidedOmemoIdentityException, CryptoFailedException,
             XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException,
             SmackException.NoResponseException, NoOmemoSupportException,
             SmackException.NotLoggedInException, IOException {
-        synchronized (LOCK) {
+        if (!multiUserChatSupportsOmemo(muc)) {
-            if (!multiUserChatSupportsOmemo(muc)) {
+            throw new NoOmemoSupportException();
-                throw new NoOmemoSupportException();
-            }
-
-            Set<BareJid> recipients = new HashSet<>();
-
-            for (EntityFullJid e : muc.getOccupants()) {
-                recipients.add(muc.getOccupant(e).getJid().asBareJid());
-            }
-            return encrypt(recipients, message);
         }
+
+        Set<BareJid> recipients = new HashSet<>();
+
+        for (EntityFullJid e : muc.getOccupants()) {
+            recipients.add(muc.getOccupant(e).getJid().asBareJid());
+        }
+        return encrypt(recipients, message);
     }
 
     /**
@@ -496,23 +487,20 @@ public final class OmemoManager extends Manager {
      * @throws SmackException.NotConnectedException
      * @throws IOException
      */
-    public void sendRatchetUpdateMessage(OmemoDevice recipient)
+    public synchronized void sendRatchetUpdateMessage(OmemoDevice recipient)
             throws SmackException.NotLoggedInException, CorruptedOmemoKeyException, InterruptedException,
             SmackException.NoResponseException, NoSuchAlgorithmException, SmackException.NotConnectedException,
             CryptoFailedException, CannotEstablishOmemoSessionException, IOException {
-        synchronized (LOCK) {
+        Message message = new Message();
-            Message message = new Message();
+        message.setFrom(getOwnJid());
-            message.setFrom(getOwnJid());
+        message.setTo(recipient.getJid());
-            message.setTo(recipient.getJid());
 
-            OmemoElement element = getOmemoService()
+        OmemoElement element = getOmemoService().createRatchetUpdateElement(new LoggedInOmemoManager(this), recipient);
-                    .createRatchetUpdateElement(new LoggedInOmemoManager(this), recipient);
+        message.addExtension(element);
-            message.addExtension(element);
 
-            // Set MAM Storage hint
+        // Set MAM Storage hint
-            StoreHint.set(message);
+        StoreHint.set(message);
-            connection().sendStanza(message);
+        connection().sendStanza(message);
-        }
     }
 
     /**
@@ -527,13 +515,11 @@ public final class OmemoManager extends Manager {
      * @throws XMPPException.XMPPErrorException
      * @throws IOException
      */
-    public boolean contactSupportsOmemo(BareJid contact)
+    public synchronized boolean contactSupportsOmemo(BareJid contact)
             throws InterruptedException, PubSubException.NotALeafNodeException, XMPPException.XMPPErrorException,
             SmackException.NotConnectedException, SmackException.NoResponseException, IOException {
-        synchronized (LOCK) {
+        OmemoCachedDeviceList deviceList = getOmemoService().refreshDeviceList(connection(), getOwnDevice(), contact);
-            OmemoCachedDeviceList deviceList = getOmemoService().refreshDeviceList(connection(), getOwnDevice(), contact);
+        return !deviceList.getActiveDevices().isEmpty();
-            return !deviceList.getActiveDevices().isEmpty();
-        }
     }
 
     /**
@@ -581,15 +567,13 @@ public final class OmemoManager extends Manager {
      * @throws CorruptedOmemoKeyException if our identityKey is corrupted.
      * @throws IOException
      */
-    public OmemoFingerprint getOwnFingerprint()
+    public synchronized OmemoFingerprint getOwnFingerprint()
             throws SmackException.NotLoggedInException, CorruptedOmemoKeyException, IOException {
-        synchronized (LOCK) {
+        if (getOwnJid() == null) {
-            if (getOwnJid() == null) {
+            throw new SmackException.NotLoggedInException();
-                throw new SmackException.NotLoggedInException();
-            }
-
-            return getOmemoService().getOmemoStoreBackend().getFingerprint(getOwnDevice());
         }
+
+        return getOmemoService().getOmemoStoreBackend().getFingerprint(getOwnDevice());
     }
 
     /**
@@ -604,21 +588,20 @@ public final class OmemoManager extends Manager {
      * @throws SmackException.NoResponseException
      * @throws IOException
      */
-    public OmemoFingerprint getFingerprint(OmemoDevice device)
+    public synchronized OmemoFingerprint getFingerprint(OmemoDevice device)
             throws CannotEstablishOmemoSessionException, SmackException.NotLoggedInException,
             CorruptedOmemoKeyException, SmackException.NotConnectedException, InterruptedException,
             SmackException.NoResponseException, IOException {
-        synchronized (LOCK) {
+        if (getOwnJid() == null) {
-            if (getOwnJid() == null) {
+            throw new SmackException.NotLoggedInException();
-                throw new SmackException.NotLoggedInException();
-            }
-
-            if (device.equals(getOwnDevice())) {
-                return getOwnFingerprint();
-            }
-
-            return getOmemoService().getOmemoStoreBackend().getFingerprintAndMaybeBuildSession(new LoggedInOmemoManager(this), device);
         }
+
+        if (device.equals(getOwnDevice())) {
+            return getOwnFingerprint();
+        }
+
+        return getOmemoService().getOmemoStoreBackend()
+                .getFingerprintAndMaybeBuildSession(new LoggedInOmemoManager(this), device);
     }
 
     /**
@@ -635,30 +618,28 @@ public final class OmemoManager extends Manager {
      * @throws SmackException.NoResponseException
      * @throws IOException
      */
-    public HashMap<OmemoDevice, OmemoFingerprint> getActiveFingerprints(BareJid contact)
+    public synchronized HashMap<OmemoDevice, OmemoFingerprint> getActiveFingerprints(BareJid contact)
             throws SmackException.NotLoggedInException, CorruptedOmemoKeyException,
             CannotEstablishOmemoSessionException, SmackException.NotConnectedException, InterruptedException,
             SmackException.NoResponseException, IOException {
-        synchronized (LOCK) {
+        if (getOwnJid() == null) {
-            if (getOwnJid() == null) {
+            throw new SmackException.NotLoggedInException();
-                throw new SmackException.NotLoggedInException();
-            }
-
-            HashMap<OmemoDevice, OmemoFingerprint> fingerprints = new HashMap<>();
-            OmemoCachedDeviceList deviceList = getOmemoService().getOmemoStoreBackend()
-                    .loadCachedDeviceList(getOwnDevice(), contact);
-
-            for (int id : deviceList.getActiveDevices()) {
-                OmemoDevice device = new OmemoDevice(contact, id);
-                OmemoFingerprint fingerprint = getFingerprint(device);
-
-                if (fingerprint != null) {
-                    fingerprints.put(device, fingerprint);
-                }
-            }
-
-            return fingerprints;
         }
+
+        HashMap<OmemoDevice, OmemoFingerprint> fingerprints = new HashMap<>();
+        OmemoCachedDeviceList deviceList = getOmemoService().getOmemoStoreBackend().loadCachedDeviceList(getOwnDevice(),
+                contact);
+
+        for (int id : deviceList.getActiveDevices()) {
+            OmemoDevice device = new OmemoDevice(contact, id);
+            OmemoFingerprint fingerprint = getFingerprint(device);
+
+            if (fingerprint != null) {
+                fingerprints.put(device, fingerprint);
+            }
+        }
+
+        return fingerprints;
     }
 
     /**
@@ -707,12 +688,10 @@ public final class OmemoManager extends Manager {
      * @throws SmackException.NoResponseException
      * @throws IOException
      */
-    public void requestDeviceListUpdateFor(BareJid contact)
+    public synchronized void requestDeviceListUpdateFor(BareJid contact)
             throws InterruptedException, PubSubException.NotALeafNodeException, XMPPException.XMPPErrorException,
             SmackException.NotConnectedException, SmackException.NoResponseException, IOException {
-        synchronized (LOCK) {
+        getOmemoService().refreshDeviceList(connection(), getOwnDevice(), contact);
-            getOmemoService().refreshDeviceList(connection(), getOwnDevice(), contact);
-        }
     }
 
     /**
@@ -728,9 +707,7 @@ public final class OmemoManager extends Manager {
     public void purgeDeviceList()
             throws SmackException.NotLoggedInException, InterruptedException, XMPPException.XMPPErrorException,
             SmackException.NotConnectedException, SmackException.NoResponseException, IOException {
-        synchronized (LOCK) {
+        getOmemoService().purgeDeviceList(new LoggedInOmemoManager(this));
-            getOmemoService().purgeDeviceList(new LoggedInOmemoManager(this));
-        }
     }
 
     /**
@@ -746,21 +723,19 @@ public final class OmemoManager extends Manager {
      * @throws SmackException.NotLoggedInException
      * @throws IOException
      */
-    public void rotateSignedPreKey()
+    public synchronized void rotateSignedPreKey()
             throws CorruptedOmemoKeyException, SmackException.NotLoggedInException, XMPPException.XMPPErrorException,
             SmackException.NotConnectedException, InterruptedException, SmackException.NoResponseException, IOException {
-        synchronized (LOCK) {
+        if (!connection().isAuthenticated()) {
-            if (!connection().isAuthenticated()) {
+            throw new SmackException.NotLoggedInException();
-                throw new SmackException.NotLoggedInException();
-            }
-
-            // generate key
-            getOmemoService().getOmemoStoreBackend().changeSignedPreKey(getOwnDevice());
-
-            // publish
-            OmemoBundleElement bundle = getOmemoService().getOmemoStoreBackend().packOmemoBundle(getOwnDevice());
-            OmemoService.publishBundle(connection(), getOwnDevice(), bundle);
         }
+
+        // generate key
+        getOmemoService().getOmemoStoreBackend().changeSignedPreKey(getOwnDevice());
+
+        // publish
+        OmemoBundleElement bundle = getOmemoService().getOmemoStoreBackend().packOmemoBundle(getOwnDevice());
+        OmemoService.publishBundle(connection(), getOwnDevice(), bundle);
     }
 
     /**
@@ -807,10 +782,8 @@ public final class OmemoManager extends Manager {
      *
      * @return deviceId
      */
-    public Integer getDeviceId() {
+    public synchronized Integer getDeviceId() {
-        synchronized (LOCK) {
+        return deviceId;
-            return deviceId;
-        }
     }
 
     /**
@@ -818,28 +791,24 @@ public final class OmemoManager extends Manager {
      *
      * @return omemoDevice
      */
-    public OmemoDevice getOwnDevice() {
+    public synchronized OmemoDevice getOwnDevice() {
-        synchronized (LOCK) {
+        BareJid jid = getOwnJid();
-            BareJid jid = getOwnJid();
+        if (jid == null) {
-            if (jid == null) {
+            return null;
-                return null;
-            }
-            return new OmemoDevice(jid, getDeviceId());
         }
+        return new OmemoDevice(jid, getDeviceId());
     }
 
     /**
      * Set the deviceId of the manager to nDeviceId.
      * @param nDeviceId new deviceId
      */
-    void setDeviceId(int nDeviceId) {
+    synchronized void setDeviceId(int nDeviceId) {
-        synchronized (LOCK) {
+        // Move this instance inside the HashMaps
-            // Move this instance inside the HashMaps
+        INSTANCES.get(connection()).remove(getDeviceId());
-            INSTANCES.get(connection()).remove(getDeviceId());
+        INSTANCES.get(connection()).put(nDeviceId, this);
-            INSTANCES.get(connection()).put(nDeviceId, this);
 
-            this.deviceId = nDeviceId;
+        this.deviceId = nDeviceId;
-        }
     }
 
     /**

smack-omemo/src/main/java/org/jivesoftware/smackx/omemo/OmemoService.java

@@ -1075,7 +1075,7 @@ public abstract class OmemoService<T_IdKeyPair, T_IdKey, T_PreKey, T_SigPreKey,
                                           OmemoManager.LoggedInOmemoManager managerGuard) throws IOException {
         OmemoManager manager = managerGuard.get();
         // Avoid the ratchet being manipulated and the bundle being published multiple times simultaneously
-        synchronized (manager.LOCK) {
+        synchronized (manager) {
             OmemoDevice userDevice = manager.getOwnDevice();
             OmemoElement element = carbonCopy.getExtension(OmemoElement.NAME_ENCRYPTED, OmemoElement_VAxolotl.NAMESPACE);
             if (element == null) {
@@ -1130,7 +1130,7 @@ public abstract class OmemoService<T_IdKeyPair, T_IdKey, T_PreKey, T_SigPreKey,
     public void onOmemoMessageStanzaReceived(Stanza stanza, OmemoManager.LoggedInOmemoManager managerGuard) throws IOException {
         OmemoManager manager = managerGuard.get();
         // Avoid the ratchet being manipulated and the bundle being published multiple times simultaneously
-        synchronized (manager.LOCK) {
+        synchronized (manager) {
             OmemoDevice userDevice = manager.getOwnDevice();
             OmemoElement element = stanza.getExtension(OmemoElement.NAME_ENCRYPTED, OmemoElement_VAxolotl.NAMESPACE);
             if (element == null) {
@@ -1219,7 +1219,7 @@ public abstract class OmemoService<T_IdKeyPair, T_IdKey, T_PreKey, T_SigPreKey,
     OmemoMessage.Received decryptStanza(Stanza stanza, OmemoManager.LoggedInOmemoManager managerGuard) throws IOException {
         OmemoManager manager = managerGuard.get();
         // Avoid the ratchet being manipulated and the bundle being published multiple times simultaneously
-        synchronized (manager.LOCK) {
+        synchronized (manager) {
             OmemoDevice userDevice = manager.getOwnDevice();
             OmemoElement element = stanza.getExtension(OmemoElement.NAME_ENCRYPTED, OmemoElement_VAxolotl.NAMESPACE);
             if (element == null) {