/*! firebase-admin v8.9.2 */ "use strict"; /*! * Copyright 2017 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ Object.defineProperty(exports, "__esModule", { value: true }); // Use untyped import syntax for Node built-ins var fs = require("fs"); var os = require("os"); var path = require("path"); var error_1 = require("../utils/error"); var api_request_1 = require("../utils/api-request"); var util = require("../utils/validator"); var GOOGLE_TOKEN_AUDIENCE = 'https://accounts.google.com/o/oauth2/token'; var GOOGLE_AUTH_TOKEN_HOST = 'accounts.google.com'; var GOOGLE_AUTH_TOKEN_PATH = '/o/oauth2/token'; // NOTE: the Google Metadata Service uses HTTP over a vlan var GOOGLE_METADATA_SERVICE_HOST = 'metadata.google.internal'; var GOOGLE_METADATA_SERVICE_TOKEN_PATH = '/computeMetadata/v1/instance/service-accounts/default/token'; var GOOGLE_METADATA_SERVICE_PROJECT_ID_PATH = '/computeMetadata/v1/project/project-id'; var configDir = (function () { // Windows has a dedicated low-rights location for apps at ~/Application Data var sys = os.platform(); if (sys && sys.length >= 3 && sys.substring(0, 3).toLowerCase() === 'win') { return process.env.APPDATA; } // On *nix the gcloud cli creates a . dir. return process.env.HOME && path.resolve(process.env.HOME, '.config'); })(); var GCLOUD_CREDENTIAL_SUFFIX = 'gcloud/application_default_credentials.json'; var GCLOUD_CREDENTIAL_PATH = configDir && path.resolve(configDir, GCLOUD_CREDENTIAL_SUFFIX); var REFRESH_TOKEN_HOST = 'www.googleapis.com'; var REFRESH_TOKEN_PATH = '/oauth2/v4/token'; var ONE_HOUR_IN_SECONDS = 60 * 60; var JWT_ALGORITHM = 'RS256'; /** * Implementation of Credential that uses a service account. */ var ServiceAccountCredential = /** @class */ (function () { /** * Creates a new ServiceAccountCredential from the given parameters. * * @param serviceAccountPathOrObject Service account json object or path to a service account json file. * @param httpAgent Optional http.Agent to use when calling the remote token server. * @param implicit An optinal boolean indicating whether this credential was implicitly discovered from the * environment, as opposed to being explicitly specified by the developer. * * @constructor */ function ServiceAccountCredential(serviceAccountPathOrObject, httpAgent, implicit) { if (implicit === void 0) { implicit = false; } this.httpAgent = httpAgent; this.implicit = implicit; var serviceAccount = (typeof serviceAccountPathOrObject === 'string') ? ServiceAccount.fromPath(serviceAccountPathOrObject) : new ServiceAccount(serviceAccountPathOrObject); this.projectId = serviceAccount.projectId; this.privateKey = serviceAccount.privateKey; this.clientEmail = serviceAccount.clientEmail; this.httpClient = new api_request_1.HttpClient(); } ServiceAccountCredential.prototype.getAccessToken = function () { var token = this.createAuthJwt_(); var postData = 'grant_type=urn%3Aietf%3Aparams%3Aoauth%3A' + 'grant-type%3Ajwt-bearer&assertion=' + token; var request = { method: 'POST', url: "https://" + GOOGLE_AUTH_TOKEN_HOST + GOOGLE_AUTH_TOKEN_PATH, headers: { 'Content-Type': 'application/x-www-form-urlencoded', }, data: postData, httpAgent: this.httpAgent, }; return requestAccessToken(this.httpClient, request); }; ServiceAccountCredential.prototype.createAuthJwt_ = function () { var claims = { scope: [ 'https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/firebase.database', 'https://www.googleapis.com/auth/firebase.messaging', 'https://www.googleapis.com/auth/identitytoolkit', 'https://www.googleapis.com/auth/userinfo.email', ].join(' '), }; var jwt = require('jsonwebtoken'); // This method is actually synchronous so we can capture and return the buffer. return jwt.sign(claims, this.privateKey, { audience: GOOGLE_TOKEN_AUDIENCE, expiresIn: ONE_HOUR_IN_SECONDS, issuer: this.clientEmail, algorithm: JWT_ALGORITHM, }); }; return ServiceAccountCredential; }()); exports.ServiceAccountCredential = ServiceAccountCredential; /** * A struct containing the properties necessary to use service account JSON credentials. */ var ServiceAccount = /** @class */ (function () { function ServiceAccount(json) { if (!util.isNonNullObject(json)) { throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, 'Service account must be an object.'); } copyAttr(this, json, 'projectId', 'project_id'); copyAttr(this, json, 'privateKey', 'private_key'); copyAttr(this, json, 'clientEmail', 'client_email'); var errorMessage; if (!util.isNonEmptyString(this.projectId)) { errorMessage = 'Service account object must contain a string "project_id" property.'; } else if (!util.isNonEmptyString(this.privateKey)) { errorMessage = 'Service account object must contain a string "private_key" property.'; } else if (!util.isNonEmptyString(this.clientEmail)) { errorMessage = 'Service account object must contain a string "client_email" property.'; } if (typeof errorMessage !== 'undefined') { throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, errorMessage); } var forge = require('node-forge'); try { forge.pki.privateKeyFromPem(this.privateKey); } catch (error) { throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, 'Failed to parse private key: ' + error); } } ServiceAccount.fromPath = function (filePath) { try { return new ServiceAccount(JSON.parse(fs.readFileSync(filePath, 'utf8'))); } catch (error) { // Throw a nicely formed error message if the file contents cannot be parsed throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, 'Failed to parse service account json file: ' + error); } }; return ServiceAccount; }()); /** * Implementation of Credential that gets access tokens from the metadata service available * in the Google Cloud Platform. This authenticates the process as the default service account * of an App Engine instance or Google Compute Engine machine. */ var ComputeEngineCredential = /** @class */ (function () { function ComputeEngineCredential(httpAgent) { this.httpClient = new api_request_1.HttpClient(); this.httpAgent = httpAgent; } ComputeEngineCredential.prototype.getAccessToken = function () { var request = this.buildRequest(GOOGLE_METADATA_SERVICE_TOKEN_PATH); return requestAccessToken(this.httpClient, request); }; ComputeEngineCredential.prototype.getProjectId = function () { var _this = this; if (this.projectId) { return Promise.resolve(this.projectId); } var request = this.buildRequest(GOOGLE_METADATA_SERVICE_PROJECT_ID_PATH); return this.httpClient.send(request) .then(function (resp) { _this.projectId = resp.text; return _this.projectId; }) .catch(function (err) { var detail = (err instanceof api_request_1.HttpError) ? getDetailFromResponse(err.response) : err.message; throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, "Failed to determine project ID: " + detail); }); }; ComputeEngineCredential.prototype.buildRequest = function (urlPath) { return { method: 'GET', url: "http://" + GOOGLE_METADATA_SERVICE_HOST + urlPath, headers: { 'Metadata-Flavor': 'Google', }, httpAgent: this.httpAgent, }; }; return ComputeEngineCredential; }()); exports.ComputeEngineCredential = ComputeEngineCredential; /** * Implementation of Credential that gets access tokens from refresh tokens. */ var RefreshTokenCredential = /** @class */ (function () { /** * Creates a new RefreshTokenCredential from the given parameters. * * @param refreshTokenPathOrObject Refresh token json object or path to a refresh token (user credentials) json file. * @param httpAgent Optional http.Agent to use when calling the remote token server. * @param implicit An optinal boolean indicating whether this credential was implicitly discovered from the * environment, as opposed to being explicitly specified by the developer. * * @constructor */ function RefreshTokenCredential(refreshTokenPathOrObject, httpAgent, implicit) { if (implicit === void 0) { implicit = false; } this.httpAgent = httpAgent; this.implicit = implicit; this.refreshToken = (typeof refreshTokenPathOrObject === 'string') ? RefreshToken.fromPath(refreshTokenPathOrObject) : new RefreshToken(refreshTokenPathOrObject); this.httpClient = new api_request_1.HttpClient(); } RefreshTokenCredential.prototype.getAccessToken = function () { var postData = 'client_id=' + this.refreshToken.clientId + '&' + 'client_secret=' + this.refreshToken.clientSecret + '&' + 'refresh_token=' + this.refreshToken.refreshToken + '&' + 'grant_type=refresh_token'; var request = { method: 'POST', url: "https://" + REFRESH_TOKEN_HOST + REFRESH_TOKEN_PATH, headers: { 'Content-Type': 'application/x-www-form-urlencoded', }, data: postData, httpAgent: this.httpAgent, }; return requestAccessToken(this.httpClient, request); }; return RefreshTokenCredential; }()); exports.RefreshTokenCredential = RefreshTokenCredential; var RefreshToken = /** @class */ (function () { function RefreshToken(json) { copyAttr(this, json, 'clientId', 'client_id'); copyAttr(this, json, 'clientSecret', 'client_secret'); copyAttr(this, json, 'refreshToken', 'refresh_token'); copyAttr(this, json, 'type', 'type'); var errorMessage; if (!util.isNonEmptyString(this.clientId)) { errorMessage = 'Refresh token must contain a "client_id" property.'; } else if (!util.isNonEmptyString(this.clientSecret)) { errorMessage = 'Refresh token must contain a "client_secret" property.'; } else if (!util.isNonEmptyString(this.refreshToken)) { errorMessage = 'Refresh token must contain a "refresh_token" property.'; } else if (!util.isNonEmptyString(this.type)) { errorMessage = 'Refresh token must contain a "type" property.'; } if (typeof errorMessage !== 'undefined') { throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, errorMessage); } } /* * Tries to load a RefreshToken from a path. Throws if the path doesn't exist or the * data at the path is invalid. */ RefreshToken.fromPath = function (filePath) { try { return new RefreshToken(JSON.parse(fs.readFileSync(filePath, 'utf8'))); } catch (error) { // Throw a nicely formed error message if the file contents cannot be parsed throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, 'Failed to parse refresh token file: ' + error); } }; return RefreshToken; }()); function getApplicationDefault(httpAgent) { if (process.env.GOOGLE_APPLICATION_CREDENTIALS) { return credentialFromFile(process.env.GOOGLE_APPLICATION_CREDENTIALS, httpAgent); } // It is OK to not have this file. If it is present, it must be valid. if (GCLOUD_CREDENTIAL_PATH) { var refreshToken = readCredentialFile(GCLOUD_CREDENTIAL_PATH, true); if (refreshToken) { return new RefreshTokenCredential(refreshToken, httpAgent, true); } } return new ComputeEngineCredential(httpAgent); } exports.getApplicationDefault = getApplicationDefault; /** * Checks if the given credential was loaded via the application default credentials mechanism. This * includes all ComputeEngineCredential instances, and the ServiceAccountCredential and RefreshTokenCredential * instances that were loaded from well-known files or environment variables, rather than being explicitly * instantiated. * * @param credential The credential instance to check. */ function isApplicationDefault(credential) { return credential instanceof ComputeEngineCredential || (credential instanceof ServiceAccountCredential && credential.implicit) || (credential instanceof RefreshTokenCredential && credential.implicit); } exports.isApplicationDefault = isApplicationDefault; /** * Copies the specified property from one object to another. * * If no property exists by the given "key", looks for a property identified by "alt", and copies it instead. * This can be used to implement behaviors such as "copy property myKey or my_key". * * @param to Target object to copy the property into. * @param from Source object to copy the property from. * @param key Name of the property to copy. * @param alt Alternative name of the property to copy. */ function copyAttr(to, from, key, alt) { var tmp = from[key] || from[alt]; if (typeof tmp !== 'undefined') { to[key] = tmp; } } /** * Obtain a new OAuth2 token by making a remote service call. */ function requestAccessToken(client, request) { return client.send(request).then(function (resp) { var json = resp.data; if (!json.access_token || !json.expires_in) { throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, "Unexpected response while fetching access token: " + JSON.stringify(json)); } return json; }).catch(function (err) { throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, getErrorMessage(err)); }); } /** * Constructs a human-readable error message from the given Error. */ function getErrorMessage(err) { var detail = (err instanceof api_request_1.HttpError) ? getDetailFromResponse(err.response) : err.message; return "Error fetching access token: " + detail; } /** * Extracts details from the given HTTP error response, and returns a human-readable description. If * the response is JSON-formatted, looks up the error and error_description fields sent by the * Google Auth servers. Otherwise returns the entire response payload as the error detail. */ function getDetailFromResponse(response) { if (response.isJson() && response.data.error) { var json = response.data; var detail = json.error; if (json.error_description) { detail += ' (' + json.error_description + ')'; } return detail; } return response.text || 'Missing error payload'; } function credentialFromFile(filePath, httpAgent) { var credentialsFile = readCredentialFile(filePath); if (typeof credentialsFile !== 'object' || credentialsFile === null) { throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, 'Failed to parse contents of the credentials file as an object'); } if (credentialsFile.type === 'service_account') { return new ServiceAccountCredential(credentialsFile, httpAgent, true); } if (credentialsFile.type === 'authorized_user') { return new RefreshTokenCredential(credentialsFile, httpAgent, true); } throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, 'Invalid contents in the credentials file'); } function readCredentialFile(filePath, ignoreMissing) { var fileText; try { fileText = fs.readFileSync(filePath, 'utf8'); } catch (error) { if (ignoreMissing) { return null; } throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, "Failed to read credentials from file " + filePath + ": " + error); } try { return JSON.parse(fileText); } catch (error) { throw new error_1.FirebaseAppError(error_1.AppErrorCodes.INVALID_CREDENTIAL, 'Failed to parse contents of the credentials file as an object: ' + error); } }