/
unstable_signed_cookie.ts
110 lines (103 loc) · 3.33 KB
/
unstable_signed_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
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
import { decodeHex, encodeHex } from "../encoding/hex.ts";
const encoder = new TextEncoder();
function splitByLast(value: string, separator: string): [string, string] {
const index = value.lastIndexOf(separator);
return index === -1
? [value, ""]
: [value.slice(0, index), value.slice(index + 1)];
}
/**
* Returns a promise with the signed cookie value from the given cryptographic
* key.
*
* @example
* ```ts
* import { signCookie } from "https://deno.land/std@$STD_VERSION/http/unstable_signed_cookie.ts";
* import { setCookie } from "https://deno.land/std@$STD_VERSION/http/cookie.ts";
*
* const key = await crypto.subtle.generateKey(
* { name: "HMAC", hash: "SHA-256" },
* true,
* ["sign", "verify"],
* );
* const value = await signCookie("my-cookie-value", key);
*
* const headers = new Headers();
* setCookie(headers, {
* name: "my-cookie-name",
* value,
* });
*
* const cookieHeader = headers.get("set-cookie");
* ```
*/
export async function signCookie(
value: string,
key: CryptoKey,
): Promise<string> {
const data = encoder.encode(value);
const signature = await crypto.subtle.sign("HMAC", key, data);
const signatureHex = encodeHex(signature);
return `${value}.${signatureHex}`;
}
/**
* Returns a promise of a boolean indicating whether the signed cookie is valid.
*
* @example
* ```ts
* import { verifyCookie } from "https://deno.land/std@$STD_VERSION/http/unstable_signed_cookie.ts";
* import { getCookies } from "https://deno.land/std@$STD_VERSION/http/cookie.ts";
*
* const key = await crypto.subtle.generateKey(
* { name: "HMAC", hash: "SHA-256" },
* true,
* ["sign", "verify"],
* );
*
* const headers = new Headers({
* Cookie: "location=tokyo.37f7481039762eef5cd46669f93c0a3214dfecba7d0cdc0b0dc40036063fb22e",
* });
* const signedCookie = getCookies(headers)["location"];
* if (signedCookie === undefined) throw new Error("Cookie not found");
* await verifyCookie(signedCookie, key);
* ```
*/
export async function verifyCookie(
signedCookie: string,
key: CryptoKey,
): Promise<boolean> {
const [value, signatureHex] = splitByLast(signedCookie, ".");
if (!value || !signatureHex) return false;
const data = encoder.encode(value);
const signature = decodeHex(signatureHex);
return await crypto.subtle.verify("HMAC", key, signature, data);
}
/**
* Parses a signed cookie to get its value.
*
* Important: always verify the cookie using {@linkcode verifyCookie} first.
*
* @example
* ```ts
* import { verifyCookie, parseSignedCookie } from "https://deno.land/std@$STD_VERSION/http/unstable_signed_cookie.ts";
* import { getCookies } from "https://deno.land/std@$STD_VERSION/http/cookie.ts";
*
* const key = await crypto.subtle.generateKey(
* { name: "HMAC", hash: "SHA-256" },
* true,
* ["sign", "verify"],
* );
*
* const headers = new Headers({
* Cookie: "location=tokyo.37f7481039762eef5cd46669f93c0a3214dfecba7d0cdc0b0dc40036063fb22e",
* });
* const signedCookie = getCookies(headers)["location"];
* if (signedCookie === undefined) throw new Error("Cookie not found");
* await verifyCookie(signedCookie, key);
* const cookie = parseSignedCookie(signedCookie);
* ```
*/
export function parseSignedCookie(signedCookie: string): string {
return splitByLast(signedCookie, ".")[0];
}