diff --git a/network/message/fingerprints.go b/network/message/fingerprints.go
index 01b814470f85b3d1abe3fa2078ea8af0aa1de171..d79f865615ead3490c5eb373f5fc72a9bd3bea64 100644
--- a/network/message/fingerprints.go
+++ b/network/message/fingerprints.go
@@ -15,23 +15,23 @@ import (
"gitlab.com/xx_network/primitives/id"
)
-// FingerprintsManager is a thread-safe map, mapping format.Fingerprint's to
-// a Handler object.
+// FingerprintsManager is a thread-safe map, mapping format.Fingerprint's to a
+// Handler object.
type FingerprintsManager struct {
fpMap map[id.ID]map[format.Fingerprint]Processor
sync.Mutex
}
-// newFingerprints is a constructor function for the Fingerprints tracker.
+// newFingerprints is a constructor function for the fingerprints tracker.
func newFingerprints() *FingerprintsManager {
return &FingerprintsManager{
fpMap: make(map[id.ID]map[format.Fingerprint]Processor),
}
}
-// Pop returns the associated handler to the fingerprint and removes
-// it from our list.
-// CRITICAL: it is never ok to process a fingerprint twice. This is a security
+// pop returns the associated handler to the fingerprint and removes it from the
+// list.
+// CRITICAL: It is never ok to process a fingerprint twice. This is a security
// vulnerability.
func (f *FingerprintsManager) pop(clientID *id.ID,
fingerprint format.Fingerprint) (
@@ -52,10 +52,10 @@ func (f *FingerprintsManager) pop(clientID *id.ID,
return nil, false
}
-// AddFingerprint is a thread-safe setter for the Fingerprints
-// map. AddFingerprint maps the given fingerprint key to the handler
-// value. If there is already an entry for this fingerprint, the
-// method returns with no write operation.
+// AddFingerprint is a thread-safe setter for the FingerprintsManager map.
+// AddFingerprint maps the given fingerprint key to the handler value. If there
+// is already an entry for this fingerprint, the method returns with no write
+// operation.
func (f *FingerprintsManager) AddFingerprint(clientID *id.ID,
fingerprint format.Fingerprint, mp Processor) error {
f.Lock()
@@ -69,16 +69,15 @@ func (f *FingerprintsManager) AddFingerprint(clientID *id.ID,
}
if _, exists := f.fpMap[cid][fingerprint]; exists {
- return errors.Errorf("fingerprint %s already exists",
- fingerprint)
+ return errors.Errorf("fingerprint %s already exists", fingerprint)
}
f.fpMap[cid][fingerprint] = mp
return nil
}
-// DeleteFingerprint is a thread-safe deletion operation on the Fingerprints map.
-// It will remove the entry for the given fingerprint from the map.
+// DeleteFingerprint is a thread-safe deletion operation on the Fingerprints
+// map. It will remove the entry for the given fingerprint from the map.
func (f *FingerprintsManager) DeleteFingerprint(clientID *id.ID,
fingerprint format.Fingerprint) {
f.Lock()
diff --git a/network/message/fingerprints_test.go b/network/message/fingerprints_test.go
index 5459c2657d95096cefd667987844f4c15a55fd76..66784d284c7e9456699eaa659144b5a6a3e78d14 100644
--- a/network/message/fingerprints_test.go
+++ b/network/message/fingerprints_test.go
@@ -9,7 +9,7 @@ package message
import (
jww "github.com/spf13/jwalterweatherman"
- "gitlab.com/elixxir/client/interfaces"
+ "gitlab.com/elixxir/client/network/identity/receptionID"
"gitlab.com/elixxir/comms/mixmessages"
"gitlab.com/elixxir/primitives/format"
"gitlab.com/xx_network/primitives/id"
@@ -21,7 +21,7 @@ import (
// Unit test.
func Test_newFingerprints(t *testing.T) {
expected := &FingerprintsManager{
- fpMap: make(map[id.ID]map[format.Fingerprint]interfaces.MessageProcessor),
+ fpMap: make(map[id.ID]map[format.Fingerprint]Processor),
}
received := newFingerprints()
@@ -87,7 +87,7 @@ func TestFingerprintsManager_AddFingerprint(t *testing.T) {
}
// Check that received value contains the expected data
- expected := map[format.Fingerprint]interfaces.MessageProcessor{fp: mp}
+ expected := map[format.Fingerprint]Processor{fp: mp}
if !reflect.DeepEqual(received, expected) {
t.Fatalf("Add error: Map does not contain expected data."+
"\nexpected: %v\nreceived: %v", expected, received)
@@ -129,7 +129,7 @@ func TestFingerprintsManager_DeleteClientFingerprints(t *testing.T) {
numTests := 100
cid := id.NewIdFromString("clientID", id.User, t)
fingerprints := make([]format.Fingerprint, 0, numTests)
- processors := make([]interfaces.MessageProcessor, 0, numTests)
+ processors := make([]Processor, 0, numTests)
for i := 0; i < numTests; i++ {
fp := format.NewFingerprint([]byte(strconv.Itoa(i)))
mp := NewMockMsgProcessor(t)
@@ -170,7 +170,7 @@ func (mock *MockMsgProcessor) MarkFingerprintUsed(_ format.Fingerprint) {
return
}
-func (mock *MockMsgProcessor) Process(format.Message, interfaces.EphemeralIdentity,
+func (mock *MockMsgProcessor) Process(format.Message, receptionID.EphemeralIdentity,
*mixmessages.RoundInfo) {
return
}
diff --git a/network/message/handler.go b/network/message/handler.go
index 625a43b2dbe62bb0e20c75058611b98756f49a2a..75728fc6a22b5b73e15f723af47051e2ef0f1bd0 100644
--- a/network/message/handler.go
+++ b/network/message/handler.go
@@ -10,7 +10,6 @@ package message
import (
"fmt"
jww "github.com/spf13/jwalterweatherman"
- "gitlab.com/elixxir/client/interfaces/preimage"
"gitlab.com/elixxir/client/stoppable"
"gitlab.com/elixxir/primitives/format"
"gitlab.com/xx_network/primitives/netTime"
@@ -29,21 +28,27 @@ func (p *handler) handleMessages(stop *stoppable.Single) {
wg.Add(len(bundle.Messages))
for i := range bundle.Messages {
msg := bundle.Messages[i]
+
go func() {
- count, ts := p.inProcess.Add(msg, bundle.RoundInfo, bundle.Identity)
+ count, ts := p.inProcess.Add(
+ msg, bundle.RoundInfo, bundle.Identity)
wg.Done()
success := p.handleMessage(msg, bundle)
if success {
- p.inProcess.Remove(msg, bundle.RoundInfo, bundle.Identity)
+ p.inProcess.Remove(
+ msg, bundle.RoundInfo, bundle.Identity)
} else {
- // fail the message if any part of the decryption fails,
- // unless it is the last attempts and has been in the buffer long
- // enough, in which case remove it
+ // Fail the message if any part of the decryption
+ // fails, unless it is the last attempts and has
+ // been in the buffer long enough, in which case
+ // remove it
if count == p.param.MaxChecksInProcessMessage &&
netTime.Since(ts) > p.param.InProcessMessageWait {
- p.inProcess.Remove(msg, bundle.RoundInfo, bundle.Identity)
+ p.inProcess.Remove(
+ msg, bundle.RoundInfo, bundle.Identity)
} else {
- p.inProcess.Failed(msg, bundle.RoundInfo, bundle.Identity)
+ p.inProcess.Failed(
+ msg, bundle.RoundInfo, bundle.Identity)
}
}
@@ -63,34 +68,36 @@ func (p *handler) handleMessage(ecrMsg format.Message, bundle Bundle) bool {
identity := bundle.Identity
round := bundle.RoundInfo
- // If we have a fingerprint, process it.
+ // If we have a fingerprint, process it
if proc, exists := p.pop(identity.Source, fingerprint); exists {
proc.Process(ecrMsg, identity, round)
return true
}
- triggers, exists := p.get(identity.Source, ecrMsg.GetSIH(), ecrMsg.GetContents())
+ triggers, exists := p.get(
+ identity.Source, ecrMsg.GetSIH(), ecrMsg.GetContents())
if exists {
for _, t := range triggers {
go t.Process(ecrMsg, identity, round)
}
if len(triggers) == 0 {
- jww.ERROR.Printf("empty service list for %s",
- ecrMsg.GetSIH()) // get preimage
+ jww.ERROR.Printf("empty service list for %s", ecrMsg.GetSIH())
}
return true
} else {
- // TODO: delete this else block because it should not be needed.
- jww.INFO.Printf("checking backup %v", preimage.MakeDefault(identity.Source))
- // //if it doesnt exist, check against the default fingerprint for the identity
+ // TODO: Delete this else block because it should not be needed.
+ jww.INFO.Printf("checking backup %v", identity.Source)
+ // //if it does not exist, check against the default fingerprint for the identity
// forMe = fingerprint2.CheckIdentityFP(ecrMsg.GetSIH(),
// ecrMsgContents, preimage.MakeDefault(identity.Source))
}
- im := fmt.Sprintf("Message cannot be identify: keyFP: %v, round: %d"+
+ im := fmt.Sprintf("Message cannot be identify: keyFP: %v, round: %d "+
"msgDigest: %s, not determined to be for client",
ecrMsg.GetKeyFP(), bundle.Round, ecrMsg.Digest())
jww.TRACE.Printf(im)
+
p.events.Report(1, "MessageReception", "Garbled", im)
+
return false
}
diff --git a/network/message/inProgress_test.go b/network/message/inProgress_test.go
index 147c69729c92950da27190aea2a15ea88ccec4a7..0220c26d81ddee6d5bf66282cdaa9f79dc49fd06 100644
--- a/network/message/inProgress_test.go
+++ b/network/message/inProgress_test.go
@@ -2,9 +2,7 @@ package message
import (
jww "github.com/spf13/jwalterweatherman"
- "gitlab.com/elixxir/client/interfaces"
- "gitlab.com/elixxir/client/interfaces/message"
- "gitlab.com/elixxir/client/interfaces/params"
+ "gitlab.com/elixxir/client/network/identity/receptionID"
"gitlab.com/elixxir/client/stoppable"
"gitlab.com/elixxir/client/storage/versioned"
pb "gitlab.com/elixxir/comms/mixmessages"
@@ -23,28 +21,14 @@ func TestMain(m *testing.M) {
os.Exit(m.Run())
}
-type TestListener struct {
- ch chan bool
-}
-
-// Hear is called to exercise the listener, passing in the data as an item.
-func (l TestListener) Hear(item message.Receive) {
- l.ch <- true
-}
-
-// Name returns a name; used for debugging.
-func (l TestListener) Name() string {
- return "TEST LISTENER FOR GARBLED MESSAGES"
-}
-
func Test_pickup_CheckInProgressMessages(t *testing.T) {
kv := versioned.NewKV(make(ekv.Memstore))
- p := NewHandler(params.Network{Messages: params.Messages{
+ p := NewHandler(Params{
MessageReceptionBuffLen: 20,
MessageReceptionWorkerPoolSize: 20,
MaxChecksInProcessMessage: 20,
InProcessMessageWait: time.Hour,
- }}, kv, nil).(*handler)
+ }, kv, nil).(*handler)
msg := makeTestFormatMessages(1)[0]
cid := id.NewIdFromString("clientID", id.User, t)
@@ -56,7 +40,7 @@ func Test_pickup_CheckInProgressMessages(t *testing.T) {
}
p.inProcess.Add(msg,
&pb.RoundInfo{ID: 1, Timestamps: []uint64{0, 1, 2, 3}},
- interfaces.EphemeralIdentity{Source: cid})
+ receptionID.EphemeralIdentity{Source: cid})
stop := stoppable.NewSingle("stop")
go p.recheckInProgressRunner(stop)
diff --git a/network/message/meteredCmixMessageBuffer.go b/network/message/meteredCmixMessageBuffer.go
index 321bf0e9496fd6ff47913d4694be519a168f0c42..8bcecabef5f70f221f9fedcf9b3806a8d714995e 100644
--- a/network/message/meteredCmixMessageBuffer.go
+++ b/network/message/meteredCmixMessageBuffer.go
@@ -11,7 +11,7 @@ import (
"encoding/json"
"github.com/pkg/errors"
jww "github.com/spf13/jwalterweatherman"
- "gitlab.com/elixxir/client/interfaces"
+ "gitlab.com/elixxir/client/network/identity/receptionID"
"gitlab.com/elixxir/client/storage/utility"
"gitlab.com/elixxir/client/storage/versioned"
pb "gitlab.com/elixxir/comms/mixmessages"
@@ -131,7 +131,8 @@ func NewOrLoadMeteredCmixMessageBuffer(kv *versioned.KV, key string) (
*MeteredCmixMessageBuffer, error) {
mb, err := utility.LoadMessageBuffer(kv, &meteredCmixMessageHandler{}, key)
if err != nil {
- jww.WARN.Printf("Failed to find MeteredCmixMessageBuffer %s, making a new one", key)
+ jww.WARN.Printf(
+ "Failed to find MeteredCmixMessageBuffer %s, making a new one", key)
return NewMeteredCmixMessageBuffer(kv, key)
}
@@ -139,10 +140,10 @@ func NewOrLoadMeteredCmixMessageBuffer(kv *versioned.KV, key string) (
}
func (mcmb *MeteredCmixMessageBuffer) Add(m format.Message, ri *pb.RoundInfo,
- identity interfaces.EphemeralIdentity) (uint, time.Time) {
+ identity receptionID.EphemeralIdentity) (uint, time.Time) {
if m.GetPrimeByteLen() == 0 {
- jww.FATAL.Panicf("Cannot handle a metered " +
- "cmix message with a length of 0")
+ jww.FATAL.Panic(
+ "Cannot handle a metered cMix message with a length of 0.")
}
msg := buildMsg(m, ri, identity)
@@ -153,10 +154,10 @@ func (mcmb *MeteredCmixMessageBuffer) Add(m format.Message, ri *pb.RoundInfo,
}
func (mcmb *MeteredCmixMessageBuffer) AddProcessing(m format.Message,
- ri *pb.RoundInfo, identity interfaces.EphemeralIdentity) (uint, time.Time) {
+ ri *pb.RoundInfo, identity receptionID.EphemeralIdentity) (uint, time.Time) {
if m.GetPrimeByteLen() == 0 {
- jww.FATAL.Panicf("Cannot handle a metered " +
- "cmix message with a length of 0")
+ jww.FATAL.Panic(
+ "Cannot handle a metered cMix message with a length of 0.")
}
msg := buildMsg(m, ri, identity)
@@ -167,68 +168,71 @@ func (mcmb *MeteredCmixMessageBuffer) AddProcessing(m format.Message,
}
func (mcmb *MeteredCmixMessageBuffer) Next() (format.Message, *pb.RoundInfo,
- interfaces.EphemeralIdentity, bool) {
+ receptionID.EphemeralIdentity, bool) {
m, ok := mcmb.mb.Next()
if !ok {
- return format.Message{}, nil, interfaces.EphemeralIdentity{}, false
+ return format.Message{}, nil, receptionID.EphemeralIdentity{}, false
}
msg := m.(meteredCmixMessage)
- // increment the count and save
+ // Increment the count and save
msg.Count++
mcmh := &meteredCmixMessageHandler{}
err := mcmh.SaveMessage(mcmb.kv, msg,
utility.MakeStoredMessageKey(mcmb.key, mcmh.HashMessage(msg)))
if err != nil {
- jww.FATAL.Panicf("Failed to save metered message after count "+
- "update: %s", err)
+ jww.FATAL.Panicf(
+ "Failed to save metered message after count update: %s", err)
}
msfFormat, err := format.Unmarshal(msg.M)
if err != nil {
- jww.FATAL.Panicf("Failed to unmarshal message after count "+
- "update: %s", err)
+ jww.FATAL.Panicf(
+ "Failed to unmarshal message after count update: %s", err)
}
ri := &pb.RoundInfo{}
err = proto.Unmarshal(msg.Ri, ri)
if err != nil {
- jww.FATAL.Panicf("Failed to unmarshal round info from msg format")
+ jww.FATAL.Panicf(
+ "Failed to unmarshal round info from msg format: %s", err)
}
- identity := interfaces.EphemeralIdentity{}
+ identity := receptionID.EphemeralIdentity{}
err = json.Unmarshal(msg.Identity, &identity)
if err != nil {
- jww.FATAL.Panicf("Failed to unmarshal identity from msg format")
+ jww.FATAL.Panicf(
+ "Failed to unmarshal identity from msg format: %s", err)
}
return msfFormat, ri, identity, true
}
func (mcmb *MeteredCmixMessageBuffer) Remove(m format.Message, ri *pb.RoundInfo,
- identity interfaces.EphemeralIdentity) {
+ identity receptionID.EphemeralIdentity) {
mcmb.mb.Succeeded(buildMsg(m, ri, identity))
}
func (mcmb *MeteredCmixMessageBuffer) Failed(m format.Message, ri *pb.RoundInfo,
- identity interfaces.EphemeralIdentity) {
+ identity receptionID.EphemeralIdentity) {
mcmb.mb.Failed(buildMsg(m, ri, identity))
}
-func buildMsg(m format.Message, ri *pb.RoundInfo, identity interfaces.EphemeralIdentity) meteredCmixMessage {
+func buildMsg(m format.Message, ri *pb.RoundInfo,
+ identity receptionID.EphemeralIdentity) meteredCmixMessage {
if m.GetPrimeByteLen() == 0 {
- jww.FATAL.Panicf("Cannot handle a metered " +
- "cmix message with a length of 0")
+ jww.FATAL.Panic(
+ "Cannot handle a metered cMix message with a length of 0.")
}
riMarshal, err := proto.Marshal(ri)
if err != nil {
- jww.FATAL.Panicf("Failed to marshal round info")
+ jww.FATAL.Panicf("Failed to marshal round info: %s", err)
}
identityMarshal, err := json.Marshal(&identity)
if err != nil {
- jww.FATAL.Panicf("Failed to marshal identity")
+ jww.FATAL.Panicf("Failed to marshal identity: %s", err)
}
return meteredCmixMessage{
diff --git a/network/message/meteredCmixMessageBuffer_test.go b/network/message/meteredCmixMessageBuffer_test.go
index beeab4e9e5b933c7bf8d0ee70c01abae14dc9801..4bf6202f75f6ab46be032f3ef15e2fad36c8f7aa 100644
--- a/network/message/meteredCmixMessageBuffer_test.go
+++ b/network/message/meteredCmixMessageBuffer_test.go
@@ -10,7 +10,7 @@ package message
import (
"bytes"
"encoding/json"
- "gitlab.com/elixxir/client/interfaces"
+ "gitlab.com/elixxir/client/network/identity/receptionID"
"gitlab.com/elixxir/client/storage/utility"
"gitlab.com/elixxir/client/storage/versioned"
pb "gitlab.com/elixxir/comms/mixmessages"
@@ -137,10 +137,10 @@ func Test_meteredCmixMessageHandler_Smoke(t *testing.T) {
// AddFingerprint two messages
mcmb.Add(testMsgs[0],
&pb.RoundInfo{ID: 1, Timestamps: []uint64{0, 1, 2, 3}},
- interfaces.EphemeralIdentity{Source: id.NewIdFromString("user1", id.User, t)})
+ receptionID.EphemeralIdentity{Source: id.NewIdFromString("user1", id.User, t)})
mcmb.Add(testMsgs[1],
&pb.RoundInfo{ID: 2, Timestamps: []uint64{0, 1, 2, 3}},
- interfaces.EphemeralIdentity{Source: id.NewIdFromString("user2", id.User, t)})
+ receptionID.EphemeralIdentity{Source: id.NewIdFromString("user2", id.User, t)})
msg, ri, identity, exists := mcmb.Next()
if !exists {
diff --git a/network/message/pickup.go b/network/message/pickup.go
index 7ad3173ad24b736500e67895df3f571ded08c1b0..4119e720465d4a9891a89b98cf3e13b7e6bb615a 100644
--- a/network/message/pickup.go
+++ b/network/message/pickup.go
@@ -57,7 +57,8 @@ func NewHandler(param Params, kv *versioned.KV, events event.Manager) Handler {
garbled, err := NewOrLoadMeteredCmixMessageBuffer(kv, inProcessKey)
if err != nil {
- jww.FATAL.Panicf("Failed to load or new the Garbled Messages system: %v", err)
+ jww.FATAL.Panicf(
+ "Failed to load or new the Garbled Messages system: %v", err)
}
m := handler{
diff --git a/network/message/processor.go b/network/message/processor.go
index f4aa5e3202615e3ed8f9328b8bcd44a3be3f2ade..214c845f307c7ef978d98ba08cbf8836877acc07 100644
--- a/network/message/processor.go
+++ b/network/message/processor.go
@@ -7,13 +7,13 @@ import (
)
type Processor interface {
- // Process decrypts and hands off the message to its internal down
- // stream message processing system.
- // CRITICAL: Fingerprints should never be used twice. Process must
- // denote, in long term storage, usage of a fingerprint and that
- // fingerprint must not be added again during application load.
- // It is a security vulnerability to reuse a fingerprint. It leaks
- // privacy and can lead to compromise of message contents and integrity.
+ // Process decrypts and hands off the message to its internal down stream
+ // message processing system.
+ // CRITICAL: Fingerprints should never be used twice. Process must denote,
+ // in long term storage, usage of a fingerprint and that fingerprint must
+ // not be added again during application load.
+ // It is a security vulnerability to reuse a fingerprint. It leaks privacy
+ // and can lead to compromise of message contents and integrity.
Process(message format.Message, receptionID receptionID.EphemeralIdentity,
round *mixmessages.RoundInfo)
}
diff --git a/network/message/serviceGenerators.go b/network/message/serviceGenerators.go
index c2e6c791e2787babf3238e76ef0896301e0b6fbd..8fb275595243792610b5786dce08d129171b4292 100644
--- a/network/message/serviceGenerators.go
+++ b/network/message/serviceGenerators.go
@@ -7,13 +7,13 @@ import (
"gitlab.com/xx_network/primitives/id"
)
-// GetDefaultService is used to generate a default service. All identities
-// will respond to their default service, but it lacks privacy because it
-// uses the public ID as the key. Used for initial reach out in some protocols,
-// otherwise should not be used
+// GetDefaultService is used to generate a default service. All identities will
+// respond to their default service, but it lacks privacy because it uses the
+// public ID as the key. Used for initial reach out in some protocols, otherwise
+// should not be used.
func GetDefaultService(recipient *id.ID) Service {
- jww.WARN.Printf("Generating Default Service for %s - "+
- "may not be private", recipient)
+ jww.WARN.Printf(
+ "Generating Default Service for %s - may not be private", recipient)
return Service{
Identifier: recipient[:],
Tag: sih.Default,
@@ -21,9 +21,9 @@ func GetDefaultService(recipient *id.ID) Service {
}
}
-// GetRandomService is used to make a servivce for cMix sending when no
-// service is needed. It fills the Identifier with random, bits in order to
-// preserve privacy
+// GetRandomService is used to make a service for cMix sending when no service
+// is needed. It fills the Identifier with random, bits in order to preserve
+// privacy.
func GetRandomService(rng csprng.Source) Service {
identifier := make([]byte, 32)
if _, err := rng.Read(identifier); err != nil {
diff --git a/network/message/serviceInterface.go b/network/message/serviceInterface.go
index 7c9e79d9027ae9362e38f5bdbac77864bb778b0c..b0304acd5085b421fe3b669559a76ab568d20df8 100644
--- a/network/message/serviceInterface.go
+++ b/network/message/serviceInterface.go
@@ -10,10 +10,10 @@ import (
type Service struct {
Identifier []byte
Tag string
- Source []byte //optional metadata field, only used on reception
+ Source []byte // Optional metadata field, only used on reception
- //private field for lazy evaluation of preimage
- //Nil denotes not yet evaluated
+ // Private field for lazy evaluation of preimage
+ // A value of nil denotes not yet evaluated
lazyPreimage *sih.Preimage
}
@@ -28,7 +28,6 @@ func (si Service) HashFromMessageHash(messageHash []byte) []byte {
}
func (si Service) preimage() sih.Preimage {
- // calculate
if si.lazyPreimage == nil {
p := sih.MakePreimage(si.Identifier, si.Tag)
si.lazyPreimage = &p
diff --git a/network/message/serviceTracker.go b/network/message/serviceTracker.go
index 8ae97c829f3218a3d6c60532dadde1e4e0412fe7..616f6dfda392ba4cb65c8d02179bbae493fe26ec 100644
--- a/network/message/serviceTracker.go
+++ b/network/message/serviceTracker.go
@@ -7,9 +7,9 @@ import (
type ServicesTracker func(ServiceList)
-// TrackServices adds a service tracker to be triggered when a nee service
-// as added. Generally used for notificatiosn to use this system to identify a
-// received message
+// TrackServices adds a service tracker to be triggered when a new service is
+// added. Generally used for notification to use this system to identify a
+// received message.
func (sm *ServicesManager) TrackServices(tracker ServicesTracker) {
if tracker == nil {
return
@@ -20,8 +20,8 @@ func (sm *ServicesManager) TrackServices(tracker ServicesTracker) {
sm.trackers = append(sm.trackers, tracker)
}
-// triggerServiceTracking triggers the tracking of services.
-// Is it called when a service is added or removed.
+// triggerServiceTracking triggers the tracking of services. Is it called when a
+// service is added or removed.
func (sm *ServicesManager) triggerServiceTracking() {
if len(sm.trackers) == 0 {
return
@@ -44,15 +44,15 @@ func (sm *ServicesManager) triggerServiceTracking() {
// The ServiceList holds all services.
type ServiceList map[id.ID][]Service
-type slMarshled struct {
+type slMarshaled struct {
Id id.ID
Services []Service
}
func (sl ServiceList) MarshalJSON() ([]byte, error) {
- slList := make([]slMarshled, 0, len(sl))
+ slList := make([]slMarshaled, 0, len(sl))
for uid, s := range sl {
- slList = append(slList, slMarshled{
+ slList = append(slList, slMarshaled{
Id: uid,
Services: s,
})
@@ -61,7 +61,7 @@ func (sl ServiceList) MarshalJSON() ([]byte, error) {
}
func (sl ServiceList) UnmarshalJSON(b []byte) error {
- slList := make([]slMarshled, 0)
+ slList := make([]slMarshaled, 0)
if err := json.Unmarshal(b, &slList); err != nil {
return err
}
diff --git a/network/message/services.go b/network/message/services.go
index 987a1d3974d782ef0520aadfcb8ecc95186eba2a..d0593890550be233428e4be83c478e167f11b99d 100644
--- a/network/message/services.go
+++ b/network/message/services.go
@@ -16,9 +16,9 @@ import (
"gitlab.com/xx_network/primitives/id"
)
-/* Service Identification Hash - predefined hash based tags appended to
-all cMix messages which,though trial hashing, are used to determine if a message
-applies to this client.
+/* Service Identification Hash - predefined hash based tags appended to all cMix
+messages which,though trial hashing, are used to determine if a message applies
+to this client.
Services are used for 2 purposes - can be processed by the notification system,
or can be used to implement custom non fingerprint processing of payloads (i.e.
@@ -63,7 +63,7 @@ func NewServices() *ServicesManager {
// fingerprint is received or it has exhausted the map.
// If a match is found, this means the message received is for the client, and
// that one or multiple services exist to process this message.
-// These services are returned to the caller along with the a true boolean.
+// These services are returned to the caller along with a true boolean.
// If the map has been exhausted with no matches found, it returns nil and false.
func (sm *ServicesManager) get(clientID *id.ID, receivedSIH,
ecrMsgContents []byte) ([]Processor,
@@ -77,17 +77,18 @@ func (sm *ServicesManager) get(clientID *id.ID, receivedSIH,
return nil, false
}
for _, s := range services {
- // check if the sih matches this service
+ // Check if the SIH matches this service
if s.ForMe(ecrMsgContents, receivedSIH) {
- // return this service directly if not the default service
if s.defaultList == nil && s.Tag != sih.Default {
+ // Return this service directly if not the default service
return []Processor{s}, true
- // if it is default, and the default list isn't empty,
- // return the default list
} else if s.defaultList != nil {
+ // If it is default and the default list is not empty, then
+ // return the default list
return s.defaultList, true
}
- // return false if its for me but i have nothing registered to
+
+ // Return false if it is for me, but I have nothing registered to
// respond to default queries
return []Processor{}, false
}
@@ -157,8 +158,8 @@ func (sm *ServicesManager) DeleteService(clientID *id.ID, toDelete Service,
return
}
- // do unique handling if this is a default service and there is more
- // then one registered
+ // Do unique handling if this is a default service and there is more than
+ // one registered
if services.defaultList != nil && len(services.defaultList) > 1 {
for i, p := range services.defaultList {
if p == processor {
diff --git a/network/message/utils_test.go b/network/message/utils_test.go
deleted file mode 100644
index bd15af236399fd5bb355da541bbf4da9a5567922..0000000000000000000000000000000000000000
--- a/network/message/utils_test.go
+++ /dev/null
@@ -1,111 +0,0 @@
-package message
-
-import (
- "gitlab.com/elixxir/comms/mixmessages"
- "gitlab.com/xx_network/comms/connect"
- "gitlab.com/xx_network/primitives/id"
- "gitlab.com/xx_network/primitives/ndf"
- "testing"
- "time"
-)
-
-type MockSendCMIXComms struct {
- t *testing.T
-}
-
-func (mc *MockSendCMIXComms) GetHost(*id.ID) (*connect.Host, bool) {
- nid1 := id.NewIdFromString("zezima", id.Node, mc.t)
- gwID := nid1.DeepCopy()
- gwID.SetType(id.Gateway)
- p := connect.GetDefaultHostParams()
- p.MaxRetries = 0
- p.AuthEnabled = false
- h, _ := connect.NewHost(gwID, "0.0.0.0", []byte(""), p)
- return h, true
-}
-
-func (mc *MockSendCMIXComms) AddHost(
- *id.ID, string, []byte, connect.HostParams) (host *connect.Host, err error) {
- host, _ = mc.GetHost(nil)
- return host, nil
-}
-
-func (mc *MockSendCMIXComms) RemoveHost(*id.ID) {
-
-}
-
-func (mc *MockSendCMIXComms) SendPutMessage(*connect.Host,
- *mixmessages.GatewaySlot, time.Duration) (*mixmessages.GatewaySlotResponse, error) {
- return &mixmessages.GatewaySlotResponse{
- Accepted: true,
- RoundID: 3,
- }, nil
-}
-
-func (mc *MockSendCMIXComms) SendPutManyMessages(*connect.Host,
- *mixmessages.GatewaySlots, time.Duration) (*mixmessages.GatewaySlotResponse, error) {
- return &mixmessages.GatewaySlotResponse{
- Accepted: true,
- RoundID: 3,
- }, nil
-}
-
-func getNDF() *ndf.NetworkDefinition {
- nodeId := id.NewIdFromString("zezima", id.Node, &testing.T{})
- gwId := nodeId.DeepCopy()
- gwId.SetType(id.Gateway)
- return &ndf.NetworkDefinition{
- E2E: ndf.Group{
- Prime: "E2EE983D031DC1DB6F1A7A67DF0E9A8E5561DB8E8D49413394C049B7A" +
- "8ACCEDC298708F121951D9CF920EC5D146727AA4AE535B0922C688B55B3D" +
- "D2AEDF6C01C94764DAB937935AA83BE36E67760713AB44A6337C20E78615" +
- "75E745D31F8B9E9AD8412118C62A3E2E29DF46B0864D0C951C394A5CBBDC" +
- "6ADC718DD2A3E041023DBB5AB23EBB4742DE9C1687B5B34FA48C3521632C" +
- "4A530E8FFB1BC51DADDF453B0B2717C2BC6669ED76B4BDD5C9FF558E88F2" +
- "6E5785302BEDBCA23EAC5ACE92096EE8A60642FB61E8F3D24990B8CB12EE" +
- "448EEF78E184C7242DD161C7738F32BF29A841698978825B4111B4BC3E1E" +
- "198455095958333D776D8B2BEEED3A1A1A221A6E37E664A64B83981C46FF" +
- "DDC1A45E3D5211AAF8BFBC072768C4F50D7D7803D2D4F278DE8014A47323" +
- "631D7E064DE81C0C6BFA43EF0E6998860F1390B5D3FEACAF1696015CB79C" +
- "3F9C2D93D961120CD0E5F12CBB687EAB045241F96789C38E89D796138E63" +
- "19BE62E35D87B1048CA28BE389B575E994DCA755471584A09EC723742DC3" +
- "5873847AEF49F66E43873",
- Generator: "2",
- },
- CMIX: ndf.Group{
- Prime: "9DB6FB5951B66BB6FE1E140F1D2CE5502374161FD6538DF1648218642" +
- "F0B5C48C8F7A41AADFA187324B87674FA1822B00F1ECF8136943D7C55757" +
- "264E5A1A44FFE012E9936E00C1D3E9310B01C7D179805D3058B2A9F4BB6F" +
- "9716BFE6117C6B5B3CC4D9BE341104AD4A80AD6C94E005F4B993E14F091E" +
- "B51743BF33050C38DE235567E1B34C3D6A5C0CEAA1A0F368213C3D19843D" +
- "0B4B09DCB9FC72D39C8DE41F1BF14D4BB4563CA28371621CAD3324B6A2D3" +
- "92145BEBFAC748805236F5CA2FE92B871CD8F9C36D3292B5509CA8CAA77A" +
- "2ADFC7BFD77DDA6F71125A7456FEA153E433256A2261C6A06ED3693797E7" +
- "995FAD5AABBCFBE3EDA2741E375404AE25B",
- Generator: "5C7FF6B06F8F143FE8288433493E4769C4D988ACE5BE25A0E2480" +
- "9670716C613D7B0CEE6932F8FAA7C44D2CB24523DA53FBE4F6EC3595892D" +
- "1AA58C4328A06C46A15662E7EAA703A1DECF8BBB2D05DBE2EB956C142A33" +
- "8661D10461C0D135472085057F3494309FFA73C611F78B32ADBB5740C361" +
- "C9F35BE90997DB2014E2EF5AA61782F52ABEB8BD6432C4DD097BC5423B28" +
- "5DAFB60DC364E8161F4A2A35ACA3A10B1C4D203CC76A470A33AFDCBDD929" +
- "59859ABD8B56E1725252D78EAC66E71BA9AE3F1DD2487199874393CD4D83" +
- "2186800654760E1E34C09E4D155179F9EC0DC4473F996BDCE6EED1CABED8" +
- "B6F116F7AD9CF505DF0F998E34AB27514B0FFE7",
- },
- Gateways: []ndf.Gateway{
- {
- ID: gwId.Marshal(),
- Address: "0.0.0.0",
- TlsCertificate: "",
- },
- },
- Nodes: []ndf.Node{
- {
- ID: nodeId.Marshal(),
- Address: "0.0.0.0",
- TlsCertificate: "",
- Status: ndf.Active,
- },
- },
- }
-}