diff options
Diffstat (limited to 'docs/openapi.yaml')
| -rw-r--r-- | docs/openapi.yaml | 38 |
1 files changed, 37 insertions, 1 deletions
diff --git a/docs/openapi.yaml b/docs/openapi.yaml index a64c739..797c46f 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -902,6 +902,42 @@ paths: '409': { description: No user registry, which holds the keys. } '503': { description: Not ready yet. } + /auth/login/party: + post: + tags: [Auth, Events] + summary: Log in as a party, by one of its keys (federation) + description: | + On a node holding a federated store (`federation` feature): a challenge + (`POST /auth/challenge`) signed by one of the keys that sign for the party there, + those its current version names or of its key set as it counts, for the namespace + `continuum-login` (an ECDSA signature's `s` low, as for events). A token as the + party (`login: party`): a party's session, which does federation work alone, + reading the events API, putting events and checking forks, while that key signs + for the party (`401` once it doesn't); anything else is `403`. The node that + issued it alone takes it. No authentication: the signature proves the party. + security: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + required: [party, challenge, signature] + properties: + party: { type: string } + challenge: { type: string } + signature: { type: string, description: 'Armored, as `ssh-keygen -Y sign -n continuum-login` writes it, or its blob in base64.' } + responses: + '200': + description: The token. + content: + application/json: + schema: { $ref: '#/components/schemas/TokenAnswer' } + '400': { description: A request that isn't one. } + '401': { description: 'Not a challenge of this node, expired or used, or not signed by a key that signs for the party, or no party of the current version (the message says which).' } + '409': { description: No federated store here. } + '503': { description: Not ready yet. } + /auth/session: post: tags: [Auth] @@ -1038,7 +1074,7 @@ paths: get: tags: [Auth] summary: Who you are here - description: The swarm, the user, how it proved it (`htpasswd`, `header`, `token`), its registry entry's capabilities (`caps`), what this request may do (`may`, a list of capabilities; with a token that says less, what both give), and its token's claims if it came with one. + description: The swarm, the user, how it proved it (`htpasswd`, `header`, `token`), its registry entry's capabilities (`caps`), what this request may do (`may`, a list of capabilities; with a token that says less, what both give), and its token's claims if it came with one (of a party's session, `party`: the key it logged in with). responses: '200': description: Who. |
