From 9e305c99b2effe5185577b14320e67b61cbc2ab1 Mon Sep 17 00:00:00 2001 From: Thomas Lutz Date: Thu, 28 Feb 2019 13:22:36 +0100 Subject: [PATCH 1/6] Fix #14: Decoding fails when two encoded characters appear one after another --- .../github/jscookie/javacookie/Cookies.java | 39 ++++++++++--------- .../test/unit/CookiesDecodingTest.java | 8 ++++ 2 files changed, 29 insertions(+), 18 deletions(-) diff --git a/src/main/java/com/github/jscookie/javacookie/Cookies.java b/src/main/java/com/github/jscookie/javacookie/Cookies.java index a8abe7f..054524f 100644 --- a/src/main/java/com/github/jscookie/javacookie/Cookies.java +++ b/src/main/java/com/github/jscookie/javacookie/Cookies.java @@ -296,17 +296,16 @@ private String encode( String decoded, Set exceptions ) { String character = new String( Character.toChars( codePoint ) ); CharArrayWriter hexSequence = new CharArrayWriter(); byte[] bytes = character.getBytes( UTF_8 ); - for ( int bytesIndex = 0; bytesIndex < bytes.length; bytesIndex++ ) { - char left = Character.forDigit( bytes[ bytesIndex ] >> 4 & 0xF, 16 ); - char right = Character.forDigit( bytes[ bytesIndex ] & 0xF, 16 ); + for (byte aByte : bytes) { + char left = Character.forDigit(aByte >> 4 & 0xF, 16); + char right = Character.forDigit(aByte & 0xF, 16); hexSequence - .append( '%' ) - .append( left ) - .append( right ); + .append('%') + .append(left) + .append(right); } - String target = character.toString(); String sequence = hexSequence.toString().toUpperCase(); - encoded = encoded.replace( target, sequence ); + encoded = encoded.replace(character, sequence ); } catch ( UnsupportedEncodingException e ) { e.printStackTrace(); } @@ -314,9 +313,14 @@ private String encode( String decoded, Set exceptions ) { return encoded; } - private String decode( String encoded ) { + private String decode(String encoded) { + // Decode characters with 3 bytes first, then with 1 byte to fix https://github.com/js-cookie/java-cookie/issues/14 + return decode( decode( encoded, 3 ), 1 ); + } + + private String decode( String encoded, Integer bytesPerCharacter ) { String decoded = encoded; - Pattern pattern = Pattern.compile( "(%[0-9A-Z]{2})+" ); + Pattern pattern = Pattern.compile( "(%[0-9A-Z]{2}){" + bytesPerCharacter + "}" ); Matcher matcher = pattern.matcher( encoded ); while ( matcher.find() ) { String encodedChar = matcher.group(); @@ -392,14 +396,13 @@ private String decodeValue( String encodedValue, String decodedName ) { private Map getCookies( String cookieHeader ) { Map result = new HashMap(); String[] cookies = cookieHeader.split( "; " ); - for ( int i = 0; i < cookies.length; i++ ) { - String cookie = cookies[ i ]; - String encodedName = cookie.split( "=" )[ 0 ]; - String decodedName = decode( encodedName ); - - String encodedValue = cookie.substring( cookie.indexOf( '=' ) + 1, cookie.length() ); - String decodedValue = decodeValue( encodedValue, decodedName ); - result.put( decodedName, decodedValue ); + for (String cookie : cookies) { + String encodedName = cookie.split("=")[0]; + String decodedName = decode(encodedName); + + String encodedValue = cookie.substring(cookie.indexOf('=') + 1); + String decodedValue = decodeValue(encodedValue, decodedName); + result.put(decodedName, decodedValue); } return result; } diff --git a/src/test/java/com/github/jscookie/javacookie/test/unit/CookiesDecodingTest.java b/src/test/java/com/github/jscookie/javacookie/test/unit/CookiesDecodingTest.java index ef5150c..d8565ec 100644 --- a/src/test/java/com/github/jscookie/javacookie/test/unit/CookiesDecodingTest.java +++ b/src/test/java/com/github/jscookie/javacookie/test/unit/CookiesDecodingTest.java @@ -34,4 +34,12 @@ public void character_with_3_bytes() { String expected = "京"; Assert.assertEquals( expected, actual ); } + + @Test + public void two_encoded_characters() { + Mockito.when(request.getHeader("cookie")).thenReturn("c=New%20York%2C%20NY"); + String actual = cookies.get("c"); + String expected = "New York, NY"; + Assert.assertEquals(expected, actual); + } } From 68dbd8f555187f3b6b57bde1ad6c3b96ce65c302 Mon Sep 17 00:00:00 2001 From: Thomas Lutz Date: Tue, 23 Mar 2021 16:01:27 +0100 Subject: [PATCH 2/6] Bump dependencies to make integration tests work (newest Selenium) --- package-lock.json | 29 +++++++++++++++++++++++++---- package.json | 2 +- pom.xml | 17 ++++++++--------- 3 files changed, 34 insertions(+), 14 deletions(-) diff --git a/package-lock.json b/package-lock.json index 68eb935..b064f78 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,13 +1,34 @@ { "name": "java-cookie", "version": "1.0.0", - "lockfileVersion": 1, + "lockfileVersion": 2, "requires": true, + "packages": { + "": { + "version": "1.0.0", + "license": "MIT", + "devDependencies": { + "bower": "1.8.12" + } + }, + "node_modules/bower": { + "version": "1.8.12", + "resolved": "https://registry.npmjs.org/bower/-/bower-1.8.12.tgz", + "integrity": "sha512-u1xy9SrwwoPlgjuHNjhV+YUPVdqyBj2ALBxuzeIUKXaPI2i2xypGgxqXkuHcITGdi5yBj5JuXgyMvgiWiS1S3Q==", + "dev": true, + "bin": { + "bower": "bin/bower" + }, + "engines": { + "node": ">=0.10.0" + } + } + }, "dependencies": { "bower": { - "version": "1.8.8", - "resolved": "https://registry.npmjs.org/bower/-/bower-1.8.8.tgz", - "integrity": "sha512-1SrJnXnkP9soITHptSO+ahx3QKp3cVzn8poI6ujqc5SeOkg5iqM1pK9H+DSc2OQ8SnO0jC/NG4Ur/UIwy7574A==", + "version": "1.8.12", + "resolved": "https://registry.npmjs.org/bower/-/bower-1.8.12.tgz", + "integrity": "sha512-u1xy9SrwwoPlgjuHNjhV+YUPVdqyBj2ALBxuzeIUKXaPI2i2xypGgxqXkuHcITGdi5yBj5JuXgyMvgiWiS1S3Q==", "dev": true } } diff --git a/package.json b/package.json index 81a3c55..544201c 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "url": "https://github.com/js-cookie/java-cookie.git" }, "devDependencies": { - "bower": "1.8.8" + "bower": "1.8.12" }, "scripts": { "test": "cd bower_components/js-cookie && ../../node/node \"../../node/node_modules/npm/bin/npm-cli.js\" install" diff --git a/pom.xml b/pom.xml index cfeb657..9e53045 100644 --- a/pom.xml +++ b/pom.xml @@ -10,7 +10,7 @@ UTF-8 UTF-8 - 2.45.0 + 3.141.59 20.0.1.Final java-cookie-scm 1.8 @@ -86,17 +86,17 @@ joda-time joda-time - 2.10.6 + 2.10.10 com.fasterxml.jackson.core jackson-databind - 2.11.2 + 2.12.2 junit junit - 4.13.1 + 4.13.2 test @@ -150,13 +150,13 @@ org.apache.httpcomponents httpclient - 4.5.12 + 4.5.13 test org.apache.httpcomponents fluent-hc - 4.5.12 + 4.5.13 test @@ -208,7 +208,7 @@ com.github.eirslett frontend-maven-plugin - 1.10.0 + 1.11.2 install node and npm @@ -216,8 +216,7 @@ install-node-and-npm - v12.18.2 - + v15.6.0 From 88b832788c9e5fc46ba13da2db2834bbcff199ec Mon Sep 17 00:00:00 2001 From: Thomas Lutz Date: Tue, 23 Mar 2021 16:14:43 +0100 Subject: [PATCH 3/6] Add unit test for 2 bytes character en/decoding, consider debug value in integration test --- .../test/integration/encoding/CookiesEncodingIT.java | 8 +++++--- .../javacookie/test/unit/CookiesDecodingTest.java | 8 ++++++++ .../javacookie/test/unit/CookiesEncodingTest.java | 6 ++++++ 3 files changed, 19 insertions(+), 3 deletions(-) diff --git a/src/test/java/com/github/jscookie/javacookie/test/integration/encoding/CookiesEncodingIT.java b/src/test/java/com/github/jscookie/javacookie/test/integration/encoding/CookiesEncodingIT.java index 9ae05f8..5c91d2d 100644 --- a/src/test/java/com/github/jscookie/javacookie/test/integration/encoding/CookiesEncodingIT.java +++ b/src/test/java/com/github/jscookie/javacookie/test/integration/encoding/CookiesEncodingIT.java @@ -44,9 +44,11 @@ public static Archive createDeployment() { "web.xml" ); - System.out.println( " ----- LOGGING THE FILES ADDED TO JBOSS" ); - System.out.println( war.toString( true ) ); - System.out.println( " ----- END OF LOGGING THE FILES ADDED TO JBOSS" ); + if(debug.is(true)) { + System.out.println(" ----- LOGGING THE FILES ADDED TO JBOSS"); + System.out.println(war.toString(true)); + System.out.println(" ----- END OF LOGGING THE FILES ADDED TO JBOSS"); + } return war; } diff --git a/src/test/java/com/github/jscookie/javacookie/test/unit/CookiesDecodingTest.java b/src/test/java/com/github/jscookie/javacookie/test/unit/CookiesDecodingTest.java index d8565ec..2391a13 100644 --- a/src/test/java/com/github/jscookie/javacookie/test/unit/CookiesDecodingTest.java +++ b/src/test/java/com/github/jscookie/javacookie/test/unit/CookiesDecodingTest.java @@ -27,6 +27,14 @@ public void character_not_allowed_in_name_and_value() { Assert.assertEquals( expected, actual ); } + @Test + public void character_with_2_bytes() { + Mockito.when( request.getHeader( "cookie" ) ).thenReturn( "c=%C3%A3" ); + String actual = cookies.get( "c" ); + String expected = "ã"; + Assert.assertEquals( expected, actual ); + } + @Test public void character_with_3_bytes() { Mockito.when( request.getHeader( "cookie" ) ).thenReturn( "c=%E4%BA%AC" ); diff --git a/src/test/java/com/github/jscookie/javacookie/test/unit/CookiesEncodingTest.java b/src/test/java/com/github/jscookie/javacookie/test/unit/CookiesEncodingTest.java index bb6681d..86e4011 100644 --- a/src/test/java/com/github/jscookie/javacookie/test/unit/CookiesEncodingTest.java +++ b/src/test/java/com/github/jscookie/javacookie/test/unit/CookiesEncodingTest.java @@ -36,6 +36,12 @@ public void characters_allowed_in_name_and_value() { ); } + @Test + public void character_with_2_bytes_in_value() { + cookies.set( "c", "ã" ); + Mockito.verify( response ).addHeader( "Set-Cookie", "c=%C3%A3; Path=/" ); + } + @Test public void character_with_3_bytes_in_value() { cookies.set( "c", "京" ); From 60305be9e250d82faae6cee8a2325e7af17527c4 Mon Sep 17 00:00:00 2001 From: Thomas Lutz Date: Tue, 26 Oct 2021 12:39:55 +0200 Subject: [PATCH 4/6] Use URLDecoder to fix decoding, bump joda-time and jackson-databind dependencies --- pom.xml | 4 +- .../github/jscookie/javacookie/Cookies.java | 40 +++++-------------- 2 files changed, 13 insertions(+), 31 deletions(-) diff --git a/pom.xml b/pom.xml index 9e53045..c2f8cfd 100644 --- a/pom.xml +++ b/pom.xml @@ -86,12 +86,12 @@ joda-time joda-time - 2.10.10 + 2.10.12 com.fasterxml.jackson.core jackson-databind - 2.12.2 + 2.13.0 junit diff --git a/src/main/java/com/github/jscookie/javacookie/Cookies.java b/src/main/java/com/github/jscookie/javacookie/Cookies.java index 0f88a2c..ff1930d 100644 --- a/src/main/java/com/github/jscookie/javacookie/Cookies.java +++ b/src/main/java/com/github/jscookie/javacookie/Cookies.java @@ -1,23 +1,21 @@ package com.github.jscookie.javacookie; +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.type.TypeReference; +import com.fasterxml.jackson.databind.ObjectMapper; + +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; import java.io.CharArrayWriter; import java.io.IOException; import java.io.UnsupportedEncodingException; +import java.net.URLDecoder; import java.util.HashMap; import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.ResourceBundle; import java.util.Set; -import java.util.regex.Matcher; -import java.util.regex.Pattern; - -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; - -import com.fasterxml.jackson.core.JsonProcessingException; -import com.fasterxml.jackson.core.type.TypeReference; -import com.fasterxml.jackson.databind.ObjectMapper; public final class Cookies implements CookiesDefinition { private static String UTF_8 = "UTF-8"; @@ -325,28 +323,12 @@ private String encode( String decoded, Set exceptions ) { } private String decode(String encoded) { - // Decode characters with 3 bytes first, then with 1 byte to fix https://github.com/js-cookie/java-cookie/issues/14 - return decode( decode( encoded, 3 ), 1 ); - } - - private String decode( String encoded, Integer bytesPerCharacter ) { + // Use URLDecoder to fix https://github.com/js-cookie/java-cookie/issues/14 String decoded = encoded; - Pattern pattern = Pattern.compile( "(%[0-9A-Z]{2}){" + bytesPerCharacter + "}" ); - Matcher matcher = pattern.matcher( encoded ); - while ( matcher.find() ) { - String encodedChar = matcher.group(); - String[] encodedBytes = encodedChar.split( "%" ); - byte[] bytes = new byte[ encodedBytes.length - 1 ]; - for ( int i = 1; i < encodedBytes.length; i++ ) { - String encodedByte = encodedBytes[ i ]; - bytes[ i - 1 ] = ( byte )Integer.parseInt( encodedByte, 16 ); - } - try { - String decodedChar = new String( bytes, UTF_8 ); - decoded = decoded.replace( encodedChar, decodedChar ); - } catch ( UnsupportedEncodingException e ) { + try { + decoded = URLDecoder.decode(encoded, UTF_8); + } catch ( UnsupportedEncodingException e) { e.printStackTrace(); - } } return decoded; } From 7c248ef50077df2e28201d83c9765e9f125f4170 Mon Sep 17 00:00:00 2001 From: Jevin Menezes Date: Thu, 4 Nov 2021 19:22:27 +0530 Subject: [PATCH 5/6] Update for travis-ci trigger --- .travis.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.travis.yml b/.travis.yml index 4b15092..2d9031e 100644 --- a/.travis.yml +++ b/.travis.yml @@ -12,3 +12,4 @@ jdk: - openjdk12 - openjdk13 - openjdk14 + - openjdk15 From 6471c69071b8c139de55fab058f815da09d046be Mon Sep 17 00:00:00 2001 From: Jevin Menezes Date: Thu, 4 Nov 2021 19:29:23 +0530 Subject: [PATCH 6/6] Update .travis.yml --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 2d9031e..5f75071 100644 --- a/.travis.yml +++ b/.travis.yml @@ -12,4 +12,4 @@ jdk: - openjdk12 - openjdk13 - openjdk14 - - openjdk15 +