70 lines
2.1 KiB
Markdown
70 lines
2.1 KiB
Markdown
# tic.crypto
|
||
|
||
时光链密码学工具库：时光链专用的密码学工具库，用来处理哈希、加解密、签名、助记词、等等。
|
||
|
||
## Table of Contents
|
||
|
||
1. [Installation Guide](#1-installation-guide)
|
||
2. [Usage](#2-usage)
|
||
3. [API Specification](#3-api-specification)
|
||
4. [References](#4-references)
|
||
|
||
## 1. Installation Guide
|
||
|
||
在前后端软件的 package.json 的依赖清单中引入本库：
|
||
```
|
||
npm install git+https://git.faronear.org/tic/tic.action#RELEASE_OR_BRANCH --save
|
||
```
|
||
|
||
## 2. Usage
|
||
|
||
基本用法示例：
|
||
```
|
||
let ticCrypto=require('tic.crypto') // 引用
|
||
let sw=ticCrypto.randomSecword() // 生成一个随机的助记词（即密语）。或者使用现成的密语。
|
||
let kp=ticCrypto.secword2keypair(sw) // 把密语转换成公私钥
|
||
let address=ticCrypto.secword2address(sw) // 把密语转换成地址
|
||
```
|
||
|
||
## 3. API Specification
|
||
|
||
|函数名|参数|说明
|
||
|-|-|-|
|
||
|hash|(data, option={hasher:'sha256', salt, input:'utf8', output:'hex'})|哈希算法。给input(=utf8|latin1|ascii)格式的输入data加salt后，根据hasher(=sha256|md5|sha1|sha512|ripemd160)，输出output(=hex|latin1|base64|buf)格式的哈希值。|
|
||
|isHashable|(data)||
|
||
|isHash|||
|
||
|encrypt|(data, pwd, option={ cipher:'aes-256-cfb', input:'utf8', output:'hex' })||
|
||
|decrypt|(data, pwd, option={ cipher:'aes-256-cfb', input:'hex', output:'utf8' })||
|
||
|sign|(data, seckey, option)||
|
||
|isSignature|||
|
||
|verify|(data, signature, pubkey, option)||
|
||
|pass2keypair|||
|
||
|secword2keypair||密语到公私钥 { pubkey, seckey }|
|
||
|seckey2pubkey|||
|
||
|secword2account||密语到账户 { address, pubkey, seckey }|
|
||
|secword2address||密语到地址 address|
|
||
|isSecword|||
|
||
|isSeckey|||
|
||
|isPubkey|||
|
||
|isAddress|||
|
||
|pubkey2address|||
|
||
|secword2seed|||
|
||
|randomSecword|(lang)|lang=[ 'CHINESE', 'ENGLISH', 'FRENCH', 'ITALIAN', 'JAPANESE', 'SPANISH' ]
|
||
|randomSeckey|||
|
||
|randomKeypair|||
|
||
|randomString|||
|
||
|randomNumber|||
|
||
|randomUuid: { [Function: v4] v1|||
|
||
|getMerkleRoot|||
|
||
|distanceSig|||
|
||
|compareSig|||
|
||
|sortSigList|||
|
||
|getString2Sign|||
|
||
|rsaSign|||
|
||
|rsaVerify|||
|
||
---
|
||
|
||
## 4. References
|
||
|
||
+ 返回根文档: <https://git.faronear.org/tic/_tic/>
|