wip: add WEBPUSH extension

References: ircv3/ircv3-specifications#471

Author: emersion

downstream.go

@@ -13,6 +13,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/SherClockHolmes/webpush-go"
 	"github.com/emersion/go-sasl"
 	"golang.org/x/crypto/bcrypt"
 	"gopkg.in/irc.v3"
@@ -232,6 +233,7 @@ var permanentDownstreamCaps = map[string]string{
 	"soju.im/bouncer-networks":        "",
 	"soju.im/bouncer-networks-notify": "",
 	"soju.im/read":                    "",
+	"soju.im/webpush":                 "",
 }
 
 // needAllDownstreamCaps is the list of downstream capabilities that
@@ -313,7 +315,8 @@ type downstreamConn struct {
 
 	lastBatchRef uint64
 
-	monitored casemapMap
+	monitored            casemapMap
+	webPushSubscriptions []webpush.Subscription
 }
 
 func newDownstreamConn(srv *Server, ic ircConn, id uint64) *downstreamConn {
@@ -2997,6 +3000,83 @@ func (dc *downstreamConn) handleMessageRegistered(ctx context.Context, msg *irc.
 				Params:  []string{"BOUNCER", "UNKNOWN_COMMAND", subcommand, "Unknown subcommand"},
 			}}
 		}
+	case "WEBPUSH":
+		var subcommand string
+		if err := parseMessageParams(msg, &subcommand); err != nil {
+			return err
+		}
+
+		switch subcommand {
+		case "VAPIDPUBKEY":
+			dc.SendMessage(&irc.Message{
+				Prefix:  dc.srv.prefix(),
+				Command: "WEBPUSH",
+				Params:  []string{"VAPIDPUBKEY", dc.srv.vapidKeys.pub},
+			})
+		case "REGISTER":
+			var endpoint, keysStr string
+			if err := parseMessageParams(msg, nil, &endpoint, &keysStr); err != nil {
+				return err
+			}
+
+			// TODO: validate endpoint URL
+			rawKeys := irc.ParseTags(keysStr)
+			authKey, hasAuthKey := rawKeys["auth"]
+			p256dhKey, hasP256dh := rawKeys["p256dh"]
+			if !hasAuthKey || !hasP256dh {
+				return ircError{&irc.Message{
+					Command: "FAIL",
+					Params:  []string{"WEBPUSH", "INVALID_PARAMS", subcommand, "Missing auth or p256dh key"},
+				}}
+			}
+
+			keys := webpush.Keys{
+				Auth:   string(authKey),
+				P256dh: string(p256dhKey),
+			}
+
+			for i, sub := range dc.user.webPushSubscriptions {
+				if sub.Endpoint == endpoint && sub.network == dc.network {
+					dc.user.webPushSubscriptions = append(dc.user.webPushSubscriptions[:i], dc.user.webPushSubscriptions[i+1:]...)
+					break
+				}
+			}
+
+			// TODO: limit max number of subscriptions, prune old ones
+			// TODO: save the subscription in the DB
+
+			sub := &webPushSubscription{
+				Subscription: webpush.Subscription{
+					Endpoint: endpoint,
+					Keys:     keys,
+				},
+				network: dc.network,
+			}
+			dc.user.webPushSubscriptions = append(dc.user.webPushSubscriptions, sub)
+
+			dc.srv.sendWebPush(&sub.Subscription, &irc.Message{
+				Prefix:  dc.srv.prefix(),
+				Command: "NOTE",
+				Params:  []string{"WEBPUSH", "REGISTERED", "Web Push subscription created"},
+			})
+		case "UNREGISTER":
+			var endpoint string
+			if err := parseMessageParams(msg, nil, &endpoint); err != nil {
+				return err
+			}
+
+			for i, sub := range dc.user.webPushSubscriptions {
+				if sub.Endpoint == endpoint && sub.network == dc.network {
+					dc.user.webPushSubscriptions = append(dc.user.webPushSubscriptions[:i], dc.user.webPushSubscriptions[i+1:]...)
+					break
+				}
+			}
+		default:
+			return ircError{&irc.Message{
+				Command: "FAIL",
+				Params:  []string{"WEBPUSH", "INVALID_PARAMS", subcommand, "Unknown command"},
+			}}
+		}
 	default:
 		dc.logger.Printf("unhandled message: %v", msg)
 

go.mod

@@ -5,6 +5,7 @@ go 1.15
 require (
 	git.sr.ht/~emersion/go-scfg v0.0.0-20211215104734-c2c7a15d6c99
 	git.sr.ht/~sircmpwn/go-bare v0.0.0-20210406120253-ab86bc2846d9
+	github.com/SherClockHolmes/webpush-go v1.2.0 // indirect
 	github.com/emersion/go-sasl v0.0.0-20211008083017-0b9dcfb154ac
 	github.com/klauspost/compress v1.14.4 // indirect
 	github.com/lib/pq v1.10.4

go.sum

@@ -38,6 +38,8 @@ git.sr.ht/~sircmpwn/go-bare v0.0.0-20210406120253-ab86bc2846d9 h1:Ahny8Ud1LjVMMA
 git.sr.ht/~sircmpwn/go-bare v0.0.0-20210406120253-ab86bc2846d9/go.mod h1:BVJwbDfVjCjoFiKrhkei6NdGcZYpkDkdyCdg1ukytRA=
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
 github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo=
+github.com/SherClockHolmes/webpush-go v1.2.0 h1:sGv0/ZWCvb1HUH+izLqrb2i68HuqD/0Y+AmGQfyqKJA=
+github.com/SherClockHolmes/webpush-go v1.2.0/go.mod h1:w6X47YApe/B9wUz2Wh8xukxlyupaxSSEbu6yKJcHN2w=
 github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc=
 github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc=
 github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0=
@@ -94,6 +96,8 @@ github.com/gobwas/pool v0.2.0/go.mod h1:q8bcK0KcYlCgd9e7WYLm9LpyS+YeLd8JVDW6Wezm
 github.com/gobwas/ws v1.0.2 h1:CoAavW/wd/kulfZmSIBt6p24n4j7tHgNVCjsfHVNUbo=
 github.com/gobwas/ws v1.0.2/go.mod h1:szmBTxLgaFppYjEmNtny/v3w89xOydFnnZMcgRRu/EM=
 github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ=
+github.com/golang-jwt/jwt v3.2.2+incompatible h1:IfV12K8xAKAnZqdXVzCZ+TOjboZ2keLg81eXfW3O+oY=
+github.com/golang-jwt/jwt v3.2.2+incompatible/go.mod h1:8pz2t5EyA70fFQQSrl6XZXzqecmYZeUEB8OUGHkxJ+I=
 github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q=
 github.com/golang/groupcache v0.0.0-20190702054246-869f871628b6/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc=
 github.com/golang/groupcache v0.0.0-20191227052852-215e87163ea7/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc=
@@ -249,6 +253,7 @@ go.opencensus.io v0.22.2/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw=
 go.opencensus.io v0.22.3/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw=
 go.opencensus.io v0.22.4/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw=
 golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
+golang.org/x/crypto v0.0.0-20190131182504-b8fe1690c613/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
 golang.org/x/crypto v0.0.0-20190605123033-f99c8df09eb5/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=

server.go

@@ -14,6 +14,7 @@ import (
 	"sync/atomic"
 	"time"
 
+	"github.com/SherClockHolmes/webpush-go"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/promauto"
 	"gopkg.in/irc.v3"
@@ -159,6 +160,10 @@ type Server struct {
 
 		upstreamConnectErrorsTotal prometheus.Counter
 	}
+
+	vapidKeys struct {
+		priv, pub string
+	}
 }
 
 func NewServer(db Database) *Server {
@@ -191,6 +196,12 @@ func (s *Server) SetConfig(cfg *Config) {
 func (s *Server) Start() error {
 	s.registerMetrics()
 
+	priv, pub, err := webpush.GenerateVAPIDKeys()
+	if err != nil {
+		return err
+	}
+	s.vapidKeys.priv, s.vapidKeys.pub = priv, pub
+
 	users, err := s.db.ListUsers(context.TODO())
 	if err != nil {
 		return err
@@ -254,6 +265,28 @@ func (s *Server) registerMetrics() {
 	})
 }
 
+func (s *Server) sendWebPush(sub *webpush.Subscription, msg *irc.Message) {
+	options := webpush.Options{
+		VAPIDPublicKey:  s.vapidKeys.pub,
+		VAPIDPrivateKey: s.vapidKeys.priv,
+		Subscriber:      "https://soju.im",
+		TTL:             7 * 24 * 60 * 60, // seconds
+		Urgency:         webpush.UrgencyHigh,
+		RecordSize:      2048,
+	}
+
+	resp, err := webpush.SendNotification([]byte(msg.String()), sub, &options)
+	if err != nil {
+		s.Logger.Printf("failed to push notification: %v", err)
+		return
+	}
+
+	resp.Body.Close()
+	if resp.StatusCode != http.StatusCreated {
+		s.Logger.Printf("failed to push notification: HTTP error: %v", resp.Status)
+	}
+}
+
 func (s *Server) Shutdown() {
 	s.lock.Lock()
 	for ln := range s.listeners {

upstream.go

@@ -498,6 +498,9 @@ func (uc *upstreamConn) handleMessage(ctx context.Context, msg *irc.Message) err
 				if ch.DetachOn == FilterMessage || ch.DetachOn == FilterDefault || (ch.DetachOn == FilterHighlight && highlight) {
 					uc.updateChannelAutoDetach(target)
 				}
+				if highlight {
+					uc.broadcastWebPush(msg)
+				}
 			}
 
 			uc.produce(target, msg, nil)
@@ -2183,3 +2186,12 @@ func (uc *upstreamConn) updateMonitor() {
 		uc.monitored.Delete(target)
 	}
 }
+
+func (uc *upstreamConn) broadcastWebPush(msg *irc.Message) {
+	for _, sub := range uc.user.webPushSubscriptions {
+		if sub.network != uc.network {
+			continue
+		}
+		uc.srv.sendWebPush(&sub.Subscription, msg)
+	}
+}

user.go

@@ -12,6 +12,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/SherClockHolmes/webpush-go"
 	"gopkg.in/irc.v3"
 )
 
@@ -433,6 +434,11 @@ func (net *network) autoSaveSASLPlain(ctx context.Context, username, password st
 	}
 }
 
+type webPushSubscription struct {
+	webpush.Subscription
+	network *network
+}
+
 type user struct {
 	User
 	srv    *Server
@@ -444,6 +450,8 @@ type user struct {
 	networks        []*network
 	downstreamConns []*downstreamConn
 	msgStore        messageStore
+
+	webPushSubscriptions []*webPushSubscription
 }
 
 func newUser(srv *Server, record *User) *user {