Merge pull request #15 from CodeCraftersCN/dev/v1.1.0

Upgrade to v1.1.0

Author: Zihlu Wang

README.md

@@ -27,7 +27,7 @@ A module for generating globally unique IDs. It includes a facade interface and
 
 <span style="font-size: 14px;">_[Learn more](https://github.com/CodeCraftersCN/jdevkit/webcal/README.md)_</span>
 
-The module `webcal` is a Java library that facilitates the generation and resolution of iCalendar content for web-based calendar applications. It provides a flexible and easy-to-use API for creating web calendars with customizable settings and events.
+The module `webcal` is a Java library that facilitates the generation and resolution of iCalendar content for web-based calendar applications. It provides a flexible and easy-to-use API for creating web calendars with customisable settings and events.
 
 With the `webcal` module, developers can easily integrate calendar functionality into web applications, enabling users to view, add, and manage events in a structured and standardized format. It is designed to simplify calendar-related tasks and enhance the overall user experience when dealing with calendar data on the web.
 

devkit-core/pom.xml

@@ -23,7 +23,7 @@
     <parent>
         <groupId>cn.org.codecrafters</groupId>
         <artifactId>jdevkit</artifactId>
-        <version>1.0.1</version>
+        <version>1.1.0</version>
     </parent>
 
     <artifactId>devkit-core</artifactId>

devkit-core/src/main/java/cn/org/codecrafters/devkit/core/exceptions/NotImplementedException.java

@@ -18,31 +18,23 @@
 package cn.org.codecrafters.devkit.core.exceptions;
 
 /**
- * NotImplementedException - Custom Runtime Exception
- * <p>
  * The {@code NotImplementedException} class is a custom runtime exception
  * that represents a situation where a particular method or functionality is
- * not implemented or is currently unavailable in the codebase. It extends the
- * standard {@code RuntimeException} class, making it an unchecked exception.
- *
+ * not implemented or is currently unavailable in the codebase.
  * <p>
  * This exception is typically thrown when developers need to indicate that a
  * specific part of the code is incomplete or requires further implementation.
  * It serves as a placeholder to highlight unfinished sections of the
  * application during development and testing phases.
- *
  * <p>
  * Usage Example:
- *
  * <pre>
  * public void someMethod() {
  *     // Some code...
  *     throw new NotImplementedException("""
- *     This feature will be implemented in a future release.
- *     """);
+ *     This feature will be implemented in a future release.""");
  * }
  * </pre>
- *
  * <b>Contact</b>
  * <ul>
  *     <li>
@@ -55,7 +47,7 @@
  * </ul>
  *
  * @author Zihlu Wang
- * @version 1.0.0
+ * @version 1.1.0
  * @see RuntimeException
  * @since 1.0.0
  */

devkit-core/src/main/java/cn/org/codecrafters/devkit/core/exceptions/package-info.java

@@ -16,7 +16,7 @@
  */
 
 /**
- * Commonly used exceptions will be used in JDevKit.
+ * This package contains commonly used exceptions will be used in JDevKit.
  *
  * @author Zihlu Wang
  * @since 1.0.0

devkit-core/src/main/java/cn/org/codecrafters/devkit/core/package-info.java

@@ -16,19 +16,16 @@
  */
 
 /**
- * This package is a part of JDevKit, an open-source Java Development Kit that
- * provides a set of convenient tools to streamline code development and
- * enhance productivity. This package serves as the core package containing
- * common exceptions that are used throughout the entireJDevKit project.
- *
+ * This package is the core part of JDevKit, an open-source Java Development
+ * Kit that provides a set of convenient tools to streamline code development
+ * and enhance productivity. This package serves as the core package containing
+ * common exceptions that are used throughout the entire JDevKit project.
  * <p>
  * JDevKit is designed to be modular, and other specific feature modules within
  * the library may rely on these exceptions from the core package.
- *
  * <p>
  * For more information and the latest version of JDevKit, please visit our
  * website <a href="https://codecrafters.org.cn">codecrafters.org.cn</a>.
- *
  * <p>
  * <b>Contact</b>
  * <ul>

devkit-core/src/main/java/cn/org/codecrafters/devkit/package-info.java

@@ -19,8 +19,8 @@
  * This package is the main part of JDevKit, an open-source Java class library
  * that provides a set of convenient tools to streamline code development and
  * enhance productivity. This package serves as the root package for several
- * modules, containing devkit-core, guid and dev-utils module.
- *
+ * modules, containing {@code devkit-core}, {@code guid} and {@code dev-utils}
+ * module.
  * <p>
  * For more information and the latest version of JDevKit, please visit our
  * website <a href="https://codecrafters.org.cn">codecrafters.org.cn</a>.

devkit-utils/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>cn.org.codecrafters</groupId>
         <artifactId>jdevkit</artifactId>
-        <version>1.0.1</version>
+        <version>1.1.0</version>
     </parent>
 
     <artifactId>devkit-utils</artifactId>

devkit-utils/src/main/java/cn/org/codecrafters/devkit/utils/AesUtil.java

@@ -0,0 +1,136 @@
+/*
+ * Copyright (C) 2023 CodeCraftersCN.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package cn.org.codecrafters.devkit.utils;
+
+import lombok.extern.slf4j.Slf4j;
+
+import javax.crypto.BadPaddingException;
+import javax.crypto.Cipher;
+import javax.crypto.IllegalBlockSizeException;
+import javax.crypto.NoSuchPaddingException;
+import javax.crypto.spec.IvParameterSpec;
+import javax.crypto.spec.SecretKeySpec;
+import java.nio.charset.StandardCharsets;
+import java.security.InvalidAlgorithmParameterException;
+import java.security.InvalidKeyException;
+import java.security.NoSuchAlgorithmException;
+import java.util.Base64;
+import java.util.Objects;
+import java.util.UUID;
+
+/**
+ * {@link AesUtil} can help you encrypt and decrypt data with specified secret
+ * by AES algorithm.
+ *
+ * @author hubin@baomidou
+ * @version 1.1.0
+ * @since 1.1.0
+ */
+@Slf4j
+public final class AesUtil {
+
+    private AesUtil() {
+    }
+
+    private static final String AES = "AES";
+
+    private static final String AES_CBC_CIPHER = "AES/CBC/PKCS5Padding";
+
+    /**
+     * Encrypts the data using the AES algorithm with the given secret.
+     *
+     * @param data   the data to be encrypted
+     * @param secret the secret to encrypt the data
+     * @return the encryption result or {@code null} if encryption failed
+     */
+    public static byte[] encrypt(byte[] data, byte[] secret) {
+        try {
+            var secretKeySpec = new SecretKeySpec(new SecretKeySpec(secret, AES).getEncoded(), AES);
+            var cipher = Cipher.getInstance(AES_CBC_CIPHER);
+            cipher.init(Cipher.ENCRYPT_MODE, secretKeySpec, new IvParameterSpec(secret));
+            return cipher.doFinal(data);
+        } catch (NoSuchAlgorithmException | NoSuchPaddingException | UnsupportedOperationException |
+                 InvalidKeyException | InvalidAlgorithmParameterException | IllegalBlockSizeException |
+                 BadPaddingException exception) {
+            log.error(exception.getMessage());
+            for (var stackTraceElement : exception.getStackTrace()) {
+                log.error("{}", stackTraceElement.toString());
+            }
+        }
+        return null;
+    }
+
+    /**
+     * Decrypts the data using the AES algorithm with the given secret.
+     *
+     * @param data the data to be decrypted
+     * @param secret  the secret to encrypt the data
+     * @return the decryption result or {@code null} if decryption failed
+     */
+    public static byte[] decrypt(byte[] data, byte[] secret) {
+        try {
+            var secretKeySpec = new SecretKeySpec(new SecretKeySpec(secret, AES).getEncoded(), AES);
+            var cipher = Cipher.getInstance(AES_CBC_CIPHER);
+            cipher.init(Cipher.DECRYPT_MODE, secretKeySpec, new IvParameterSpec(secret));
+            return cipher.doFinal(data);
+        } catch (NoSuchAlgorithmException | NoSuchPaddingException | UnsupportedOperationException |
+                 InvalidKeyException | InvalidAlgorithmParameterException | IllegalBlockSizeException |
+                 BadPaddingException exception) {
+            log.error(exception.getMessage());
+            for (var stackTraceElement : exception.getStackTrace()) {
+                log.error("{}", stackTraceElement.toString());
+            }
+        }
+        return null;
+    }
+
+    /**
+     * Encrypts the data using the AES algorithm with the given secret.
+     *
+     * @param data the data to be encrypted
+     * @param secret  the secret to encrypt the data
+     * @return the encryption result or {@code null} if encryption failed
+     */
+    public static String encrypt(String data, String secret) {
+        return Base64.getEncoder().encodeToString(encrypt(data.getBytes(StandardCharsets.UTF_8), secret.getBytes(StandardCharsets.UTF_8)));
+    }
+
+    /**
+     * Decrypts the data using the AES algorithm with the given secret.
+     *
+     * @param data the data to be decrypted
+     * @param secret  the secret to encrypt the data
+     * @return the decryption result or {@code null} if decryption failed
+     */
+    public static String decrypt(String data, String secret) {
+        return new String(Objects.requireNonNull(
+                decrypt(Base64.getDecoder().decode(data.getBytes()),
+                        secret.getBytes(StandardCharsets.UTF_8)))
+        );
+    }
+
+    /**
+     * Generates 16 characters-long random secret.
+     *
+     * @return the generated secure secret
+     */
+    public static String generateRandomSecret() {
+        return UUID.randomUUID().toString().replaceAll("-", "").substring(0, 16);
+    }
+
+}

devkit-utils/src/main/java/cn/org/codecrafters/devkit/utils/Base64Util.java

@@ -20,20 +20,18 @@
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
 import java.util.Base64;
+import java.util.Objects;
 
 /**
- * <p>
- * The {@code Base64Util} class provides static methods to encode and decode
- * strings using Base64 encoding. It utilizes the {@link Base64} class from the
+ * The {@link Base64Util} class provides static methods to encode and decode
+ * strings with Base64 encoding. It utilizes the {@link Base64} class from the
  * Java standard library for performing the encoding and decoding operations.
  * This utility class offers convenient methods to encode and decode strings
  * with different character sets.
- * 
  * <p>
  * This class is designed as a final class with a private constructor to
  * prevent instantiation. All methods in this class are static, allowing easy
  * access to the Base64 encoding and decoding functionality.
- * 
  * <p>
  * Example usage:
  * <pre>
@@ -47,19 +45,45 @@
  * String decoded = Base64Util.decode(encoded);
  * System.out.println("Decoded string: " + decoded);
  * </pre>
- *
  * <p>
  * <b>Note:</b> This utility class uses the default charset (UTF-8) if no
  * specific charset is provided. It is recommended to specify the charset
  * explicitly to ensure consistent encoding and decoding.
- * 
  *
  * @author Zihlu Wang
- * @version 1.0.0
+ * @version 1.1.0
  * @since 1.0.0
  */
 public final class Base64Util {
 
+    private static Base64.Encoder encoder;
+
+    private static Base64.Decoder decoder;
+
+    /**
+     * Ensure that there is only one Base64 Encoder.
+     *
+     * @return the {@link Base64.Encoder} instance
+     */
+    private static Base64.Encoder getEncoder() {
+        if (Objects.isNull(encoder)) {
+            encoder = Base64.getEncoder();
+        }
+        return encoder;
+    }
+
+    /**
+     * Ensure that there is only one Base64 Encoder.
+     *
+     * @return the {@link Base64.Encoder} instance
+     */
+    private static Base64.Decoder getDecoder() {
+        if (Objects.isNull(decoder)) {
+            decoder = Base64.getDecoder();
+        }
+        return decoder;
+    }
+
     /**
      * Private constructor to prevent instantiation of the class.
      */
@@ -74,8 +98,7 @@ private Base64Util() {
      * @return the Base64 encoded string
      */
     public static String encode(String value, Charset charset) {
-        var encoder = Base64.getEncoder();
-        var encoded = encoder.encode(value.getBytes(charset));
+        var encoded = getEncoder().encode(value.getBytes(charset));
 
         return new String(encoded);
     }
@@ -98,8 +121,7 @@ public static String encode(String value) {
      * @return the decoded string
      */
     public static String decode(String value, Charset charset) {
-        var decoder = Base64.getDecoder();
-        var decoded = decoder.decode(value.getBytes(charset));
+        var decoded = getDecoder().decode(value.getBytes(charset));
 
         return new String(decoded);
     }