'use strict'; exports = module.exports = { getApp, listByUser, getAppIcon, install, uninstall, restore, importApp, exportApp, backup, update, getLogs, getLogStream, listBackups, repair, setAccessRestriction, setLabel, setTags, setIcon, setMemoryLimit, setCpuShares, setAutomaticBackup, setAutomaticUpdate, setReverseProxyConfig, setCertificate, setDebugMode, setEnvironment, setMailbox, setLocation, setDataDir, setMounts, stop, start, restart, exec, execWebSocket, clone, uploadFile, downloadFile, load }; var apps = require('../apps.js'), assert = require('assert'), auditSource = require('../auditsource.js'), BoxError = require('../boxerror.js'), debug = require('debug')('box:routes/apps'), HttpError = require('connect-lastmile').HttpError, HttpSuccess = require('connect-lastmile').HttpSuccess, safe = require('safetydance'), users = require('../users.js'), WebSocket = require('ws'); async function load(req, res, next) { assert.strictEqual(typeof req.params.id, 'string'); const [error, result] = await safe(apps.get(req.params.id)); if (error) return next(BoxError.toHttpError(error)); req.resource = result; next(); } function getApp(req, res, next) { assert.strictEqual(typeof req.resource, 'object'); next(new HttpSuccess(200, apps.removeInternalFields(req.resource))); } async function listByUser(req, res, next) { assert.strictEqual(typeof req.user, 'object'); let [error, result] = await safe(apps.listByUser(req.user)); if (error) return next(BoxError.toHttpError(error)); result = result.map(apps.removeRestrictedFields); next(new HttpSuccess(200, { apps: result })); } async function getAppIcon(req, res, next) { assert.strictEqual(typeof req.resource, 'object'); const [error, icon] = await safe(apps.getIcon(req.resource, { original: req.query.original })); if (error) return next(BoxError.toHttpError(error)); res.send(icon); } async function install(req, res, next) { assert.strictEqual(typeof req.body, 'object'); const data = req.body; // atleast one if ('manifest' in data && typeof data.manifest !== 'object') return next(new HttpError(400, 'manifest must be an object')); if ('appStoreId' in data && typeof data.appStoreId !== 'string') return next(new HttpError(400, 'appStoreId must be a string')); if (!data.manifest && !data.appStoreId) return next(new HttpError(400, 'appStoreId or manifest is required')); // required if (typeof data.location !== 'string') return next(new HttpError(400, 'location is required')); if (typeof data.domain !== 'string') return next(new HttpError(400, 'domain is required')); if (typeof data.accessRestriction !== 'object') return next(new HttpError(400, 'accessRestriction is required')); // optional if (('portBindings' in data) && typeof data.portBindings !== 'object') return next(new HttpError(400, 'portBindings must be an object')); if ('icon' in data && typeof data.icon !== 'string') return next(new HttpError(400, 'icon is not a string')); if ('label' in data && typeof data.label !== 'string') return next(new HttpError(400, 'label must be a string')); if ('memoryLimit' in data && typeof data.memoryLimit !== 'number') return next(new HttpError(400, 'memoryLimit is not a number')); if ('sso' in data && typeof data.sso !== 'boolean') return next(new HttpError(400, 'sso must be a boolean')); if ('enableBackup' in data && typeof data.enableBackup !== 'boolean') return next(new HttpError(400, 'enableBackup must be a boolean')); if ('enableAutomaticUpdate' in data && typeof data.enableAutomaticUpdate !== 'boolean') return next(new HttpError(400, 'enableAutomaticUpdate must be a boolean')); if (('debugMode' in data) && typeof data.debugMode !== 'object') return next(new HttpError(400, 'debugMode must be an object')); if ('alternateDomains' in data) { if (!Array.isArray(data.alternateDomains)) return next(new HttpError(400, 'alternateDomains must be an array')); if (data.alternateDomains.some(function (d) { return (typeof d.domain !== 'string' || typeof d.subdomain !== 'string'); })) return next(new HttpError(400, 'alternateDomains array must contain objects with domain and subdomain strings')); } if ('aliasDomains' in data) { if (!Array.isArray(data.aliasDomains)) return next(new HttpError(400, 'aliasDomains must be an array')); if (data.aliasDomains.some(function (d) { return (typeof d.domain !== 'string' || typeof d.subdomain !== 'string'); })) return next(new HttpError(400, 'aliasDomains array must contain objects with domain and subdomain strings')); } if ('env' in data) { if (!data.env || typeof data.env !== 'object') return next(new HttpError(400, 'env must be an object')); if (Object.keys(data.env).some(function (key) { return typeof data.env[key] !== 'string'; })) return next(new HttpError(400, 'env must contain values as strings')); } if ('overwriteDns' in req.body && typeof req.body.overwriteDns !== 'boolean') return next(new HttpError(400, 'overwriteDns must be boolean')); if ('skipDnsSetup' in req.body && typeof req.body.skipDnsSetup !== 'boolean') return next(new HttpError(400, 'skipDnsSetup must be boolean')); if ('enableMailbox' in req.body && typeof req.body.enableMailbox !== 'boolean') return next(new HttpError(400, 'enableMailbox must be boolean')); let [error, result] = await safe(apps.downloadManifest(data.appStoreId, data.manifest)); if (error) return next(BoxError.toHttpError(error)); if (safe.query(result.manifest, 'addons.docker') && req.user.role !== users.ROLE_OWNER) return next(new HttpError(403, '"owner" role is required to install app with docker addon')); data.appStoreId = result.appStoreId; data.manifest = result.manifest; [error, result] = await safe(apps.install(data, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(202, { id: result.id, taskId: result.taskId })); } async function setAccessRestriction(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); if (typeof req.body.accessRestriction !== 'object') return next(new HttpError(400, 'accessRestriction must be an object')); const [error] = await safe(apps.setAccessRestriction(req.resource, req.body.accessRestriction, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(200, {})); } async function setLabel(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); if (typeof req.body.label !== 'string') return next(new HttpError(400, 'label must be a string')); const [error] = await safe(apps.setLabel(req.resource, req.body.label, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(200, {})); } async function setTags(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); if (!Array.isArray(req.body.tags)) return next(new HttpError(400, 'tags must be an array')); if (req.body.tags.some((t) => typeof t !== 'string')) return next(new HttpError(400, 'tags array must contain strings')); const [error] = await safe(apps.setTags(req.resource, req.body.tags, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(200, {})); } async function setIcon(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); if (req.body.icon !== null && typeof req.body.icon !== 'string') return next(new HttpError(400, 'icon is null or a base-64 image string')); const [error] = await safe(apps.setIcon(req.resource, req.body.icon || null /* empty string means null */, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(200, {})); } async function setMemoryLimit(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); if (typeof req.body.memoryLimit !== 'number') return next(new HttpError(400, 'memoryLimit is not a number')); const [error, result] = await safe(apps.setMemoryLimit(req.resource, req.body.memoryLimit, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(202, { taskId: result.taskId })); } function setCpuShares(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); if (typeof req.body.cpuShares !== 'number') return next(new HttpError(400, 'cpuShares is not a number')); apps.setCpuShares(req.resource, req.body.cpuShares, auditSource.fromRequest(req), function (error, result) { if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(202, { taskId: result.taskId })); }); } async function setAutomaticBackup(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); if (typeof req.body.enable !== 'boolean') return next(new HttpError(400, 'enable must be a boolean')); const [error] = await safe(apps.setAutomaticBackup(req.resource, req.body.enable, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(200, {})); } async function setAutomaticUpdate(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); if (typeof req.body.enable !== 'boolean') return next(new HttpError(400, 'enable must be a boolean')); const [error] = await safe(apps.setAutomaticUpdate(req.resource, req.body.enable, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(200, {})); } async function setReverseProxyConfig(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); if (req.body.robotsTxt !== null && typeof req.body.robotsTxt !== 'string') return next(new HttpError(400, 'robotsTxt is not a string')); if (req.body.csp !== null && typeof req.body.csp !== 'string') return next(new HttpError(400, 'csp is not a string')); const [error] = await safe(apps.setReverseProxyConfig(req.resource, req.body, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(200, {})); } async function setCertificate(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); if (typeof req.body.location !== 'string') return next(new HttpError(400, 'location must be string')); // location may be an empty string if (!req.body.domain) return next(new HttpError(400, 'domain is required')); if (typeof req.body.domain !== 'string') return next(new HttpError(400, 'domain must be string')); if (req.body.key !== null && typeof req.body.cert !== 'string') return next(new HttpError(400, 'cert must be a string')); if (req.body.cert !== null && typeof req.body.key !== 'string') return next(new HttpError(400, 'key must be a string')); if (req.body.cert && !req.body.key) return next(new HttpError(400, 'key must be provided')); if (!req.body.cert && req.body.key) return next(new HttpError(400, 'cert must be provided')); const [error] = await safe(apps.setCertificate(req.resource, req.body, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(200, {})); } async function setEnvironment(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); if (!req.body.env || typeof req.body.env !== 'object') return next(new HttpError(400, 'env must be an object')); if (Object.keys(req.body.env).some((key) => typeof req.body.env[key] !== 'string')) return next(new HttpError(400, 'env must contain values as strings')); const [error, result] = await safe(apps.setEnvironment(req.resource, req.body.env, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(202, { taskId: result.taskId })); } async function setDebugMode(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); if (req.body.debugMode !== null && typeof req.body.debugMode !== 'object') return next(new HttpError(400, 'debugMode must be an object')); const [error, result] = await safe(apps.setDebugMode(req.resource, req.body.debugMode, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(202, { taskId: result.taskId })); } async function setMailbox(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); if (typeof req.body.enable !== 'boolean') return next(new HttpError(400, 'enable must be a boolean')); if (req.body.enable) { if (req.body.mailboxName !== null && typeof req.body.mailboxName !== 'string') return next(new HttpError(400, 'mailboxName must be a string')); if (typeof req.body.mailboxDomain !== 'string') return next(new HttpError(400, 'mailboxDomain must be a string')); } const [error, result] = await safe(apps.setMailbox(req.resource, req.body, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(202, { taskId: result.taskId })); } async function setLocation(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); if (typeof req.body.location !== 'string') return next(new HttpError(400, 'location must be string')); // location may be an empty string if (!req.body.domain) return next(new HttpError(400, 'domain is required')); if (typeof req.body.domain !== 'string') return next(new HttpError(400, 'domain must be string')); if ('portBindings' in req.body && typeof req.body.portBindings !== 'object') return next(new HttpError(400, 'portBindings must be an object')); if ('alternateDomains' in req.body) { if (!Array.isArray(req.body.alternateDomains)) return next(new HttpError(400, 'alternateDomains must be an array')); if (req.body.alternateDomains.some(function (d) { return (typeof d.domain !== 'string' || typeof d.subdomain !== 'string'); })) return next(new HttpError(400, 'alternateDomains array must contain objects with domain and subdomain strings')); } if ('aliasDomains' in req.body) { if (!Array.isArray(req.body.aliasDomains)) return next(new HttpError(400, 'aliasDomains must be an array')); if (req.body.aliasDomains.some(function (d) { return (typeof d.domain !== 'string' || typeof d.subdomain !== 'string'); })) return next(new HttpError(400, 'aliasDomains array must contain objects with domain and subdomain strings')); } if ('overwriteDns' in req.body && typeof req.body.overwriteDns !== 'boolean') return next(new HttpError(400, 'overwriteDns must be boolean')); if ('skipDnsSetup' in req.body && typeof req.body.skipDnsSetup !== 'boolean') return next(new HttpError(400, 'skipDnsSetup must be boolean')); const [error, result] = await safe(apps.setLocation(req.resource, req.body, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(202, { taskId: result.taskId })); } async function setDataDir(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); if (req.body.dataDir !== null && typeof req.body.dataDir !== 'string') return next(new HttpError(400, 'dataDir must be a string')); const [error, result] = await safe(apps.setDataDir(req.resource, req.body.dataDir, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(202, { taskId: result.taskId })); } async function repair(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); const data = req.body; if ('manifest' in data) { if (!data.manifest || typeof data.manifest !== 'object') return next(new HttpError(400, 'manifest must be an object')); if (safe.query(data.manifest, 'addons.docker') && req.user.role !== users.ROLE_OWNER) return next(new HttpError(403, '"owner" role is required to repair app with docker addon')); } if ('dockerImage' in data) { if (!data.dockerImage || typeof data.dockerImage !== 'string') return next(new HttpError(400, 'dockerImage must be a string')); } const [error, result] = await safe(apps.repair(req.resource, data, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(202, { taskId: result.taskId })); } async function restore(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); const data = req.body; if (!data.backupId || typeof data.backupId !== 'string') return next(new HttpError(400, 'backupId must be non-empty string')); const [error, result] = await safe(apps.restore(req.resource, data.backupId, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(202, { taskId: result.taskId })); } async function importApp(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); const data = req.body; if ('backupId' in data) { // if not provided, we import in-place if (typeof data.backupId !== 'string') return next(new HttpError(400, 'backupId must be string')); if (typeof data.backupFormat !== 'string') return next(new HttpError(400, 'backupFormat must be string')); if ('backupConfig' in data && typeof data.backupConfig !== 'object') return next(new HttpError(400, 'backupConfig must be an object')); const backupConfig = req.body.backupConfig; if (req.body.backupConfig) { if (typeof backupConfig.provider !== 'string') return next(new HttpError(400, 'provider is required')); if ('password' in backupConfig && typeof backupConfig.password !== 'string') return next(new HttpError(400, 'password must be a string')); if ('acceptSelfSignedCerts' in backupConfig && typeof backupConfig.acceptSelfSignedCerts !== 'boolean') return next(new HttpError(400, 'format must be a boolean')); // testing backup config can take sometime req.clearTimeout(); } } const [error, result] = await safe(apps.importApp(req.resource, data, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(202, { taskId: result.taskId })); } async function exportApp(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); const [error, result] = await safe(apps.exportApp(req.resource, {}, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(202, { taskId: result.taskId })); } async function clone(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); var data = req.body; if (typeof data.backupId !== 'string') return next(new HttpError(400, 'backupId must be a string')); if (typeof data.location !== 'string') return next(new HttpError(400, 'location is required')); if (typeof data.domain !== 'string') return next(new HttpError(400, 'domain is required')); if (('portBindings' in data) && typeof data.portBindings !== 'object') return next(new HttpError(400, 'portBindings must be an object')); if ('overwriteDns' in req.body && typeof req.body.overwriteDns !== 'boolean') return next(new HttpError(400, 'overwriteDns must be boolean')); if ('skipDnsSetup' in req.body && typeof req.body.skipDnsSetup !== 'boolean') return next(new HttpError(400, 'skipDnsSetup must be boolean')); const [error, result] = await safe(apps.clone(req.resource, data, req.user, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(201, { id: result.id, taskId: result.taskId })); } async function backup(req, res, next) { assert.strictEqual(typeof req.resource, 'object'); const [error, result] = await safe(apps.backup(req.resource)); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(202, { taskId: result.taskId })); } async function uninstall(req, res, next) { assert.strictEqual(typeof req.resource, 'object'); const [error, result] = await safe(apps.uninstall(req.resource, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(202, { taskId: result.taskId })); } async function start(req, res, next) { assert.strictEqual(typeof req.resource, 'object'); const [error, result] = await safe(apps.start(req.resource, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(202, { taskId: result.taskId })); } async function stop(req, res, next) { assert.strictEqual(typeof req.resource, 'object'); const [error, result] = await safe(apps.stop(req.resource, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(202, { taskId: result.taskId })); } async function restart(req, res, next) { assert.strictEqual(typeof req.resource, 'object'); const [error, result] = await safe(apps.restart(req.resource, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(202, { taskId: result.taskId })); } async function update(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); const data = req.body; // atleast one if ('manifest' in data && typeof data.manifest !== 'object') return next(new HttpError(400, 'manifest must be an object')); if ('appStoreId' in data && typeof data.appStoreId !== 'string') return next(new HttpError(400, 'appStoreId must be a string')); if (!data.manifest && !data.appStoreId) return next(new HttpError(400, 'appStoreId or manifest is required')); if ('skipBackup' in data && typeof data.skipBackup !== 'boolean') return next(new HttpError(400, 'skipBackup must be a boolean')); if ('force' in data && typeof data.force !== 'boolean') return next(new HttpError(400, 'force must be a boolean')); let [error, result] = await safe(apps.downloadManifest(data.appStoreId, data.manifest)); if (error) return next(BoxError.toHttpError(error)); const { appStoreId, manifest } = result; if (safe.query(manifest, 'addons.docker') && req.user.role !== users.ROLE_OWNER) return next(new HttpError(403, '"owner" role is required to update app with docker addon')); data.appStoreId = appStoreId; data.manifest = manifest; [error, result] = await safe(apps.updateApp(req.resource, data, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(202, { taskId: result.taskId })); } // this route is for streaming logs function getLogStream(req, res, next) { assert.strictEqual(typeof req.resource, 'object'); var lines = 'lines' in req.query ? parseInt(req.query.lines, 10) : 10; // we ignore last-event-id if (isNaN(lines)) return next(new HttpError(400, 'lines must be a valid number')); function sse(id, data) { return 'id: ' + id + '\ndata: ' + data + '\n\n'; } if (req.headers.accept !== 'text/event-stream') return next(new HttpError(400, 'This API call requires EventStream')); var options = { lines: lines, follow: true, format: 'json' }; apps.getLogs(req.resource, options, function (error, logStream) { if (error) return next(BoxError.toHttpError(error)); res.writeHead(200, { 'Content-Type': 'text/event-stream', 'Cache-Control': 'no-cache', 'Connection': 'keep-alive', 'X-Accel-Buffering': 'no', // disable nginx buffering 'Access-Control-Allow-Origin': '*' }); res.write('retry: 3000\n'); res.on('close', logStream.close); logStream.on('data', function (data) { var obj = JSON.parse(data); res.write(sse(obj.realtimeTimestamp, JSON.stringify(obj))); // send timestamp as id }); logStream.on('end', res.end.bind(res)); logStream.on('error', res.end.bind(res, null)); }); } function getLogs(req, res, next) { assert.strictEqual(typeof req.resource, 'object'); var lines = 'lines' in req.query ? parseInt(req.query.lines, 10) : 10; if (isNaN(lines)) return next(new HttpError(400, 'lines must be a number')); var options = { lines: lines, follow: false, format: req.query.format || 'json' }; apps.getLogs(req.resource, options, function (error, logStream) { if (error) return next(BoxError.toHttpError(error)); res.writeHead(200, { 'Content-Type': 'application/x-logs', 'Content-Disposition': `attachment; filename="${req.resource.id}.log"`, 'Cache-Control': 'no-cache', 'X-Accel-Buffering': 'no' // disable nginx buffering }); logStream.pipe(res); }); } function demuxStream(stream, stdin) { var header = null; stream.on('readable', function() { header = header || stream.read(4); while (header !== null) { var length = header.readUInt32BE(0); if (length === 0) { header = null; return stdin.end(); // EOF } var payload = stream.read(length); if (payload === null) break; stdin.write(payload); header = stream.read(4); } }); } async function exec(req, res, next) { assert.strictEqual(typeof req.resource, 'object'); let cmd = null; if (req.query.cmd) { cmd = safe.JSON.parse(req.query.cmd); if (!Array.isArray(cmd) || cmd.length < 1) return next(new HttpError(400, 'cmd must be array with atleast size 1')); } const columns = req.query.columns ? parseInt(req.query.columns, 10) : null; if (isNaN(columns)) return next(new HttpError(400, 'columns must be a number')); const rows = req.query.rows ? parseInt(req.query.rows, 10) : null; if (isNaN(rows)) return next(new HttpError(400, 'rows must be a number')); const tty = req.query.tty === 'true'; if (safe.query(req.resource, 'manifest.addons.docker') && req.user.role !== users.ROLE_OWNER) return next(new HttpError(403, '"owner" role is requied to exec app with docker addon')); // in a badly configured reverse proxy, we might be here without an upgrade if (req.headers['upgrade'] !== 'tcp') return next(new HttpError(404, 'exec requires TCP upgrade')); const [error, duplexStream] = await safe(apps.exec(req.resource, { cmd: cmd, rows: rows, columns: columns, tty: tty })); if (error) return next(BoxError.toHttpError(error)); req.clearTimeout(); res.sendUpgradeHandshake(); // When tty is disabled, the duplexStream has 2 separate streams. When enabled, it has stdout/stderr merged. duplexStream.pipe(res.socket); if (tty) { res.socket.pipe(duplexStream); // in tty mode, the client always waits for server to exit } else { demuxStream(res.socket, duplexStream); res.socket.on('error', function () { duplexStream.end(); }); res.socket.on('end', function () { duplexStream.end(); }); } } async function execWebSocket(req, res, next) { assert.strictEqual(typeof req.resource, 'object'); let cmd = null; if (req.query.cmd) { cmd = safe.JSON.parse(req.query.cmd); if (!Array.isArray(cmd) || cmd.length < 1) return next(new HttpError(400, 'cmd must be array with atleast size 1')); } const columns = req.query.columns ? parseInt(req.query.columns, 10) : null; if (isNaN(columns)) return next(new HttpError(400, 'columns must be a number')); const rows = req.query.rows ? parseInt(req.query.rows, 10) : null; if (isNaN(rows)) return next(new HttpError(400, 'rows must be a number')); const tty = req.query.tty === 'true' ? true : false; // in a badly configured reverse proxy, we might be here without an upgrade if (req.headers['upgrade'] !== 'websocket') return next(new HttpError(404, 'exec requires websocket')); const [error, duplexStream] = await safe(apps.exec(req.resource, { cmd: cmd, rows: rows, columns: columns, tty: tty })); if (error) return next(BoxError.toHttpError(error)); req.clearTimeout(); res.handleUpgrade(function (ws) { duplexStream.on('end', function () { ws.close(); }); duplexStream.on('close', function () { ws.close(); }); duplexStream.on('error', function (error) { debug('duplexStream error:', error); }); duplexStream.on('data', function (data) { if (ws.readyState !== WebSocket.OPEN) return; ws.send(data.toString()); }); ws.on('error', function (error) { debug('websocket error:', error); }); ws.on('message', function (msg) { duplexStream.write(msg); }); ws.on('close', function () { // Clean things up, if any? }); }); } async function listBackups(req, res, next) { assert.strictEqual(typeof req.resource, 'object'); const page = typeof req.query.page !== 'undefined' ? parseInt(req.query.page) : 1; if (!page || page < 0) return next(new HttpError(400, 'page query param has to be a postive number')); const perPage = typeof req.query.per_page !== 'undefined'? parseInt(req.query.per_page) : 25; if (!perPage || perPage < 0) return next(new HttpError(400, 'per_page query param has to be a postive number')); const [error, result] = await safe(apps.listBackups(req.resource, page, perPage)); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(200, { backups: result })); } function uploadFile(req, res, next) { assert.strictEqual(typeof req.resource, 'object'); if (typeof req.query.file !== 'string' || !req.query.file) return next(new HttpError(400, 'file query argument must be provided')); if (!req.files.file) return next(new HttpError(400, 'file must be provided as multipart')); apps.uploadFile(req.resource, req.files.file.path, req.query.file, function (error) { if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(202, {})); }); } function downloadFile(req, res, next) { assert.strictEqual(typeof req.resource, 'object'); if (typeof req.query.file !== 'string' || !req.query.file) return next(new HttpError(400, 'file query argument must be provided')); apps.downloadFile(req.resource, req.query.file, function (error, stream, info) { if (error) return next(BoxError.toHttpError(error)); var headers = { 'Content-Type': 'application/octet-stream', 'Content-Disposition': `attachment; filename*=utf-8''${encodeURIComponent(info.filename)}` // RFC 2184 section 4 }; if (info.size) headers['Content-Length'] = info.size; res.writeHead(200, headers); stream.pipe(res); }); } async function setMounts(req, res, next) { assert.strictEqual(typeof req.body, 'object'); assert.strictEqual(typeof req.resource, 'object'); if (!Array.isArray(req.body.mounts)) return next(new HttpError(400, 'mounts should be an array')); for (let m of req.body.mounts) { if (!m || typeof m !== 'object') return next(new HttpError(400, 'mounts must be an object')); if (typeof m.volumeId !== 'string') return next(new HttpError(400, 'volumeId must be a string')); if (typeof m.readOnly !== 'boolean') return next(new HttpError(400, 'readOnly must be a boolean')); } const [error, result] = await safe(apps.setMounts(req.resource, req.body.mounts, auditSource.fromRequest(req))); if (error) return next(BoxError.toHttpError(error)); next(new HttpSuccess(202, { taskId: result.taskId })); }