vault-tree 0.1.0 → 0.3.3

data/features/steps/exceptions.steps.rb

@@ -6,7 +6,7 @@ end
 When(/^I attempt fill a vault without providing a master passphrase$/) do
   begin
     @contract = VaultTree::Contract.new(@contract_json)
-    @contract = @contract.close_vault('alice_contract_secret')
+    @contract = @contract.close_vault('message')
   rescue => e
     @exception = e
   end
@@ -16,12 +16,38 @@ Then(/^a MissingPassphrase exception is raised$/) do
   @exception.should be_an_instance_of(VaultTree::Exceptions::MissingPassphrase)
 end
 
+Given(/^this broken contract:$/) do |string|
+  @contract_json = string
+  @contract = VaultTree::Contract.new(@contract_json, master_passphrase: 'TEST_USER', external_data: {})
+end
+
 Given(/^the broken contract$/) do
   contract_path = VaultTree::PathHelpers.broken_contract
   @contract_json = File.read(contract_path)
   @contract = VaultTree::Contract.new(@contract_json, master_passphrase: 'TEST_USER', external_data: {})
 end
 
+When(/^I attempt lock a vault with External Data that does not exists$/) do
+  @contract = VaultTree::Contract.new(@contract_json, master_passphrase: 'TEST_USER', external_data: nil )
+  begin
+    @contract = @contract.close_vault('missing_external_data_vault')
+  rescue => e
+    @exception = e
+  end
+end
+
+When(/^I lock the data away$/) do
+  @contract = VaultTree::Contract.new(@contract_json).close_vault('missing_external_data_vault')
+end
+
+When(/^I attempt to unlock a vault with External Data that does not exists$/) do
+  begin
+    @contract = @contract.retrieve_contents('missing_external_data_vault')
+  rescue => e
+    @exception = e
+  end
+end
+
 When(/^I attempt fill a vault with External Data that does not exists$/) do
   begin
     @contract = @contract.close_vault('missing_external_data_vault')
@@ -101,3 +127,21 @@ end
 Then(/^a MissingPartnerDecryptionKey exception is raised$/) do
   @exception.should be_an_instance_of(VaultTree::Exceptions::MissingPartnerDecryptionKey)
 end
+
+When(/^I lock a vault with External Data and attempt to unlock with the wrong External Data$/) do
+  locking_key = VaultTree::LockSmith.new().generate_secret_key
+  @contract = VaultTree::Contract.new(@contract_json, external_data: {'missing_external_data_vault' => locking_key})
+  @contract = @contract.close_vault('missing_external_data_vault')
+  @contract_json = @contract.as_json
+  begin
+    wrong_unlocking_key = VaultTree::LockSmith.new().generate_secret_key
+    @contract = VaultTree::Contract.new(@contract_json, external_data: {'missing_external_data_vault' => wrong_unlocking_key})
+    @contents = @contract.retrieve_contents('missing_external_data_vault')
+  rescue => e
+    @exception = e
+  end
+end
+
+Then(/^a FailedUnlockAttempt exception is raised$/) do
+  @exception.should be_an_instance_of(VaultTree::Exceptions::FailedUnlockAttempt)
+end

data/features/steps/one_two_three.steps.rb

@@ -0,0 +1,57 @@
+Given(/^Alice has the blank contract$/) do
+  contract_path = VaultTree::PathHelpers.core_contracts('one_two_three.0.7.0.json')
+  @contract_json = File.read(contract_path)
+end
+
+# Change this to just attributes vice public attributes
+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
+
+Then(/^Bob can access all of her public attributes$/) do
+  @contents = @contract.retrieve_contents('alice_public_encryption_key')
+end
+
+When(/^Bob locks his attributes$/) do
+
+  @contract = @contract.close_vault('bob_decryption_key')
+  # Verify can reopen
+  @contract.retrieve_contents('bob_decryption_key')
+
+  @contract = @contract.close_vault('congratulations_message')
+  # Verify can reopen
+  @contract.retrieve_contents('congratulations_message')
+
+  @contract = @contract.close_vault('vault_two_key')
+  # Verify they can reopen
+  @contract.retrieve_contents('vault_two_key')
+
+  @contract = @contract.close_vault('vault_three_key')
+  # Verify they can reopen
+  @contract.retrieve_contents('vault_three_key')
+
+  @contract = @contract.close_vault('bob_public_encryption_key')
+  # Verify they can reopen
+  @contract.retrieve_contents('bob_public_encryption_key')
+end
+
+When(/^He fills and locks each of the three main vaults$/) do
+  @contract = @contract.close_vault('first')
+  @contract = @contract.close_vault('second')
+  @contract = @contract.close_vault('third')
+end
+
+Then(/^Alice can execute the contract to recover the final message$/) do
+  @contract_json = @contract.as_json 
+  @contract = VaultTree::Contract.new(@contract_json, master_passphrase: 'ALICE_SECURE_PASS', external_data: {})
+  puts @contract.retrieve_contents('third')
+  @contract.retrieve_contents('third').should == @bobs_external_data['congratulations_message']
+end

data/features/steps/secret_sharing.steps.rb

@@ -0,0 +1,36 @@
+Given(/^I have a blank secret sharing contract$/) do
+  contract_path = VaultTree::PathHelpers.shared_secret_contract
+  @contract_json = File.read(contract_path)
+  @contract = VaultTree::Contract.new(@contract_json)
+end
+
+Given(/^I create a new message$/) do
+  @external_data = {"message" => "CONGRATS! YOU OPENED THE VAULT WITH AN ASSEMBLED KEY."}
+end
+
+When(/^I lock the message with an assembled key$/) do
+  @contract = VaultTree::Contract.new(@contract_json, external_data: @external_data)
+  @contract = @contract.close_vault('message')
+end
+
+When(/^I attempt to lock the message with a generated shamir key$/) do
+  @contract = VaultTree::Contract.new(@contract_json, external_data: @external_data)
+  @contract = @contract.close_vault('message')
+end
+
+Then(/^key shares are created and locked away in their cooresponding vaults$/) do
+  @contract.vault_closed?('s_1').should be true
+  @contract.vault_closed?('s_2').should be true
+  @contract.vault_closed?('s_3').should be true
+  @contract.vault_closed?('s_4').should be true
+  @contract.vault_closed?('s_5').should be true
+end
+
+When(/^I attempt to unlock the message with the assembled shamir key$/) do
+  @recovered_message = @contract.retrieve_contents('message')
+end
+
+Then(/^I successfully gather the locked shares and unlock the message$/) do
+  puts @recovered_message
+  @recovered_message.should == @external_data["message"]
+end

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

@@ -0,0 +1,69 @@
+{
+"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/block_chain_key_transfer.0.1.0.json

@@ -0,0 +1,59 @@
+{
+"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/one_two_three.0.7.0.json

@@ -0,0 +1,108 @@
+{
+"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": ""
+}
+
+}
+}

data/features/support/contract_fixtures/template.json

@@ -0,0 +1,33 @@
+{
+"header": {
+"title":"",
+"description":""
+},
+"vaults": {
+
+"":{
+  "description":"",
+  "fill_with": "",
+  "lock_with": "",
+  "unlock_with": "",
+  "contents": ""
+},
+
+"":{
+  "description":"",
+  "fill_with": "",
+  "lock_with": "",
+  "unlock_with": "",
+  "contents": ""
+},
+
+"":{
+  "description":"",
+  "fill_with": "",
+  "lock_with": "",
+  "unlock_with": "",
+  "contents": ""
+}
+
+}
+}

data/features/what_is_vault_tree.md

@@ -0,0 +1,18 @@
+Vault Tree is a software framework that makes it easy to author and execute **Distributed Cryptographic Contracts.**
+
+These are sort of like [Smart Contracts], but designed for for web developers building applications against the Bitcoin Block Chain.
+
+[Smart Contracts]: http://en.wikipedia.org/wiki/Smart_contract
+
+## Background
+
+Contracts are fundemental building blocks of our modern economy. They are simply voluntary and structured aggreements between two or more parties.
+
+There are many examples that we are already familiar with from our daily lives such as employment contracts and rental agreements. Also, the sophisticated investment instruments that drive our modern financial system are just examples of standardized contracts.
+
+It's been know for quite a while that well structured contracts can be thought of as a computer programs. If we bring cutting edge [cryptographic libraries], and distributed virtual currencies such as [Bitcoin] into the picture, can we change the way we view the problem of **contract enforcement**?
+
+You can think of Vault Tree as a collection of tools that will help web developers, businesses, and online communities explore a new way of thinking about contracts.
+
+[cryptographic libraries]: http://en.wikipedia.org/wiki/Cryptography
+[Bitcoin]: http://bitcoin.org/en/