SherClockHolmes / webpush-go

Web Push API Encryption with VAPID support.
MIT License
325 stars 68 forks source link
vapid webpush

webpush-go

Go Report Card GoDoc

Web Push API Encryption with VAPID support.

go get -u github.com/SherClockHolmes/webpush-go

Example

For a full example, refer to the code in the example directory.

package main

import (
    "encoding/json"

    webpush "github.com/SherClockHolmes/webpush-go"
)

func main() {
    // Decode subscription
    s := &webpush.Subscription{}
    json.Unmarshal([]byte("<YOUR_SUBSCRIPTION>"), s)

    // Send Notification
    resp, err := webpush.SendNotification([]byte("Test"), s, &webpush.Options{
        Subscriber:      "example@example.com",
        VAPIDPublicKey:  "<YOUR_VAPID_PUBLIC_KEY>",
        VAPIDPrivateKey: "<YOUR_VAPID_PRIVATE_KEY>",
        TTL:             30,
    })
    if err != nil {
        // TODO: Handle error
    }
    defer resp.Body.Close()
}

Generating VAPID Keys

Use the helper method GenerateVAPIDKeys to generate the VAPID key pair.

privateKey, publicKey, err := webpush.GenerateVAPIDKeys()
if err != nil {
    // TODO: Handle error
}

Development

  1. Install Go 1.11+
  2. go mod vendor
  3. go test

For other language implementations visit:

WebPush Libs