util.js 33 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087
  1. /* eslint guard-for-in:0 */
  2. var AWS;
  3. /**
  4. * A set of utility methods for use with the AWS SDK.
  5. *
  6. * @!attribute abort
  7. * Return this value from an iterator function {each} or {arrayEach}
  8. * to break out of the iteration.
  9. * @example Breaking out of an iterator function
  10. * AWS.util.each({a: 1, b: 2, c: 3}, function(key, value) {
  11. * if (key == 'b') return AWS.util.abort;
  12. * });
  13. * @see each
  14. * @see arrayEach
  15. * @api private
  16. */
  17. var util = {
  18. environment: 'nodejs',
  19. engine: function engine() {
  20. if (util.isBrowser() && typeof navigator !== 'undefined') {
  21. return navigator.userAgent;
  22. } else {
  23. var engine = process.platform + '/' + process.version;
  24. if (process.env.AWS_EXECUTION_ENV) {
  25. engine += ' exec-env/' + process.env.AWS_EXECUTION_ENV;
  26. }
  27. return engine;
  28. }
  29. },
  30. userAgent: function userAgent() {
  31. var name = util.environment;
  32. var agent = 'aws-sdk-' + name + '/' + require('./core').VERSION;
  33. if (name === 'nodejs') agent += ' ' + util.engine();
  34. return agent;
  35. },
  36. uriEscape: function uriEscape(string) {
  37. var output = encodeURIComponent(string);
  38. output = output.replace(/[^A-Za-z0-9_.~\-%]+/g, escape);
  39. // AWS percent-encodes some extra non-standard characters in a URI
  40. output = output.replace(/[*]/g, function(ch) {
  41. return '%' + ch.charCodeAt(0).toString(16).toUpperCase();
  42. });
  43. return output;
  44. },
  45. uriEscapePath: function uriEscapePath(string) {
  46. var parts = [];
  47. util.arrayEach(string.split('/'), function (part) {
  48. parts.push(util.uriEscape(part));
  49. });
  50. return parts.join('/');
  51. },
  52. urlParse: function urlParse(url) {
  53. return util.url.parse(url);
  54. },
  55. urlFormat: function urlFormat(url) {
  56. return util.url.format(url);
  57. },
  58. queryStringParse: function queryStringParse(qs) {
  59. return util.querystring.parse(qs);
  60. },
  61. queryParamsToString: function queryParamsToString(params) {
  62. var items = [];
  63. var escape = util.uriEscape;
  64. var sortedKeys = Object.keys(params).sort();
  65. util.arrayEach(sortedKeys, function(name) {
  66. var value = params[name];
  67. var ename = escape(name);
  68. var result = ename + '=';
  69. if (Array.isArray(value)) {
  70. var vals = [];
  71. util.arrayEach(value, function(item) { vals.push(escape(item)); });
  72. result = ename + '=' + vals.sort().join('&' + ename + '=');
  73. } else if (value !== undefined && value !== null) {
  74. result = ename + '=' + escape(value);
  75. }
  76. items.push(result);
  77. });
  78. return items.join('&');
  79. },
  80. readFileSync: function readFileSync(path) {
  81. if (util.isBrowser()) return null;
  82. return require('fs').readFileSync(path, 'utf-8');
  83. },
  84. base64: {
  85. encode: function encode64(string) {
  86. if (typeof string === 'number') {
  87. throw util.error(new Error('Cannot base64 encode number ' + string));
  88. }
  89. if (string === null || typeof string === 'undefined') {
  90. return string;
  91. }
  92. var buf = util.buffer.toBuffer(string);
  93. return buf.toString('base64');
  94. },
  95. decode: function decode64(string) {
  96. if (typeof string === 'number') {
  97. throw util.error(new Error('Cannot base64 decode number ' + string));
  98. }
  99. if (string === null || typeof string === 'undefined') {
  100. return string;
  101. }
  102. return util.buffer.toBuffer(string, 'base64');
  103. }
  104. },
  105. buffer: {
  106. /**
  107. * Buffer constructor for Node buffer and buffer pollyfill
  108. */
  109. toBuffer: function(data, encoding) {
  110. return (typeof util.Buffer.from === 'function' && util.Buffer.from !== Uint8Array.from) ?
  111. util.Buffer.from(data, encoding) : new util.Buffer(data, encoding);
  112. },
  113. alloc: function(size, fill, encoding) {
  114. if (typeof size !== 'number') {
  115. throw new Error('size passed to alloc must be a number.');
  116. }
  117. if (typeof util.Buffer.alloc === 'function') {
  118. return util.Buffer.alloc(size, fill, encoding);
  119. } else {
  120. var buf = new util.Buffer(size);
  121. if (fill !== undefined && typeof buf.fill === 'function') {
  122. buf.fill(fill, undefined, undefined, encoding);
  123. }
  124. return buf;
  125. }
  126. },
  127. toStream: function toStream(buffer) {
  128. if (!util.Buffer.isBuffer(buffer)) buffer = util.buffer.toBuffer(buffer);
  129. var readable = new (util.stream.Readable)();
  130. var pos = 0;
  131. readable._read = function(size) {
  132. if (pos >= buffer.length) return readable.push(null);
  133. var end = pos + size;
  134. if (end > buffer.length) end = buffer.length;
  135. readable.push(buffer.slice(pos, end));
  136. pos = end;
  137. };
  138. return readable;
  139. },
  140. /**
  141. * Concatenates a list of Buffer objects.
  142. */
  143. concat: function(buffers) {
  144. var length = 0,
  145. offset = 0,
  146. buffer = null, i;
  147. for (i = 0; i < buffers.length; i++) {
  148. length += buffers[i].length;
  149. }
  150. buffer = util.buffer.alloc(length);
  151. for (i = 0; i < buffers.length; i++) {
  152. buffers[i].copy(buffer, offset);
  153. offset += buffers[i].length;
  154. }
  155. return buffer;
  156. }
  157. },
  158. string: {
  159. byteLength: function byteLength(string) {
  160. if (string === null || string === undefined) return 0;
  161. if (typeof string === 'string') string = util.buffer.toBuffer(string);
  162. if (typeof string.byteLength === 'number') {
  163. return string.byteLength;
  164. } else if (typeof string.length === 'number') {
  165. return string.length;
  166. } else if (typeof string.size === 'number') {
  167. return string.size;
  168. } else if (typeof string.path === 'string') {
  169. return require('fs').lstatSync(string.path).size;
  170. } else {
  171. throw util.error(new Error('Cannot determine length of ' + string),
  172. { object: string });
  173. }
  174. },
  175. upperFirst: function upperFirst(string) {
  176. return string[0].toUpperCase() + string.substr(1);
  177. },
  178. lowerFirst: function lowerFirst(string) {
  179. return string[0].toLowerCase() + string.substr(1);
  180. }
  181. },
  182. ini: {
  183. parse: function string(ini) {
  184. var currentSection, map = {};
  185. util.arrayEach(ini.split(/\r?\n/), function(line) {
  186. line = line.split(/(^|\s)[;#]/)[0].trim(); // remove comments and trim
  187. var isSection = line[0] === '[' && line[line.length - 1] === ']';
  188. if (isSection) {
  189. currentSection = line.substring(1, line.length - 1);
  190. if (currentSection === '__proto__' || currentSection.split(/\s/)[1] === '__proto__') {
  191. throw util.error(
  192. new Error('Cannot load profile name \'' + currentSection + '\' from shared ini file.')
  193. );
  194. }
  195. } else if (currentSection) {
  196. var indexOfEqualsSign = line.indexOf('=');
  197. var start = 0;
  198. var end = line.length - 1;
  199. var isAssignment =
  200. indexOfEqualsSign !== -1 && indexOfEqualsSign !== start && indexOfEqualsSign !== end;
  201. if (isAssignment) {
  202. var name = line.substring(0, indexOfEqualsSign).trim();
  203. var value = line.substring(indexOfEqualsSign + 1).trim();
  204. map[currentSection] = map[currentSection] || {};
  205. map[currentSection][name] = value;
  206. }
  207. }
  208. });
  209. return map;
  210. }
  211. },
  212. fn: {
  213. noop: function() {},
  214. callback: function (err) { if (err) throw err; },
  215. /**
  216. * Turn a synchronous function into as "async" function by making it call
  217. * a callback. The underlying function is called with all but the last argument,
  218. * which is treated as the callback. The callback is passed passed a first argument
  219. * of null on success to mimick standard node callbacks.
  220. */
  221. makeAsync: function makeAsync(fn, expectedArgs) {
  222. if (expectedArgs && expectedArgs <= fn.length) {
  223. return fn;
  224. }
  225. return function() {
  226. var args = Array.prototype.slice.call(arguments, 0);
  227. var callback = args.pop();
  228. var result = fn.apply(null, args);
  229. callback(result);
  230. };
  231. }
  232. },
  233. /**
  234. * Date and time utility functions.
  235. */
  236. date: {
  237. /**
  238. * @return [Date] the current JavaScript date object. Since all
  239. * AWS services rely on this date object, you can override
  240. * this function to provide a special time value to AWS service
  241. * requests.
  242. */
  243. getDate: function getDate() {
  244. if (!AWS) AWS = require('./core');
  245. if (AWS.config.systemClockOffset) { // use offset when non-zero
  246. return new Date(new Date().getTime() + AWS.config.systemClockOffset);
  247. } else {
  248. return new Date();
  249. }
  250. },
  251. /**
  252. * @return [String] the date in ISO-8601 format
  253. */
  254. iso8601: function iso8601(date) {
  255. if (date === undefined) { date = util.date.getDate(); }
  256. return date.toISOString().replace(/\.\d{3}Z$/, 'Z');
  257. },
  258. /**
  259. * @return [String] the date in RFC 822 format
  260. */
  261. rfc822: function rfc822(date) {
  262. if (date === undefined) { date = util.date.getDate(); }
  263. return date.toUTCString();
  264. },
  265. /**
  266. * @return [Integer] the UNIX timestamp value for the current time
  267. */
  268. unixTimestamp: function unixTimestamp(date) {
  269. if (date === undefined) { date = util.date.getDate(); }
  270. return date.getTime() / 1000;
  271. },
  272. /**
  273. * @param [String,number,Date] date
  274. * @return [Date]
  275. */
  276. from: function format(date) {
  277. if (typeof date === 'number') {
  278. return new Date(date * 1000); // unix timestamp
  279. } else {
  280. return new Date(date);
  281. }
  282. },
  283. /**
  284. * Given a Date or date-like value, this function formats the
  285. * date into a string of the requested value.
  286. * @param [String,number,Date] date
  287. * @param [String] formatter Valid formats are:
  288. # * 'iso8601'
  289. # * 'rfc822'
  290. # * 'unixTimestamp'
  291. * @return [String]
  292. */
  293. format: function format(date, formatter) {
  294. if (!formatter) formatter = 'iso8601';
  295. return util.date[formatter](util.date.from(date));
  296. },
  297. parseTimestamp: function parseTimestamp(value) {
  298. if (typeof value === 'number') { // unix timestamp (number)
  299. return new Date(value * 1000);
  300. } else if (value.match(/^\d+$/)) { // unix timestamp
  301. return new Date(value * 1000);
  302. } else if (value.match(/^\d{4}/)) { // iso8601
  303. return new Date(value);
  304. } else if (value.match(/^\w{3},/)) { // rfc822
  305. return new Date(value);
  306. } else {
  307. throw util.error(
  308. new Error('unhandled timestamp format: ' + value),
  309. {code: 'TimestampParserError'});
  310. }
  311. }
  312. },
  313. crypto: {
  314. crc32Table: [
  315. 0x00000000, 0x77073096, 0xEE0E612C, 0x990951BA, 0x076DC419,
  316. 0x706AF48F, 0xE963A535, 0x9E6495A3, 0x0EDB8832, 0x79DCB8A4,
  317. 0xE0D5E91E, 0x97D2D988, 0x09B64C2B, 0x7EB17CBD, 0xE7B82D07,
  318. 0x90BF1D91, 0x1DB71064, 0x6AB020F2, 0xF3B97148, 0x84BE41DE,
  319. 0x1ADAD47D, 0x6DDDE4EB, 0xF4D4B551, 0x83D385C7, 0x136C9856,
  320. 0x646BA8C0, 0xFD62F97A, 0x8A65C9EC, 0x14015C4F, 0x63066CD9,
  321. 0xFA0F3D63, 0x8D080DF5, 0x3B6E20C8, 0x4C69105E, 0xD56041E4,
  322. 0xA2677172, 0x3C03E4D1, 0x4B04D447, 0xD20D85FD, 0xA50AB56B,
  323. 0x35B5A8FA, 0x42B2986C, 0xDBBBC9D6, 0xACBCF940, 0x32D86CE3,
  324. 0x45DF5C75, 0xDCD60DCF, 0xABD13D59, 0x26D930AC, 0x51DE003A,
  325. 0xC8D75180, 0xBFD06116, 0x21B4F4B5, 0x56B3C423, 0xCFBA9599,
  326. 0xB8BDA50F, 0x2802B89E, 0x5F058808, 0xC60CD9B2, 0xB10BE924,
  327. 0x2F6F7C87, 0x58684C11, 0xC1611DAB, 0xB6662D3D, 0x76DC4190,
  328. 0x01DB7106, 0x98D220BC, 0xEFD5102A, 0x71B18589, 0x06B6B51F,
  329. 0x9FBFE4A5, 0xE8B8D433, 0x7807C9A2, 0x0F00F934, 0x9609A88E,
  330. 0xE10E9818, 0x7F6A0DBB, 0x086D3D2D, 0x91646C97, 0xE6635C01,
  331. 0x6B6B51F4, 0x1C6C6162, 0x856530D8, 0xF262004E, 0x6C0695ED,
  332. 0x1B01A57B, 0x8208F4C1, 0xF50FC457, 0x65B0D9C6, 0x12B7E950,
  333. 0x8BBEB8EA, 0xFCB9887C, 0x62DD1DDF, 0x15DA2D49, 0x8CD37CF3,
  334. 0xFBD44C65, 0x4DB26158, 0x3AB551CE, 0xA3BC0074, 0xD4BB30E2,
  335. 0x4ADFA541, 0x3DD895D7, 0xA4D1C46D, 0xD3D6F4FB, 0x4369E96A,
  336. 0x346ED9FC, 0xAD678846, 0xDA60B8D0, 0x44042D73, 0x33031DE5,
  337. 0xAA0A4C5F, 0xDD0D7CC9, 0x5005713C, 0x270241AA, 0xBE0B1010,
  338. 0xC90C2086, 0x5768B525, 0x206F85B3, 0xB966D409, 0xCE61E49F,
  339. 0x5EDEF90E, 0x29D9C998, 0xB0D09822, 0xC7D7A8B4, 0x59B33D17,
  340. 0x2EB40D81, 0xB7BD5C3B, 0xC0BA6CAD, 0xEDB88320, 0x9ABFB3B6,
  341. 0x03B6E20C, 0x74B1D29A, 0xEAD54739, 0x9DD277AF, 0x04DB2615,
  342. 0x73DC1683, 0xE3630B12, 0x94643B84, 0x0D6D6A3E, 0x7A6A5AA8,
  343. 0xE40ECF0B, 0x9309FF9D, 0x0A00AE27, 0x7D079EB1, 0xF00F9344,
  344. 0x8708A3D2, 0x1E01F268, 0x6906C2FE, 0xF762575D, 0x806567CB,
  345. 0x196C3671, 0x6E6B06E7, 0xFED41B76, 0x89D32BE0, 0x10DA7A5A,
  346. 0x67DD4ACC, 0xF9B9DF6F, 0x8EBEEFF9, 0x17B7BE43, 0x60B08ED5,
  347. 0xD6D6A3E8, 0xA1D1937E, 0x38D8C2C4, 0x4FDFF252, 0xD1BB67F1,
  348. 0xA6BC5767, 0x3FB506DD, 0x48B2364B, 0xD80D2BDA, 0xAF0A1B4C,
  349. 0x36034AF6, 0x41047A60, 0xDF60EFC3, 0xA867DF55, 0x316E8EEF,
  350. 0x4669BE79, 0xCB61B38C, 0xBC66831A, 0x256FD2A0, 0x5268E236,
  351. 0xCC0C7795, 0xBB0B4703, 0x220216B9, 0x5505262F, 0xC5BA3BBE,
  352. 0xB2BD0B28, 0x2BB45A92, 0x5CB36A04, 0xC2D7FFA7, 0xB5D0CF31,
  353. 0x2CD99E8B, 0x5BDEAE1D, 0x9B64C2B0, 0xEC63F226, 0x756AA39C,
  354. 0x026D930A, 0x9C0906A9, 0xEB0E363F, 0x72076785, 0x05005713,
  355. 0x95BF4A82, 0xE2B87A14, 0x7BB12BAE, 0x0CB61B38, 0x92D28E9B,
  356. 0xE5D5BE0D, 0x7CDCEFB7, 0x0BDBDF21, 0x86D3D2D4, 0xF1D4E242,
  357. 0x68DDB3F8, 0x1FDA836E, 0x81BE16CD, 0xF6B9265B, 0x6FB077E1,
  358. 0x18B74777, 0x88085AE6, 0xFF0F6A70, 0x66063BCA, 0x11010B5C,
  359. 0x8F659EFF, 0xF862AE69, 0x616BFFD3, 0x166CCF45, 0xA00AE278,
  360. 0xD70DD2EE, 0x4E048354, 0x3903B3C2, 0xA7672661, 0xD06016F7,
  361. 0x4969474D, 0x3E6E77DB, 0xAED16A4A, 0xD9D65ADC, 0x40DF0B66,
  362. 0x37D83BF0, 0xA9BCAE53, 0xDEBB9EC5, 0x47B2CF7F, 0x30B5FFE9,
  363. 0xBDBDF21C, 0xCABAC28A, 0x53B39330, 0x24B4A3A6, 0xBAD03605,
  364. 0xCDD70693, 0x54DE5729, 0x23D967BF, 0xB3667A2E, 0xC4614AB8,
  365. 0x5D681B02, 0x2A6F2B94, 0xB40BBE37, 0xC30C8EA1, 0x5A05DF1B,
  366. 0x2D02EF8D],
  367. crc32: function crc32(data) {
  368. var tbl = util.crypto.crc32Table;
  369. var crc = 0 ^ -1;
  370. if (typeof data === 'string') {
  371. data = util.buffer.toBuffer(data);
  372. }
  373. for (var i = 0; i < data.length; i++) {
  374. var code = data.readUInt8(i);
  375. crc = (crc >>> 8) ^ tbl[(crc ^ code) & 0xFF];
  376. }
  377. return (crc ^ -1) >>> 0;
  378. },
  379. hmac: function hmac(key, string, digest, fn) {
  380. if (!digest) digest = 'binary';
  381. if (digest === 'buffer') { digest = undefined; }
  382. if (!fn) fn = 'sha256';
  383. if (typeof string === 'string') string = util.buffer.toBuffer(string);
  384. return util.crypto.lib.createHmac(fn, key).update(string).digest(digest);
  385. },
  386. md5: function md5(data, digest, callback) {
  387. return util.crypto.hash('md5', data, digest, callback);
  388. },
  389. sha256: function sha256(data, digest, callback) {
  390. return util.crypto.hash('sha256', data, digest, callback);
  391. },
  392. hash: function(algorithm, data, digest, callback) {
  393. var hash = util.crypto.createHash(algorithm);
  394. if (!digest) { digest = 'binary'; }
  395. if (digest === 'buffer') { digest = undefined; }
  396. if (typeof data === 'string') data = util.buffer.toBuffer(data);
  397. var sliceFn = util.arraySliceFn(data);
  398. var isBuffer = util.Buffer.isBuffer(data);
  399. //Identifying objects with an ArrayBuffer as buffers
  400. if (util.isBrowser() && typeof ArrayBuffer !== 'undefined' && data && data.buffer instanceof ArrayBuffer) isBuffer = true;
  401. if (callback && typeof data === 'object' &&
  402. typeof data.on === 'function' && !isBuffer) {
  403. data.on('data', function(chunk) { hash.update(chunk); });
  404. data.on('error', function(err) { callback(err); });
  405. data.on('end', function() { callback(null, hash.digest(digest)); });
  406. } else if (callback && sliceFn && !isBuffer &&
  407. typeof FileReader !== 'undefined') {
  408. // this might be a File/Blob
  409. var index = 0, size = 1024 * 512;
  410. var reader = new FileReader();
  411. reader.onerror = function() {
  412. callback(new Error('Failed to read data.'));
  413. };
  414. reader.onload = function() {
  415. var buf = new util.Buffer(new Uint8Array(reader.result));
  416. hash.update(buf);
  417. index += buf.length;
  418. reader._continueReading();
  419. };
  420. reader._continueReading = function() {
  421. if (index >= data.size) {
  422. callback(null, hash.digest(digest));
  423. return;
  424. }
  425. var back = index + size;
  426. if (back > data.size) back = data.size;
  427. reader.readAsArrayBuffer(sliceFn.call(data, index, back));
  428. };
  429. reader._continueReading();
  430. } else {
  431. if (util.isBrowser() && typeof data === 'object' && !isBuffer) {
  432. data = new util.Buffer(new Uint8Array(data));
  433. }
  434. var out = hash.update(data).digest(digest);
  435. if (callback) callback(null, out);
  436. return out;
  437. }
  438. },
  439. toHex: function toHex(data) {
  440. var out = [];
  441. for (var i = 0; i < data.length; i++) {
  442. out.push(('0' + data.charCodeAt(i).toString(16)).substr(-2, 2));
  443. }
  444. return out.join('');
  445. },
  446. createHash: function createHash(algorithm) {
  447. return util.crypto.lib.createHash(algorithm);
  448. }
  449. },
  450. /** @!ignore */
  451. /* Abort constant */
  452. abort: {},
  453. each: function each(object, iterFunction) {
  454. for (var key in object) {
  455. if (Object.prototype.hasOwnProperty.call(object, key)) {
  456. var ret = iterFunction.call(this, key, object[key]);
  457. if (ret === util.abort) break;
  458. }
  459. }
  460. },
  461. arrayEach: function arrayEach(array, iterFunction) {
  462. for (var idx in array) {
  463. if (Object.prototype.hasOwnProperty.call(array, idx)) {
  464. var ret = iterFunction.call(this, array[idx], parseInt(idx, 10));
  465. if (ret === util.abort) break;
  466. }
  467. }
  468. },
  469. update: function update(obj1, obj2) {
  470. util.each(obj2, function iterator(key, item) {
  471. obj1[key] = item;
  472. });
  473. return obj1;
  474. },
  475. merge: function merge(obj1, obj2) {
  476. return util.update(util.copy(obj1), obj2);
  477. },
  478. copy: function copy(object) {
  479. if (object === null || object === undefined) return object;
  480. var dupe = {};
  481. // jshint forin:false
  482. for (var key in object) {
  483. dupe[key] = object[key];
  484. }
  485. return dupe;
  486. },
  487. isEmpty: function isEmpty(obj) {
  488. for (var prop in obj) {
  489. if (Object.prototype.hasOwnProperty.call(obj, prop)) {
  490. return false;
  491. }
  492. }
  493. return true;
  494. },
  495. arraySliceFn: function arraySliceFn(obj) {
  496. var fn = obj.slice || obj.webkitSlice || obj.mozSlice;
  497. return typeof fn === 'function' ? fn : null;
  498. },
  499. isType: function isType(obj, type) {
  500. // handle cross-"frame" objects
  501. if (typeof type === 'function') type = util.typeName(type);
  502. return Object.prototype.toString.call(obj) === '[object ' + type + ']';
  503. },
  504. typeName: function typeName(type) {
  505. if (Object.prototype.hasOwnProperty.call(type, 'name')) return type.name;
  506. var str = type.toString();
  507. var match = str.match(/^\s*function (.+)\(/);
  508. return match ? match[1] : str;
  509. },
  510. error: function error(err, options) {
  511. var originalError = null;
  512. if (typeof err.message === 'string' && err.message !== '') {
  513. if (typeof options === 'string' || (options && options.message)) {
  514. originalError = util.copy(err);
  515. originalError.message = err.message;
  516. }
  517. }
  518. err.message = err.message || null;
  519. if (typeof options === 'string') {
  520. err.message = options;
  521. } else if (typeof options === 'object' && options !== null) {
  522. util.update(err, options);
  523. if (options.message)
  524. err.message = options.message;
  525. if (options.code || options.name)
  526. err.code = options.code || options.name;
  527. if (options.stack)
  528. err.stack = options.stack;
  529. }
  530. if (typeof Object.defineProperty === 'function') {
  531. Object.defineProperty(err, 'name', {writable: true, enumerable: false});
  532. Object.defineProperty(err, 'message', {enumerable: true});
  533. }
  534. err.name = String(options && options.name || err.name || err.code || 'Error');
  535. err.time = new Date();
  536. if (originalError) {
  537. err.originalError = originalError;
  538. }
  539. for (var key in options || {}) {
  540. if (key[0] === '[' && key[key.length - 1] === ']') {
  541. key = key.slice(1, -1);
  542. if (key === 'code' || key === 'message') {
  543. continue;
  544. }
  545. err['[' + key + ']'] = 'See error.' + key + ' for details.';
  546. Object.defineProperty(err, key, {
  547. value: err[key] || (options && options[key]) || (originalError && originalError[key]),
  548. enumerable: false,
  549. writable: true
  550. });
  551. }
  552. }
  553. return err;
  554. },
  555. /**
  556. * @api private
  557. */
  558. inherit: function inherit(klass, features) {
  559. var newObject = null;
  560. if (features === undefined) {
  561. features = klass;
  562. klass = Object;
  563. newObject = {};
  564. } else {
  565. var ctor = function ConstructorWrapper() {};
  566. ctor.prototype = klass.prototype;
  567. newObject = new ctor();
  568. }
  569. // constructor not supplied, create pass-through ctor
  570. if (features.constructor === Object) {
  571. features.constructor = function() {
  572. if (klass !== Object) {
  573. return klass.apply(this, arguments);
  574. }
  575. };
  576. }
  577. features.constructor.prototype = newObject;
  578. util.update(features.constructor.prototype, features);
  579. features.constructor.__super__ = klass;
  580. return features.constructor;
  581. },
  582. /**
  583. * @api private
  584. */
  585. mixin: function mixin() {
  586. var klass = arguments[0];
  587. for (var i = 1; i < arguments.length; i++) {
  588. // jshint forin:false
  589. for (var prop in arguments[i].prototype) {
  590. var fn = arguments[i].prototype[prop];
  591. if (prop !== 'constructor') {
  592. klass.prototype[prop] = fn;
  593. }
  594. }
  595. }
  596. return klass;
  597. },
  598. /**
  599. * @api private
  600. */
  601. hideProperties: function hideProperties(obj, props) {
  602. if (typeof Object.defineProperty !== 'function') return;
  603. util.arrayEach(props, function (key) {
  604. Object.defineProperty(obj, key, {
  605. enumerable: false, writable: true, configurable: true });
  606. });
  607. },
  608. /**
  609. * @api private
  610. */
  611. property: function property(obj, name, value, enumerable, isValue) {
  612. var opts = {
  613. configurable: true,
  614. enumerable: enumerable !== undefined ? enumerable : true
  615. };
  616. if (typeof value === 'function' && !isValue) {
  617. opts.get = value;
  618. }
  619. else {
  620. opts.value = value; opts.writable = true;
  621. }
  622. Object.defineProperty(obj, name, opts);
  623. },
  624. /**
  625. * @api private
  626. */
  627. memoizedProperty: function memoizedProperty(obj, name, get, enumerable) {
  628. var cachedValue = null;
  629. // build enumerable attribute for each value with lazy accessor.
  630. util.property(obj, name, function() {
  631. if (cachedValue === null) {
  632. cachedValue = get();
  633. }
  634. return cachedValue;
  635. }, enumerable);
  636. },
  637. /**
  638. * TODO Remove in major version revision
  639. * This backfill populates response data without the
  640. * top-level payload name.
  641. *
  642. * @api private
  643. */
  644. hoistPayloadMember: function hoistPayloadMember(resp) {
  645. var req = resp.request;
  646. var operationName = req.operation;
  647. var operation = req.service.api.operations[operationName];
  648. var output = operation.output;
  649. if (output.payload && !operation.hasEventOutput) {
  650. var payloadMember = output.members[output.payload];
  651. var responsePayload = resp.data[output.payload];
  652. if (payloadMember.type === 'structure') {
  653. util.each(responsePayload, function(key, value) {
  654. util.property(resp.data, key, value, false);
  655. });
  656. }
  657. }
  658. },
  659. /**
  660. * Compute SHA-256 checksums of streams
  661. *
  662. * @api private
  663. */
  664. computeSha256: function computeSha256(body, done) {
  665. if (util.isNode()) {
  666. var Stream = util.stream.Stream;
  667. var fs = require('fs');
  668. if (typeof Stream === 'function' && body instanceof Stream) {
  669. if (typeof body.path === 'string') { // assume file object
  670. var settings = {};
  671. if (typeof body.start === 'number') {
  672. settings.start = body.start;
  673. }
  674. if (typeof body.end === 'number') {
  675. settings.end = body.end;
  676. }
  677. body = fs.createReadStream(body.path, settings);
  678. } else { // TODO support other stream types
  679. return done(new Error('Non-file stream objects are ' +
  680. 'not supported with SigV4'));
  681. }
  682. }
  683. }
  684. util.crypto.sha256(body, 'hex', function(err, sha) {
  685. if (err) done(err);
  686. else done(null, sha);
  687. });
  688. },
  689. /**
  690. * @api private
  691. */
  692. isClockSkewed: function isClockSkewed(serverTime) {
  693. if (serverTime) {
  694. util.property(AWS.config, 'isClockSkewed',
  695. Math.abs(new Date().getTime() - serverTime) >= 300000, false);
  696. return AWS.config.isClockSkewed;
  697. }
  698. },
  699. applyClockOffset: function applyClockOffset(serverTime) {
  700. if (serverTime)
  701. AWS.config.systemClockOffset = serverTime - new Date().getTime();
  702. },
  703. /**
  704. * @api private
  705. */
  706. extractRequestId: function extractRequestId(resp) {
  707. var requestId = resp.httpResponse.headers['x-amz-request-id'] ||
  708. resp.httpResponse.headers['x-amzn-requestid'];
  709. if (!requestId && resp.data && resp.data.ResponseMetadata) {
  710. requestId = resp.data.ResponseMetadata.RequestId;
  711. }
  712. if (requestId) {
  713. resp.requestId = requestId;
  714. }
  715. if (resp.error) {
  716. resp.error.requestId = requestId;
  717. }
  718. },
  719. /**
  720. * @api private
  721. */
  722. addPromises: function addPromises(constructors, PromiseDependency) {
  723. var deletePromises = false;
  724. if (PromiseDependency === undefined && AWS && AWS.config) {
  725. PromiseDependency = AWS.config.getPromisesDependency();
  726. }
  727. if (PromiseDependency === undefined && typeof Promise !== 'undefined') {
  728. PromiseDependency = Promise;
  729. }
  730. if (typeof PromiseDependency !== 'function') deletePromises = true;
  731. if (!Array.isArray(constructors)) constructors = [constructors];
  732. for (var ind = 0; ind < constructors.length; ind++) {
  733. var constructor = constructors[ind];
  734. if (deletePromises) {
  735. if (constructor.deletePromisesFromClass) {
  736. constructor.deletePromisesFromClass();
  737. }
  738. } else if (constructor.addPromisesToClass) {
  739. constructor.addPromisesToClass(PromiseDependency);
  740. }
  741. }
  742. },
  743. /**
  744. * @api private
  745. * Return a function that will return a promise whose fate is decided by the
  746. * callback behavior of the given method with `methodName`. The method to be
  747. * promisified should conform to node.js convention of accepting a callback as
  748. * last argument and calling that callback with error as the first argument
  749. * and success value on the second argument.
  750. */
  751. promisifyMethod: function promisifyMethod(methodName, PromiseDependency) {
  752. return function promise() {
  753. var self = this;
  754. var args = Array.prototype.slice.call(arguments);
  755. return new PromiseDependency(function(resolve, reject) {
  756. args.push(function(err, data) {
  757. if (err) {
  758. reject(err);
  759. } else {
  760. resolve(data);
  761. }
  762. });
  763. self[methodName].apply(self, args);
  764. });
  765. };
  766. },
  767. /**
  768. * @api private
  769. */
  770. isDualstackAvailable: function isDualstackAvailable(service) {
  771. if (!service) return false;
  772. var metadata = require('../apis/metadata.json');
  773. if (typeof service !== 'string') service = service.serviceIdentifier;
  774. if (typeof service !== 'string' || !metadata.hasOwnProperty(service)) return false;
  775. return !!metadata[service].dualstackAvailable;
  776. },
  777. /**
  778. * @api private
  779. */
  780. calculateRetryDelay: function calculateRetryDelay(retryCount, retryDelayOptions, err) {
  781. if (!retryDelayOptions) retryDelayOptions = {};
  782. var customBackoff = retryDelayOptions.customBackoff || null;
  783. if (typeof customBackoff === 'function') {
  784. return customBackoff(retryCount, err);
  785. }
  786. var base = typeof retryDelayOptions.base === 'number' ? retryDelayOptions.base : 100;
  787. var delay = Math.random() * (Math.pow(2, retryCount) * base);
  788. return delay;
  789. },
  790. /**
  791. * @api private
  792. */
  793. handleRequestWithRetries: function handleRequestWithRetries(httpRequest, options, cb) {
  794. if (!options) options = {};
  795. var http = AWS.HttpClient.getInstance();
  796. var httpOptions = options.httpOptions || {};
  797. var retryCount = 0;
  798. var errCallback = function(err) {
  799. var maxRetries = options.maxRetries || 0;
  800. if (err && err.code === 'TimeoutError') err.retryable = true;
  801. // Call `calculateRetryDelay()` only when relevant, see #3401
  802. if (err && err.retryable && retryCount < maxRetries) {
  803. var delay = util.calculateRetryDelay(retryCount, options.retryDelayOptions, err);
  804. if (delay >= 0) {
  805. retryCount++;
  806. setTimeout(sendRequest, delay + (err.retryAfter || 0));
  807. return;
  808. }
  809. }
  810. cb(err);
  811. };
  812. var sendRequest = function() {
  813. var data = '';
  814. http.handleRequest(httpRequest, httpOptions, function(httpResponse) {
  815. httpResponse.on('data', function(chunk) { data += chunk.toString(); });
  816. httpResponse.on('end', function() {
  817. var statusCode = httpResponse.statusCode;
  818. if (statusCode < 300) {
  819. cb(null, data);
  820. } else {
  821. var retryAfter = parseInt(httpResponse.headers['retry-after'], 10) * 1000 || 0;
  822. var err = util.error(new Error(),
  823. {
  824. statusCode: statusCode,
  825. retryable: statusCode >= 500 || statusCode === 429
  826. }
  827. );
  828. if (retryAfter && err.retryable) err.retryAfter = retryAfter;
  829. errCallback(err);
  830. }
  831. });
  832. }, errCallback);
  833. };
  834. AWS.util.defer(sendRequest);
  835. },
  836. /**
  837. * @api private
  838. */
  839. uuid: {
  840. v4: function uuidV4() {
  841. return require('uuid').v4();
  842. }
  843. },
  844. /**
  845. * @api private
  846. */
  847. convertPayloadToString: function convertPayloadToString(resp) {
  848. var req = resp.request;
  849. var operation = req.operation;
  850. var rules = req.service.api.operations[operation].output || {};
  851. if (rules.payload && resp.data[rules.payload]) {
  852. resp.data[rules.payload] = resp.data[rules.payload].toString();
  853. }
  854. },
  855. /**
  856. * @api private
  857. */
  858. defer: function defer(callback) {
  859. if (typeof process === 'object' && typeof process.nextTick === 'function') {
  860. process.nextTick(callback);
  861. } else if (typeof setImmediate === 'function') {
  862. setImmediate(callback);
  863. } else {
  864. setTimeout(callback, 0);
  865. }
  866. },
  867. /**
  868. * @api private
  869. */
  870. getRequestPayloadShape: function getRequestPayloadShape(req) {
  871. var operations = req.service.api.operations;
  872. if (!operations) return undefined;
  873. var operation = (operations || {})[req.operation];
  874. if (!operation || !operation.input || !operation.input.payload) return undefined;
  875. return operation.input.members[operation.input.payload];
  876. },
  877. getProfilesFromSharedConfig: function getProfilesFromSharedConfig(iniLoader, filename) {
  878. var profiles = {};
  879. var profilesFromConfig = {};
  880. if (process.env[util.configOptInEnv]) {
  881. var profilesFromConfig = iniLoader.loadFrom({
  882. isConfig: true,
  883. filename: process.env[util.sharedConfigFileEnv]
  884. });
  885. }
  886. var profilesFromCreds= {};
  887. try {
  888. var profilesFromCreds = iniLoader.loadFrom({
  889. filename: filename ||
  890. (process.env[util.configOptInEnv] && process.env[util.sharedCredentialsFileEnv])
  891. });
  892. } catch (error) {
  893. // if using config, assume it is fully descriptive without a credentials file:
  894. if (!process.env[util.configOptInEnv]) throw error;
  895. }
  896. for (var i = 0, profileNames = Object.keys(profilesFromConfig); i < profileNames.length; i++) {
  897. profiles[profileNames[i]] = objectAssign(profiles[profileNames[i]] || {}, profilesFromConfig[profileNames[i]]);
  898. }
  899. for (var i = 0, profileNames = Object.keys(profilesFromCreds); i < profileNames.length; i++) {
  900. profiles[profileNames[i]] = objectAssign(profiles[profileNames[i]] || {}, profilesFromCreds[profileNames[i]]);
  901. }
  902. return profiles;
  903. /**
  904. * Roughly the semantics of `Object.assign(target, source)`
  905. */
  906. function objectAssign(target, source) {
  907. for (var i = 0, keys = Object.keys(source); i < keys.length; i++) {
  908. target[keys[i]] = source[keys[i]];
  909. }
  910. return target;
  911. }
  912. },
  913. /**
  914. * @api private
  915. */
  916. ARN: {
  917. validate: function validateARN(str) {
  918. return str && str.indexOf('arn:') === 0 && str.split(':').length >= 6;
  919. },
  920. parse: function parseARN(arn) {
  921. var matched = arn.split(':');
  922. return {
  923. partition: matched[1],
  924. service: matched[2],
  925. region: matched[3],
  926. accountId: matched[4],
  927. resource: matched.slice(5).join(':')
  928. };
  929. },
  930. build: function buildARN(arnObject) {
  931. if (
  932. arnObject.service === undefined ||
  933. arnObject.region === undefined ||
  934. arnObject.accountId === undefined ||
  935. arnObject.resource === undefined
  936. ) throw util.error(new Error('Input ARN object is invalid'));
  937. return 'arn:'+ (arnObject.partition || 'aws') + ':' + arnObject.service +
  938. ':' + arnObject.region + ':' + arnObject.accountId + ':' + arnObject.resource;
  939. }
  940. },
  941. /**
  942. * @api private
  943. */
  944. defaultProfile: 'default',
  945. /**
  946. * @api private
  947. */
  948. configOptInEnv: 'AWS_SDK_LOAD_CONFIG',
  949. /**
  950. * @api private
  951. */
  952. sharedCredentialsFileEnv: 'AWS_SHARED_CREDENTIALS_FILE',
  953. /**
  954. * @api private
  955. */
  956. sharedConfigFileEnv: 'AWS_CONFIG_FILE',
  957. /**
  958. * @api private
  959. */
  960. imdsDisabledEnv: 'AWS_EC2_METADATA_DISABLED'
  961. };
  962. /**
  963. * @api private
  964. */
  965. module.exports = util;