@jccdex/cwt-lib
v1.0.2
Published
chain web token
Downloads
14
Readme
cwt-lib (chain-web-token)
用于区块链身份认证的js库;
js library for blockchain identity authentication;
使用区块链的私钥对数据结构({header: ... , payload: ...})进行签名,生成cwt;
Using the private key data structure of the blockchain ({header:... , payload: ... }) sign and generate cwt;
使用区块链的公钥对cwt进行验证,证明其身份;
Verify the cwt using the blockchain's public key to prove its identity;
Synopsis
chain web token (缩写cwt)
是有三部分组成 header.payload.Signature
,其中的 Signature
是对 header.payload
进行签名。chain web token (abbreviated cwt)
is composed of three partsheader.payload.Signature
, where Signature
is the signature of header.payload
.
目前支持ethereum、ripple、bitcoin、jingtum。
Currently support ethereum, ripple, bitcoin, jingtum.
Install
npm install @jccdex/cwt-lib
CDN
ChainWebToken
as a global variable. Size is 135k.
<script src="https://unpkg.com/@jccdex/cwt-lib/dist/cwt-lib.min.js"></script>
Table of Contents
API
sign
import { sign } form "@jccdex/cwt-lib"
const cwt = sign({
chain: "",
privateKey: "",
usr: "",
time: "",
alg: ""
});
// Result example:
// eyJhbGciOiJzZWNwMjU2azEiLCJ4NWMiOlsiLS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS1cbk1GWXdFQVlIS29aSXpqMENBUVlGSzRFRUFBb0RRZ0FFTVRxOXVhdENOQVhXSFV2U2tPYm0wOTd0cDFJVVAyZVJcbjFyKzU4T3ljNHoyeTNaSFBobFN3K01JUTBHczRkSVZDcHFiMmJjcE9aTkpvUEY5TzYxSEJiQT09XG4tLS0tLUVORCBQVUJMSUMgS0VZLS0tLS0iXSwidHlwZSI6IkNXVCIsImNoYWluIjoiamluZ3R1bSJ9.eyJ1c3IiOiJqaW5ndHVtX3NlY3AyNTZrMSIsInRpbWUiOjEyMzQ1Nn0.MEUCIH546Iz3wqdTgTLHJg3czMbQqLVJHj9iddqXPIr6MnG9AiEAkvKelTLl-ZWvCNJ9O8rWHhksuggz_jgg8wEM44mf9xk
// cwt decode:
// {
// header: {
// alg: 'secp256k1',
// x5c: [
// '-----BEGIN PUBLIC KEY-----\n' +
// 'MFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEMTq9uatCNAXWHUvSkObm097tp1IUP2eR\n' +
// '1r+58Oyc4z2y3ZHPhlSw+MIQ0Gs4dIVCpqb2bcpOZNJoPF9O61HBbA==\n' +
// '-----END PUBLIC KEY-----'
// ],// Public key in pem format
// type: 'CWT',
// chain: 'jingtum'
// },
// payload: { usr: '...usr...', time: Timestamp(unit:s) },
// signature: 'MEUCIH546Iz3wqdTgTLHJg3czMbQqLVJHj9iddqXPIr6MnG9AiEAkvKelTLl-ZWvCNJ9O8rWHhksuggz_jgg8wEM44mf9xk'
// }
arguments
chain: Support chain
privateKey: Private key or secret
usr: User name
time: Timestamp unit:s
Non-essential
If you want to generate cwt for a specific time, please do not ignore it, otherwise is current time.
alg: Algorithm Non-essential
If the private key is ripple or jingtum chain, length is 64 and algorithm is ed25519
, alg is ed25519
.