Change default visibility

The visibility field in the headers is used to control to what extent the
proposal payload will be visibile in the final tx. The default should be full
visibility.

Change-Id: I61f059c2f3ed58b3dab981b009e17e1ec133776c
Signed-off-by: Alessandro Sorniotti <[email protected]>

Author: ale-linux

core/common/validation/msgvalidation.go

@@ -46,9 +46,16 @@ func validateChaincodeProposalMessage(prop *pb.Proposal, hdr *common.Header) (*p
 	// TODO: should we even do this? If so, using which interface?
 
 	//    - ensure that the visibility field has some value we understand
-	// TODO: we need to define visibility fields first
-
-	// TODO: should we check the payload as well?
+	// currently the fabric only supports full visibility: this means that
+	// there are no restrictions on which parts of the proposal payload will
+	// be visible in the final transaction; this default approach requires
+	// no additional instructions in the PayloadVisibility field which is
+	// therefore expected to be nil; however the fabric may be extended to
+	// encode more elaborate visibility mechanisms that shall be encoded in
+	// this field (and handled appropriately by the peer)
+	if chaincodeHdrExt.PayloadVisibility != nil {
+		return nil, fmt.Errorf("Invalid payload visibility field")
+	}
 
 	return chaincodeHdrExt, nil
 }

core/endorser/endorser.go

@@ -271,12 +271,7 @@ func (e *Endorser) endorseProposal(ctx context.Context, chainID string, txid str
 // ProcessProposal process the Proposal
 func (e *Endorser) ProcessProposal(ctx context.Context, signedProp *pb.SignedProposal) (*pb.ProposalResponse, error) {
 	// at first, we check whether the message is valid
-	prop, _, hdrExt, err := validation.ValidateProposalMessage(signedProp)
-	if err != nil {
-		return &pb.ProposalResponse{Response: &pb.Response{Status: 500, Message: err.Error()}}, err
-	}
-
-	hdr, err := putils.GetHeader(prop.Header)
+	prop, hdr, hdrExt, err := validation.ValidateProposalMessage(signedProp)
 	if err != nil {
 		return &pb.ProposalResponse{Response: &pb.Response{Status: 500, Message: err.Error()}}, err
 	}
@@ -325,8 +320,6 @@ func (e *Endorser) ProcessProposal(ctx context.Context, signedProp *pb.SignedPro
 	//       to validate the supplied action before endorsing it
 
 	//1 -- simulate
-	//TODO what do we do with response ? We need it for Invoke responses for sure
-	//Which field in PayloadResponse will carry return value ?
 	cd, res, simulationResult, ccevent, err := e.simulateProposal(ctx, chainID, txid, prop, hdrExt.ChaincodeId, txsim)
 	if err != nil {
 		return &pb.ProposalResponse{Response: &pb.Response{Status: 500, Message: err.Error()}}, err
@@ -346,7 +339,6 @@ func (e *Endorser) ProcessProposal(ctx context.Context, signedProp *pb.SignedPro
 		}
 	}
 
-	//TODO what do we do with response ? We need it for Invoke responses for sure
 	// Set the proposal response payload - it
 	// contains the "return value" from the
 	// chaincode invocation

core/scc/escc/endorser_onevalidsignature.go

@@ -52,9 +52,10 @@ func (e *EndorserOneValidSignature) Init(stub shim.ChaincodeStubInterface) pb.Re
 // args[0] - function name (not used now)
 // args[1] - serialized Header object
 // args[2] - serialized ChaincodeProposalPayload object
-// args[3] - binary blob of simulation results
-// args[4] - serialized events (optional)
-// args[5] - payloadVisibility (optional)
+// args[3] - result of executing chaincode
+// args[4] - binary blob of simulation results
+// args[5] - serialized events
+// args[6] - payloadVisibility
 //
 // NOTE: this chaincode is meant to sign another chaincode's simulation
 // results. It should not manipulate state as any state change will be
@@ -119,11 +120,15 @@ func (e *EndorserOneValidSignature) Invoke(stub shim.ChaincodeStubInterface) pb.
 	}
 
 	// Handle payload visibility (it's an optional argument)
-	visibility := []byte("") // TODO: when visibility is properly defined, replace with the default
+	// currently the fabric only supports full visibility: this means that
+	// there are no restrictions on which parts of the proposal payload will
+	// be visible in the final transaction; this default approach requires
+	// no additional instructions in the PayloadVisibility field; however
+	// the fabric may be extended to encode more elaborate visibility
+	// mechanisms that shall be encoded in this field (and handled
+	// appropriately by the peer)
+	var visibility []byte
 	if len(args) > 6 {
-		if args[6] == nil {
-			return shim.Error("serialized events are null")
-		}
 		visibility = args[6]
 	}
 

core/scc/escc/endorser_onevalidsignature_test.go

@@ -186,17 +186,15 @@ func TestInvoke(t *testing.T) {
 	}
 
 	// success test 3: invocation with mandatory args + events and visibility
-	visibility := []byte("visibility")
-
-	args = [][]byte{[]byte(""), proposal.Header, proposal.Payload, successRes, simRes, events, visibility}
+	args = [][]byte{[]byte(""), proposal.Header, proposal.Payload, successRes, simRes, events, nil}
 	res = stub.MockInvoke("1", args)
 	if res.Status != shim.OK {
 		t.Fail()
 		t.Fatalf("escc invoke failed with: %s", res.Message)
 		return
 	}
 
-	err = validateProposalResponse(res.Payload, proposal, visibility, successResponse, simRes, events)
+	err = validateProposalResponse(res.Payload, proposal, []byte{}, successResponse, simRes, events)
 	if err != nil {
 		t.Fail()
 		t.Fatalf("%s", err)

protos/utils/txutils.go

@@ -253,15 +253,15 @@ func GetBytesProposalPayloadForTx(payload *peer.ChaincodeProposalPayload, visibi
 		return nil, errors.New("Failure while marshalling the ChaincodeProposalPayload!")
 	}
 
-	// TODO: handle payload visibility - it needs to be defined first!
-	// here, as an example, I'll code the visibility policy that allows the
-	// full header but only the hash of the payload
-
-	digest, err := factory.GetDefaultOrPanic().Hash(cppBytes, &bccsp.SHAOpts{})
-	if err != nil {
-		return nil, fmt.Errorf("Failed computing digest [%s]", err)
-	}
-	return digest, nil
+	// currently the fabric only supports full visibility: this means that
+	// there are no restrictions on which parts of the proposal payload will
+	// be visible in the final transaction; this default approach requires
+	// no additional instructions in the PayloadVisibility field; however
+	// the fabric may be extended to encode more elaborate visibility
+	// mechanisms that shall be encoded in this field (and handled
+	// appropriately by the peer)
+
+	return cppBytes, nil
 }
 
 // GetProposalHash2 gets the proposal hash - this version