Compare commits

...

3 Commits

Author SHA1 Message Date
yutent f26091f81c fixed fs 2024-07-17 12:21:49 +08:00
yutent 54a8feb5ca update 2024-03-11 16:50:44 +08:00
yutent 6740bed15b 更新文档 2024-03-11 16:48:18 +08:00
3 changed files with 22 additions and 29 deletions

View File

@ -252,7 +252,7 @@ crypto.hmac('md5', '123456', 'sdfvkjfhd')
#### cipher(mode, data[, key, inEncode, outEncode]) #### cipher(mode, data[, key, inEncode, outEncode])
- mode `<String>` - mode `<String>`
- data `<String>` | `<Buffer>` - data `<String>` | `<Buffer>`
- key `<String>` 可选, 默认为 `<Buffer d7 2c 87 d0 f0 77 c7 76 6f 29 85 df ab 30 e8 95>`, 即 `crypto.scryptSync('', '', 16)` 的结果 - key `<String>` 可选, 默认为 `<Buffer 0 0 0 ... 0>`, 即 `Buffer.alloc(16)` 的结果
- inEncode '<String>' 可选 - inEncode '<String>' 可选
- outEncode '<String>' 可选默认返回Buffer对象 - outEncode '<String>' 可选默认返回Buffer对象
@ -260,7 +260,7 @@ crypto.hmac('md5', '123456', 'sdfvkjfhd')
> `mode`为算法类型,常见的有`aes-128-cbc、aes-128-gcm`等等地,很多,具体有哪些可以通过 `this.crypto.getCiphers()` 来查看。 > `mode`为算法类型,常见的有`aes-128-cbc、aes-128-gcm`等等地,很多,具体有哪些可以通过 `this.crypto.getCiphers()` 来查看。
> 其他的参数与上面的HMAC算法相似; `inEncode`即声明要加密的数据是什么编码的,默认根据要加密的数据进行判断。 > 其他的参数与上面的HMAC算法相似; `inEncode`即声明要加密的数据是什么编码的,默认根据要加密的数据进行判断。
>> 需要注意的是, 算法类型为`aes-***-gcm`时, 返回的不是一个字符串, 而是一个对象{ enStr, authTag }, 解密时, 需要提供这个 authTag方可解密
```javascript ```javascript
// 这里给出一个AES-128-CBC的加密例子 // 这里给出一个AES-128-CBC的加密例子
@ -271,16 +271,12 @@ crypto.cipher('aes-128-cbc', '123456', 'abcdefg')
crypto.cipher('aes-128-cbc', '123456', 'abcdefg', 'utf8', 'hex') crypto.cipher('aes-128-cbc', '123456', 'abcdefg', 'utf8', 'hex')
// 9aa03d64f87d555f9fc0a95fa6270656 // 9aa03d64f87d555f9fc0a95fa6270656
// 要注意gcm算法的结果
crypto.cipher('aes-128-gcm', '123456', 'abcdefg')
// { enStr: 'qmo1a4Jz',
// authTag: <Buffer c4 a0 3e ab e5 34 a0 ea 25 02 f0 91 06 f7 3b dd>
// }
// v3.x 之后, decipher()同理 // v3.x 之后, decipher()同理
crypto.cipher('aes-128-cbc', '123456', {key}) crypto.cipher('aes-128-cbc', '123456', {key})
// 等价于 // 等价于
crypto.cipheriv('aes-128-cbc', '123456', {key}, EMPTY_IV) // 其中 EMPTY_IV = crypto.scryptSync('', '', 16) crypto.cipheriv('aes-128-cbc', '123456', {key}, EMPTY_IV) // 其中 EMPTY_IV = Buffer.alloc(16)
``` ```
@ -308,14 +304,8 @@ crypto.decipher('aes-128-cbc', '9aa03d64f87d555f9fc0a95fa6270656', 'abcdefg', 'h
// 要注意gcm算法的结果
// authTag: <Buffer c4 a0 3e ab e5 34 a0 ea 25 02 f0 91 06 f7 3b dd>
crypto.decipher('aes-128-gcm', 'qmo1a4Jz', 'abcdefg', authTag)
// 123456
``` ```
> 至于另外的`cipheriv/decipheriv`这2个方法这里就不细讲了和上面的这2个是同样的用法只是要多1个参数`向量(iv)` > 至于另外的`cipheriv/decipheriv`这2个方法这里就不细讲了和上面的这2个是同样的用法只是要多1个参数`向量(iv)`
>> **`特别要注意的一点是选择128位的加密算法那key的长度就必须是16位256则是32位依此类推; 算法类型为gcm时,返回的是对象,解密时需要提供authTag `,具体的请看相关文档** >> **`特别要注意的一点是选择128位的加密算法那key的长度就必须是16位256则是32位依此类推`,具体的请看相关文档**

View File

@ -1,6 +1,6 @@
{ {
"name": "crypto.js", "name": "crypto.js",
"version": "3.2.0", "version": "3.2.2",
"description": "原生crypto加密模块的二次封装,简化常用加密函数的使用", "description": "原生crypto加密模块的二次封装,简化常用加密函数的使用",
"keywords": [ "keywords": [
"md5", "md5",

View File

@ -27,7 +27,7 @@ const MAC = (function (ns) {
return Math.random().toString(16).slice(-4) return Math.random().toString(16).slice(-4)
})(os.networkInterfaces()) })(os.networkInterfaces())
var __inc__ = 4096 let __inc__ = 4096
/** /**
* [base64encode base64编码] * [base64encode base64编码]
@ -35,7 +35,7 @@ var __inc__ = 4096
* @param {bool} urlFriendly [是否对URL友好, 默认否, 是则会把+转成-, /_] * @param {bool} urlFriendly [是否对URL友好, 默认否, 是则会把+转成-, /_]
*/ */
export function base64encode(str, urlFriendly) { export function base64encode(str, urlFriendly) {
var buf, str64 let buf, str64
if (Buffer.isBuffer(str)) { if (Buffer.isBuffer(str)) {
buf = str buf = str
@ -86,8 +86,8 @@ export function rand(len, forceNum) {
// 返回一个如下格式的 xxxxxxxx-xxxx-xxxx-xxxxxxxx 的唯一ID // 返回一个如下格式的 xxxxxxxx-xxxx-xxxx-xxxxxxxx 的唯一ID
export function uuid(pipe = '-') { export function uuid(pipe = '-') {
var str = crypto.randomUUID() let str = crypto.randomUUID()
var now = (~~(Date.now() / 1000)).toString(16) let now = (~~(Date.now() / 1000)).toString(16)
if (__inc__ > 65535) { if (__inc__ > 65535) {
__inc__ = 4096 __inc__ = 4096
@ -121,11 +121,12 @@ export function md5(str, encode) {
* @param {Str} file [文件路径] * @param {Str} file [文件路径]
*/ */
export function md5Sign(file) { export function md5Sign(file) {
if (fs.accessSync(file, fs.constants.R_OK)) { try {
var buf = fs.readFileSync(file) let buf = fs.readFileSync(file)
return hash('md5', buf) return hash('md5', buf)
} catch (e) {
return null
} }
return null
} }
/** /**
@ -149,11 +150,12 @@ export function sha1(str, encode) {
* @param {Str} file [文件路径] * @param {Str} file [文件路径]
*/ */
export function sha1Sign(file) { export function sha1Sign(file) {
if (fs.accessSync(file, fs.constants.R_OK)) { try {
var buf = fs.readFileSync(file) let buf = fs.readFileSync(file)
return hash('sha1', buf) return hash('sha1', buf)
} catch (e) {
return null
} }
return null
} }
/** /**
@ -177,11 +179,12 @@ export function sha256(str, encoding) {
* @param {Str} file [文件路径] * @param {Str} file [文件路径]
*/ */
export function sha256Sign(file) { export function sha256Sign(file) {
if (fs.accessSync(file, fs.constants.R_OK)) { try {
var buf = fs.readFileSync(file) let buf = fs.readFileSync(file)
return hash('sha256', buf) return hash('sha256', buf)
} catch (e) {
return null
} }
return null
} }
export { export {