tailscale/goupnp
tailscale/goupnp
1
0
Fork 0
mirror of https://github.com/tailscale/goupnp.git synced 2024-10-23 08:34:53 +08:00
Code Issues Packages Projects Releases Wiki Activity
Temporary working copy fork of huin/goupnp; a UPnP client library for Go (#golang)
155 Commits 5 Branches 1 Tag 453 KiB
Go 100%
main
Go to file
Brad Fitzpatrick 66b27ba4e4 goupnp: remove unused Device.FindService context argument 
It was misleading.

Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
2021-08-03 20:07:27 -07:00
cmd Add ctx to other new client calls 2021-07-09 18:00:03 -07:00
dcps/internetgateway2 Add ctx to other new client calls 2021-07-09 18:00:03 -07:00
httpu goupnp: clean up oddities 2021-07-28 11:38:22 -07:00
scpd Add SCPD.GetAction method. 2014-06-06 21:55:52 +01:00
soap goupnp: add context key for httpClient 2021-08-03 18:12:11 -07:00
ssdp goupnp: clean up oddities 2021-07-28 11:38:22 -07:00
.gitignore Switch to generate code with go generate. 2018-10-13 15:04:17 +01:00
device.go goupnp: remove unused Device.FindService context argument 2021-08-03 20:07:27 -07:00
go.mod Add context to service clients 2021-06-29 10:57:15 -07:00
go.sum Add context to service clients 2021-06-29 10:57:15 -07:00
goupnp.go goupnp: add context key for httpClient 2021-08-03 18:12:11 -07:00
GUIDE.md Fix inconsistent indents in GUIDE.md examples. 2021-02-21 12:36:27 +00:00
LICENSE Update email address. 2017-08-03 10:08:12 +01:00
network.go goupnp: remove unused closer allocation 2021-07-28 11:42:20 -07:00
README.md Fork changes 2021-06-24 14:47:30 -07:00
service_client.go goupnp: remove unused Device.FindService context argument 2021-08-03 20:07:27 -07:00

README.md

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):

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

Core components:

  • GoDoc (goupnp) core library - contains datastructures and utilities typically used by the implemented DCPs.
  • GoDoc httpu HTTPU implementation, underlies SSDP.
  • GoDoc ssdp SSDP client implementation (simple service discovery protocol) - used to discover UPnP services on a network.
  • GoDoc 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

  2. 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
}