Skip to content

Commit a3202a6

Browse files
authored
Document how to migrate passwords from Synapse with a pepper set (#4353)
2 parents 852a817 + da9fc3c commit a3202a6

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/setup/migration.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ Follow the instructions in the [installation guide](installation.md) to install
4545
Synapse uses bcrypt as its password hashing scheme while MAS defaults to using the newer argon2id.
4646
You will have to configure the version 1 scheme as bcrypt for migrated passwords to work.
4747
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.
48+
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.
4849

4950
Example passwords configuration:
5051
```yml
@@ -53,6 +54,8 @@ passwords:
5354
schemes:
5455
- version: 1
5556
algorithm: bcrypt
57+
# Optional, must match the `password_config.pepper` in the Synapse config
58+
#secret: secretPepperValue
5659
- version: 2
5760
algorithm: argon2id
5861
```

0 commit comments

Comments
 (0)