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

outdated Q library was removed #478

Merged
merged 1 commit into from
Oct 29, 2020
Merged

outdated Q library was removed #478

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
98 changes: 88 additions & 10 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@
"dependencies": {
"debug": "^3.1.0",
"passport-strategy": "*",
"q": "^1.5.0",
"xml-crypto": "^2.0.0",
"xml-encryption": "1.2.1",
"xml2js": "0.4.x",
Expand All @@ -47,7 +46,6 @@
"@types/debug": "^4.1.5",
"@types/node": "^14.14.5",
"@types/passport-strategy": "^0.2.35",
"@types/q": "^1.5.4",
"@types/xml-crypto": "^1.4.1",
"@types/xml2js": "^0.4.5",
"@types/xmldom": "^0.1.30",
Expand Down
67 changes: 33 additions & 34 deletions src/passport-saml/saml.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,11 @@ import url from 'url';
import querystring from 'querystring';
import xmlbuilder from 'xmlbuilder';
import xmlenc from 'xml-encryption';
import util from 'util';
import util, { promisify } from 'util';
import {CacheProvider as InMemoryCacheProvider} from './inmemory-cache-provider';
import * as algorithms from './algorithms';
import { signAuthnRequestPost } from './saml-post-signing';
import type { Request } from 'express';
import Q from 'q';

function processValidlySignedPostRequest(self: SAML, doc, dom, callback) {
const request = doc.LogoutRequest;
Expand Down Expand Up @@ -100,6 +99,8 @@ interface SAMLOptions {
decryptionPvk: string;
logoutCallbackUrl: string;
validateInResponseTo: boolean;
requestIdExpirationPeriodMs: number;
audience: string;
}


Expand Down Expand Up @@ -238,13 +239,13 @@ class SAML {
const instant = this.generateInstant();
const forceAuthn = this.options.forceAuthn || false;

Q.fcall(() => {
(async () => {
if(this.options.validateInResponseTo) {
return Q.ninvoke(this.cacheProvider, 'save', id, instant);
return promisify(this.cacheProvider.save).bind(this.cacheProvider)(id, instant);
} else {
return Q();
return;
}
})
})()
.then(() => {
const request = {
'samlp:AuthnRequest': {
Expand Down Expand Up @@ -310,10 +311,9 @@ class SAML {
}
callback(null, stringRequest);
})
.fail(function(err){
.catch(function(err){
callback(err);
})
.done();
});
}

generateLogoutRequest(req) {
Expand Down Expand Up @@ -354,7 +354,7 @@ class SAML {
};
}

return Q.ninvoke(this.cacheProvider, 'save', id, instant)
return util.promisify(this.cacheProvider.save).bind(this.cacheProvider)(id, instant)
.then(function() {
return xmlbuilder.create(request).end();
});
Expand Down Expand Up @@ -662,7 +662,7 @@ class SAML {
validatePostResponse(container, callback) {
let xml, doc, inResponseTo;

Q.fcall(() => {
(async() => {
xml = Buffer.from(container.SAMLResponse, 'base64').toString('utf8');
doc = new xmldom.DOMParser({
}).parseFromString(xml);
Expand All @@ -677,7 +677,7 @@ class SAML {

return this.validateInResponseTo(inResponseTo);
}
})
})()
.then(() => this.certsToCheck())
.then(certs => {
// Check if this document has a valid top-level signature
Expand Down Expand Up @@ -712,7 +712,7 @@ class SAML {
const encryptedAssertionXml = encryptedAssertions[0].toString();

const xmlencOptions = { key: this.options.decryptionPvk };
return Q.ninvoke<string>(xmlenc, 'decrypt', encryptedAssertionXml, xmlencOptions)
return util.promisify(xmlenc.decrypt).bind(xmlenc)(encryptedAssertionXml, xmlencOptions)
.then(decryptedXml => {
const decryptedDoc = new xmldom.DOMParser().parseFromString(decryptedXml);
const decryptedAssertions = xpath(decryptedDoc, "/*[local-name()='Assertion']");
Expand Down Expand Up @@ -797,31 +797,30 @@ class SAML {
.catch(err => {
debug('validatePostResponse resulted in an error: %s', err);
if (this.options.validateInResponseTo) {
Q.ninvoke(this.cacheProvider, 'remove', inResponseTo)
util.promisify(this.cacheProvider.remove).bind(this.cacheProvider)(inResponseTo)
.then(function() {
callback(err);
});
} else {
callback(err);
}
})
.done();
});
}

validateInResponseTo(inResponseTo) {
if (this.options.validateInResponseTo) {
if (inResponseTo) {
return Q.ninvoke(this.cacheProvider, 'get', inResponseTo)
return util.promisify(this.cacheProvider.get).bind(this.cacheProvider)(inResponseTo)
.then(result => {
if (!result)
throw new Error('InResponseTo is not valid');
return Q();
return Promise.resolve();
});
} else {
throw new Error('InResponseTo is missing from response');
}
} else {
return Q();
return Promise.resolve();
}
}

Expand All @@ -846,13 +845,13 @@ class SAML {
return callback(err);
}

Q.fcall(() => {
(async () => {
return samlMessageType === 'SAMLResponse' ?
this.verifyLogoutResponse(doc) : this.verifyLogoutRequest(doc);
})
})()
.then(() => this.hasValidSignatureForRedirect(container, originalQuery))
.then(() => processValidlySignedSamlLogout(this, doc, dom, callback))
.fail(err => callback(err));
.catch(err => callback(err));
});
});
}
Expand Down Expand Up @@ -886,7 +885,7 @@ class SAML {
}
});
} else {
return Q(true);
return Promise.resolve(true);
}
}

Expand Down Expand Up @@ -926,7 +925,7 @@ class SAML {
}

verifyLogoutResponse(doc) {
return Q.fcall(() => {
return (async () => {
const statusCode = doc.LogoutResponse.Status[0].StatusCode[0].$.Value;
if (statusCode !== "urn:oasis:names:tc:SAML:2.0:status:Success")
throw 'Bad status code: ' + statusCode;
Expand All @@ -937,8 +936,8 @@ class SAML {
return this.validateInResponseTo(inResponseTo);
}

return Q(true);
});
return Promise.resolve(true);
})();
}

verifyIssuer(samlMessage) {
Expand All @@ -953,7 +952,7 @@ class SAML {
}
}

processValidlySignedAssertion = function(xml, samlResponseXml, inResponseTo, callback) {
processValidlySignedAssertion(xml, samlResponseXml, inResponseTo, callback) {
let msg;
const parserConfig = {
explicitRoot: true,
Expand Down Expand Up @@ -1030,34 +1029,34 @@ class SAML {
if (confirmData && confirmData.$) {
const subjectInResponseTo = confirmData.$.InResponseTo;
if (inResponseTo && subjectInResponseTo && subjectInResponseTo != inResponseTo) {
return Q.ninvoke(this.cacheProvider, 'remove', inResponseTo)
return util.promisify(this.cacheProvider.remove).bind(this.cacheProvider)(inResponseTo)
.then(() => {
throw new Error('InResponseTo is not valid');
});
} else if (subjectInResponseTo) {
let foundValidInResponseTo = false;
return Q.ninvoke<string>(this.cacheProvider, 'get', subjectInResponseTo)
return util.promisify(this.cacheProvider.get).bind(this.cacheProvider)(subjectInResponseTo)
.then(result => {
if (result) {
const createdAt = new Date(result);
if (nowMs < createdAt.getTime() + this.options.requestIdExpirationPeriodMs)
foundValidInResponseTo = true;
}
return Q.ninvoke(this.cacheProvider, 'remove', inResponseTo );
return util.promisify(this.cacheProvider.remove).bind(this.cacheProvider)(inResponseTo);
})
.then(() => {
if (!foundValidInResponseTo) {
throw new Error('InResponseTo is not valid');
}
return Q();
return Promise.resolve();
});
}
}
} else {
return Q.ninvoke(this.cacheProvider, 'remove', inResponseTo);
return util.promisify(this.cacheProvider.remove).bind(this.cacheProvider)(inResponseTo);
}
} else {
return Q();
return Promise.resolve();
}
})
.then(() => {
Expand Down Expand Up @@ -1215,7 +1214,7 @@ class SAML {
const encryptedDataXml = encryptedDatas[0].toString();

const xmlencOptions = { key: self.options.decryptionPvk };
return Q.ninvoke<string>(xmlenc, 'decrypt', encryptedDataXml, xmlencOptions)
return util.promisify(xmlenc.decrypt).bind(xmlenc)(encryptedDataXml, xmlencOptions)
.then(function (decryptedXml) {
const decryptedDoc = new xmldom.DOMParser().parseFromString(decryptedXml);
const decryptedIds = xpath(decryptedDoc, "/*[local-name()='NameID']");
Expand Down