Skip to content
Snippets Groups Projects
Commit c8e5235d authored by Josh Brooks's avatar Josh Brooks
Browse files

Improve documentation & organization of auth package

parent 3cf2e785
Branches
Tags
2 merge requests!510Release,!207WIP: Client Restructure
Show whitespace changes
Inline Side-by-side
auth/confirm.go
+ 92
− 91
View file @ c8e5235d
......@@ -51,7 +51,8 @@ func (s *state) confirm(partner contact.Contact, serviceTag string) (
var sentRound id.Round
//run the handler
err := s.store.HandleReceivedRequest(partner.ID, func(rr *store.ReceivedRequest) error {
err := s.store.HandleReceivedRequest(partner.ID,
func(rr *store.ReceivedRequest) error {
// verify the passed contact matches what is stored
if rr.GetContact().DhPubKey.Cmp(partner.DhPubKey) != 0 {
return errors.New("pending Auth Request has different " +
......@@ -75,8 +76,8 @@ func (s *state) confirm(partner contact.Contact, serviceTag string) (
rng.Close()
/*construct message*/
// we build the payload before we save because it is technically fallible
// which can get into a bricked state if it fails
// we build the payload before we save because it is technically
// fallible which can get into a bricked state if it fails
baseFmt := newBaseFormat(s.net.GetMaxMessageLength(),
s.e2e.GetGroup().GetP().ByteLen())
ecrFmt := newEcrFormat(baseFmt.GetEcrPayloadLen())
......@@ -104,9 +105,9 @@ func (s *state) confirm(partner contact.Contact, serviceTag string) (
jww.TRACE.Printf("SendConfirm ECRPAYLOAD: %v", baseFmt.GetEcrPayload())
jww.TRACE.Printf("SendConfirm MAC: %v", mac)
// warning: channel can get into a bricked state if the first save occurs and
// the second does not or the two occur and the storage into critical
// messages does not occur
// warning: channel can get into a bricked state if the first save
// occurs and the second does not or the two occur and the storage
// into critical messages does not occur
// create local relationship
p := session.GetDefaultParams()
......
auth/interface.go
+ 55
− 0
View file @ c8e5235d
package auth
import (
"github.com/cloudflare/circl/dh/sidh"
"gitlab.com/elixxir/client/cmix"
"gitlab.com/elixxir/client/cmix/identity"
"gitlab.com/elixxir/client/cmix/identity/receptionID"
"gitlab.com/elixxir/client/cmix/message"
"gitlab.com/elixxir/client/cmix/rounds"
"gitlab.com/elixxir/client/e2e"
"gitlab.com/elixxir/client/e2e/ratchet/partner"
"gitlab.com/elixxir/client/e2e/ratchet/partner/session"
"gitlab.com/elixxir/crypto/contact"
"gitlab.com/elixxir/crypto/cyclic"
"gitlab.com/elixxir/primitives/fact"
"gitlab.com/elixxir/primitives/format"
"gitlab.com/xx_network/primitives/id"
"gitlab.com/xx_network/primitives/id/ephemeral"
)
type State interface {
......@@ -84,3 +95,47 @@ type State interface {
// VerifyOwnership checks if the received ownership proof is valid
VerifyOwnership(received, verified contact.Contact, e2e e2e.Handler) bool
}
// Callbacks is the interface for auth callback methods.
type Callbacks interface {
Request(partner contact.Contact, receptionID receptionID.EphemeralIdentity,
round rounds.Round)
Confirm(partner contact.Contact, receptionID receptionID.EphemeralIdentity,
round rounds.Round)
Reset(partner contact.Contact, receptionID receptionID.EphemeralIdentity,
round rounds.Round)
}
// cmixClient is a sub-interface of cmix.Client with
// methods relevant to this package.
type cmixClient interface {
IsHealthy() bool
GetMaxMessageLength() int
AddService(clientID *id.ID, newService message.Service,
response message.Processor)
DeleteService(clientID *id.ID, toDelete message.Service,
processor message.Processor)
GetIdentity(get *id.ID) (identity.TrackedID, error)
AddFingerprint(identity *id.ID, fingerprint format.Fingerprint,
mp message.Processor) error
DeleteFingerprint(identity *id.ID, fingerprint format.Fingerprint)
Send(recipient *id.ID, fingerprint format.Fingerprint,
service message.Service, payload, mac []byte, cmixParams cmix.CMIXParams) (
id.Round, ephemeral.Id, error)
}
// e2eHandler is a sub-interface of e2e.Handler containing
// methods relevant to this package.
type e2eHandler interface {
GetHistoricalDHPubkey() *cyclic.Int
GetHistoricalDHPrivkey() *cyclic.Int
GetGroup() *cyclic.Group
AddPartner(partnerID *id.ID,
partnerPubKey, myPrivKey *cyclic.Int,
partnerSIDHPubKey *sidh.PublicKey,
mySIDHPrivKey *sidh.PrivateKey, sendParams,
receiveParams session.Params) (partner.Manager, error)
GetPartner(partnerID *id.ID) (partner.Manager, error)
DeletePartner(partnerId *id.ID) error
GetReceptionID() *id.ID
}
auth/state.go
+ 10
− 57
View file @ c8e5235d
......@@ -10,27 +10,19 @@ package auth
import (
"encoding/base64"
"github.com/cloudflare/circl/dh/sidh"
"github.com/pkg/errors"
"gitlab.com/elixxir/client/auth/store"
"gitlab.com/elixxir/client/cmix"
"gitlab.com/elixxir/client/cmix/identity"
"gitlab.com/elixxir/client/cmix/identity/receptionID"
"gitlab.com/elixxir/client/cmix/message"
"gitlab.com/elixxir/client/cmix/rounds"
"gitlab.com/elixxir/client/e2e"
"gitlab.com/elixxir/client/e2e/ratchet/partner"
"gitlab.com/elixxir/client/e2e/ratchet/partner/session"
"gitlab.com/elixxir/client/event"
"gitlab.com/elixxir/client/storage/versioned"
"gitlab.com/elixxir/crypto/contact"
"gitlab.com/elixxir/crypto/cyclic"
"gitlab.com/elixxir/crypto/fastRNG"
"gitlab.com/elixxir/primitives/format"
"gitlab.com/xx_network/primitives/id"
"gitlab.com/xx_network/primitives/id/ephemeral"
)
// state is an implementation of the State interface.
type state struct {
callbacks Callbacks
......@@ -46,45 +38,6 @@ type state struct {
backupTrigger func(reason string)
}
type cmixClient interface {
IsHealthy() bool
GetMaxMessageLength() int
AddService(clientID *id.ID, newService message.Service,
response message.Processor)
DeleteService(clientID *id.ID, toDelete message.Service,
processor message.Processor)
GetIdentity(get *id.ID) (identity.TrackedID, error)
AddFingerprint(identity *id.ID, fingerprint format.Fingerprint,
mp message.Processor) error
DeleteFingerprint(identity *id.ID, fingerprint format.Fingerprint)
Send(recipient *id.ID, fingerprint format.Fingerprint,
service message.Service, payload, mac []byte, cmixParams cmix.CMIXParams) (
id.Round, ephemeral.Id, error)
}
type e2eHandler interface {
GetHistoricalDHPubkey() *cyclic.Int
GetHistoricalDHPrivkey() *cyclic.Int
GetGroup() *cyclic.Group
AddPartner(partnerID *id.ID,
partnerPubKey, myPrivKey *cyclic.Int,
partnerSIDHPubKey *sidh.PublicKey,
mySIDHPrivKey *sidh.PrivateKey, sendParams,
receiveParams session.Params) (partner.Manager, error)
GetPartner(partnerID *id.ID) (partner.Manager, error)
DeletePartner(partnerId *id.ID) error
GetReceptionID() *id.ID
}
type Callbacks interface {
Request(partner contact.Contact, receptionID receptionID.EphemeralIdentity,
round rounds.Round)
Confirm(partner contact.Contact, receptionID receptionID.EphemeralIdentity,
round rounds.Round)
Reset(partner contact.Contact, receptionID receptionID.EphemeralIdentity,
round rounds.Round)
}
// NewState loads the auth state or creates new auth state if one cannot be
// found.
// Bases its reception identity and keys off of what is found in e2e.
......@@ -92,8 +45,8 @@ type Callbacks interface {
// Parameters:
// The params object passed in determines the services that will be used
// to pick up requests and signal notifications. These are unique to an
// identity, so multiple auth states with the same service tags with different
// identities can run simultaneously.
// identity, so multiple auth states with the same service tags with
// different identities can run simultaneously.
// Default parameters can be retrieved via GetDefaultParameters()
// Temporary:
// In some cases, for example client <-> server communications, connections
......@@ -108,10 +61,9 @@ func NewState(kv *versioned.KV, net cmix.Client, e2e e2e.Handler,
kv, net, e2e, rng, event, params, callbacks, backupTrigger)
}
// NewStateLegacy loads the auth state or creates new auth state if one cannot be
// found.
// Bases its reception identity and keys off of what is found in e2e.
// Does not modify the kv prefix for backwards compatibility
// NewStateLegacy loads the auth state or creates new auth state if one cannot
// be found. Bases its reception identity and keys off of what is found in e2e.
// Does not modify the kv prefix for backwards compatibility.
// Otherwise, acts the same as NewState
func NewStateLegacy(kv *versioned.KV, net cmix.Client, e2e e2e.Handler,
rng *fastRNG.StreamGenerator, event event.Reporter, params Param,
......@@ -152,13 +104,14 @@ func NewStateLegacy(kv *versioned.KV, net cmix.Client, e2e e2e.Handler,
return s, nil
}
// CallAllReceivedRequests will iterate through all pending contact requests and replay
// them on the callbacks.
// CallAllReceivedRequests will iterate through all pending contact requests
// and replay them on the callbacks.
func (s *state) CallAllReceivedRequests() {
rrList := s.store.GetAllReceivedRequests()
for i := range rrList {
rr := rrList[i]
eph := receptionID.BuildIdentityFromRound(rr.GetContact().ID, rr.GetRound())
eph := receptionID.BuildIdentityFromRound(rr.GetContact().ID,
rr.GetRound())
s.callbacks.Request(rr.GetContact(), eph, rr.GetRound())
}
}
......
auth/store/sentRequestHandler.go
+ 1
− 1
View file @ c8e5235d
package store
// SentRequestHandler allows the lower fevel to assign and remove services
// SentRequestHandler allows the lower level to assign and remove services
type SentRequestHandler interface {
Add(sr *SentRequest)
Delete(sr *SentRequest)
......
e2e/sendUnsafe_test.go 0 → 100644
+ 104
− 0
View file @ c8e5235d
///////////////////////////////////////////////////////////////////////////////
// Copyright © 2020 xx network SEZC //
// //
// Use of this source code is governed by a license that can be found in the //
// LICENSE file //
///////////////////////////////////////////////////////////////////////////////
package e2e
import (
"gitlab.com/elixxir/client/catalog"
"gitlab.com/elixxir/client/e2e/parse"
"gitlab.com/elixxir/client/e2e/ratchet"
"gitlab.com/elixxir/client/e2e/receive"
"gitlab.com/elixxir/client/e2e/rekey"
"gitlab.com/elixxir/client/storage/versioned"
dh "gitlab.com/elixxir/crypto/diffieHellman"
"gitlab.com/elixxir/crypto/fastRNG"
"gitlab.com/elixxir/ekv"
"gitlab.com/xx_network/crypto/csprng"
"gitlab.com/xx_network/primitives/id"
"testing"
)
func TestManager_SendUnsafe(t *testing.T) {
streamGen := fastRNG.NewStreamGenerator(12, 1024, csprng.NewSystemRNG)
rng := streamGen.GetStream()
defer rng.Close()
netHandler := newMockCmixHandler()
// Generate new E2E manager
myKv := versioned.NewKV(ekv.MakeMemstore())
myID := id.NewIdFromString("myID", id.User, t)
myNet := newMockCmix(myID, netHandler, t)
m1 := &manager{
Switchboard: receive.New(),
partitioner: parse.NewPartitioner(myKv, myNet.GetMaxMessageLength()),
net: myNet,
myID: myID,
events: mockEventsManager{},
grp: myNet.GetInstance().GetE2EGroup(),
rekeyParams: rekey.GetDefaultParams(),
}
myPrivKey := dh.GeneratePrivateKey(
dh.DefaultPrivateKeyLength, m1.grp, rng)
err := ratchet.New(myKv, myID, myPrivKey, m1.grp)
if err != nil {
t.Errorf("Failed to generate new ratchet: %+v", err)
}
myFpGen := &fpGenerator{m1}
myServices := newMockServices()
m1.Ratchet, err = ratchet.Load(
myKv, myID, m1.grp, myFpGen, myServices, streamGen)
// Generate new E2E manager
partnerKv := versioned.NewKV(ekv.MakeMemstore())
partnerID := id.NewIdFromString("partnerID", id.User, t)
partnerNet := newMockCmix(partnerID, netHandler, t)
m2 := &manager{
Switchboard: receive.New(),
partitioner: parse.NewPartitioner(partnerKv, partnerNet.GetMaxMessageLength()),
net: partnerNet,
myID: partnerID,
events: mockEventsManager{},
grp: partnerNet.GetInstance().GetE2EGroup(),
rekeyParams: rekey.GetDefaultParams(),
}
receiveChan := make(chan receive.Message, 10)
m2.Switchboard.RegisterListener(partnerID, catalog.NoType, &mockListener{receiveChan})
partnerPrivKey := dh.GeneratePrivateKey(
dh.DefaultPrivateKeyLength, m2.grp, rng)
err = ratchet.New(partnerKv, partnerID, partnerPrivKey, m2.grp)
if err != nil {
t.Errorf("Failed to generate new ratchet: %+v", err)
}
partnerFpGen := &fpGenerator{m2}
partnerServices := newMockServices()
m1.Ratchet, err = ratchet.Load(
partnerKv, partnerID, m2.grp, partnerFpGen, partnerServices, streamGen)
// Generate partner identity and add partner
partnerPubKey, partnerSidhPubKey, mySidhPrivKey, sessionParams :=
genPartnerKeys(partnerPrivKey, m1.grp, rng, t)
_, err = m1.Ratchet.AddPartner(partnerID, partnerPubKey, myPrivKey,
partnerSidhPubKey, mySidhPrivKey, sessionParams, sessionParams)
if err != nil {
t.Errorf("Failed to add partner: %+v", err)
}
payload := []byte("My Payload")
p := GetDefaultParams()
_, _, err = m1.sendUnsafe(catalog.NoType, partnerID, payload, p)
if err != nil {
t.Fatalf("sendUnsafe error: %v", err)
}
}
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment