mirror of
https://github.com/lightningnetwork/lnd.git
synced 2024-11-20 02:27:21 +01:00
377e770db4
In this commit, we introduce a new package `nat`. This package is responsible for handling the different techniques for NAT traversals. Specifically, we have implemented UPnP and NAT-PMP support. This will allow users to easily advertise their nodes to the network as long as their devices are behind a single NAT. Devices behind multiple NATs are not supported.
118 lines
2.6 KiB
Go
118 lines
2.6 KiB
Go
package nat
|
|
|
|
import (
|
|
"fmt"
|
|
"net"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/jackpal/gateway"
|
|
natpmp "github.com/jackpal/go-nat-pmp"
|
|
)
|
|
|
|
// Compile-time check to ensure PMP implements the Traversal interface.
|
|
var _ Traversal = (*PMP)(nil)
|
|
|
|
// PMP is a concrete implementation of the Traversal interface that uses the
|
|
// NAT-PMP technique.
|
|
type PMP struct {
|
|
client *natpmp.Client
|
|
|
|
forwardedPortsMtx sync.Mutex
|
|
forwardedPorts map[uint16]struct{}
|
|
}
|
|
|
|
// DiscoverPMP attempts to scan the local network for a NAT-PMP enabled device
|
|
// within the given timeout.
|
|
func DiscoverPMP(timeout time.Duration) (*PMP, error) {
|
|
// Retrieve the gateway IP address of the local network.
|
|
gatewayIP, err := gateway.DiscoverGateway()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
pmp := &PMP{
|
|
client: natpmp.NewClientWithTimeout(gatewayIP, timeout),
|
|
forwardedPorts: make(map[uint16]struct{}),
|
|
}
|
|
|
|
// We'll then attempt to retrieve the external IP address of this
|
|
// device to ensure it is not behind multiple NATs.
|
|
if _, err := pmp.ExternalIP(); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return pmp, nil
|
|
}
|
|
|
|
// ExternalIP returns the external IP address of the NAT-PMP enabled device.
|
|
func (p *PMP) ExternalIP() (net.IP, error) {
|
|
res, err := p.client.GetExternalAddress()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
ip := net.IP(res.ExternalIPAddress[:])
|
|
if isPrivateIP(ip) {
|
|
return nil, ErrMultipleNAT
|
|
}
|
|
|
|
return ip, nil
|
|
}
|
|
|
|
// AddPortMapping enables port forwarding for the given port.
|
|
func (p *PMP) AddPortMapping(port uint16) error {
|
|
p.forwardedPortsMtx.Lock()
|
|
defer p.forwardedPortsMtx.Unlock()
|
|
|
|
if _, exists := p.forwardedPorts[port]; exists {
|
|
return nil
|
|
}
|
|
|
|
_, err := p.client.AddPortMapping("tcp", int(port), int(port), 0)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
p.forwardedPorts[port] = struct{}{}
|
|
|
|
return nil
|
|
}
|
|
|
|
// DeletePortMapping disables port forwarding for the given port.
|
|
func (p *PMP) DeletePortMapping(port uint16) error {
|
|
p.forwardedPortsMtx.Lock()
|
|
defer p.forwardedPortsMtx.Unlock()
|
|
|
|
if _, exists := p.forwardedPorts[port]; !exists {
|
|
return fmt.Errorf("port %d is not being forwarded", port)
|
|
}
|
|
|
|
_, err := p.client.AddPortMapping("tcp", int(port), 0, 0)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
delete(p.forwardedPorts, port)
|
|
|
|
return nil
|
|
}
|
|
|
|
// ForwardedPorts returns a list of ports currently being forwarded.
|
|
func (p *PMP) ForwardedPorts() []uint16 {
|
|
p.forwardedPortsMtx.Lock()
|
|
defer p.forwardedPortsMtx.Unlock()
|
|
|
|
ports := make([]uint16, 0, len(p.forwardedPorts))
|
|
for port := range p.forwardedPorts {
|
|
ports = append(ports, port)
|
|
}
|
|
|
|
return ports
|
|
}
|
|
|
|
// Name returns the name of the specific NAT traversal technique used.
|
|
func (p *PMP) Name() string {
|
|
return "NAT-PMP"
|
|
}
|