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

Impl of the SameSite enum for NewCookie #4855

Merged
merged 2 commits into from
Sep 20, 2021
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
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2010, 2020 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2010, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
Expand Down Expand Up @@ -120,14 +120,15 @@ private static class MutableNewCookie {
boolean secure = false;
boolean httpOnly = false;
Date expiry = null;
NewCookie.SameSite sameSite = null;

public MutableNewCookie(String name, String value) {
this.name = name;
this.value = value;
}

public NewCookie getImmutableNewCookie() {
return new NewCookie(name, value, path, domain, version, comment, maxAge, expiry, secure, httpOnly);
return new NewCookie(name, value, path, domain, version, comment, maxAge, expiry, secure, httpOnly, sameSite);
}
}

Expand Down Expand Up @@ -163,6 +164,8 @@ public static NewCookie parseNewCookie(String header) {
cookie.version = Integer.parseInt(value);
} else if (param.startsWith("httponly")) {
cookie.httpOnly = true;
} else if (param.startsWith("samesite")) {
cookie.sameSite = NewCookie.SameSite.valueOf(value.toUpperCase());
} else if (param.startsWith("expires")) {
try {
cookie.expiry = HttpDateFormat.readDate(value + ", " + bites[++i]);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2010, 2020 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2010, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
Expand Down Expand Up @@ -73,6 +73,10 @@ public String toString(final NewCookie cookie) {
if (cookie.isHttpOnly()) {
b.append(";HttpOnly");
}
if (cookie.getSameSite() != null) {
b.append(";SameSite=");
b.append(cookie.getSameSite());
}
if (cookie.getExpiry() != null) {
b.append(";Expires=");
b.append(HttpDateFormat.getPreferredDateFormat().format(cookie.getExpiry()));
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/*
* Copyright (c) 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/

package org.glassfish.jersey.message.internal;

import jakarta.ws.rs.core.NewCookie;
import org.junit.Assert;
import org.junit.Test;

import java.util.Date;

public class NewCookieProviderTest {

private final NewCookie newCookie = new NewCookie(
"test",
"value",
"/",
"localhost",
1,
"comment",
60,
new Date(),
true,
true,
NewCookie.SameSite.STRICT
);

@Test
public void SameSiteTest() {
final NewCookieProvider provider = new NewCookieProvider();
final String newCookieString = provider.toString(newCookie);
Assert.assertTrue(newCookieString.contains("SameSite=STRICT"));
Assert.assertEquals(NewCookie.SameSite.STRICT, provider.fromString(newCookieString).getSameSite());
}

}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2013, 2020 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2013, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
Expand Down Expand Up @@ -37,14 +37,18 @@ public class CookiesParserTest {

@Test
public void testCaseInsensitiveNewCookieParams() throws Exception {
_testCaseInsensitiveNewCookieParams("expires", "max-age", "path", "domain", "comment", "version", "secure", "httponly");
_testCaseInsensitiveNewCookieParams("Expires", "Max-Age", "Path", "Domain", "Comment", "Version", "Secure", "HttpOnly");
_testCaseInsensitiveNewCookieParams("exPires", "max-aGe", "patH", "doMAin", "Comment", "vErsion", "secuRe", "httPonly");
_testCaseInsensitiveNewCookieParams("expires", "max-age", "path", "domain",
"comment", "version", "secure", "httponly", "samesite");
_testCaseInsensitiveNewCookieParams("Expires", "Max-Age", "Path", "Domain",
"Comment", "Version", "Secure", "HttpOnly", "SameSite");
_testCaseInsensitiveNewCookieParams("exPires", "max-aGe", "patH", "doMAin",
"Comment", "vErsion", "secuRe", "httPonly", "samEsite");
}

private void _testCaseInsensitiveNewCookieParams(final String expires, final String maxAge, final String path,
final String domain, final String comment, final String version,
final String secure, final String httpOnly) throws Exception {
final String secure, final String httpOnly, final String sameSite)
throws Exception {

final String header = "foo=bar;"
+ expires + "=Tue, 15 Jan 2013 21:47:38 GMT;"
Expand All @@ -54,7 +58,8 @@ private void _testCaseInsensitiveNewCookieParams(final String expires, final Str
+ comment + "=Testing;"
+ version + "=1;"
+ secure + ";"
+ httpOnly;
+ httpOnly + ";"
+ sameSite + "=STRICT";

final NewCookie cookie = CookiesParser.parseNewCookie(header);

Expand All @@ -69,5 +74,6 @@ private void _testCaseInsensitiveNewCookieParams(final String expires, final Str
assertThat(cookie.getVersion(), equalTo(1));
assertThat(cookie.isSecure(), is(true));
assertThat(cookie.isHttpOnly(), is(true));
assertThat(cookie.getSameSite(), equalTo(NewCookie.SameSite.STRICT));
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2014, 2020 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2014, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
Expand Down Expand Up @@ -187,6 +187,12 @@ public void testNewCookieToString() {
cookie = new NewCookie("fred", "flintstone", null, null, "a modern stonage family", 60, false);
expResult = "fred=flintstone;Version=1;Comment=\"a modern stonage family\";Max-Age=60";
assertEquals(expResult, cookie.toString());

cookie = new NewCookie("fred", "flintstone", null, null, 1,
"a modern stonage family", 60, null, false, false,
NewCookie.SameSite.STRICT);
expResult = "fred=flintstone;Version=1;Comment=\"a modern stonage family\";Max-Age=60;SameSite=STRICT";
assertEquals(expResult, cookie.toString());
}

@Test
Expand All @@ -209,6 +215,16 @@ public void testNewCookieValueOf() {
assertEquals(1, cookie.getVersion());
assertEquals(60, cookie.getMaxAge());
assertTrue(cookie.isSecure());

cookie = NewCookie.valueOf(
"fred=flintstone;Version=1;Comment=\"a modern stonage family\";Max-Age=60;Secure;SameSite=NONE");
assertEquals("fred", cookie.getName());
assertEquals("flintstone", cookie.getValue());
assertEquals("a modern stonage family", cookie.getComment());
assertEquals(1, cookie.getVersion());
assertEquals(60, cookie.getMaxAge());
assertTrue(cookie.isSecure());
assertEquals(NewCookie.SameSite.NONE, cookie.getSameSite());
}

}