-
-
Notifications
You must be signed in to change notification settings - Fork 80.8k
Expand file tree
/
Copy pathoauth.ts
More file actions
432 lines (399 loc) · 14.4 KB
/
Copy pathoauth.ts
File metadata and controls
432 lines (399 loc) · 14.4 KB
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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
// OpenRouter OAuth support exchanges PKCE browser login codes for API keys.
import { createServer } from "node:http";
import { formatErrorMessage } from "openclaw/plugin-sdk/error-runtime";
import type { ProviderAuthContext, ProviderAuthMethod } from "openclaw/plugin-sdk/plugin-entry";
import {
buildApiKeyCredential,
generatePkceVerifierChallenge,
type ProviderAuthResult,
} from "openclaw/plugin-sdk/provider-auth";
import { generateOAuthState } from "openclaw/plugin-sdk/provider-auth-runtime";
import { readResponseTextLimited } from "openclaw/plugin-sdk/provider-http";
import { applyOpenrouterConfig, OPENROUTER_DEFAULT_MODEL_REF } from "./onboard.js";
const PROVIDER_ID = "openrouter";
export const OPENROUTER_OAUTH_METHOD_ID = "oauth";
export const OPENROUTER_OAUTH_CHOICE_ID = "openrouter-oauth";
export const OPENROUTER_OAUTH_AUTHORIZE_URL = "https://openrouter.ai/auth";
export const OPENROUTER_OAUTH_TOKEN_URL = "https://openrouter.ai/api/v1/auth/keys";
export const OPENROUTER_OAUTH_CALLBACK_HOST = "localhost";
export const OPENROUTER_OAUTH_CALLBACK_PORT = 3000;
export const OPENROUTER_OAUTH_CALLBACK_PATH = "/openrouter-oauth/callback";
export const OPENROUTER_OAUTH_REDIRECT_URI = `http://${OPENROUTER_OAUTH_CALLBACK_HOST}:${OPENROUTER_OAUTH_CALLBACK_PORT}${OPENROUTER_OAUTH_CALLBACK_PATH}`;
export const OPENROUTER_OAUTH_CODE_CHALLENGE_METHOD = "S256";
const OPENROUTER_OAUTH_TIMEOUT_MS = 5 * 60 * 1000;
const OPENROUTER_OAUTH_FETCH_TIMEOUT_MS = 30 * 1000;
const OPENROUTER_OAUTH_ERROR_BODY_LIMIT_BYTES = 8 * 1024;
const OPENROUTER_OAUTH_PROFILE_ID = "openrouter:default";
type OpenRouterOAuthCallbackResult = {
code: string;
state: string;
};
type OpenRouterOAuthKeyResult = {
key: string;
userId?: string;
};
type OpenRouterOAuthLoginOptions = {
createPkce?: () => { verifier: string; challenge: string };
createState?: () => string;
fetchImpl?: typeof fetch;
waitForCallback?: typeof waitForOpenRouterOAuthCallback;
};
function isRecord(value: unknown): value is Record<string, unknown> {
return value !== null && typeof value === "object" && !Array.isArray(value);
}
function readString(value: unknown): string | undefined {
return typeof value === "string" && value.trim().length > 0 ? value.trim() : undefined;
}
function extractOpenRouterError(value: unknown): string | undefined {
if (typeof value === "string") {
return value.trim() || undefined;
}
if (!isRecord(value)) {
return undefined;
}
const direct = readString(value.message) ?? readString(value.error_description);
if (direct) {
return direct;
}
const error = value.error;
if (typeof error === "string") {
return error.trim() || undefined;
}
if (isRecord(error)) {
return readString(error.message) ?? readString(error.code);
}
return undefined;
}
async function readResponseBody(response: Response): Promise<unknown> {
const text = response.ok
? await response.text()
: await readResponseTextLimited(response, OPENROUTER_OAUTH_ERROR_BODY_LIMIT_BYTES).catch(
() => "",
);
if (!text.trim()) {
return null;
}
try {
return JSON.parse(text) as unknown;
} catch {
return text;
}
}
function parseOpenRouterKeyResponse(value: unknown): OpenRouterOAuthKeyResult {
if (!isRecord(value)) {
throw new Error("OpenRouter OAuth key exchange returned an unexpected response.");
}
const key = readString(value.key);
if (!key) {
throw new Error("OpenRouter OAuth key exchange returned no API key.");
}
const userId = readString(value.user_id) ?? readString(value.userId);
return {
key,
...(userId ? { userId } : {}),
};
}
export function buildOpenRouterOAuthRedirectUri(params: { state: string }): string {
const url = new URL(OPENROUTER_OAUTH_REDIRECT_URI);
url.searchParams.set("state", params.state);
return url.toString();
}
export function buildOpenRouterOAuthAuthorizeUrl(params: {
codeChallenge: string;
state: string;
}): string {
const url = new URL(OPENROUTER_OAUTH_AUTHORIZE_URL);
url.searchParams.set("callback_url", buildOpenRouterOAuthRedirectUri({ state: params.state }));
url.searchParams.set("code_challenge", params.codeChallenge);
url.searchParams.set("code_challenge_method", OPENROUTER_OAUTH_CODE_CHALLENGE_METHOD);
return url.toString();
}
function requireOpenRouterOAuthState(state: string | undefined, expectedState: string): string {
if (!state) {
throw new Error("Missing OpenRouter OAuth state. Paste the full redirect URL.");
}
if (state !== expectedState) {
throw new Error("OpenRouter OAuth state mismatch. Please retry login.");
}
return state;
}
export function parseOpenRouterOAuthCallbackInput(
input: string,
expectedState: string,
): OpenRouterOAuthCallbackResult {
const trimmed = input.trim();
if (!trimmed) {
throw new Error("No input provided.");
}
const parseParams = (params: URLSearchParams): OpenRouterOAuthCallbackResult => {
const code = readString(params.get("code"));
if (!code) {
throw new Error("Missing 'code' parameter in redirect URL.");
}
const state = requireOpenRouterOAuthState(readString(params.get("state")), expectedState);
return { code, state };
};
try {
const url = new URL(trimmed);
return parseParams(url.searchParams);
} catch (err) {
if (err instanceof TypeError) {
if (trimmed.includes("code=")) {
return parseParams(new URLSearchParams(trimmed));
}
throw new Error("Paste the full OpenRouter redirect URL, not just the code.", {
cause: err,
});
}
throw err;
}
}
export async function exchangeOpenRouterOAuthCode(params: {
code: string;
codeVerifier: string;
fetchImpl?: typeof fetch;
}): Promise<OpenRouterOAuthKeyResult> {
const fetchImpl = params.fetchImpl ?? fetch;
const response = await fetchImpl(OPENROUTER_OAUTH_TOKEN_URL, {
method: "POST",
headers: {
"Content-Type": "application/json",
Accept: "application/json",
},
body: JSON.stringify({
code: params.code,
code_verifier: params.codeVerifier,
code_challenge_method: OPENROUTER_OAUTH_CODE_CHALLENGE_METHOD,
}),
signal: AbortSignal.timeout(OPENROUTER_OAUTH_FETCH_TIMEOUT_MS),
});
const body = await readResponseBody(response);
if (!response.ok) {
const message = extractOpenRouterError(body);
throw new Error(
`OpenRouter OAuth key exchange failed (${response.status})${message ? `: ${message}` : ""}`,
);
}
return parseOpenRouterKeyResponse(body);
}
export async function waitForOpenRouterOAuthCallback(params: {
expectedState: string;
timeoutMs?: number;
onProgress?: (message: string) => void;
}): Promise<OpenRouterOAuthCallbackResult> {
const timeoutMs = params.timeoutMs ?? OPENROUTER_OAUTH_TIMEOUT_MS;
return new Promise<OpenRouterOAuthCallbackResult>((resolve, reject) => {
let settled = false;
const timeout = setTimeout(() => {
finish(new Error("OpenRouter OAuth callback timeout"));
}, timeoutMs);
const server = createServer((req, res) => {
try {
const requestUrl = new URL(
req.url ?? "/",
`http://${OPENROUTER_OAUTH_CALLBACK_HOST}:${OPENROUTER_OAUTH_CALLBACK_PORT}`,
);
if (requestUrl.pathname !== OPENROUTER_OAUTH_CALLBACK_PATH) {
res.statusCode = 404;
res.setHeader("Content-Type", "text/plain");
res.end("Not found");
return;
}
if (req.method !== "GET") {
res.statusCode = 405;
res.setHeader("Allow", "GET");
res.setHeader("Content-Type", "text/plain");
res.end("Method not allowed");
return;
}
const error = readString(requestUrl.searchParams.get("error"));
if (error) {
res.statusCode = 400;
res.setHeader("Content-Type", "text/plain");
res.end(`OpenRouter authentication failed: ${error}`);
finish(new Error(`OpenRouter OAuth error: ${error}`));
return;
}
const code = readString(requestUrl.searchParams.get("code"));
if (!code) {
res.statusCode = 400;
res.setHeader("Content-Type", "text/plain");
res.end("Missing OAuth code");
finish(new Error("Missing OpenRouter OAuth code"));
return;
}
const state = readString(requestUrl.searchParams.get("state"));
try {
requireOpenRouterOAuthState(state, params.expectedState);
} catch (err) {
res.statusCode = 400;
res.setHeader("Content-Type", "text/plain");
res.end("Invalid OAuth state");
finish(err instanceof Error ? err : new Error("OpenRouter OAuth state mismatch"));
return;
}
res.statusCode = 200;
res.setHeader("Content-Type", "text/html; charset=utf-8");
res.end(
"<!doctype html><html><head><meta charset='utf-8'/></head>" +
"<body><h2>OpenRouter OAuth complete</h2>" +
"<p>You can close this window and return to OpenClaw.</p></body></html>",
);
finish(undefined, { code, state: params.expectedState });
} catch (err) {
finish(err instanceof Error ? err : new Error("OpenRouter OAuth callback failed"));
}
});
const finish = (err?: Error, result?: OpenRouterOAuthCallbackResult) => {
if (settled) {
return;
}
settled = true;
if (timeout) {
clearTimeout(timeout);
}
try {
server.close();
} catch {
// Best-effort cleanup after callback completion or timeout.
}
if (err) {
reject(err);
return;
}
if (result) {
resolve(result);
}
};
server.once("error", (err) => {
finish(err instanceof Error ? err : new Error("OpenRouter OAuth callback server error"));
});
server.listen(OPENROUTER_OAUTH_CALLBACK_PORT, OPENROUTER_OAUTH_CALLBACK_HOST, () => {
params.onProgress?.(
`Waiting for OpenRouter OAuth callback on ${OPENROUTER_OAUTH_REDIRECT_URI}...`,
);
});
});
}
async function promptForOpenRouterRedirect(
ctx: ProviderAuthContext,
expectedState: string,
): Promise<string> {
const input = await ctx.prompter.text({
message: "Paste the OpenRouter redirect URL",
placeholder: `${OPENROUTER_OAUTH_REDIRECT_URI}?state=...&code=...`,
validate: (value: string) => (value.trim().length > 0 ? undefined : "Required"),
});
return parseOpenRouterOAuthCallbackInput(input, expectedState).code;
}
async function resolveOpenRouterOAuthCode(
ctx: ProviderAuthContext,
params: {
authorizeUrl: string;
state: string;
waitForCallback: typeof waitForOpenRouterOAuthCallback;
onProgress: (message: string) => void;
},
): Promise<string> {
await ctx.prompter.note(
ctx.isRemote
? [
"Open this URL in your LOCAL browser.",
"After signing in, paste the redirect URL back here.",
"",
`Redirect URI: ${OPENROUTER_OAUTH_REDIRECT_URI}`,
].join("\n")
: [
"Browser will open for OpenRouter authentication.",
"If the callback does not auto-complete, paste the redirect URL.",
"",
`Redirect URI: ${OPENROUTER_OAUTH_REDIRECT_URI}`,
].join("\n"),
"OpenRouter OAuth",
);
if (ctx.isRemote) {
ctx.runtime.log(`\nOpen this URL in your LOCAL browser:\n\n${params.authorizeUrl}\n`);
return await promptForOpenRouterRedirect(ctx, params.state);
}
const callbackPromise = params
.waitForCallback({ expectedState: params.state, onProgress: params.onProgress })
.catch(async () => {
params.onProgress("OAuth callback not detected; waiting for redirect URL...");
return { code: await promptForOpenRouterRedirect(ctx, params.state), state: params.state };
});
void callbackPromise.catch(() => undefined);
try {
await ctx.openUrl(params.authorizeUrl);
ctx.runtime.log(`Open: ${params.authorizeUrl}`);
} catch {
ctx.runtime.log(`Open manually: ${params.authorizeUrl}`);
}
return (await callbackPromise).code;
}
export async function loginOpenRouterOAuth(
ctx: ProviderAuthContext,
options: OpenRouterOAuthLoginOptions = {},
): Promise<ProviderAuthResult> {
const progress = ctx.prompter.progress("Starting OpenRouter OAuth...");
try {
const pkce = options.createPkce?.() ?? generatePkceVerifierChallenge();
const state = options.createState?.() ?? generateOAuthState();
const authorizeUrl = buildOpenRouterOAuthAuthorizeUrl({
codeChallenge: pkce.challenge,
state,
});
const code = await resolveOpenRouterOAuthCode(ctx, {
authorizeUrl,
state,
waitForCallback: options.waitForCallback ?? waitForOpenRouterOAuthCallback,
onProgress: (message) => progress.update(message),
});
progress.update("Exchanging OpenRouter OAuth code...");
const token = await exchangeOpenRouterOAuthCode({
code,
codeVerifier: pkce.verifier,
fetchImpl: options.fetchImpl,
});
progress.stop("OpenRouter OAuth complete");
const metadata = {
authFlow: "oauth-pkce",
...(token.userId ? { userId: token.userId } : {}),
};
const credential = {
...buildApiKeyCredential(PROVIDER_ID, token.key, metadata),
displayName: token.userId ? `OpenRouter ${token.userId}` : "OpenRouter OAuth",
};
return {
profiles: [{ profileId: OPENROUTER_OAUTH_PROFILE_ID, credential }],
configPatch: applyOpenrouterConfig(ctx.config),
defaultModel: OPENROUTER_DEFAULT_MODEL_REF,
notes: [
"OpenRouter OAuth issued an OpenRouter API key and stored it in the default OpenRouter auth profile.",
"Re-run OpenRouter OAuth to rotate that key or use the API-key setup path for a key you manage manually.",
],
};
} catch (err) {
progress.stop("OpenRouter OAuth failed");
throw new Error(`OpenRouter OAuth failed: ${formatErrorMessage(err)}`, { cause: err });
}
}
export function createOpenRouterOAuthAuthMethod(): ProviderAuthMethod {
return {
id: OPENROUTER_OAUTH_METHOD_ID,
label: "OpenRouter OAuth",
hint: "Browser sign-in",
kind: "oauth",
wizard: {
choiceId: OPENROUTER_OAUTH_CHOICE_ID,
choiceLabel: "OpenRouter OAuth",
choiceHint: "Browser sign-in",
groupId: PROVIDER_ID,
groupLabel: "OpenRouter",
groupHint: "OAuth or API key",
methodId: OPENROUTER_OAUTH_METHOD_ID,
onboardingScopes: ["text-inference", "music-generation"],
onboardingFeatured: true,
},
run: async (ctx) => await loginOpenRouterOAuth(ctx),
};
}