HASH_PASSWORD(1)

hey bestie 💖 welcome to the HASH_PASSWORD(1) page from the General Commands Manual — it's giving password-reset realness, and honestly? iconic.

💖 NAME 💖

hash_password — calculate the hash of a new password, so that passwords can be reset 💅

✨ SYNOPSIS ✨

bestie, the original page has literally no synopsis text under this heading — so we're keeping the void exactly as it is 🫶

🦋 DESCRIPTION 🦋

hash_password calculates the hash of a supplied password using bcrypt. No cap, that's the whole vibe.

hash_password takes a password as a parameter either on the command line or from the STDIN if it's not supplied.

It accepts a 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 12.

The hashed password is written on the STDOUT.

🌸 FILES 🌸

A sample YAML file accepted by hash_password is described below:

bcrypt_rounds: 17 password_config: pepper: "random hashing pepper"

💅 OPTIONS 💅

• -p, --password — Read the password from the command line if [password] is supplied, or from STDIN. If not, prompt the user and read the password from the tty prompt. 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:

$ hash_password -p "p@ssw0rd"
$2b$12$VJNqWQYfsWTEwcELfoSi4Oa8eA17movHqqi8.X8fWFpum7SxZ9MFe

Hash from the stdin:

$ cat password_file | hash_password
Password:
Confirm password:
$2b$12$AszlvfmJl2esnyhmn8m/kuR2tdXgROWtWxnX.rcuAbM8ErLoUhybG

Hash from the prompt:

$ hash_password
Password:
Confirm password:
$2b$12$AszlvfmJl2esnyhmn8m/kuR2tdXgROWtWxnX.rcuAbM8ErLoUhybG

Using a config file:

$ 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 the Debian GNU/Linux distribution. Periodt. 💅

🫶 SEE ALSO 🫶

• synctl(1)
• synapse_port_db(1)
• register_new_matrix_user(1)
• synapse_review_recent_signups(1)

---

August 2024 • HASH_PASSWORD(1) • stay hydrated and hash responsibly, bestie 🫶💖