summaryrefslogtreecommitdiff
path: root/vendor/github.com/SherClockHolmes/webpush-go/webpush.go
diff options
context:
space:
mode:
authorLibravatar Vyr Cossont <VyrCossont@users.noreply.github.com>2025-01-23 16:47:30 -0800
committerLibravatar GitHub <noreply@github.com>2025-01-23 16:47:30 -0800
commit5b765d734ee70f0a8a0790444d60969a727567f8 (patch)
treef76e05a6e5b22df17160be595c40e964bdbe5f22 /vendor/github.com/SherClockHolmes/webpush-go/webpush.go
parent[feature] Serve bot accounts over AP as Service instead of Person (#3672) (diff)
downloadgotosocial-5b765d734ee70f0a8a0790444d60969a727567f8.tar.xz
[feature] Push notifications (#3587)
* Update push subscription API model to be Mastodon 4.0 compatible * Add webpush-go dependency # Conflicts: # go.sum * Single-row table for storing instance's VAPID key pair * Generate VAPID key pair during startup * Add VAPID public key to instance info API * Return VAPID public key when registering an app * Store Web Push subscriptions in DB * Add Web Push sender (similar to email sender) * Add no-op push senders to most processor tests * Test Web Push notifications from workers * Delete Web Push subscriptions when account is deleted * Implement push subscription API * Linter fixes * Update Swagger * Fix enum to int migration * Fix GetVAPIDKeyPair * Create web push subscriptions table with indexes * Log Web Push server error messages * Send instance URL as Web Push JWT subject * Accept any 2xx code as a success * Fix malformed VAPID sub claim * Use packed notification flags * Remove unused date columns * Add notification type for update notifications Not used yet * Make GetVAPIDKeyPair idempotent and remove PutVAPIDKeyPair * Post-rebase fixes * go mod tidy * Special-case 400 errors other than 408/429 Most client errors should remove the subscription. * Improve titles, trim body to reasonable length * Disallow cleartext HTTP for Web Push servers * Fix lint * Remove redundant index on unique column Also removes redundant unique and notnull tags on ID column since these are implied by pk * Make realsender.go more readable * Use Tobi's style for wrapping errors * Restore treating all 5xx codes as temporary problems * Always load target account settings * Stub `policy` and `standard` * webpush.Sender: take type converter as ctor param * Move webpush.MockSender and noopSender into testrig
Diffstat (limited to 'vendor/github.com/SherClockHolmes/webpush-go/webpush.go')
-rw-r--r--vendor/github.com/SherClockHolmes/webpush-go/webpush.go287
1 files changed, 287 insertions, 0 deletions
diff --git a/vendor/github.com/SherClockHolmes/webpush-go/webpush.go b/vendor/github.com/SherClockHolmes/webpush-go/webpush.go
new file mode 100644
index 000000000..4c85ad638
--- /dev/null
+++ b/vendor/github.com/SherClockHolmes/webpush-go/webpush.go
@@ -0,0 +1,287 @@
+package webpush
+
+import (
+ "bytes"
+ "context"
+ "crypto/aes"
+ "crypto/cipher"
+ "crypto/elliptic"
+ "crypto/rand"
+ "crypto/sha256"
+ "encoding/base64"
+ "encoding/binary"
+ "errors"
+ "io"
+ "net/http"
+ "strconv"
+ "strings"
+ "time"
+
+ "golang.org/x/crypto/hkdf"
+)
+
+const MaxRecordSize uint32 = 4096
+
+var ErrMaxPadExceeded = errors.New("payload has exceeded the maximum length")
+
+// saltFunc generates a salt of 16 bytes
+var saltFunc = func() ([]byte, error) {
+ salt := make([]byte, 16)
+ _, err := io.ReadFull(rand.Reader, salt)
+ if err != nil {
+ return salt, err
+ }
+
+ return salt, nil
+}
+
+// HTTPClient is an interface for sending the notification HTTP request / testing
+type HTTPClient interface {
+ Do(*http.Request) (*http.Response, error)
+}
+
+// Options are config and extra params needed to send a notification
+type Options struct {
+ HTTPClient HTTPClient // Will replace with *http.Client by default if not included
+ RecordSize uint32 // Limit the record size
+ Subscriber string // Sub in VAPID JWT token
+ Topic string // Set the Topic header to collapse a pending messages (Optional)
+ TTL int // Set the TTL on the endpoint POST request
+ Urgency Urgency // Set the Urgency header to change a message priority (Optional)
+ VAPIDPublicKey string // VAPID public key, passed in VAPID Authorization header
+ VAPIDPrivateKey string // VAPID private key, used to sign VAPID JWT token
+ VapidExpiration time.Time // optional expiration for VAPID JWT token (defaults to now + 12 hours)
+}
+
+// Keys are the base64 encoded values from PushSubscription.getKey()
+type Keys struct {
+ Auth string `json:"auth"`
+ P256dh string `json:"p256dh"`
+}
+
+// Subscription represents a PushSubscription object from the Push API
+type Subscription struct {
+ Endpoint string `json:"endpoint"`
+ Keys Keys `json:"keys"`
+}
+
+// SendNotification calls SendNotificationWithContext with default context for backwards-compatibility
+func SendNotification(message []byte, s *Subscription, options *Options) (*http.Response, error) {
+ return SendNotificationWithContext(context.Background(), message, s, options)
+}
+
+// SendNotificationWithContext sends a push notification to a subscription's endpoint
+// Message Encryption for Web Push, and VAPID protocols.
+// FOR MORE INFORMATION SEE RFC8291: https://datatracker.ietf.org/doc/rfc8291
+func SendNotificationWithContext(ctx context.Context, message []byte, s *Subscription, options *Options) (*http.Response, error) {
+ // Authentication secret (auth_secret)
+ authSecret, err := decodeSubscriptionKey(s.Keys.Auth)
+ if err != nil {
+ return nil, err
+ }
+
+ // dh (Diffie Hellman)
+ dh, err := decodeSubscriptionKey(s.Keys.P256dh)
+ if err != nil {
+ return nil, err
+ }
+
+ // Generate 16 byte salt
+ salt, err := saltFunc()
+ if err != nil {
+ return nil, err
+ }
+
+ // Create the ecdh_secret shared key pair
+ curve := elliptic.P256()
+
+ // Application server key pairs (single use)
+ localPrivateKey, x, y, err := elliptic.GenerateKey(curve, rand.Reader)
+ if err != nil {
+ return nil, err
+ }
+
+ localPublicKey := elliptic.Marshal(curve, x, y)
+
+ // Combine application keys with receiver's EC public key
+ sharedX, sharedY := elliptic.Unmarshal(curve, dh)
+ if sharedX == nil {
+ return nil, errors.New("Unmarshal Error: Public key is not a valid point on the curve")
+ }
+
+ // Derive ECDH shared secret
+ sx, sy := curve.ScalarMult(sharedX, sharedY, localPrivateKey)
+ if !curve.IsOnCurve(sx, sy) {
+ return nil, errors.New("Encryption error: ECDH shared secret isn't on curve")
+ }
+ mlen := curve.Params().BitSize / 8
+ sharedECDHSecret := make([]byte, mlen)
+ sx.FillBytes(sharedECDHSecret)
+
+ hash := sha256.New
+
+ // ikm
+ prkInfoBuf := bytes.NewBuffer([]byte("WebPush: info\x00"))
+ prkInfoBuf.Write(dh)
+ prkInfoBuf.Write(localPublicKey)
+
+ prkHKDF := hkdf.New(hash, sharedECDHSecret, authSecret, prkInfoBuf.Bytes())
+ ikm, err := getHKDFKey(prkHKDF, 32)
+ if err != nil {
+ return nil, err
+ }
+
+ // Derive Content Encryption Key
+ contentEncryptionKeyInfo := []byte("Content-Encoding: aes128gcm\x00")
+ contentHKDF := hkdf.New(hash, ikm, salt, contentEncryptionKeyInfo)
+ contentEncryptionKey, err := getHKDFKey(contentHKDF, 16)
+ if err != nil {
+ return nil, err
+ }
+
+ // Derive the Nonce
+ nonceInfo := []byte("Content-Encoding: nonce\x00")
+ nonceHKDF := hkdf.New(hash, ikm, salt, nonceInfo)
+ nonce, err := getHKDFKey(nonceHKDF, 12)
+ if err != nil {
+ return nil, err
+ }
+
+ // Cipher
+ c, err := aes.NewCipher(contentEncryptionKey)
+ if err != nil {
+ return nil, err
+ }
+
+ gcm, err := cipher.NewGCM(c)
+ if err != nil {
+ return nil, err
+ }
+
+ // Get the record size
+ recordSize := options.RecordSize
+ if recordSize == 0 {
+ recordSize = MaxRecordSize
+ }
+
+ recordLength := int(recordSize) - 16
+
+ // Encryption Content-Coding Header
+ recordBuf := bytes.NewBuffer(salt)
+
+ rs := make([]byte, 4)
+ binary.BigEndian.PutUint32(rs, recordSize)
+
+ recordBuf.Write(rs)
+ recordBuf.Write([]byte{byte(len(localPublicKey))})
+ recordBuf.Write(localPublicKey)
+
+ // Data
+ dataBuf := bytes.NewBuffer(message)
+
+ // Pad content to max record size - 16 - header
+ // Padding ending delimeter
+ dataBuf.Write([]byte("\x02"))
+ if err := pad(dataBuf, recordLength-recordBuf.Len()); err != nil {
+ return nil, err
+ }
+
+ // Compose the ciphertext
+ ciphertext := gcm.Seal([]byte{}, nonce, dataBuf.Bytes(), nil)
+ recordBuf.Write(ciphertext)
+
+ // POST request
+ req, err := http.NewRequest("POST", s.Endpoint, recordBuf)
+ if err != nil {
+ return nil, err
+ }
+
+ if ctx != nil {
+ req = req.WithContext(ctx)
+ }
+
+ req.Header.Set("Content-Encoding", "aes128gcm")
+ req.Header.Set("Content-Length", strconv.Itoa(len(ciphertext)))
+ req.Header.Set("Content-Type", "application/octet-stream")
+ req.Header.Set("TTL", strconv.Itoa(options.TTL))
+
+ // Сheck the optional headers
+ if len(options.Topic) > 0 {
+ req.Header.Set("Topic", options.Topic)
+ }
+
+ if isValidUrgency(options.Urgency) {
+ req.Header.Set("Urgency", string(options.Urgency))
+ }
+
+ expiration := options.VapidExpiration
+ if expiration.IsZero() {
+ expiration = time.Now().Add(time.Hour * 12)
+ }
+
+ // Get VAPID Authorization header
+ vapidAuthHeader, err := getVAPIDAuthorizationHeader(
+ s.Endpoint,
+ options.Subscriber,
+ options.VAPIDPublicKey,
+ options.VAPIDPrivateKey,
+ expiration,
+ )
+ if err != nil {
+ return nil, err
+ }
+
+ req.Header.Set("Authorization", vapidAuthHeader)
+
+ // Send the request
+ var client HTTPClient
+ if options.HTTPClient != nil {
+ client = options.HTTPClient
+ } else {
+ client = &http.Client{}
+ }
+
+ return client.Do(req)
+}
+
+// decodeSubscriptionKey decodes a base64 subscription key.
+// if necessary, add "=" padding to the key for URL decode
+func decodeSubscriptionKey(key string) ([]byte, error) {
+ // "=" padding
+ buf := bytes.NewBufferString(key)
+ if rem := len(key) % 4; rem != 0 {
+ buf.WriteString(strings.Repeat("=", 4-rem))
+ }
+
+ bytes, err := base64.StdEncoding.DecodeString(buf.String())
+ if err == nil {
+ return bytes, nil
+ }
+
+ return base64.URLEncoding.DecodeString(buf.String())
+}
+
+// Returns a key of length "length" given an hkdf function
+func getHKDFKey(hkdf io.Reader, length int) ([]byte, error) {
+ key := make([]byte, length)
+ n, err := io.ReadFull(hkdf, key)
+ if n != len(key) || err != nil {
+ return key, err
+ }
+
+ return key, nil
+}
+
+func pad(payload *bytes.Buffer, maxPadLen int) error {
+ payloadLen := payload.Len()
+ if payloadLen > maxPadLen {
+ return ErrMaxPadExceeded
+ }
+
+ padLen := maxPadLen - payloadLen
+
+ padding := make([]byte, padLen)
+ payload.Write(padding)
+
+ return nil
+}