Fix an issue where SecureAction#getCanonicalPath can resolve paths to real paths#501
Open
pigelvy wants to merge 1 commit intoapache:masterfrom
Open
Fix an issue where SecureAction#getCanonicalPath can resolve paths to real paths#501pigelvy wants to merge 1 commit intoapache:masterfrom
pigelvy wants to merge 1 commit intoapache:masterfrom
Conversation
… the real paths
On Windows, if Apache Felix is run from a `subst` drive (e.g. "P:\felix" where "P:" is a "subst" drive to "C:\tmp"), some internal resources failed to be properly resolved on startup.
I noticed that, with Java 25, an exception occured in `org.apache.felix.framework.Felix#handleJavaVersionChange()`.
---
ERROR: Bundle org.apache.felix.framework [0] The data file must be inside the data dir.
Could not create framework: java.lang.NullPointerException: Cannot invoke "java.io.File.isFile()" because "dataFile" is null
java.lang.NullPointerException: Cannot invoke "java.io.File.isFile()" because "dataFile" is null
at org.apache.felix.framework.Felix.handleJavaVersionChange(Felix.java:1012)
at org.apache.felix.framework.Felix.init(Felix.java:810)
at org.apache.felix.framework.Felix.init(Felix.java:648)
at org.apache.felix.main.Main.main(Main.java:289)
---
After some investigation and step-by-step debugging, it appeared that the issue is located in `BundleCache#getSystemBundleDataFile(String)` because the canonical paths are not resolved similarly. This causes the file to be detected as outside of it directory.
```
String dataFilePath = BundleCache.getSecureAction().getCanonicalPath(dataFile);
String dataDirPath = BundleCache.getSecureAction().getCanonicalPath(sbDir);
if (!dataFilePath.equals(dataDirPath) && !dataFilePath.startsWith(dataDirPath + File.separatorChar))
{
throw new IllegalArgumentException("The data file must be inside the data dir.");
}
```
To prevent this verification from being too dependent on the underlying file-system and the resolution of real paths, this commit leverages `java.nio.file.Path#normalize` to sanitize the file path.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
On Windows, if Apache Felix is run from a
substdrive (e.g. "P:\felix" where "P:" is a "subst" drive to "C:\tmp"), some internal resources failed to be properly resolved on startup.I noticed that, with Java 25, an exception occured in
org.apache.felix.framework.Felix#handleJavaVersionChange().After some investigation and step-by-step debugging, it appeared that the issue is located in
BundleCache#getSystemBundleDataFile(String)because the canonical paths are not resolved similarly. This causes the file to be detected as outside of it directory.To prevent this verification from being too dependent on the underlying file-system and the resolution to real paths, this commit leverages
java.nio.file.Path#normalizeto sanitize the file path.