deno.land / std@0.166.0 / http / cookie.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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.// Structured similarly to Go's cookie.go// https://github.com/golang/go/blob/master/src/net/http/cookie.go// This module is browser compatible.
import { assert } from "../_util/asserts.ts";import { toIMF } from "../datetime/mod.ts";
export interface Cookie { /** Name of the cookie. */ name: string; /** Value of the cookie. */ value: string; /** Expiration date of the cookie. */ expires?: Date | number; /** Max-Age of the Cookie. Max-Age must be an integer superior or equal to 0. */ maxAge?: number; /** Specifies those hosts to which the cookie will be sent. */ domain?: string; /** Indicates a URL path that must exist in the request. */ path?: string; /** Indicates if the cookie is made using SSL & HTTPS. */ secure?: boolean; /** Indicates that cookie is not accessible via JavaScript. */ httpOnly?: boolean; /** * Allows servers to assert that a cookie ought not to * be sent along with cross-site requests. */ sameSite?: "Strict" | "Lax" | "None"; /** Additional key value pairs with the form "key=value" */ unparsed?: string[];}
const FIELD_CONTENT_REGEXP = /^(?=[\x20-\x7E]*$)[^()@<>,;:\\"\[\]?={}\s]+$/;
function toString(cookie: Cookie): string { if (!cookie.name) { return ""; } const out: string[] = []; validateName(cookie.name); validateValue(cookie.name, cookie.value); out.push(`${cookie.name}=${cookie.value}`);
// Fallback for invalid Set-Cookie // ref: https://tools.ietf.org/html/draft-ietf-httpbis-cookie-prefixes-00#section-3.1 if (cookie.name.startsWith("__Secure")) { cookie.secure = true; } if (cookie.name.startsWith("__Host")) { cookie.path = "/"; cookie.secure = true; delete cookie.domain; }
if (cookie.secure) { out.push("Secure"); } if (cookie.httpOnly) { out.push("HttpOnly"); } if (typeof cookie.maxAge === "number" && Number.isInteger(cookie.maxAge)) { assert( cookie.maxAge >= 0, "Max-Age must be an integer superior or equal to 0", ); out.push(`Max-Age=${cookie.maxAge}`); } if (cookie.domain) { validateDomain(cookie.domain); out.push(`Domain=${cookie.domain}`); } if (cookie.sameSite) { out.push(`SameSite=${cookie.sameSite}`); } if (cookie.path) { validatePath(cookie.path); out.push(`Path=${cookie.path}`); } if (cookie.expires) { const { expires } = cookie; const dateString = toIMF( typeof expires === "number" ? new Date(expires) : expires, ); out.push(`Expires=${dateString}`); } if (cookie.unparsed) { out.push(cookie.unparsed.join("; ")); } return out.join("; ");}
/** * Validate Cookie Name. * @param name Cookie name. */function validateName(name: string | undefined | null) { if (name && !FIELD_CONTENT_REGEXP.test(name)) { throw new TypeError(`Invalid cookie name: "${name}".`); }}
/** * Validate Path Value. * See {@link https://tools.ietf.org/html/rfc6265#section-4.1.2.4}. * @param path Path value. */function validatePath(path: string | null) { if (path == null) { return; } for (let i = 0; i < path.length; i++) { const c = path.charAt(i); if ( c < String.fromCharCode(0x20) || c > String.fromCharCode(0x7E) || c == ";" ) { throw new Error( path + ": Invalid cookie path char '" + c + "'", ); } }}
/** * Validate Cookie Value. * See {@link https://tools.ietf.org/html/rfc6265#section-4.1}. * @param value Cookie value. */function validateValue(name: string, value: string | null) { if (value == null || name == null) return; for (let i = 0; i < value.length; i++) { const c = value.charAt(i); if ( c < String.fromCharCode(0x21) || c == String.fromCharCode(0x22) || c == String.fromCharCode(0x2c) || c == String.fromCharCode(0x3b) || c == String.fromCharCode(0x5c) || c == String.fromCharCode(0x7f) ) { throw new Error( "RFC2616 cookie '" + name + "' cannot contain character '" + c + "'", ); } if (c > String.fromCharCode(0x80)) { throw new Error( "RFC2616 cookie '" + name + "' can only have US-ASCII chars as value" + c.charCodeAt(0).toString(16), ); } }}
/** * Validate Cookie Domain. * See {@link https://datatracker.ietf.org/doc/html/rfc6265#section-4.1.2.3}. * @param domain Cookie domain. */function validateDomain(domain: string) { if (domain == null) { return; } const char1 = domain.charAt(0); const charN = domain.charAt(domain.length - 1); if (char1 == "-" || charN == "." || charN == "-") { throw new Error( "Invalid first/last char in cookie domain: " + domain, ); }}
/** * Parse cookies of a header * @param headers The headers instance to get cookies from * @return Object with cookie names as keys */export function getCookies(headers: Headers): Record<string, string> { const cookie = headers.get("Cookie"); if (cookie != null) { const out: Record<string, string> = {}; const c = cookie.split(";"); for (const kv of c) { const [cookieKey, ...cookieVal] = kv.split("="); assert(cookieKey != null); const key = cookieKey.trim(); out[key] = cookieVal.join("="); } return out; } return {};}
/** * Set the cookie header properly in the headers * @param headers The headers instance to set the cookie to * @param cookie Cookie to set */export function setCookie(headers: Headers, cookie: Cookie) { // Parsing cookie headers to make consistent set-cookie header // ref: https://tools.ietf.org/html/rfc6265#section-4.1.1 const v = toString(cookie); if (v) { headers.append("Set-Cookie", v); }}
/** * Set the cookie header with empty value in the headers to delete it * @param headers The headers instance to delete the cookie from * @param name Name of cookie * @param attributes Additional cookie attributes */export function deleteCookie( headers: Headers, name: string, attributes?: { path?: string; domain?: string },) { setCookie(headers, { name: name, value: "", expires: new Date(0), ...attributes, });}
function parseSetCookie(value: string): Cookie | null { const attrs = value .split(";") .map((attr) => attr .trim() .split("=") .map((keyOrValue) => keyOrValue.trim()) ); const cookie: Cookie = { name: attrs[0][0], value: attrs[0][1], };
for (const [key, value] of attrs.slice(1)) { switch (key.toLocaleLowerCase()) { case "expires": cookie.expires = new Date(value); break; case "max-age": cookie.maxAge = Number(value); if (cookie.maxAge < 0) { console.warn( "Max-Age must be an integer superior or equal to 0. Cookie ignored.", ); return null; } break; case "domain": cookie.domain = value; break; case "path": cookie.path = value; break; case "secure": cookie.secure = true; break; case "httponly": cookie.httpOnly = true; break; case "samesite": cookie.sameSite = value as Cookie["sameSite"]; break; default: if (!Array.isArray(cookie.unparsed)) { cookie.unparsed = []; } cookie.unparsed.push([key, value].join("=")); } } if (cookie.name.startsWith("__Secure-")) { /** This requirement is mentioned in https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie but not the RFC. */ if (!cookie.secure) { console.warn( "Cookies with names starting with `__Secure-` must be set with the secure flag. Cookie ignored.", ); return null; } } if (cookie.name.startsWith("__Host-")) { if (!cookie.secure) { console.warn( "Cookies with names starting with `__Host-` must be set with the secure flag. Cookie ignored.", ); return null; } if (cookie.domain !== undefined) { console.warn( "Cookies with names starting with `__Host-` must not have a domain specified. Cookie ignored.", ); return null; } if (cookie.path !== "/") { console.warn( "Cookies with names starting with `__Host-` must have path be `/`. Cookie has been ignored.", ); return null; } } return cookie;}
/** * Parse set-cookies of a header * @param headers The headers instance to get set-cookies from * @return List of cookies */export function getSetCookies(headers: Headers): Cookie[] { if (!headers.has("set-cookie")) { return []; } return [...headers.entries()] .filter(([key]) => key === "set-cookie") .map(([_, value]) => value) /** Parse each `set-cookie` header separately */ .map(parseSetCookie) /** Skip empty cookies */ .filter(Boolean) as Cookie[];}
std
Deno standard library
GitHub Repositorydenoland/deno_std
GitHub Stars
2457

Version Info

Tagged at
2 months ago