Sydent: Reference Matrix Identity Server http://matrix.org (mirror)
David Baker
e5792134c1
Sort out encodings in the email messages: encode unicodes to strings where necessary, have differently encoded versions of the substitutions for use in the different places and use the email header library to generate the appropriately encoded header.
|
8 years ago | |
|---|---|---|
| res | 8 years ago | |
| scripts | 8 years ago | |
| sydent | 8 years ago | |
| .gitignore | 8 years ago | |
| LICENSE | 9 years ago | |
| README.rst | 9 years ago | |
| setup.cfg | 9 years ago | |
| setup.py | 8 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:
Request the validation of your email address:
curl -XPOST 'http://localhost:8090/_matrix/identity/api/v1/validate/email/requestToken' -d'email=matthew@arasphere.net&clientSecret=abcd&sendAttempt=1'
{"success": true, "tokenId": 1}
# receive 943258 by mail
Use this code to validate your email address:
curl -XPOST 'http://localhost:8090/_matrix/identity/api/v1/validate/email/submitToken' -d'token=943258&sid=1&clientSecret=abcd'
{"success": true}
Use the validated email address to bind it to a matrix ID:
curl -XPOST 'http://localhost:8090/_matrix/identity/api/v1/3pid/bind' -d'sid=1&clientSecret=abcd&mxid=%40matthew%3amatrix.org'
# 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
============
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:
Request the validation of your email address:
curl -XPOST 'http://localhost:8090/_matrix/identity/api/v1/validate/email/requestToken' -d'email=matthew@arasphere.net&clientSecret=abcd&sendAttempt=1'
{"success": true, "tokenId": 1}
# receive 943258 by mail
Use this code to validate your email address:
curl -XPOST 'http://localhost:8090/_matrix/identity/api/v1/validate/email/submitToken' -d'token=943258&sid=1&clientSecret=abcd'
{"success": true}
Use the validated email address to bind it to a matrix ID:
curl -XPOST 'http://localhost:8090/_matrix/identity/api/v1/3pid/bind' -d'sid=1&clientSecret=abcd&mxid=%40matthew%3amatrix.org'
# 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