A golang webfinger server implementation
Matt Baer aa4d647357 Update GoDoc badge 4 months ago
.gitignore Add .gitignore 4 months ago
LICENSE Initial commit of webfinger service 1 year ago
README.md Update GoDoc badge 4 months ago
account.go Initial commit of webfinger service 1 year ago
account_test.go Initial commit of webfinger service 1 year ago
doc.go Initial commit of webfinger service 1 year ago
error.go Initial commit of webfinger service 1 year ago
error_test.go Initial commit of webfinger service 1 year ago
http.go Send request.Host information in FindUser() call 4 months ago
http_test.go Send request.Host information in FindUser() call 4 months ago
link.go Fix JSON property for Link's Rel field 5 months ago
middleware.go Initial commit of webfinger service 1 year ago
resolver.go Send request.Host information in FindUser() call 4 months ago
resource.go Initial commit of webfinger service 1 year ago
service.go Initial commit of webfinger service 1 year ago

README.md

GoDoc

go-webfinger

go-webfinger is a golang webfinger server implementation. See v1.0 for the latest stable version, and our Code.as repo for the Write.as-specific implementation.

Past v1.0, this fork was made especially for federation support on Write.as, which includes users across write.as, *.writeas.com, and custom domains we host. The master branch contains changes specific to our implementation, and will change without notification.

Usage

webfinger.Service is implemented as a net/http handler, which means usage is simply registering the object with your http service.

Using the webfinger service as the main ServeHTTP:

myResolver = ...
wf := webfinger.Default(myResolver{})
wf.NotFoundHandler = // the rest of your app
http.ListenAndService(":8080", wf)

Using the webfinger service as a route on an existing HTTP router:

myResolver = ...
wf := webfinger.Default(myResolver{})
http.Handle(webfinger.WebFingerPath, http.HandlerFunc(wf.Webfinger))
http.ListenAndService(":8080", nil)

Defaults

The webfinger service is installed with a few defaults. Some of these defaults ensure we stick closely to the webfinger specification (tls-only, CORS, Content-Type) and other defaults are simply useful for development (no-cache)

The full list of defaults can be found in the godoc for webfinger.Service. They are exposed as public variables which can be overriden.

PreHandlers are the list of preflight HTTP handlers to run. You can add your own via wf.PreHandlers["my-custom-name"] = ..., however, execution order is not guaranteed.

TLS-Only

Handler which routes to the TLS version of the page. Disable via wf.NoTLSHandler = nil.

No-Cache

A PreFlight handler which sets no-cache headers on anything under /.well-known/webfinger. Disable or override via wf.PreHandlers[webfinger.NoCacheMiddleware]

Content Type as application/jrd+json

A PreFlight handler which sets the Content-Type to application/jrd+json. Disable or override via wf.PreHandlers[webfinger.ContentTypeMiddleware].

CORS

A PreFlight handler which adds the CORS headers. Disable or override via wf.PreHandlers[webfinger.CorsMiddleware].