Skip to content
Sign up

flagon-io/g1t

public
0
128 linesCodeBlameRaw
1/**
2 * The front door's rate limits (workers/app.ts), per request before it is
3 * answered. The bindings and their limits are in `RATE_LIMITS`
4 * (packages/contracts/src/rate-limits.ts); CONTRIBUTING.md, "Rate limits",
5 * says how they are kept.
6 *
7 * - Git over HTTPS: without credentials, by address; with them, by a hash
8 * of the credential, much higher. A clone is about three requests.
9 * - Pages: every request that reaches the Worker counts against a ceiling
10 * per address. Signed out, by address, with a tighter limit on what is
11 * costly to answer (archives, run pages, logs, search). Signed in, by a
12 * hash of the session cookie, higher: the session is not checked here,
13 * which would cost a call to identity, and the ceiling per address keeps
14 * made-up cookies from getting round the signed-out limit. With an
15 * access token (`Authorization: Bearer`, app/lib/website-token.ts), by a
16 * hash of the token, at the API's limit for a token; the address ceiling
17 * applies as for cookies.
18 *
19 * Static assets never reach the Worker (the assets binding answers them),
20 * and the few files it serves itself are left out here too. Every limit
21 * fails open.
22 */
23import {
24 type RateLimitBinding,
25 checkLimit,
26 clientAddress,
27 secretKey,
28 tooManyRequests,
29} from "@g1t/contracts/rate-limits";
30
31export type FrontDoorLimits = {
32 WEB_ANONYMOUS_LIMIT?: RateLimitBinding;
33 WEB_HEAVY_LIMIT?: RateLimitBinding;
34 WEB_SESSION_LIMIT?: RateLimitBinding;
35 WEB_ADDRESS_LIMIT?: RateLimitBinding;
36 WEB_TOKEN_LIMIT?: RateLimitBinding;
37 GIT_ANONYMOUS_LIMIT?: RateLimitBinding;
38 GIT_SIGNED_LIMIT?: RateLimitBinding;
39};
40
41/** Files the Worker serves that are never limited: build output, fonts, and top-level files such as robots.txt. */
42const UNLIMITED = /^\/(?:assets\/|fonts\/|favicon|[^/]+\.(?:ico|png|svg|txt|xml|webmanifest)$)/;
43
44/**
45 * What is costly to answer for a signed-out visitor: a repository's
46 * archives, a run's page, log downloads and artifacts, and search. A
47 * running job's live log (`actions/jobs/:job/log`, a small read the page
48 * makes about once a second) counts as a page: with the run's page
49 * refreshing beside it, it would use up this limit in half a minute.
50 */
51const HEAVY =
52 /^\/(?:search(?:\.data)?$|[^/]+\/[^/]+\/(?:archive\/|actions\/runs\/[^/]+(?:\.data|\/logs\.zip|\/artifacts\/[^/]+)?$|actions\/jobs\/[^/]+\/log\.txt$))/;
53
54export function unlimited(pathname: string): boolean {
55 return UNLIMITED.test(pathname);
56}
57
58export function heavy(pathname: string): boolean {
59 return HEAVY.test(pathname);
60}
61
62/** The session cookie's value, or null when signed out. */
63export function sessionCookie(cookie: string | null): string | null {
64 const match = /(?:^|;\s*)g1t_session=([^;]+)/.exec(cookie ?? "");
65 return match?.[1] ?? null;
66}
67
68const GIT_MESSAGE_ANONYMOUS =
69 "Too many git requests from your network. Wait a minute and try again, or use credentials for a higher limit: https://docs.g1t.sh/reference/rate-limits/\n";
70const GIT_MESSAGE_SIGNED = "Too many git requests with these credentials. Wait a minute and try again: https://docs.g1t.sh/reference/rate-limits/\n";
71const PAGE_MESSAGE = "Too many requests from your network. Wait a minute and try again.\n";
72const TOKEN_PAGE_MESSAGE = "Too many requests with this access token. Wait a minute and try again: https://docs.g1t.sh/reference/rate-limits/\n";
73
74/**
75 * The 429 for a git request past its limit, or null to go on. Git shows a
76 * plain-text answer's body to the person running it.
77 */
78export async function gitLimited(env: FrontDoorLimits, request: Request): Promise<Response | null> {
79 const credentials = request.headers.get("authorization");
80 if (credentials) {
81 const verdict = await checkLimit(env.GIT_SIGNED_LIMIT, await secretKey("git", credentials));
82 return verdict === "limited" ? tooManyRequests(GIT_MESSAGE_SIGNED) : null;
83 }
84 const verdict = await checkLimit(env.GIT_ANONYMOUS_LIMIT, `ip:${clientAddress(request)}`);
85 return verdict === "limited" ? tooManyRequests(GIT_MESSAGE_ANONYMOUS) : null;
86}
87
88/**
89 * The token in a page request's `Authorization: Bearer` header, or null
90 * (app/lib/website-token.ts). Not checked here either.
91 */
92export function websiteToken(authorization: string | null): string | null {
93 return /^\s*bearer\s+(\S+)\s*$/i.exec(authorization ?? "")?.[1] ?? null;
94}
95
96/** The 429 for a page or data request past its limit, or null to go on. */
97export async function pageLimited(env: FrontDoorLimits, request: Request, pathname: string): Promise<Response | null> {
98 if (unlimited(pathname)) return null;
99 const address = `ip:${clientAddress(request)}`;
100 const token = websiteToken(request.headers.get("authorization"));
101 const session = sessionCookie(request.headers.get("cookie"));
102 const checks: Promise<string>[] = [checkLimit(env.WEB_ADDRESS_LIMIT, address)];
103 if (token) {
104 // A token on the website: per token, as the API counts it.
105 checks.push(secretKey("token", token).then((key) => checkLimit(env.WEB_TOKEN_LIMIT, key)));
106 } else if (session) {
107 checks.push(secretKey("session", session).then((key) => checkLimit(env.WEB_SESSION_LIMIT, key)));
108 } else {
109 checks.push(checkLimit(env.WEB_ANONYMOUS_LIMIT, address));
110 if (heavy(pathname)) checks.push(checkLimit(env.WEB_HEAVY_LIMIT, address));
111 }
112 const verdicts = await Promise.all(checks);
113 if (!verdicts.includes("limited")) return null;
114 if (token && verdicts[1] === "limited") return tooManyRequests(TOKEN_PAGE_MESSAGE);
115 return tooManyRequests(token || session ? PAGE_MESSAGE : `${PAGE_MESSAGE.trimEnd()} Signed-in accounts have a higher limit.\n`);
116}
117
118/**
119 * The 429 for a repository file on the usercontent origin past its limit,
120 * or null to go on. Nothing there is signed in (it never sees the session
121 * cookie), so a file counts as a signed-out page from its address. Avatars
122 * and custom emoji are answered from cache and are not limited.
123 */
124export async function usercontentLimited(env: FrontDoorLimits, request: Request, path: string): Promise<Response | null> {
125 if (path.startsWith("/avatars/") || path.startsWith("/emoji/")) return null;
126 const verdict = await checkLimit(env.WEB_ANONYMOUS_LIMIT, `ip:${clientAddress(request)}`);
127 return verdict === "limited" ? tooManyRequests(PAGE_MESSAGE) : null;
128}