Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow Message#fromEncoded to take a short-form (key-only) cipherParams #438

Merged
merged 1 commit into from
Dec 11, 2017
Merged

Allow Message#fromEncoded to take a short-form (key-only) cipherParams #438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions common/lib/types/message.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,8 +215,18 @@ var Message = (function() {
return result;
};

function normalizeCipherOptions(options) {
if(options && options.cipher && !options.cipher.channelCipher) {
if(!Crypto) throw new Error('Encryption not enabled; use ably.encryption.js instead');
var cipher = Crypto.getCipher(options.cipher);
options.cipher = cipher.cipherParams;
options.channelCipher = cipher.cipher;
}
}

Message.fromEncoded = function(encoded, options) {
var msg = Message.fromValues(encoded);
normalizeCipherOptions(options);
/* if decoding fails at any point, catch and return the message decoded to
* the fullest extent possible */
try {
Expand All @@ -228,6 +238,7 @@ var Message = (function() {
};

Message.fromEncodedArray = function(encodedArray, options) {
normalizeCipherOptions(options);
return Utils.arrMap(encodedArray, function(encoded) {
return Message.fromEncoded(encoded, options);
});
Expand Down
26 changes: 26 additions & 0 deletions spec/realtime/crypto.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,32 @@ define(['ably', 'shared_helper', 'async'], function(Ably, helper, async) {
});
};

exports.fromEncoded_cipher_options = function(test) {
if(!Crypto) {
test.ok(false, 'Encryption not supported');
test.done();
return;
}

loadTestData(testResourcesPath + 'crypto-data-256.json', function(err, testData) {
if(err) {
test.ok(false, 'Unable to get test assets; err = ' + displayError(err));
return;
}
var key = BufferUtils.base64Decode(testData.key);
var iv = BufferUtils.base64Decode(testData.iv);

test.expect(testData.items.length);
for(var i = 0; i < testData.items.length; i++) {
var item = testData.items[i];
var testMessage = Message.fromEncoded(item.encoded);
var decryptedMessage = Message.fromEncoded(item.encrypted, {cipher: {key: key, iv: iv}});
test.ok(compareMessage(testMessage, decryptedMessage));
}
test.done();
});
};

exports.msgpack_128 = function(test) {
if(typeof ArrayBuffer === 'undefined') {
/* Encryption or binary transport not supported */
Expand Down