Page History

public final class Client {
  private 06|AA. Java References#API 06]\]:

{quote}
A {{ReentrantLock}} is owned by the thread last successfully locking, but not yet unlocking it. A thread invoking {{lock}} will return, successfully acquiring the lock, when the lock is not owned by another thread.
{quote}

Consequently, an unreleased lock in any thread will stop other threads from acquiring the same lock.   Intrinsic locks of class objects used for method and block synchronization are automatically released on exceptional conditions (such as abnormal thread termination).

h2. Noncompliant Code Example (Checked Exception)

This noncompliant code example protects a resource using a {{ReentrantLock}} but fails to release the lock if an exception occurs while performing operations on the open file. If an exception is thrown, control transfers to the {{catch}} block and the call to {{unlock()}} is not executed.

{code:bgColor=#FFcccc}
public void doSomething(File file) {
  final Lock lock = new ReentrantLock();

  public void doSomething(File tryfile) {
    InputStream in = lock.lock();null;
    try {
    InputStream  in = new FileInputStream(file);
      lock.lock();

      // Perform operations on the open file.

      lock.unlock();
    } catch (FileNotFoundException fnfx) {
      // Handle the exception
  }
}
{code}

Note that the lock is not released, even when the {{doSomething()}} method returns. 


h2. Compliant Solution ({{finally}} block)

This compliant solution encapsulates operations that may throw an exception in a {{try}} block immediately after acquiring the lock.  The lock is acquired just before the try block, which guarantees that it is held when the finally block executes. The lock is released in the corresponding {{finally}} block, which ensures the lock is released regardless of whether or not an exception occurs.

{code:bgColor=#ccccff}
public void doSomething(File file) {
   } finally {
      if (in != null) {
        try {
          in.close();
        } catch (IOException x) {
          // Handle exception
        }  
      }
    }
  }
}

public final class Client {
  private final Lock lock = new ReentrantLock();

  public void lock.lock()doSomething(File file) {
    InputStream in = null;
    try {
    InputStream  in = new FileInputStream(file);
      lock.lock();
      // Perform operations on the open file.
    } catch (FileNotFoundException fnf) {
      // HandleForward theto exceptionhandler
    } finally {
      lock.unlock();
  }
}
{code}


h2. Noncompliant Code Example     if (in != null) {
        try {
          in.close();
        } catch (IOException e) {
          // Forward to handler
        }
      }
    }
  }
}

public final class Client(unchecked exception)

This noncompliant code example uses a {{ReentrantLock}} to protect a {{java.util.Date}} instance, which is not thread-safe by design.  

{mc} Do not declare lock as private as it need package-wide accessibility for illustrative purposes {mc}

{code:bgColor=#FFcccc}
final class DateHandler {
  private final DateLock datelock = new DateReentrantLock();

  public void  final Lock lockdoSomething(File file) {
    InputStream in = new ReentrantLock()null;

  public void doSomethingSafely(String str) {lock.lock();
    try {
      in = new doSomethingFileInputStream(strfile);
      // Perform operations on the open file
    } catch (ThrowableFileNotFoundException tfnf) {
      // Forward to handler
    } finally {
      }lock.unlock();

     public voidif doSomething(String strin != null) {
      lock.lock();
  try {
     String   dateString = datein.toStringclose();
    if (str.equals(dateString)    } catch (IOException e) {
          // ...
 Forward to handler
        }
      lock.unlock();
}
    }
  }
}

public interface LockAction {
  void doSomethingWithFile(InputStream in);
}

public final class ReentrantLockAction {
  private static final Lock lock = new ReentrantLock();

  public static void doSomething(File file, LockAction action)  {
    InputStream in = null;
    lock.lock();
    try {
      in = new FileInputStream(file);
      action.doSomethingWithFile(in);
    } catch (FileNotFoundException fnf) {
      // Forward to handler
    } finally {
      lock.unlock();

      if (in != null) {
    {code}

Because the {{doSomething()}} method fails to check if {{str}} is {{null}}, a runtime exception can occur, preventing the lock from being released.

Note that the {{doSomethingSafely()}} method must catch {{Throwable}} to be compliant with [EXC06-J. Do not allow exceptions to transmit sensitive information].

h2. Compliant Solution ({{finally}} block)

This compliant solution encapsulates operations that can throw an exception in a try block and release the lock in the associated {{finally}} block.  

{code:bgColor=#ccccff}
final class DateHandler {
  private final Date date = new Date();
  final Lock lock = new ReentrantLock();

  public void doSomethingSafely(String str) {
    try {
          doSomethingin.close(str);
        } catch (ThrowableIOException te) {
          // Forward to handler
        }
      }
    }
  }
}

public final class Client {
  public void doSomething(StringFile strfile) {
    lock.lock();
    try {
      String dateString = date.toString();
      if (str != null && ReentrantLockAction.doSomething(file, new LockAction() {
      public void doSomethingWithFile(InputStream in) {
        // Perform operations on the open file
      }
    });
  }
}

final class DateHandler {

  private final Date date = new Date();

  private final Lock lock = new ReentrantLock();

  // str could be null
  public void doSomething(String str) {
    lock.lock();
    String dateString = date.toString();
    if (str.equals(dateString)) {
        // ...
      }
    } finally {// ...

      lock.unlock();
    }
  }
}
{code}

Consequently, the lock is released even in the event of a runtime exception. The {{doSomething()}} method also ensures that the string is not null to avoid throwing a {{NullPointerException}}.


h2. Risk Assessment

Failing to release locks on exceptional conditions may lead to thread starvation and deadlock.

|| Rule || Severity || Likelihood || Remediation Cost || Priority || Level ||
| CON15- J | low | likely | low | {color:#cc9900}{*}P9{*}{color} | {color:#cc9900}{*}L2{*}{color} |



h3. Automated Detection

TODO


h3. Related Vulnerabilities

[GERONIMO-2234|http://issues.apache.org/jira/browse/GERONIMO-2234]

h2. References

\[[API 06|AA. Java References#API 06]\] Class {{ReentrantLock}}

----
[!The CERT Sun Microsystems Secure Coding Standard for Java^button_arrow_left.png!|CON13-J. Do not use Thread.stop() to terminate threads]      [!The CERT Sun Microsystems Secure Coding Standard for Java^button_arrow_up.png!|11. Concurrency (CON)]      [!The CERT Sun Microsystems Secure Coding Standard for Java^button_arrow_right.png!|CON16-J. Do not assume that the sleep(), yield() or getState() methods provide synchronization semantics]

}

final class DateHandler {

  private final Date date = new Date();

  private final Lock lock = new ReentrantLock();

  // str could be null
  public void doSomething(String str) {
    lock.lock();
    try {
      String dateString = date.toString();
      if (str != null && str.equals(dateString)) {
        // ...
      }
      // ...

    } finally {
      lock.unlock();
    }
  }
}