Require minimal digest algorithm dependencies.

CHANGELOG.md

@@ -18,14 +18,16 @@ Forge ChangeLog
 - Improve PhantomJS support.
 - Move Bower/bundle support to
   [forge-dist](https://github.com/digitalbazaar/forge-dist).
+- **BREAKING**: Require minimal digest algorithm dependencies from individual
+  modules.
 
 ### Added
 
 - webpack bundler support via `npm run build`:
-  - Builds .js, .min.js, and basic sourcemaps.
-  - Basic build: forge.js.
-  - Build with extra utils and networking support: forge.all.js.
-  - Build WebWorker support: prime.worker.js.
+  - Builds `.js`, `.min.js`, and basic sourcemaps.
+  - Basic build: `forge.js`.
+  - Build with extra utils and networking support: `forge.all.js`.
+  - Build WebWorker support: `prime.worker.js`.
 - Browserify support in package.json.
 - Karma browser testing.
 - `forge.options` field.
@@ -38,6 +40,7 @@ Forge ChangeLog
 - Add pbkdf2 usePureJavaScript test.
 - Add rsa.generateKeyPair async and usePureJavaScript tests.
 - Add .editorconfig support.
+- Add `md.all.js` which includes all digest algorithms.
 
 ### Removed
 
@@ -68,6 +71,13 @@ Forge ChangeLog
   also now in a different directory.
 - (all) The library should now directly support building custom bundles with
   webpack, browserify, or similar.
+- (all) If building a custom bundle ensure the correct dependencies are
+  included. In particular, note there is now a `md.all.js` file to include all
+  digest algorithms. Individual files limit what they include by default to
+  allow smaller custom builds. For instance, `pbdkf2.js` has a `sha1` default
+  but does not include any algorithm files by default. This allows the
+  possibility to include only `sha256` without the overhead of `sha1` and
+  `sha512`.
 
 ### Notes
 

lib/index.js

@@ -15,7 +15,7 @@ require('./des');
 require('./hmac');
 require('./kem');
 require('./log');
-require('./md');
+require('./md.all');
 require('./mgf1');
 require('./pbkdf2');
 require('./pem');

lib/md.all.js

@@ -0,0 +1,13 @@
+/**
+ * Node.js module for all known Forge message digests.
+ *
+ * @author Dave Longley
+ *
+ * Copyright 2011-2017 Digital Bazaar, Inc.
+ */
+module.exports = require('./md');
+
+require('./md5');
+require('./sha1');
+require('./sha256');
+require('./sha512');

lib/md.js

@@ -9,8 +9,3 @@ var forge = require('./forge');
 
 module.exports = forge.md = forge.md || {};
 forge.md.algorithms = forge.md.algorithms || {};
-
-require('./md5');
-require('./sha1');
-require('./sha256');
-require('./sha512');

lib/md5.js

@@ -6,11 +6,10 @@
  * Copyright (c) 2010-2014 Digital Bazaar, Inc.
  */
 var forge = require('./forge');
+require('./md');
 require('./util');
 
 var md5 = module.exports = forge.md5 = forge.md5 || {};
-forge.md = forge.md || {};
-forge.md.algorithms = forge.md.algorithms || {};
 forge.md.md5 = forge.md.algorithms.md5 = md5;
 
 /**

lib/pbe.js

@@ -23,8 +23,8 @@ require('./asn1');
 require('./des');
 require('./md');
 require('./oids');
-require('./pem');
 require('./pbkdf2');
+require('./pem');
 require('./random');
 require('./rc2');
 require('./rsa');
@@ -643,6 +643,9 @@ pki.pbe.generatePkcs12Key = function(password, salt, id, iter, n, md) {
   var j, l;
 
   if(typeof md === 'undefined' || md === null) {
+    if(!('sha1' in forge.md)) {
+      throw new Error('"sha1" hash algorithm unavailable.');
+    }
     md = forge.md.sha1.create();
   }
 
@@ -929,6 +932,9 @@ pki.pbe.getCipherForPKCS12PBE = function(oid, params, password) {
  */
 pki.pbe.opensslDeriveBytes = function(password, salt, dkLen, md) {
   if(typeof md === 'undefined' || md === null) {
+    if(!('md5' in forge.md)) {
+      throw new Error('"md5" hash algorithm unavailable.');
+    }
     md = forge.md.md5.create();
   }
   if(salt === null) {
@@ -983,6 +989,9 @@ function prfAlgorithmToMessageDigest(prfAlgorithm) {
       'hmacWithSHA512'];
     throw error;
   }
+  if(!factory || !(prfAlgorithm in factory)) {
+    throw new Error('Unknown hash algorithm: ' + prfAlgorithm);
+  }
   return factory[prfAlgorithm].create();
 }
 

lib/pbkdf2.js

@@ -77,7 +77,7 @@ module.exports = forge.pbkdf2 = pkcs5.pbkdf2 = function(
 
   if(typeof md === 'undefined' || md === null) {
     // default prf to SHA-1
-    md = forge.md.sha1.create();
+    md = 'sha1';
   }
   if(typeof md === 'string') {
     if(!(md in forge.md.algorithms)) {

lib/prng.js

@@ -10,7 +10,6 @@
  * Copyright (c) 2010-2014 Digital Bazaar, Inc.
  */
 var forge = require('./forge');
-require('./md');
 require('./util');
 
 var _crypto = null;

lib/random.js

@@ -15,7 +15,7 @@
  */
 var forge = require('./forge');
 require('./aes');
-require('./md');
+require('./sha256');
 require('./prng');
 require('./util');
 

lib/sha1.js

@@ -6,11 +6,10 @@
  * Copyright (c) 2010-2015 Digital Bazaar, Inc.
  */
 var forge = require('./forge');
+require('./md');
 require('./util');
 
 var sha1 = module.exports = forge.sha1 = forge.sha1 || {};
-forge.md = forge.md || {};
-forge.md.algorithms = forge.md.algorithms || {};
 forge.md.sha1 = forge.md.algorithms.sha1 = sha1;
 
 /**

lib/sha256.js

@@ -8,11 +8,10 @@
  * Copyright (c) 2010-2015 Digital Bazaar, Inc.
  */
 var forge = require('./forge');
+require('./md');
 require('./util');
 
 var sha256 = module.exports = forge.sha256 = forge.sha256 || {};
-forge.md = forge.md || {};
-forge.md.algorithms = forge.md.algorithms || {};
 forge.md.sha256 = forge.md.algorithms.sha256 = sha256;
 
 /**

lib/sha512.js

@@ -11,11 +11,10 @@
  * Copyright (c) 2014-2015 Digital Bazaar, Inc.
  */
 var forge = require('./forge');
+require('./md');
 require('./util');
 
 var sha512 = module.exports = forge.sha512 = forge.sha512 || {};
-forge.md = forge.md || {};
-forge.md.algorithms = forge.md.algorithms || {};
 
 // SHA-512
 forge.md.sha512 = forge.md.algorithms.sha512 = sha512;

lib/tls.js

@@ -233,10 +233,11 @@
 var forge = require('./forge');
 require('./asn1');
 require('./hmac');
-require('./md');
+require('./md5');
 require('./pem');
 require('./pki');
 require('./random');
+require('./sha1');
 require('./util');
 
 /**

tests/unit/kem.js

@@ -1,6 +1,6 @@
 var ASSERT = require('assert');
 var KEM = require('../../lib/kem');
-var MD = require('../../lib/md');
+var MD = require('../../lib/md.all');
 var RSA = require('../../lib/rsa');
 var UTIL = require('../../lib/util');
 var JSBN = require('../../lib/jsbn');

tests/unit/mgf1.js

@@ -1,6 +1,6 @@
 var ASSERT = require('assert');
+var MD = require('../../lib/md.all');
 var MGF = require('../../lib/mgf');
-var MD = require('../../lib/md');
 var UTIL = require('../../lib/util');
 
 (function() {

tests/unit/pbkdf2.js

@@ -1,7 +1,7 @@
 var ASSERT = require('assert');
 var FORGE = require('../../lib/forge');
+var MD = require('../../lib/md.all');
 var PBKDF2 = require('../../lib/pbkdf2');
-var MD = require('../../lib/md');
 var UTIL = require('../../lib/util');
 
 (function() {

tests/unit/pkcs1.js

@@ -1,8 +1,8 @@
 var ASSERT = require('assert');
-var PKI = require('../../lib/pki');
-var PKCS1 = require('../../lib/pkcs1');
-var MD = require('../../lib/md');
 var JSBN = require('../../lib/jsbn');
+var MD = require('../../lib/md.all');
+var PKCS1 = require('../../lib/pkcs1');
+var PKI = require('../../lib/pki');
 var UTIL = require('../../lib/util');
 
 (function() {

tests/unit/rsa.js

@@ -1,11 +1,11 @@
 var ASSERT = require('assert');
 var FORGE = require('../../lib/forge');
-var PKI = require('../../lib/pki');
-var RSA = require('../../lib/rsa');
-var MD = require('../../lib/md');
+var MD = require('../../lib/md.all');
 var MGF = require('../../lib/mgf');
+var PKI = require('../../lib/pki');
 var PSS = require('../../lib/pss');
 var RANDOM = require('../../lib/random');
+var RSA = require('../../lib/rsa');
 var UTIL = require('../../lib/util');
 
 (function() {

tests/unit/x509.js

@@ -1,6 +1,6 @@
 var ASSERT = require('assert');
+var MD = require('../../lib/md.all');
 var PKI = require('../../lib/pki');
-var MD = require('../../lib/md');
 var UTIL = require('../../lib/util');
 
 (function() {

webpack.config.js

@@ -31,15 +31,33 @@ const outputs = [
     library: null,
     libraryTarget: null
   }
-  // custom builds can be created by specifying the high level files you need
-  // webpack will pull in dependencies as needed
-  // Note: if using UMD or similar, add forge.js *last* to properly export
+  // Custom builds can be created by specifying the high level files you need
+  // webpack will pull in dependencies as needed.
+  //
+  // Note: Some modules, such as pbkdf2, may require explicitly listing other
+  // modules they require, such as sha1 or sha256. This is to allow smaller
+  // builds when you don't require a default dependency.
+  //
+  // Note: If using UMD or similar, add forge.js *last* to properly export
   // the top level forge namespace.
+  //
+  // Example: sha1 + ...
   //{
   //  entry: ['./lib/sha1.js', ..., './lib/forge.js'],
   //  filenameBase: 'forge.custom'
   //  libraryTarget: 'umd'
   //}
+  // Example: PBKDF2 + sha1, explicitly include sha1 default
+  //{
+  //  entry: ['./lib/pbkdf2.js', './lib/sha1.js', './lib/forge.js'],
+  //  filenameBase: 'forge.pbkdf2-sha1'
+  //  libraryTarget: 'umd'
+  // Example: PBKDF2 + sha256, without the sha1 default
+  //{
+  //  entry: ['./lib/pbkdf2.js', './lib/sha256.js', './lib/forge.js'],
+  //  filenameBase: 'forge.pbkdf2-sha256'
+  //  libraryTarget: 'umd'
+  //}
 ];
 
 outputs.forEach((info) => {