forked from tw-bc-group/fabric
-
Notifications
You must be signed in to change notification settings - Fork 0
/
endorsement.go
582 lines (514 loc) · 20.2 KB
/
endorsement.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
/*
Copyright IBM Corp. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0
*/
package endorsement
import (
"fmt"
"github.com/hyperledger/fabric/common/chaincode"
"github.com/hyperledger/fabric/common/flogging"
"github.com/hyperledger/fabric/common/graph"
"github.com/hyperledger/fabric/common/policies"
"github.com/hyperledger/fabric/common/policies/inquire"
"github.com/hyperledger/fabric/gossip/api"
"github.com/hyperledger/fabric/gossip/common"
. "github.com/hyperledger/fabric/gossip/discovery"
"github.com/hyperledger/fabric/protos/discovery"
"github.com/hyperledger/fabric/protos/msp"
"github.com/pkg/errors"
)
var (
logger = flogging.MustGetLogger("discovery/endorsement")
)
type principalEvaluator interface {
// SatisfiesPrincipal returns whether a given peer identity satisfies a certain principal
// on a given channel
SatisfiesPrincipal(channel string, identity []byte, principal *msp.MSPPrincipal) error
// MSPOfPrincipal returns the MSP ID of the given principal
MSPOfPrincipal(principal *msp.MSPPrincipal) string
}
type chaincodeMetadataFetcher interface {
// ChaincodeMetadata returns the metadata of the chaincode as appears in the ledger,
// or nil if the channel doesn't exist, or the chaincode isn't found in the ledger
Metadata(channel string, cc string, loadCollections bool) *chaincode.Metadata
}
type policyFetcher interface {
// PolicyByChaincode returns a policy that can be inquired which identities
// satisfy it
PolicyByChaincode(channel string, cc string) policies.InquireablePolicy
}
type gossipSupport interface {
// IdentityInfo returns identity information about peers
IdentityInfo() api.PeerIdentitySet
// PeersOfChannel returns the NetworkMembers considered alive
// and also subscribed to the channel given
PeersOfChannel(common.ChainID) Members
// Peers returns the NetworkMembers considered alive
Peers() Members
}
type endorsementAnalyzer struct {
gossipSupport
principalEvaluator
policyFetcher
chaincodeMetadataFetcher
}
// NewEndorsementAnalyzer constructs an NewEndorsementAnalyzer out of the given support
func NewEndorsementAnalyzer(gs gossipSupport, pf policyFetcher, pe principalEvaluator, mf chaincodeMetadataFetcher) *endorsementAnalyzer {
return &endorsementAnalyzer{
gossipSupport: gs,
policyFetcher: pf,
principalEvaluator: pe,
chaincodeMetadataFetcher: mf,
}
}
type peerPrincipalEvaluator func(member NetworkMember, principal *msp.MSPPrincipal) bool
// PeersForEndorsement returns an EndorsementDescriptor for a given set of peers, channel, and chaincode
func (ea *endorsementAnalyzer) PeersForEndorsement(chainID common.ChainID, interest *discovery.ChaincodeInterest) (*discovery.EndorsementDescriptor, error) {
identities := ea.IdentityInfo()
identitiesByID := identities.ByID()
metadataAndCollectionFilters, err := loadMetadataAndFilters(metadataAndFilterContext{
identityInfoByID: identitiesByID,
interest: interest,
chainID: chainID,
evaluator: ea,
fetch: ea,
})
if err != nil {
return nil, errors.WithStack(err)
}
metadata := metadataAndCollectionFilters.md
// Filter out peers that don't have the chaincode installed on them
chanMembership := ea.PeersOfChannel(chainID).Filter(peersWithChaincode(metadata...))
// Filter out peers that aren't authorized by the collection configs of the chaincode invocation chain
chanMembership = chanMembership.Filter(metadataAndCollectionFilters.isMemberAuthorized)
channelMembersById := chanMembership.ByID()
// Choose only the alive messages of those that have joined the channel
aliveMembership := ea.Peers().Intersect(chanMembership)
membersById := aliveMembership.ByID()
// Compute a mapping between the PKI-IDs of members to their identities
identitiesOfMembers := computeIdentitiesOfMembers(identities, membersById)
filter := ea.excludeIfCCNotInstalled(membersById, identitiesByID)
principalsSets, err := ea.computePrincipalSets(chainID, interest, filter)
if err != nil {
logger.Warningf("Principal set computation failed: %v", err)
return nil, errors.WithStack(err)
}
return ea.computeEndorsementResponse(&context{
chaincode: interest.Chaincodes[0].Name,
channel: string(chainID),
principalsSets: principalsSets,
channelMembersById: channelMembersById,
aliveMembership: aliveMembership,
identitiesOfMembers: identitiesOfMembers,
})
}
type context struct {
chaincode string
channel string
aliveMembership Members
principalsSets []policies.PrincipalSet
channelMembersById map[string]NetworkMember
identitiesOfMembers memberIdentities
}
func (ea *endorsementAnalyzer) computeEndorsementResponse(ctx *context) (*discovery.EndorsementDescriptor, error) {
// mapPrincipalsToGroups returns a mapping from principals to their corresponding groups.
// groups are just human readable representations that mask the principals behind them
principalGroups := mapPrincipalsToGroups(ctx.principalsSets)
// principalsToPeersGraph computes a bipartite graph (V1 U V2 , E)
// such that V1 is the peers, V2 are the principals,
// and each e=(peer,principal) is in E if the peer satisfies the principal
satGraph := principalsToPeersGraph(principalAndPeerData{
members: ctx.aliveMembership,
pGrps: principalGroups,
}, ea.satisfiesPrincipal(ctx.channel, ctx.identitiesOfMembers))
layouts := computeLayouts(ctx.principalsSets, principalGroups, satGraph)
if len(layouts) == 0 {
return nil, errors.New("cannot satisfy any principal combination")
}
criteria := &peerMembershipCriteria{
possibleLayouts: layouts,
satGraph: satGraph,
chanMemberById: ctx.channelMembersById,
idOfMembers: ctx.identitiesOfMembers,
}
return &discovery.EndorsementDescriptor{
Chaincode: ctx.chaincode,
Layouts: layouts,
EndorsersByGroups: endorsersByGroup(criteria),
}, nil
}
type principalFilter func(policies.PrincipalSet) bool
func (ea *endorsementAnalyzer) excludeIfCCNotInstalled(membersById map[string]NetworkMember, identitiesByID map[string]api.PeerIdentityInfo) principalFilter {
// Obtain the MSP IDs of the members of the channel that are alive
mspIDsOfChannelPeers := mspIDsOfMembers(membersById, identitiesByID)
// Create an exclusion filter for MSP Principals which their peers don't have the chaincode installed
excludeMSPsWithoutChaincodeInstalled := func(principal *msp.MSPPrincipal) bool {
mspID := ea.MSPOfPrincipal(principal)
_, exists := mspIDsOfChannelPeers[mspID]
return mspID != "" && exists
}
return func(principalsSet policies.PrincipalSet) bool {
return principalsSet.ContainingOnly(excludeMSPsWithoutChaincodeInstalled)
}
}
func (ea *endorsementAnalyzer) computePrincipalSets(chainID common.ChainID, interest *discovery.ChaincodeInterest, filter principalFilter) (policies.PrincipalSets, error) {
var inquireablePolicies []policies.InquireablePolicy
for _, chaincode := range interest.Chaincodes {
pol := ea.PolicyByChaincode(string(chainID), chaincode.Name)
if pol == nil {
logger.Debug("Policy for chaincode '", chaincode, "'doesn't exist")
return nil, errors.New("policy not found")
}
inquireablePolicies = append(inquireablePolicies, pol)
}
var cpss []inquire.ComparablePrincipalSets
for _, policy := range inquireablePolicies {
var cmpsets inquire.ComparablePrincipalSets
for _, ps := range policy.SatisfiedBy() {
if !filter(ps) {
logger.Debug(ps, "filtered out due to chaincodes not being installed on the corresponding organizations")
continue
}
cps := inquire.NewComparablePrincipalSet(ps)
if cps == nil {
return nil, errors.New("failed creating a comparable principal set")
}
cmpsets = append(cmpsets, cps)
}
if len(cmpsets) == 0 {
return nil, errors.New("chaincode isn't installed on sufficient organizations required by the endorsement policy")
}
cpss = append(cpss, cmpsets)
}
cps, err := mergePrincipalSets(cpss)
if err != nil {
return nil, errors.WithStack(err)
}
return cps.ToPrincipalSets(), nil
}
type metadataAndFilterContext struct {
chainID common.ChainID
interest *discovery.ChaincodeInterest
fetch chaincodeMetadataFetcher
identityInfoByID map[string]api.PeerIdentityInfo
evaluator principalEvaluator
}
// metadataAndColFilter holds metadata and member filters
type metadataAndColFilter struct {
md []*chaincode.Metadata
isMemberAuthorized memberFilter
}
func loadMetadataAndFilters(ctx metadataAndFilterContext) (*metadataAndColFilter, error) {
var metadata []*chaincode.Metadata
var filters []identityFilter
for _, chaincode := range ctx.interest.Chaincodes {
ccMD := ctx.fetch.Metadata(string(ctx.chainID), chaincode.Name, len(chaincode.CollectionNames) > 0)
if ccMD == nil {
return nil, errors.Errorf("No metadata was found for chaincode %s in channel %s", chaincode.Name, string(ctx.chainID))
}
metadata = append(metadata, ccMD)
if len(chaincode.CollectionNames) == 0 {
continue
}
principalSetByCollections, err := principalsFromCollectionConfig(ccMD.CollectionsConfig)
if err != nil {
logger.Warningf("Failed initializing collection filter for chaincode %s: %v", chaincode.Name, err)
return nil, errors.WithStack(err)
}
filter, err := principalSetByCollections.toIdentityFilter(string(ctx.chainID), ctx.evaluator, chaincode)
if err != nil {
logger.Warningf("Failed computing collection principal sets for chaincode %s due to %v", chaincode.Name, err)
return nil, errors.WithStack(err)
}
filters = append(filters, filter)
}
return computeFiltersWithMetadata(filters, metadata, ctx.identityInfoByID), nil
}
func computeFiltersWithMetadata(filters identityFilters, metadata []*chaincode.Metadata, identityInfoByID map[string]api.PeerIdentityInfo) *metadataAndColFilter {
if len(filters) == 0 {
return &metadataAndColFilter{
md: metadata,
isMemberAuthorized: noopMemberFilter,
}
}
filter := filters.combine().toMemberFilter(identityInfoByID)
return &metadataAndColFilter{
isMemberAuthorized: filter,
md: metadata,
}
}
// identityFilter accepts or rejects peer identities
type identityFilter func(api.PeerIdentityType) bool
// identityFilters aggregates multiple identityFilters
type identityFilters []identityFilter
// memberFilter accepts or rejects NetworkMembers
type memberFilter func(member NetworkMember) bool
// noopMemberFilter accepts every NetworkMember
func noopMemberFilter(_ NetworkMember) bool {
return true
}
// combine combines all identityFilters into a single identityFilter which only accepts identities
// which all the original filters accept
func (filters identityFilters) combine() identityFilter {
return func(identity api.PeerIdentityType) bool {
for _, f := range filters {
if !f(identity) {
return false
}
}
return true
}
}
// toMemberFilter converts this identityFilter to a memberFilter based on the given mapping
// from PKI-ID as strings, to PeerIdentityInfo which holds the peer identities
func (idf identityFilter) toMemberFilter(identityInfoByID map[string]api.PeerIdentityInfo) memberFilter {
return func(member NetworkMember) bool {
identity, exists := identityInfoByID[string(member.PKIid)]
if !exists {
return false
}
return idf(identity.Identity)
}
}
func (ea *endorsementAnalyzer) satisfiesPrincipal(channel string, identitiesOfMembers memberIdentities) peerPrincipalEvaluator {
return func(member NetworkMember, principal *msp.MSPPrincipal) bool {
err := ea.SatisfiesPrincipal(channel, identitiesOfMembers.identityByPKIID(member.PKIid), principal)
if err == nil {
// TODO: log the principals in a human readable form
logger.Debug(member, "satisfies principal", principal)
return true
}
logger.Debug(member, "doesn't satisfy principal", principal, ":", err)
return false
}
}
type peerMembershipCriteria struct {
satGraph *principalPeerGraph
idOfMembers memberIdentities
chanMemberById map[string]NetworkMember
possibleLayouts layouts
}
// endorsersByGroup computes a map from groups to peers.
// Each group included, is found in some layout, which means
// that there is some principal combination that includes the corresponding
// group.
// This means that if a group isn't included in the result, there is no
// principal combination (that includes the principal corresponding to the group),
// such that there are enough peers to satisfy the principal combination.
func endorsersByGroup(criteria *peerMembershipCriteria) map[string]*discovery.Peers {
satGraph := criteria.satGraph
idOfMembers := criteria.idOfMembers
chanMemberById := criteria.chanMemberById
includedGroups := criteria.possibleLayouts.groupsSet()
res := make(map[string]*discovery.Peers)
// Map endorsers to their corresponding groups.
// Iterate the principals, and put the peers into each group that corresponds with a principal vertex
for grp, principalVertex := range satGraph.principalVertices {
if _, exists := includedGroups[grp]; !exists {
// If the current group is not found in any layout, skip the corresponding principal
continue
}
peerList := &discovery.Peers{}
res[grp] = peerList
for _, peerVertex := range principalVertex.Neighbors() {
member := peerVertex.Data.(NetworkMember)
peerList.Peers = append(peerList.Peers, &discovery.Peer{
Identity: idOfMembers.identityByPKIID(member.PKIid),
StateInfo: chanMemberById[string(member.PKIid)].Envelope,
MembershipInfo: member.Envelope,
})
}
}
return res
}
// computeLayouts computes all possible principal combinations
// that can be used to satisfy the endorsement policy, given a graph
// of available peers that maps each peer to a principal it satisfies.
// Each such a combination is called a layout, because it maps
// a group (alias for a principal) to a threshold of peers that need to endorse,
// and that satisfy the corresponding principal.
func computeLayouts(principalsSets []policies.PrincipalSet, principalGroups principalGroupMapper, satGraph *principalPeerGraph) []*discovery.Layout {
var layouts []*discovery.Layout
// principalsSets is a collection of combinations of principals,
// such that each combination (given enough peers) satisfies the endorsement policy.
for _, principalSet := range principalsSets {
layout := &discovery.Layout{
QuantitiesByGroup: make(map[string]uint32),
}
// Since principalsSet has repetitions, we first
// compute a mapping from the principal to repetitions in the set.
for principal, plurality := range principalSet.UniqueSet() {
key := principalKey{
cls: int32(principal.PrincipalClassification),
principal: string(principal.Principal),
}
// We map the principal to a group, which is an alias for the principal.
layout.QuantitiesByGroup[principalGroups.group(key)] = uint32(plurality)
}
// Check that the layout can be satisfied with the current known peers
// This is done by iterating the current layout, and ensuring that
// each principal vertex is connected to at least <plurality> peer vertices.
if isLayoutSatisfied(layout.QuantitiesByGroup, satGraph) {
// If so, then add the layout to the layouts, since we have enough peers to satisfy the
// principal combination
layouts = append(layouts, layout)
}
}
return layouts
}
func isLayoutSatisfied(layout map[string]uint32, satGraph *principalPeerGraph) bool {
for grp, plurality := range layout {
// Do we have more than <plurality> peers connected to the principal?
if len(satGraph.principalVertices[grp].Neighbors()) < int(plurality) {
return false
}
}
return true
}
type principalPeerGraph struct {
peerVertices []*graph.Vertex
principalVertices map[string]*graph.Vertex
}
type principalAndPeerData struct {
members Members
pGrps principalGroupMapper
}
func principalsToPeersGraph(data principalAndPeerData, satisfiesPrincipal peerPrincipalEvaluator) *principalPeerGraph {
// Create the peer vertices
peerVertices := make([]*graph.Vertex, len(data.members))
for i, member := range data.members {
peerVertices[i] = graph.NewVertex(string(member.PKIid), member)
}
// Create the principal vertices
principalVertices := make(map[string]*graph.Vertex)
for pKey, grp := range data.pGrps {
principalVertices[grp] = graph.NewVertex(grp, pKey.toPrincipal())
}
// Connect principals and peers
for _, principalVertex := range principalVertices {
for _, peerVertex := range peerVertices {
// If the current peer satisfies the principal, connect their corresponding vertices with an edge
principal := principalVertex.Data.(*msp.MSPPrincipal)
member := peerVertex.Data.(NetworkMember)
if satisfiesPrincipal(member, principal) {
peerVertex.AddNeighbor(principalVertex)
}
}
}
return &principalPeerGraph{
peerVertices: peerVertices,
principalVertices: principalVertices,
}
}
func mapPrincipalsToGroups(principalsSets []policies.PrincipalSet) principalGroupMapper {
groupMapper := make(principalGroupMapper)
totalPrincipals := make(map[principalKey]struct{})
for _, principalSet := range principalsSets {
for _, principal := range principalSet {
totalPrincipals[principalKey{
principal: string(principal.Principal),
cls: int32(principal.PrincipalClassification),
}] = struct{}{}
}
}
for principal := range totalPrincipals {
groupMapper.group(principal)
}
return groupMapper
}
type memberIdentities map[string]api.PeerIdentityType
func (m memberIdentities) identityByPKIID(id common.PKIidType) api.PeerIdentityType {
return m[string(id)]
}
func computeIdentitiesOfMembers(identitySet api.PeerIdentitySet, members map[string]NetworkMember) memberIdentities {
identitiesByPKIID := make(map[string]api.PeerIdentityType)
identitiesOfMembers := make(map[string]api.PeerIdentityType, len(members))
for _, identity := range identitySet {
identitiesByPKIID[string(identity.PKIId)] = identity.Identity
}
for _, member := range members {
if identity, exists := identitiesByPKIID[string(member.PKIid)]; exists {
identitiesOfMembers[string(member.PKIid)] = identity
}
}
return identitiesOfMembers
}
// principalGroupMapper maps principals to names of groups
type principalGroupMapper map[principalKey]string
func (mapper principalGroupMapper) group(principal principalKey) string {
if grp, exists := mapper[principal]; exists {
return grp
}
grp := fmt.Sprintf("G%d", len(mapper))
mapper[principal] = grp
return grp
}
type principalKey struct {
cls int32
principal string
}
func (pk principalKey) toPrincipal() *msp.MSPPrincipal {
return &msp.MSPPrincipal{
PrincipalClassification: msp.MSPPrincipal_Classification(pk.cls),
Principal: []byte(pk.principal),
}
}
// layouts is an aggregation of several layouts
type layouts []*discovery.Layout
// groupsSet returns a set of groups that the layouts contain
func (l layouts) groupsSet() map[string]struct{} {
m := make(map[string]struct{})
for _, layout := range l {
for grp := range layout.QuantitiesByGroup {
m[grp] = struct{}{}
}
}
return m
}
func peersWithChaincode(metadata ...*chaincode.Metadata) func(member NetworkMember) bool {
return func(member NetworkMember) bool {
if member.Properties == nil {
return false
}
for _, ccMD := range metadata {
var found bool
for _, cc := range member.Properties.Chaincodes {
if cc.Name == ccMD.Name && cc.Version == ccMD.Version {
found = true
}
}
if !found {
return false
}
}
return true
}
}
func mspIDsOfMembers(membersById map[string]NetworkMember, identitiesByID map[string]api.PeerIdentityInfo) map[string]struct{} {
res := make(map[string]struct{})
for pkiID := range membersById {
if identity, exists := identitiesByID[string(pkiID)]; exists {
res[string(identity.Organization)] = struct{}{}
}
}
return res
}
func mergePrincipalSets(cpss []inquire.ComparablePrincipalSets) (inquire.ComparablePrincipalSets, error) {
// Obtain the first ComparablePrincipalSet first
var cps inquire.ComparablePrincipalSets
cps, cpss, err := popComparablePrincipalSets(cpss)
if err != nil {
return nil, errors.WithStack(err)
}
for _, cps2 := range cpss {
cps = inquire.Merge(cps, cps2)
}
return cps, nil
}
func popComparablePrincipalSets(sets []inquire.ComparablePrincipalSets) (inquire.ComparablePrincipalSets, []inquire.ComparablePrincipalSets, error) {
if len(sets) == 0 {
return nil, nil, errors.New("no principal sets remained after filtering")
}
cps, cpss := sets[0], sets[1:]
return cps, cpss, nil
}