kotovalexarian-likes-gitlab
/
hagrid-keyserver--hagrid
mirror of https://gitlab.com/hagrid-keyserver/hagrid.git
1
0
Fork 0
Code Releases Activity

remove "usage" from readme (it's outdated anyways)

This commit is contained in:
Vincent Breitmoser 2019-06-06 15:05:57 +02:00
parent 117ea2c168
commit 0fb2d69b61
1 changed files with 2 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
README.md
View File

@ -45,87 +45,8 @@ setup.
Usage
-----
### HKP
Hagrid implements a subset of the [HKP][] protocol so that tools like
GnuPG and OpenKeychain can use it without modification.
[HKP]: https://tools.ietf.org/html/draft-shaw-openpgp-hkp-00
#### `GET /pks/lookup?op=get&options=mr&search=<QUERY>`
Returns an *ASCII Armored* key matching the query. Query may be:
- An exact email address query of the form `localpart@example.org`.
- A hexadecimal representation of a long *KeyID* of either a primary
key, or a subkey (`069C0C348DD82C19`, optionally prefixed by `0x`).
- A hexadecimal representation of a *Fingerprint* of either a primary
key, or a subkey (`8E8C33FA4626337976D97978069C0C348DD82C19`,
optionally prefixed by `0x`).
Note that while the hexadecimal digits may use either case, using
upper case letters is more efficient with Hagrid.
#### `GET /pks/lookup?op=index&options=mr&search=<QUERY>`
Returns a [machine-readable list][] of keys matching the query. Query may
have the forms detailed above. Hagrid always returns either one or no
keys at all.
[machine-readable list]: https://tools.ietf.org/html/draft-shaw-openpgp-hkp-00#section-5.2
#### `POST /pks/add`
Keys may be submitted using a POST request to `/pks/add`, the body of
the request being a `application/x-www-form-urlencoded` query.
`keytext` must be the keys to submit, which must be *ASCII Armored*.
More than one key may be submitted in one request.
#### Limitations
By design, Hagrid cannot (or intentionally chooses not to) implement
the full HKP protocol. The main limitations are:
- No support for `op=vindex`,
- only exact matches for user IDs are returned (i.e. `exact=on` is
always assumed),
- the `fingerprint` variable is ignored,
- the `nm` option is ignored,
- `op=index` returns either one or no keys,
- uploads are restricted to 1 MiB,
- all packets that aren't public keys, user IDs or signatures are filtered out.
### VKS
Hagrid has its own URL scheme to fetch keys.
#### `GET /vks/v1/by-fingerprint/<FINGERPRINT>`
Retrieves the key with the given *Fingerprint*. *Fingerprint* may
refer to the primary key, or any subkey. Hexadecimal digits MUST be
uppercase, and MUST NOT be prefixed with `0x`. The returned key is
*ASCII Armored*.
#### `GET /vks/v1/by-keyid/<KEY-ID>`
Retrieves the key with the given long *KeyID*. *KeyID* may refer to
the primary key, or any subkey. Hexadecimal digits MUST be uppercase,
and MUST NOT be prefixed with `0x`. The returned key is *ASCII
Armored*.
#### `GET /vks/v1/by-email/<URL-encoded user ID>`
Retrieves the key with the given *User ID*. Only exact matches are
accepted. Lookup by *User ID* requires opt-in by the key's owner.
The returned key is *ASCII Armored*.
#### `POST /vks/v1/publish`
Keys may be submitted using a POST request to `/vks/v1/publish`, the
body of the request being a `multipart/form-data` query. `keytext`
must be the keys to submit, either *ASCII Armored* or not. More than
one key may be submitted in one request. Hagrid will send
verification emails to every non-expired *User ID*.
You can find instructions and API documentation at the running instance at
[https://keys.openpgp.org](keys.openpgp.org).
Building
--------