v0.1.1

Feat: handle unsual exponent migrate to node-forge

.gitignore

@@ -10,5 +10,4 @@ yarn.lock
 *.pid
 /coverage
 package-lock.json
-*.key
 *.html

.travis.yml

@@ -0,0 +1,7 @@
+language: node_js
+node_js:
+  - "8"
+  - "9"
+  - "10"
+  - "11"
+  - "12"

README.md

@@ -1,5 +1,14 @@
 # node-ebics-client
----
+<p align="center">
+<a href="https://travis-ci.org/eCollect/node-ebics-client" title="Build Status"><img src="https://travis-ci.org/eCollect/node-ebics-client.svg?branch=master" alt="Build Status" /></a>
+<a href="https://www.npmjs.com/package/ebics-client" title="Build Status">
+<img alt="ebics-client" src="https://img.shields.io/npm/v/ebics-client">
+</a>
+<a href="https://snyk.io/test/github/ecollect/node-ebics-client" title="Known Vulnerabilities">
+<img src="https://snyk.io/test/github/ecollect/node-ebics-client/badge.svg" alt="Known Vulnerabilities">
+</a>
+<a href="/eCollect/node-ebics-client/blob/master/LICENSE" title="GPL-3.0"><img alt="GPL-3.0" src="https://img.shields.io/github/license/eCollect/node-ebics-client"></a>
+</p>
 
 Pure node.js ( >=8 ) implementation of [EBICS](https://en.wikipedia.org/wiki/Electronic_Banking_Internet_Communication_Standard) ( Electronic Banking Internet Communication ).
 
@@ -12,6 +21,7 @@ The client is currently tested and verified to work with the following banks:
 * [Credit Suisse (Schweiz) AG](https://www.credit-suisse.com/ch/en.html)
 * [Zürcher Kantonalbank](https://www.zkb.ch/en/lg/ew.html)
 * [Raiffeisen Schweiz](https://www.raiffeisen.ch/rch/de.html)
+* [BW Bank](https://www.bw-bank.de/de/home.html)
 
 
 ## Inspiration
@@ -22,3 +32,5 @@ The basic concept of this library was inspired by the [EPICS](https://github.com
 ## Copyright
 
 Copyright: eCollect AG, 2018-9.  
+Licensed under the [GPLv3](LICENSE) license.
+

lib/BankLetter.js

@@ -13,10 +13,8 @@ const registerHelpers = () => {
 	handlebars.registerHelper('now', () => moment().format('HH:mm:ss'));
 
 	handlebars.registerHelper('keyExponentBits', k => Buffer.byteLength(k.e()) * 8);
-	// handlebars.registerHelper('keyExponentBits', k => Buffer.byteLength(new BN(k.key.keyPair.e).toBuffer()) * 8);
 
-	handlebars.registerHelper('keyModulusBits', k => k.key.getKeySize());
-	// return Buffer.byteLength(new BN(k.key.keyPair.e).toBuffer()) * 8;
+	handlebars.registerHelper('keyModulusBits', k => k.size());
 
 	handlebars.registerHelper('keyExponent', k => k.e('hex'));
 
@@ -24,8 +22,6 @@ const registerHelpers = () => {
 
 	handlebars.registerHelper('sha256', (k) => {
 		const digest = Buffer.from(Crypto.digestPublicKey(k), 'base64').toString('HEX');
-		// const digest = Buffer.from(k.publicDigest(), 'base64').toString('HEX');
-
 		return digest.toUpperCase().match(/.{1,2}/g).join(' ');
 	});
 };

lib/keymanagers/Key.js

@@ -0,0 +1,138 @@
+'use strict';
+
+const {
+	pki: {
+		rsa,
+		publicKeyToPem,
+		privateKeyToPem,
+		publicKeyFromPem,
+		privateKeyFromPem,
+	},
+	jsbn: {
+		BigInteger,
+	},
+} = require('node-forge');
+
+const getKeyType = (str) => {
+	const matches = str.match(/(PRIVATE|PUBLIC) KEY/);
+	if (!matches)
+		return null;
+	return matches[1].toLowerCase();
+};
+
+const keyFromPem = (pem) => {
+	const type = getKeyType(pem);
+	const isPublic = type === 'public';
+	const key = isPublic ? publicKeyFromPem(pem) : privateKeyFromPem(pem);
+
+	return {
+		isPublic,
+		key,
+	};
+};
+
+/**
+ * Creates a public key from modulus and exponent
+ * @param {Buffer} mod - the modulus
+ * @param {Buffer} exp - the exponent
+ */
+const keyFromModAndExp = (mod, exp) => {
+	const bnMod = new BigInteger(mod.toString('hex'), 16);
+	const bnExp = new BigInteger(exp.toString('hex'), 16);
+
+	return {
+		key: rsa.setPublicKey(bnMod, bnExp),
+		isPublic: true,
+	};
+};
+
+module.exports = class Key {
+	constructor({
+		pem = null, mod = null, exp = null, size = 2048,
+	} = {}) {
+		// generate new private key
+		if (!pem && !mod && !exp) {
+			const keyPair = rsa.generateKeyPair(size);
+
+			this.keyIsPublic = false;
+			this.privateKey = keyPair.privateKey;
+			this.publicKey = keyPair.publicKey;
+
+			return;
+		}
+
+		// new key from pem string
+		if (pem) {
+			const { key, isPublic } = keyFromPem(pem);
+
+			this.keyIsPublic = isPublic;
+			this.privateKey = isPublic ? null : key;
+			this.publicKey = isPublic ? key : null;
+
+			return;
+		}
+
+		// new key from mod and exp
+		if (mod && exp) {
+			const { key, isPublic } = keyFromModAndExp(mod, exp);
+
+			this.keyIsPublic = isPublic;
+			this.privateKey = isPublic ? null : key;
+			this.publicKey = isPublic ? key : null;
+
+			return;
+		}
+
+		// not good
+		throw new Error(`Can not create key without ${!mod ? 'modulus' : 'exponent'}.`);
+	}
+
+	static generate(size = 2048) {
+		return new Key({ size });
+	}
+
+	static importKey({ mod, exp }) {
+		return new Key({ mod, exp });
+	}
+
+	n(to = 'buff') {
+		const key = this.keyIsPublic ? this.publicKey : this.privateKey;
+		const keyN = Buffer.from(key.n.toByteArray());
+
+		return to === 'hex' ? keyN.toString('hex', 1) : keyN;
+	}
+
+	e(to = 'buff') {
+		const key = this.keyIsPublic ? this.publicKey : this.privateKey;
+		const eKey = Buffer.from(key.e.toByteArray());
+
+		return to === 'hex' ? eKey.toString('hex') : eKey;
+	}
+
+	d() {
+		if (this.keyIsPublic)
+			throw new Error('Can not get d component out of public key.');
+
+		return Buffer.from(this.privateKey.d.toByteArray());
+	}
+
+	isPrivate() {
+		return !this.keyIsPublic;
+	}
+
+	isPublic() {
+		return this.keyIsPublic;
+	}
+
+	// eslint-disable-next-line class-methods-use-this
+	size() {
+		const keyN = this.n('hex');
+		const bn = new BigInteger(keyN, 16);
+
+		return bn.bitLength();
+	}
+
+	toPem() {
+		return this.keyIsPublic ? publicKeyToPem(this.publicKey) : privateKeyToPem(this.privateKey);
+	}
+};

lib/keymanagers/Keys.js

@@ -1,8 +1,13 @@
 'use strict';
 
-const Key = require('./keyRSA');
+const Key = require('./Key');
 
-const keyOrNull = key => (key ? Key(key) : null);
+const keyOrNull = (key) => {
+	if (key instanceof Key)
+		return key;
+
+	return key ? new Key({ pem: key }) : null;
+};
 
 module.exports = class Keys {
 	constructor({
@@ -25,15 +30,15 @@ module.exports = class Keys {
 		const keys = {};
 
 		Object.keys({ A006: '', X002: '', E002: '' }).forEach((key) => {
-			keys[key] = Key().generate();
+			keys[key] = Key.generate(); // Key().generate();
 		});
 
 		return new Keys(keys);
 	}
 
 	setBankKeys(bankKeys) {
-		this.keys.bankX002 = Key().importKey(bankKeys.bankX002);
-		this.keys.bankE002 = Key().importKey(bankKeys.bankE002);
+		this.keys.bankX002 = new Key(bankKeys.bankX002); // Key().importKey(bankKeys.bankX002);
+		this.keys.bankE002 = new Key(bankKeys.bankE002); // Key().importKey(bankKeys.bankE002);
 	}
 
 	a() {

lib/keymanagers/keyRSA.js

@@ -1,49 +0,0 @@
-'use strict';
-
-const BN = require('bn.js');
-const NodeRSA = require('node-rsa');
-
-const keyOrNull = (encodedKey) => {
-	if (encodedKey === null) return new NodeRSA();
-
-	return (encodedKey instanceof NodeRSA) ? encodedKey : new NodeRSA(encodedKey);
-};
-
-module.exports = encodedKey => ({
-	key: keyOrNull(encodedKey),
-
-	generate(keySize = 2048) {
-		return new NodeRSA({ b: keySize });
-	},
-
-	importKey({ mod, exp }) {
-		this.key = new NodeRSA();
-		this.key.importKey({ n: mod, e: exp }, 'components-public');
-
-		return this;
-	},
-
-	n(to = 'buff') {
-		const keyN = Buffer.from(this.key.exportKey('components-public').n);
-
-		return to === 'hex'
-			? keyN.toString('hex', 1)
-			: keyN;
-	},
-
-	e(to = 'buff') {
-		const eKey = new BN(this.key.exportKey('components-public').e).toBuffer();
-
-		return to === 'hex'
-			? eKey.toString('hex')
-			: eKey;
-	},
-
-	d() {
-		return this.key.keyPair.d.toBuffer();
-	},
-
-	toPem() {
-		return this.key.isPrivate() ? this.key.exportKey('pkcs1-private-pem') : this.key.exportKey('pkcs8-public-pem');
-	},
-});

lib/orders/H004/response.js

@@ -2,7 +2,6 @@
 
 const zlib = require('zlib');
 const crypto = require('crypto');
-const BN = require('bn.js');
 
 const Crypto = require('../../crypto/Crypto');
 
@@ -127,10 +126,12 @@ module.exports = (xml, keys) => ({
 			const modulus = xpath.select(".//*[local-name(.)='Modulus']", keyNodes[i])[0].textContent;
 			const exponent = xpath.select(".//*[local-name(.)='Exponent']", keyNodes[i])[0].textContent;
 
-			const mod = new BN(Buffer.from(modulus, 'base64'), 2).toBuffer();
-			const exp = new BN(Buffer.from(exponent, 'base64')).toNumber();
-
-			bankKeys[`bank${type}`] = { mod, exp };
+			const mod = Buffer.from(modulus, 'base64');
+			const exp = Buffer.from(exponent, 'base64');
+			bankKeys[`bank${type}`] = {
+				mod,
+				exp,
+			};
 		}
 
 		return bankKeys;

package.json

@@ -1,11 +1,11 @@
 {
 	"name": "ebics-client",
-	"version": "0.0.8",
+	"version": "0.1.1",
 	"description": "Node.js ISO 20022 Compliant EBICS Client",
 	"main": "index.js",
 	"scripts": {
 		"lint": "eslint .",
-		"test": "mocha test/*/**.js"
+		"test": "mocha test/**/*.js"
 	},
 	"repository": {
 		"type": "git",
@@ -28,13 +28,13 @@
 			"url": "https://github.com/yagop"
 		}
 	],
-	"license": "MIT",
+	"license": "GPLv3",
 	"dependencies": {
 		"bn.js": "^5.0.0",
 		"handlebars": "^4.4.3",
 		"js2xmlparser": "^4.0.0",
 		"moment": "^2.24.0",
-		"node-rsa": "^1.0.6",
+		"node-forge": "^0.9.1",
 		"request": "^2.88.0",
 		"uuid": "^3.3.3",
 		"xml-crypto": "^1.4.0",

test/fixtures/keys.js

@@ -0,0 +1,43 @@
+'use strict';
+
+const publicSmallExpPEM = '';
+const publicSmallExpMod = '';
+const publicSmallExpExp = '';
+
+const publicBigPEM = `-----BEGIN PUBLIC KEY-----
+MIIBJDANBgkqhkiG9w0BAQEFAAOCAREAMIIBDAKCAQEAuvqhJ2ptulHGUmYq3BOO
+NoIDXOUDrVV3s188wvU3Fj9TcO3yBqWuJ5GMEzRIOfi8Pb4AkJBjjPOR0Taby7+n
+7coa2Zm0ZprGzXVM1Gb0aG3BAbDaFbvdF25NLAtkmtKKW/8YfXy89qvy6+UEBdOa
+1UTLaR+9Pf63Wa+qu638udSDe3refHdZV1bKUR1UOZ/1iWn5b7aq4vITRPNNWXk5
+eG8He2lWzYHg5+yY4ckBooh1K5cMwl5s+Iz24iWtqIlV5EyORbdfGatrNzv6S7Lx
+FngEGCL5e97qU1pAcarE9XmrlJ5dHl9LQPaw957AlZuOFpVEE5shXZkSgRYrHv2m
+cQIFAQAAAA8=
+-----END PUBLIC KEY-----`;
+const publicBigModString = 'ALr6oSdqbbpRxlJmKtwTjjaCA1zlA61Vd7NfPML1NxY/U3Dt8galrieRjBM0SDn4vD2+AJCQY4zzkdE2m8u/p+3KGtmZtGaaxs11TNRm9GhtwQGw2hW73RduTSwLZJrSilv/GH18vPar8uvlBAXTmtVEy2kfvT3+t1mvqrut/LnUg3t63nx3WVdWylEdVDmf9Ylp+W+2quLyE0TzTVl5OXhvB3tpVs2B4OfsmOHJAaKIdSuXDMJebPiM9uIlraiJVeRMjkW3Xxmrazc7+kuy8RZ4BBgi+Xve6lNaQHGqxPV5q5SeXR5fS0D2sPeewJWbjhaVRBObIV2ZEoEWKx79pnE=';
+const publicBigModBytes = [0, 186, 250, 161, 39, 106, 109, 186, 81, 198, 82, 102, 42, 220, 19, 142, 54, 130, 3, 92, 229, 3, 173, 85, 119, 179, 95, 60, 194, 245, 55, 22, 63, 83, 112, 237, 242, 6, 165, 174, 39, 145, 140, 19, 52, 72, 57, 248, 188, 61, 190, 0, 144, 144, 99, 140, 243, 145, 209, 54, 155, 203, 191, 167, 237, 202, 26, 217, 153, 180, 102, 154, 198, 205, 117, 76, 212, 102, 244, 104, 109, 193, 1, 176, 218, 21, 187, 221, 23, 110, 77, 44, 11, 100, 154, 210, 138, 91, 255, 24, 125, 124, 188, 246, 171, 242, 235, 229, 4, 5, 211, 154, 213, 68, 203, 105, 31, 189, 61, 254, 183, 89, 175, 170, 187, 173, 252, 185, 212, 131, 123, 122, 222, 124, 119, 89, 87, 86, 202, 81, 29, 84, 57, 159, 245, 137, 105, 249, 111, 182, 170, 226, 242, 19, 68, 243, 77, 89, 121, 57, 120, 111, 7, 123, 105, 86, 205, 129, 224, 231, 236, 152, 225, 201, 1, 162, 136, 117, 43, 151, 12, 194, 94, 108, 248, 140, 246, 226, 37, 173, 168, 137, 85, 228, 76, 142, 69, 183, 95, 25, 171, 107, 55, 59, 250, 75, 178, 241, 22, 120, 4, 24, 34, 249, 123, 222, 234, 83, 90, 64, 113, 170, 196, 245, 121, 171, 148, 158, 93, 30, 95, 75, 64, 246, 176, 247, 158, 192, 149, 155, 142, 22, 149, 68, 19, 155, 33, 93, 153, 18, 129, 22, 43, 30, 253, 166, 113];
+const publicBigExpString = 'AQAAAA8=';
+const publicBigExpBytes = [1, 0, 0, 0, 15];
+
+
+const pblc = {
+	big: {
+		pem: publicBigPEM,
+		mod: {
+			bytes: publicBigModBytes,
+			string: publicBigModString,
+		},
+		exp: {
+			bytes: publicBigExpBytes,
+			string: publicBigExpString,
+		},
+	},
+	small: {
+		pem: publicSmallExpPEM,
+		mod: publicSmallExpMod,
+		exp: publicSmallExpExp,
+	},
+};
+
+module.exports = {
+	pblc,
+};

test/unit/keys.js

@@ -0,0 +1,92 @@
+'use strict';
+
+/* eslint-env node, mocha */
+
+const { assert } = require('chai');
+const fixtures = require('../fixtures/keys');
+// const Key = require('../lib/keymanagers/keyRSA');
+const Key = require('../../lib/keymanagers/Key');
+
+const stripWhitespace = str => str.replace(/\s+/g, '');
+
+describe('Keys management', () => {
+	describe('generates brand new', () => {
+		const keySize = 2048;
+		// const newKey = Key().generate(keySize);
+		const newKey = Key.generate();
+
+		it('private key', () => {
+			assert.isTrue(newKey.isPrivate());
+		});
+
+		it('that has the right key size', () => {
+			// const newKeySize = newKey.size(); // console.log(newKey.size());
+			assert(newKey.size(), keySize);
+		});
+	});
+
+	describe('creates public key from mod and exp', () => {
+		const { pem, mod, exp } = fixtures.pblc.big;
+
+		describe('that are strings', () => {
+			const m = Buffer.from(mod.string, 'base64');
+			const e = Buffer.from(exp.string, 'base64');
+			/* const newKey = Key().importKey({
+				mod: m, exp: e, modulus: mod.string, exponent: exp.string,
+			}); */
+			const newKey = new Key({ mod: m, exp: e });
+
+			it('and is really public', () => {
+				assert.isTrue(newKey.isPublic());
+			});
+
+
+			it('and has a propper mod in bytes', () => {
+				assert.deepEqual([...newKey.n()], mod.bytes);
+			});
+
+			it('and has a propper pem string', () => {
+				assert.equal(stripWhitespace(newKey.toPem()), stripWhitespace(pem));
+			});
+		});
+
+		describe('that are bytes', () => {
+			const m = Buffer.from(mod.bytes);
+			const e = Buffer.from(exp.bytes);
+			/* const newKey = Key().importKey({
+				mod: m, exp: e, modulus: mod.string, exponent: exp.string,
+			}); */
+			const newKey = new Key({ mod: m, exp: e });
+
+			it('and is really public', () => {
+				assert.isTrue(newKey.isPublic());
+			});
+
+			it('and has a propper mod as a string', () => {
+				assert.equal(newKey.n().toString('base64'), mod.string);
+			});
+
+			it('and has a propper pem string', () => {
+				assert.equal(stripWhitespace(newKey.toPem()), stripWhitespace(pem));
+			});
+		});
+	});
+
+	describe('creates public key from pem string', () => {
+		const { pem } = fixtures.pblc.big;
+		// const newKey = Key(pem);
+		const newKey = new Key({ pem });
+
+		it('and is really public', () => {
+			assert.isTrue(newKey.isPublic());
+		});
+
+		it('and has a propper(the same) pem string', () => {
+			/* newKey.pempem = {
+				modulus: mod.string,
+				exponent: exp.string,
+			}; */
+			assert.equal(stripWhitespace(newKey.toPem()), stripWhitespace(pem));
+		});
+	});
+});

test/unit/responseParser.js

@@ -3,7 +3,7 @@
 /* eslint-env node, mocha */
 
 const { assert } = require('chai');
-const H004Response = require('../lib/orders/H004/response');
+const H004Response = require('../../lib/orders/H004/response');
 
 describe('H004 response parsing', () => {
 	it('parses bank keys', () => {