wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Rename 'perspective server' to 'notary server' as that's what the Perspectives Project calls them too

Browse source
This commit is contained in:
Paul "LeoNerd" Evans 2015-08-05 11:35:48 +01:00
parent 880bf20403
commit 49c52a96a7
1 changed files with 15 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

30
specification/30_server_server_api.rst
View file

@ -78,17 +78,17 @@ Version 2
Each home server publishes its public keys under ``/_matrix/key/v2/server/``. Each home server publishes its public keys under ``/_matrix/key/v2/server/``.
Home servers query for keys by either getting ``/_matrix/key/v2/server/`` Home servers query for keys by either getting ``/_matrix/key/v2/server/``
directly or by querying an intermediate perspective server using a directly or by querying an intermediate notary server using a
``/_matrix/key/v2/query`` API. Intermediate perspective servers query the ``/_matrix/key/v2/query`` API. Intermediate notary servers query the
``/_matrix/key/v2/server/`` API on behalf of another server and sign the ``/_matrix/key/v2/server/`` API on behalf of another server and sign the
response with their own key. A server may query multiple perspective servers response with their own key. A server may query multiple notary servers to
to ensure that they all report the same public keys. ensure that they all report the same public keys.
This approach is borrowed from the Perspectives Project This approach is borrowed from the Perspectives Project
(http://perspectives-project.org/), but modified to include the NACL keys and to (http://perspectives-project.org/), but modified to include the NACL keys and to
use JSON instead of XML. It has the advantage of avoiding a single trust-root use JSON instead of XML. It has the advantage of avoiding a single trust-root
since each server is free to pick which perspective servers they trust and can since each server is free to pick which notary servers they trust and can
corroborate the keys returned by a given perspective server by querying other corroborate the keys returned by a given notary server by querying other
servers. servers.
Publishing Keys Publishing Keys
@ -122,15 +122,15 @@ The ``old_verify_keys`` can be used to sign events with an ``origin_server_ts``
before the ``expired_ts``. The ``expired_ts`` is a millisecond POSIX timestamp before the ``expired_ts``. The ``expired_ts`` is a millisecond POSIX timestamp
of when the originating server stopped using that key. of when the originating server stopped using that key.
Intermediate perspective servers should cache a response for half of its Intermediate notary servers should cache a response for half of its remaining
remaining life time to avoid serving a stale response. Originating servers should life time to avoid serving a stale response. Originating servers should avoid
avoid returning responses that expire in less than an hour to avoid repeated returning responses that expire in less than an hour to avoid repeated requests
requests for an about to expire certificate. Requesting servers should limit how for an about to expire certificate. Requesting servers should limit how
frequently they query for certificates to avoid flooding a server with requests. frequently they query for certificates to avoid flooding a server with requests.
If a server goes offline intermediate perspective servers should continue to If a server goes offline intermediate notary servers should continue to return
return the last response they received from that server so that the signatures the last response they received from that server so that the signatures of old
of old events sent by that server can still be checked. events sent by that server can still be checked.
==================== =================== ====================================== ==================== =================== ======================================
Key Type Description Key Type Description
@ -191,8 +191,8 @@ The ``minimum_valid_until_ts`` is a millisecond POSIX timestamp indicating
when the returned certificate will need to be valid until to be useful to the when the returned certificate will need to be valid until to be useful to the
requesting server. This can be set using the maximum ``origin_server_ts`` of requesting server. This can be set using the maximum ``origin_server_ts`` of
an batch of events that a requesting server is trying to validate. This allows an batch of events that a requesting server is trying to validate. This allows
an intermediate perspectives server to give a prompt cached response even if an intermediate notary server to give a prompt cached response even if the
the originating server is offline. originating server is offline.
This API can return keys for servers that are offline be using cached responses This API can return keys for servers that are offline be using cached responses
taken from when the server was online. Keys can be queried from multiple taken from when the server was online. Keys can be queried from multiple