module.exports = { friendlyName: 'Modify android device', description: 'Modifies a device of an Android enterprise', inputs: { androidEnterpriseId: { type: 'string', required: true, }, deviceId: { type: 'string', required: true, }, }, exits: { success: { description: 'The device of an Android enterprise was successfully updated.' }, missingAuthHeader: { description: 'This request was missing an authorization header.', responseType: 'unauthorized'}, unauthorized: { description: 'Invalid authentication token.', responseType: 'unauthorized'}, notFound: { description: 'No Android enterprise found for this Fleet server.', responseType: 'notFound' }, deviceNoLongerManaged: { description: 'The device is no longer managed by the Android enterprise.', responseType: 'notFound' }, invalidPolicyName: {description: 'The specified policy_name is invalid', responseType: 'badRequest' } }, fn: async function ({ androidEnterpriseId, deviceId}) { // Extract fleetServerSecret from the Authorization header let authHeader = this.req.get('authorization'); let fleetServerSecret; if (authHeader && authHeader.startsWith('Bearer')) { fleetServerSecret = authHeader.replace('Bearer', '').trim(); } else { throw 'missingAuthHeader'; } // Authenticate this request let thisAndroidEnterprise = await AndroidEnterprise.findOne({ androidEnterpriseId: androidEnterpriseId }); // Return a 404 response if no records are found. if (!thisAndroidEnterprise) { throw 'notFound'; } // Return an unauthorized response if the provided secret does not match. if (thisAndroidEnterprise.fleetServerSecret !== fleetServerSecret) { throw 'unauthorized'; } // Check the list of Android Enterprises managed by Fleet to see if this Android Enterprise is still managed. let isEnterpriseManagedByFleet = await sails.helpers.androidProxy.getIsEnterpriseManagedByFleet(androidEnterpriseId); // Return a 404 response if this Android enterprise is no longer managed by Fleet. if(!isEnterpriseManagedByFleet) { throw 'notFound'; } // Update the device for this Android enterprise. // Note: We're using sails.helpers.flow.build here to handle any errors that occur using google's node library. let modifyDeviceResponse = await sails.helpers.flow.build(async () => { let { google } = require('googleapis'); let androidmanagement = google.androidmanagement('v1'); let googleAuth = new google.auth.GoogleAuth({ scopes: ['https://www.googleapis.com/auth/androidmanagement'], credentials: { client_email: sails.config.custom.androidEnterpriseServiceAccountEmailAddress,// eslint-disable-line camelcase private_key: sails.config.custom.androidEnterpriseServiceAccountPrivateKey,// eslint-disable-line camelcase }, }); // Acquire the google auth client, and bind it to all future calls let authClient = await googleAuth.getClient(); google.options({ auth: authClient }); // [?]: https://googleapis.dev/nodejs/googleapis/latest/androidmanagement/classes/Resource$Enterprises$Devices.html#patch let patchDeviceResponse = await androidmanagement.enterprises.devices.patch({ name: `enterprises/${androidEnterpriseId}/devices/${deviceId}`, // Note: Typically, we use defined inputs instead of accessing req.body directly. We forward req.body here to prevent previously set values from being overwritten by undefined values. // This behavior should not be repeated in future Android proxy endpoints. requestBody: this.req.body, }); return patchDeviceResponse.data; }).intercept({status: 429}, (err)=>{ // If the Android management API returns a 429 response, log an additional warning that will trigger a help-p1 alert. sails.log.warn(`p1: Android management API rate limit exceeded!`); return new Error(`When attempting to update a device for an Android enterprise (${androidEnterpriseId}), an error occurred. Error: ${err}`); }).intercept((err)=>{ let errorString = err.toString(); if (errorString.includes('Device is no longer being managed')) { return {'deviceNoLongerManaged': 'The device is no longer managed by the Android enterprise.'}; } if(errorString.includes('policy_name is expected to start')) { return {'invalidPolicyName': 'The request could not be completed because of an invalid policy name.'}; } return new Error(`When attempting to update a device for an Android enterprise (${androidEnterpriseId}), an error occurred. Error: ${require('util').inspect(err)}`); }); // Return the modified device back to the Fleet server. return modifyDeviceResponse; } };