feat: 注释规范化

Author: meethigher

src/main/java/top/meethigher/proxy/FastAes.java

@@ -15,9 +15,9 @@
 public final class FastAes {
 
     private static final String TRANSFORMATION = "AES/GCM/NoPadding";
-    private static final int    AES_KEY_LEN    = 128;          // bit
-    private static final int    GCM_TAG_LEN    = 128;          // bit
-    private static final int    GCM_IV_LEN     = 12;           // byte
+    private static final int AES_KEY_LEN = 128;          // bit
+    private static final int GCM_TAG_LEN = 128;          // bit
+    private static final int GCM_IV_LEN = 12;           // byte
 
     private static final SecureRandom RAND = new SecureRandom();
 
@@ -30,12 +30,15 @@ public final class FastAes {
         }
     });
 
-    private FastAes() {}   // utility class
+    private FastAes() {
+    }   // utility class
 
     /* ---------------------------------- 对外 API ---------------------------------- */
 
     /**
      * 随机生成 AES-128 密钥
+     *
+     * @return 密钥
      */
     public static SecretKey generateKey() {
         try {
@@ -49,6 +52,9 @@ public static SecretKey generateKey() {
 
     /**
      * 将原始密钥字节数组包装成 SecretKey
+     *
+     * @param rawKey 原始密钥字节数组
+     * @return SecretKey
      */
     public static SecretKey restoreKey(byte[] rawKey) {
         if (rawKey.length != AES_KEY_LEN / 8) {
@@ -59,6 +65,10 @@ public static SecretKey restoreKey(byte[] rawKey) {
 
     /**
      * 加密：返回 byte[]，格式为 IV(12B) + CipherText + Tag(16B)
+     *
+     * @param key   密钥
+     * @param plain 原文
+     * @return 密文字节数组
      */
     public static byte[] encrypt(byte[] plain, SecretKey key) {
         try {
@@ -71,16 +81,20 @@ public static byte[] encrypt(byte[] plain, SecretKey key) {
             byte[] cipherText = cipher.doFinal(plain);
 
             return ByteBuffer.allocate(iv.length + cipherText.length)
-                             .put(iv)
-                             .put(cipherText)
-                             .array();
+                    .put(iv)
+                    .put(cipherText)
+                    .array();
         } catch (Exception e) {
             throw new RuntimeException("Encrypt error", e);
         }
     }
 
     /**
      * 解密：输入格式须为 IV(12B) + CipherText + Tag(16B)
+     *
+     * @param key              密钥
+     * @param ivPlusCipherText 密文
+     * @return 原文
      */
     public static byte[] decrypt(byte[] ivPlusCipherText, SecretKey key) {
         try {
@@ -104,7 +118,6 @@ public static byte[] decrypt(byte[] ivPlusCipherText, SecretKey key) {
         }
     }
 
-    /* ----------------------------- 简易 Base64 封装 ----------------------------- */
 
     public static String encryptToBase64(byte[] plain, SecretKey key) {
         return Base64.getEncoder().encodeToString(encrypt(plain, key));

src/main/java/top/meethigher/proxy/tcp/mux/Mux.java

@@ -45,7 +45,8 @@ public Mux(Vertx vertx, String secret) {
     }
 
     /**
-     * 将host与port通过英文冒号连接，返回加密base64串(无换行)
+     * @param configuration mux通信配置信息
+     * @return 返回configuration加密后的base64串(无换行)
      */
     public Buffer aesBase64Encode(MuxConfiguration configuration) {
         String addr = configuration.toString();
@@ -55,7 +56,8 @@ public Buffer aesBase64Encode(MuxConfiguration configuration) {
     }
 
     /**
-     * 将加密内容还原
+     * @param buffer 加密内容
+     * @return buffer解密后的内容
      */
     public MuxConfiguration aesBase64Decode(Buffer buffer) {
         TunnelMessageCodec.DecodedMessage decode = TunnelMessageCodec.decode(buffer);

src/main/java/top/meethigher/proxy/tcp/mux/ReverseTcpProxyMuxServer.java

@@ -45,6 +45,9 @@ protected void handleConnect(NetSocket src) {
 
     /**
      * 根据{@code MuxMessage }建立后端连接，并将数据连接和后端连接进行绑定
+     *
+     * @param src    muxclient与muxserver建立的连接
+     * @param muxMsg mux通信配置消息
      */
     protected void bindMuxConnections(NetSocket src, MuxMessageParser.MuxMessage muxMsg) {
         src.pause();

src/main/java/top/meethigher/proxy/tcp/tunnel/Tunnel.java

@@ -71,6 +71,8 @@ public void on(TunnelMessageType type, TunnelHandler tunnelHandler) {
 
     /**
      * 返回加密base64串(无换行)
+     * @param bodyBytes 原文
+     * @return 密文
      */
     public byte[] aesBase64Encode(byte[] bodyBytes) {
         SecretKey key = restoreKey(secret.getBytes(StandardCharsets.UTF_8));
@@ -79,6 +81,9 @@ public byte[] aesBase64Encode(byte[] bodyBytes) {
 
     /**
      * 将加密内容还原
+     *
+     * @param bodyBytes 密文
+     * @return 原文
      */
     public byte[] aesBase64Decode(byte[] bodyBytes) {
         SecretKey key = restoreKey(secret.getBytes(StandardCharsets.UTF_8));