0xauth 中文文档教程
0xauth-js
0xAuth 协议的 javascript 库
ALPHA DEVELOPMENT, NOT READY YET FOR REAL WORLD USES
Install
服务器端：
npm i --save 0xauth
客户端：
npm i 0xauth
cp node_modules/0xauth/dist/0xauth.js your/dest/folder/.
Usage
服务器端：
const 0xauth = require('0xauth')
const Auth = 0xauth.Auth
const authToken = new 0xauth.AuthToken({...})
...
客户端：
var client = new 0xauth.client()
client.init('trx', tronWeb)
// and/or
client.init('eth', web3)
...
Server API
Auth.getAuthorizationToken(params)
参数：
issuer The RDNS of the app/service issuing the token
expireAt (optional) The Linux timestamp at expiration
extraParams Extra-parametes related with the app
用于测试目的，您还可以传递：
createdAt The Linux timestamp of creation
randomString A 4 chars base64 string
而在正常情况下会生成这两个值。
示例：
const aWeekFromNow = Math.floor((Date.now() + 7 * 24 * 3600 * 1000) / 1000)
Auth.getAuthorizationToken({
issuer: 'com.example.auth',
expireAt: aWeekFromNow,
extraParams: 'uid/233,active'
})
这将返回如下内容：
0xAuth:1;com.example.auth;1559439788:1560044588;e3Jg;uid/233,active;de
Auth.signAndReturnToken(authTokenString, chain, privateKey, format = 'ps')
authTokenString 是要以字符串格式签名的身份验证令牌 chain 是支持的区块链之一的缩写，例如 eth 或 trx privateKey 是用于签名的私钥 format 是签名格式（更多信息在 0xAuth 协议）
Auth.verifySignedToken(signedTokenString)
signedTokenString 是包含验证所需的所有信息的签名令牌。
History
0.1.0
- updating Web3 and Tronweb
0.0.6
- first complete version
Credits
License
版权所有 (c) 2019弗朗切斯科苏洛 francesco@sullo.co
0xauth-js
A javascript library for the 0xAuth protocol
ALPHA DEVELOPMENT, NOT READY YET FOR REAL WORLD USES
Implementation of the 0xAuth protocol
Install
Server sidee:
npm i --save 0xauth
Client side:
npm i 0xauth
cp node_modules/0xauth/dist/0xauth.js your/dest/folder/.
Usage
Server side:
const 0xauth = require('0xauth')
const Auth = 0xauth.Auth
const authToken = new 0xauth.AuthToken({...})
...
Client side:
var client = new 0xauth.client()
client.init('trx', tronWeb)
// and/or
client.init('eth', web3)
...
Server API
Auth.getAuthorizationToken(params)
Params:
issuer The RDNS of the app/service issuing the token
expireAt (optional) The Linux timestamp at expiration
extraParams Extra-parametes related with the app
For testing purposes, you can also pass:
createdAt The Linux timestamp of creation
randomString A 4 chars base64 string
while in a normal case those two values are generated.
Example:
const aWeekFromNow = Math.floor((Date.now() + 7 * 24 * 3600 * 1000) / 1000)
Auth.getAuthorizationToken({
issuer: 'com.example.auth',
expireAt: aWeekFromNow,
extraParams: 'uid/233,active'
})
That would return something like:
0xAuth:1;com.example.auth;1559439788:1560044588;e3Jg;uid/233,active;de
Auth.signAndReturnToken(authTokenString, chain, privateKey, format = 'ps')
authTokenString is the auth token to be signed in string format chain is the abbreviation of one of the supported blockchains, for example eth or trx privateKey is the private key to be used for the signature format is the signature format (more info at 0xAuth protocol)
Auth.verifySignedToken(signedTokenString)
signedTokenString is a signed token containing all the info necessary for the verification.
History
0.1.0
- updating Web3 and Tronweb
0.0.6
- first complete version
Credits
License
Copyright (c) 2019 Francesco Sullo francesco@sullo.co
