These are functionally the same as the "urn:schemas-upnp-org" services with a few minor changes, and are still used by older devices. Support them to improve our ability to obtain an external IP on such networks. Updates #10911 Signed-off-by: Andrew Dunham <andrew@du.nham.ca> Change-Id: I05501fad9d6f0a3b8cf19fc95eee80e7d16cc2cfmain
Andrew Dunham
2 years ago
parent
75f1d3e7d7
commit
fd94d96e2b
@ -0,0 +1,303 @@ |
||||
// Copyright (c) Tailscale Inc & AUTHORS
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
//go:build !js
|
||||
|
||||
// (no raw sockets in JS/WASM)
|
||||
|
||||
package portmapper |
||||
|
||||
import ( |
||||
"context" |
||||
|
||||
"github.com/tailscale/goupnp" |
||||
"github.com/tailscale/goupnp/soap" |
||||
) |
||||
|
||||
const ( |
||||
urn_LegacyWANPPPConnection_1 = "urn:dslforum-org:service:WANPPPConnection:1" |
||||
urn_LegacyWANIPConnection_1 = "urn:dslforum-org:service:WANIPConnection:1" |
||||
) |
||||
|
||||
// legacyWANPPPConnection1 is the same as internetgateway2.WANPPPConnection1,
|
||||
// except using the old URN that starts with "urn:dslforum-org".
|
||||
//
|
||||
// The definition for this can be found in older documentation about UPnP; for
|
||||
// the purposes of this implementation, we're referring to "DSL Forum TR-064:
|
||||
// LAN-Side DSL CPE Configuration", which, while deprecated, can be found at:
|
||||
//
|
||||
// https://www.broadband-forum.org/wp-content/uploads/2018/11/TR-064_Corrigendum-1.pdf
|
||||
// https://www.broadband-forum.org/pdfs/tr-064-1-0-1.pdf
|
||||
type legacyWANPPPConnection1 struct { |
||||
goupnp.ServiceClient |
||||
} |
||||
|
||||
// AddPortMapping implements upnpClient
|
||||
func (client *legacyWANPPPConnection1) AddPortMapping( |
||||
ctx context.Context, |
||||
NewRemoteHost string, |
||||
NewExternalPort uint16, |
||||
NewProtocol string, |
||||
NewInternalPort uint16, |
||||
NewInternalClient string, |
||||
NewEnabled bool, |
||||
NewPortMappingDescription string, |
||||
NewLeaseDuration uint32, |
||||
) (err error) { |
||||
// Request structure.
|
||||
request := &struct { |
||||
NewRemoteHost string |
||||
NewExternalPort string |
||||
NewProtocol string |
||||
NewInternalPort string |
||||
NewInternalClient string |
||||
NewEnabled string |
||||
NewPortMappingDescription string |
||||
NewLeaseDuration string |
||||
}{} |
||||
|
||||
if request.NewRemoteHost, err = soap.MarshalString(NewRemoteHost); err != nil { |
||||
return |
||||
} |
||||
if request.NewExternalPort, err = soap.MarshalUi2(NewExternalPort); err != nil { |
||||
return |
||||
} |
||||
if request.NewProtocol, err = soap.MarshalString(NewProtocol); err != nil { |
||||
return |
||||
} |
||||
if request.NewInternalPort, err = soap.MarshalUi2(NewInternalPort); err != nil { |
||||
return |
||||
} |
||||
if request.NewInternalClient, err = soap.MarshalString(NewInternalClient); err != nil { |
||||
return |
||||
} |
||||
if request.NewEnabled, err = soap.MarshalBoolean(NewEnabled); err != nil { |
||||
return |
||||
} |
||||
if request.NewPortMappingDescription, err = soap.MarshalString(NewPortMappingDescription); err != nil { |
||||
return |
||||
} |
||||
if request.NewLeaseDuration, err = soap.MarshalUi4(NewLeaseDuration); err != nil { |
||||
return |
||||
} |
||||
|
||||
// Response structure.
|
||||
response := any(nil) |
||||
|
||||
// Perform the SOAP call.
|
||||
return client.SOAPClient.PerformAction(ctx, urn_LegacyWANPPPConnection_1, "AddPortMapping", request, response) |
||||
} |
||||
|
||||
// DeletePortMapping implements upnpClient
|
||||
func (client *legacyWANPPPConnection1) DeletePortMapping(ctx context.Context, NewRemoteHost string, NewExternalPort uint16, NewProtocol string) (err error) { |
||||
// Request structure.
|
||||
request := &struct { |
||||
NewRemoteHost string |
||||
NewExternalPort string |
||||
NewProtocol string |
||||
}{} |
||||
if request.NewRemoteHost, err = soap.MarshalString(NewRemoteHost); err != nil { |
||||
return |
||||
} |
||||
if request.NewExternalPort, err = soap.MarshalUi2(NewExternalPort); err != nil { |
||||
return |
||||
} |
||||
if request.NewProtocol, err = soap.MarshalString(NewProtocol); err != nil { |
||||
return |
||||
} |
||||
|
||||
// Response structure.
|
||||
response := any(nil) |
||||
|
||||
// Perform the SOAP call.
|
||||
return client.SOAPClient.PerformAction(ctx, urn_LegacyWANPPPConnection_1, "DeletePortMapping", request, response) |
||||
} |
||||
|
||||
// GetExternalIPAddress implements upnpClient
|
||||
func (client *legacyWANPPPConnection1) GetExternalIPAddress(ctx context.Context) (NewExternalIPAddress string, err error) { |
||||
// Request structure.
|
||||
request := any(nil) |
||||
|
||||
// Response structure.
|
||||
response := &struct { |
||||
NewExternalIPAddress string |
||||
}{} |
||||
|
||||
// Perform the SOAP call.
|
||||
if err = client.SOAPClient.PerformAction(ctx, urn_LegacyWANPPPConnection_1, "GetExternalIPAddress", request, response); err != nil { |
||||
return |
||||
} |
||||
|
||||
if NewExternalIPAddress, err = soap.UnmarshalString(response.NewExternalIPAddress); err != nil { |
||||
return |
||||
} |
||||
return |
||||
} |
||||
|
||||
// GetStatusInfo implements upnpClient
|
||||
func (client *legacyWANPPPConnection1) GetStatusInfo(ctx context.Context) (NewConnectionStatus string, NewLastConnectionError string, NewUptime uint32, err error) { |
||||
// Request structure.
|
||||
request := any(nil) |
||||
|
||||
// Response structure.
|
||||
response := &struct { |
||||
NewConnectionStatus string |
||||
NewLastConnectionError string |
||||
NewUpTime string // NOTE: the "T" is capitalized here, per the spec, though it's lowercase in the newer UPnP spec
|
||||
}{} |
||||
|
||||
// Perform the SOAP call.
|
||||
if err = client.SOAPClient.PerformAction(ctx, urn_LegacyWANPPPConnection_1, "GetStatusInfo", request, response); err != nil { |
||||
return |
||||
} |
||||
|
||||
if NewConnectionStatus, err = soap.UnmarshalString(response.NewConnectionStatus); err != nil { |
||||
return |
||||
} |
||||
if NewLastConnectionError, err = soap.UnmarshalString(response.NewLastConnectionError); err != nil { |
||||
return |
||||
} |
||||
if NewUptime, err = soap.UnmarshalUi4(response.NewUpTime); err != nil { |
||||
return |
||||
} |
||||
return |
||||
} |
||||
|
||||
// legacyWANIPConnection1 is the same as internetgateway2.WANIPConnection1,
|
||||
// except using the old URN that starts with "urn:dslforum-org".
|
||||
//
|
||||
// See legacyWANPPPConnection1 for details on where this is defined.
|
||||
type legacyWANIPConnection1 struct { |
||||
goupnp.ServiceClient |
||||
} |
||||
|
||||
// AddPortMapping implements upnpClient
|
||||
func (client *legacyWANIPConnection1) AddPortMapping( |
||||
ctx context.Context, |
||||
NewRemoteHost string, |
||||
NewExternalPort uint16, |
||||
NewProtocol string, |
||||
NewInternalPort uint16, |
||||
NewInternalClient string, |
||||
NewEnabled bool, |
||||
NewPortMappingDescription string, |
||||
NewLeaseDuration uint32, |
||||
) (err error) { |
||||
// Request structure.
|
||||
request := &struct { |
||||
NewRemoteHost string |
||||
NewExternalPort string |
||||
NewProtocol string |
||||
NewInternalPort string |
||||
NewInternalClient string |
||||
NewEnabled string |
||||
NewPortMappingDescription string |
||||
NewLeaseDuration string |
||||
}{} |
||||
|
||||
if request.NewRemoteHost, err = soap.MarshalString(NewRemoteHost); err != nil { |
||||
return |
||||
} |
||||
if request.NewExternalPort, err = soap.MarshalUi2(NewExternalPort); err != nil { |
||||
return |
||||
} |
||||
if request.NewProtocol, err = soap.MarshalString(NewProtocol); err != nil { |
||||
return |
||||
} |
||||
if request.NewInternalPort, err = soap.MarshalUi2(NewInternalPort); err != nil { |
||||
return |
||||
} |
||||
if request.NewInternalClient, err = soap.MarshalString(NewInternalClient); err != nil { |
||||
return |
||||
} |
||||
if request.NewEnabled, err = soap.MarshalBoolean(NewEnabled); err != nil { |
||||
return |
||||
} |
||||
if request.NewPortMappingDescription, err = soap.MarshalString(NewPortMappingDescription); err != nil { |
||||
return |
||||
} |
||||
if request.NewLeaseDuration, err = soap.MarshalUi4(NewLeaseDuration); err != nil { |
||||
return |
||||
} |
||||
|
||||
// Response structure.
|
||||
response := any(nil) |
||||
|
||||
// Perform the SOAP call.
|
||||
return client.SOAPClient.PerformAction(ctx, urn_LegacyWANIPConnection_1, "AddPortMapping", request, response) |
||||
} |
||||
|
||||
// DeletePortMapping implements upnpClient
|
||||
func (client *legacyWANIPConnection1) DeletePortMapping(ctx context.Context, NewRemoteHost string, NewExternalPort uint16, NewProtocol string) (err error) { |
||||
// Request structure.
|
||||
request := &struct { |
||||
NewRemoteHost string |
||||
NewExternalPort string |
||||
NewProtocol string |
||||
}{} |
||||
if request.NewRemoteHost, err = soap.MarshalString(NewRemoteHost); err != nil { |
||||
return |
||||
} |
||||
if request.NewExternalPort, err = soap.MarshalUi2(NewExternalPort); err != nil { |
||||
return |
||||
} |
||||
if request.NewProtocol, err = soap.MarshalString(NewProtocol); err != nil { |
||||
return |
||||
} |
||||
|
||||
// Response structure.
|
||||
response := any(nil) |
||||
|
||||
// Perform the SOAP call.
|
||||
return client.SOAPClient.PerformAction(ctx, urn_LegacyWANIPConnection_1, "DeletePortMapping", request, response) |
||||
} |
||||
|
||||
// GetExternalIPAddress implements upnpClient
|
||||
func (client *legacyWANIPConnection1) GetExternalIPAddress(ctx context.Context) (NewExternalIPAddress string, err error) { |
||||
// Request structure.
|
||||
request := any(nil) |
||||
|
||||
// Response structure.
|
||||
response := &struct { |
||||
NewExternalIPAddress string |
||||
}{} |
||||
|
||||
// Perform the SOAP call.
|
||||
if err = client.SOAPClient.PerformAction(ctx, urn_LegacyWANIPConnection_1, "GetExternalIPAddress", request, response); err != nil { |
||||
return |
||||
} |
||||
|
||||
if NewExternalIPAddress, err = soap.UnmarshalString(response.NewExternalIPAddress); err != nil { |
||||
return |
||||
} |
||||
return |
||||
} |
||||
|
||||
// GetStatusInfo implements upnpClient
|
||||
func (client *legacyWANIPConnection1) GetStatusInfo(ctx context.Context) (NewConnectionStatus string, NewLastConnectionError string, NewUptime uint32, err error) { |
||||
// Request structure.
|
||||
request := any(nil) |
||||
|
||||
// Response structure.
|
||||
response := &struct { |
||||
NewConnectionStatus string |
||||
NewLastConnectionError string |
||||
NewUpTime string // NOTE: the "T" is capitalized here, per the spec, though it's lowercase in the newer UPnP spec
|
||||
}{} |
||||
|
||||
// Perform the SOAP call.
|
||||
if err = client.SOAPClient.PerformAction(ctx, urn_LegacyWANIPConnection_1, "GetStatusInfo", request, response); err != nil { |
||||
return |
||||
} |
||||
|
||||
if NewConnectionStatus, err = soap.UnmarshalString(response.NewConnectionStatus); err != nil { |
||||
return |
||||
} |
||||
if NewLastConnectionError, err = soap.UnmarshalString(response.NewLastConnectionError); err != nil { |
||||
return |
||||
} |
||||
if NewUptime, err = soap.UnmarshalUi4(response.NewUpTime); err != nil { |
||||
return |
||||
} |
||||
return |
||||
} |
||||
Loading…
Reference in new issue