Skip to content

Fix shading of multi-release BouncyCastle classes #47127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vcolin7 merged 2 commits into from
Nov 3, 2025
Merged

Fix shading of multi-release BouncyCastle classes #47127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de256ad
Added workaround to move multi-release classes when shading BouncyCastle
vcolin7 Oct 31, 2025
d50b78d
Merge remote-tracking branch 'upstream/main' into jca-shading-fix
vcolin7 Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions sdk/keyvault/azure-security-keyvault-jca/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

### Bugs Fixed
- Fixed the NPE where the token object was not returned when the credential information was incorrect.
- Fixed an issue where release-specific classes from BouncyCastle were not properly shaded for Java 9 and above, leading to potential class loading issues in multi-release JARs. ([#47127](https://github.com/Azure/azure-sdk-for-java/pull/47127))

### Other Changes
- Included the `org.brotli:dec` library in the list of shaded dependencies to avoid issues when generating and publishing docs to MSLearn.
Expand Down
20 changes: 20 additions & 0 deletions sdk/keyvault/azure-security-keyvault-jca/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,11 @@
<exclude>META-INF/*.DSA</exclude>
<exclude>META-INF/*.RSA</exclude>
<exclude>META-INF/services/java.security.Provider</exclude>
<!-- Exclude OSGI metadata since it references original (unshaded) package names
and is not applicable after relocation -->
<exclude>**/OSGI-INF/**</exclude>
<!-- Exclude Bouncy Castle's module-info since it references unshaded packages. -->
<exclude>**/module-info.class</exclude>
</excludes>
</filter>
</filters>
Expand All @@ -170,6 +175,21 @@
<pattern>org.bouncycastle</pattern>
<shadedPattern>com.azure.security.keyvault.jca.implementation.shaded.org.bouncycastle</shadedPattern>
</relocation>
<!-- Manually relocate Bouncy Castle multi-release classes to the correct shaded package.
This workaround is needed because the maven-shade-plugin (as of 3.6.1) relocates the
bytecode but does not move the class files to the shaded directory structure (MSHADE-406).
This additional relocation rule matches the file path pattern and moves multi-release
classes to preserve Java 9+ optimizations while preventing package leakage.
Based on: https://github.com/datafaker-net/datafaker/pull/1008
See:
- https://github.com/apache/maven-shade-plugin/pull/202
- https://issues.apache.org/jira/browse/MSHADE-406
- https://github.com/Azure/azure-sdk-for-java/issues/45277 -->
<relocation>
<pattern>META-INF/versions/(\d+)/org/bouncycastle</pattern>
<shadedPattern>META-INF/versions/$1/com/azure/security/keyvault/jca/implementation/shaded/org/bouncycastle</shadedPattern>
<rawString>true</rawString>
</relocation>
</relocations>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
Expand Down
Loading