You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
58 lines
2.0 KiB
YAML
58 lines
2.0 KiB
YAML
# Copyright 2018 New Vector Ltd
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
openapi: 3.1.0
|
|
info:
|
|
title: Matrix Federation Key Exchange API
|
|
version: 1.0.0
|
|
paths:
|
|
/server:
|
|
get:
|
|
summary: Get the homeserver's public key(s)
|
|
description: |-
|
|
Gets the homeserver's published signing keys.
|
|
The homeserver may have any number of active keys and may have a
|
|
number of old keys.
|
|
|
|
Intermediate notary servers should cache a response for half of its
|
|
lifetime to avoid serving a stale response. Originating servers should
|
|
avoid returning responses that expire in less than an hour to avoid
|
|
repeated requests for a certificate that is about to expire. Requesting
|
|
servers should limit how frequently they query for certificates to
|
|
avoid flooding a server with requests.
|
|
|
|
If the server fails to respond to this request, intermediate notary
|
|
servers should continue to return the last response they received
|
|
from the server so that the signatures of old events can still be
|
|
checked.
|
|
operationId: getServerKey
|
|
responses:
|
|
"200":
|
|
description: The homeserver's keys
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: definitions/keys.yaml
|
|
servers:
|
|
- url: "{protocol}://{hostname}{basePath}"
|
|
variables:
|
|
protocol:
|
|
enum:
|
|
- http
|
|
- https
|
|
default: https
|
|
hostname:
|
|
default: localhost:8448
|
|
basePath:
|
|
default: /_matrix/key/v2
|