Sydent: Reference Matrix Identity Server http://matrix.org (mirror)

David Baker 25cd16f8f6 Correct default port in README.rst 10 years ago
res 2360cd427f Reference Synapse Identity Verification and Lookup Server 10 years ago
sydent 7d753fe42b Delete renamed file 10 years ago
.gitignore f96eb58f21 Add gitignore for *.pyc 10 years ago
LICENSE 2360cd427f Reference Synapse Identity Verification and Lookup Server 10 years ago
README.rst 25cd16f8f6 Correct default port in README.rst 10 years ago
setup.cfg 2360cd427f Reference Synapse Identity Verification and Lookup Server 10 years ago
setup.py 17c243aae3 point setup.py at the right README 10 years ago

README.rst

Installation
============

Dependencies can be installed using setup.py in the same way as synapse: see synapse/README.rst.

Having installed dependencies, you can run sydent using::

$ python -m sydent.sydent

This will create a configuration file in sydent.conf with some defaults. You'll most likely want to change the server name and specify a mail relay.

Requests
========

The requests that synapse servers and clients submit to the identity server are, briefly, as follows:

curl -XPOST 'http://localhost:8090/matrix/identity/api/v1/validate/email/requestToken' -d'email=matthew@arasphere.net&clientSecret=abcd'
{"success": true, "tokenId": 1}

# receive 943258 by mail

curl -XPOST 'http://localhost:8090/matrix/identity/api/v1/validate/email/submitToken' -d'token=943258&tokenId=1&mxId=%40matthew%3amatrix.org'
{"success": true}

# lookup:

curl 'http://localhost:8090/matrix/identity/api/v1/lookup?medium=email&address=henry%40matrix.org'

# fetch pubkey key for a server

curl http://localhost:8090/matrix/identity/api/v1/pubkey/ed25519