psiphon-tunnel-core/vendor/github.com/tailscale/goupnp

tailscale/goupnp

This repo is a temporary fork of huin/goupnp(A UPnP client library for Go), customized for UPnP support in Tailscale.

Installation

Run go get -u github.com/tailscale/goupnp.

Documentation

See GUIDE.md for a quick start on the most common use case for this library.

Supported DCPs (you probably want to start with one of these):

• av1 - Client for UPnP Device Control Protocol MediaServer v1 and MediaRenderer v1.
• internetgateway1 - Client for UPnP Device Control Protocol Internet Gateway Device v1.
• internetgateway2 - Client for UPnP Device Control Protocol Internet Gateway Device v2.

Core components:

• (goupnp) core library - contains datastructures and utilities typically used by the implemented DCPs.
• httpu HTTPU implementation, underlies SSDP.
• ssdp SSDP client implementation (simple service discovery protocol) - used to discover UPnP services on a network.
• soap SOAP client implementation (simple object access protocol) - used to communicate with discovered services.

Regenerating dcps generated source code:

1. Build code generator:

go get -u github.com/tailscale/goupnp/cmd/goupnpdcpgen

1. Regenerate the code:

go generate ./...

Supporting additional UPnP devices and services:

Supporting additional services is, in the trivial case, simply a matter of adding the service to the dcpMetadata whitelist in cmd/goupnpdcpgen/metadata.go, regenerating the source code (see above), and committing that source code.

However, it would be helpful if anyone needing such a service could test the service against the service they have, and then reporting any trouble encountered as an issue on this project. If it just works, then please report at least minimal working functionality as an issue, and optionally contribute the metadata upstream.

Migrating due to Breaking Changes

• #40 introduced a breaking change to handling non-utf8 encodings, but removes a heavy dependency on golang.org/x/net with charset encodings. If this breaks your usage of this library, you can return to the old behavior by modifying the exported variable and importing the package yourself:

  import (
  "golang.org/x/net/html/charset"
  "github.com/tailscale/goupnp"
  )
  
  func init() {
  // should be modified before goupnp libraries are in use.
  goupnp.CharsetReaderFault = charset.NewReaderLabel
  }