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

feat: add external async signing and encryption strategies #74

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: add external async signing and encryption strategies #74

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
44 changes: 39 additions & 5 deletions lib/saml11.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,17 +57,34 @@ function extractSaml11Options(opts) {
* @param [options.encryptionAlgorithm] {string}
* @param [options.keyEncryptionAlgorithm] {string}
*
* @param [strategies]
*
* // Signing strategy
* @param {Function} [strategies.signXml]
*
* // Encryption strategy
* @param {Function} [strategies.encryptXml]
*
* @param {Function} [callback] required if encrypting
* @return {String|*}
*/
exports.create = function(options, callback) {
return createAssertion(extractSaml11Options(options), {
exports.create = function(options, strategies, callback) {
var defaultStrategy = {
signXml: SignXml.fromSignXmlOptions(Object.assign({
xpathToNodeBeforeSignature: "//*[local-name(.)='AuthenticationStatement']",
signatureIdAttribute: 'AssertionID'
}, options)),
encryptXml: EncryptXml.fromEncryptXmlOptions(options)
}, callback);
}

if (typeof strategies === 'function' && callback == null) {
callback = strategies
strategies = defaultStrategy
} else {
strategies = strategies || defaultStrategy
}

return createAssertion(extractSaml11Options(options), strategies, callback);
}

/**
Expand Down Expand Up @@ -177,9 +194,19 @@ function createAssertion(options, strategies, callback) {
nameIDs[1].setAttribute('Format', options.nameIdentifierFormat);
}

if (callback) {
signAndEncryptAsync(doc, strategies, options, callback)
} else {
return signAndEncryptSync(doc, strategies)
}
}

function signAndEncryptAsync(doc, strategies, options, callback) {
if (strategies.encryptXml === EncryptXml.unencrypted) {
var signed = strategies.signXml(doc);
return strategies.encryptXml(signed, callback);
strategies.signXml(doc, function(err, signed){
strategies.encryptXml(signed, callback);
});
return
}

// encryption is turned on,
Expand All @@ -206,6 +233,13 @@ function createAssertion(options, strategies, callback) {
});
}

function signAndEncryptSync(doc, strategies) {
if (strategies.encryptXml === EncryptXml.unencrypted) {
var signed = strategies.signXml(doc);
return strategies.encryptXml(signed);
}
}

function addSubjectConfirmation(encryptOptions, doc, randomBytes, callback) {
xmlenc.encryptKeyInfo(randomBytes, encryptOptions, function(err, keyinfo) {
if (err) return callback(err);
Expand Down
69 changes: 55 additions & 14 deletions lib/saml20.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,17 +96,34 @@ function extractSaml20Options(opts) {
* @param [options.encryptionAlgorithm] {string}
* @param [options.keyEncryptionAlgorithm] {string}
*
* @param [strategies]
*
* // Signing strategy
* @param {Function} [strategies.signXml]
*
* // Encryption strategy
* @param {Function} [strategies.encryptXml]
*
* @param {Function} [callback] required if encrypting
* @return {*}
*/
exports.create = function createSignedAssertion(options, callback) {
return createAssertion(extractSaml20Options(options), {
exports.create = function createSignedAssertion(options, strategies, callback) {
var defaultStrategy = {
signXml: SignXml.fromSignXmlOptions(Object.assign({
xpathToNodeBeforeSignature: "//*[local-name(.)='Issuer']",
signatureIdAttribute: 'ID'
}, options)),
encryptXml: EncryptXml.fromEncryptXmlOptions(options)
}, callback);
}

if (typeof strategies === 'function' && callback == null) {
callback = strategies
strategies = defaultStrategy
} else {
strategies = strategies || defaultStrategy
}

return createAssertion(extractSaml20Options(options), strategies, callback);
};

/**
Expand Down Expand Up @@ -251,6 +268,40 @@ function createAssertion(options, strategies, callback) {
authnCtxClassRef.textContent = options.authnContextClassRef;
}

if (callback) {
signAndEncryptAsync(doc, strategies, callback)
} else {
return signAndEncryptSync(doc, strategies)
}
}

function signAndEncryptAsync(doc, strategies, callback) {
try {
strategies.signXml(doc, function(err, signed){
if (err || !signed) {
return utils.reportError(err, callback);
}

if (strategies.encryptXml === EncryptXml.unencrypted) {
return strategies.encryptXml(signed, callback);
}

async.waterfall([
function (cb) {
strategies.encryptXml(signed, cb)
},
function (encrypted, cb) {
var assertion = '<saml:EncryptedAssertion xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion">' + encrypted + '</saml:EncryptedAssertion>';
cb(null, utils.removeWhitespace(assertion));
},
], callback);
});
} catch(err) {
utils.reportError(err, callback);
}
}

function signAndEncryptSync(doc, strategies) {
var signed;
try {
signed = strategies.signXml(doc);
Expand All @@ -259,16 +310,6 @@ function createAssertion(options, strategies, callback) {
}

if (strategies.encryptXml === EncryptXml.unencrypted) {
return strategies.encryptXml(signed, callback);
return strategies.encryptXml(signed);
}

async.waterfall([
function (cb) {
strategies.encryptXml(signed, cb)
},
function (encrypted, cb) {
var assertion = '<saml:EncryptedAssertion xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion">' + encrypted + '</saml:EncryptedAssertion>';
cb(null, utils.removeWhitespace(assertion));
},
], callback);
}
36 changes: 36 additions & 0 deletions test/saml11.tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ var xmlenc = require('xml-encryption');
var utils = require('./utils');
var saml11 = require('../lib/saml11');

var EncryptXml = require('../lib/xml/encrypt');
var SignXml = require('../lib/xml/sign');

describe('saml 1.1', function () {

saml11TestSuite({
Expand Down Expand Up @@ -347,6 +350,39 @@ describe('saml 1.1', function () {
});
});

it('should create a saml 1.1 encrypted assertion using async strategy', function (done) {
var options = {
cert: fs.readFileSync(__dirname + '/test-auth0.pem'),
key: fs.readFileSync(__dirname + '/test-auth0.key'),
encryptionPublicKey: fs.readFileSync(__dirname + '/test-auth0_rsa.pub'),
encryptionCert: fs.readFileSync(__dirname + '/test-auth0.pem')
};

var strategies = {
signXml: SignXml.fromSignXmlOptions(Object.assign({
xpathToNodeBeforeSignature: "//*[local-name(.)='AuthenticationStatement']",
signatureIdAttribute: 'AssertionID'
}, options)),
encryptXml: EncryptXml.fromEncryptXmlOptions(options)
}

var callback = function(err, encrypted) {
if (err) return done(err);

xmlenc.decrypt(encrypted, { key: fs.readFileSync(__dirname + '/test-auth0.key')}, function(err, decrypted) {
if (err) return done(err);
assertSignature(decrypted, options);
done();
});
}

if (createAssertion === 'create'){
saml11[createAssertion](options, strategies, callback);
} else {
saml11[createAssertion](options, callback);
}
});

it('should support holder-of-key suject confirmationmethod', function (done) {
var options = {
cert: fs.readFileSync(__dirname + '/test-auth0.pem'),
Expand Down
36 changes: 36 additions & 0 deletions test/saml20.tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ var xmldom = require('xmldom');
var xmlenc = require('xml-encryption');

var saml = require('../lib/saml20');
var EncryptXml = require('../lib/xml/encrypt');
var SignXml = require('../lib/xml/sign');

describe('saml 2.0', function () {
saml20TestSuite({
Expand Down Expand Up @@ -513,6 +515,40 @@ describe('saml 2.0', function () {
});
});

it('should create a saml 2.0 signed and encrypted assertion with async strategy', function (done) {
var options = {
cert: fs.readFileSync(__dirname + '/test-auth0.pem'),
key: fs.readFileSync(__dirname + '/test-auth0.key'),
encryptionPublicKey: fs.readFileSync(__dirname + '/test-auth0_rsa.pub'),
encryptionCert: fs.readFileSync(__dirname + '/test-auth0.pem')
};

var strategies = {
signXml: SignXml.fromSignXmlOptions(Object.assign({
xpathToNodeBeforeSignature: "//*[local-name(.)='Issuer']",
signatureIdAttribute: 'ID'
}, options)),
encryptXml: EncryptXml.fromEncryptXmlOptions(options)
}

var callback = function(err, encrypted){
if (err) return done(err);
var encryptedData = utils.getEncryptedData(encrypted);

xmlenc.decrypt(encryptedData.toString(), { key: fs.readFileSync(__dirname + '/test-auth0.key') }, function (err, decrypted) {
if (err) return done(err);
assertSignature(decrypted, options);
done();
});
}

if (createAssertion === 'create'){
saml[createAssertion](options, strategies, callback)
} else {
saml[createAssertion](options, callback)
}
});

it('should set attributes', function (done) {
var options = {
cert: fs.readFileSync(__dirname + '/test-auth0.pem'),
Expand Down