SYNAPSE_HASH_PASSWORD(1) General Commands Manual SYNAPSE_HASH_PASSWORD(1)
NAME
synapse_hash_password - Calculate the hash of a new password, so that
passwords can be reset
SYNOPSIS
synapse_hash_password [-p|--password [password]] [-c|--config file]
DESCRIPTION
synapse_hash_password calculates the hash of a supplied password using
bcrypt.
synapse_hash_password takes a password as an parameter either on the
command line or the STDIN if not supplied.
It accepts an YAML file which can be used to specify parameters like
the number of rounds for bcrypt and password_config section having the
pepper value used for the hashing. By default bcrypt_rounds is set to
10.
The hashed password is written on the STDOUT.
FILES
A sample YAML file accepted by synapse_hash_password is described be-
low:
bcrypt_rounds: 17 password_config: pepper: "random hashing pepper"
OPTIONS
-p, --password
Read the password form the command line if [password] is sup-
plied. If not, prompt the user and read the password form the
STDIN. It is not recommended to type the password on the command
line directly. Use the STDIN instead.
-c, --config
Read the supplied YAML file containing the options bcrypt_rounds
and the password_config section containing the pepper value.
EXAMPLES
Hash from the command line:
$ synapse_hash_password -p "p@ssw0rd"
$2b$12$VJNqWQYfsWTEwcELfoSi4Oa8eA17movHqqi8.X8fWFpum7SxZ9MFe
Hash from the STDIN:
$ synapse_hash_password
Password:
Confirm password:
$2b$12$AszlvfmJl2esnyhmn8m/kuR2tdXgROWtWxnX.rcuAbM8ErLoUhybG
Using a config file:
$ synapse_hash_password -c config.yml
Password:
Confirm password:
$2b$12$CwI.wBNr.w3kmiUlV3T5s.GT2wH7uebDCovDrCOh18dFedlANK99O
COPYRIGHT
This man page was written by Rahul De «rahulde@swecha.net» for Debian
GNU/Linux distribution.
SEE ALSO
synctl(1), synapse_port_db(1), synapse_register_new_matrix_user(1)
March 2022 SYNAPSE_HASH_PASSWORD(1)
Generated by dwww version 1.15 on Thu Sep 4 10:47:01 CEST 2025.