{"id":22741827,"url":"https://github.com/t2bot/vault-plugin-secrets-matrix","last_synced_at":"2025-03-30T04:14:19.147Z","repository":{"id":114495919,"uuid":"155009587","full_name":"t2bot/vault-plugin-secrets-matrix","owner":"t2bot","description":"Vault secrets engine for Matrix","archived":false,"fork":false,"pushed_at":"2018-10-29T02:23:05.000Z","size":13,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-05T06:33:56.498Z","etag":null,"topics":["engine","matrix","secrets","vault"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/t2bot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-27T21:09:33.000Z","updated_at":"2024-09-09T17:45:11.000Z","dependencies_parsed_at":"2023-05-17T02:45:28.150Z","dependency_job_id":null,"html_url":"https://github.com/t2bot/vault-plugin-secrets-matrix","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/t2bot%2Fvault-plugin-secrets-matrix","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/t2bot%2Fvault-plugin-secrets-matrix/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/t2bot%2Fvault-plugin-secrets-matrix/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/t2bot%2Fvault-plugin-secrets-matrix/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/t2bot","download_url":"https://codeload.github.com/t2bot/vault-plugin-secrets-matrix/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246273552,"owners_count":20750906,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["engine","matrix","secrets","vault"],"created_at":"2024-12-11T00:18:14.150Z","updated_at":"2025-03-30T04:14:19.139Z","avatar_url":"https://github.com/t2bot.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vault-plugin-secrets-matrix\n\nVault secrets engine for Matrix. \n\n# Install / Upgrade\n\nYou'll need to set the `plugin_directory` for Vault so that the plugin can be\nloaded. The example here assumes you have the plugin directory set to `/etc/vault/plugins`. \n\n```bash\n# Clone and build the repository\ngit clone https://github.com/t2bot/vault-plugin-secrets-matrix.git\ncd vault-plugin-secrets-matrix\ngo build -o /etc/vault/plugins/matrix\n\n# Register the plugin in the catalog\nsha256=$(shasum -a 256 \"/etc/vault/plugins/matrix\" | cut -d \" \" -f1)\nvault write sys/plugins/catalog/matrix sha_256=$sha256 command=\"matrix\"\n\n# Enable the plugin and mount it to matrix/\nvault secrets enable -path=matrix -plugin-name=matrix plugin\n```\n\n# Configuration\n\nYou'll need to configure the homeservers you want the plugin to interact with. Each homeserver\nneeds a client/server API URL to talk to. This is typically the same as what you'd set for clients.\n\n```bash\nvault write matrix/config/homeserver/example.org cs_url=https://example.org\n```\n\nYou'll also need to configure which users should be accessible through the plugin. Each uses a \nlogin secret that will be given to the `io.t2bot.vault` login type during authentication.\n\n```bash\n# for @alice:example.org\nvault write matrix/config/user/alice/example.org login_secret=SomeSecretString\n```\n\n# Usage with Synapse\n\n1. Install the [synapse-vault-auth-provider](https://github.com/t2bot/synapse-vault-auth-provider)\n2. Register any homeservers and users you want to log in with (as per the \"Configuration\" section above)\n3. Write the same `login_secret` used for the user to the kv store:\n   ```bash\n   vault kv put secret/matrix/users/@alice:example.org login_secret=SomeSecretString\n   ```\n4. Read an access token from Vault:\n   ```bash\n   # for @alice:example.org\n   vault read matrix/user/alice/example.org\n   ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ft2bot%2Fvault-plugin-secrets-matrix","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ft2bot%2Fvault-plugin-secrets-matrix","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ft2bot%2Fvault-plugin-secrets-matrix/lists"}