go-websub

go-websub is a websub subscriber, publisher, and hub library written in go. It passes all of the websub.rocks tests for publishers and hubs, and almost all of them for subscribers.

Inspired by https://github.com/tystuyfzand/websub-client and https://github.com/tystuyfzand/websub-server.

Examples

See the ./examples/ directory for examples of using a subscriber, publisher, and hub.

Importing

go get github.com/notnotquinn/go-websub

Quick links

Features
- Subscriber features - methods
- Publisher features - methods
- Hub features - methods
Spec conformance classes

Features

BIG: Does not (currently) persist state between restarts.
Can run subscriber, publisher, and hub from one server, on one port, if needed. (see examples/single-port)

Subscriber features

BIG: Does not (currently) persist state between restarts.
Not completely spec compliant. (see Subscriber conformance)
Functions independently from publisher and hub.
Subscribe & unsubscribe to topics.
Simple function callback system, with access to subscription meta-data.
Request specific lease duration.
Provide hub.secret and verify hub signature.
Automatically refresh expiring subscriptions.

Subscriber methods

Interact with the subscriber via a Go API:

Subscribe to topic URLs with callback.

Example:

subscription, err := s.Subscribe(
	// Topic URL that exposes Link headers for "hub" and "self".
	"https://example.com/topic1",
	// for authenticated content distribution (maximum of 200 characters)
	"random bytes",
	// Callback function is called when the subscriber receives a valid
	// request from the hub, not on invalid ones
	// (for example ones with a missing or invalid hub signature)
	func(sub *websub.SubscriberSubscription, contentType string, body io.Reader) {
		fmt.Println("Received content!")
		// do something...
	},
)

if err != nil {
	// handle
}

Unsubscribe from topics.

Example:

err = s.Unsubscribe(subscription)

if err != nil {
	// handle
}

Publisher features

BIG: Does not (currently) persist state between restarts.
Completely spec compliant.
Functions independently from subscriber and hub.
Advertise topic and hub URLs for previously published topics.
Send publish requests for topic URLs that arent under the publishers base URL.
Send both hub.topic and hub.url on publish requests.
Treat https://example.com/baseURL/topic/ equal to https://example.com/baseURL/topic for incoming requests.
Optionally advertise topic and hub URLs for unpublished topics.
Optionally post content in publish request. (see publisher publishing methods #2)

Publisher methods

Interact with the publisher via a Go API:

Publish content with content-type.

Example:

err = p.Publish(
	// Topic URL
	p.BaseURL()+"/topic1",
	// Content Type
	"text/plain",
	// Content
	[]byte("Hello, WebSub!"),
)

if err != nil {
	// handle
}

Hub features

BIG: Does not (currently) persist state between restarts.
Completely spec compliant.
Functions independently from subscriber and publiser.
Configurable retry limits for distribution requests.
Configurable lease length limits and default lease length.
Configurable User-Agent for HTTP requests on behaf of the hub.
Configure one of "sha1", "sha256", "sha384", and "sha512" for signing publish requests.
Optionally expose all known topic URLs as a JSON array to /topics and provide websub updates for new topics.
Optionally accept publish requests with the body as the content. (see Hub accepted publishing methods #2)

Hub methods

Interact with the hub via a Go API:

Custom subscription validation.

Example:

// Deny any subscription where the callback URL is not under "example.com"
h.AddValidator(func(sub *websub.HubSubscription) (ok bool, reason string) {
	parsed, err := url.Parse(sub.Callback)
	if err != nil {
		return false, "invalid callback url"
	}

	if parsed.Host != "example.com" {
		return false, "callback host not allowed"
	}

	return true, ""
})

Sniff on published topics. (to all or one topic, as if you were subscribed)

Example:

// List the topic url as an empty string to listen to all publishes.
h.AddSniffer("https://example.com/topic1",
    func(topic, contentType string, content []byte) {
		fmt.Printf("New publish on \"https://example.com/topic1\" !")
	},
)

Publish content via method call.

Example:

// no return value
h.Publish("https://example.com/topic1", "Content-Type", []byte("Content"))

Get all topic URLs programmatically.

Example:

fmt.Printf("%#v", h.GetTopics())
// []string{"https://example.com/topic1", https://example.com/topic2", ...}

Spec conformance classes

As per the websub spec.

Subscriber conformance

The included subscriber technically does not follow the websub spec, because it does not support discovering links from HTML tags, Atom feeds, or RSS feeds.

The subscriber still discovers topics form their Link headers, so this does not impact the subscriber's interaction with the hub or publisher implemented here, but it may end up being a problem if you are planning on subscribing to other publisher implementations that don't provide Link headers for their topics.

A conforming subscriber:

Publisher conformance

A conforming publisher:

MUST advertise topic and hub URLs for a given resource URL as described in Discovery.

Publisher publishing methods

There are 2 options to publish, which are both supported by the hub:

(default) Send a POST request (as Content-Type: application/x-www-form-urlencoded) with the keys hub.mode set to publish, and hub.url & hub.topic both set to the updated URL in the body as a form.
(opt-in) Send a POST request with the same keys as above in the query string parameters, and the key hub.content equal to body. The hub will not make any request to the topic URL, and instead will distribute the body of the POST request, and associated Content-Type to subscribers. This method is disabled by default for the hub.

The updated URL is duplicated because of possible hub implementation variations.

Hub conformance

A conforming hub:

MUST accept a subscription request with the parameters hub.callback, hub.mode and hub.topic.
MUST accept a subscription request with a hub.secret parameter.
MAY respect the requested lease duration in subscription requests.
- Respects requested lease duration if it is within a configurable allowed range, otherwise it is pinned to the maximum or minimum limit.
MUST allow subscribers to re-request already active subscriptions.
MUST support unsubscription requests.
MUST send content distribution requests with a matching content type of the topic URL. (See Content Negotiation )
MUST send a X-Hub-Signature header if the subscription was made with a hub.secret as described in Authenticated Content Distribution .
MAY reduce the payload of the content distribution to a diff of the contents for supported formats as described in Content Distribution .

Hub accepted publishing methods

There are two ways for publishers to publish to the hub, which match the ones availible for the provided publisher:

Send a POST request (as Content-Type: application/x-www-form-urlencoded) with the keys hub.mode equal to publish, one or both of hub.topic and hub.url equal to the topic URL that was updated in the body as a form. If both are provided hub.topic is used. The hub makes a GET request to the topic URL and distributes the content to subscribers, with the correct Content-Type.
(disabled by default) Send a POST request with the same keys as above in the query string parameters, and the key hub.content equal to body. The hub will not make any request to the topic URL, and instead will distribute the body of the POST request, and associated Content-Type to subscribers.

NotNotQuinn/go-websub