1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
|
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-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
}
|