mirror of
https://github.com/google-gemini/gemini-cli.git
synced 2026-04-24 12:04:56 -07:00
feat(core): require user consent before MCP server OAuth (#18132)
This commit is contained in:
@@ -0,0 +1,111 @@
|
||||
/**
|
||||
* @license
|
||||
* Copyright 2025 Google LLC
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
import { describe, it, expect, vi } from 'vitest';
|
||||
import type { Mock } from 'vitest';
|
||||
import readline from 'node:readline';
|
||||
import process from 'node:process';
|
||||
import { coreEvents } from './events.js';
|
||||
import { getConsentForOauth } from './authConsent.js';
|
||||
import { FatalAuthenticationError } from './errors.js';
|
||||
import { writeToStdout } from './stdio.js';
|
||||
|
||||
vi.mock('node:readline');
|
||||
vi.mock('./stdio.js', () => ({
|
||||
writeToStdout: vi.fn(),
|
||||
createWorkingStdio: vi.fn(() => ({
|
||||
stdout: process.stdout,
|
||||
stderr: process.stderr,
|
||||
})),
|
||||
}));
|
||||
|
||||
describe('getConsentForOauth', () => {
|
||||
it('should use coreEvents when listeners are present', async () => {
|
||||
vi.restoreAllMocks();
|
||||
const mockEmitConsentRequest = vi.spyOn(coreEvents, 'emitConsentRequest');
|
||||
const mockListenerCount = vi
|
||||
.spyOn(coreEvents, 'listenerCount')
|
||||
.mockReturnValue(1);
|
||||
|
||||
mockEmitConsentRequest.mockImplementation((payload) => {
|
||||
payload.onConfirm(true);
|
||||
});
|
||||
|
||||
const result = await getConsentForOauth('Login required.');
|
||||
|
||||
expect(result).toBe(true);
|
||||
expect(mockEmitConsentRequest).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
prompt: expect.stringContaining(
|
||||
'Login required. Opening authentication page in your browser.',
|
||||
),
|
||||
}),
|
||||
);
|
||||
|
||||
mockListenerCount.mockRestore();
|
||||
mockEmitConsentRequest.mockRestore();
|
||||
});
|
||||
|
||||
it('should use readline when no listeners are present and stdin is a TTY', async () => {
|
||||
vi.restoreAllMocks();
|
||||
const mockListenerCount = vi
|
||||
.spyOn(coreEvents, 'listenerCount')
|
||||
.mockReturnValue(0);
|
||||
const originalIsTTY = process.stdin.isTTY;
|
||||
Object.defineProperty(process.stdin, 'isTTY', {
|
||||
value: true,
|
||||
configurable: true,
|
||||
});
|
||||
|
||||
const mockReadline = {
|
||||
on: vi.fn((event, callback) => {
|
||||
if (event === 'line') {
|
||||
callback('y');
|
||||
}
|
||||
}),
|
||||
close: vi.fn(),
|
||||
};
|
||||
(readline.createInterface as Mock).mockReturnValue(mockReadline);
|
||||
|
||||
const result = await getConsentForOauth('Login required.');
|
||||
|
||||
expect(result).toBe(true);
|
||||
expect(readline.createInterface).toHaveBeenCalled();
|
||||
expect(writeToStdout).toHaveBeenCalledWith(
|
||||
expect.stringContaining(
|
||||
'Login required. Opening authentication page in your browser.',
|
||||
),
|
||||
);
|
||||
|
||||
mockListenerCount.mockRestore();
|
||||
Object.defineProperty(process.stdin, 'isTTY', {
|
||||
value: originalIsTTY,
|
||||
configurable: true,
|
||||
});
|
||||
});
|
||||
|
||||
it('should throw FatalAuthenticationError when no listeners and not a TTY', async () => {
|
||||
vi.restoreAllMocks();
|
||||
const mockListenerCount = vi
|
||||
.spyOn(coreEvents, 'listenerCount')
|
||||
.mockReturnValue(0);
|
||||
const originalIsTTY = process.stdin.isTTY;
|
||||
Object.defineProperty(process.stdin, 'isTTY', {
|
||||
value: false,
|
||||
configurable: true,
|
||||
});
|
||||
|
||||
await expect(getConsentForOauth('Login required.')).rejects.toThrow(
|
||||
FatalAuthenticationError,
|
||||
);
|
||||
|
||||
mockListenerCount.mockRestore();
|
||||
Object.defineProperty(process.stdin, 'isTTY', {
|
||||
value: originalIsTTY,
|
||||
configurable: true,
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,60 @@
|
||||
/**
|
||||
* @license
|
||||
* Copyright 2025 Google LLC
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
import readline from 'node:readline';
|
||||
import { CoreEvent, coreEvents } from './events.js';
|
||||
import { FatalAuthenticationError } from './errors.js';
|
||||
import { createWorkingStdio, writeToStdout } from './stdio.js';
|
||||
|
||||
/**
|
||||
* Requests consent from the user for OAuth login.
|
||||
* Handles both TTY and non-TTY environments.
|
||||
*/
|
||||
export async function getConsentForOauth(prompt: string): Promise<boolean> {
|
||||
const finalPrompt = prompt + ' Opening authentication page in your browser. ';
|
||||
|
||||
if (coreEvents.listenerCount(CoreEvent.ConsentRequest) === 0) {
|
||||
if (!process.stdin.isTTY) {
|
||||
throw new FatalAuthenticationError(
|
||||
'Interactive consent could not be obtained.\n' +
|
||||
'Please run Gemini CLI in an interactive terminal to authenticate, or use NO_BROWSER=true for manual authentication.',
|
||||
);
|
||||
}
|
||||
return getOauthConsentNonInteractive(finalPrompt);
|
||||
}
|
||||
|
||||
return getOauthConsentInteractive(finalPrompt);
|
||||
}
|
||||
|
||||
async function getOauthConsentNonInteractive(prompt: string) {
|
||||
const rl = readline.createInterface({
|
||||
input: process.stdin,
|
||||
output: createWorkingStdio().stdout,
|
||||
terminal: true,
|
||||
});
|
||||
|
||||
const fullPrompt = prompt + 'Do you want to continue? [Y/n]: ';
|
||||
writeToStdout(`\n${fullPrompt}`);
|
||||
|
||||
return new Promise<boolean>((resolve) => {
|
||||
rl.on('line', (answer) => {
|
||||
rl.close();
|
||||
resolve(['y', ''].includes(answer.trim().toLowerCase()));
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
async function getOauthConsentInteractive(prompt: string) {
|
||||
const fullPrompt = prompt + '\n\nDo you want to continue?';
|
||||
return new Promise<boolean>((resolve) => {
|
||||
coreEvents.emitConsentRequest({
|
||||
prompt: fullPrompt,
|
||||
onConfirm: (confirmed: boolean) => {
|
||||
resolve(confirmed);
|
||||
},
|
||||
});
|
||||
});
|
||||
}
|
||||
Reference in New Issue
Block a user