Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: UriTemplate reserved expansion does not escape reserved chars #1844

Merged
merged 1 commit into from
May 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,15 @@ public class PercentEscaper extends UnicodeEscaper {
public static final String SAFEPATHCHARS_URLENCODER = "-_.!~*'()@:$&,;=+";

/**
* Contains the safe characters plus all reserved characters. This happens to be the safe path
* characters plus those characters which are reserved for URI segments, namely '/' and '?'.
* A string of characters that do not need to be encoded when used in URI Templates reserved
* expansion, as specified in RFC 6570. This includes the safe characters plus all reserved
* characters.
*
* <p>For details on escaping URI Templates using the reserved expansion, see <a
* href="https://www.rfc-editor.org/rfc/rfc6570#section-3.2.3">RFC 6570 - section 3.2.3</a>.
*/
public static final String SAFE_PLUS_RESERVED_CHARS_URLENCODER = SAFEPATHCHARS_URLENCODER + "/?";
public static final String SAFE_PLUS_RESERVED_CHARS_URLENCODER =
SAFEPATHCHARS_URLENCODER + "/?#[]";

/**
* A string of characters that do not need to be encoded when used in URI user info part, as
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -322,4 +322,30 @@ public void testExpandSeveralTemplatesNoParametersUsed() {
SortedMap<String, Object> map = Maps.newTreeMap();
assertEquals("", UriTemplate.expand("{?id,uid}", map, false));
}

public void testExpandTemplates_reservedExpansion_mustNotEscapeReservedCharSet() {

String reservedSet = ":/?#[]@!$&'()*+,;=";

SortedMap<String, Object> requestMap = Maps.newTreeMap();
requestMap.put("var", reservedSet);

assertEquals(
"Reserved expansion must not escape chars from reserved set according to rfc6570#section-3.2.3",
reservedSet,
UriTemplate.expand("{+var}", requestMap, false));
}

public void testExpandTemplates_reservedExpansion_mustNotEscapeUnreservedCharSet() {

String unReservedSet = "-._~";

SortedMap<String, Object> requestMap = Maps.newTreeMap();
requestMap.put("var", unReservedSet);

assertEquals(
"Reserved expansion must not escape chars from unreserved set according to rfc6570#section-3.2.3",
unReservedSet,
UriTemplate.expand("{+var}", requestMap, false));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Memo: Python's uritemplate agrees:

>>> a="-._~"; a == URITemplate("{+var}").expand(var=a)
True
>>> a=":/?#[]@!$&'()*+,;="; a == URITemplate("{+var}").expand(var=a)
True

}
}