forked from Mirrors/doipjs
Run prettier on docs
This commit is contained in:
Yarmo Mackenbach
parent
52227e5cee
commit
1a2c6b7b84
7 changed files with 63 additions and 39 deletions
|
|
@ -1,20 +1,24 @@
|
|||
- Getting started
|
||||
|
||||
- [Installation](installation.md)
|
||||
- [Quick start (Node.js)](quickstart-nodejs.md)
|
||||
- [Quick start (browser)](quickstart-browser.md)
|
||||
- [Terminology](terminology.md)
|
||||
|
||||
- Reference
|
||||
|
||||
- [API](api.md)
|
||||
- [Service provider data object](serviceproviderdataobject.md)
|
||||
|
||||
- Concepts
|
||||
|
||||
- [DOIP](doip.md)
|
||||
- [Proofs](proofs.md)
|
||||
- [Claims](claims.md)
|
||||
- [Service providers](serviceproviders.md)
|
||||
|
||||
- Service providers
|
||||
|
||||
- [dev.to](serviceproviders/devto.md)
|
||||
- [discourse](serviceproviders/discourse.md)
|
||||
- [dns](serviceproviders/dns.md)
|
||||
|
|
|
|||
|
|
@ -2,14 +2,14 @@
|
|||
|
||||
## verify
|
||||
|
||||
*(async)* doip.verify(uri, [fingerprint], [opts])
|
||||
_(async)_ doip.verify(uri, [fingerprint], [opts])
|
||||
|
||||
Verifies the identity behind the provided **uri** using the **fingerprint**.
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Mandatory | Description |
|
||||
|-------------|--------|-----------|----------------------------------|
|
||||
| ----------- | ------ | --------- | -------------------------------- |
|
||||
| uri | string | true | the URI to an identity to verify |
|
||||
| fingerprint | string | false | the fingerprint of the claim |
|
||||
| opts | object | false | options (see below) |
|
||||
|
|
@ -17,7 +17,7 @@ Verifies the identity behind the provided **uri** using the **fingerprint**.
|
|||
**Options**
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|-------------------|---------|----------------------|---------------------------------------------------------------------|
|
||||
| ----------------- | ------- | -------------------- | ------------------------------------------------------------------- |
|
||||
| returnMatchesOnly | boolean | false | only return matching service providers, do not attempt verification |
|
||||
| proxyPolicy | string | 'adaptive' | when to use a proxy ['adaptive', 'always', 'never'] |
|
||||
| doipProxyHostname | string | 'proxy.keyoxide.org' | the hostname of the proxy server |
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@
|
|||
[2020-11-06](https://codeberg.org/keyoxide/doipjs/releases/tag/0.4.2)
|
||||
|
||||
### Changed
|
||||
|
||||
- URLs in package.json
|
||||
|
||||
## 0.4.1
|
||||
|
|
@ -12,6 +13,7 @@
|
|||
[2020-11-06](https://codeberg.org/keyoxide/doipjs/releases/tag/0.4.1)
|
||||
|
||||
### Changed
|
||||
|
||||
- Update README
|
||||
- Add image to coverpage
|
||||
|
||||
|
|
@ -20,17 +22,21 @@
|
|||
[2020-11-06](https://codeberg.org/keyoxide/doipjs/releases/tag/0.4.0)
|
||||
|
||||
### Added
|
||||
|
||||
- Custom request handler for DNS service provider
|
||||
- Docs
|
||||
|
||||
### Changed
|
||||
|
||||
- Service provider data structure
|
||||
- More consistent handling of options
|
||||
|
||||
### Removed
|
||||
|
||||
- dotenv dependency
|
||||
|
||||
### Fixed
|
||||
|
||||
- Crash for unexpected JSON data structure
|
||||
- Body in http requests
|
||||
|
||||
|
|
@ -39,14 +45,17 @@
|
|||
[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
|
||||
|
|
|
|||
|
|
@ -73,12 +73,12 @@ verification of DOIPs. Please refer to the [list of supported service providers]
|
|||
The endgame of using DOIP is to add at least two profile. Proving that you own
|
||||
a single profile—in a way—doesn't prove anything. The issue is that
|
||||
we cannot prove that **you**, the physical being **you**, holds that key. DOIP
|
||||
can only verify that "*whoever holds that key also holds that profile*".
|
||||
can only verify that "_whoever holds that key also holds that profile_".
|
||||
|
||||
By adding at least two profiles, you can create meaningful links between those
|
||||
profiles. If someone knows **you**, the physical being **you**, is **Alice** on
|
||||
website A, they will also now know that you are **Alice123** on website B,
|
||||
simply because "*whoever holds that key also holds both of those profiles*".
|
||||
simply because "_whoever holds that key also holds both of those profiles_".
|
||||
|
||||
## Why the snail logo?
|
||||
|
||||
|
|
|
|||
|
|
@ -1,14 +1,23 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<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>
|
||||
<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 = {
|
||||
|
|
@ -25,5 +34,5 @@
|
|||
<script src="//cdn.jsdelivr.net/npm/docsify-copy-code"></script>
|
||||
<script src="//cdn.jsdelivr.net/npm/prismjs@1.22.0/components/prism-bash.min.js"></script>
|
||||
<script src="//cdn.jsdelivr.net/npm/prismjs@1.22.0/components/prism-json.min.js"></script>
|
||||
</body>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ The object returned by any service provider has the following layout:
|
|||
|
||||
```json
|
||||
{
|
||||
"serviceprovider" : {
|
||||
"serviceprovider": {
|
||||
"type": "web",
|
||||
"name": "awesome-service"
|
||||
},
|
||||
|
|
@ -40,6 +40,7 @@ Mandatory: true
|
|||
```
|
||||
|
||||
Currently, only two types of service providers are supported:
|
||||
|
||||
- `web`: traditional website platforms
|
||||
- `communication`: platforms for interpersonal communication
|
||||
|
||||
|
|
@ -124,6 +125,7 @@ Mandatory: true
|
|||
```
|
||||
|
||||
The format in which the claim's fingerprint is expected to be found in the proof. There are three supported claim formats:
|
||||
|
||||
- `uri`: the claim is formulated as `openpgp4fpr:FINGERPRINT`
|
||||
- `message`: the claim is formulated as `[Verifying my OpenPGP key: openpgp4fpr:FINGERPRINT]`
|
||||
- `fingerprint`: the claim is formulated as `FINGERPRINT`
|
||||
|
|
@ -151,6 +153,7 @@ Mandatory: true
|
|||
```
|
||||
|
||||
How the claim relates to the proof. There are three supported claim relations:
|
||||
|
||||
- `contains`: the proof is a long text containing the claim
|
||||
- `equals`: the proof is equal to the claim
|
||||
- `oneOf`: the proof is an array of string, one of which is the claim
|
||||
|
|
|
|||
|
|
@ -12,11 +12,10 @@ For more detailed information, please refer to [Claims](claims.md).
|
|||
|
||||
## Cryptographic key
|
||||
|
||||
|
||||
According to [Wikipedia](https://en.wikipedia.org/wiki/Key_(cryptography)):
|
||||
According to [Wikipedia](<https://en.wikipedia.org/wiki/Key_(cryptography)>):
|
||||
|
||||
> [...] a piece of information (a parameter) that determines the functional
|
||||
output of a cryptographic algorithm.
|
||||
> output of a cryptographic algorithm.
|
||||
|
||||
Cryptographic keys can be used to encrypt/decrypt data and verify digital
|
||||
signatures.
|
||||
|
|
|
|||
Loading…
Reference in a new issue