Skip to content

Use percent encoding in OAuth according to rfc 5849 section 3.6 #1332

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

Merged
merged 3 commits into from
Jan 25, 2017
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 @@ -92,19 +92,19 @@ private String encodedParams(long oauthTimestamp, String nonce, List<Param> form
OAuthParameterSet allParameters = new OAuthParameterSet(allParametersSize);

// start with standard OAuth parameters we need
allParameters.add(KEY_OAUTH_CONSUMER_KEY, Utf8UrlEncoder.encodeQueryElement(consumerAuth.getKey()));
allParameters.add(KEY_OAUTH_NONCE, Utf8UrlEncoder.encodeQueryElement(nonce));
allParameters.add(KEY_OAUTH_CONSUMER_KEY, Utf8UrlEncoder.percentEncodeQueryElement(consumerAuth.getKey()));
allParameters.add(KEY_OAUTH_NONCE, Utf8UrlEncoder.percentEncodeQueryElement(nonce));
allParameters.add(KEY_OAUTH_SIGNATURE_METHOD, OAUTH_SIGNATURE_METHOD);
allParameters.add(KEY_OAUTH_TIMESTAMP, String.valueOf(oauthTimestamp));
if (userAuth.getKey() != null) {
allParameters.add(KEY_OAUTH_TOKEN, Utf8UrlEncoder.encodeQueryElement(userAuth.getKey()));
allParameters.add(KEY_OAUTH_TOKEN, Utf8UrlEncoder.percentEncodeQueryElement(userAuth.getKey()));
}
allParameters.add(KEY_OAUTH_VERSION, OAUTH_VERSION_1_0);

if (formParams != null) {
for (Param param : formParams) {
// formParams are not already encoded
allParameters.add(Utf8UrlEncoder.encodeQueryElement(param.getName()), Utf8UrlEncoder.encodeQueryElement(param.getValue()));
allParameters.add(Utf8UrlEncoder.percentEncodeQueryElement(param.getName()), Utf8UrlEncoder.percentEncodeQueryElement(param.getValue()));
}
}
if (queryParams != null) {
Expand Down Expand Up @@ -164,11 +164,11 @@ StringBuilder signatureBaseString(Request request, long oauthTimestamp, String n
StringBuilder sb = StringUtils.stringBuilder();
sb.append(request.getMethod()); // POST / GET etc (nothing to URL encode)
sb.append('&');
Utf8UrlEncoder.encodeAndAppendQueryElement(sb, baseUrl);
Utf8UrlEncoder.encodeAndAppendPercentEncoded(sb, baseUrl);

// and all that needs to be URL encoded (... again!)
sb.append('&');
Utf8UrlEncoder.encodeAndAppendQueryElement(sb, encodedParams);
Utf8UrlEncoder.encodeAndAppendPercentEncoded(sb, encodedParams);
return sb;
}

Expand All @@ -182,7 +182,7 @@ String calculateSignature(Request request, long oauthTimestamp, String nonce) {
return Base64.encode(rawSignature);
}

private String constructAuthHeader(String signature, String nonce, long oauthTimestamp) {
String constructAuthHeader(String signature, String nonce, long oauthTimestamp) {
StringBuilder sb = StringUtils.stringBuilder();
sb.append("OAuth ");
sb.append(KEY_OAUTH_CONSUMER_KEY).append("=\"").append(consumerAuth.getKey()).append("\", ");
Expand All @@ -193,23 +193,23 @@ private String constructAuthHeader(String signature, String nonce, long oauthTim

// careful: base64 has chars that need URL encoding:
sb.append(KEY_OAUTH_SIGNATURE).append("=\"");
Utf8UrlEncoder.encodeAndAppendQueryElement(sb, signature).append("\", ");
Utf8UrlEncoder.encodeAndAppendPercentEncoded(sb, signature).append("\", ");
sb.append(KEY_OAUTH_TIMESTAMP).append("=\"").append(oauthTimestamp).append("\", ");

// also: nonce may contain things that need URL encoding (esp. when using base64):
sb.append(KEY_OAUTH_NONCE).append("=\"");
Utf8UrlEncoder.encodeAndAppendQueryElement(sb, nonce);
Utf8UrlEncoder.encodeAndAppendPercentEncoded(sb, nonce);
sb.append("\", ");

sb.append(KEY_OAUTH_VERSION).append("=\"").append(OAUTH_VERSION_1_0).append("\"");
return sb.toString();
}

protected long generateTimestamp() {
long generateTimestamp() {
return System.currentTimeMillis() / 1000L;
}

protected String generateNonce() {
String generateNonce() {
byte[] nonceBuffer = NONCE_BUFFER.get();
ThreadLocalRandom.current().nextBytes(nonceBuffer);
// let's use base64 encoding over hex, slightly more compact than hex or decimals
Expand Down
10 changes: 10 additions & 0 deletions client/src/main/java/org/asynchttpclient/util/Utf8UrlEncoder.java
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,16 @@ public static StringBuilder encodeAndAppendFormElement(StringBuilder sb, CharSeq
return appendEncoded(sb, input, FORM_URL_ENCODED_SAFE_CHARS, true);
}

public static String percentEncodeQueryElement(String input) {
StringBuilder sb = new StringBuilder(input.length() + 6);
encodeAndAppendPercentEncoded(sb, input);
return sb.toString();
}

public static StringBuilder encodeAndAppendPercentEncoded(StringBuilder sb, CharSequence input) {
return appendEncoded(sb, input, RFC3986_UNRESERVED_CHARS, false);
}

private static StringBuilder lazyInitStringBuilder(CharSequence input, int firstNonUsAsciiPosition) {
StringBuilder sb = new StringBuilder(input.length() + 6);
for (int i = 0; i < firstNonUsAsciiPosition; i++) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -309,4 +309,22 @@ public void testWithStarQueryParameterValue() {
+ "oauth_version%3D1.0%26"//
+ "testvalue%3D%252A");
}

@Test
public void testSignatureGenerationWithAsteriskInPath() {
ConsumerKey consumer = new ConsumerKey("key", "secret");
String someNonce = "6ad17f97334700f3ec2df0631d5b7511";
long someTimestamp = 1469019732;
String urlWithAsterisksInPath = "http://example.com/oauth/example/*path/wi*th/asterisks*";

OAuthSignatureCalculator calc = new OAuthSignatureCalculator(consumer, new RequestToken(null, null));
final Request request = get(urlWithAsterisksInPath).build();

String expectedSignature = "cswi/v3ZqhVkTyy5MGqW841BxDA=";
String actualSignature = calc.calculateSignature(request, someTimestamp, someNonce);
assertEquals(actualSignature, expectedSignature);

String generatedAuthHeader = calc.constructAuthHeader(actualSignature, someNonce, someTimestamp);
assertTrue(generatedAuthHeader.contains("oauth_signature=\"cswi%2Fv3ZqhVkTyy5MGqW841BxDA%3D\""));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,12 @@ public void testBasics() {
assertEquals(Utf8UrlEncoder.encodeQueryElement("a&b"), "a%26b");
assertEquals(Utf8UrlEncoder.encodeQueryElement("a+b"), "a%2Bb");
}

@Test(groups = "standalone")
public void testPercentageEncoding() {
assertEquals(Utf8UrlEncoder.percentEncodeQueryElement("foobar"), "foobar");
assertEquals(Utf8UrlEncoder.percentEncodeQueryElement("foo*bar"), "foo%2Abar");
assertEquals(Utf8UrlEncoder.percentEncodeQueryElement("foo~b_ar"), "foo~b_ar");
}

}