Skip to content

Commit 7946646

Browse files
committed
Be more explicit about security considerations for EncryptInterceptor
1 parent 1c74eaa commit 7946646

2 files changed

Lines changed: 17 additions & 3 deletions

File tree

webapps/docs/changelog.xml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,12 @@
131131
<code>EncryptInterceptor</code> to <code>AES/GCM/NoPadding</code>. This
132132
is a breaking change for the <code>EncryptInterceptor</code>. (markt)
133133
</add>
134+
<add>
135+
Expand the documentation for the <code>EncryptInterceptor</code> to be
136+
more explicit regarding the security weaknesses of some supported
137+
algorithms. Also explicitly state that the replay protection is only
138+
effective for non-malleable algorithms. (markt)
139+
</add>
134140
</changelog>
135141
</subsection>
136142
</section>

webapps/docs/config/cluster-interceptor.xml

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -241,8 +241,16 @@
241241
<p>
242242
The EncryptInterceptor uses the timestamp of the message to provide replay
243243
protection. For this to be effective, clock skew between cluster nodes
244-
should be minimised. If not, it is likely a high proportion of valid
245-
messages will be rejected.
244+
should be minimised. If the clock skew is not minimised, it is likely that
245+
a high proportion of valid messages will be rejected.
246+
</p>
247+
<p>
248+
The replay protection is only effective if the configured encryption
249+
algorithm is not malleable. The default algorithm
250+
(<code>AES/GCM/NoPadding</code>) is not malleable and replay protection
251+
will be effective in the default configuration. Some supported algorithms -
252+
such as <code>AES/CBC/PKCS5Padding</code> - are malleable and the replay
253+
protection will not be effective with such algoriths.
246254
</p>
247255
<attributes>
248256
<attribute name="encryptionAlgorithm" required="false">
@@ -255,7 +263,7 @@
255263
<p>The EncryptInterceptor currently supports the following standard
256264
<a href="https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation">block-cipher modes</a>:
257265
CBC, CFB, OFB and GCM. Of these, it is recommended that GCM is always
258-
used.</p>
266+
used due to security weaknesses with the other block-cipher modes.</p>
259267

260268
<p>The length of the key will specify the flavor of the encryption
261269
algorithm to be used, if applicable (e.g. AES-128 versus AES-256).</p>

0 commit comments

Comments
 (0)