forked from Mirrors/doipjs
Add signature verification API documentation
This commit is contained in:
parent
6c2aa92187
commit
a8e0526d59
1 changed files with 28 additions and 0 deletions
28
docs/api.md
28
docs/api.md
|
@ -187,3 +187,31 @@ Parses the `keyPlaintext`.
|
||||||
**Returns**
|
**Returns**
|
||||||
|
|
||||||
A public key object.
|
A public key object.
|
||||||
|
|
||||||
|
## signatures.verify(uri, [fingerprint], [opts])
|
||||||
|
|
||||||
|
_(async)_ doip.signatures.verify(signature, [opts])
|
||||||
|
|
||||||
|
Verifies the identity behind the claims in the provided clear-signed **signature**.
|
||||||
|
|
||||||
|
**Parameters**
|
||||||
|
|
||||||
|
| Name | Type | Mandatory | Description |
|
||||||
|
| --------- | ------ | --------- | ------------------------- |
|
||||||
|
| signature | string | true | the clear-sgned signature |
|
||||||
|
| opts | object | false | options (see below) |
|
||||||
|
|
||||||
|
**Options**
|
||||||
|
|
||||||
|
See [claims.verify(uri, ...)](#claimsverifyuri-fingerprint-opts).
|
||||||
|
|
||||||
|
**Returns**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"errors": [ ... ],
|
||||||
|
"publicKey": { ... },
|
||||||
|
"fingerprint": "...",
|
||||||
|
"serviceproviderData": { ... }
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in a new issue