Merge pull request #2145 from MetaMask/ConfigurableEncryption

Configurable encryption

app/scripts/keyring-controller.js

@@ -36,7 +36,7 @@ class KeyringController extends EventEmitter {
       identities: {},
     })
     this.ethStore = opts.ethStore
-    this.encryptor = encryptor
+    this.encryptor = opts.encryptor || encryptor
     this.keyrings = []
     this.getNetwork = opts.getNetwork
   }

app/scripts/metamask-controller.js

@@ -95,6 +95,7 @@ module.exports = class MetamaskController extends EventEmitter {
       initState: initState.KeyringController,
       ethStore: this.ethStore,
       getNetwork: this.networkController.getNetworkState.bind(this.networkController),
+      encryptor: opts.encryptor || undefined,
     })
     this.keyringController.on('newAccount', (address) => {
       this.preferencesController.setSelectedAddress(address)
@@ -674,4 +675,4 @@ module.exports = class MetamaskController extends EventEmitter {
       return Promise.resolve(rpcTarget)
     })
   }
-}
+}

docs/porting_to_new_environment.md

@@ -6,10 +6,37 @@ MetaMask has been under continuous development for nearly two years now, and we
 
 The core functionality of MetaMask all lives in what we call [The MetaMask Controller](https://github.com/MetaMask/metamask-extension/blob/master/app/scripts/metamask-controller.js). Our goal for this file is for it to eventually be its own javascript module that can be imported into any JS-compatible context, allowing it to fully manage an app's relationship to Ethereum.
 
-The MM Controller exposes most of its functionality via two methods:
+#### Constructor
 
-- [metamask.getState()](https://github.com/MetaMask/metamask-extension/blob/master/app/scripts/metamask-controller.js#L241) - This method returns a javascript object representing the current MetaMask state. This includes things like known accounts, sent transactions, current exchange rates, and more! The controller is also an event emitter, so you can subscribe to state updates via `metamask.on('update', handleStateUpdate)`. State examples available [here](https://github.com/MetaMask/metamask-extension/tree/master/development/states) under the `metamask` key. (Warning: some are outdated)
-- [metamask.getApi()](https://github.com/MetaMask/metamask-extension/blob/master/app/scripts/metamask-controller.js#L274-L335) - Returns a JavaScript object filled with callback functions representing every operation our user interface ever performs. Everything from creating new accounts, changing the current network, to sending a transaction, is provided via these API methods. We export this external API on an object because it allows us to easily expose this API over a port using [dnode](https://www.npmjs.com/package/dnode), which is how our WebExtension's UI works!
+When calling `new MetaMask(opts)`, many platform-specific options are configured. The keys on `opts` are as follows:
+
+- initState: The last emitted state, used for restoring persistent state between sessions.
+- platform: The `platform` object defines a variety of platform-specific functions, including opening the confirmation view, and opening web sites.
+- encryptor - An object that provides access to the desired encryption methods.
+
+##### Encryptor
+
+An object that provides two simple methods, which can encrypt in any format you prefer. This parameter is optional, and will default to the browser-native WebCrypto API.
+
+- encrypt(password, object) - returns a Promise of a string that is ready for storage.
+- decrypt(password, encryptedString) - Accepts the encrypted output of `encrypt` and returns a Promise of a restored `object` as it was encrypted.
+
+
+##### Platform Options
+
+The `platform` object has a variety of options:
+
+- reload (function) - Will be called when MetaMask would like to reload its own context.
+- openWindow ({ url }) - Will be called when MetaMask would like to open a web page. It will be passed a single `options` object with a `url` key, with a string value.
+- getVersion() - Should return the current MetaMask version, as described in the current `CHANGELOG.md` or `app/manifest.json`.
+
+#### [metamask.getState()](https://github.com/MetaMask/metamask-extension/blob/master/app/scripts/metamask-controller.js#L241)
+
+This method returns a javascript object representing the current MetaMask state. This includes things like known accounts, sent transactions, current exchange rates, and more! The controller is also an event emitter, so you can subscribe to state updates via `metamask.on('update', handleStateUpdate)`. State examples available [here](https://github.com/MetaMask/metamask-extension/tree/master/development/states) under the `metamask` key. (Warning: some are outdated)
+
+#### [metamask.getApi()](https://github.com/MetaMask/metamask-extension/blob/master/app/scripts/metamask-controller.js#L274-L335)
+
+Returns a JavaScript object filled with callback functions representing every operation our user interface ever performs. Everything from creating new accounts, changing the current network, to sending a transaction, is provided via these API methods. We export this external API on an object because it allows us to easily expose this API over a port using [dnode](https://www.npmjs.com/package/dnode), which is how our WebExtension's UI works!
 
 ### The UI
 
@@ -62,4 +89,4 @@ If streams seem new and confusing to you, that's ok, they can seem strange at fi
 
 ## Conclusion
 
-I hope this has been helpful to you! If you have any other questionsm, or points you think need clarification in this guide, please [open an issue on our GitHub](https://github.com/MetaMask/metamask-plugin/issues/new)!
+I hope this has been helpful to you! If you have any other questionsm, or points you think need clarification in this guide, please [open an issue on our GitHub](https://github.com/MetaMask/metamask-plugin/issues/new)!

package.json

@@ -129,7 +129,7 @@
     "redux": "^3.0.5",
     "redux-logger": "^3.0.6",
     "redux-thunk": "^2.2.0",
-    "request-promise": "^4.1.1",
+    "request-promise": "^4.2.1",
     "sandwich-expando": "^1.0.5",
     "semaphore": "^1.0.5",
     "sw-stream": "^2.0.0",

test/unit/keyring-controller-test.js

@@ -27,12 +27,9 @@ describe('KeyringController', function () {
       ethStore: {
         addAccount (acct) { accounts.push(ethUtil.addHexPrefix(acct)) },
       },
+      encryptor: mockEncryptor,
     })
 
-    // Stub out the browser crypto for a mock encryptor.
-    // Browser crypto is tested in the integration test suite.
-    keyringController.encryptor = mockEncryptor
-
     keyringController.createNewVaultAndKeychain(password)
     .then(function (newState) {
       newState