From add03a5889124cf38b2ea410891782b0678248bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kamil=20Og=C3=B3rek?= Date: Tue, 13 Mar 2018 20:55:39 +0100 Subject: [PATCH] feat: Sensible non-Error exception serializer (#1253) * feat: Sensible non-Error exception serializer * ref: Restructure captureException method --- src/raven.js | 60 ++++++--- src/utils.js | 98 ++++++++++++++- test/integration/test.js | 7 +- test/raven.test.js | 71 +++++++++-- test/utils.test.js | 243 +++++++++++++++++++++++++++++++++++ vendor/md5/md5.js | 266 +++++++++++++++++++++++++++++++++++++++ 6 files changed, 716 insertions(+), 29 deletions(-) create mode 100644 vendor/md5/md5.js diff --git a/src/raven.js b/src/raven.js index b20de308080b..a70411dcf424 100644 --- a/src/raven.js +++ b/src/raven.js @@ -2,11 +2,13 @@ var TraceKit = require('../vendor/TraceKit/tracekit'); var stringify = require('../vendor/json-stringify-safe/stringify'); +var md5 = require('../vendor/md5/md5'); var RavenConfigError = require('./configError'); var utils = require('./utils'); var isError = utils.isError; var isObject = utils.isObject; +var isPlainObject = utils.isPlainObject; var isErrorEvent = utils.isErrorEvent; var isUndefined = utils.isUndefined; var isFunction = utils.isFunction; @@ -28,6 +30,8 @@ var parseUrl = utils.parseUrl; var fill = utils.fill; var supportsFetch = utils.supportsFetch; var supportsReferrerPolicy = utils.supportsReferrerPolicy; +var serializeKeysForMessage = utils.serializeKeysForMessage; +var serializeException = utils.serializeException; var wrapConsoleMethod = require('./console').wrapMethod; @@ -456,23 +460,34 @@ Raven.prototype = { */ captureException: function(ex, options) { options = objectMerge({trimHeadFrames: 0}, options ? options : {}); - // Cases for sending ex as a message, rather than an exception - var isNotError = !isError(ex); - var isNotErrorEvent = !isErrorEvent(ex); - var isErrorEventWithoutError = isErrorEvent(ex) && !ex.error; - - if ((isNotError && isNotErrorEvent) || isErrorEventWithoutError) { - return this.captureMessage( - ex, - objectMerge(options, { - stacktrace: true, // if we fall back to captureMessage, default to attempting a new trace - trimHeadFrames: options.trimHeadFrames + 1 - }) - ); - } - // Get actual Error from ErrorEvent - if (isErrorEvent(ex)) ex = ex.error; + if (isPlainObject(ex)) { + // If it is plain Object, serialize it manually and extract options + // This will allow us to group events based on top-level keys + // which is much better than creating new group when any key/value change + options = this._getCaptureExceptionOptionsFromPlainObject(options, ex); + ex = new Error(options.message); + + } else if (isErrorEvent(ex) && ex.error) { + // If it is an ErrorEvent with `error` property, extract it to get actual Error + ex = ex.error; + } else if (isError(ex)){ + // we have a real Error object + ex = ex; + } else { + // If none of previous checks were valid, then it means that + // it's not a plain Object + // it's not a valid ErrorEvent (one with an error property) + // it's not an Error + // So bail out and capture it as a simple message: + return this.captureMessage( + ex, + objectMerge(options, { + stacktrace: true, // if we fall back to captureMessage, default to attempting a new trace + trimHeadFrames: options.trimHeadFrames + 1 + }) + ); + } // Store the raw exception object for potential debugging and introspection this._lastCapturedException = ex; @@ -494,6 +509,19 @@ Raven.prototype = { return this; }, + _getCaptureExceptionOptionsFromPlainObject: function(currentOptions, ex) { + var exKeys = Object.keys(ex).sort(); + var options = objectMerge(currentOptions, { + message: + 'Non-Error exception captured with keys: ' + serializeKeysForMessage(exKeys), + fingerprint: [md5(exKeys)], + extra: currentOptions.extra || {} + }); + options.extra.__serialized__ = serializeException(ex); + + return options; + }, + /* * Manually send a message to Sentry * diff --git a/src/utils.js b/src/utils.js index a4fcc6b1ebc9..eab9c76dffa1 100644 --- a/src/utils.js +++ b/src/utils.js @@ -1,3 +1,5 @@ +var stringify = require('../vendor/json-stringify-safe/stringify'); + var _window = typeof window !== 'undefined' ? window @@ -441,6 +443,98 @@ function safeJoin(input, delimiter) { return output.join(delimiter); } +// Default Node.js REPL depth +var MAX_SERIALIZE_EXCEPTION_DEPTH = 3; +// 50kB, as 100kB is max payload size, so half sounds reasonable +var MAX_SERIALIZE_EXCEPTION_SIZE = 50 * 1024; +var MAX_SERIALIZE_KEYS_LENGTH = 40; + +function utf8Length(value) { + return ~-encodeURI(value).split(/%..|./).length; +} + +function jsonSize(value) { + return utf8Length(JSON.stringify(value)); +} + +function serializeValue(value) { + var maxLength = 40; + + if (typeof value === 'string') { + return value.length <= maxLength ? value : value.substr(0, maxLength - 1) + '\u2026'; + } else if ( + typeof value === 'number' || + typeof value === 'boolean' || + typeof value === 'undefined' + ) { + return value; + } + + var type = Object.prototype.toString.call(value); + + // Node.js REPL notation + if (type === '[object Object]') return '[Object]'; + if (type === '[object Array]') return '[Array]'; + if (type === '[object Function]') + return value.name ? '[Function: ' + value.name + ']' : '[Function]'; + + return value; +} + +function serializeObject(value, depth) { + if (depth === 0) return serializeValue(value); + + if (isPlainObject(value)) { + return Object.keys(value).reduce(function(acc, key) { + acc[key] = serializeObject(value[key], depth - 1); + return acc; + }, {}); + } else if (Array.isArray(value)) { + return value.map(function(val) { + return serializeObject(val, depth - 1); + }); + } + + return serializeValue(value); +} + +function serializeException(ex, depth, maxSize) { + if (!isPlainObject(ex)) return ex; + + depth = typeof depth !== 'number' ? MAX_SERIALIZE_EXCEPTION_DEPTH : depth; + maxSize = typeof depth !== 'number' ? MAX_SERIALIZE_EXCEPTION_SIZE : maxSize; + + var serialized = serializeObject(ex, depth); + + if (jsonSize(stringify(serialized)) > maxSize) { + return serializeException(ex, depth - 1); + } + + return serialized; +} + +function serializeKeysForMessage(keys, maxLength) { + if (typeof keys === 'number' || typeof keys === 'string') return keys.toString(); + if (!Array.isArray(keys)) return ''; + + keys = keys.filter(function(key) { + return typeof key === 'string'; + }); + if (keys.length === 0) return '[object has no keys]'; + + maxLength = typeof maxLength !== 'number' ? MAX_SERIALIZE_KEYS_LENGTH : maxLength; + if (keys[0].length >= maxLength) return keys[0]; + + for (var usedKeys = keys.length; usedKeys > 0; usedKeys--) { + var serialized = keys.slice(0, usedKeys).join(', '); + if (serialized.length > maxLength) continue; + if (usedKeys === keys.length) return serialized; + return serialized + '\u2026'; + } + + return ''; +} + module.exports = { isObject: isObject, isError: isError, @@ -470,5 +564,7 @@ module.exports = { isSameStacktrace: isSameStacktrace, parseUrl: parseUrl, fill: fill, - safeJoin: safeJoin + safeJoin: safeJoin, + serializeException: serializeException, + serializeKeysForMessage: serializeKeysForMessage }; diff --git a/test/integration/test.js b/test/integration/test.js index 779e6c38265d..5552ed84b052 100644 --- a/test/integration/test.js +++ b/test/integration/test.js @@ -106,11 +106,8 @@ describe('integration', function() { }, function() { var ravenData = iframe.contentWindow.ravenData[0]; - assert.isAtLeast(ravenData.stacktrace.frames.length, 1); - assert.isAtMost(ravenData.stacktrace.frames.length, 3); - - // verify trimHeadFrames hasn't slipped into final payload - assert.isUndefined(ravenData.trimHeadFrames); + assert.isAtLeast(ravenData.exception.values[0].stacktrace.frames.length, 1); + assert.isAtMost(ravenData.exception.values[0].stacktrace.frames.length, 3); } ); }); diff --git a/test/raven.test.js b/test/raven.test.js index 4d0d7095dfc1..819f31afc65e 100644 --- a/test/raven.test.js +++ b/test/raven.test.js @@ -3079,13 +3079,6 @@ describe('Raven (public API)', function() { }); } - it('should send non-Errors as messages', function() { - this.sinon.stub(Raven, 'isSetup').returns(true); - this.sinon.stub(Raven, 'captureMessage'); - Raven.captureException({}, {foo: 'bar'}); - assert.isTrue(Raven.captureMessage.calledOnce); - }); - it('should call handleStackInfo', function() { var error = new Error('pickleRick'); this.sinon.stub(Raven, 'isSetup').returns(true); @@ -3156,6 +3149,70 @@ describe('Raven (public API)', function() { Raven.captureException(new Error('err')); }); }); + + it('should serialize non-error exceptions', function(done) { + this.sinon.stub(Raven, 'isSetup').returns(true); + this.sinon.stub(Raven, '_send').callsFake(function stubbedSend(kwargs) { + kwargs.message.should.equal( + 'Non-Error exception captured with keys: aKeyOne, bKeyTwo, cKeyThree, dKeyFour\u2026' + ); + + var serialized = kwargs.extra.__serialized__; + var fn; + + // Yes, I know, it's ugly but... + // unfortunately older browsers are not capable of extracting method names + // therefore we have to use `oneOf` here + fn = serialized.eKeyFive; + delete serialized.eKeyFive; + assert.oneOf(fn, ['[Function: foo]', '[Function]']); + + fn = serialized.fKeySix.levelTwo.levelThreeAnonymousFunction; + delete serialized.fKeySix.levelTwo.levelThreeAnonymousFunction; + assert.oneOf(fn, ['[Function: levelThreeAnonymousFunction]', '[Function]']); + + fn = serialized.fKeySix.levelTwo.levelThreeNamedFunction; + delete serialized.fKeySix.levelTwo.levelThreeNamedFunction; + assert.oneOf(fn, ['[Function: bar]', '[Function]']); + + assert.deepEqual(serialized, { + aKeyOne: 'a', + bKeyTwo: 42, + cKeyThree: {}, + dKeyFour: ['d'], + fKeySix: { + levelTwo: { + levelThreeObject: '[Object]', + levelThreeArray: '[Array]', + levelThreeString: 'foo', + levelThreeNumber: 42 + } + } + }); + + done(); + }); + + Raven.captureException({ + aKeyOne: 'a', + bKeyTwo: 42, + cKeyThree: {}, + dKeyFour: ['d'], + eKeyFive: function foo() {}, + fKeySix: { + levelTwo: { + levelThreeObject: { + enough: 42 + }, + levelThreeArray: [42], + levelThreeAnonymousFunction: function() {}, + levelThreeNamedFunction: function bar() {}, + levelThreeString: 'foo', + levelThreeNumber: 42 + } + } + }); + }); }); describe('.captureBreadcrumb', function() { diff --git a/test/utils.test.js b/test/utils.test.js index fd63389efe78..2c4d6baca8ec 100644 --- a/test/utils.test.js +++ b/test/utils.test.js @@ -24,6 +24,8 @@ var htmlTreeAsString = utils.htmlTreeAsString; var htmlElementAsString = utils.htmlElementAsString; var parseUrl = utils.parseUrl; var safeJoin = utils.safeJoin; +var serializeException = utils.serializeException; +var serializeKeysForMessage = utils.serializeKeysForMessage; describe('utils', function() { describe('isUndefined', function() { @@ -453,4 +455,245 @@ describe('utils', function() { ); }); }); + + describe('serializeException', function() { + it('return [Object] when reached depth=0', function() { + var actual = serializeException( + { + a: 42, + b: 'asd', + c: true + }, + 0 + ); + var expected = '[Object]'; + + assert.deepEqual(actual, expected); + }); + + it('should serialize one level deep with depth=1', function() { + var actual = serializeException( + { + a: 42, + b: 'asd', + c: true, + d: undefined, + e: + 'very long string that is definitely over 120 characters, which is default for now but can be changed anytime because why not?', + f: {foo: 42}, + g: [1, 'a', true], + h: function() {} + }, + 1 + ); + var expected = { + a: 42, + b: 'asd', + c: true, + d: undefined, + e: 'very long string that is definitely ove\u2026', + f: '[Object]', + g: '[Array]' + }; + + // Unfortunately older browsers are not capable of extracting method names + // therefore we have to use `oneOf` here + var fn = actual.h; + delete actual.h; + + assert.deepEqual(actual, expected); + assert.oneOf(fn, ['[Function: h]', '[Function]']); + }); + + it('should serialize arbitrary number of depths', function() { + var actual = serializeException( + { + a: 42, + b: 'asd', + c: true, + d: undefined, + e: + 'very long string that is definitely over 40 characters, which is default for now but can be changed', + f: { + foo: 42, + bar: { + foo: 42, + bar: { + bar: { + bar: { + bar: 42 + } + } + }, + baz: ['hello'] + }, + baz: [1, 'a', true] + }, + g: [1, 'a', true], + h: function bar() {} + }, + 5 + ); + var expected = { + a: 42, + b: 'asd', + c: true, + d: undefined, + e: 'very long string that is definitely ove\u2026', + f: { + foo: 42, + bar: { + foo: 42, + bar: { + bar: { + bar: '[Object]' + } + }, + baz: ['hello'] + }, + baz: [1, 'a', true] + }, + g: [1, 'a', true] + }; + + // Unfortunately older browsers are not capable of extracting method names + // therefore we have to use `oneOf` here + var fn = actual.h; + delete actual.h; + + assert.deepEqual(actual, expected); + assert.oneOf(fn, ['[Function: bar]', '[Function]']); + }); + + it('should reduce depth if payload size was exceeded', function() { + var actual = serializeException( + { + a: { + a: '50kB worth of payload pickle rick', + b: '50kB worth of payload pickle rick' + }, + b: '50kB worth of payload pickle rick' + }, + 2, + 100 + ); + var expected = { + a: '[Object]', + b: '50kB worth of payload pickle rick' + }; + + assert.deepEqual(actual, expected); + }); + + it('should reduce depth only one level at the time', function() { + var actual = serializeException( + { + a: { + a: { + a: { + a: [ + '50kB worth of payload pickle rick', + '50kB worth of payload pickle rick', + '50kB worth of payload pickle rick' + ] + } + }, + b: '50kB worth of payload pickle rick' + }, + b: '50kB worth of payload pickle rick' + }, + 4, + 200 + ); + var expected = { + a: { + a: { + a: { + a: '[Array]' + } + }, + b: '50kB worth of payload pickle rick' + }, + b: '50kB worth of payload pickle rick' + }; + + assert.deepEqual(actual, expected); + }); + + it('should fallback to [Object] if cannot reduce payload size enough', function() { + var actual = serializeException( + { + a: '50kB worth of payload pickle rick', + b: '50kB worth of payload pickle rick', + c: '50kB worth of payload pickle rick', + d: '50kB worth of payload pickle rick' + }, + 1, + 100 + ); + var expected = '[Object]'; + + assert.deepEqual(actual, expected); + }); + }); + + describe('serializeKeysForMessage', function() { + it('should fit as many keys as possible in default limit of 40', function() { + var actual = serializeKeysForMessage([ + 'pickle', + 'rick', + 'morty', + 'snuffles', + 'server', + 'request' + ]); + var expected = 'pickle, rick, morty, snuffles, server\u2026'; + assert.equal(actual, expected); + }); + + it('shouldnt append ellipsis if you use the exact length limit', function() { + var actual = serializeKeysForMessage( + ['pickle', 'rick', 'morty', 'summer', 'jerry', 'beth'], + 40 + ); + var expected = 'pickle, rick, morty, summer, jerry, beth'; + // expected.length === 40 + assert.equal(actual, expected); + }); + + it('shouldnt append ellipsis if have enough space', function() { + var actual = serializeKeysForMessage(['pickle', 'rick', 'morty']); + var expected = 'pickle, rick, morty'; + assert.equal(actual, expected); + }); + + it('should default to no-keys message if empty array provided', function() { + var actual = serializeKeysForMessage([]); + var expected = '[object has no keys]'; + assert.equal(actual, expected); + }); + + it('should leave first key as is, if its too long for the limit', function() { + var actual = serializeKeysForMessage([ + 'imSuchALongKeyThatIDontEvenFitInTheLimitOf40Characters', + 'pickle' + ]); + var expected = 'imSuchALongKeyThatIDontEvenFitInTheLimitOf40Characters'; + assert.equal(actual, expected); + }); + + it('should work with provided maxLength', function() { + var actual = serializeKeysForMessage(['foo', 'bar', 'baz'], 10); + var expected = 'foo, bar\u2026'; + assert.equal(actual, expected); + }); + + it('handles incorrect input', function() { + assert.equal(serializeKeysForMessage({}), ''); + assert.equal(serializeKeysForMessage(false), ''); + assert.equal(serializeKeysForMessage(undefined), ''); + assert.equal(serializeKeysForMessage(42), '42'); + assert.equal(serializeKeysForMessage('foo'), 'foo'); + }); + }); }); diff --git a/vendor/md5/md5.js b/vendor/md5/md5.js new file mode 100644 index 000000000000..6ed37d99bb31 --- /dev/null +++ b/vendor/md5/md5.js @@ -0,0 +1,266 @@ +/* + * JavaScript MD5 + * https://github.com/blueimp/JavaScript-MD5 + * + * Copyright 2011, Sebastian Tschan + * https://blueimp.net + * + * Licensed under the MIT license: + * https://opensource.org/licenses/MIT + * + * Based on + * A JavaScript implementation of the RSA Data Security, Inc. MD5 Message + * Digest Algorithm, as defined in RFC 1321. + * Version 2.2 Copyright (C) Paul Johnston 1999 - 2009 + * Other contributors: Greg Holt, Andrew Kepert, Ydnar, Lostinet + * Distributed under the BSD License + * See http://pajhome.org.uk/crypt/md5 for more info. + */ + +/* +* Add integers, wrapping at 2^32. This uses 16-bit operations internally +* to work around bugs in some JS interpreters. +*/ +function safeAdd(x, y) { + var lsw = (x & 0xffff) + (y & 0xffff); + var msw = (x >> 16) + (y >> 16) + (lsw >> 16); + return (msw << 16) | (lsw & 0xffff); +} + +/* +* Bitwise rotate a 32-bit number to the left. +*/ +function bitRotateLeft(num, cnt) { + return (num << cnt) | (num >>> (32 - cnt)); +} + +/* +* These functions implement the four basic operations the algorithm uses. +*/ +function md5cmn(q, a, b, x, s, t) { + return safeAdd(bitRotateLeft(safeAdd(safeAdd(a, q), safeAdd(x, t)), s), b); +} +function md5ff(a, b, c, d, x, s, t) { + return md5cmn((b & c) | (~b & d), a, b, x, s, t); +} +function md5gg(a, b, c, d, x, s, t) { + return md5cmn((b & d) | (c & ~d), a, b, x, s, t); +} +function md5hh(a, b, c, d, x, s, t) { + return md5cmn(b ^ c ^ d, a, b, x, s, t); +} +function md5ii(a, b, c, d, x, s, t) { + return md5cmn(c ^ (b | ~d), a, b, x, s, t); +} + +/* +* Calculate the MD5 of an array of little-endian words, and a bit length. +*/ +function binlMD5(x, len) { + /* append padding */ + x[len >> 5] |= 0x80 << (len % 32); + x[(((len + 64) >>> 9) << 4) + 14] = len; + + var i; + var olda; + var oldb; + var oldc; + var oldd; + var a = 1732584193; + var b = -271733879; + var c = -1732584194; + var d = 271733878; + + for (i = 0; i < x.length; i += 16) { + olda = a; + oldb = b; + oldc = c; + oldd = d; + + a = md5ff(a, b, c, d, x[i], 7, -680876936); + d = md5ff(d, a, b, c, x[i + 1], 12, -389564586); + c = md5ff(c, d, a, b, x[i + 2], 17, 606105819); + b = md5ff(b, c, d, a, x[i + 3], 22, -1044525330); + a = md5ff(a, b, c, d, x[i + 4], 7, -176418897); + d = md5ff(d, a, b, c, x[i + 5], 12, 1200080426); + c = md5ff(c, d, a, b, x[i + 6], 17, -1473231341); + b = md5ff(b, c, d, a, x[i + 7], 22, -45705983); + a = md5ff(a, b, c, d, x[i + 8], 7, 1770035416); + d = md5ff(d, a, b, c, x[i + 9], 12, -1958414417); + c = md5ff(c, d, a, b, x[i + 10], 17, -42063); + b = md5ff(b, c, d, a, x[i + 11], 22, -1990404162); + a = md5ff(a, b, c, d, x[i + 12], 7, 1804603682); + d = md5ff(d, a, b, c, x[i + 13], 12, -40341101); + c = md5ff(c, d, a, b, x[i + 14], 17, -1502002290); + b = md5ff(b, c, d, a, x[i + 15], 22, 1236535329); + + a = md5gg(a, b, c, d, x[i + 1], 5, -165796510); + d = md5gg(d, a, b, c, x[i + 6], 9, -1069501632); + c = md5gg(c, d, a, b, x[i + 11], 14, 643717713); + b = md5gg(b, c, d, a, x[i], 20, -373897302); + a = md5gg(a, b, c, d, x[i + 5], 5, -701558691); + d = md5gg(d, a, b, c, x[i + 10], 9, 38016083); + c = md5gg(c, d, a, b, x[i + 15], 14, -660478335); + b = md5gg(b, c, d, a, x[i + 4], 20, -405537848); + a = md5gg(a, b, c, d, x[i + 9], 5, 568446438); + d = md5gg(d, a, b, c, x[i + 14], 9, -1019803690); + c = md5gg(c, d, a, b, x[i + 3], 14, -187363961); + b = md5gg(b, c, d, a, x[i + 8], 20, 1163531501); + a = md5gg(a, b, c, d, x[i + 13], 5, -1444681467); + d = md5gg(d, a, b, c, x[i + 2], 9, -51403784); + c = md5gg(c, d, a, b, x[i + 7], 14, 1735328473); + b = md5gg(b, c, d, a, x[i + 12], 20, -1926607734); + + a = md5hh(a, b, c, d, x[i + 5], 4, -378558); + d = md5hh(d, a, b, c, x[i + 8], 11, -2022574463); + c = md5hh(c, d, a, b, x[i + 11], 16, 1839030562); + b = md5hh(b, c, d, a, x[i + 14], 23, -35309556); + a = md5hh(a, b, c, d, x[i + 1], 4, -1530992060); + d = md5hh(d, a, b, c, x[i + 4], 11, 1272893353); + c = md5hh(c, d, a, b, x[i + 7], 16, -155497632); + b = md5hh(b, c, d, a, x[i + 10], 23, -1094730640); + a = md5hh(a, b, c, d, x[i + 13], 4, 681279174); + d = md5hh(d, a, b, c, x[i], 11, -358537222); + c = md5hh(c, d, a, b, x[i + 3], 16, -722521979); + b = md5hh(b, c, d, a, x[i + 6], 23, 76029189); + a = md5hh(a, b, c, d, x[i + 9], 4, -640364487); + d = md5hh(d, a, b, c, x[i + 12], 11, -421815835); + c = md5hh(c, d, a, b, x[i + 15], 16, 530742520); + b = md5hh(b, c, d, a, x[i + 2], 23, -995338651); + + a = md5ii(a, b, c, d, x[i], 6, -198630844); + d = md5ii(d, a, b, c, x[i + 7], 10, 1126891415); + c = md5ii(c, d, a, b, x[i + 14], 15, -1416354905); + b = md5ii(b, c, d, a, x[i + 5], 21, -57434055); + a = md5ii(a, b, c, d, x[i + 12], 6, 1700485571); + d = md5ii(d, a, b, c, x[i + 3], 10, -1894986606); + c = md5ii(c, d, a, b, x[i + 10], 15, -1051523); + b = md5ii(b, c, d, a, x[i + 1], 21, -2054922799); + a = md5ii(a, b, c, d, x[i + 8], 6, 1873313359); + d = md5ii(d, a, b, c, x[i + 15], 10, -30611744); + c = md5ii(c, d, a, b, x[i + 6], 15, -1560198380); + b = md5ii(b, c, d, a, x[i + 13], 21, 1309151649); + a = md5ii(a, b, c, d, x[i + 4], 6, -145523070); + d = md5ii(d, a, b, c, x[i + 11], 10, -1120210379); + c = md5ii(c, d, a, b, x[i + 2], 15, 718787259); + b = md5ii(b, c, d, a, x[i + 9], 21, -343485551); + + a = safeAdd(a, olda); + b = safeAdd(b, oldb); + c = safeAdd(c, oldc); + d = safeAdd(d, oldd); + } + return [a, b, c, d]; +} + +/* +* Convert an array of little-endian words to a string +*/ +function binl2rstr(input) { + var i; + var output = ''; + var length32 = input.length * 32; + for (i = 0; i < length32; i += 8) { + output += String.fromCharCode((input[i >> 5] >>> (i % 32)) & 0xff); + } + return output; +} + +/* +* Convert a raw string to an array of little-endian words +* Characters >255 have their high-byte silently ignored. +*/ +function rstr2binl(input) { + var i; + var output = []; + output[(input.length >> 2) - 1] = undefined; + for (i = 0; i < output.length; i += 1) { + output[i] = 0; + } + var length8 = input.length * 8; + for (i = 0; i < length8; i += 8) { + output[i >> 5] |= (input.charCodeAt(i / 8) & 0xff) << (i % 32); + } + return output; +} + +/* +* Calculate the MD5 of a raw string +*/ +function rstrMD5(s) { + return binl2rstr(binlMD5(rstr2binl(s), s.length * 8)); +} + +/* +* Calculate the HMAC-MD5, of a key and some data (raw strings) +*/ +function rstrHMACMD5(key, data) { + var i; + var bkey = rstr2binl(key); + var ipad = []; + var opad = []; + var hash; + ipad[15] = opad[15] = undefined; + if (bkey.length > 16) { + bkey = binlMD5(bkey, key.length * 8); + } + for (i = 0; i < 16; i += 1) { + ipad[i] = bkey[i] ^ 0x36363636; + opad[i] = bkey[i] ^ 0x5c5c5c5c; + } + hash = binlMD5(ipad.concat(rstr2binl(data)), 512 + data.length * 8); + return binl2rstr(binlMD5(opad.concat(hash), 512 + 128)); +} + +/* +* Convert a raw string to a hex string +*/ +function rstr2hex(input) { + var hexTab = '0123456789abcdef'; + var output = ''; + var x; + var i; + for (i = 0; i < input.length; i += 1) { + x = input.charCodeAt(i); + output += hexTab.charAt((x >>> 4) & 0x0f) + hexTab.charAt(x & 0x0f); + } + return output; +} + +/* +* Encode a string as utf-8 +*/ +function str2rstrUTF8(input) { + return unescape(encodeURIComponent(input)); +} + +/* +* Take string arguments and return either raw or hex encoded strings +*/ +function rawMD5(s) { + return rstrMD5(str2rstrUTF8(s)); +} +function hexMD5(s) { + return rstr2hex(rawMD5(s)); +} +function rawHMACMD5(k, d) { + return rstrHMACMD5(str2rstrUTF8(k), str2rstrUTF8(d)); +} +function hexHMACMD5(k, d) { + return rstr2hex(rawHMACMD5(k, d)); +} + +function md5(string, key, raw) { + if (!key) { + if (!raw) { + return hexMD5(string); + } + return rawMD5(string); + } + if (!raw) { + return hexHMACMD5(key, string); + } + return rawHMACMD5(key, string); +} + +module.exports = md5;