-
Notifications
You must be signed in to change notification settings - Fork 2.5k
/
cookies.ts
160 lines (140 loc) · 4.08 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
import type { CookieParseOptions, CookieSerializeOptions } from "cookie";
import { parse, serialize } from "cookie";
import { sign, unsign } from "cookie-signature";
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.
*/
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.
*
* See https://remix.run/dashboard/docs/cookies#signing-cookies
*/
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): any;
/**
* Serializes the given value to a string and returns the `Set-Cookie`
* header.
*/
serialize(value: any, options?: CookieSerializeOptions): string;
}
/**
* Creates and returns a new Cookie.
*/
export function createCookie(
name: string,
{ secrets = [], ...options }: CookieOptions = {}
): Cookie {
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;
},
parse(cookieHeader, parseOptions) {
if (!cookieHeader) return null;
let cookies = parse(cookieHeader, { ...options, ...parseOptions });
return name in cookies
? cookies[name] === ""
? ""
: decodeCookieValue(cookies[name], secrets)
: null;
},
serialize(value, serializeOptions) {
return serialize(
name,
value === "" ? "" : encodeCookieValue(value, secrets),
{
...options,
...serializeOptions
}
);
}
};
}
export function isCookie(object: any): object is Cookie {
return (
object != null &&
typeof object.name === "string" &&
typeof object.isSigned === "boolean" &&
typeof object.parse === "function" &&
typeof object.serialize === "function"
);
}
function encodeCookieValue(value: any, secrets: string[]): string {
let encoded = encodeData(value);
if (secrets.length > 0) {
encoded = sign(encoded, secrets[0]);
}
return encoded;
}
function decodeCookieValue(value: string, secrets: string[]): any {
if (secrets.length > 0) {
for (let secret of secrets) {
let unsignedValue = unsign(value, secret);
if (unsignedValue !== false) {
return decodeData(unsignedValue);
}
}
return null;
}
return decodeData(value);
}
function encodeData(value: any): string {
return btoa(JSON.stringify(value));
}
function decodeData(value: string): any {
try {
return JSON.parse(atob(value));
} catch (error) {
return {};
}
}
function btoa(b: string): string {
return Buffer.from(b, "binary").toString("base64");
}
function atob(a: string): string {
return Buffer.from(a, "base64").toString("binary");
}