mirror of
https://codeberg.org/keyoxide/doipjs.git
synced 2024-12-22 22:49:28 -07:00
WIP Add docs
This commit is contained in:
Yarmo Mackenbach
parent
bea7679255
commit
3d8aa73456
10 changed files with 224 additions and 0 deletions
29
docs/README.md
Normal file
29
docs/README.md
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
# doip.js
|
||||
|
||||
doip.js allows browsers and Node.js projects to verify decentralized online identities based on OpenPGP.
|
||||
|
||||
## Features
|
||||
|
||||
- Verify online identities using profile URLs
|
||||
- Regex-based service provider detection
|
||||
- [Mocha](https://mochajs.org/) tests
|
||||
|
||||
## Todo
|
||||
|
||||
- Fetch keys using key servers and WKD
|
||||
|
||||
## About Keyoxide
|
||||
|
||||
[Keyoxide](https://keyoxide.org/), made by Yarmo Mackenbach, is a modern, secure and privacy-friendly platform to establish decentralized online identities using a novel concept know as [DOIP](doip.md). 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](https://codeberg.org/keyoxide/doipjs) and open sourced under the [Apache-2.0](https://codeberg.org/keyoxide/doipjs/src/branch/main/LICENSE) license.
|
||||
|
||||
## Community
|
||||
|
||||
There's a [Keyoxide Matrix room](https://matrix.to/#/#keyoxide:matrix.org) where we discuss everything DOIP and Keyoxide.
|
||||
|
||||
## Donate
|
||||
|
||||
Please consider [donating](https://liberapay.com/Keyoxide/) if you think this project is a step in the right direction for the internet.
|
||||
|
||||
## Funding
|
||||
|
||||
This library was realized with funding from [NLnet](https://nlnet.nl/project/Keyoxide/).
|
||||
8
docs/_coverpage.md
Normal file
8
docs/_coverpage.md
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
# doip.js <small>0.3.0</small>
|
||||
|
||||
Decentralized OpenPGP Identity Proofs library in Node.js
|
||||
|
||||
[Source code](https://codeberg.org/keyoxide/doipjs)
|
||||
[Getting started](#doipjs)
|
||||
|
||||
|
||||
20
docs/_sidebar.md
Normal file
20
docs/_sidebar.md
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
- Getting started
|
||||
- [Quick start](quickstart.md)
|
||||
- [Configuration](configuration.md)
|
||||
|
||||
- Reference
|
||||
- API
|
||||
- [Service provider data object](serviceproviderdataobject.md)
|
||||
|
||||
- Concepts
|
||||
- [DOIP](doip.md)
|
||||
- [Cryptographic keys](#)
|
||||
- [Proofs](#)
|
||||
- [Claims](#)
|
||||
- [Service providers](#)
|
||||
|
||||
- Service providers
|
||||
- [Liberapay](serviceproviders/liberapay.md)
|
||||
|
||||
- More
|
||||
- [Changelog](changelog.md)
|
||||
22
docs/changelog.md
Normal file
22
docs/changelog.md
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
# Changelog
|
||||
|
||||
## 0.3.0
|
||||
|
||||
[2020-11-04](https://codeberg.org/keyoxide/doipjs/releases/tag/0.3.0)
|
||||
|
||||
### Added
|
||||
- Liberapay service provider
|
||||
- Proxy request handler
|
||||
|
||||
### Changed
|
||||
- Improve handling of arrays in JSON
|
||||
- Customizable proxy hostname
|
||||
|
||||
### Fixed
|
||||
- Dots in URL regex
|
||||
|
||||
## 0.2.0
|
||||
|
||||
[2020-11-03](https://codeberg.org/keyoxide/doipjs/releases/tag/0.2.0)
|
||||
|
||||
Initial release
|
||||
1
docs/doip.md
Normal file
1
docs/doip.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
# Decentralized OpenPGP Identity Proofs
|
||||
28
docs/index.html
Normal file
28
docs/index.html
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>doip.js</title>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
|
||||
<meta name="description" content="doip.js documentation, Node.js library for Decentralized OpenPGP Identity Proofs">
|
||||
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
|
||||
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
|
||||
</head>
|
||||
<body>
|
||||
<div id="app"></div>
|
||||
<script>
|
||||
window.$docsify = {
|
||||
name: 'doip.js',
|
||||
themeColor: '#8C76F2',
|
||||
coverpage: true,
|
||||
loadSidebar: true,
|
||||
maxLevel: 4,
|
||||
subMaxLevel: 2,
|
||||
}
|
||||
</script>
|
||||
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
|
||||
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/external-script.min.js"></script>
|
||||
<script src="//cdn.jsdelivr.net/npm/docsify-copy-code"></script>
|
||||
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
47
docs/quickstart.md
Normal file
47
docs/quickstart.md
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
# Quick start
|
||||
|
||||
## Installation
|
||||
|
||||
Install using **Yarn**:
|
||||
|
||||
```bash
|
||||
yarn add doipjs
|
||||
```
|
||||
|
||||
Install using **NPM**:
|
||||
|
||||
```bash
|
||||
npm install --save doipjs
|
||||
```
|
||||
|
||||
## Usage (Node.js)
|
||||
|
||||
Basic example:
|
||||
|
||||
```javascript
|
||||
const doip = require('doip')
|
||||
|
||||
const verifyIdentity = async (url, fp) => {
|
||||
console.log(await doip.verify(url, fp))
|
||||
}
|
||||
verifyIdentity('dns:doip.rocks', '9f0048ac0b23301e1f77e994909f6bd6f80f485d')
|
||||
```
|
||||
|
||||
This snippet works en will verify the [doip.rocks](https://doip.rocks) as
|
||||
linked to Yarmo's cryptographic key using the [dns](serviceproviders/dns.md)
|
||||
service provider.
|
||||
|
||||
## Usage (browser)
|
||||
|
||||
Basic example:
|
||||
|
||||
```html
|
||||
<script src="https://cdn.jsdelivr.net/npm/keyoxide@0.3.0/dist/doip.min.js"></script>
|
||||
```
|
||||
|
||||
```javascript
|
||||
const verifyIdentity = async (url, fp) => {
|
||||
console.log(await doip.verify(url, fp))
|
||||
}
|
||||
verifyIdentity('dns:doip.rocks', '9f0048ac0b23301e1f77e994909f6bd6f80f485d')
|
||||
```
|
||||
67
docs/serviceproviderdataobject.md
Normal file
67
docs/serviceproviderdataobject.md
Normal file
|
|
@ -0,0 +1,67 @@
|
|||
# Service provider data object
|
||||
|
||||
The object returned by any service provider has the following layout:
|
||||
|
||||
```
|
||||
serviceprovider
|
||||
type string: the service provider's type [web, communication]
|
||||
name string: the service provider's name
|
||||
profile
|
||||
display string: the profile's identifier for display
|
||||
uri string: the profile's URI
|
||||
proof
|
||||
uri string: the URI containing the proof to be by humans and machines
|
||||
fetch string: an alternative URI that should be used by machines
|
||||
useProxy boolean: should the request be sent using a proxy
|
||||
format string: [json, text]
|
||||
claim
|
||||
fingerprint string: the fingerprint that verifies the claim if found in the proof
|
||||
format string: how is the fingerprint formatted [uri, message, fingerprint]
|
||||
path array: the path to the claim inside the proof JSON
|
||||
relation string: how the claim format relates to the proof format [contains, equals, oneOf]
|
||||
qr string: a URI to be displayed as QR code if the claim is verified
|
||||
customRequestHandler function: handles the request if the default request handler does not suffice; optional
|
||||
```
|
||||
|
||||
## serviceprovider.type
|
||||
|
||||
```
|
||||
Type: string
|
||||
Values: web, communication
|
||||
Mandatory: true
|
||||
```
|
||||
|
||||
Currently, only two types of service providers are supported:
|
||||
- `web`: traditional website platforms
|
||||
- `communication`: platforms for interpersonal communication
|
||||
|
||||
## serviceprovider.name
|
||||
|
||||
```
|
||||
Type: string
|
||||
Values: *
|
||||
Mandatory: true
|
||||
```
|
||||
|
||||
The name of the service provider (or protocol): `dns`, `xmpp`, `gitea`, `fediverse`, etc.
|
||||
|
||||
## profile.display
|
||||
|
||||
```
|
||||
Type: string
|
||||
Values: *
|
||||
Mandatory: true
|
||||
```
|
||||
|
||||
The account's name to display
|
||||
|
||||
## proof.fetch
|
||||
|
||||
Sometimes, the URI used by humans to verify a claim is inadequate for use by machines. This is needed when the JSON is served by a different endpoint. In this case, machines will use a different URI than the one shown to humans.
|
||||
|
||||
## claim.format
|
||||
|
||||
There are three claim formats:
|
||||
- uri: the claim is formulated as `openpgp4fpr:FINGEPRPRINT`
|
||||
- message: the claim is formulated as `[Verifying my OpenPGP key: openpgp4fpr:FINGEPRPRINT]`
|
||||
- fingerprint: the claim is formulated as `FINGEPRPRINT`
|
||||
1
docs/serviceproviders/liberapay.md
Normal file
1
docs/serviceproviders/liberapay.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
# Liberapay
|
||||
|
|
@ -23,6 +23,7 @@
|
|||
"license:check": "./node_modules/license-check-and-add/dist/src/cli.js check",
|
||||
"license:add": "./node_modules/license-check-and-add/dist/src/cli.js add",
|
||||
"license:remove": "./node_modules/license-check-and-add/dist/src/cli.js remove",
|
||||
"docs": "docsify serve ./docs",
|
||||
"test": "./node_modules/mocha/bin/mocha"
|
||||
},
|
||||
"repository": {
|
||||
|
|
|
|||
Loading…
Reference in a new issue