This is an automated email from the ASF dual-hosted git repository.

dongjoon pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/spark.git


The following commit(s) were added to refs/heads/master by this push:
     new 0c653db0b2fe [SPARK-49879][CORE] Move `TransportCipherUtil` to a 
separate file to eliminate Java compilation warnings
0c653db0b2fe is described below

commit 0c653db0b2fe9d337a1f69220862d05df2f0daf7
Author: yangjie01 <[email protected]>
AuthorDate: Fri Oct 4 15:18:16 2024 -0700

    [SPARK-49879][CORE] Move `TransportCipherUtil` to a separate file to 
eliminate Java compilation warnings
    
    ### What changes were proposed in this pull request?
    Run `build/mvn clean install -pl common/network-common`, we can see the 
following compilation warnings:
    
    ```
    [WARNING] [Warn] 
/Users/yangjie01/SourceCode/git/spark-maven/common/network-common/src/main/java/org/apache/spark/network/crypto/CtrTransportCipher.java:73:11:
    auxiliary class TransportCipherUtil in 
/Users/yangjie01/SourceCode/git/spark-maven/common/network-common/src/main/java/org/apache/spark/network/crypto/TransportCipher.java
 should not be accessed from outside its own source file
    [WARNING] [Warn] 
/Users/yangjie01/SourceCode/git/spark-maven/common/network-common/src/main/java/org/apache/spark/network/crypto/GcmTransportCipher.java:63:15:
    auxiliary class TransportCipherUtil in 
/Users/yangjie01/SourceCode/git/spark-maven/common/network-common/src/main/java/org/apache/spark/network/crypto/TransportCipher.java
 should not be accessed from outside its own source file
    ```
    
    So this pr moves `TransportCipherUtil` to a separate file to eliminate the 
aforementioned Java compilation warnings.
    
    ### Why are the changes needed?
    Fix compilation warnings.
    
    ### Does this PR introduce _any_ user-facing change?
    No
    
    ### How was this patch tested?
    - Pass GitHub Actions
    - locally run `build/mvn clean install -pl common/network-common`, no 
longer have the aforementioned compilation warnings.
    
    ### Was this patch authored or co-authored using generative AI tooling?
    No
    
    Closes #48352 from LuciferYang/Move-TransportCipherUtil.
    
    Authored-by: yangjie01 <[email protected]>
    Signed-off-by: Dongjoon Hyun <[email protected]>
---
 .../spark/network/crypto/TransportCipher.java      | 20 -----------
 ...ansportCipher.java => TransportCipherUtil.java} | 39 +++++++++-------------
 2 files changed, 16 insertions(+), 43 deletions(-)

diff --git 
a/common/network-common/src/main/java/org/apache/spark/network/crypto/TransportCipher.java
 
b/common/network-common/src/main/java/org/apache/spark/network/crypto/TransportCipher.java
index 355c55272018..33494aee4444 100644
--- 
a/common/network-common/src/main/java/org/apache/spark/network/crypto/TransportCipher.java
+++ 
b/common/network-common/src/main/java/org/apache/spark/network/crypto/TransportCipher.java
@@ -17,32 +17,12 @@
 
 package org.apache.spark.network.crypto;
 
-import com.google.common.annotations.VisibleForTesting;
-import com.google.crypto.tink.subtle.Hex;
-import com.google.crypto.tink.subtle.Hkdf;
 import io.netty.channel.Channel;
 
-import javax.crypto.spec.SecretKeySpec;
 import java.io.IOException;
-import java.nio.charset.StandardCharsets;
 import java.security.GeneralSecurityException;
 
 interface TransportCipher {
     String getKeyId() throws GeneralSecurityException;
     void addToChannel(Channel channel) throws IOException, 
GeneralSecurityException;
 }
-
-class TransportCipherUtil {
-    /*
-     * This method is used for testing to verify key derivation.
-     */
-    @VisibleForTesting
-    static String getKeyId(SecretKeySpec key) throws GeneralSecurityException {
-        byte[] keyIdBytes = Hkdf.computeHkdf("HmacSha256",
-                key.getEncoded(),
-                null,
-                "keyID".getBytes(StandardCharsets.UTF_8),
-                32);
-        return Hex.encode(keyIdBytes);
-    }
-}
diff --git 
a/common/network-common/src/main/java/org/apache/spark/network/crypto/TransportCipher.java
 
b/common/network-common/src/main/java/org/apache/spark/network/crypto/TransportCipherUtil.java
similarity index 63%
copy from 
common/network-common/src/main/java/org/apache/spark/network/crypto/TransportCipher.java
copy to 
common/network-common/src/main/java/org/apache/spark/network/crypto/TransportCipherUtil.java
index 355c55272018..1df2732f240c 100644
--- 
a/common/network-common/src/main/java/org/apache/spark/network/crypto/TransportCipher.java
+++ 
b/common/network-common/src/main/java/org/apache/spark/network/crypto/TransportCipherUtil.java
@@ -17,32 +17,25 @@
 
 package org.apache.spark.network.crypto;
 
-import com.google.common.annotations.VisibleForTesting;
-import com.google.crypto.tink.subtle.Hex;
-import com.google.crypto.tink.subtle.Hkdf;
-import io.netty.channel.Channel;
-
-import javax.crypto.spec.SecretKeySpec;
-import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.security.GeneralSecurityException;
+import javax.crypto.spec.SecretKeySpec;
 
-interface TransportCipher {
-    String getKeyId() throws GeneralSecurityException;
-    void addToChannel(Channel channel) throws IOException, 
GeneralSecurityException;
-}
+import com.google.common.annotations.VisibleForTesting;
+import com.google.crypto.tink.subtle.Hex;
+import com.google.crypto.tink.subtle.Hkdf;
 
 class TransportCipherUtil {
-    /*
-     * This method is used for testing to verify key derivation.
-     */
-    @VisibleForTesting
-    static String getKeyId(SecretKeySpec key) throws GeneralSecurityException {
-        byte[] keyIdBytes = Hkdf.computeHkdf("HmacSha256",
-                key.getEncoded(),
-                null,
-                "keyID".getBytes(StandardCharsets.UTF_8),
-                32);
-        return Hex.encode(keyIdBytes);
-    }
+  /**
+   * This method is used for testing to verify key derivation.
+   */
+  @VisibleForTesting
+  static String getKeyId(SecretKeySpec key) throws GeneralSecurityException {
+    byte[] keyIdBytes = Hkdf.computeHkdf("HmacSha256",
+        key.getEncoded(),
+        null,
+        "keyID".getBytes(StandardCharsets.UTF_8),
+        32);
+    return Hex.encode(keyIdBytes);
+  }
 }


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to