Skip to content

Commit

Permalink
Merge pull request #1351 from ably/1345-change-generateRandomKey-to-p…
Browse files Browse the repository at this point in the history 
…romise

Change `Crypto.generateRandomKey` API to use Promises
  • Loading branch information
@lawrence-forooghian
lawrence-forooghian authored Jul 3, 2023
2 parents b61e18b + a0105eb commit 1172194
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 46 deletions.
4 changes: 2 additions & 2 deletions ably.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2963,9 +2963,9 @@ declare namespace Types {
* Generates a random key to be used in the encryption of the channel. If the language cryptographic randomness primitives are blocking or async, a callback is used. The callback returns a generated binary key.
*
* @param keyLength - The length of the key, in bits, to be generated. If not specified, this is equal to the default `keyLength` of the default algorithm: for AES this is 256 bits.
* @param callback - A function which, upon success, will be called with the generated key as a binary, for example, a byte array. Upon failure, the function will be called with information about the error.
* @returns A promise which, upon success, will be fulfilled with the generated key as a binary, for example, a byte array. Upon failure, the promise will be rejected with an {@link Types.ErrorInfo} object which explains the error.
*/
generateRandomKey(keyLength?: number, callback?: Types.StandardCallback<CipherKey>): void;
generateRandomKey(keyLength?: number): Promise<CipherKey>;
/**
* Returns a {@link CipherParams} object, using the default values for any fields not supplied by the {@link CipherParamOptions} object.
*
Expand Down
23 changes: 10 additions & 13 deletions src/platform/nodejs/lib/util/crypto.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,19 +190,16 @@ var CryptoFactory = function (bufferUtils: typeof BufferUtils) {
* @param keyLength (optional) the required keyLength in bits
* @param callback (optional) (err, key)
*/
static generateRandomKey(keyLength?: number, callback?: API.Types.StandardCallback<API.Types.CipherKey>) {
if (arguments.length == 1 && typeof keyLength == 'function') {
callback = keyLength;
keyLength = undefined;
}

generateRandom((keyLength || DEFAULT_KEYLENGTH) / 8, function (err, buf) {
if (callback !== undefined) {
const errorInfo = err
? new ErrorInfo('Failed to generate random key: ' + err.message, 500, 50000, err)
: null;
callback(errorInfo, buf);
}
static async generateRandomKey(keyLength?: number): Promise<API.Types.CipherKey> {
return new Promise((resolve, reject) => {
generateRandom((keyLength || DEFAULT_KEYLENGTH) / 8, function (err, buf) {
if (err) {
const errorInfo = new ErrorInfo('Failed to generate random key: ' + err.message, 500, 50000, err);
reject(errorInfo);
} else {
resolve(buf!);
}
});
});
}

Expand Down
24 changes: 10 additions & 14 deletions src/platform/web/lib/util/crypto.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -181,21 +181,17 @@ var CryptoFactory = function (config: IPlatformConfig, bufferUtils: typeof Buffe
* Generate a random encryption key from the supplied keylength (or the
* default keyLength if none supplied) as an ArrayBuffer
* @param keyLength (optional) the required keyLength in bits
* @param callback (optional) (err, key)
*/
static generateRandomKey(keyLength?: number, callback?: API.Types.StandardCallback<API.Types.CipherKey>) {
if (arguments.length == 1 && typeof keyLength == 'function') {
callback = keyLength;
keyLength = undefined;
}

generateRandom((keyLength || DEFAULT_KEYLENGTH) / 8, function (err, buf) {
if (callback !== undefined) {
const errorInfo = err
? new ErrorInfo('Failed to generate random key: ' + err.message, 400, 50000, err)
: null;
callback(errorInfo, buf ?? undefined);
}
static async generateRandomKey(keyLength?: number): Promise<API.Types.CipherKey> {
return new Promise((resolve, reject) => {
generateRandom((keyLength || DEFAULT_KEYLENGTH) / 8, function (err, buf) {
if (err) {
const errorInfo = new ErrorInfo('Failed to generate random key: ' + err.message, 400, 50000, err);
reject(errorInfo);
} else {
resolve(buf!);
}
});
});
}

Expand Down
34 changes: 17 additions & 17 deletions test/realtime/crypto.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ define(['ably', 'shared_helper', 'async', 'chai'], function (Ably, helper, async

/* generateRandomKey with an explicit keyLength */
it('generateRandomKey0', function (done) {
Crypto.generateRandomKey(64, function (err, key) {
whenPromiseSettles(Crypto.generateRandomKey(64), function (err, key) {
if (err) {
done(err);
return;
Expand All @@ -136,7 +136,7 @@ define(['ably', 'shared_helper', 'async', 'chai'], function (Ably, helper, async

/* generateRandomKey with no keyLength should generate 256-bit keys */
it('generateRandomKey1', function (done) {
Crypto.generateRandomKey(function (err, key) {
whenPromiseSettles(Crypto.generateRandomKey(), function (err, key) {
if (err) {
done(err);
return;
Expand All @@ -151,7 +151,7 @@ define(['ably', 'shared_helper', 'async', 'chai'], function (Ably, helper, async
});

it('getDefaultParams_withResultOfGenerateRandomKey', function (done) {
Crypto.generateRandomKey(function (err, key) {
whenPromiseSettles(Crypto.generateRandomKey(), function (err, key) {
if (err) {
done(err);
}
Expand All @@ -168,7 +168,7 @@ define(['ably', 'shared_helper', 'async', 'chai'], function (Ably, helper, async
});

it('getDefaultParams_ArrayBuffer_key', function (done) {
Crypto.generateRandomKey(function (err, key) {
whenPromiseSettles(Crypto.generateRandomKey(), function (err, key) {
if (err) {
done(err);
}
Expand All @@ -184,7 +184,7 @@ define(['ably', 'shared_helper', 'async', 'chai'], function (Ably, helper, async
});

it('getDefaultParams_base64_key', function (done) {
Crypto.generateRandomKey(function (err, key) {
whenPromiseSettles(Crypto.generateRandomKey(), function (err, key) {
if (err) {
done(err);
return;
Expand All @@ -201,7 +201,7 @@ define(['ably', 'shared_helper', 'async', 'chai'], function (Ably, helper, async
});

it('getDefaultParams_check_keylength', function (done) {
Crypto.generateRandomKey(64, function (err, key) {
whenPromiseSettles(Crypto.generateRandomKey(64), function (err, key) {
if (err) {
done(err);
return;
Expand All @@ -216,7 +216,7 @@ define(['ably', 'shared_helper', 'async', 'chai'], function (Ably, helper, async
});

it('getDefaultParams_preserves_custom_algorithms', function (done) {
Crypto.generateRandomKey(64, function (err, key) {
whenPromiseSettles(Crypto.generateRandomKey(64), function (err, key) {
if (err) {
done(err);
return;
Expand Down Expand Up @@ -401,7 +401,7 @@ define(['ably', 'shared_helper', 'async', 'chai'], function (Ably, helper, async
return;
}

Crypto.generateRandomKey(keyLength, function (err, key) {
whenPromiseSettles(Crypto.generateRandomKey(keyLength), function (err, key) {
if (err) {
closeAndFinish(done, realtime, err);
return;
Expand Down Expand Up @@ -464,7 +464,7 @@ define(['ably', 'shared_helper', 'async', 'chai'], function (Ably, helper, async
channel = realtime.channels.get(channelName),
messageText = 'Test message (' + channelName + ')';

Crypto.generateRandomKey(128, function (err, key) {
whenPromiseSettles(Crypto.generateRandomKey(128), function (err, key) {
channel.setOptions({ cipher: { key: key } });
try {
expect(channel.channelOptions.cipher.algorithm).to.equal('aes');
Expand Down Expand Up @@ -534,7 +534,7 @@ define(['ably', 'shared_helper', 'async', 'chai'], function (Ably, helper, async
txChannel = txRealtime.channels.get(channelName),
rxChannel = rxRealtime.channels.get(channelName);

Crypto.generateRandomKey(function (err, key) {
whenPromiseSettles(Crypto.generateRandomKey(), function (err, key) {
if (err) {
closeAndFinish(done, realtime, err);
return;
Expand Down Expand Up @@ -608,7 +608,7 @@ define(['ably', 'shared_helper', 'async', 'chai'], function (Ably, helper, async
channelName = 'publish_immediately',
messageText = 'Test message';

Crypto.generateRandomKey(function (err, key) {
whenPromiseSettles(Crypto.generateRandomKey(), function (err, key) {
if (err) {
closeAndFinish(done, [txRealtime, rxRealtime], err);
return;
Expand Down Expand Up @@ -655,10 +655,10 @@ define(['ably', 'shared_helper', 'async', 'chai'], function (Ably, helper, async
async.parallel(
[
function (cb) {
Crypto.generateRandomKey(cb);
whenPromiseSettles(Crypto.generateRandomKey(), cb);
},
function (cb) {
Crypto.generateRandomKey(cb);
whenPromiseSettles(Crypto.generateRandomKey(), cb);
},
function (cb) {
attachChannels([txChannel, rxChannel], cb);
Expand Down Expand Up @@ -723,7 +723,7 @@ define(['ably', 'shared_helper', 'async', 'chai'], function (Ably, helper, async
closeAndFinish(done, [txRealtime, rxRealtime], err);
return;
}
Crypto.generateRandomKey(function (err, rxKey) {
whenPromiseSettles(Crypto.generateRandomKey(), function (err, rxKey) {
if (err) {
closeAndFinish(done, [txRealtime, rxRealtime], err);
return;
Expand Down Expand Up @@ -766,7 +766,7 @@ define(['ably', 'shared_helper', 'async', 'chai'], function (Ably, helper, async
closeAndFinish(done, [txRealtime, rxRealtime], err);
return;
}
Crypto.generateRandomKey(function (err, txKey) {
whenPromiseSettles(Crypto.generateRandomKey(), function (err, txKey) {
if (err) {
closeAndFinish(done, [txRealtime, rxRealtime], err);
return;
Expand Down Expand Up @@ -811,7 +811,7 @@ define(['ably', 'shared_helper', 'async', 'chai'], function (Ably, helper, async
attachChannels([txChannel, rxChannel], cb);
};
var setInitialOptions = function (cb) {
Crypto.generateRandomKey(function (err, key) {
whenPromiseSettles(Crypto.generateRandomKey(), function (err, key) {
if (err) {
closeAndFinish(done, [txRealtime, rxRealtime], err);
return;
Expand Down Expand Up @@ -844,7 +844,7 @@ define(['ably', 'shared_helper', 'async', 'chai'], function (Ably, helper, async
};

var createSecondKey = function (cb) {
Crypto.generateRandomKey(function (err, key) {
whenPromiseSettles(Crypto.generateRandomKey(), function (err, key) {
if (err) {
closeAndFinish(done, [txRealtime, rxRealtime], err);
return;
Expand Down

0 comments on commit 1172194

Please sign in to comment.