Matrix Synapse Authentication Provider for Blockstack ID
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
matrix_blockstack_password_provider
.gitignore
LICENSE
README.md
setup.py

README.md

matrix-blockstack-password-provider

Matrix Synapse Authentication Provider for Blockstack IDs

Installation

Use pip install matrix_blockstack_password_provider to install the package in your synapse environment

Configuration

In homeserver.yaml edit the password_provider section:

password_providers:
    - module: "matrix_blockstack_password_provider.BlockstackPasswordProvider"
      config:
        enabled: true
        endpoint: "https://core.blockstack.org"

The endpoint is optional and defaults to https://core.blockstack.org

Known Homeservers for Blockstack users

Client support

  • Currently only OI Chat supports this type of authentication.
  • Client apps need to write a file mxid.json into the root of their gaia bucket. The content is the challenge received from a home server auth endpoint. Then for authentication, the client needs to send the id address as username and as password a client app generated nonce that was used when requesting the challenge together with the app domain in the format nonce + "|" + appDomain + "|" + blockstackId . Users can do this manually on a account management site.