synapse/debian/hash_password.1

.\" generated with Ronn-NG/v0.10.1
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
.TH "HASH_PASSWORD" "1" "August 2024" ""
.SH "NAME"
\fBhash_password\fR \- Calculate the hash of a new password, so that passwords can be reset
.SH "SYNOPSIS"
.TS
allbox;
\fBhash_password\fR [\fB\-p\fR	\fB\-\-password\fR [password]] [\fB\-c\fR	\fB\-\-config\fR \fIfile\fR]
.TE
.SH "DESCRIPTION"
\fBhash_password\fR calculates the hash of a supplied password using bcrypt\.
.P
\fBhash_password\fR takes a password as an parameter either on the command line or the \fBSTDIN\fR if not supplied\.
.P
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 \fBbcrypt_rounds\fR is set to \fB12\fR\.
.P
The hashed password is written on the \fBSTDOUT\fR\.
.SH "FILES"
A sample YAML file accepted by \fBhash_password\fR is described below:
.P
bcrypt_rounds: 17 password_config: pepper: "random hashing pepper"
.SH "OPTIONS"
.TP
\fB\-p\fR, \fB\-\-password\fR
Read the password form the command line if [password] is supplied, or from \fBSTDIN\fR\. 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\.
.TP
\fB\-c\fR, \fB\-\-config\fR
Read the supplied YAML \fIfile\fR containing the options \fBbcrypt_rounds\fR and the \fBpassword_config\fR section containing the \fBpepper\fR value\.
.SH "EXAMPLES"
Hash from the command line:
.IP "" 4
.nf
$ hash_password \-p "p@ssw0rd"
$2b$12$VJNqWQYfsWTEwcELfoSi4Oa8eA17movHqqi8\.X8fWFpum7SxZ9MFe
.fi
.IP "" 0
.P
Hash from the stdin:
.IP "" 4
.nf
$ cat password_file | hash_password
Password:
Confirm password:
$2b$12$AszlvfmJl2esnyhmn8m/kuR2tdXgROWtWxnX\.rcuAbM8ErLoUhybG
.fi
.IP "" 0
.P
Hash from the prompt:
.IP "" 4
.nf
$ hash_password
Password:
Confirm password:
$2b$12$AszlvfmJl2esnyhmn8m/kuR2tdXgROWtWxnX\.rcuAbM8ErLoUhybG
.fi
.IP "" 0
.P
Using a config file:
.IP "" 4
.nf
$ hash_password \-c config\.yml
Password:
Confirm password:
$2b$12$CwI\.wBNr\.w3kmiUlV3T5s\.GT2wH7uebDCovDrCOh18dFedlANK99O
.fi
.IP "" 0
.SH "COPYRIGHT"
This man page was written by Rahul De «rahulde@swecha\.net» for Debian GNU/Linux distribution\.
.SH "SEE ALSO"
synctl(1), synapse_port_db(1), register_new_matrix_user(1), synapse_review_recent_signups(1)
hash_password accepts stdin now (#17608) `hash_password` now actually accepts password from stdin. The `getpass` reads from TTY, and does NOT accept stdin in any way. The manpage has been updated to reflect that. 2024-08-27 20:51:43 +03:00			`.\" generated with Ronn-NG/v0.10.1`
			`.\" http://github.com/apjanke/ronn-ng/tree/0.10.1`
			`.TH "HASH_PASSWORD" "1" "August 2024" ""`
import from package-debian-synapse 2018-12-10 20:14:34 +03:00			`.SH "NAME"`
			`\fBhash_password\fR \- Calculate the hash of a new password, so that passwords can be reset`
			`.SH "SYNOPSIS"`
hash_password accepts stdin now (#17608) `hash_password` now actually accepts password from stdin. The `getpass` reads from TTY, and does NOT accept stdin in any way. The manpage has been updated to reflect that. 2024-08-27 20:51:43 +03:00			`.TS`
			`allbox;`
			`\fBhash_password\fR [\fB\-p\fR \fB\-\-password\fR [password]] [\fB\-c\fR \fB\-\-config\fR \fIfile\fR]`
			`.TE`
import from package-debian-synapse 2018-12-10 20:14:34 +03:00			`.SH "DESCRIPTION"`
			`\fBhash_password\fR calculates the hash of a supplied password using bcrypt\.`
			`.P`
			`\fBhash_password\fR takes a password as an parameter either on the command line or the \fBSTDIN\fR if not supplied\.`
			`.P`
Correct default number of bcrypt hash rounds in .1 man page (#13930) 2022-09-28 16:45:13 +03:00			`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 \fBbcrypt_rounds\fR is set to \fB12\fR\.`
import from package-debian-synapse 2018-12-10 20:14:34 +03:00			`.P`
			`The hashed password is written on the \fBSTDOUT\fR\.`
			`.SH "FILES"`
			`A sample YAML file accepted by \fBhash_password\fR is described below:`
			`.P`
			`bcrypt_rounds: 17 password_config: pepper: "random hashing pepper"`
			`.SH "OPTIONS"`
			`.TP`
			`\fB\-p\fR, \fB\-\-password\fR`
hash_password accepts stdin now (#17608) `hash_password` now actually accepts password from stdin. The `getpass` reads from TTY, and does NOT accept stdin in any way. The manpage has been updated to reflect that. 2024-08-27 20:51:43 +03:00			`Read the password form the command line if [password] is supplied, or from \fBSTDIN\fR\. 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\.`
import from package-debian-synapse 2018-12-10 20:14:34 +03:00			`.TP`
			`\fB\-c\fR, \fB\-\-config\fR`
			`Read the supplied YAML \fIfile\fR containing the options \fBbcrypt_rounds\fR and the \fBpassword_config\fR section containing the \fBpepper\fR value\.`
			`.SH "EXAMPLES"`
			`Hash from the command line:`
			`.IP "" 4`
			`.nf`
			`$ hash_password \-p "p@ssw0rd"`
			`$2b$12$VJNqWQYfsWTEwcELfoSi4Oa8eA17movHqqi8\.X8fWFpum7SxZ9MFe`
			`.fi`
			`.IP "" 0`
			`.P`
hash_password accepts stdin now (#17608) `hash_password` now actually accepts password from stdin. The `getpass` reads from TTY, and does NOT accept stdin in any way. The manpage has been updated to reflect that. 2024-08-27 20:51:43 +03:00			`Hash from the stdin:`
			`.IP "" 4`
			`.nf`
			`$ cat password_file \| hash_password`
			`Password:`
			`Confirm password:`
			`$2b$12$AszlvfmJl2esnyhmn8m/kuR2tdXgROWtWxnX\.rcuAbM8ErLoUhybG`
			`.fi`
			`.IP "" 0`
			`.P`
			`Hash from the prompt:`
import from package-debian-synapse 2018-12-10 20:14:34 +03:00			`.IP "" 4`
			`.nf`
			`$ hash_password`
			`Password:`
			`Confirm password:`
			`$2b$12$AszlvfmJl2esnyhmn8m/kuR2tdXgROWtWxnX\.rcuAbM8ErLoUhybG`
			`.fi`
			`.IP "" 0`
			`.P`
			`Using a config file:`
			`.IP "" 4`
			`.nf`
			`$ hash_password \-c config\.yml`
			`Password:`
			`Confirm password:`
			`$2b$12$CwI\.wBNr\.w3kmiUlV3T5s\.GT2wH7uebDCovDrCOh18dFedlANK99O`
			`.fi`
			`.IP "" 0`
			`.SH "COPYRIGHT"`
hash_password accepts stdin now (#17608) `hash_password` now actually accepts password from stdin. The `getpass` reads from TTY, and does NOT accept stdin in any way. The manpage has been updated to reflect that. 2024-08-27 20:51:43 +03:00			`This man page was written by Rahul De «rahulde@swecha\.net» for Debian GNU/Linux distribution\.`
import from package-debian-synapse 2018-12-10 20:14:34 +03:00			`.SH "SEE ALSO"`
Add script for getting info about recently registered users (#10290) 2021-07-06 15:03:16 +03:00			`synctl(1), synapse_port_db(1), register_new_matrix_user(1), synapse_review_recent_signups(1)`