Decentralized Online Identity Proofs library in Node/JavaScript
Find a file
2022-08-16 21:34:11 +02:00
.husky Replace prettier with standard, add husky 2021-07-09 23:47:48 +02:00
dist Release 0.15.7 2022-08-04 10:45:45 +02:00
docker/proxy Improve docker builds 2021-11-06 18:48:53 +01:00
examples Improve examples 2022-02-08 18:48:57 +01:00
src Merge pull request 'Add Stack Exchange service provider' (#23) from cherryblossom/doipjs:stack-exchange into main 2022-08-16 21:34:11 +02:00
static Add jsdoc documentation 2021-04-22 15:14:21 +02:00
test Add doip.keys.fetch 2022-03-27 23:04:16 +02:00
.drone.yml Fix drone config 2022-02-25 22:12:07 +01:00
.editorconfig Add editorconfig 2021-03-25 13:19:54 +01:00
.gitignore Ignore docs 2021-04-20 16:42:58 +02:00
.licenseignore Revert to drone CI 2022-02-25 21:09:48 +01:00
CHANGELOG.md Fix CHANGELOG 2022-08-04 10:42:05 +02:00
jsdoc-lib.json Replace prettier with standard, add husky 2021-07-09 23:47:48 +02:00
LICENSE Update year 2021-01-13 13:20:33 +01:00
license-checker-config.json Add regex to license check 2022-02-25 11:07:17 +01:00
LICENSE.HEADER Add regex to license check 2022-02-25 11:07:17 +01:00
package.json Release 0.15.7 2022-08-04 10:45:45 +02:00
README.md Fix typo 2021-04-22 15:56:30 +02:00
yarn.lock Update dependencies 2022-03-22 13:42:07 +01:00

doip.js

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

Source code available at codeberg.org.

Documentation available at js.doip.rocks.

Features

  • Verify online identities using decentralized technology
  • Based on OpenPGP, a widely-used cryptographic standard
  • Regex-based service provider detection
  • Mocha tests

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 works and will verify the doip.rocks domain as bidirectionally linked to Yarmo's cryptographic key.

About Keyoxide

Keyoxide, made by Yarmo Mackenbach, is a modern, secure and privacy-friendly platform to establish decentralized online identities using a novel concept know as DOIP. In an effort to make this technology accessible for other projects and stimulate the emergence of both complementary and competing projects, this project-agnostic library is published on codeberg.org and open sourced under the Apache-2.0 license.

Community

There's a Keyoxide Matrix room where we discuss everything DOIP and Keyoxide.

Donate

Please consider donating if you think this project is a step in the right direction for the internet.

Funding

This library was realized with funding from NLnet.