Feranor PQC Sidecar
API by Feranor · rest
The API of the Feranor PQC sidecar, version 1. Content goes in and out as raw bodies; messages are CMS (RFC 5652) in binary form, with the media types of RFC 8551; errors are problem details (RFC 9457) with a stable code. In JSON answers, members without a value are left out. The sidecar listens on a Unix socket by default (no server URL applies: send any Host, for example http://localhost), or on a loopback TCP port with an access token. The two alternatives of the security requirement are the two transports: the empty one, {}, is the Unix socket, where the socket's file permissions decide who may call; on TCP the access token is required, and a request without it is answered 401. Every route, query parameter, header, media type, problem code and JSON member here is checked against the sidecar by its tests. The guide's sidecar chapter tells how to deploy it.
Verification: observed. Source: crawl.
Capabilities (13)
- Liveness
- Readiness
- What verifiers of hybrid signatures trust too
- Decrypt a message with the key store
- Encrypt content for one or more recipients
- Describe a message without any key
- The last log entries
- The last operations
- What senders encrypt to
- Sign content
- What verifiers trust
- Verify a signature
- Product version profile platform and license