aboutsummaryrefslogtreecommitdiffstats
path: root/p2p/nat/natupnp.go
blob: 029143b7bccb6f7f9da21eb935aee40aaa3c702a (plain) (blame)
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
// Copyright 2015 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package nat

import (
    "errors"
    "fmt"
    "net"
    "strings"
    "time"

    "github.com/huin/goupnp"
    "github.com/huin/goupnp/dcps/internetgateway1"
    "github.com/huin/goupnp/dcps/internetgateway2"
)

const soapRequestTimeout = 3 * time.Second

type upnp struct {
    dev     *goupnp.RootDevice
    service string
    client  upnpClient
}

type upnpClient interface {
    GetExternalIPAddress() (string, error)
    AddPortMapping(string, uint16, string, uint16, string, bool, string, uint32) error
    DeletePortMapping(string, uint16, string) error
    GetNATRSIPStatus() (sip bool, nat bool, err error)
}

func (n *upnp) ExternalIP() (addr net.IP, err error) {
    ipString, err := n.client.GetExternalIPAddress()
    if err != nil {
        return nil, err
    }
    ip := net.ParseIP(ipString)
    if ip == nil {
        return nil, errors.New("bad IP in response")
    }
    return ip, nil
}

func (n *upnp) AddMapping(protocol string, extport, intport int, desc string, lifetime time.Duration) error {
    ip, err := n.internalAddress()
    if err != nil {
        return nil
    }
    protocol = strings.ToUpper(protocol)
    lifetimeS := uint32(lifetime / time.Second)
    n.DeleteMapping(protocol, extport, intport)
    return n.client.AddPortMapping("", uint16(extport), protocol, uint16(intport), ip.String(), true, desc, lifetimeS)
}

func (n *upnp) internalAddress() (net.IP, error) {
    devaddr, err := net.ResolveUDPAddr("udp4", n.dev.URLBase.Host)
    if err != nil {
        return nil, err
    }
    ifaces, err := net.Interfaces()
    if err != nil {
        return nil, err
    }
    for _, iface := range ifaces {
        addrs, err := iface.Addrs()
        if err != nil {
            return nil, err
        }
        for _, addr := range addrs {
            if x, ok := addr.(*net.IPNet); ok && x.Contains(devaddr.IP) {
                return x.IP, nil
            }
        }
    }
    return nil, fmt.Errorf("could not find local address in same net as %v", devaddr)
}

func (n *upnp) DeleteMapping(protocol string, extport, intport int) error {
    return n.client.DeletePortMapping("", uint16(extport), strings.ToUpper(protocol))
}

func (n *upnp) String() string {
    return "UPNP " + n.service
}

// discoverUPnP searches for Internet Gateway Devices
// and returns the first one it can find on the local network.
func discoverUPnP() Interface {
    found := make(chan *upnp, 2)
    // IGDv1
    go discover(found, internetgateway1.URN_WANConnectionDevice_1, func(dev *goupnp.RootDevice, sc goupnp.ServiceClient) *upnp {
        switch sc.Service.ServiceType {
        case internetgateway1.URN_WANIPConnection_1:
            return &upnp{dev, "IGDv1-IP1", &internetgateway1.WANIPConnection1{ServiceClient: sc}}
        case internetgateway1.URN_WANPPPConnection_1:
            return &upnp{dev, "IGDv1-PPP1", &internetgateway1.WANPPPConnection1{ServiceClient: sc}}
        }
        return nil
    })
    // IGDv2
    go discover(found, internetgateway2.URN_WANConnectionDevice_2, func(dev *goupnp.RootDevice, sc goupnp.ServiceClient) *upnp {
        switch sc.Service.ServiceType {
        case internetgateway2.URN_WANIPConnection_1:
            return &upnp{dev, "IGDv2-IP1", &internetgateway2.WANIPConnection1{ServiceClient: sc}}
        case internetgateway2.URN_WANIPConnection_2:
            return &upnp{dev, "IGDv2-IP2", &internetgateway2.WANIPConnection2{ServiceClient: sc}}
        case internetgateway2.URN_WANPPPConnection_1:
            return &upnp{dev, "IGDv2-PPP1", &internetgateway2.WANPPPConnection1{ServiceClient: sc}}
        }
        return nil
    })
    for i := 0; i < cap(found); i++ {
        if c := <-found; c != nil {
            return c
        }
    }
    return nil
}

// finds devices matching the given target and calls matcher for all
// advertised services of each device. The first non-nil service found
// is sent into out. If no service matched, nil is sent.
func discover(out chan<- *upnp, target string, matcher func(*goupnp.RootDevice, goupnp.ServiceClient) *upnp) {
    devs, err := goupnp.DiscoverDevices(target)
    if err != nil {
        out <- nil
        return
    }
    found := false
    for i := 0; i < len(devs) && !found; i++ {
        if devs[i].Root == nil {
            continue
        }
        devs[i].Root.Device.VisitServices(func(service *goupnp.Service) {
            if found {
                return
            }
            // check for a matching IGD service
            sc := goupnp.ServiceClient{
                SOAPClient: service.NewSOAPClient(),
                RootDevice: devs[i].Root,
                Location:   devs[i].Location,
                Service:    service,
            }
            sc.SOAPClient.HTTPClient.Timeout = soapRequestTimeout
            upnp := matcher(devs[i].Root, sc)
            if upnp == nil {
                return
            }
            // check whether port mapping is enabled
            if _, nat, err := upnp.client.GetNATRSIPStatus(); err != nil || !nat {
                return
            }
            out <- upnp
            found = true
        })
    }
    if !found {
        out <- nil
    }
}