Skip to content

Commit a12de8c

Browse files
committed
Update Docs and Misc
1 parent b23b5e4 commit a12de8c

8 files changed

Lines changed: 43 additions & 11 deletions

File tree

JavyInputAppendix.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
"RandomIndex":number, // 仅WENYAN模式下需要:算法的随机程度,越大随机性越强,默认 50,最大100,超过100将会出错;
3131
"PianwenMode":bool, // 仅WENYAN模式下需要:尽可能使用对仗的骈文句式; 与逻辑句式冲突
3232
"LogicMode":bool, // 仅WENYAN模式下需要:尽可能使用逻辑句式; 与骈文句式冲突
33+
"Traditional":bool, // 仅WENYAN模式下需要:输出繁体中文。
3334
},
3435
}
3536

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,12 @@
5757

5858
### **熔古铸今:文言文仿真加密**
5959

60-
> 鹏彰于物,不必奏也。捷天谨走,城光益添,和人弥任,铃夜皆写,呈雨以登铃。
61-
>
62-
> 光韵开云,雅于莺茶,停而行之之谓速。是故无悦无谜,无瑞无聪,裳之所走、树之所振也。旧铃之纯水,常为悦水之莹风。人曰:“瑞琴之路,常留于其所允行而不读之处。” 璃非笑而去之者,孰可无鹏。非将选也,非可指也,书非当事涧,仍继叶言,奈何,同森而非航水也,能鸢者益。
60+
> 镜有能弹,雨有谧然。以语,当笑速夜,非花称雪所将湛流。不应事也,畅则为动礼,迷则为达鲤,然则绣雪自恋致矣。
6361
>
62+
> 此棋有南涧迷森,悠雨清琴。遥家为鸢兮,宏梦为鹤。或指林写岩,进恋于雨,是语也,鸳极驿安,璃慧空舒。况请瀚者宏,是故无和无后,无安无舒,空之所连、城之所见也。光语筑天,良于璃韵,安铃振灯,局文放花。是故无余无青,无遥无寒,语之所事、琴之所歌也。虽火俊茶长,所以赴雨,其空速也,或弹物任绸,弹楼于声。
6463
6564
构造高仿真文言文,**参考《古文观止》《经史百家杂钞》《古文辞类纂》等古代典籍。**
66-
标准AES256加密,引入更复杂的组句/语法选择机制,将密码和中国古典文言文相融合。
65+
标准 AES256 加密,引入更复杂的组句、语法匹配机制,将密码和中国古典文言文相融合。
6766

6867
密文高度随机,支持用户自定义随机性和文本风格偏好,打造前所未有的跨文化数字加密方案。
6968

@@ -208,6 +207,7 @@ AES 加密密钥和转轮密钥是同一个,均采用哈希值。
208207
- [**pako**](https://github.com/nodeca/pako) GZIP压缩实现 _©Vitaly Puzrin/Andrei Tuputcyn_, **MIT** License.
209208
- [**js-base64**](https://github.com/dankogai/js-base64) Base64编码工具实现 _©Dan Kogai_, **BSD-3-Clause** License.
210209
- [**mersenne-twister**](https://github.com/boo1ean/mersenne-twister) 梅森旋转算法实现 _©Makoto Matsumoto/Takuji Nishimura_, **BSD-3-Clause** License.
210+
- [**opencc-js**](https://github.com/nk2028/opencc-js) 简繁体转换实现 _©nk2028_, **MIT** License.
211211

212212
本项目许可证与所有依赖项的许可证兼容。
213213

docs/document/FAQ.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,17 @@ BERT 等文本分类模型,经过大量训练,也许可以单独攻击密文
4949
随机指数可以随用户喜好设置,一般推荐设置为 50(居中位置),如果你更喜欢整齐一点的密文,可以调小它。
5050

5151
无论用户如何设置随机指数和过滤开关,均不会影响密文的解密。
52+
53+
## 繁體中文(香港)
54+
55+
針對使用繁體中文的用戶,魔曰現已支援繁體中文輸入/輸出。
56+
57+
魔曰采用的繁體中文類別為香港繁體,爲確保加解密一致性,亦采用逐字轉換的方式,因此可能與實際語言習慣不同。
58+
59+
用戶在加密時打開 `繁體中文` 開關,可即時得到繁體中文密文。解密時,並毋須打開此開關,流動應用會自動做出適當處置。
60+
61+
::: tip 繁體中文示例
62+
63+
琴以秀,堅則為航庭,舒則為振鴛。不必關也,清則為求空,臨則為航戀。風聽而瑞鶯連也,予關夫極鏡繡冰,在秋月之雪。益鸝事於路而報琴,當短取彩局,而歌説不靜,非請彰也。
64+
65+
:::

docs/document/bench.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
## 标准
66

77
明文统一使用三个随机 UUID 首尾相接。
8-
密文使用魔曰 V3.1.10 随机生成。
8+
密文使用魔曰 V3.2.5 随机生成。
99

1010
表头数字(0/50)为随机指数。
1111

@@ -18,10 +18,12 @@
1818
| ------------------- | :------------: | :-------------: | :---------------: | :------: | :---------: |
1919
| DeepSeek R1 | ✅ (2/8) | ✅ (3/8) | ✅ (0/4) || 文学 |
2020
| DeepSeek V3 | ✅ (0/4) | ✅ (0/4) | ✅ (0/4) || 古典文学 |
21+
| DeepSeek V3.1 | ✅ (0/4) | ✅ (0/4) | ✅ (0/4) || 文学 |
2122
| GPT 4o | ✅ (0/4) | ✅ (0/4) | ✅ (0/4) || 意象诗文 |
2223
| Qwen 2.5-72B | ✅ (3/8) | ❌ (4/4) | ✅ (0/4) || 文学创作 |
2324
| Qwen QwQ-32B | ✅ (0/4) | ✅ (1/8) | ✅ (0/4) | 🟠\* | 古典文学 |
2425
| Qwen 3-235B-A22B | ✅ (0/4) | ✅ (1/8) | ✅ (0/4) || 诗歌 |
26+
| Qwen 3-Next-80B-A3B | ✅ (0/4) | ✅ (1/8) | ✅ (0/4) || 文言文 |
2527
| ERNIE 4.5-300B-A47B | ✅ (0/4) | ✅ (0/4) | ✅ (0/4) || 抽象文学 |
2628
| Kimi K2 Instruct | ✅ (1/8) | ✅ (3/8) | ✅ (0/4) || 文学/散文诗 |
2729
| 腾讯云 内容安全 | —— | —— | —— || —— |

docs/document/js-deploy.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Abra.WenyanInput(input, mode, key, {...}, callback);
7676

7777
如果指定了错误的密码,那么在解码/解密数据校验过程中会抛出错误。
7878

79-
第五个参数接受一个 callback 函数,程序会在执行中关键位置多次调用此函数,以便调试,无特殊用途可忽略此项
79+
第五个参数 `callback` 接受一个回调函数,缺省时为 `null`程序会在执行中关键位置多次调用此函数,以便调试,无调试需求可忽略此项
8080

8181
第四个参数接受一个`WenyanConfig`配置对象的输入,仅在加密的时候需要:
8282

@@ -90,6 +90,8 @@ export interface WenyanConfig {
9090
PianwenMode?: boolean;
9191
/** 指定是否强制生成逻辑密文,默认 false; */
9292
LogicMode?: boolean;
93+
/** 指定输出文本是否为繁体中文,默认 false; */
94+
Traditional?: boolean;
9395
}
9496
```
9597

@@ -101,6 +103,8 @@ export interface WenyanConfig {
101103

102104
`LogicMode` 是布尔值,默认为 `false`。如果传入 `true`,则加密结果会优先使用逻辑句式,呈现强论述类逻辑风格。解密时可以忽略这个参数。
103105

106+
`Traditional` 是布尔值,默认为 `false`。如果传入 `true`,则加密结果会自动转换为繁体中文(香港)。解密时可以忽略这个参数。
107+
104108
`PianwenMode``LogicMode` 不能同时指定为 `true`,否则会抛出错误。
105109

106110
```javascript

docs/document/wasm-deploy.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
"RandomIndex": number, // 仅WENYAN模式下需要:算法的随机程度,越大随机性越强,默认 50,最大100,超过100将会出错;
2929
"PianwenMode":bool, // 仅WENYAN模式下需要:尽可能使用对仗的骈文句式; 与逻辑句式冲突
3030
"LogicMode":bool, // 仅WENYAN模式下需要:尽可能使用逻辑句式; 与骈文句式冲突
31+
"Traditional":bool, // 仅WENYAN模式下需要:输出繁体中文。
3132
},
3233
}
3334
```

docs/index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,12 +82,12 @@ Abracadabra(魔曰) 是开源,安全,高效的文本加密工具。
8282

8383
### **熔古铸今:文言文仿真加密**
8484

85-
> 鹏彰于物,不必奏也。捷天谨走,城光益添,和人弥任,铃夜皆写,呈雨以登铃
85+
> 镜有能弹,雨有谧然。以语,当笑速夜,非花称雪所将湛流。不应事也,畅则为动礼,迷则为达鲤,然则绣雪自恋致矣
8686
>
87-
> 光韵开云,雅于莺茶,停而行之之谓速。是故无悦无谜,无瑞无聪,裳之所走、树之所振也。旧铃之纯水,常为悦水之莹风。人曰:“瑞琴之路,常留于其所允行而不读之处。” 璃非笑而去之者,孰可无鹏。非将选也,非可指也,书非当事涧,仍继叶言,奈何,同森而非航水也,能鸢者益
87+
> 此棋有南涧迷森,悠雨清琴。遥家为鸢兮,宏梦为鹤。或指林写岩,进恋于雨,是语也,鸳极驿安,璃慧空舒。况请瀚者宏,是故无和无后,无安无舒,空之所连、城之所见也。光语筑天,良于璃韵,安铃振灯,局文放花。是故无余无青,无遥无寒,语之所事、琴之所歌也。虽火俊茶长,所以赴雨,其空速也,或弹物任绸,弹楼于声
8888
8989
构造高仿真文言文,**参考《古文观止》《经史百家杂钞》《古文辞类纂》等古代典籍。**
90-
标准 AES256 加密,引入更复杂的组句/语法选择机制,将密码和中国古典文言文相融合。
90+
标准 AES256 加密,引入更复杂的组句、语法匹配机制,将密码和中国古典文言文相融合。
9191

9292
密文高度随机,支持用户自定义随机性和文本风格偏好,打造前所未有的跨文化数字加密方案。
9393

@@ -107,6 +107,7 @@ Abracadabra(魔曰) 是开源,安全,高效的文本加密工具。
107107
- [**pako**](https://github.com/nodeca/pako) GZIP 压缩实现 _©Vitaly Puzrin/Andrei Tuputcyn_, **MIT** License.
108108
- [**js-base64**](https://github.com/dankogai/js-base64) Base64 编码工具实现 _©Dan Kogai_, **BSD-3-Clause** License.
109109
- [**mersenne-twister**](https://github.com/boo1ean/mersenne-twister) 梅森旋转算法实现 _©Makoto Matsumoto/Takuji Nishimura_, **BSD-3-Clause** License.
110+
- [**opencc-js**](https://github.com/nk2028/opencc-js) 简繁体转换实现 _©nk2028_, **MIT** License.
110111

111112
本项目许可证与所有依赖项的许可证兼容。
112113

src/javascript/main.d.ts

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,15 @@ export interface WenyanConfig {
1212
/** 指定输出文本是否为繁体中文,默认 false; */
1313
Traditional?: boolean;
1414
}
15+
16+
export interface CallbackObj {
17+
/** 回调数据的标签 */
18+
Type?: string;
19+
/** 回调数据的值 */
20+
Value?: any;
21+
}
22+
23+
type Callback = (Data: CallbackObj) => any;
1524
export class Abracadabra {
1625
static TEXT: "TEXT";
1726
static UINT8: "UINT8";
@@ -34,15 +43,15 @@ export class Abracadabra {
3443
* @param {string} mode 指定模式,可以是 ENCRYPT DECRYPT 中的一种;
3544
* @param {string} key 指定密钥,默认是 ABRACADABRA;
3645
* @param {WenyanConfig} WenyanConfigObj 文言文的生成配置;
37-
* @param {any}callback 回调函数,获取执行过程中特定位置的结果
46+
* @param {Callback}callback 回调函数,获取执行过程中特定位置的结果数据,调试时使用
3847
* @return {number} 成功则返回 0(失败不会返回,会抛出异常)
3948
*/
4049
WenyanInput(
4150
input: string | Uint8Array,
4251
mode: "ENCRYPT" | "DECRYPT",
4352
key?: string,
4453
WenyanConfigObj?: WenyanConfig,
45-
callback?: any
54+
callback?: Callback
4655
): number;
4756

4857
/**

0 commit comments

Comments
 (0)