Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 4x 4x 4x 4x 4x 4x 4x 4x 4x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 3x 3x 2x 2x 2x 1x 4x 4x 3x 3x 3x 3x 3x 1x 1x 1x 3x 3x 3x 3x 3x 3x 3x 1x 1x 1x 3x 3x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 3x 3x 3x 3x 3x 3x 3x 3x 3x 1x 2x 2x 2x 2x 2x 2x 1x 3x 3x 3x 3x 3x 3x 3x 3x 3x 1x 3x 3x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 2x 2x 2x 2x 2x 2x 2x 1x 3x 3x 3x 1x 15x 15x 15x 15x 15x 14x 1x 1x 1x 4x 3x 1x 1x 17x 1x 1x 1x 8x 3x 3x 3x 3x 3x 3x 5x 5x 5x 5x 1x 4x 1x 3x 2x 5x 5x 3x 2x 1x 5x 5x 1x 4x 1x 75x 1x 3x 3x 1x 11x 11x 1x 23x 1x 1x | /* eslint-disable no-undef */
/* eslint-disable camelcase */
/**
Copyright (c) 2018 Intuit
#
# 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.
*/
/**
* @namespace OAuthClient
*/
'use strict';
const atob = require('atob');
const Csrf = require('csrf');
const queryString = require('query-string');
const popsicle = require('popsicle');
const os = require('os');
const winston = require('winston');
const path = require('path');
const fs = require('fs');
const jwt = require('jsonwebtoken');
const AuthResponse = require('./response/AuthResponse');
const version = require('../package.json');
const Token = require('./access-token/Token');
/**
* @constructor
* @param {string} config.environment
* @param {string} config.appSecret
* @param {string} config.appKey
* @param {string} [config.cachePrefix]
*/
function OAuthClient(config) {
this.environment = config.environment;
this.clientId = config.clientId;
this.clientSecret = config.clientSecret;
this.redirectUri = config.redirectUri;
this.token = new Token(config.token);
this.logging = !!(
Object.prototype.hasOwnProperty.call(config, 'logging') && config.logging === true
);
this.logger = null;
this.state = new Csrf();
Iif (this.logging) {
const dir = './logs';
if (!fs.existsSync(dir)) {
fs.mkdirSync(dir);
}
this.logger = winston.createLogger({
level: 'info',
format: winston.format.combine(
winston.format.timestamp(),
winston.format.printf((info) => `${info.timestamp} ${info.level}: ${info.message}`),
),
transports: [
new winston.transports.File({
filename: path.join(dir, 'oAuthClient-log.log'),
}),
],
});
}
}
OAuthClient.cacheId = 'cacheID';
OAuthClient.authorizeEndpoint = 'https://appcenter.intuit.com/connect/oauth2';
OAuthClient.tokenEndpoint = 'https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer';
OAuthClient.revokeEndpoint = 'https://developer.api.intuit.com/v2/oauth2/tokens/revoke';
OAuthClient.userinfo_endpoint_production =
'https://accounts.platform.intuit.com/v1/openid_connect/userinfo';
OAuthClient.userinfo_endpoint_sandbox =
'https://sandbox-accounts.platform.intuit.com/v1/openid_connect/userinfo';
OAuthClient.migrate_sandbox = 'https://developer-sandbox.api.intuit.com/v2/oauth2/tokens/migrate';
OAuthClient.migrate_production = 'https://developer.api.intuit.com/v2/oauth2/tokens/migrate';
OAuthClient.environment = {
sandbox: 'https://sandbox-quickbooks.api.intuit.com/',
production: 'https://quickbooks.api.intuit.com/',
};
OAuthClient.jwks_uri = 'https://oauth.platform.intuit.com/op/v1/jwks';
OAuthClient.scopes = {
Accounting: 'com.intuit.quickbooks.accounting',
Payment: 'com.intuit.quickbooks.payment',
Payroll: 'com.intuit.quickbooks.payroll',
TimeTracking: 'com.intuit.quickbooks.payroll.timetracking',
Benefits: 'com.intuit.quickbooks.payroll.benefits',
Profile: 'profile',
Email: 'email',
Phone: 'phone',
Address: 'address',
OpenId: 'openid',
Intuit_name: 'intuit_name',
};
OAuthClient.user_agent = `Intuit-OAuthClient-JS_${
version.version
}_${os.type()}_${os.release()}_${os.platform()}`;
OAuthClient.prototype.setAuthorizeURLs = function setAuthorizeURLs(params) {
// check if the customURL's are passed correctly
if (!params) {
throw new Error("Provide the custom authorize URL's");
}
OAuthClient.authorizeEndpoint = params.authorizeEndpoint;
OAuthClient.tokenEndpoint = params.tokenEndpoint;
OAuthClient.revokeEndpoint = params.revokeEndpoint;
this.environment === 'sandbox'
? (OAuthClient.userinfo_endpoint_sandbox = params.userInfoEndpoint)
: (OAuthClient.userinfo_endpoint_production = params.userInfoEndpoint);
return this;
};
/**
* Redirect User to Authorization Page
* *
* @param params
* @returns {string} authorize Uri
*/
OAuthClient.prototype.authorizeUri = function authorizeUri(params) {
params = params || {};
// check if the scopes is provided
if (!params.scope) throw new Error('Provide the scopes');
const authUri = `${OAuthClient.authorizeEndpoint}?${queryString.stringify({
response_type: 'code',
redirect_uri: this.redirectUri,
client_id: this.clientId,
scope: Array.isArray(params.scope) ? params.scope.join(' ') : params.scope,
state: params.state || this.state.create(this.state.secretSync()),
})}`;
this.log('info', 'The Authorize Uri is :', authUri);
return authUri;
};
/**
* Create Token { exchange authorization code for bearer_token }
* *
* @param {string|Object} uri
* @returns {Promise}
*/
OAuthClient.prototype.createToken = function createToken(uri) {
return new Promise((resolve) => {
if (!uri) throw new Error('Provide the Uri');
const params = queryString.parse(uri.split('?').reverse()[0]);
this.getToken().realmId = params.realmId ? params.realmId : '';
Eif ('state' in params) this.getToken().state = params.state;
const body = {};
if (params.code) {
body.grant_type = 'authorization_code';
body.code = params.code;
body.redirect_uri = params.redirectUri || this.redirectUri;
}
const request = {
url: OAuthClient.tokenEndpoint,
body,
method: 'POST',
headers: {
Authorization: `Basic ${this.authHeader()}`,
'Content-Type': AuthResponse._urlencodedContentType,
Accept: AuthResponse._jsonContentType,
'User-Agent': OAuthClient.user_agent,
},
};
resolve(this.getTokenRequest(request));
})
.then((res) => {
const authResponse = res.json ? res : null;
const json = (authResponse && authResponse.getJson()) || res;
this.token.setToken(json);
this.log('info', 'Create Token response is : ', JSON.stringify(authResponse, null, 2));
return authResponse;
})
.catch((e) => {
this.log('error', 'Create Token () threw an exception : ', JSON.stringify(e, null, 2));
throw e;
});
};
/**
* Refresh the access_token
* *
* @returns {Promise}
*/
OAuthClient.prototype.refresh = function refresh() {
return new Promise((resolve) => {
this.validateToken();
const body = {};
body.grant_type = 'refresh_token';
body.refresh_token = this.getToken().refresh_token;
const request = {
url: OAuthClient.tokenEndpoint,
body,
method: 'POST',
headers: {
Authorization: `Basic ${this.authHeader()}`,
'Content-Type': AuthResponse._urlencodedContentType,
Accept: AuthResponse._jsonContentType,
'User-Agent': OAuthClient.user_agent,
},
};
resolve(this.getTokenRequest(request));
})
.then((res) => {
const authResponse = res.json ? res : null;
const json = (authResponse && authResponse.getJson()) || res;
this.token.setToken(json);
this.log('info', 'Refresh Token () response is : ', JSON.stringify(authResponse, null, 2));
return authResponse;
})
.catch((e) => {
this.log('error', 'Refresh Token () threw an exception : ', JSON.stringify(e, null, 2));
throw e;
});
};
/**
* Refresh Tokens by passing refresh_token parameter explicitly
* *
* @param {string} refresh_token
* @returns {Promise}
*/
OAuthClient.prototype.refreshUsingToken = function refreshUsingToken(refresh_token) {
return new Promise((resolve) => {
if (!refresh_token) throw new Error('The Refresh token is missing');
const body = {};
body.grant_type = 'refresh_token';
body.refresh_token = refresh_token;
const request = {
url: OAuthClient.tokenEndpoint,
body,
method: 'POST',
headers: {
Authorization: `Basic ${this.authHeader()}`,
'Content-Type': AuthResponse._urlencodedContentType,
Accept: AuthResponse._jsonContentType,
'User-Agent': OAuthClient.user_agent,
},
};
resolve(this.getTokenRequest(request));
})
.then((res) => {
const authResponse = res.json ? res : null;
const json = (authResponse && authResponse.getJson()) || res;
this.token.setToken(json);
this.log(
'info',
'Refresh usingToken () response is : ',
JSON.stringify(authResponse, null, 2),
);
return authResponse;
})
.catch((e) => {
this.log('error', 'Refresh Token () threw an exception : ', JSON.stringify(e, null, 2));
throw e;
});
};
/**
* Revoke access_token/refresh_token
* *
* @param {Object} params.access_token (optional)
* @param {Object} params.refresh_token (optional)
* @returns {Promise}
*/
OAuthClient.prototype.revoke = function revoke(params) {
return new Promise((resolve) => {
params = params || {};
const body = {};
body.token =
params.access_token ||
params.refresh_token ||
(this.getToken().isAccessTokenValid()
? this.getToken().access_token
: this.getToken().refresh_token);
const request = {
url: OAuthClient.revokeEndpoint,
body,
method: 'POST',
headers: {
Authorization: `Basic ${this.authHeader()}`,
Accept: AuthResponse._jsonContentType,
'Content-Type': AuthResponse._jsonContentType,
'User-Agent': OAuthClient.user_agent,
},
};
resolve(this.getTokenRequest(request));
})
.then((authResponse) => {
this.token.clearToken();
this.log('info', 'Revoke Token () response is : ', JSON.stringify(authResponse, null, 2));
return authResponse;
})
.catch((e) => {
this.log('error', 'Revoke Token () threw an exception : ', JSON.stringify(e, null, 2));
throw e;
});
};
/**
* Get User Info { Get User Info }
* *
* @returns {Promise}
*/
OAuthClient.prototype.getUserInfo = function getUserInfo() {
return new Promise((resolve) => {
const request = {
url:
this.environment === 'sandbox'
? OAuthClient.userinfo_endpoint_sandbox
: OAuthClient.userinfo_endpoint_production,
method: 'GET',
headers: {
Authorization: `Bearer ${this.token.access_token}`,
Accept: AuthResponse._jsonContentType,
'User-Agent': OAuthClient.user_agent,
},
};
resolve(this.getTokenRequest(request));
})
.then((res) => {
const authResponse = res.json ? res : null;
this.log(
'info',
'The Get User Info () response is : ',
JSON.stringify(authResponse, null, 2),
);
return authResponse;
})
.catch((e) => {
this.log('error', 'Get User Info () threw an exception : ', JSON.stringify(e, null, 2));
throw e;
});
};
/**
* Make API call. Pass the url,method,headers using `params` object
* *
* @param {Object} params
* @returns {Promise}
*/
OAuthClient.prototype.makeApiCall = function makeApiCall(params) {
return new Promise((resolve) => {
params = params || {};
const transport = params.transport ? params.transport : popsicle.createTransport({ type: "text" });
const headers =
params.headers && typeof params.headers === 'object'
? Object.assign(
{},
{
Authorization: `Bearer ${this.getToken().access_token}`,
Accept: AuthResponse._jsonContentType,
'User-Agent': OAuthClient.user_agent,
},
params.headers
)
: Object.assign(
{},
{
Authorization: `Bearer ${this.getToken().access_token}`,
Accept: AuthResponse._jsonContentType,
'User-Agent': OAuthClient.user_agent,
}
);
const request = {
url: params.url,
method: params.method || 'GET',
headers,
transport,
};
params.body && (request.body = params.body);
resolve(this.getTokenRequest(request));
})
.then((authResponse) => {
this.log('info', 'The makeAPICall () response is : ', JSON.stringify(authResponse, null, 2));
return authResponse;
})
.catch((e) => {
this.log('error', 'Get makeAPICall () threw an exception : ', JSON.stringify(e, null, 2));
throw e;
});
};
/**
* Validate id_token
* *
* @param {Object} params(optional)
* @returns {Promise<AuthResponse>}
*/
OAuthClient.prototype.validateIdToken = function validateIdToken(params = {}) {
return new Promise((resolve) => {
if (!this.getToken().id_token) throw new Error('The bearer token does not have id_token');
const id_token = this.getToken().id_token || params.id_token;
// Decode ID Token
const token_parts = id_token.split('.');
const id_token_header = JSON.parse(atob(token_parts[0]));
const id_token_payload = JSON.parse(atob(token_parts[1]));
// Step 1 : First check if the issuer is as mentioned in "issuer"
Iif (id_token_payload.iss !== 'https://oauth.platform.intuit.com/op/v1') return false;
// Step 2 : check if the aud field in idToken contains application's clientId
Iif (!id_token_payload.aud.find((audience) => audience === this.clientId)) return false;
// Step 3 : ensure the timestamp has not elapsed
Iif (id_token_payload.exp < Date.now() / 1000) return false;
const request = {
url: OAuthClient.jwks_uri,
method: 'GET',
headers: {
Accept: AuthResponse._jsonContentType,
'User-Agent': OAuthClient.user_agent,
},
};
return resolve(this.getKeyFromJWKsURI(id_token, id_token_header.kid, request));
})
.then((res) => {
this.log('info', 'The validateIdToken () response is : ', JSON.stringify(res, null, 2));
Eif (res) return true;
return false;
})
.catch((e) => {
this.log('error', 'The validateIdToken () threw an exception : ', JSON.stringify(e, null, 2));
throw e;
});
};
/**
* Get Key from JWKURI
* *
* @param {string} id_token
* @param {string} kid
* @param {Object} request
* @returns {Promise}
*/
OAuthClient.prototype.getKeyFromJWKsURI = function getKeyFromJWKsURI(id_token, kid, request) {
return new Promise((resolve) => {
resolve(this.loadResponse(request));
})
.then((response) => {
Iif (Number(response.status) !== 200) throw new Error('Could not reach JWK endpoint');
// Find the key by KID
const responseBody = JSON.parse(response.body);
const key = responseBody.keys.find((el) => el.kid === kid);
const cert = this.getPublicKey(key.n, key.e);
return jwt.verify(id_token, cert);
})
.catch((e) => {
e = this.createError(e);
this.log(
'error',
'The getKeyFromJWKsURI () threw an exception : ',
JSON.stringify(e, null, 2),
);
throw e;
});
};
/**
* Get Public Key
* *
* @param modulus
* @param exponent
*/
OAuthClient.prototype.getPublicKey = function getPublicKey(modulus, exponent) {
// eslint-disable-next-line global-require
const getPem = require('rsa-pem-from-mod-exp');
const pem = getPem(modulus, exponent);
return pem;
};
/**
* Get Token Request
* *
* @param {Object} request
* @returns {Promise}
*/
OAuthClient.prototype.getTokenRequest = function getTokenRequest(request) {
const authResponse = new AuthResponse({
token: this.token,
});
return new Promise((resolve) => {
resolve(this.loadResponse(request));
})
.then((response) => {
authResponse.processResponse(response);
if (!authResponse.valid()) throw new Error('Response has an Error');
return authResponse;
})
.catch((e) => {
Eif (!e.authResponse) e = this.createError(e, authResponse);
throw e;
});
};
/**
* Validate Token
* *
* @returns {boolean}
*/
OAuthClient.prototype.validateToken = function validateToken() {
if (!this.token.refreshToken()) throw new Error('The Refresh token is missing');
if (!this.token.isRefreshTokenValid())
throw new Error('The Refresh token is invalid, please Authorize again.');
};
/**
* Make HTTP Request using Popsicle Client
* @param request
* @returns response
*/
OAuthClient.prototype.loadResponse = function loadResponse(request) {
return popsicle.get(request).then((response) => response);
};
/**
* Load response from JWK URI
* @param request
* @returns response
*/
OAuthClient.prototype.loadResponseFromJWKsURI = function loadResponseFromJWKsURI(request) {
return popsicle.get(request).then((response) => response);
};
/**
* Wrap the exception with more information
* @param {Error|IApiError} e
* @param {AuthResponse} authResponse
* @return {Error|IApiError}
*/
OAuthClient.prototype.createError = function createError(e, authResponse) {
if (!authResponse || authResponse.body === '') {
e.error = (authResponse && authResponse.response.statusText) || e.message || '';
e.authResponse = authResponse || '';
e.intuit_tid =
(authResponse && authResponse.headers() && authResponse.headers().intuit_tid) || '';
e.originalMessage = e.message || '';
e.error_description = (authResponse && authResponse.response.statusText) || '';
return e;
}
e.authResponse = authResponse;
e.originalMessage = e.message;
e.error = '';
if ('error' in authResponse.getJson()) {
e.error = authResponse.getJson().error;
} else if (authResponse.response.statusText) {
e.error = authResponse.response.statusText;
} else if (e.message) {
e.error = e.message;
}
e.error_description = '';
if ('error_description' in authResponse.getJson()) {
e.error_description = authResponse.getJson().error_description;
} else if (authResponse.response.statusText) {
e.error_description = authResponse.response.statusText;
}
e.intuit_tid = authResponse.headers().intuit_tid;
return e;
};
/**
* isAccessToken Valid () { TTL of access_token }
* @returns {boolean}
* @private
*/
OAuthClient.prototype.isAccessTokenValid = function isAccessTokenValid() {
return this.token.isAccessTokenValid();
};
/**
* GetToken
* @returns {Token}
*/
OAuthClient.prototype.getToken = function getToken() {
return this.token;
};
/**
* Set Token
* @param {Object}
* @returns {Token}
*/
OAuthClient.prototype.setToken = function setToken(params) {
this.token = new Token(params);
return this.token;
};
/**
* Get AuthHeader
* @returns {string} authHeader
*/
OAuthClient.prototype.authHeader = function authHeader() {
const apiKey = `${this.clientId}:${this.clientSecret}`;
return typeof btoa === 'function' ? btoa(apiKey) : Buffer.from(apiKey).toString('base64');
};
OAuthClient.prototype.log = function log(level, message, messageData) {
if (this.logging) {
this.logger.log(level, message + messageData);
}
};
module.exports = OAuthClient;
|