#web-push #http-ece #vapid

web-push

Web push notification client with support for http-ece encryption and VAPID authentication

24 releases

new 0.9.1 Sep 15, 2021
0.8.0 Aug 10, 2021
0.7.2 Feb 2, 2020
0.6.0 Dec 10, 2019
0.1.1 Jun 15, 2017

#19 in Web programming

Download history 51/week @ 2021-05-30 66/week @ 2021-06-06 48/week @ 2021-06-13 36/week @ 2021-06-20 248/week @ 2021-06-27 37/week @ 2021-07-04 21/week @ 2021-07-11 69/week @ 2021-07-18 142/week @ 2021-07-25 167/week @ 2021-08-01 41/week @ 2021-08-08 53/week @ 2021-08-15 61/week @ 2021-08-22 32/week @ 2021-08-29 63/week @ 2021-09-05 265/week @ 2021-09-12

352 downloads per month
Used in xorc-notifications

Apache-2.0

58KB
878 lines

Rust Web Push

Cargo tests crates.io docs.rs

Matrix chat

Web push notification sender.

Requirements

Clients require an async executor. System Openssl is needed for compilation.

Migration to greater than v0.7

  • The aesgcm variant of ContentEncoding has been removed. Aes128Gcm support was added in v0.8, so all uses of ContentEncoding::aesgcm can simply be changed to ContentEncoding::Aes128Gcm with no change to functionality. This will add support for Edge in the process.

  • WebPushClient::new() now returns a Result, as the default client now has a fallible constructor. Please handle this error in the case of resource starvation.

  • All GCM/FCM support has been removed. If you relied on this functionality, consider the fcm crate. If you just require web push, you will need to use VAPID to send payloads. See below for info.

  • A new error variant WebPushError::InvalidClaims has been added. This may break exhaustive matches.

Usage

To send a web push from command line, first subscribe to receive push notifications with your browser and store the subscription info into a json file. It should have the following content:

{
  "endpoint": "https://updates.push.services.mozilla.com/wpush/v1/TOKEN",
  "keys": {
    "auth": "####secret####",
    "p256dh": "####public_key####"
  }
}

Google has good instructions for building a frontend to receive notifications.

Store the subscription info to examples/test.json and send a notification with cargo run --example simple_send -- -f examples/test.json -p "It works!".

Example

use web_push::*;
use base64::URL_SAFE;
use std::fs::File;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
    let endpoint = "https://updates.push.services.mozilla.com/wpush/v1/...";
    let p256dh = "key_from_browser_as_base64";
    let auth = "auth_from_browser_as_base64";

    //You would likely get this by deserializing a browser `pushSubscription` object.  
    let subscription_info = SubscriptionInfo::new(
        endpoint,
        p256dh,
        auth
    );

    //Read signing material for payload.
    let file = File::open("private.pem").unwrap();
    let mut sig_builder = VapidSignatureBuilder::from_pem(file, &subscription_info)?.build()?;

    //Now add payload and encrypt.
    let mut builder = WebPushMessageBuilder::new(&subscription_info)?;
    let content = "Encrypted payload to be sent in the notification".as_bytes();
    builder.set_payload(ContentEncoding::Aes128Gcm, content);
    builder.set_vapid_signature(sig_builder);

    let client = WebPushClient::new()?;

    //Finally, send the notification!
    client.send(builder.build()?).await?;
    Ok(())
}

VAPID

VAPID authentication prevents unknown sources sending notifications to the client and is required by all current browsers when sending a payload.

The private key to be used by the server can be generated with OpenSSL:

openssl ecparam -genkey -name prime256v1 -out private_key.pem

To derive a public key from the just-generated private key, to be used in the JavaScript client:

openssl ec -in private_key.pem -pubout -outform DER|tail -c 65|base64|tr '/+' '_-'|tr -d '\n'

The signature is created with VapidSignatureBuilder. It automatically adds the required claims aud and exp. Adding these claims to the builder manually will override the default values.

Overview

Currently, the crate implements RFC8188 content encryption for notification payloads. This is done by delegating encryption to mozilla's ece crate. Our security is thus tied to theirs. The default client is built on isahc, but can be swapped out with a hyper based client using the hyper-client feature. Custom clients can be made using the request_builder module.

Library tested with Google's and Mozilla's push notification services. Also verified to work on Edge.

Openssl is needed to build. Install openssl-dev or equivalent on *nix, or openssl using vcpkg on Windows. A nix script is also available.

If installing on Windows, this is the exact command:

vcpkg integrate install
vcpkg install openssl:x64-windows-static-md

Debugging

If you get an error or the push notification doesn't work you can try to debug using the following instructions:

Add the following to your Cargo.toml:

log = "0.4"
pretty_env_logger = "0.3"

Add the following to your main.rs:

extern crate pretty_env_logger;

// ...
fn main() {
    pretty_env_logger::init();
    // ...
}

Or use any other logging library compatible with https://docs.rs/log/

Then run your program with the following environment variables:

RUST_LOG="web_push::client=trace" cargo run

This should print some more information about the requests to the push service which may aid you or somebody else in finding the error.

Dependencies

~29MB
~510K SLoC