ntfy/server/server_web_push.go

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

136 lines
5 KiB
Go
Raw Normal View History

2023-05-31 05:56:10 +12:00
package server
import (
"encoding/json"
"fmt"
"net/http"
"regexp"
2023-05-31 05:56:10 +12:00
"github.com/SherClockHolmes/webpush-go"
"heckel.io/ntfy/log"
"heckel.io/ntfy/user"
2023-05-31 05:56:10 +12:00
)
// test: https://regexr.com/7eqvl
// example urls:
//
// https://android.googleapis.com/XYZ
// https://fcm.googleapis.com/XYZ
// https://updates.push.services.mozilla.com/XYZ
// https://updates-autopush.stage.mozaws.net/XYZ
// https://updates-autopush.dev.mozaws.net/XYZ
// https://AAA.notify.windows.com/XYZ
// https://AAA.push.apple.com/XYZ
const (
webPushEndpointAllowRegexStr = `^https:\/\/(android\.googleapis\.com|fcm\.googleapis\.com|updates\.push\.services\.mozilla\.com|updates-autopush\.stage\.mozaws\.net|updates-autopush\.dev\.mozaws\.net|.*\.notify\.windows\.com|.*\.push\.apple\.com)\/.*$`
webPushTopicSubscribeLimit = 50
)
var webPushEndpointAllowRegex = regexp.MustCompile(webPushEndpointAllowRegexStr)
func (s *Server) handleWebPushUpdate(w http.ResponseWriter, r *http.Request, v *visitor) error {
2023-06-09 15:09:38 +12:00
req, err := readJSONWithLimit[apiWebPushUpdateSubscriptionRequest](r.Body, jsonBodyBytesLimit, false)
if err != nil || req.Endpoint == "" || req.P256dh == "" || req.Auth == "" {
2023-05-31 05:56:10 +12:00
return errHTTPBadRequestWebPushSubscriptionInvalid
2023-06-09 15:09:38 +12:00
} else if !webPushEndpointAllowRegex.MatchString(req.Endpoint) {
return errHTTPBadRequestWebPushEndpointUnknown
2023-06-09 15:09:38 +12:00
} else if len(req.Topics) > webPushTopicSubscribeLimit {
return errHTTPBadRequestWebPushTopicCountTooHigh
}
2023-06-09 15:09:38 +12:00
topics, err := s.topicsFromIDs(req.Topics...)
2023-05-31 05:56:10 +12:00
if err != nil {
return err
2023-05-31 05:56:10 +12:00
}
if s.userManager != nil {
2023-06-09 04:20:12 +12:00
u := v.User()
for _, t := range topics {
if err := s.userManager.Authorize(u, t.ID, user.PermissionRead); err != nil {
logvr(v, r).With(t).Err(err).Debug("Access to topic %s not authorized", t.ID)
return errHTTPForbidden.With(t)
}
}
2023-05-31 05:56:10 +12:00
}
2023-06-09 15:09:38 +12:00
if err := s.webPush.UpsertSubscription(req.Endpoint, req.Topics, v.MaybeUserID(), req.Auth, req.P256dh); err != nil {
2023-05-31 05:56:10 +12:00
return err
}
return s.writeJSON(w, newSuccessResponse())
}
func (s *Server) publishToWebPushEndpoints(v *visitor, m *message) {
2023-05-31 06:23:03 +12:00
subscriptions, err := s.webPush.SubscriptionsForTopic(m.Topic)
2023-05-31 05:56:10 +12:00
if err != nil {
logvm(v, m).Err(err).Warn("Unable to publish web push messages")
return
}
2023-06-09 04:20:12 +12:00
payload, err := json.Marshal(newWebPushPayload(fmt.Sprintf("%s/%s", s.config.BaseURL, m.Topic), m))
if err != nil {
log.Tag(tagWebPush).Err(err).Warn("Unable to marshal expiring payload")
return
}
for _, subscription := range subscriptions {
2023-06-09 15:09:38 +12:00
ctx := log.Context{"endpoint": subscription.Endpoint, "username": subscription.UserID, "topic": m.Topic, "message_id": m.ID}
2023-06-09 04:20:12 +12:00
if err := s.sendWebPushNotification(payload, subscription, &ctx); err != nil {
log.Tag(tagWebPush).Err(err).Fields(ctx).Warn("Unable to publish web push message")
}
2023-06-03 00:45:05 +12:00
}
}
2023-05-31 05:56:10 +12:00
func (s *Server) pruneOrNotifyWebPushSubscriptions() {
if s.config.WebPushPublicKey == "" {
return
}
go func() {
if err := s.pruneOrNotifyWebPushSubscriptionsInternal(); err != nil {
log.Tag(tagWebPush).Err(err).Warn("Unable to prune or notify web push subscriptions")
}
}()
}
func (s *Server) pruneOrNotifyWebPushSubscriptionsInternal() error {
2023-06-03 00:45:05 +12:00
subscriptions, err := s.webPush.ExpireAndGetExpiringSubscriptions(s.config.WebPushExpiryWarningDuration, s.config.WebPushExpiryDuration)
if err != nil {
log.Tag(tagWebPush).Err(err).Warn("Unable to publish expiry imminent warning")
return err
2023-06-09 04:20:12 +12:00
} else if len(subscriptions) == 0 {
return nil
2023-06-03 00:45:05 +12:00
}
2023-06-09 04:20:12 +12:00
payload, err := json.Marshal(newWebPushSubscriptionExpiringPayload())
2023-06-03 00:45:05 +12:00
if err != nil {
2023-06-09 04:20:12 +12:00
log.Tag(tagWebPush).Err(err).Warn("Unable to marshal expiring payload")
return err
2023-06-03 00:45:05 +12:00
}
for _, subscription := range subscriptions {
2023-06-09 15:09:38 +12:00
ctx := log.Context{"endpoint": subscription.Endpoint}
if err := s.sendWebPushNotification(payload, subscription, &ctx); err != nil {
log.Tag(tagWebPush).Err(err).Fields(ctx).Warn("Unable to publish expiry imminent warning")
return err
2023-06-09 04:20:12 +12:00
}
}
2023-06-09 04:20:12 +12:00
log.Tag(tagWebPush).Debug("Expiring old subscriptions and published %d expiry imminent warnings", len(subscriptions))
return nil
2023-06-09 04:20:12 +12:00
}
2023-06-03 00:45:05 +12:00
2023-06-09 04:20:12 +12:00
func (s *Server) sendWebPushNotification(message []byte, sub *webPushSubscription, ctx *log.Context) error {
2023-06-09 15:09:38 +12:00
resp, err := webpush.SendNotification(message, sub.ToSubscription(), &webpush.Options{
2023-06-03 00:45:05 +12:00
Subscriber: s.config.WebPushEmailAddress,
VAPIDPublicKey: s.config.WebPushPublicKey,
VAPIDPrivateKey: s.config.WebPushPrivateKey,
2023-06-09 04:20:12 +12:00
Urgency: webpush.UrgencyHigh, // iOS requires this to ensure delivery
2023-06-03 00:45:05 +12:00
})
if err != nil {
2023-06-09 04:20:12 +12:00
log.Tag(tagWebPush).Err(err).Fields(*ctx).Debug("Unable to publish web push message, removing endpoint")
2023-06-09 15:09:38 +12:00
if err := s.webPush.RemoveSubscriptionsByEndpoint(sub.Endpoint); err != nil {
2023-06-09 04:20:12 +12:00
return err
2023-06-03 00:45:05 +12:00
}
2023-06-09 04:20:12 +12:00
return err
2023-06-03 00:45:05 +12:00
}
2023-06-09 04:20:12 +12:00
if (resp.StatusCode < 200 || resp.StatusCode > 299) && resp.StatusCode != 429 {
log.Tag(tagWebPush).Fields(*ctx).Field("response_code", resp.StatusCode).Debug("Unable to publish web push message, unexpected response")
2023-06-09 15:09:38 +12:00
if err := s.webPush.RemoveSubscriptionsByEndpoint(sub.Endpoint); err != nil {
2023-06-09 04:20:12 +12:00
return err
2023-06-03 00:45:05 +12:00
}
2023-06-09 04:20:12 +12:00
return errHTTPInternalErrorWebPushUnableToPublish.Fields(*ctx)
2023-06-03 00:45:05 +12:00
}
2023-06-09 04:20:12 +12:00
return nil
2023-05-31 05:56:10 +12:00
}