mirrors/hockeypuck
1
0
Fork 0
mirror of https://github.com/hockeypuck/hockeypuck.git synced 2025-12-17 08:55:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Page: HIP 009: Management Interface
Pages
HIP 000: Hockeypuck Improvement Proposals HIP 001: [REVERTED] Regaining control over public key identity with authenticated key management HIP 002: SKS v2 protocol HIP 003: Timestamp aware merge strategy HIP 004: Third party revocation sig distribution HIP 005: Reliable personal data deletion using self signatures HIP 006: WKD support HIP 007: Recursive resolver HIP 008: Out of Band Email Ownership Proof HIP 009: Management Interface HIP 010: Internal rate limiting support HIP 011: Merge ptree into pghkp HIP 012: Define and use JSON‐LD schemas HIP 013: In‐Band Metadata Sync Using Trust Packets Home Migrating from SKS‐keyserver to Hockeypuck Semantic Versioning Policy Upgrading docker‐compose standalone deployment from 2.1 to 2.2
HIP 009: Management Interface
Andrew Gallagher edited this page 2025-03-28 15:26:54 +00:00
Table of Contents

(See https://github.com/hockeypuck/hockeypuck/issues/359) (See https://github.com/hockeypuck/hockeypuck/issues/229) (See https://github.com/hockeypuck/hockeypuck/issues/184)

Motivation

Currently, operators have to manage the key database through either the (clunky) /pks/delete interface, or by making queries directly against postgres. There are some helper scripts under the contrib directory, but they are far from ideal.

In addition, blocklists are currently maintained in the config file, but this does not scale. Some operators have hundreds blocked keys purely due to RTBF requests, and it would be nice if we could also bulk-block keys from known spamming campaigns.

Examples of interactions

TBC

Design

We will implement an admin API at /pks/admin, using OpenPGP signatures for authentication, to replace the admin usage of /pks/delete and /pks/replace. We will also implement table blocklists and allow them to be manipulated via the admin API.

We will also implement client-facing tools to make the API pleasant. These may be command-line or web-based (to be decided).

Out of scope

TBC

Security considerations

TBC

Compatibility

TBC