Skip to content

Commit 6101e8f

Browse files
acogoluegnesacogoluegnes
committed
Document configuration encryption
References #979 Fixes rabbitmq/rabbitmq-website#282
1 parent 9ee645a commit 6101e8f

File tree

2 files changed

+104
-0
lines changed

2 files changed

+104
-0
lines changed

‎docs/rabbitmq.config.example‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,27 @@
132132
%%
133133
%% {password_hashing_module, rabbit_password_hashing_sha256},
134134

135+
%% Configuration entry encryption.
136+
%% See http://www.rabbitmq.com/configure.html#configuration-encryption
137+
%%
138+
%% To specify the passphrase in the configuration file:
139+
%%
140+
%% {config_entry_decoder, [{passphrase, <<"mypassphrase">>}]}
141+
%%
142+
%% To specify the passphrase in an external file:
143+
%%
144+
%% {config_entry_decoder, [{passphrase, {file, "/path/to/passphrase/file"}}]}
145+
%%
146+
%% To make the broker request the passphrase when it starts:
147+
%%
148+
%% {config_entry_decoder, [{passphrase, prompt}]}
149+
%%
150+
%% To change encryption settings:
151+
%%
152+
%% {config_entry_decoder, [{cipher, aes_cbc256},
153+
%% {hash, sha512},
154+
%% {iterations, 1000}]}
155+
135156
%%
136157
%% Default User / VHost
137158
%% ====================

‎docs/rabbitmqctl.1.xml‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2083,6 +2083,89 @@
20832083
</variablelist>
20842084
</listitem>
20852085
</varlistentry>
2086+
<varlistentry>
2087+
<term>
2088+
<cmdsynopsis>
2089+
<command>encode</command>
2090+
<arg choice="opt">--decode</arg>
2091+
<arg choice="opt"><replaceable>value</replaceable></arg>
2092+
<arg choice="opt"><replaceable>passphrase</replaceable></arg>
2093+
<arg choice="opt">--list-ciphers</arg>
2094+
<arg choice="opt">--list-hashes</arg>
2095+
<arg choice="opt">--cipher <replaceable>cipher</replaceable></arg>
2096+
<arg choice="opt">--hash <replaceable>hash</replaceable></arg>
2097+
<arg choice="opt">--iterations <replaceable>iterations</replaceable></arg>
2098+
</cmdsynopsis>
2099+
</term>
2100+
<listitem>
2101+
<variablelist>
2102+
<varlistentry>
2103+
<term><cmdsynopsis><arg choice="opt">--decode</arg></cmdsynopsis></term>
2104+
<listitem>
2105+
<para>
2106+
Flag to decrypt the input value.
2107+
</para>
2108+
<para role="example-prefix">For example:</para>
2109+
<screen role="example">rabbitmqctl encode --decode '{encrypted,'&lt;&lt;"..."&gt;&gt;}' mypassphrase</screen>
2110+
</listitem>
2111+
</varlistentry>
2112+
<varlistentry>
2113+
<term>
2114+
<cmdsynopsis>
2115+
<arg choice="opt"><replaceable>value</replaceable></arg>
2116+
<arg choice="opt"><replaceable>passphrase</replaceable></arg>
2117+
</cmdsynopsis>
2118+
</term>
2119+
<listitem>
2120+
<para>
2121+
Value to encrypt/decrypt and passphrase.
2122+
</para>
2123+
<para role="example-prefix">For example:</para>
2124+
<screen role="example">rabbitmqctl encode '&lt;&lt;"guest"&gt;&gt;' mypassphrase</screen>
2125+
<screen role="example">rabbitmqctl encode --decode '{encrypted,'&lt;&lt;"..."&gt;&gt;}' mypassphrase</screen>
2126+
</listitem>
2127+
</varlistentry>
2128+
<varlistentry>
2129+
<term><cmdsynopsis><arg choice="opt">--list-ciphers</arg></cmdsynopsis></term>
2130+
<listitem>
2131+
<para>
2132+
Flag to list the supported ciphers.
2133+
</para>
2134+
<para role="example-prefix">For example:</para>
2135+
<screen role="example">rabbitmqctl encode --list-ciphers</screen>
2136+
</listitem>
2137+
</varlistentry>
2138+
<varlistentry>
2139+
<term><cmdsynopsis><arg choice="opt">--list-hashes</arg></cmdsynopsis></term>
2140+
<listitem>
2141+
<para>
2142+
Flag to list the supported hash algorithms.
2143+
</para>
2144+
<para role="example-prefix">For example:</para>
2145+
<screen role="example">rabbitmqctl encode --list-hashes</screen>
2146+
</listitem>
2147+
</varlistentry>
2148+
<varlistentry>
2149+
<term>
2150+
<cmdsynopsis>
2151+
<arg choice="opt">--cipher <replaceable>cipher</replaceable></arg>
2152+
<arg choice="opt">--hash <replaceable>hash</replaceable></arg>
2153+
<arg choice="opt">--iterations <replaceable>iterations</replaceable></arg>
2154+
</cmdsynopsis>
2155+
</term>
2156+
<listitem>
2157+
<para>
2158+
Options to specify the encryption settings. They can be used independently.
2159+
</para>
2160+
<para role="example-prefix">For example:</para>
2161+
<screen role="example">
2162+
rabbitmqctl encode --cipher blowfish_cfb64 --hash sha256 --iterations 10000 \
2163+
'&lt;&lt;"guest"&gt;&gt;' mypassphrase</screen>
2164+
</listitem>
2165+
</varlistentry>
2166+
</variablelist>
2167+
</listitem>
2168+
</varlistentry>
20862169
</variablelist>
20872170
</refsect2>
20882171
</refsect1>

0 commit comments

Comments
 (0)