宇天 9319bea6da update 2018-07-01 23:59:41 +08:00
LICENSE 更换开源协议为MIT;代码优化;this.crypto改名为this.origin;增加uuid的方法 2018-05-25 00:09:29 +08:00
Readme.md update 2018-05-25 00:12:16 +08:00
index.js update 2018-07-01 23:59:12 +08:00
package.json update 2018-07-01 23:59:41 +08:00

Readme.md

加密工具(Crypto)

本模块是对原生的crypto模块二次封装的,在使用上更加简单方便。

安装

  • 使用npm安装
npm install crypto.js
  • 从github获取
git clone https://github.com/yutent/crypto.js.git

属性

其实就一个属性,即 origin,即为原生的crypto对象,方便在封装的方法中无法满足需求时,可以自行调用原生的crypto实现。

常用API方法

对使用频率非常高的几种加密/编码进行更加简便的封装。

rand(len[, forceNum])

  • len <Number>
  • forceNum <Boolean> 可选

该方法用于生成指定长度的随机字符串[a-z-A-z0-9],参数len即为要生成的字符串长度了; 而forceNum 顾名思义,就是是否强制返回纯数字字符串。

let crypto = require('crypto.js')
crypto.rand(6) // ddjF7d
crypto.rand(16) // 4sf7dJH6tGHDjhdf
crypto.rand(6,  true) // 439875
crypto.rand(10, true) // 3458765234

uuid()

返回一个如下格式的 xxxxxxxx-xxxx-xxxx-xxxxxxxx 的唯一ID

let crypto = require('crypto.js')
crypto.uuid() // 076d029f-4927-ec5f-5b06e35e

md5(str[, encode])

  • str <Number> | <String>
  • encode <String> 可选

这方法,应该没有人不知道是做什么的了,encode是要返回的字符串编码,默认为hex 可选base64 不过有这需求的人可能也许大概...很少吧。

crypto.md5(123456) // e10adc3949ba59abbe56e057f20f883e
crypto.md5('123456') // e10adc3949ba59abbe56e057f20f883e
crypto.md5('hello world') // 5eb63bbbe01eeed093cb22bb8f5acdc3
crypto.md5('hello world', 'base64') // XrY7u+Ae7tCTyyK7j1rNww==

md5Sign(file)

  • file <String>

该方法用于计算文件的md5签名file即为文件的绝对路径。

crypto.md5Sign('xx.jpg')

sha1(str[, encode])

  • str <Number> | <String>
  • encode <String> 可选

这方法也应该没有人不知道是做什么的了,encode是要返回的字符串编码,默认为hex 可选base64 不过有这需求的人可能也许大概...很少吧。

crypto.sha1(123456) // 7c4a8d09ca3762af61e59520943dc26494f8941b
crypto.sha1('123456') // 7c4a8d09ca3762af61e59520943dc26494f8941b
crypto.sha1('hello world') // 2aae6c35c94fcfb415dbe95f408b9ce91ee846ed
crypto.sha1('hello world', 'base64') // Kq5sNclPz7QV2+lfQIuc6R7oRu0=

sha1Sign(file)

  • file <String>

该方法用于计算文件的sha1签名file即为文件的绝对路径。

crypto.sha1Sign('xx.jpg')

sha256(str[, encode])

  • str <Number> | <String>
  • encode <String> 可选

自然这方法,也没啥好说的了。

base64encode(str[, urlFriendly])

  • str <Number> | <String> | <Buffer>
  • urlFriendly <Boolean> 可选

这是用来进行base64编码的本身没啥好说。主要是第2个参数是指编码的结果是否对URL友好默认为否; 如果为true则会把+转成-/转成_ (遵循RFC4648标准)。

crypto.base64encode('hello world') //aGVsbG8gd29ybGQ=

base64decode(str[, urlFriendly])

  • str <String>
  • urlFriendly <Boolean> 可选

与之对应的便是这个base解码了。同样urlFriendly是指要解码的字符串之前是否采用了URL友好处理默认否。

crypto.base64decode('aGVsbG8gd29ybGQ=') //hello world

更强大的API方法

除去上面8个更为常用的方法之外还有很多很多也经常要到的比如AES加密等那此时就可以使用下面这里方法自行配置了。

1. 散列算法

hash(mode, data[, outEncode])

  • mode <String>
  • data <String> | <Buffer>
  • outEncode '' 可选

散列算法(也称为哈希算法),用来实现一些重要数据的模糊处理,以达到隐藏明文的目的。 上面的md5、sha1、sha256等其实就是基于这个再次封装的结果; mode,即算法类型,常用的有 md5, sha1, sha256, sha512等; data 即为要加密的字符串; outEncode是输出的编码类型;

crypto.hash('md5', '123456') //e10adc3949ba59abbe56e057f20f883e

2. HMAC算法

hmac(mode, data[, key][, outEncode])

  • mode <String>
  • data <String> | <Buffer>
  • key <String> 可选
  • outEncode '' 可选

HMAC算法是在散列算法的基础上与一个密钥结合在一起以阻止对签名完整性的破坏。 与上面的散列算法相比,多了一个密钥的参数key;

//a21cf00de4343af1b8b2087af07eb7b9
crypto.hmac('md5', '123456', 'sdfvkjfhd') 

3. 公钥加密

在上面的2种算法中加密都是不可逆的也就是说加密后的字符我们是没办法再还原回去了但是有很多场景需要我们对拿到的加密字符还原到明文状态。 所以出现了公钥加密这种算法; 而Node.js本身给我们提供了4种与公钥加密相关的类Cipher/Decipher、Sign、Verify这里只讲前面2个以及它们衍生出来的Cipheriv/Decipheriv;

cipher(mode, data[, key][, inEncode][, outEncode])

  • mode <String>
  • data <String> | <Buffer>
  • key <String> 可选
  • inEncode '' 可选
  • outEncode '' 可选默认base64

mode为算法类型,常见的有aes-128-cbc、aes-128-gcm等等地,很多,具体有哪些可以通过 this.crypto.getCiphers() 来查看。 其他的参数与上面的HMAC算法相似; inEncode即声明要加密的数据是什么编码的,默认根据要加密的数据进行判断。

//这里给出一个AES-128-CBC的加密例子
// 
crypto.cipher('aes-128-cbc', '123456', 'abcdefg')
//mqA9ZPh9VV+fwKlfpicGVg==

crypto.cipher('aes-128-cbc', '123456', 'abcdefg', 'utf8', 'hex')
//9aa03d64f87d555f9fc0a95fa6270656

decipher(mode, data[, key][, inEncode][, outEncode])

  • mode <String>
  • data <String> | <Buffer>
  • key <String> 可选
  • inEncode '' 可选, 默认是base64
  • outEncode '' 可选默认utf8

这是与上面的cipher对应的解密方法;

// 这里不用指定编码默认即为base64
crypto.decipher('aes-128-cbc', 'mqA9ZPh9VV+fwKlfpicGVg==', 'abcdefg')
// 123456

// 这里一定要指定因为之前加密的时候指定输出为hex所以这里也要指定输入的是hex编码
crypto.decipher('aes-128-cbc', '9aa03d64f87d555f9fc0a95fa6270656', 'abcdefg', 'hex')
//123456

至于另外的cipheriv/decipheriv这2个方法这里就不细讲了和上面的这2个是同样的用法只是要多1个参数向量(iv), 特别要注意的一点是选择128位的加密算法那key的长度就必须是16位256则是32位依此类推; 向量iv是16位,具体的请看相关文档

base on crypto module
JavaScript 100%