Skip to content

Document how to migrate passwords from Synapse with a pepper set #4353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 11, 2025
Merged

Document how to migrate passwords from Synapse with a pepper set #4353

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c9bca2b
Document password scheme secret field for migrations
speatzle Apr 11, 2025
da9fc3c
Minor rewording
sandhose Apr 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/setup/migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ Follow the instructions in the [installation guide](installation.md) to install
Synapse uses bcrypt as its password hashing scheme while MAS defaults to using the newer argon2id.
You will have to configure the version 1 scheme as bcrypt for migrated passwords to work.
It is also recommended that you keep argon2id as version 2 so that once users log in, their hashes will be updated to the newer recommended scheme.
If you have a `pepper` set in the `password_config` section of your Synapse config, then you need to specify this `pepper` as the `secret` field for your `bcrypt` scheme.

Example passwords configuration:
```yml
Expand All @@ -53,6 +54,8 @@ passwords:
schemes:
- version: 1
algorithm: bcrypt
# Optional, must match the `password_config.pepper` in the Synapse config
#secret: secretPepperValue
- version: 2
algorithm: argon2id
```
Expand Down
Loading