Skip to content

Commit 16c51d8

Browse files
NihalJainNihalJain
authored
HBASE-28921 Avoid bundling hbase-webapps folder in default jars (#6388)
We are bundling all webapp resources in hbase-server, hbase-thrift, hbase-rest and transitively to hbase-shaded-mapreduce jar. This can be an issue, say if any of the Js projects used by hbase are vulnerable, security scan tools like sonatype start flagging the jars too as vulnerable since they contain vulnerable code. With this JIRA, we want to avoid bundling static webapp resources in our jars as these are available during runtime via hbase-webapps directory bundled in our assembly. But, we still need this for our minicluster based tests which expects it to be present in test classpath. Hence, we are copying hbase-webapps to hbase-server tests jar, which contains class SingleProcessHBaseCluster responsible for hbase minicluster creation. This class eventually needs hbase-webapps in classpath during HttpServer initialisation and hence we are adding hbase-webapps to hbase-server test resources. Signed-off-by: Istvan Toth <[email protected]>
1 parent 70f2fef commit 16c51d8

File tree

3 files changed

+93
-15
lines changed

3 files changed

+93
-15
lines changed

‎hbase-rest/pom.xml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -289,6 +289,15 @@
289289
<skipAssembly>true</skipAssembly>
290290
</configuration>
291291
</plugin>
292+
<plugin>
293+
<groupId>org.apache.maven.plugins</groupId>
294+
<artifactId>maven-jar-plugin</artifactId>
295+
<configuration>
296+
<excludes>
297+
<exclude>**/hbase-webapps/**</exclude>
298+
</excludes>
299+
</configuration>
300+
</plugin>
292301
<!-- Make a jar and put the sources in the jar -->
293302
<plugin>
294303
<groupId>org.apache.maven.plugins</groupId>

‎hbase-server/pom.xml

Lines changed: 75 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
<license.bundles.bootstrap>true</license.bundles.bootstrap>
3636
<license.bundles.jquery>true</license.bundles.jquery>
3737
<license.bundles.vega>true</license.bundles.vega>
38+
<hbase.webapps.dir>hbase-webapps</hbase.webapps.dir>
3839
</properties>
3940
<dependencies>
4041
<dependency>
@@ -437,24 +438,83 @@
437438
<skipAssembly>true</skipAssembly>
438439
</configuration>
439440
</plugin>
441+
<plugin>
442+
<groupId>org.codehaus.mojo</groupId>
443+
<artifactId>build-helper-maven-plugin</artifactId>
444+
<executions>
445+
<execution>
446+
<id>add-test-source</id>
447+
<goals>
448+
<goal>add-test-resource</goal>
449+
</goals>
450+
<phase>generate-test-sources</phase>
451+
<configuration>
452+
<!-- Add the hbase-webapps directory to the test resources -->
453+
<resources>
454+
<resource>
455+
<!-- Directory containing hbase-webapps -->
456+
<directory>target/${hbase.webapps.dir}</directory>
457+
<!-- Target directory under test-classes -->
458+
<targetPath>${hbase.webapps.dir}</targetPath>
459+
</resource>
460+
</resources>
461+
</configuration>
462+
</execution>
463+
</executions>
464+
</plugin>
440465
<plugin>
441466
<groupId>org.apache.maven.plugins</groupId>
442467
<artifactId>maven-jar-plugin</artifactId>
443-
<configuration>
444-
<!-- Exclude these 2 packages, because their dependency _binary_ files
445-
include the sources, and Maven 2.2 appears to add them to the sources to compile,
446-
weird -->
447-
<excludes>
448-
<exclude>org/apache/jute/**</exclude>
449-
<exclude>org/apache/zookeeper/**</exclude>
450-
<exclude>**/*.jsp</exclude>
451-
<exclude>hbase-site.xml</exclude>
452-
<exclude>hdfs-site.xml</exclude>
453-
<exclude>log4j.properties</exclude>
454-
<exclude>mapred-queues.xml</exclude>
455-
<exclude>mapred-site.xml</exclude>
456-
</excludes>
457-
</configuration>
468+
<executions>
469+
<!-- Exclude specified file(s) from the default JAR -->
470+
<execution>
471+
<id>default-jar</id>
472+
<goals>
473+
<goal>jar</goal>
474+
</goals>
475+
<phase>package</phase>
476+
<configuration>
477+
<excludes>
478+
<!-- Exclude these 2 packages, because their dependency _binary_ files
479+
include the sources, and Maven 2.2 appears to add them to the sources to compile,
480+
weird -->
481+
<exclude>org/apache/jute/**</exclude>
482+
<exclude>org/apache/zookeeper/**</exclude>
483+
<exclude>**/*.jsp</exclude>
484+
<exclude>hbase-site.xml</exclude>
485+
<exclude>hdfs-site.xml</exclude>
486+
<exclude>log4j.properties</exclude>
487+
<exclude>mapred-queues.xml</exclude>
488+
<exclude>mapred-site.xml</exclude>
489+
<!-- NOTE: We have the below exclude only for the default JAR -->
490+
<exclude>**/hbase-webapps/**</exclude>
491+
</excludes>
492+
</configuration>
493+
</execution>
494+
<!-- Copy of default jar exclusions, minus not removing hbase-webapps-->
495+
<execution>
496+
<id>test-jar</id>
497+
<goals>
498+
<goal>test-jar</goal>
499+
</goals>
500+
<phase>package</phase>
501+
<configuration>
502+
<classifier>tests</classifier>
503+
<excludes>
504+
<exclude>org/apache/jute/**</exclude>
505+
<exclude>org/apache/zookeeper/**</exclude>
506+
<exclude>**/*.jsp</exclude>
507+
<exclude>hbase-site.xml</exclude>
508+
<exclude>hdfs-site.xml</exclude>
509+
<exclude>log4j.properties</exclude>
510+
<exclude>mapred-queues.xml</exclude>
511+
<exclude>mapred-site.xml</exclude>
512+
<!-- We do not want to exclude hbase-webapps from tests. We actually intentionally
513+
add this directory to out test resources. See HBASE-28921 for details! -->
514+
</excludes>
515+
</configuration>
516+
</execution>
517+
</executions>
458518
</plugin>
459519
<!-- General ant tasks, bound to different build phases -->
460520
<plugin>

‎hbase-thrift/pom.xml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,15 @@
194194
<skipAssembly>true</skipAssembly>
195195
</configuration>
196196
</plugin>
197+
<plugin>
198+
<groupId>org.apache.maven.plugins</groupId>
199+
<artifactId>maven-jar-plugin</artifactId>
200+
<configuration>
201+
<excludes>
202+
<exclude>**/hbase-webapps/**</exclude>
203+
</excludes>
204+
</configuration>
205+
</plugin>
197206
<!-- General ant tasks, bound to different build phases -->
198207
<plugin>
199208
<artifactId>maven-antrun-plugin</artifactId>

0 commit comments

Comments
 (0)