vault-tree 0.3.4 → 0.6.0

data/features/keywords/master_passphrase.feature

@@ -1,68 +0,0 @@
-Feature: Master Passphrase
-
-```javascript
-"lock_with": "MASTER_PASSPHRASE",
-"unlock_with": "MASTER_PASSPHRASE"
-```
-
-The master password can be thought of as the secure password for the system that is executing the contract. It should never be shared or transfered between parties.
-
-Vault Tree prevents this value from ever being stored within a vault. If you attempt to store the master password within a vault, an exception will be thrown.
-
-As a best practice you should minimize the number of vaults that are locked or
-unlocked with your master password. Specifically, consider randomly generating a
-contract secret and then locking it with your master password. Then you can lock
-other vaults with this randomly generated ephemeral secret when you want store
-confidential contract data.
-
-Scenario: Close And Open With Master Password
-  Given the blank contract:
-    """javascript
-      {
-        "header": {},
-        "vaults": {
-          "random_vault_key":{
-            "description":"Random Number",
-            "fill_with": "RANDOM_NUMBER",
-            "lock_with": "MASTER_PASSPHRASE",
-            "unlock_with": "MASTER_PASSPHRASE",
-            "contents": ""
-            },
-          "message":{
-            "description": "Simple Congratulations Message",
-            "fill_with": "EXTERNAL_DATA",
-            "lock_with": "KEY['random_vault_key']",
-            "unlock_with": "KEY['random_vault_key']",
-            "contents": ""
-          }
-        }
-      }
-    """
-  When I lock a message in a vault with my Master Password
-  Then I can recover the message with my Master Password
-
-Scenario: Missing Passphrase
-  Given the blank contract:
-    """javascript
-      {
-        "header": {},
-        "vaults": {
-          "random_vault_key":{
-            "description":"Random Number",
-            "fill_with": "RANDOM_NUMBER",
-            "lock_with": "MASTER_PASSPHRASE",
-            "unlock_with": "MASTER_PASSPHRASE",
-            "contents": ""
-            },
-          "message":{
-            "description": "Simple Congratulations Message",
-            "fill_with": "EXTERNAL_DATA",
-            "lock_with": "KEY['random_vault_key']",
-            "unlock_with": "KEY['random_vault_key']",
-            "contents": ""
-          }
-        }
-      }
-    """
-  When I attempt fill a vault without providing a master passphrase
-  Then a MissingPassphrase exception is raised

data/features/manipulating_contracts.md

@@ -1,84 +0,0 @@
-Contracts are a central part of the [Vault Tree Project]. Here is what you
-need to know:
-
-* A Vault Tree Contract is simply a [JSON] text file
-* Every contract is composed of two parts:
-  - The **Header** section, which includes helpful meta data
-  - The **Vaults** section, which can be any collection of _vaults_ that form the
-    contract.
-* The way in which you, the contract author, organize the vaults will determine the **Self-Enforcing Terms** of your contract.
-* Each vault will typically contain either an **external data** string that is provided by one of the contract
-  participants, or a key to anther vault.
-
-### Writing and Simulating Contracts
-
-If you've made it to this far, then you're ready to build some stuff. You're
-thinking to yourself:
-
-* For my Vault Tree Contract to be useful it probably needs to involve more than one person.
-* I think I can write a contract, but I really need a way to test it out and think through all the different scenarios.
-* When my final contract is complete it might involve network calls to pass it
-  between parties, queries the Bitcoin Block Chain, or some other crazy step involving the outside world.
-
-What I really need is a way to **Simulate** how the contract will be used in real life ...
-
-Enter [Cucumber].
-
-[Cucumber]: https://github.com/cucumber/cucumber
-
-Cucumber is a tool designed to test complicated full stack web applications. However, we are going to use it for a slightly different purpose.
-
-Take a look at this simple example:
-
-```Gherkin
-Scenario: Alice and Bob Execute the One Two Three Contract
-  Given Alice has the blank contract
-  When she locks all of her attributes
-  And she sends the contract to Bob
-  Then Bob can access all of her public attributes
-  When Bob locks his attributes
-  And He fills and locks each of the three main vaults
-  Then Alice can execute the contract to recover the final message
-```
-
-Great. So we wrote down how the contract is used in some funny looking format  ... so what.
-
-Well, what if we associate each one of these steps in the scenario with some simple Ruby code that interacts with the Vault Tree API. Here are the first three step definitions:
-
-```Ruby
-# This file: "features/core/one_two_three/one_two_three.steps.rb"
-# Associated Contract: "core/one_two_three.0.7.0.json"
-
-Given(/^Alice has the blank contract$/) do
-  contract_path = VaultTree::ContractsRepo::PathHelpers.core_contracts('one_two_three.0.7.0.json')
-  @contract_json = File.read(contract_path)
-end
-
-When(/^she locks all of her attributes$/) do
-  @contract = VaultTree::Contract.new(@contract_json, master_passphrase: 'ALICE_SECURE_PASS', external_data: {})
-  @contract = @contract.close_vault('alice_decryption_key')
-  @contract = @contract.close_vault('alice_public_encryption_key')
-end
-
-When(/^she sends the contract to Bob$/) do
-  @contract_json = @contract.as_json
-  @bobs_external_data = {"congratulations_message" => "CONGRATS! YOU OPENED THE THIRD VAULT."}
-  @contract = VaultTree::Contract.new(@contract_json, master_passphrase: 'BOB_SECURE_PASS', external_data: @bobs_external_data)
-end
-```
-
-Not only can we easily run the contract throught the library to test that it
-works, we have a straight forward mechanism for simulating otherwise complicated
-steps like sending the JSON representation of the contact _over the wire_.
-
-Some items to keep in mind when you run Cucumber scenarios:
-
-* Run `rake` instead of `cucumber` when in the VM `/vagrant` dir
-* This will:
-  - Take care of the wierd cucumber configuration flags needed to handle the unconventional directory structure.
-  - Execute all cucumber scenarios associated with contracts in the `/core` directory
-
-[JSON]: http://www.json.org 
-[Vault Tree Homepage]: http://www.vault-tree.org
-[Vault Tree Project]: http://www.vault-tree.org
-

data/features/support/contract_fixtures/asymmetric_vault.0.1.0.json

@@ -1,69 +0,0 @@
-{
-"header": {
-
-"title":"Asymmetric Vault",
-"description":"Demonstrated use of a Vault Tree Asymmetric Vault",
-"template_url":"https://github.com/VaultTree/contracts/blob/master/core/asymmetric_vault.0.1.0.json",
-"contributers":"Andrew Bashelor"
-},
-"vaults": {
-
-"bob_contract_secret":{
-  "description":"Contract specific password to lock private information",
-  "fill_with": "RANDOM_NUMBER",
-  "lock_with": "MASTER_PASSPHRASE",
-  "unlock_with": "MASTER_PASSPHRASE",
-  "contents": ""
-},
-
-"alice_contract_secret":{
-  "description":"Contract specific password to lock private information",
-  "fill_with": "RANDOM_NUMBER",
-  "lock_with": "MASTER_PASSPHRASE",
-  "unlock_with": "MASTER_PASSPHRASE",
-  "contents": ""
-},
-
-"alice_public_encryption_key":{
-  "description":"Public key for asymmetric encryption",
-  "fill_with": "PUBLIC_ENCRYPTION_KEY['alice_decryption_key']",
-  "lock_with": "UNLOCKED",
-  "unlock_with": "UNLOCKED",
-  "contents": ""
-},
-
-"bob_public_encryption_key":{
-  "description":"Public key for asymmetric encryption",
-  "fill_with": "PUBLIC_ENCRYPTION_KEY['bob_decryption_key']",
-  "lock_with": "UNLOCKED",
-  "unlock_with": "UNLOCKED",
-  "contents": ""
-},
-
-"alice_decryption_key":{
-  "description":"Private key for asymmetric decryption",
-  "fill_with": "DECRYPTION_KEY",
-  "lock_with": "KEY['alice_contract_secret']",
-  "unlock_with": "KEY['alice_contract_secret']",
-  "contents": ""
-},
-
-"bob_decryption_key":{
-  "description":"Private key for asymmetric decryption",
-  "fill_with": "DECRYPTION_KEY",
-  "lock_with": "KEY['bob_contract_secret']",
-  "unlock_with": "KEY['bob_contract_secret']",
-  "contents": ""
-},
-
-"message":{
-  "description":"This is an asymmetric vault. It contains a secret message.",
-  "fill_with": "EXTERNAL_DATA",
-  "lock_with": "DH_KEY['alice_public_encryption_key','bob_decryption_key']",
-  "unlock_with": "DH_KEY['bob_public_encryption_key','alice_decryption_key']",
-  "contents": ""
-}
-
-
-}
-}

data/features/support/contract_fixtures/blank_simple_test_contract.json

@@ -1,14 +0,0 @@
-{
-"header": {},
-"vaults": {
-
-"simple_message":{
-  "owner": "tester",
-  "fill_with": "EXTERNAL_DATA",
-  "lock_with": "MASTER_PASSPHRASE",
-  "unlock_with": "MASTER_PASSPHRASE",
-  "contents": ""
-}
-
-}
-}

data/features/support/contract_fixtures/block_chain_key_transfer.0.1.0.json

@@ -1,59 +0,0 @@
-{
-"header": {
-  "title":"Block Chain Key Transfer",
-  "description":"A simple key transfer sheme utilizing a revealed BTC Wallet Address. This can be used as step within the execution of a larger contract.",
-  "template_url":"https://github.com/VaultTree/contracts/blob/master/contracts/block_chain_key_transfer.0.1.0.json",
-  "contributer":"Andrew Bashelor"
-},
-"vaults": {
-
-"sender_btc_signing_key":{
-  "description":"This is the secret Bitcoin Signing Key that SENDER wishes to transfer to RECEIVER. The RECEIVER can unlock only after he has the revealed address.",
-  "fill_with": "EXTERNAL_DATA",
-  "lock_with": "KEY['sender_concealed_destination_wallet_address']",
-  "unlock_with": "KEY['receiver_revealed_destination_wallet_address']",
-  "contents": ""
-},
-
-"sender_origin_wallet_address":{
-  "description":"SENDER origin wallet address. Chosen by SENDER and known in advance to RECEIVER.",
-  "fill_with": "EXTERNAL_DATA",
-  "lock_with": "UNLOCKED",
-  "unlock_with": "UNLOCKED",
-  "contents": ""
-},
-
-"sender_concealed_destination_wallet_address":{
-  "description":"SENDER concealed copy of the destination wallet address. This wallet address is kept secret until SENDER chosed to transfer BTC to it",
-  "fill_with": "EXTERNAL_DATA",
-  "lock_with": "KEY['sender_secret']",
-  "unlock_with": "KEY['sender_secret']",
-  "contents": ""
-},
-
-"receiver_revealed_destination_wallet_address":{
-  "description":"RECEIVER monitors the Block Chain and fills this vault with the newly revealied destination address.",
-  "fill_with": "EXTERNAL_DATA",
-  "lock_with": "KEY['receiver_secret']",
-  "unlock_with": "KEY['receiver_secret']",
-  "contents": ""
-},
-
-"receiver_secret":{
-  "fill_with": "RANDOM_NUMBER",
-  "lock_with": "MASTER_PASSPHRASE",
-  "unlock_with": "MASTER_PASSPHRASE",
-  "contents": ""
-},
-
-"sender_secret":{
-  "description":"Contract specific password for SENDER. Used to Lock the SENDER private information.",
-  "fill_with": "RANDOM_NUMBER",
-  "lock_with": "MASTER_PASSPHRASE",
-  "unlock_with": "MASTER_PASSPHRASE",
-  "contents": ""
-}
-
-
-}
-}

data/features/support/contract_fixtures/broken_contract.json

@@ -1,55 +0,0 @@
-{
-"header": {
-
-"title":"Broken Contract",
-"summary":"This is a test fixture for ensuring proper exception handling. These are examples of what NOT to do.",
-"contributers":"Andrew Bashelor"
-},
-"vaults": {
-
-"empty_vault":{
-  "fill_with": "RANDOM_NUMBER",
-  "lock_with": "MASTER_PASSPHRASE",
-  "unlock_with": "MASTER_PASSPHRASE",
-  "contents": ""
-},
-
-"unsupported_keyword":{
-  "fill_with": "UNSUPPORTED_KEYWORD",
-  "lock_with": "UNLOCKED",
-  "unlock_with": "UNLOCKED",
-  "contents": ""
-},
-
-"fill_with_master_pass_vault":{
-  "fill_with": "MASTER_PASSPHRASE",
-  "lock_with": "UNLOCKED",
-  "unlock_with": "UNLOCKED",
-  "contents": ""
-},
-
-"missing_external_data_vault":{
-  "fill_with": "EXTERNAL_DATA",
-  "lock_with": "UNLOCKED",
-  "unlock_with": "UNLOCKED",
-  "contents": ""
-},
-
-"empty_decryption_key":{
-  "description": "Leave this empty.",
-  "fill_with": "DECRYPTION_KEY",
-  "lock_with": "UNLOCKED",
-  "unlock_with": "UNLOCKED",
-  "contents": ""
-},
-
-"orphaned_public_key":{
-  "description": "Attempt to establish a public key with first building a decryption key",
-  "fill_with": "PUBLIC_ENCRYPTION_KEY['empty_decryption_key']",
-  "lock_with": "UNLOCKED",
-  "unlock_with": "UNLOCKED",
-  "contents": ""
-}
-
-}
-}

data/features/support/contract_fixtures/one_two_three.0.7.0.json

@@ -1,108 +0,0 @@
-{
-"header": {
-
-"title":"One Two Three",
-"description":"A simple contract to test the full Vault Tree stack. Open each vault to proceed to the next one. Unlock the congratulations message",
-"template_url":"https://github.com/VaultTree/contracts/blob/master/contracts/one_two_three.0.7.0.json",
-"contributers":"Andrew Bashelor"
-},
-"vaults": {
-
-"bob_contract_secret":{
-  "description":"contract specific password to lock private information",
-  "fill_with": "RANDOM_NUMBER",
-  "lock_with": "MASTER_PASSPHRASE",
-  "unlock_with": "MASTER_PASSPHRASE",
-  "contents": ""
-},
-
-"alice_contract_secret":{
-  "description":"contract specific password to lock private information",
-  "fill_with": "RANDOM_NUMBER",
-  "lock_with": "MASTER_PASSPHRASE",
-  "unlock_with": "MASTER_PASSPHRASE",
-  "contents": ""
-},
-
-"alice_public_encryption_key":{
-  "description":"public key for asymmetric encryption",
-  "fill_with": "PUBLIC_ENCRYPTION_KEY['alice_decryption_key']",
-  "lock_with": "UNLOCKED",
-  "unlock_with": "UNLOCKED",
-  "contents": ""
-},
-
-"bob_public_encryption_key":{
-  "description":"public key for asymmetric encryption",
-  "fill_with": "PUBLIC_ENCRYPTION_KEY['bob_decryption_key']",
-  "lock_with": "UNLOCKED",
-  "unlock_with": "UNLOCKED",
-  "contents": ""
-},
-
-"alice_decryption_key":{
-  "description":"private key for asymmetric decryption",
-  "fill_with": "DECRYPTION_KEY",
-  "lock_with": "KEY['alice_contract_secret']",
-  "unlock_with": "KEY['alice_contract_secret']",
-  "contents": ""
-},
-
-"bob_decryption_key":{
-  "description":"private key for asymmetric decryption",
-  "fill_with": "DECRYPTION_KEY",
-  "lock_with": "KEY['bob_contract_secret']",
-  "unlock_with": "KEY['bob_contract_secret']",
-  "contents": ""
-},
-
-"congratulations_message":{
-  "description":"A simple message for Bob to put in the final vault",
-  "fill_with": "EXTERNAL_DATA",
-  "lock_with": "KEY['bob_contract_secret']",
-  "unlock_with": "KEY['bob_contract_secret']",
-  "contents": ""
-},
-
-"vault_two_key":{
-  "description":"Key to lock vault two. Once Bob locks the second vault he will put this key inside vault one.",
-  "fill_with": "RANDOM_NUMBER",
-  "lock_with": "KEY['bob_contract_secret']",
-  "unlock_with": "KEY['bob_contract_secret']",
-  "contents": ""
-},
-
-"vault_three_key":{
-  "description":"Key to lock vault three. Once Bob locks the third vault he will put this key inside vault two.",
-  "fill_with": "RANDOM_NUMBER",
-  "lock_with": "KEY['bob_contract_secret']",
-  "unlock_with": "KEY['bob_contract_secret']",
-  "contents": ""
-},
-
-"first":{
-  "description":"This is an asymmetric vault with mutual authentication. It contains the key to vault two and is locked by Bob, with Alices public key. Only Alice can unlock it.",
-  "fill_with": "KEY['vault_two_key']",
-  "lock_with": "DH_KEY['alice_public_encryption_key','bob_decryption_key']",
-  "unlock_with": "DH_KEY['bob_public_encryption_key','alice_decryption_key']",
-  "contents": ""
-},
-
-"second":{
-  "description":"Alice unlocks this vault with the key held in the first vault.",
-  "fill_with": "KEY['vault_three_key']",
-  "lock_with": "KEY['vault_two_key']",
-  "unlock_with": "KEY['first']",
-  "contents": ""
-},
-
-"third":{
-  "description":"Contains a simple message. Unlock the key found in the second vault.",
-  "fill_with": "KEY['congratulations_message']",
-  "lock_with": "KEY['vault_three_key']",
-  "unlock_with": "KEY['second']",
-  "contents": ""
-}
-
-}
-}