exchange signed routing records in identify #747
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,28 +2,31 @@ package basichost | |
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "io" | ||
| "net" | ||
| "time" | ||
|
|
||
| "github.com/libp2p/go-libp2p-core/connmgr" | ||
| "github.com/libp2p/go-libp2p-core/crypto" | ||
| "github.com/libp2p/go-libp2p-core/event" | ||
| "github.com/libp2p/go-libp2p-core/host" | ||
| "github.com/libp2p/go-libp2p-core/network" | ||
| "github.com/libp2p/go-libp2p-core/peer" | ||
| "github.com/libp2p/go-libp2p-core/peerstore" | ||
| "github.com/libp2p/go-libp2p-core/protocol" | ||
| "github.com/libp2p/go-libp2p-core/record" | ||
|
|
||
| "github.com/libp2p/go-eventbus" | ||
| inat "github.com/libp2p/go-libp2p-nat" | ||
| "github.com/libp2p/go-libp2p/p2p/protocol/identify" | ||
| "github.com/libp2p/go-libp2p/p2p/protocol/ping" | ||
|
|
||
| logging "github.com/ipfs/go-log" | ||
| "github.com/jbenet/goprocess" | ||
| goprocessctx "github.com/jbenet/goprocess/context" | ||
|
|
||
| "github.com/multiformats/go-multiaddr" | ||
| ma "github.com/multiformats/go-multiaddr" | ||
| madns "github.com/multiformats/go-multiaddr-dns" | ||
| manet "github.com/multiformats/go-multiaddr-net" | ||
|
|
@@ -76,7 +79,6 @@ type BasicHost struct { | |
| maResolver *madns.Resolver | ||
| cmgr connmgr.ConnManager | ||
| eventbus event.Bus | ||
|
|
||
| AddrsFactory AddrsFactory | ||
|
|
||
|
|
@@ -90,6 +92,9 @@ type BasicHost struct { | |
| } | ||
|
|
||
| addrChangeChan chan struct{} | ||
|
|
||
| signKey crypto.PrivKey | ||
| caBook peerstore.CertifiedAddrBook | ||
| } | ||
|
|
||
| var _ host.Host = (*BasicHost)(nil) | ||
|
|
@@ -143,18 +148,19 @@ func NewHost(ctx context.Context, net network.Network, opts *HostOpts) (*BasicHo | |
| if h.emitters.evtLocalProtocolsUpdated, err = h.eventbus.Emitter(&event.EvtLocalProtocolsUpdated{}); err != nil { | ||
| return nil, err | ||
| } | ||
| if h.emitters.evtLocalAddrsUpdated, err = h.eventbus.Emitter(&event.EvtLocalAddressesUpdated{}, eventbus.Stateful); err != nil { | ||
|
There was a problem hiding this comment. I'm not sure if this should be stateful. Are we doing this to get around the fact that we don't have some form of There was a problem hiding this comment. @Stebalien We have a However, calling that when you get a This avoids that race. |
||
| return nil, err | ||
| } | ||
|
|
||
| cab, ok := peerstore.GetCertifiedAddrBook(net.Peerstore()) | ||
| if !ok { | ||
| return nil, errors.New("peerstore should also be a certified address book") | ||
| } | ||
| h.caBook = cab | ||
|
|
||
| h.signKey = h.Peerstore().PrivKey(h.ID()) | ||
| if h.signKey == nil { | ||
| return nil, errors.New("unable to access host key") | ||
| } | ||
|
|
||
| h.proc = goprocessctx.WithContextAndTeardown(ctx, func() error { | ||
|
|
@@ -241,12 +247,12 @@ func New(net network.Network, opts ...interface{}) *BasicHost { | |
| } | ||
|
|
||
| h, err := NewHost(context.Background(), net, hostopts) | ||
| if err != nil { | ||
| // this cannot happen with legacy options | ||
| // plus we want to keep the (deprecated) legacy interface unchanged | ||
| panic(err) | ||
| } | ||
| h.Start() | ||
|
|
||
| return h | ||
| } | ||
|
|
@@ -312,44 +318,13 @@ func (h *BasicHost) newStreamHandler(s network.Stream) { | |
| go handle(protoID, s) | ||
| } | ||
|
|
||
| // SignalAddressChange signals to the host that it needs to determine whether our listen addresses have recently | ||
| // changed. | ||
| // Warning: this interface is unstable and may disappear in the future. | ||
| func (h *BasicHost) SignalAddressChange() { | ||
| select { | ||
| case h.addrChangeChan <- struct{}{}: | ||
| default: | ||
|
There was a problem hiding this comment. This is fine because the channel is buffered. If the event loop is firing, we will queue the next trigger. If the channel is full, the next iteration of the event loop will pick up the update we were intending to communicate. |
||
| } | ||
| } | ||
|
|
||
|
|
@@ -385,6 +360,80 @@ func makeUpdatedAddrEvent(prev, current []ma.Multiaddr) *event.EvtLocalAddresses | |
| return &evt | ||
| } | ||
|
|
||
| func (h *BasicHost) makeSignedPeerRecord(evt *event.EvtLocalAddressesUpdated) (*record.Envelope, error) { | ||
| current := make([]multiaddr.Multiaddr, len(evt.Current)) | ||
Stebalien marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| for _, a := range evt.Current { | ||
| current = append(current, a.Address) | ||
| } | ||
|
|
||
| addrs := make([]multiaddr.Multiaddr, 0, len(current)) | ||
| for _, a := range current { | ||
| if a == nil { | ||
| continue | ||
| } | ||
| addrs = append(addrs, a) | ||
| } | ||
Stebalien marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| rec := peer.NewPeerRecord() | ||
| rec.PeerID = h.network.LocalPeer() | ||
|
|
||
| rec.Addrs = addrs | ||
Stebalien marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return record.Seal(rec, h.signKey) | ||
| } | ||
|
|
||
| func (h *BasicHost) background(p goprocess.Process) { | ||
| var lastAddrs []ma.Multiaddr | ||
|
|
||
| emitAddrChange := func(currentAddrs []ma.Multiaddr) { | ||
| changeEvt := makeUpdatedAddrEvent(lastAddrs, currentAddrs) | ||
| if changeEvt != nil { | ||
|
There was a problem hiding this comment. Negate the condition to short-circuit instead, and outdent the block. |
||
| // add signed peer record to the event | ||
| sr, err := h.makeSignedPeerRecord(changeEvt) | ||
| if err != nil { | ||
| log.Errorf("error creating a signed peer record from the set of current addresses, err=%s", err) | ||
| return | ||
| } | ||
| changeEvt.SignedPeerRecord = *sr | ||
|
|
||
| // persist the signed record to the peerstore | ||
| if _, err := h.caBook.ConsumePeerRecord(sr, peerstore.PermanentAddrTTL); err != nil { | ||
| log.Errorf("failed to persist signed peer record in peer store, err=%s", err) | ||
| return | ||
| } | ||
|
|
||
| // emit addr change event on the bus | ||
| if err := h.emitters.evtLocalAddrsUpdated.Emit(*changeEvt); err != nil { | ||
| log.Warnf("error emitting event for updated addrs: %s", err) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // immediately emit the first address change event if we have a listen address | ||
| if h.Addrs() != nil { | ||
| emitAddrChange(h.Addrs()) | ||
| } | ||
| // init lastAddrs | ||
| lastAddrs = h.Addrs() | ||
|
There was a problem hiding this comment. This is racy. Capture the addresses and use them when emitting the event and setting There was a problem hiding this comment. @raulk Even though this code is executed in a single dedicated go-routine, have refactored this to make it easier to reason about. |
||
|
|
||
| // periodically schedules an IdentifyPush to update our peers for changes | ||
| // in our address set (if needed) | ||
| ticker := time.NewTicker(10 * time.Second) | ||
| defer ticker.Stop() | ||
|
|
||
| for { | ||
| select { | ||
| case <-ticker.C: | ||
| case <-h.addrChangeChan: | ||
| case <-p.Closing(): | ||
| return | ||
| } | ||
|
|
||
| // emit an EvtLocalAddressesUpdatedEvent event if our listen addresses have changed. | ||
| emitAddrChange(h.Addrs()) | ||
| // update last seen addrs | ||
| lastAddrs = h.Addrs() | ||
|
|
||
| } | ||
| } | ||
|
|
||
| // ID returns the (local) peer.ID associated with this Host | ||
| func (h *BasicHost) ID() peer.ID { | ||
| return h.Network().LocalPeer() | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need this bump?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, we do not. This was the remanent of a previous eventbus change I made that we do not need anymore.
This has been fixed.