-
Notifications
You must be signed in to change notification settings - Fork 2.5k
/
cookies.ts
261 lines (234 loc) · 6.9 KB
/
cookies.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
import type { CookieParseOptions, CookieSerializeOptions } from "cookie";
import { parse, serialize } from "cookie";
import type { SignFunction, UnsignFunction } from "./crypto";
import { warnOnce } from "./warnings";
export type { CookieParseOptions, CookieSerializeOptions };
export interface CookieSignatureOptions {
/**
* An array of secrets that may be used to sign/unsign the value of a cookie.
*
* The array makes it easy to rotate secrets. New secrets should be added to
* the beginning of the array. `cookie.serialize()` will always use the first
* value in the array, but `cookie.parse()` may use any of them so that
* cookies that were signed with older secrets still work.
*/
secrets?: string[];
}
export type CookieOptions = CookieParseOptions &
CookieSerializeOptions &
CookieSignatureOptions;
/**
* A HTTP cookie.
*
* A Cookie is a logical container for metadata about a HTTP cookie; its name
* and options. But it doesn't contain a value. Instead, it has `parse()` and
* `serialize()` methods that allow a single instance to be reused for
* parsing/encoding multiple different values.
*
* @see https://remix.run/utils/cookies#cookie-api
*/
export interface Cookie {
/**
* The name of the cookie, used in the `Cookie` and `Set-Cookie` headers.
*/
readonly name: string;
/**
* True if this cookie uses one or more secrets for verification.
*/
readonly isSigned: boolean;
/**
* The Date this cookie expires.
*
* Note: This is calculated at access time using `maxAge` when no `expires`
* option is provided to `createCookie()`.
*/
readonly expires?: Date;
/**
* Parses a raw `Cookie` header and returns the value of this cookie or
* `null` if it's not present.
*/
parse(
cookieHeader: string | null,
options?: CookieParseOptions
): Promise<any>;
/**
* Serializes the given value to a string and returns the `Set-Cookie`
* header.
*/
serialize(value: any, options?: CookieSerializeOptions): Promise<string>;
}
export type CreateCookieFunction = (
name: string,
cookieOptions?: CookieOptions
) => Cookie;
/**
* Creates a logical container for managing a browser cookie from the server.
*
* @see https://remix.run/utils/cookies#createcookie
*/
export const createCookieFactory =
({
sign,
unsign,
}: {
sign: SignFunction;
unsign: UnsignFunction;
}): CreateCookieFunction =>
(name, cookieOptions = {}) => {
let { secrets = [], ...options } = {
path: "/",
sameSite: "lax" as const,
...cookieOptions,
};
warnOnceAboutExpiresCookie(name, options.expires);
return {
get name() {
return name;
},
get isSigned() {
return secrets.length > 0;
},
get expires() {
// Max-Age takes precedence over Expires
return typeof options.maxAge !== "undefined"
? new Date(Date.now() + options.maxAge * 1000)
: options.expires;
},
async parse(cookieHeader, parseOptions) {
if (!cookieHeader) return null;
let cookies = parse(cookieHeader, { ...options, ...parseOptions });
return name in cookies
? cookies[name] === ""
? ""
: await decodeCookieValue(unsign, cookies[name], secrets)
: null;
},
async serialize(value, serializeOptions) {
return serialize(
name,
value === "" ? "" : await encodeCookieValue(sign, value, secrets),
{
...options,
...serializeOptions,
}
);
},
};
};
export type IsCookieFunction = (object: any) => object is Cookie;
/**
* Returns true if an object is a Remix cookie container.
*
* @see https://remix.run/utils/cookies#iscookie
*/
export const isCookie: IsCookieFunction = (object): object is Cookie => {
return (
object != null &&
typeof object.name === "string" &&
typeof object.isSigned === "boolean" &&
typeof object.parse === "function" &&
typeof object.serialize === "function"
);
};
async function encodeCookieValue(
sign: SignFunction,
value: any,
secrets: string[]
): Promise<string> {
let encoded = encodeData(value);
if (secrets.length > 0) {
encoded = await sign(encoded, secrets[0]);
}
return encoded;
}
async function decodeCookieValue(
unsign: UnsignFunction,
value: string,
secrets: string[]
): Promise<any> {
if (secrets.length > 0) {
for (let secret of secrets) {
let unsignedValue = await unsign(value, secret);
if (unsignedValue !== false) {
return decodeData(unsignedValue);
}
}
return null;
}
return decodeData(value);
}
function encodeData(value: any): string {
return btoa(myUnescape(encodeURIComponent(JSON.stringify(value))));
}
function decodeData(value: string): any {
try {
return JSON.parse(decodeURIComponent(myEscape(atob(value))));
} catch (error: unknown) {
return {};
}
}
// See: https:/zloirock/core-js/blob/master/packages/core-js/modules/es.escape.js
function myEscape(value: string): string {
let str = value.toString();
let result = "";
let index = 0;
let chr, code;
while (index < str.length) {
chr = str.charAt(index++);
if (/[\w*+\-./@]/.exec(chr)) {
result += chr;
} else {
code = chr.charCodeAt(0);
if (code < 256) {
result += "%" + hex(code, 2);
} else {
result += "%u" + hex(code, 4).toUpperCase();
}
}
}
return result;
}
function hex(code: number, length: number): string {
let result = code.toString(16);
while (result.length < length) result = "0" + result;
return result;
}
// See: https:/zloirock/core-js/blob/master/packages/core-js/modules/es.unescape.js
function myUnescape(value: string): string {
let str = value.toString();
let result = "";
let index = 0;
let chr, part;
while (index < str.length) {
chr = str.charAt(index++);
if (chr === "%") {
if (str.charAt(index) === "u") {
part = str.slice(index + 1, index + 5);
if (/^[\da-f]{4}$/i.exec(part)) {
result += String.fromCharCode(parseInt(part, 16));
index += 5;
continue;
}
} else {
part = str.slice(index, index + 2);
if (/^[\da-f]{2}$/i.exec(part)) {
result += String.fromCharCode(parseInt(part, 16));
index += 2;
continue;
}
}
}
result += chr;
}
return result;
}
function warnOnceAboutExpiresCookie(name: string, expires?: Date) {
warnOnce(
!expires,
`The "${name}" cookie has an "expires" property set. ` +
`This will cause the expires value to not be updated when the session is committed. ` +
`Instead, you should set the expires value when serializing the cookie. ` +
`You can use \`commitSession(session, { expires })\` if using a session storage object, ` +
`or \`cookie.serialize("value", { expires })\` if you're using the cookie directly.`
);
}