doip.js

status-badge License Mastodon Follow Open Collective backers and sponsors

doip.js allows websites and Node.js projects to verify decentralized online identities.

Documentation available at js.doip.rocks.

Installation (node)

Install using yarn or npm:

yarn add doipjs
# or
npm install --save doipjs

Import the doip module in your code:

const doip = require('./doipjs')

Installation (browser)

Include the following HTML snippet (requires openpgp.js):

<script src="/static/openpgp.min.js"></script>
<script src="/static/doip.min.js"></script>

Quickstart

Run the following javascript:

const verifyIdentity = async (url, fp) => {
 const claim = new doip.Claim(url, fp)
 claim.match()
 await claim.verify()
 console.log(claim.result)
}
verifyIdentity('dns:doip.rocks', '9f0048ac0b23301e1f77e994909f6bd6f80f485d')

This snippet verifies the doip.rocks domain as bidirectionally linked to Yarmo's cryptographic key.

Contributing

Anyone can contribute!

Developers are invited to:

• fork the repository and play around
• submit PRs to implement new features or fix bugs

If you are new to contributing to open source software, we'd love to help you! To get started, here's a list of "good first issues" that you could look into.

Everyone is invited to:

• find and report bugs
• suggesting new features
• help with translations
• improve documentation
• start using open source software and promote it

Please note that this project has a Code of Conduct that all contributors agree to abide when participating.

About the Keyoxide project

The Keyoxide project strives for a healthier internet for all and has made its efforts fully open source. Our community is open and welcoming, feel free to say hi!

Funding for the project comes from the NLnet foundation, NGI0 and the people supporting our OpenCollective. The project is grateful for all your support.