KAFKA-6319: Quote strings stored in JSON configs#4303
Conversation
|
@ijuma Can you review, please? Thank you! |
|
Thanks @rajinisivaram. What do we do about the invalid json strings that have already been stored? |
9518f46 to
dd03670
Compare
|
@ijuma Have updated to handle non-escaped backslash in configs persisted by 1.0 code. |
ijuma
left a comment
ijuma
left a comment
There was a problem hiding this comment.
Thanks for the PR, looks good overall, just a few minor comments.
There was a problem hiding this comment.
We should probably say, "Before 1.0.1, ..."
There was a problem hiding this comment.
Can we file a JIRA to move this so that it only applies to ACLs in trunk (for 1.1)?
There was a problem hiding this comment.
There was a problem hiding this comment.
I think this is not used any more.
There was a problem hiding this comment.
Use triple quotes to avoid the need for Java escaping?
There was a problem hiding this comment.
Do we have endpoint identification enabled anywhere?
There was a problem hiding this comment.
No, but since we may decide to make HTTPS the default value and this test would fail with endpoint validation enabled, I thought it was better to explicitly remove it.
There was a problem hiding this comment.
Triple quotes to avoid Java escaping.
There was a problem hiding this comment.
Simple this is a reasonably simple string, can we not just provide the full string without encoding instead of implementing this method?
dd03670 to
f3d08b2
Compare
|
@ijuma Thank you for the review. I have made the updates. |
| case _: JsonProcessingException => | ||
| // In 1.0, Json#encode did not escape backslash or any other special characters. SSL principals | ||
| // Before 1.0.1, Json#encode did not escape backslash or any other special characters. SSL principals | ||
| // stored in ACLs may contain backslash as an escape char, making the JSON generated in 1.0 invalid. |
There was a problem hiding this comment.
We probably want to replace 1.0 as well.
| assertEquals("\"str1\\\\,str2\"", Json.encode("str1\\,str2")) | ||
| assertEquals("\"\\\"quoted\\\"\"", Json.encode("\"quoted\"")) | ||
| assertEquals(""""str1\\,str2"""", Json.encode("""str1\,str2""")) | ||
| assertEquals(""""\"quoted\""""", Json.encode(""""quoted"""")) |
There was a problem hiding this comment.
Ouch, maybe my suggestion was bad in this line.
There was a problem hiding this comment.
A bit unclear to be honest. Both options seem hard to read. :)
There was a problem hiding this comment.
Shall I leave it as is or do you want me to change it back - I don't mind either way.
|
retest this please |
ijuma
left a comment
ijuma
left a comment
There was a problem hiding this comment.
Thanks for the PR, LGTM. Can you please update the PR description to remove the automatically generated text?
|
@ijuma Thanks for the review. Fixed the description. |
|
Merged to trunk and 1.0 branches. |
This is required for ACLs where SSL principals contain special characters (e.g. comma) that are escaped using backslash. The strings need to be quoted for JSON to ensure that the JSON stored in ZK is valid. Also converted `SslEndToEndAuthorizationTest` to use a principal with special characters to ensure that this path is tested. Author: Rajini Sivaram <rajinisivaram@googlemail.com> Reviewers: Ismael Juma <ismael@juma.me.uk> Closes #4303 from rajinisivaram/KAFKA-6319 (cherry picked from commit 651c6e4) Signed-off-by: Ismael Juma <ismael@juma.me.uk>
2 participants
This is required for ACLs where SSL principals contain special characters (e.g. comma) that are escaped using backslash. The strings need to be quoted for JSON to ensure that the JSON stored in ZK is valid. Since ACLs may have been stored in ZK without escaping with previous versions of Kafka, a workaround has been added to parse those.
Also converted
SslEndToEndAuthorizationTestto use a principal with special characters to ensure that this path is tested.Committer Checklist (excluded from commit message)