import Koa from 'koa'; import { performance } from 'perf_hooks'; import { limiter } from './limiter.js'; import { CacheableLocalUser, User } from '@/models/entities/user.js'; import endpoints, { IEndpointMeta } from './endpoints.js'; import { ApiError } from './error.js'; import { apiLogger } from './logger.js'; import { AccessToken } from '@/models/entities/access-token.js'; import IPCIDR from 'ip-cidr'; const accessDenied = { message: 'Access denied.', code: 'ACCESS_DENIED', id: '56f35758-7dd5-468b-8439-5d6fb8ec9b8e', }; export default async (endpoint: string, user: CacheableLocalUser | null | undefined, token: AccessToken | null | undefined, data: any, ctx?: Koa.Context) => { const isSecure = user != null && token == null; const isModerator = user != null && (user.isModerator || user.isAdmin); const ep = endpoints.find(e => e.name === endpoint); if (ep == null) { throw new ApiError({ message: 'No such endpoint.', code: 'NO_SUCH_ENDPOINT', id: 'f8080b67-5f9c-4eb7-8c18-7f1eeae8f709', httpStatusCode: 404, }); } if (ep.meta.secure && !isSecure) { throw new ApiError(accessDenied); } if (ep.meta.requireCredential && ep.meta.limit && !isModerator) { // koa will automatically load the `X-Forwarded-For` header if `proxy: true` is configured in the app. let limitActor: string; if (user) { limitActor = user.id; } else { // because a single person may control many IPv6 addresses, // only a /64 subnet prefix of any IP will be taken into account. // (this means for IPv4 the entire address is used) const ip = IPCIDR.createAddress(ctx.ip).mask(64); limitActor = 'ip-' + parseInt(ip, 2).toString(36); } const limit = Object.assign({}, ep.meta.limit); if (!limit.key) { limit.key = ep.name; } // Rate limit await limiter(limit as IEndpointMeta['limit'] & { key: NonNullable }, limitActor).catch(e => { throw new ApiError({ message: 'Rate limit exceeded. Please try again later.', code: 'RATE_LIMIT_EXCEEDED', id: 'd5826d14-3982-4d2e-8011-b9e9f02499ef', httpStatusCode: 429, }); }); } if (ep.meta.requireCredential && user == null) { throw new ApiError({ message: 'Credential required.', code: 'CREDENTIAL_REQUIRED', id: '1384574d-a912-4b81-8601-c7b1c4085df1', httpStatusCode: 401, }); } if (ep.meta.requireCredential && user!.isSuspended) { throw new ApiError({ message: 'Your account has been suspended.', code: 'YOUR_ACCOUNT_SUSPENDED', id: 'a8c724b3-6e9c-4b46-b1a8-bc3ed6258370', httpStatusCode: 403, }); } if (ep.meta.requireAdmin && !user!.isAdmin) { throw new ApiError(accessDenied, { reason: 'You are not the admin.' }); } if (ep.meta.requireModerator && !isModerator) { throw new ApiError(accessDenied, { reason: 'You are not a moderator.' }); } if (token && ep.meta.kind && !token.permission.some(p => p === ep.meta.kind)) { throw new ApiError({ message: 'Your app does not have the necessary permissions to use this endpoint.', code: 'PERMISSION_DENIED', id: '1370e5b7-d4eb-4566-bb1d-7748ee6a1838', }); } // Cast non JSON input if (ep.meta.requireFile && ep.params.properties) { for (const k of Object.keys(ep.params.properties)) { const param = ep.params.properties![k]; if (['boolean', 'number', 'integer'].includes(param.type ?? '') && typeof data[k] === 'string') { try { data[k] = JSON.parse(data[k]); } catch (e) { throw new ApiError({ message: 'Invalid param.', code: 'INVALID_PARAM', id: '0b5f1631-7c1a-41a6-b399-cce335f34d85', }, { param: k, reason: `cannot cast to ${param.type}`, }); } } } } // API invoking const before = performance.now(); return await ep.exec(data, user, token, ctx?.file).catch((e: Error) => { if (e instanceof ApiError) { throw e; } else { apiLogger.error(`Internal error occurred in ${ep.name}: ${e?.message}`, { ep: ep.name, ps: data, e: { message: e?.message, code: e?.name, stack: e?.stack, }, }); throw new ApiError(null, { e: { message: e?.message, code: e?.name, stack: e?.stack, }, }); } }).finally(() => { const after = performance.now(); const time = after - before; if (time > 1000) { apiLogger.warn(`SLOW API CALL DETECTED: ${ep.name} (${time}ms)`); } }); };