mirror of
https://mau.dev/maunium/synapse.git
synced 2024-12-16 04:03:51 +01:00
58 lines
2.1 KiB
Groff
58 lines
2.1 KiB
Groff
.\" generated with Ronn-NG/v0.8.0
|
|
.\" http://github.com/apjanke/ronn-ng/tree/0.8.0
|
|
.TH "HASH_PASSWORD" "1" "July 2021" "" ""
|
|
.SH "NAME"
|
|
\fBhash_password\fR \- Calculate the hash of a new password, so that passwords can be reset
|
|
.SH "SYNOPSIS"
|
|
\fBhash_password\fR [\fB\-p\fR|\fB\-\-password\fR [password]] [\fB\-c\fR|\fB\-\-config\fR \fIfile\fR]
|
|
.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\. If not, prompt the user and read the password form the \fBSTDIN\fR\. 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
|
|
$ 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 <\fI\%mailto:rahulde@swecha\.net\fR> for Debian GNU/Linux distribution\.
|
|
.SH "SEE ALSO"
|
|
synctl(1), synapse_port_db(1), register_new_matrix_user(1), synapse_review_recent_signups(1)
|