0xauth

v0.0.6

A javascript library for the 0xAuth protocol

NPM

README

GitHub

Website

MIT

Latest version published 2 years ago

    npm install 0xauth

We couldn't find any similar packages Browse all packages

Package Health Score

38 / 100

Popularity
Limited
Maintenance
Inactive
Security
Security review needed
Community
Limited

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Limited

Weekly Downloads (5)

Dependents: 0
GitHub Stars: 0
Forks: 0
Contributors: 2

The npm package 0xauth receives a total of 5 downloads a week. As such, we scored 0xauth popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package 0xauth, we found that it has been starred ? times, and that 0 other projects on the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Security

Security review needed

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

0.0.6

Indirect Vulnerabilities

0.0.6

License Risks

0.0.6

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security Policy: No

Snyk detected that the latest version of 0xauth has a security vulnerability.

We highly advise you to review these security issues.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

We found a way for you to contribute to the project! Looks like 0xauth is missing a security policy.

    # Install the Snyk CLI and test your project
npm i snyk && snyk test 0xauth

Fix it in your project with Snyk!

Maintenance

Inactive

Commit Frequency

Open Issues: 0
Merged PR: 15
Open PR: 2
Last Commit: 7 months ago

Further analysis of the maintenance status of 0xauth based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for 0xauth is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 2
Funding: No
License: MIT

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like 0xauth is missing a Code of Conduct.

Embed Package Health Score Badge

Package

Node.js Compatibility: >=8.10.0

Age: 2 years
Dependencies: 6 Direct / 578 Total
Versions: 7
Install Size: 81.6 kB
Dist-tags: 1
# of Files: 30
Maintainers: 1
TS Typings: No

We detected a total of 578 direct & transitive dependencies for 0xauth. See the full dependency tree of 0xauth

0xauth has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

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.

Credits

Francesco Sullo

License

The MIT License

0xauth versions

Dist-Tags for 0xauth

latest

Version	Published	Tag	Node.js Compatability	Licenses	Dependencies	Direct Vulnerabilities	Publisher
0.0.6	16 June 2019	latest	>=8.10.0	MIT	6	0 H 0 M 0 L	sullof
All Versions

Last updated on 17 January-2021, at 03:07 (UTC).

0xauth

A javascript library for the 0xAuth protocol

Package Health Score

Popularity

Security

Security and license risk for significant versions

Version

Release Date

Direct Vulnerabilities

Indirect Vulnerabilities

License Risks

Maintenance

Community

Embed Package Health Score Badge

Package

0xauth-js

ALPHA DEVELOPMENT, NOT READY YET FOR REAL WORLD USES

Install

Usage

Server API

Auth.getAuthorizationToken(params)

Auth.signAndReturnToken(authTokenString, chain, privateKey, format = 'ps')

Auth.verifySignedToken(signedTokenString)

Credits

License

0xauth versions

0xauth dependencies