[aerogear-dev] cordova javascript api
Hi,
Just wanted to talk about the api for cordova crypto, right now the api looks like this:
var agCrypto = new AeroGear.Crypto();
agCrypto.deriveKey( function(rawPassword) {
var options = {
IV: "69696ee955b62b73cd62bda875fc73d68219e0036b7a0b37",
AAD: "feedfacedeadbeeffeedfacedeadbeefabaddad2",
key: rawPassword,
data: "My Bonnie lies over the ocean, my Bonnie lies over the sea"
};
agCrypto.encrypt( function(cipherText) {
console.log(cipherText)
}, options );
}, errorHandler, 'myPassword' );
So this calls the deriveKey function and within that function it calls the encrypt now
this nesting is going to get worse when we add getRandomValue on top of this so I suggest
we change it a bit to the style we also use in the data manager:
agCrypto.getRandomValue({
success: function (generatedIV) {
agCrypto.deriveKey({
password: 'my password',
success: function (rawPassword) {
agCrypto.encrypt({
options: {
IV: generatedIV,
key: rawPassword,
data: "My Bonnie lies over the ocean, my Bonnie lies over the
sea"
},
success: function (cipherText) {
console.log(cipherText);
}
});
}
});
}
});
Although this style is more readable and the nesting could be broken up by introducing
references to functions it's still not very nice and it's getting more away from
the original javascript api. One last solution we could use be to use promises, because we
already have a dependency to the jquery promises we could reuse them here and get rid of
the nesting like so:
agCrypto.deriveKey('my password').then(function(rawPassword) {
return agCrypto.getRandomValue();
}).then(function(generatedIV) {
return agCrypto.encrypt({
IV: generatedIV,
key: rawPassword,
data: "My Bonnie lies over the ocean, my Bonnie lies over the sea"
});
}).then(function(cipherText) {
console.log(cipherText);
}, function(error) {
// there was some error.
});
Now in my opinion this is the most readable of them all, but the trick is now it looks
nothing like the original javascript api, but maybe we need to let go of that in favour of
readability. Which version do you prefer and what do you think?
Cheers,
Erik Jan
Attachments:
- attachment.html (text/html — 11.4 KB)