[Bouncy Castle] include bc into pulsar-client fix docs (apache#8491)

### Motivation The docs of bc need an update after merge PR apache#7453, also we could include bc in the pulsar client to avoid reference it in other modules. ### Modifications - fix the docs after fix PR 7453; - make pulsar client include bc module; avoid other modules to include bc. - fix the pulsar-function bc jar issue. ### Verifying this change all the tests passed.
teaey · Nov 10, 2020 · 134f2aa · 134f2aa
1 parent 73b4c3d
commit 134f2aa
Show file tree

Hide file tree

Showing 23 changed files with 126 additions and 231 deletions.
diff --git a/bouncy-castle/bcfips-include-test/pom.xml b/bouncy-castle/bcfips-include-test/pom.xml
@@ -69,15 +69,10 @@
 
     <!--exclude bouncy castle, then load fips version-->
     <dependency>
-      <groupId>org.bouncycastle</groupId>
-      <artifactId>bc-fips</artifactId>
-      <version>${bouncycastlefips.version}</version>
-    </dependency>
-
-    <dependency>
-      <groupId>org.bouncycastle</groupId>
-      <artifactId>bcpkix-fips</artifactId>
-      <version>${bouncycastlefips.version}</version>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>bouncy-castle-bcfips</artifactId>
+      <version>${project.version}</version>
+      <classifier>pkg</classifier>
     </dependency>
 
   </dependencies>

diff --git a/distribution/server/pom.xml b/distribution/server/pom.xml
@@ -40,14 +40,6 @@
       <version>${project.version}</version>
     </dependency>
 
-    <dependency>
-      <groupId>${project.groupId}</groupId>
-      <artifactId>bouncy-castle-bc</artifactId>
-      <version>${project.version}</version>
-      <classifier>pkg</classifier>
-      <optional>true</optional>
-    </dependency>
-
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>pulsar-discovery-service</artifactId>

diff --git a/pulsar-broker-shaded/pom.xml b/pulsar-broker-shaded/pom.xml
@@ -40,13 +40,6 @@
       <artifactId>pulsar-broker</artifactId>
       <version>${project.parent.version}</version>
     </dependency>
-    <dependency>
-      <groupId>${project.groupId}</groupId>
-      <artifactId>bouncy-castle-bc</artifactId>
-      <version>${project.parent.version}</version>
-      <classifier>pkg</classifier>
-      <optional>true</optional>
-    </dependency>
   </dependencies>
 
   <build>
@@ -111,8 +104,6 @@
                   <include>com.thoughtworks.paranamer:paranamer</include>
                   <include>org.apache.commons:commons-compress</include>
                   <include>org.tukaani:xz</include>
-                  <!-- bouncycastle Provider dependencies-->
-                  <include>org.bouncycastle:*</include>
                 </includes>
               </artifactSet>
               <filters>
@@ -121,6 +112,10 @@
                   <includes>
                     <include>**</include>
                   </includes>
+                  <excludes>
+                    <!-- bouncycastle jars could not be shaded, or the signatures will be wrong-->
+                    <exclude>org/bouncycastle/**</exclude>
+                  </excludes>
                 </filter>
               </filters>
               <relocations>

diff --git a/pulsar-broker/pom.xml b/pulsar-broker/pom.xml
@@ -76,14 +76,6 @@
       <version>${project.version}</version>
     </dependency>
 
-    <dependency>
-      <groupId>${project.groupId}</groupId>
-      <artifactId>bouncy-castle-bc</artifactId>
-      <version>${project.version}</version>
-      <classifier>pkg</classifier>
-      <optional>true</optional>
-    </dependency>
-
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>pulsar-discovery-service</artifactId>

diff --git a/pulsar-client-1x-base/pulsar-client-2x-shaded/pom.xml b/pulsar-client-1x-base/pulsar-client-2x-shaded/pom.xml
@@ -69,6 +69,10 @@
                   <includes>
                     <include>**</include>
                   </includes>
+                  <excludes>
+                    <!-- bouncycastle jars could not be shaded, or the signatures will be wrong-->
+                    <exclude>org/bouncycastle/**</exclude>
+                  </excludes>
                 </filter>
               </filters>
               <relocations>

diff --git a/pulsar-client-admin-shaded/pom.xml b/pulsar-client-admin-shaded/pom.xml
@@ -92,8 +92,6 @@
                   <include>org.yaml:snakeyaml</include>
                   <include>io.swagger:*</include>
                   <include>org.apache.bookkeeper:bookkeeper-common-allocator</include>
-                  <!-- bouncycastle Provider dependencies-->
-                  <include>org.bouncycastle:*</include>
                 </includes>
               </artifactSet>
               <filters>
@@ -102,12 +100,20 @@
                   <includes>
                     <include>**</include>
                   </includes>
+                  <excludes>
+                    <!-- bouncycastle jars could not be shaded, or the signatures will be wrong-->
+                    <exclude>org/bouncycastle/**</exclude>
+                  </excludes>
                 </filter>
                 <filter>
                   <artifact>org.apache.pulsar:pulsar-client-admin-original</artifact>
                   <includes>
                     <include>**</include>
                   </includes>
+                  <excludes>
+                    <!-- bouncycastle jars could not be shaded, or the signatures will be wrong-->
+                    <exclude>org/bouncycastle/**</exclude>
+                  </excludes>
                 </filter>
               </filters>
               <relocations>

diff --git a/pulsar-client-all/pom.xml b/pulsar-client-all/pom.xml
@@ -49,19 +49,11 @@
       <version>${project.parent.version}</version>
       <optional>true</optional>
     </dependency>
-    <dependency>
-      <groupId>${project.groupId}</groupId>
-      <artifactId>bouncy-castle-bc</artifactId>
-      <version>${project.parent.version}</version>
-      <classifier>pkg</classifier>
-      <optional>true</optional>
-    </dependency>
   </dependencies>
 
   <build>
     <plugins>
 
-
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-dependency-plugin</artifactId>
@@ -85,8 +77,6 @@
                   <outputDirectory>${project.build.directory}/classes</outputDirectory>
                 </artifactItem>
               </artifactItems>
-
-
             </configuration>
           </execution>
         </executions>
@@ -162,8 +152,7 @@
                   <include>org.apache.commons:commons-compress</include>
                   <include>org.tukaani:xz</include>
                   <include>org.apache.bookkeeper:bookkeeper-common-allocator</include>
-                  <!-- bouncycastle Provider dependencies-->
-                  <include>org.bouncycastle:*</include>
+                  <!-- Issue #6834, Since Netty ByteBuf shaded, we need also shade this module -->
                   <include>org.apache.pulsar:pulsar-client-messagecrypto-bc</include>
                 </includes>
               </artifactSet>
@@ -173,6 +162,10 @@
                   <includes>
                     <include>**</include>
                   </includes>
+                  <excludes>
+                    <!-- bouncycastle jars could not be shaded, or the signatures will be wrong-->
+                    <exclude>org/bouncycastle/**</exclude>
+                  </excludes>
                 </filter>
               </filters>
               <relocations>

diff --git a/pulsar-client-shaded/pom.xml b/pulsar-client-shaded/pom.xml
@@ -42,14 +42,6 @@
       <groupId>${project.groupId}</groupId>
       <artifactId>pulsar-client-messagecrypto-bc</artifactId>
       <version>${project.version}</version>
-      <optional>true</optional>
-    </dependency>
-    <dependency>
-      <groupId>${project.groupId}</groupId>
-      <artifactId>bouncy-castle-bc</artifactId>
-      <version>${project.version}</version>
-      <classifier>pkg</classifier>
-      <optional>true</optional>
     </dependency>
   </dependencies>
 
@@ -89,8 +81,6 @@
                   <outputDirectory>${project.build.directory}/classes/org/asynchttpclient/config</outputDirectory>
                 </artifactItem>
               </artifactItems>
-
-
             </configuration>
           </execution>
         </executions>
@@ -149,27 +139,20 @@
                   <include>com.thoughtworks.paranamer:paranamer</include>
                   <include>org.apache.commons:commons-compress</include>
                   <include>org.tukaani:xz</include>
-                  <!-- bouncycastle Provider dependencies-->
-                  <include>org.bouncycastle:*</include>
+                  <!-- Issue #6834, Since Netty ByteBuf shaded, we need also shade this module -->
                   <include>org.apache.pulsar:pulsar-client-messagecrypto-bc</include>
                 </includes>
               </artifactSet>
               <filters>
-                <filter>
-                  <!-- Shading signed JARs will fail without
-                      this. http://stackoverflow.com/questions/999489/invalid-signature-file-when-attempting-to-run-a-jar -->
-                  <artifact>*:*</artifact>
-                  <excludes>
-                    <exclude>META-INF/*.SF</exclude>
-                    <exclude>META-INF/*.DSA</exclude>
-                    <exclude>META-INF/*.RSA</exclude>
-                  </excludes>
-                </filter>
                 <filter>
                   <artifact>org.apache.pulsar:pulsar-client-original</artifact>
                   <includes>
                     <include>**</include>
                   </includes>
+                  <excludes>
+                    <!-- bouncycastle jars could not be shaded, or the signatures will be wrong-->
+                    <exclude>org/bouncycastle/**</exclude>
+                  </excludes>
                 </filter>
               </filters>
               <relocations>

diff --git a/pulsar-client-tools-test/pom.xml b/pulsar-client-tools-test/pom.xml
@@ -57,13 +57,6 @@
       <version>${project.version}</version>
       <scope>test</scope>
     </dependency>
-    <dependency>
-      <groupId>${project.groupId}</groupId>
-      <artifactId>bouncy-castle-bc</artifactId>
-      <version>${project.version}</version>
-      <classifier>pkg</classifier>
-      <scope>test</scope>
-    </dependency>
   </dependencies>
   <build>
     <plugins>

diff --git a/pulsar-client/pom.xml b/pulsar-client/pom.xml
@@ -56,11 +56,10 @@
       <artifactId>bouncy-castle-bc</artifactId>
       <version>${project.parent.version}</version>
       <classifier>pkg</classifier>
-      <!-- bc module should not be included in the followed package, or the signature in jar would be wrong -->
-      <optional>true</optional>
     </dependency>
 
     <dependency>
+      <!-- this module only need by the real client, client inside broker no need this module -->
       <groupId>${project.groupId}</groupId>
       <artifactId>pulsar-client-messagecrypto-bc</artifactId>
       <version>${project.parent.version}</version>

diff --git a/pulsar-discovery-service/pom.xml b/pulsar-discovery-service/pom.xml
@@ -67,7 +67,6 @@
       <artifactId>bouncy-castle-bc</artifactId>
       <version>${project.version}</version>
       <classifier>pkg</classifier>
-      <optional>true</optional>
     </dependency>
 
     <dependency>

diff --git a/pulsar-functions/localrun-shaded/pom.xml b/pulsar-functions/localrun-shaded/pom.xml
@@ -60,13 +60,13 @@
                             </transformers>
                             <filters>
                                 <filter>
-                                    <!-- Shading signed JARs will fail without
-                                        this. http://stackoverflow.com/questions/999489/invalid-signature-file-when-attempting-to-run-a-jar -->
-                                    <artifact>*:*</artifact>
+                                    <artifact>org.apache.pulsar:pulsar-client-original</artifact>
+                                    <includes>
+                                        <include>**</include>
+                                    </includes>
                                     <excludes>
-                                        <exclude>META-INF/*.SF</exclude>
-                                        <exclude>META-INF/*.DSA</exclude>
-                                        <exclude>META-INF/*.RSA</exclude>
+                                        <!-- bouncycastle jars could not be shaded, or the signatures will be wrong-->
+                                        <exclude>org/bouncycastle/**</exclude>
                                     </excludes>
                                 </filter>
                             </filters>
@@ -250,10 +250,6 @@
                                     <pattern>jline</pattern>
                                     <shadedPattern>org.apache.pulsar.functions.runtime.shaded.jline</shadedPattern>
                                 </relocation>
-                                <relocation>
-                                    <pattern>org.bouncycastle</pattern>
-                                    <shadedPattern>org.apache.pulsar.functions.runtime.shaded.org.bouncycastle</shadedPattern>
-                                </relocation>
                                 <relocation>
                                     <pattern>org.xerial.snappy</pattern>
                                     <shadedPattern>org.apache.pulsar.functions.runtime.shaded.org.xerial.snappy</shadedPattern>
@@ -353,4 +349,4 @@
             </plugin>
         </plugins>
     </build>
-</project>
+</project>
diff --git a/pulsar-functions/worker/pom.xml b/pulsar-functions/worker/pom.xml
@@ -52,13 +52,6 @@
       <version>${project.version}</version>
     </dependency>
 
-    <dependency>
-      <groupId>${project.groupId}</groupId>
-      <artifactId>bouncy-castle-bc</artifactId>
-      <version>${project.version}</version>
-      <classifier>pkg</classifier>
-    </dependency>
-
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>pulsar-client-admin-original</artifactId>

diff --git a/pulsar-io/debezium/core/pom.xml b/pulsar-io/debezium/core/pom.xml
@@ -68,13 +68,6 @@
       <version>${project.version}</version>
     </dependency>
 
-    <dependency>
-      <groupId>${project.groupId}</groupId>
-      <artifactId>bouncy-castle-bc</artifactId>
-      <version>${project.version}</version>
-      <classifier>pkg</classifier>
-    </dependency>
-
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>pulsar-broker</artifactId>

diff --git a/pulsar-io/kafka-connect-adaptor/pom.xml b/pulsar-io/kafka-connect-adaptor/pom.xml
@@ -68,13 +68,6 @@
       <version>${project.version}</version>
     </dependency>
 
-    <dependency>
-      <groupId>${project.groupId}</groupId>
-      <artifactId>bouncy-castle-bc</artifactId>
-      <version>${project.version}</version>
-      <classifier>pkg</classifier>
-    </dependency>
-
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>kafka-connect-avro-converter-shaded</artifactId>

diff --git a/pulsar-proxy/pom.xml b/pulsar-proxy/pom.xml
@@ -171,12 +171,5 @@
       <groupId>com.beust</groupId>
       <artifactId>jcommander</artifactId>
     </dependency>
-
-    <dependency>
-      <groupId>${project.groupId}</groupId>
-      <artifactId>bouncy-castle-bc</artifactId>
-      <version>${project.version}</version>
-      <scope>test</scope>
-    </dependency>
   </dependencies>
 </project>
diff --git a/pulsar-sql/presto-pulsar/pom.xml b/pulsar-sql/presto-pulsar/pom.xml
@@ -63,14 +63,6 @@
             <version>${project.version}</version>
         </dependency>
 
-        <dependency>
-            <groupId>${project.groupId}</groupId>
-            <artifactId>bouncy-castle-bc</artifactId>
-            <version>${project.version}</version>
-            <classifier>pkg</classifier>
-            <optional>true</optional>
-        </dependency>
-
         <dependency>
             <groupId>${project.groupId}</groupId>
             <artifactId>managed-ledger</artifactId>
@@ -148,6 +140,10 @@
                                     <includes>
                                         <include>**</include>
                                     </includes>
+                                    <excludes>
+                                        <!-- bouncycastle jars could not be shaded, or the signatures will be wrong-->
+                                        <exclude>org/bouncycastle/**</exclude>
+                                    </excludes>
                                 </filter>
                             </filters>
                             <relocations>