summaryrefslogtreecommitdiff
path: root/docs/rabbitmqctl.8
diff options
context:
space:
mode:
authorMichael Klishin <mklishin@pivotal.io>2017-07-04 17:22:46 +0300
committerMichael Klishin <mklishin@pivotal.io>2017-07-04 17:22:46 +0300
commitf8194a8407ade85bd3616ae7a7844786334ea860 (patch)
treea685dc8f066253a516ae0f8e0a7ddd4d52d54afb /docs/rabbitmqctl.8
parent2ca2000d7524c6d837db82172981e6695288fe90 (diff)
parent5d45fc999335451eeee3f9dd4c6f87b9fbfe4f3f (diff)
downloadrabbitmq-server-git-f8194a8407ade85bd3616ae7a7844786334ea860.tar.gz
Merge branch 'master' into rabbitmq-server-1280
Diffstat (limited to 'docs/rabbitmqctl.8')
-rw-r--r--docs/rabbitmqctl.849
1 files changed, 31 insertions, 18 deletions
diff --git a/docs/rabbitmqctl.8 b/docs/rabbitmqctl.8
index 6f8d40eaf2..7a8497a89b 100644
--- a/docs/rabbitmqctl.8
+++ b/docs/rabbitmqctl.8
@@ -1811,42 +1811,55 @@ floating point number.
Values lower than 1.0 can be dangerous and should be used carefully.
.El
.\" ------------------------------------
-.It Cm encode Oo Fl -decode Oc Oo Ar value Oc Oo Ar passphrase Oc Oo Fl -list-ciphers Oc Oo Fl -list-hashes Oc Oo Fl -cipher Ar cipher Oc Oo Fl -hash Ar hash Oc Op Fl -iterations Ar iterations
+.It Cm encode Ar value Ar passphrase Oo Fl -cipher Ar cipher Oc Oo Fl -hash Ar hash Oc Op Fl -iterations Ar iterations
.Bl -tag -width Ds
-.It Fl -decode
-Flag to decrypt the input value.
-.Pp
-For example:
-.sp
-.Dl rabbitmqctl encode --decode '{encrypted,<<"...">>}' mypassphrase
.It Ar value Ar passphrase
-Value to encrypt/decrypt and passphrase.
+Value to encrypt and passphrase.
.Pp
For example:
.sp
.Dl rabbitmqctl encode '<<"guest">>' mypassphrase
-.sp
-.Dl rabbitmqctl encode --decode '{encrypted,<<"...">>}' mypassphrase
-.It Fl -list-ciphers
-Flag to list the supported ciphers.
+.It Fl -cipher Ar cipher Fl -hash Ar hash Fl -iterations Ar iterations
+Options to specify the encryption settings.
+They can be used independently.
.Pp
For example:
.sp
-.Dl rabbitmqctl encode --list-ciphers
-.It Fl -list-hashes
-Flag to list the supported hash algorithms.
+.Dl rabbitmqctl encode --cipher blowfish_cfb64 --hash sha256 --iterations 10000 '<<"guest">>' mypassphrase
+.El
+.\" ------------------------------------
+.It Cm decode Ar value Ar passphrase Oo Fl -cipher Ar cipher Oc Oo Fl -hash Ar hash Oc Op Fl -iterations Ar iterations
+.Bl -tag -width Ds
+.It Ar value Ar passphrase
+Value to decrypt (as produced by the encode command) and passphrase.
.Pp
For example:
.sp
-.Dl rabbitmqctl encode --list-hashes
+.Dl rabbitmqctl decode '{encrypted, <<"...">>}' mypassphrase
.It Fl -cipher Ar cipher Fl -hash Ar hash Fl -iterations Ar iterations
-Options to specify the encryption settings.
+Options to specify the decryption settings.
They can be used independently.
.Pp
For example:
.sp
-.Dl rabbitmqctl encode --cipher blowfish_cfb64 --hash sha256 --iterations 10000 '<<"guest">>' mypassphrase
+.Dl rabbitmqctl decode --cipher blowfish_cfb64 --hash sha256 --iterations 10000 '{encrypted,<<"...">>} mypassphrase
.El
+.\" ------------------------------------
+.It Cm list_hashes
+Lists hash functions supported by encoding commands.
+.Pp
+For example, this command instructs the RabbitMQ broker to list all hash
+functions supported by encoding commands:
+.sp
+.Dl rabbitmqctl list_hashes
+.\" ------------------------------------
+.It Cm list_ciphers
+Lists cipher suites supported by encoding commands.
+.Pp
+For example, this command instructs the RabbitMQ broker to list all
+cipher suites supported by encoding commands:
+.sp
+.Dl rabbitmqctl list_ciphers
.El
.\" ------------------------------------------------------------------
.Sh PLUGIN COMMANDS