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.

Sign up for GitHub

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

Jump to bottom

Loosen cookie name/value validation #210

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Loosen cookie name/value validation #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e408c70
Loosen cookie name/value validation
blakeembrey Nov 15, 2024
8c9f866
Add utf8 example to value test
blakeembrey Nov 15, 2024
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
11 changes: 8 additions & 3 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,11 @@
* tchar = "!" / "#" / "$" / "%" / "&" / "'" /
* "*" / "+" / "-" / "." / "^" / "_" /
* "`" / "|" / "~" / DIGIT / ALPHA
*
* Note: Allowing more characters - https://github.com/jshttp/cookie/issues/191
* Allow same range as cookie value, except `=`, which delimits end of name.
*/
const cookieNameRegExp = /^[!#$%&'*+\-.^_`|~0-9A-Za-z]+$/;
const cookieNameRegExp = /^[\u0021-\u003A\u003C\u003E-\u007E]+$/;

/**
* RegExp to match cookie-value in RFC 6265 sec 4.1.1
Expand All @@ -19,9 +22,11 @@ const cookieNameRegExp = /^[!#$%&'*+\-.^_`|~0-9A-Za-z]+$/;
* ; US-ASCII characters excluding CTLs,
* ; whitespace DQUOTE, comma, semicolon,
* ; and backslash
*
* Allowing more characters: https://github.com/jshttp/cookie/issues/191
* Comma, backslash, and DQUOTE are not part of the parsing algorithm.
*/
const cookieValueRegExp =
/^("?)[\u0021\u0023-\u002B\u002D-\u003A\u003C-\u005B\u005D-\u007E]*\1$/;
const cookieValueRegExp = /^[\u0021-\u003A\u003C-\u007E]*$/;

/**
* RegExp to match domain-value in RFC 6265 sec 4.1.1
Expand Down
174 changes: 82 additions & 92 deletions src/serialize.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,91 +14,80 @@ describe("cookie.serialize(name, value)", function () {
expect(cookie.serialize("foo", "")).toEqual("foo=");
});

it("should serialize valid name", function () {
var validNames = [
"foo",
"foo!bar",
"foo#bar",
"foo$bar",
"foo'bar",
"foo*bar",
"foo+bar",
"foo-bar",
"foo.bar",
"foo^bar",
"foo_bar",
"foo`bar",
"foo|bar",
"foo~bar",
"foo7bar",
];

validNames.forEach(function (name) {
expect(cookie.serialize(name, "baz")).toEqual(name + "=baz");
});
it.each([
["foo"],
["foo,bar"],
["foo!bar"],
["foo#bar"],
["foo$bar"],
["foo'bar"],
["foo*bar"],
["foo+bar"],
["foo-bar"],
["foo.bar"],
["foo^bar"],
["foo_bar"],
["foo`bar"],
["foo|bar"],
["foo~bar"],
["foo7bar"],
["foo/bar"],
["foo@bar"],
["foo[bar"],
["foo]bar"],
["foo:bar"],
["foo{bar"],
["foo}bar"],
['foo"bar'],
["foo<bar"],
["foo>bar"],
["foo?bar"],
["foo\\bar"],
])("should serialize name: %s", (name) => {
expect(cookie.serialize(name, "baz")).toEqual(`${name}=baz`);
});

it("should throw for invalid name", function () {
var invalidNames = [
"foo\n",
"foo\u280a",
"foo/foo",
"foo,foo",
"foo;foo",
"foo@foo",
"foo[foo]",
"foo?foo",
"foo:foo",
"foo{foo}",
"foo foo",
"foo\tfoo",
'foo"foo',
"foo<script>foo",
];

invalidNames.forEach(function (name) {
expect(cookie.serialize.bind(cookie, name, "bar")).toThrow(
/argument name is invalid/,
);
});
it.each([
["foo\n"],
["foo\u280a"],
["foo=bar"],
["foo;bar"],
["foo bar"],
["foo\tbar"],
])("should throw for invalid name: %s", (name) => {
expect(() => cookie.serialize(name, "bar")).toThrow(
/argument name is invalid/,
);
});
});

describe("cookie.serialize(name, value, options)", function () {
describe('with "domain" option', function () {
it("should serialize valid domain", function () {
var validDomains = [
"example.com",
"sub.example.com",
".example.com",
"localhost",
".localhost",
"my-site.org",
"localhost",
];

validDomains.forEach(function (domain) {
expect(cookie.serialize("foo", "bar", { domain: domain })).toEqual(
"foo=bar; Domain=" + domain,
);
});
it.each([
["example.com"],
["sub.example.com"],
[".example.com"],
["localhost"],
[".localhost"],
["my-site.org"],
["localhost"],
])("should serialize domain: %s", (domain) => {
expect(cookie.serialize("foo", "bar", { domain })).toEqual(
`foo=bar; Domain=${domain}`,
);
});

it("should throw for invalid domain", function () {
var invalidDomains = [
"example.com\n",
"sub.example.com\u0000",
"my site.org",
"domain..com",
"example.com; Path=/",
"example.com /* inject a comment */",
];

invalidDomains.forEach(function (domain) {
expect(
cookie.serialize.bind(cookie, "foo", "bar", { domain: domain }),
).toThrow(/option domain is invalid/);
});
it.each([
["example.com\n"],
["sub.example.com\u0000"],
["my site.org"],
["domain..com"],
["example.com; Path=/"],
["example.com /* inject a comment */"],
])("should throw for invalid domain: %s", (domain) => {
expect(() => cookie.serialize("foo", "bar", { domain })).toThrow(
/option domain is invalid/,
);
});
});

Expand All @@ -113,22 +102,23 @@ describe("cookie.serialize(name, value, options)", function () {
).toEqual("foo=YmFy");
});

it("should throw when returned value is invalid", function () {
expect(
cookie.serialize.bind(cookie, "foo", "+ \n", {
encode: function (v) {
return v;
},
}),
).toThrow(/argument val is invalid/);
expect(
cookie.serialize.bind(cookie, "foo", "foo bar", {
encode: function (v) {
return v;
},
}),
).toThrow(/argument val is invalid/);
});
it.each(["foo=bar", 'foo"bar', "foo,bar", "foo\\bar", "foo$bar"])(
"should serialize value: %s",
(value) => {
expect(cookie.serialize("foo", value, { encode: (x) => x })).toEqual(
`foo=${value}`,
);
},
);

it.each([["+\n"], ["foo bar"], ["foo\tbar"], ["foo;bar"], ["foo\u280a"]])(
"should throw for invalid value: %s",
(value) => {
expect(() =>
cookie.serialize("foo", value, { encode: (x) => x }),
).toThrow(/argument val is invalid/);
},
);
});

describe('with "expires" option', function () {
Expand Down