Skip to content

Commit

Permalink
8329013: StackOverflowError when starting Apache Tomcat with signed jar
Browse files Browse the repository at this point in the history
Reviewed-by: dfuchs, jpai
  • Loading branch information
coffeys committed Apr 2, 2024
1 parent dd5d7d0 commit 925d829
Show file tree
Hide file tree
Showing 2 changed files with 93 additions and 8 deletions.
35 changes: 27 additions & 8 deletions src/java.base/share/classes/jdk/internal/event/EventHelper.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2018, 2022, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2018, 2024, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
Expand Down Expand Up @@ -27,6 +27,7 @@

import jdk.internal.access.JavaUtilJarAccess;
import jdk.internal.access.SharedSecrets;
import jdk.internal.misc.ThreadTracker;

import java.lang.invoke.MethodHandles;
import java.lang.invoke.VarHandle;
Expand Down Expand Up @@ -133,6 +134,18 @@ private static String getDurationString(Instant start) {
}
}

private static class ThreadTrackHolder {
static final ThreadTracker TRACKER = new ThreadTracker();
}

private static Object tryBeginLookup() {
return ThreadTrackHolder.TRACKER.tryBegin();
}

private static void endLookup(Object key) {
ThreadTrackHolder.TRACKER.end(key);
}

/**
* Helper to determine if security events are being logged
* at a preconfigured logging level. The configuration value
Expand All @@ -141,14 +154,20 @@ private static String getDurationString(Instant start) {
* @return boolean indicating whether an event should be logged
*/
public static boolean isLoggingSecurity() {
// Avoid a bootstrap issue where the commitEvent attempts to
// trigger early loading of System Logger but where
// the verification process still has JarFiles locked
if (securityLogger == null && !JUJA.isInitializing()) {
LOGGER_HANDLE.compareAndSet( null, System.getLogger(SECURITY_LOGGER_NAME));
loggingSecurity = securityLogger.isLoggable(LOG_LEVEL);
Object key;
// Avoid bootstrap issues where
// * commitEvent triggers early loading of System Logger but where
// the verification process still has JarFiles locked
// * the loading of the logging libraries involves recursive
// calls to security libraries triggering recursion
if (securityLogger == null && !JUJA.isInitializing() && (key = tryBeginLookup()) != null) {
try {
LOGGER_HANDLE.compareAndSet(null, System.getLogger(SECURITY_LOGGER_NAME));
loggingSecurity = securityLogger.isLoggable(LOG_LEVEL);
} finally {
endLookup(key);
}
}
return loggingSecurity;
}

}
66 changes: 66 additions & 0 deletions test/jdk/jdk/security/logging/RecursiveEventHelper.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
/*
* Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/

import java.util.logging.*;

import jdk.internal.event.EventHelper;

/*
* @test
* @bug 8329013
* @summary StackOverflowError when starting Apache Tomcat with signed jar
* @modules java.base/jdk.internal.event:+open
* @run main/othervm -Xmx32m -Djava.util.logging.manager=RecursiveEventHelper RecursiveEventHelper
*/
public class RecursiveEventHelper extends LogManager {
// an extra check to ensure the custom manager is in use
static volatile boolean customMethodCalled;

public static void main(String[] args) throws Exception {
String classname = System.getProperty("java.util.logging.manager");
if (!classname.equals("RecursiveEventHelper")) {
throw new RuntimeException("java.util.logging.manager not set");
}

// this call will trigger initialization of logging framework
// which will call into our custom LogManager and use the
// custom getProperty method below. EventHelper.isLoggingSecurity()
// is also on the code path of original report and triggers
// similar recursion.
System.getLogger("testLogger");
if (!customMethodCalled) {
throw new RuntimeException("Method not called");
}
}

@Override
public String getProperty(String p) {
// this call mimics issue reported in initial bug report where
// opening of a signed jar during System logger initialization triggered
// a recursive call (via EventHelper.isLoggingSecurity) back into
// logger API
EventHelper.isLoggingSecurity();
customMethodCalled = true;
return super.getProperty(p);
}
}

3 comments on commit 925d829

@openjdk-notifier
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@coffeys
Copy link
Contributor Author

@coffeys coffeys commented on 925d829 Apr 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/backport jdk22u

@openjdk
Copy link

@openjdk openjdk bot commented on 925d829 Apr 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@coffeys the backport was successfully created on the branch backport-coffeys-925d8293 in my personal fork of openjdk/jdk22u. To create a pull request with this backport targeting openjdk/jdk22u:master, just click the following link:

➡️ Create pull request

The title of the pull request is automatically filled in correctly and below you find a suggestion for the pull request body:

Hi all,

This pull request contains a backport of commit 925d8293 from the openjdk/jdk repository.

The commit being backported was authored by Sean Coffey on 2 Apr 2024 and was reviewed by Daniel Fuchs and Jaikiran Pai.

Thanks!

If you need to update the source branch of the pull then run the following commands in a local clone of your personal fork of openjdk/jdk22u:

$ git fetch https://github.com/openjdk-bots/jdk22u.git backport-coffeys-925d8293:backport-coffeys-925d8293
$ git checkout backport-coffeys-925d8293
# make changes
$ git add paths/to/changed/files
$ git commit --message 'Describe additional changes made'
$ git push https://github.com/openjdk-bots/jdk22u.git backport-coffeys-925d8293

⚠️ @coffeys You are not yet a collaborator in my fork openjdk-bots/jdk22u. An invite will be sent out and you need to accept it before you can proceed.

Please sign in to comment.