@staryea/network-crypt
TypeScript icon, indicating that this package has built-in type declarations

0.1.0 • Public • Published

gm-crypt-nodejs

JavaScript Style GuideLicense: MIT

基于javascriptTypedArray的国密加密算法实现。

Implement of Chinese encrypt algorithm in JavaScript and TypedArray.

为了兼容浏览器环境和 node.je 环境,这里我们使用了TextEncoderBase64.js

Here we use TextEncoder and Base64.js for both browser and node.js environment.

由于使用了TextEncoder,所以暂时不支持Edge。Node.js 版本最低为 8,建议使用最新的 LTS 版本。

Because of using TextEncoder, this code cannot run in Edge browser. Node.js‘s version should at least be 8, and the newest LTS version is recommended.

Roadmap

  • [x] SM4
  • [ ] SM3
  • [ ] SM2

Documentation

Install

npm install gm-crypt

SM4

Init

const SM4 = require('gm-crypt').sm4;

let sm4Config = {
    // encrypt/decypt main key; cannot be omitted
    key: 'JeF8U9wHFOMfs2Y8',

    // optional; can be 'cbc' or 'ecb'
    mode: 'cbc', // default

    // optional; when use cbc mode, it's necessary
    iv: 'UISwD9fW6cFh9SNS', // default is null

    // optional: this is the cipher data's type; Can be 'base64' or 'text'
    cipherType: 'base64' // default is base64
};

let sm4 = new SM4(sm4Config);

Encrypt

let plaintext = '中国国密加解密算法';
let ciphertext = sm4.encrypt(plaintext);
// ciphertext's result is 'j/+HgSpv8RZQI2YtSq0L1RnemiSokMm1VvLHSTt245U='

Decrypt

let ciphertext = 'j/+HgSpv8RZQI2YtSq0L1RnemiSokMm1VvLHSTt245U=';
let plaintext = sm4.decrypt(ciphertext);
// plaintext's result is '中国国密加解密算法'

License

MIT

Readme

Keywords

Package Sidebar

Install

npm i @staryea/network-crypt

Weekly Downloads

14

Version

0.1.0

License

ISC

Unpacked Size

28.4 kB

Total Files

7

Last publish

Collaborators

  • staryea-jiangwy