ph-utils 0.14.1 → 0.15.0

package/lib/crypto.d.ts

@@ -13,6 +13,24 @@ export declare function bufferToHex(bf: ArrayBuffer | Uint8Array, upper?: boolea
  * @returns
  */
 export declare function sha(message: string, upper?: boolean, algorithm?: string): Promise<string>;
+/**
+ * 哈希算法
+ * @param message     待进行 hash 的数据
+ * @param upper       是否转换为大写, 默认为: false
+ * @param algorithm   hash算法, 支持: SHA-1、SHA-256、SHA-384、SHA-512; 默认为: SHA-256
+ * @returns
+ */
+export declare function hash(message: string, upper?: boolean, algorithm?: string): Promise<string>;
+type HMACAlgorithm = "SHA-256" | "SHA-512";
+/**
+ * 使用 HMAC 算法计算消息的哈希值
+ * @param message - 需要计算哈希的消息字符串
+ * @param secret - 用于生成 HMAC 的密钥
+ * @param algorithm - HMAC 使用的哈希算法,默认为 "SHA-256"
+ * @param upper - 是否将结果转换为大写,默认为 false
+ * @returns 返回十六进制格式的 HMAC 哈希值
+ */
+export declare function hmacHash(message: string, secret: string, algorithm?: HMACAlgorithm, upper?: boolean): Promise<string>;
 /** 返回结果类似 */
 type AlgorithmResType = "hex" | "hexUpper" | "base64" | "raw";
 /**

package/lib/crypto.js

@@ -63,6 +63,30 @@ export async function sha(message, upper = false, algorithm = "SHA-256") {
     const hashBuffer = await globalThis.crypto.subtle.digest(algorithm || "SHA-256", msgUint8);
     return bufferToHex(hashBuffer, upper);
 }
+/**
+ * 哈希算法
+ * @param message     待进行 hash 的数据
+ * @param upper       是否转换为大写, 默认为: false
+ * @param algorithm   hash算法, 支持: SHA-1、SHA-256、SHA-384、SHA-512; 默认为: SHA-256
+ * @returns
+ */
+export async function hash(message, upper = false, algorithm = "SHA-256") {
+    return sha(message, upper, algorithm);
+}
+/**
+ * 使用 HMAC 算法计算消息的哈希值
+ * @param message - 需要计算哈希的消息字符串
+ * @param secret - 用于生成 HMAC 的密钥
+ * @param algorithm - HMAC 使用的哈希算法,默认为 "SHA-256"
+ * @param upper - 是否将结果转换为大写,默认为 false
+ * @returns 返回十六进制格式的 HMAC 哈希值
+ */
+export async function hmacHash(message, secret, algorithm = "SHA-256", upper = false) {
+    const encoder = new TextEncoder();
+    const key = await crypto.subtle.importKey("raw", encoder.encode(secret), { name: "HMAC", hash: { name: algorithm } }, false, ["sign"]);
+    const signature = await crypto.subtle.sign("HMAC", key, encoder.encode(message));
+    return bufferToHex(signature, upper);
+}
 function parseRsaKey(pem) {
     const pemHeader = "-----BEGIN PUBLIC KEY-----";
     const pemFooter = "-----END PUBLIC KEY-----";

package/lib/crypto_node.d.ts

@@ -1,4 +1,5 @@
-type HashAlgorithmName = "md5" | "sha1" | "sha256";
+type HashAlgorithmName = "md5" | SHAHashAlgorithmName;
+type SHAHashAlgorithmName = "sha1" | "sha256" | "sha512";
 /**
  * 进行 md5|sha1|sha256 数据摘要签名
  * @param d 待加密的数据
@@ -6,6 +7,22 @@ type HashAlgorithmName = "md5" | "sha1" | "sha256";
  * @param upper 返回的结果是否需要大写. Defaults to False.
  */
 export declare function hashDigest(d: string, algorithm?: HashAlgorithmName, upper?: boolean): string;
+/**
+ * 进行 md5|sha1|sha256 数据摘要签名
+ * @param d 待加密的数据
+ * @param algorithm 签名算法, md5、sha1、sha256. Defaults to "sha256".
+ * @param upper 返回的结果是否需要大写. Defaults to False.
+ */
+export declare function hash(d: string, algorithm?: HashAlgorithmName, upper?: boolean): string;
+/**
+ * 使用 HMAC 算法对消息进行哈希处理
+ * @param message 待处理的消息
+ * @param key 用于 HMAC 算法的密钥
+ * @param algorithm 哈希算法，可选值为 "sha1"、"sha256" 或 "sha512"，默认为 "sha256"
+ * @param upper 返回的结果是否需要大写，默认为 false
+ * @returns 经过 HMAC 哈希处理后的字符串
+ */
+export declare function hmacHash(message: string, key: string, algorithm?: SHAHashAlgorithmName, upper?: boolean): string;
 /**
  * 生成 RSA 签名密钥对
  * @returns: [公钥, 私钥]

package/lib/crypto_node.js

@@ -1,4 +1,4 @@
-import { createHash, createCipheriv, randomBytes, generateKeyPair, createDecipheriv, privateDecrypt, publicEncrypt, } from "node:crypto";
+import { createHash, createCipheriv, randomBytes, generateKeyPair, createDecipheriv, privateDecrypt, publicEncrypt, createHmac, } from "node:crypto";
 /**
  * 进行 md5|sha1|sha256 数据摘要签名
  * @param d 待加密的数据
@@ -9,6 +9,27 @@ export function hashDigest(d, algorithm = "sha256", upper = false) {
     const hashed = createHash(algorithm).update(d).digest("hex");
     return upper ? hashed.toUpperCase() : hashed;
 }
+/**
+ * 进行 md5|sha1|sha256 数据摘要签名
+ * @param d 待加密的数据
+ * @param algorithm 签名算法, md5、sha1、sha256. Defaults to "sha256".
+ * @param upper 返回的结果是否需要大写. Defaults to False.
+ */
+export function hash(d, algorithm = "sha256", upper = false) {
+    return hashDigest(d, algorithm, upper);
+}
+/**
+ * 使用 HMAC 算法对消息进行哈希处理
+ * @param message 待处理的消息
+ * @param key 用于 HMAC 算法的密钥
+ * @param algorithm 哈希算法，可选值为 "sha1"、"sha256" 或 "sha512"，默认为 "sha256"
+ * @param upper 返回的结果是否需要大写，默认为 false
+ * @returns 经过 HMAC 哈希处理后的字符串
+ */
+export function hmacHash(message, key, algorithm = "sha256", upper = false) {
+    const hashed = createHmac(algorithm, key).update(message).digest("hex");
+    return upper ? hashed.toUpperCase() : hashed;
+}
 /**
  * 生成 RSA 签名密钥对
  * @returns: [公钥, 私钥]

package/package.json

@@ -68,7 +68,7 @@
     },
     "./*": "./lib/*"
   },
-  "version": "0.14.1",
+  "version": "0.15.0",
   "type": "module",
   "repository": {
     "type": "git",