Skip to content

allow hs2019 algorithm in signing and verifying #105

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

allow hs2019 algorithm in signing and verifying #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eac0b4b
allow hs2019 algorithm in signing and verifying
blacktemplar Apr 3, 2020
a045447
add assert for new option
blacktemplar Apr 4, 2020
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
16 changes: 12 additions & 4 deletions lib/signer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,9 @@ RequestSigner.prototype.sign = function (cb) {
assert.string(sig.keyId, 'signature.keyId');
assert.string(sig.algorithm, 'signature.algorithm');
assert.string(sig.signature, 'signature.signature');
alg = validateAlgorithm(sig.algorithm);
if (sig.algorithm !== "hs2019") {
alg = validateAlgorithm(sig.algorithm);
}

authz = FormatAuthz('Signature ', {
keyId: sig.keyId,
Expand All @@ -226,11 +228,13 @@ RequestSigner.prototype.sign = function (cb) {
cb(e);
return;
}
alg = (this.rs_alg[0] || this.rs_key.type) + '-' + sigObj.hashAlgorithm;
if (!sigObj.hideAlgorithm) {
alg = (this.rs_alg[0] || this.rs_key.type) + '-' + sigObj.hashAlgorithm;
}
var signature = sigObj.toString();
authz = FormatAuthz('Signature ', {
keyId: this.rs_keyId,
algorithm: alg,
algorithm: sigObj.hideAlgorithm ? "hs2019" : alg,
headers: this.rs_headers.join(' '),
signature: signature
});
Expand Down Expand Up @@ -294,6 +298,9 @@ module.exports = {
* signing algorithm for the type of key given
* - {String} httpVersion optional; defaults to '1.1'.
* - {Boolean} strict optional; defaults to 'false'.
* - {Boolean} hideAlgorithm optional; if true, hides
* algorithm by writing "hs2019" to signature;
* defaults to 'false'.
* @return {Boolean} true if Authorization (and optionally Date) were added.
* @throws {TypeError} on bad parameter types (input).
* @throws {InvalidAlgorithmError} if algorithm was bad or incompatible with
Expand All @@ -310,6 +317,7 @@ module.exports = {
assert.optionalString(options.opaque, 'options.opaque');
assert.optionalArrayOfString(options.headers, 'options.headers');
assert.optionalString(options.httpVersion, 'options.httpVersion');
assert.optionalBool(options.hideAlgorithm, 'options.hideAlgorithm');

if (!request.getHeader('Date'))
request.setHeader('Date', jsprim.rfc1123(new Date()));
Expand Down Expand Up @@ -433,7 +441,7 @@ module.exports = {

var params = {
'keyId': options.keyId,
'algorithm': options.algorithm,
'algorithm': options.hideAlgorithm ? "hs2019" : options.algorithm,
'signature': signature
};
if (options.opaque)
Expand Down
10 changes: 8 additions & 2 deletions lib/verify.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,23 @@ module.exports = {
*
* @param {Object} parsedSignature the object you got from `parse`.
* @param {String} pubkey RSA/DSA private key PEM.
* @param {String} overriddenAlgorithm if signature has hidden algorithm this tells the verifier the real algorithm to use
* @return {Boolean} true if valid, false otherwise.
* @throws {TypeError} if you pass in bad arguments.
* @throws {InvalidAlgorithmError}
*/
verifySignature: function verifySignature(parsedSignature, pubkey) {
verifySignature: function verifySignature(parsedSignature, pubkey, overriddenAlgorithm = null) {
assert.object(parsedSignature, 'parsedSignature');
if (typeof (pubkey) === 'string' || Buffer.isBuffer(pubkey))
pubkey = sshpk.parseKey(pubkey);
assert.ok(sshpk.Key.isKey(pubkey, [1, 1]), 'pubkey must be a sshpk.Key');

var alg = validateAlgorithm(parsedSignature.algorithm);
var algorithm = parsedSignature.algorithm;
if (algorithm === "hs2019" && overriddenAlgorithm !== null) {
algorithm = overriddenAlgorithm;
}

var alg = validateAlgorithm(algorithm);
if (alg[0] === 'hmac' || alg[0] !== pubkey.type)
return (false);

Expand Down