Merge pull request #250 from fraVlaca/purgePD

PurgePrivateData

Author: mbwhite

fabric-chaincode-integration-test/src/test/java/org/hyperleder/fabric/shim/integration/contractinstall/ContractInstallTest.java

@@ -3,7 +3,7 @@
 
 SPDX-License-Identifier: Apache-2.0
 */
-package org.hyperleder.fabric.shim.integration.ledgertests;
+package org.hyperleder.fabric.shim.integration.contractinstall;
 import static org.hamcrest.core.StringContains.containsString;
 import static org.junit.Assert.assertThat;
 

fabric-chaincode-shim/build.gradle

@@ -8,7 +8,7 @@
         mavenCentral()
     }
     dependencies {
-        classpath 'org.owasp:dependency-check-gradle:5.3.2'
+        classpath 'org.owasp:dependency-check-gradle:7.1.0.1'
     }
 }
 
@@ -71,6 +71,9 @@ dependencyCheck {
     format='ALL'
     analyzers {
         assemblyEnabled=false
+        ossIndex {
+            enabled=false
+        }
     }
 }
 

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/shim/ChaincodeStub.java

@@ -452,6 +452,25 @@ public interface ChaincodeStub {
      */
     void delPrivateData(String collection, String key);
 
+    /**
+     * Reqauests purging of the specified <code>key</code> to be from
+     * the private data stores.
+     * <p>
+     * Note that only hash of the private writeset goes into the transaction
+     * proposal response (which is sent to the client who issued the transaction)
+     * and the actual private writeset gets temporarily stored in a transient store.
+     * The <code>key</code> and its value will be purged from the collection. This is an
+     * asynchronous activity.
+     * <p>
+     * Purge is a complete removal of the history of the key. There is existing purge
+     * possible mased on block height. This API allows the contract to be pro-active in
+     * requesting data be purged. This can contribute towards meeting privacy requirements.
+     *
+     * @param collection name of the collection
+     * @param key        name of the value to be deleted
+     */
+    void purgePrivateData(String collection, String key);
+
     /**
      * Returns all existing keys, and their values, that are lexicographically
      * between <code>startkey</code> (inclusive) and the <code>endKey</code>

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/shim/impl/ChaincodeMessageFactory.java

@@ -67,6 +67,10 @@ protected static ChaincodeMessage newDeleteStateEventMessage(final String channe
         return newEventMessage(DEL_STATE, channelId, txId, DelState.newBuilder().setCollection(collection).setKey(key).build().toByteString());
     }
 
+    protected static ChaincodeMessage newPurgeStateEventMessage(final String channelId, final String txId, final String collection, final String key) {
+        return newEventMessage(Type.PURGE_PRIVATE_DATA, channelId, txId, DelState.newBuilder().setCollection(collection).setKey(key).build().toByteString());
+    }
+
     protected static ChaincodeMessage newErrorEventMessage(final String channelId, final String txId, final Throwable throwable) {
         return newErrorEventMessage(channelId, txId, printStackTrace(throwable));
     }

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/shim/impl/InvocationStubImpl.java

@@ -511,6 +511,14 @@ public void delPrivateData(final String collection, final String key) {
         this.handler.invoke(msg);
     }
 
+    @Override
+    public void purgePrivateData(final String collection, final String key) {
+        validateCollection(collection);
+        final ChaincodeMessage msg = ChaincodeMessageFactory.newPurgeStateEventMessage(channelId, txId, collection,
+                key);
+        this.handler.invoke(msg);
+    }
+
     @Override
     public QueryResultsIterator<KeyValue> getPrivateDataByRange(final String collection, final String startKey,
             final String endKey) {

fabric-chaincode-shim/src/test/java/org/hyperledger/fabric/contract/ChaincodeStubNaiveImpl.java

@@ -210,6 +210,11 @@ public void delPrivateData(final String collection, final String key) {
 
     }
 
+    @Override
+    public void purgePrivateData(final String collection, final String key) {
+
+    }
+
     @Override
     public QueryResultsIterator<KeyValue> getPrivateDataByRange(final String collection, final String startKey, final String endKey) {
         return null;

fabric-chaincode-shim/src/test/java/org/hyperledger/fabric/shim/ChaincodeStubTest.java

@@ -198,6 +198,12 @@ public void delPrivateData(final String collection, final String key) {
 
         }
 
+        @Override
+        public void purgePrivateData(final String collection, final String key) {
+            // TODO Auto-generated method stub
+
+        }
+
         @Override
         public QueryResultsIterator<KeyValue> getPrivateDataByRange(final String collection, final String startKey, final String endKey) {
             // TODO Auto-generated method stub

fabric-chaincode-shim/src/test/java/org/hyperledger/fabric/shim/mock/peer/PurgeValueStep.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2019 IBM All Rights Reserved.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package org.hyperledger.fabric.shim.mock.peer;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.hyperledger.fabric.protos.peer.ChaincodeMessage;
+
+/**
+ * Simulates purgePrivateData() invocation in chaincode Waits for PURGE_PRIVATE_DATA message from
+ * chaincode and sends back response with empty payload
+ */
+public final class PurgeValueStep implements ScenarioStep {
+
+    private ChaincodeMessage orgMsg;
+
+    @Override
+    public boolean expected(final ChaincodeMessage msg) {
+        orgMsg = msg;
+        return msg.getType() == ChaincodeMessage.Type.PURGE_PRIVATE_DATA;
+    }
+
+    @Override
+    public List<ChaincodeMessage> next() {
+        final List<ChaincodeMessage> list = new ArrayList<>();
+        list.add(ChaincodeMessage.newBuilder()
+                .setType(ChaincodeMessage.Type.RESPONSE)
+                .setChannelId(orgMsg.getChannelId())
+                .setTxid(orgMsg.getTxid())
+                .build());
+        return list;
+    }
+}