Spaces:
Sleeping
Sleeping
File size: 11,110 Bytes
7dc28be | 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 | // src/auth.ts
import { google } from 'googleapis';
import { OAuth2Client } from 'google-auth-library';
import { JWT } from 'google-auth-library';
import * as fs from 'fs/promises';
import * as path from 'path';
import * as os from 'os';
import * as http from 'http';
import { fileURLToPath } from 'url';
import * as crypto from 'crypto';
import { logger } from './logger.js';
// ---------------------------------------------------------------------------
// Paths
// ---------------------------------------------------------------------------
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const projectRootDir = path.resolve(__dirname, '..');
/** Credentials file path (legacy dev workflow fallback). */
const CREDENTIALS_PATH = path.join(projectRootDir, 'credentials.json');
/**
* Token storage directory following XDG Base Directory spec.
* Uses $XDG_CONFIG_HOME if set, otherwise ~/.config.
*
* When GOOGLE_MCP_PROFILE is set, tokens are stored in a subdirectory
* per profile, allowing multiple Google accounts (one per project).
*/
function getConfigDir(): string {
const xdg = process.env.XDG_CONFIG_HOME;
const base = xdg || path.join(os.homedir(), '.config');
const baseDir = path.join(base, 'google-docs-mcp');
const profile = process.env.GOOGLE_MCP_PROFILE;
if (profile && !/^[\w-]+$/.test(profile)) {
throw new Error(
'GOOGLE_MCP_PROFILE must contain only alphanumeric characters, hyphens, or underscores.'
);
}
return profile ? path.join(baseDir, profile) : baseDir;
}
function getTokenPath(): string {
return path.join(getConfigDir(), 'token.json');
}
// ---------------------------------------------------------------------------
// Scopes
// ---------------------------------------------------------------------------
const SCOPES = [
'https://www.googleapis.com/auth/documents',
'https://www.googleapis.com/auth/drive',
'https://www.googleapis.com/auth/spreadsheets',
'https://www.googleapis.com/auth/script.external_request',
'https://www.googleapis.com/auth/gmail.modify',
'https://www.googleapis.com/auth/calendar.events',
];
const TOKEN_CREDENTIAL_FIELDS = ['access_token', 'refresh_token', 'scope', 'token_type'] as const;
export function sanitizeStoredTokenCredentials(
rawCredentials: unknown
): OAuth2Client['credentials'] {
if (!rawCredentials || typeof rawCredentials !== 'object' || Array.isArray(rawCredentials)) {
throw new Error('Invalid saved token format.');
}
const raw = rawCredentials as Record<string, unknown>;
const credentials: Record<string, string | number> = {};
for (const field of TOKEN_CREDENTIAL_FIELDS) {
const value = raw[field];
if (typeof value === 'string' && value.length > 0) {
credentials[field] = value;
}
}
if (typeof raw.expiry_date === 'number') {
credentials.expiry_date = raw.expiry_date;
}
if (!credentials.refresh_token && !credentials.access_token) {
throw new Error('Saved token does not contain OAuth token credentials.');
}
return credentials as OAuth2Client['credentials'];
}
export function createStoredTokenPayload(
credentials: OAuth2Client['credentials']
): OAuth2Client['credentials'] {
return sanitizeStoredTokenCredentials({
refresh_token: credentials.refresh_token,
});
}
// ---------------------------------------------------------------------------
// Client secrets resolution
// ---------------------------------------------------------------------------
/**
* Resolves OAuth client ID and secret.
*
* Priority:
* 1. GOOGLE_CLIENT_ID + GOOGLE_CLIENT_SECRET env vars (npx / production)
* 2. credentials.json in the project root (local dev fallback)
*/
async function loadClientSecrets(): Promise<{
client_id: string;
client_secret: string;
}> {
// 1. Environment variables
const envId = process.env.GOOGLE_CLIENT_ID;
const envSecret = process.env.GOOGLE_CLIENT_SECRET;
if (envId && envSecret) {
return { client_id: envId, client_secret: envSecret };
}
// 2. credentials.json fallback
try {
const content = await fs.readFile(CREDENTIALS_PATH, 'utf8');
const keys = JSON.parse(content);
const key = keys.installed || keys.web;
if (!key) {
throw new Error('Could not find client secrets in credentials.json.');
}
return {
client_id: key.client_id,
client_secret: key.client_secret,
};
} catch (err: any) {
if (err.code === 'ENOENT') {
throw new Error(
'No OAuth credentials found. Set GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET ' +
'environment variables, or place a credentials.json file in the project root.'
);
}
throw err;
}
}
// ---------------------------------------------------------------------------
// Service account auth (unchanged)
// ---------------------------------------------------------------------------
async function authorizeWithServiceAccount(): Promise<JWT> {
const serviceAccountPath = process.env.SERVICE_ACCOUNT_PATH!;
const impersonateUser = process.env.GOOGLE_IMPERSONATE_USER;
try {
const keyFileContent = await fs.readFile(serviceAccountPath, 'utf8');
const serviceAccountKey = JSON.parse(keyFileContent);
const auth = new JWT({
email: serviceAccountKey.client_email,
key: serviceAccountKey.private_key,
scopes: SCOPES,
subject: impersonateUser,
});
await auth.authorize();
if (impersonateUser) {
logger.info(`Service Account authentication successful, impersonating: ${impersonateUser}`);
} else {
logger.info('Service Account authentication successful!');
}
return auth;
} catch (error: any) {
if (error.code === 'ENOENT') {
logger.error(`FATAL: Service account key file not found at path: ${serviceAccountPath}`);
throw new Error(
'Service account key file not found. Please check the path in SERVICE_ACCOUNT_PATH.'
);
}
logger.error('FATAL: Error loading or authorizing the service account key:', error.message);
throw new Error(
'Failed to authorize using the service account. Ensure the key file is valid and the path is correct.'
);
}
}
// ---------------------------------------------------------------------------
// Token persistence (XDG path)
// ---------------------------------------------------------------------------
async function loadSavedCredentialsIfExist(): Promise<OAuth2Client | null> {
try {
const tokenPath = getTokenPath();
const content = await fs.readFile(tokenPath, 'utf8');
const credentials = sanitizeStoredTokenCredentials(JSON.parse(content));
const { client_secret, client_id } = await loadClientSecrets();
const client = new google.auth.OAuth2(client_id, client_secret);
client.setCredentials(credentials);
return client;
} catch {
return null;
}
}
async function saveCredentials(client: OAuth2Client): Promise<void> {
const configDir = getConfigDir();
await fs.mkdir(configDir, { recursive: true, mode: 0o700 });
const tokenPath = getTokenPath();
const payload = JSON.stringify(createStoredTokenPayload(client.credentials), null, 2);
await fs.writeFile(tokenPath, payload, { mode: 0o600 });
logger.info('Token stored to', tokenPath);
}
// ---------------------------------------------------------------------------
// Interactive OAuth browser flow
// ---------------------------------------------------------------------------
async function authenticate(): Promise<OAuth2Client> {
const { client_secret, client_id } = await loadClientSecrets();
// Start a temporary local server to receive the OAuth callback
const server = http.createServer();
await new Promise<void>((resolve) => server.listen(0, 'localhost', resolve));
const port = (server.address() as { port: number }).port;
const redirectUri = `http://localhost:${port}`;
const oAuth2Client = new google.auth.OAuth2(client_id, client_secret, redirectUri);
const state = crypto.randomBytes(32).toString('hex');
const authorizeUrl = oAuth2Client.generateAuthUrl({
access_type: 'offline',
scope: SCOPES.join(' '),
state,
});
logger.info('Authorize this app by visiting this url:', authorizeUrl);
const AUTH_TIMEOUT_MS = 5 * 60 * 1000;
const timeout = setTimeout(() => {
server.close();
}, AUTH_TIMEOUT_MS);
// Wait for the OAuth callback
const code = await new Promise<string>((resolve, reject) => {
server.on('request', (req, res) => {
const url = new URL(req.url!, `http://localhost:${port}`);
const authCode = url.searchParams.get('code');
const error = url.searchParams.get('error');
if (error) {
res.writeHead(200, { 'Content-Type': 'text/html' });
res.end('<h1>Authorization failed</h1><p>You can close this tab.</p>');
reject(new Error(`Authorization error: ${error}`));
clearTimeout(timeout);
server.close();
return;
}
const returnedState = url.searchParams.get('state');
if (returnedState !== state) {
res.writeHead(400, { 'Content-Type': 'text/html' });
res.end('<h1>Invalid state parameter</h1><p>Possible CSRF attack. Please try again.</p>');
return;
}
if (authCode) {
res.writeHead(200, { 'Content-Type': 'text/html' });
res.end('<h1>Authorization successful!</h1><p>You can close this tab.</p>');
resolve(authCode);
clearTimeout(timeout);
server.close();
}
});
});
const { tokens } = await oAuth2Client.getToken(code);
oAuth2Client.setCredentials(tokens);
if (tokens.refresh_token) {
await saveCredentials(oAuth2Client);
} else {
logger.warn('Did not receive refresh token. Token might expire.');
}
logger.info('Authentication successful!');
return oAuth2Client;
}
// ---------------------------------------------------------------------------
// Public API
// ---------------------------------------------------------------------------
/**
* Main authorization entry point used by the server at startup.
*
* Resolution order:
* 1. SERVICE_ACCOUNT_PATH env var -> service account JWT
* 2. Saved token in ~/.config/google-docs-mcp/token.json -> OAuth2Client
* 3. Interactive browser OAuth flow -> OAuth2Client (saves token for next time)
*/
export async function authorize(): Promise<OAuth2Client | JWT> {
if (process.env.SERVICE_ACCOUNT_PATH) {
logger.info('Service account path detected. Attempting service account authentication...');
return authorizeWithServiceAccount();
}
logger.info('Attempting OAuth 2.0 authentication...');
const client = await loadSavedCredentialsIfExist();
if (client) {
logger.info('Using saved credentials.');
return client;
}
logger.info('No saved token found. Starting interactive authentication flow...');
return authenticate();
}
/**
* Forces the interactive OAuth browser flow, ignoring any saved token.
* Used by the `auth` CLI subcommand to let users (re-)authorize.
*/
export async function runAuthFlow(): Promise<void> {
await authenticate();
}
|