Skip to content

Commit 7539a9b

Browse files
petebacondarwinpetebacondarwin
authored
[workers-auth] Extract OAuth 2.0 + PKCE flow into a new package (#14121)
1 parent b502d54 commit 7539a9b

42 files changed

Lines changed: 2688 additions & 1604 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.changeset/extract-workers-auth-oauth-flow.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
"wrangler": patch
3+
"@cloudflare/workers-auth": patch
4+
---
5+
6+
Extract the OAuth 2.0 + PKCE flow into a new `@cloudflare/workers-auth` package.
7+
8+
The OAuth login / logout / refresh logic, the auth-config TOML file IO, the OAuth token exchange + local callback server, and the Cloudflare Access detection helpers that previously lived in `packages/wrangler/src/user/` have moved to the new internal-only `@cloudflare/workers-auth` package. Wrangler now wires the OAuth flow up via a small glue module that injects its logger, browser opener, interactivity detector, and config cache via a dependency- injection context.
9+
10+
What stays in wrangler:
11+
12+
- The yargs `login` / `logout` / `whoami` / `auth token` commands
13+
- Environment-based credential resolution (`CLOUDFLARE_API_TOKEN`, `CLOUDFLARE_API_KEY` / `CLOUDFLARE_EMAIL`, etc.)
14+
- Cloudflare account selection (`requireAuth`, `getOrSelectAccountId`)
15+
- The OAuth scope catalog (passed into the OAuth flow as a generic `string[]`)
16+
- `whoami` / account fetching
17+
18+
No behavior change for end users. The on-disk TOML format and location remain identical, and all telemetry message labels are preserved verbatim.
19+
20+
`@cloudflare/workers-auth` is published with `prerelease: true` and is not intended for external use — its APIs may change without notice.

‎packages/workers-auth/AGENTS.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# AGENTS.md — workers-auth
2+
3+
OAuth-2.0-with-PKCE flow against Cloudflare's `dash.cloudflare.com` (or staging /
4+
custom-overridden) endpoints. Used by wrangler and (in future) other Cloudflare
5+
CLIs. Internal-only — published as `prerelease: true`.
6+
7+
## STRUCTURE
8+
9+
- `src/pkce.ts` — PKCE code-verifier / code-challenge generation (RFC 7636)
10+
- `src/errors.ts` — `ErrorOAuth2` class hierarchy + `toErrorClass` mapper
11+
- `src/generate-auth-url.ts` — authorize URL builder + `OAUTH_CALLBACK_URL`
12+
- `src/generate-random-state.ts` — CSRF state generator
13+
- `src/env-vars.ts` — `WRANGLER_*` env-var getters for OAuth endpoints
14+
- `src/access.ts` — Cloudflare Access detection + service-token / `cloudflared` headers
15+
- `src/auth-config-file.ts` — read/write the persisted TOML at `<globalWranglerConfigPath>/config/<env>.toml`
16+
- `src/state.ts` — `readStoredAuthState()` + `StoredAuthState` shape
17+
- `src/token-exchange.ts` — auth-code → token + refresh-token rotation + `fetchAuthToken`
18+
- `src/callback-server.ts` — local HTTP server on `localhost:8976` for the OAuth callback
19+
- `src/flow.ts` — `createOAuthFlow(ctx)` factory wiring everything together
20+
- `src/context.ts` — `OAuthFlowContext` interface (DI surface)
21+
- `src/test-helpers/` — MSW handlers for consumers' tests (`@cloudflare/workers-auth/test-helpers`)
22+
23+
## DI SURFACE
24+
25+
`createOAuthFlow(ctx)` accepts a context object:
26+
27+
- `logger` — drop-in replacement for wrangler's logger singleton
28+
- `isNonInteractiveOrCI()` — whether to suppress interactive prompts
29+
- `openInBrowser(url)` — opens the browser to the OAuth authorize URL
30+
- `hasEnvCredentials()` — short-circuits refresh logic when env-based auth is set
31+
- `purgeOnLoginOrLogout()` — invalidate consumer-side caches after login/logout
32+
- `generateAuthUrl?` / `generateRandomState?` — test overrides for deterministic
33+
snapshot tests (defaults pull from `./generate-auth-url` / `./generate-random-state`)
34+
35+
Wrangler wires this once in `packages/wrangler/src/user/user.ts`.
36+
37+
## CONVENTIONS
38+
39+
- License: dual MIT/Apache-2.0. Files derived from
40+
[BitySA/oauth2-auth-code-pkce](https://github.com/BitySA/oauth2-auth-code-pkce)
41+
carry the Apache-2.0 header.
42+
- No `console.*` — use the injected `ctx.logger`.
43+
- No global `fetch` — use undici's `fetch`.
44+
- `UserError` instances must carry stable `telemetryMessage` labels
45+
(`<area> <sub-area> <failure>`, e.g. `user oauth invalid scope`).
46+
These labels are part of the telemetry contract — preserve them verbatim.
47+
- No direct Cloudflare REST API calls. This package talks to OAuth endpoints
48+
(`/oauth2/auth`, `/oauth2/token`, `/oauth2/revoke`) only.
49+
- OAuth callback server listens on `localhost:8976` by default; override via
50+
`LoginProps.callbackHost` / `callbackPort` per-call.
51+
52+
## BUILD
53+
54+
- tsup: two entry points — `src/index.ts` and `src/test-helpers/index.ts`
55+
- ESM-only output to `dist/`
56+
- `@cloudflare/*`, `undici`, `msw`, and `vitest` are kept external

‎packages/workers-auth/LICENSE-APACHE‎

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

‎packages/workers-auth/LICENSE-MIT‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Copyright (c) 2020 Cloudflare, Inc. <wrangler@cloudflare.com>
2+
3+
Permission is hereby granted, free of charge, to any
4+
person obtaining a copy of this software and associated
5+
documentation files (the "Software"), to deal in the
6+
Software without restriction, including without
7+
limitation the rights to use, copy, modify, merge,
8+
publish, distribute, sublicense, and/or sell copies of
9+
the Software, and to permit persons to whom the Software
10+
is furnished to do so, subject to the following
11+
conditions:
12+
13+
The above copyright notice and this permission notice
14+
shall be included in all copies or substantial portions
15+
of the Software.
16+
17+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
18+
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
19+
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
20+
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
21+
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
22+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
24+
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25+
DEALINGS IN THE SOFTWARE.

‎packages/workers-auth/README.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# @cloudflare/workers-auth
2+
3+
Internal OAuth 2.0 + PKCE flow for Cloudflare CLIs (wrangler and friends).
4+
5+
> **Not intended for external use.** APIs may change without notice. This package
6+
> is consumed only by other packages inside this monorepo.
7+
8+
## What's in this package
9+
10+
- OAuth 2.0 Authorization Code flow with PKCE (RFC 6749 + RFC 7636)
11+
- Cloudflare-flavored OAuth endpoints (`dash.cloudflare.com` / staging / `WRANGLER_*` overrides)
12+
- Cloudflare Access detection + service-token / `cloudflared` integration for staging auth domains
13+
- Persistent auth state stored as TOML in `<globalWranglerConfigPath>/config/<env>.toml`
14+
- `login`, `logout`, `loginOrRefreshIfRequired`, `getOauthToken`, `getOAuthTokenFromLocalState`
15+
16+
What's **not** here (lives in wrangler):
17+
18+
- yargs `login` / `logout` / `whoami` / `auth token` commands
19+
- Environment-based credential resolution (`CLOUDFLARE_API_TOKEN`, etc.)
20+
- Cloudflare account selection (`requireAuth`, `getOrSelectAccountId`)
21+
- The scope catalog (passed in as `string[]`)
22+
- `whoami` / account fetching
23+
24+
## Attribution
25+
26+
Portions of this package are derived from
27+
[BitySA/oauth2-auth-code-pkce](https://github.com/BitySA/oauth2-auth-code-pkce),
28+
licensed under the Apache License 2.0. See the individual file headers for
29+
the attribution and `LICENSE` for the full text.
30+
31+
The rest of the package is MIT-licensed.

‎packages/workers-auth/package.json‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
{
2+
"name": "@cloudflare/workers-auth",
3+
"version": "0.0.0",
4+
"description": "Internal OAuth 2.0 + PKCE flow for Cloudflare CLIs. Not intended for external use — APIs may change without notice.",
5+
"homepage": "https://github.com/cloudflare/workers-sdk/tree/main/packages/workers-auth#readme",
6+
"bugs": {
7+
"url": "https://github.com/cloudflare/workers-sdk/issues"
8+
},
9+
"license": "MIT OR Apache-2.0",
10+
"author": "workers-devprod@cloudflare.com",
11+
"repository": {
12+
"type": "git",
13+
"url": "https://github.com/cloudflare/workers-sdk.git",
14+
"directory": "packages/workers-auth"
15+
},
16+
"files": [
17+
"dist"
18+
],
19+
"sideEffects": false,
20+
"exports": {
21+
".": {
22+
"import": "./dist/index.mjs",
23+
"types": "./dist/index.d.mts"
24+
},
25+
"./test-helpers": {
26+
"import": "./dist/test-helpers/index.mjs",
27+
"types": "./dist/test-helpers/index.d.mts"
28+
}
29+
},
30+
"scripts": {
31+
"build": "tsup",
32+
"check:type": "tsc -p ./tsconfig.json",
33+
"deploy": "echo 'no deploy'",
34+
"dev": "concurrently -c black,blue --kill-others-on-fail false \"pnpm tsup --watch src\" \"pnpm run check:type --watch --preserveWatchOutput\"",
35+
"test": "vitest",
36+
"test:ci": "vitest run"
37+
},
38+
"dependencies": {
39+
"@cloudflare/workers-utils": "workspace:*",
40+
"undici": "catalog:default"
41+
},
42+
"devDependencies": {
43+
"@cloudflare/workers-tsconfig": "workspace:*",
44+
"@types/node": "catalog:default",
45+
"@vitest/ui": "catalog:default",
46+
"concurrently": "^8.2.2",
47+
"msw": "catalog:default",
48+
"smol-toml": "catalog:default",
49+
"ts-dedent": "^2.2.0",
50+
"tsup": "8.3.0",
51+
"typescript": "catalog:default",
52+
"vitest": "catalog:default"
53+
},
54+
"peerDependencies": {
55+
"msw": "catalog:default",
56+
"vitest": "^4.1.0"
57+
},
58+
"peerDependenciesMeta": {
59+
"msw": {
60+
"optional": true
61+
},
62+
"vitest": {
63+
"optional": true
64+
}
65+
},
66+
"volta": {
67+
"extends": "../../package.json"
68+
},
69+
"workers-sdk": {
70+
"prerelease": true
71+
}
72+
}

0 commit comments

Comments
 (0)