pywebpush 2.1.2__tar.gz → 2.2.0__tar.gz

{pywebpush-2.1.2 → pywebpush-2.2.0}/CHANGELOG.md

@@ -1,6 +1,20 @@
 # I am terrible at keeping this up-to-date.
 
+## 2.2.0 (2026-)
+
+- Update `rst` files to reflect `md` file changes
+
+Add comment discussing additional work for Windows Notification Service (WNS)
+
+- Update the README.md file to mention the required, non-standard headers.
+
+_BREAKING_CHANGE_
+This version also drops legacy support for GCM/FCM authorization keys, since those items
+are obsolete according to Google.
+See https://firebase.google.com/docs/cloud-messaging/auth-server#authorize-legacy-protocol-send-requests
+
 ## 2.1.2 (2025-11-10)
+
 chore: fix formatting
 chore: update CHANGELOG
 chore: note admin update

{pywebpush-2.1.2 → pywebpush-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pywebpush
-Version: 2.1.2
+Version: 2.2.0
 Summary: WebPush publication library
 Author-email: JR Conlin <src+webpusher@jrconlin.com>
 License: MPL-2.0
@@ -10,6 +10,7 @@ Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: aiohttp
@@ -26,9 +27,6 @@ Dynamic: license-file
 
 # Webpush Data encryption library for Python
 
-[![Build Status](https://travis-ci.org/web-push-libs/pywebpush.svg?branch=main)](https://travis-ci.org/web-push-libs/pywebpush)
-[![Requirements Status](https://requires.io/github/web-push-libs/pywebpush/requirements.svg?branch=main)](https://requires.io/github/web-push-libs/pywebpush/requirements/?branch=main)
-
 This library is available on [pypi as pywebpush](https://pypi.python.org/pypi/pywebpush).
 Source is available on [github](https://github.com/mozilla-services/pywebpush).
 Please note: This library was designated as a `Critical Project` by PyPi, it is currently
@@ -64,6 +62,11 @@ referenced to the user who requested it, and recall it when there's
 a new push subscription update is left as an exercise for the
 reader.
 
+_*Note:*_ Some platforms (like Microsoft Windows) require additional
+headers specified for the Push call. These additional headers are not
+standard and may be rejected by other Push services. Please see
+[Special Instructions](#special-instructions) below.
+
 ### Sending Data using `webpush()` One Call
 
 In many cases, your code will be sending a single message to many
@@ -82,7 +85,7 @@ webpush(subscription_info,
 This will encode `data`, add the appropriate VAPID auth headers if required and send it to the push server identified
 in the `subscription_info` block.
 
-##### Parameters
+#### Parameters
 
 _subscription_info_ - The `dict` of the subscription info (described above).
 
@@ -107,7 +110,7 @@ e.g. the output of:
 openssl ecparam -name prime256v1 -genkey -noout -out private_key.pem
 ```
 
-##### Example
+#### Example
 
 ```python
 from pywebpush import webpush, WebPushException
@@ -145,7 +148,7 @@ can pass just `wp = WebPusher(subscription_info)`. This will return a `WebPusher
 
 The following methods are available:
 
-#### `.send(data, headers={}, ttl=0, gcm_key="", reg_id="", content_encoding="aes128gcm", curl=False, timeout=None)`
+#### `.send(data, headers={}, ttl=0, reg_id="", content_encoding="aes128gcm", curl=False, timeout=None)`
 
 Send the data using additional parameters. On error, returns a `WebPushException`
 
@@ -157,9 +160,6 @@ _headers_ A `dict` containing any additional headers to send
 
 _ttl_ Message Time To Live on Push Server waiting for the client to reconnect (in seconds)
 
-_gcm_key_ Google Cloud Messaging key (if using the older GCM push system) This is the API key obtained from the Google
-Developer Console.
-
 _reg_id_ Google Cloud Messaging registration ID (will be extracted from endpoint if not specified)
 
 _content_encoding_ ECE content encoding type (defaults to "aes128gcm")
@@ -172,10 +172,10 @@ See [requests documentation](http://docs.python-requests.org/en/master/user/quic
 
 ##### Example
 
-to send from Chrome using the old GCM mode:
+to send to a user on Chrome:
 
 ```python
-WebPusher(subscription_info).send(data, headers, ttl, gcm_key)
+WebPusher(subscription_info).send(data, headers, ttl)
 ```
 
 #### `.encode(data, content_encoding="aes128gcm")`
@@ -188,7 +188,7 @@ _data_ Binary string of data to send
 
 _content_encoding_ ECE content encoding type (defaults to "aes128gcm")
 
-*Note* This will return a `NoData` exception if the data is not present or empty. It is completely
+_*Note*_ This will return a `NoData` exception if the data is not present or empty. It is completely
 valid to send a WebPush notification with no data, but encoding is a no-op in that case. Best not
 to call it if you don't have data.
 
@@ -200,8 +200,7 @@ encoded_data = WebPush(subscription_info).encode(data)
 
 ## Stand Alone Webpush
 
-If you're not really into coding your own solution, there's also a "stand-alone" `pywebpush` command in the
-./bin directory.
+If you're not really into coding your own solution, there's also a "stand-alone" `pywebpush` command in the `./bin` directory.
 
 This uses two files:
 
@@ -227,3 +226,40 @@ If you're interested in just testing your applications WebPush interface, you co
 which will encrypt and send the contents of `stuff_to_send.data`.
 
 See `./bin/pywebpush --help` for available commands and options.
+
+## Special Instructions
+
+### Windows
+
+[Microsoft requires](https://learn.microsoft.com/en-us/windows/apps/design/shell/tiles-and-notifications/push-request-response-headers#request-parameters)
+one extra header and suggests several additional headers. Users have reported that not including
+these headers can cause notifications to fail to appear. These additional headers are non-standard
+and may be rejected by other platforms. You should be cautious including them with calls to
+non-Microsoft platforms, or to non-Microsoft destinations.
+
+As of 2024-Apr-19, Microsoft requires an `X-WNS-Type` header. As an example, you can include this
+header within the command line call:
+
+Content of the `windows_headers.json` file:
+
+```json
+{"X-WNS-Type":"wns/toast", "TTL":600, "Content-Type": "text/xml"}
+```
+
+_*Note*_ : This includes both the `TTL` set to 10 minutes and the required matching `Content-Type` header for `wns/toast`.
+
+```bash
+pywebpush --data stuff_to_send.xml \
+   --info edge_user_info.json \
+   --head windows_headers.json \
+   --claims vapid_claims.json
+```
+
+### Google Cloud Messaging (GCM)
+
+Please note that GCM has been sunset by Google. Providers should
+use [Firebase Cloud Messaging](https://firebase.google.com/support/troubleshooter/fcm/tokens/gcm) instead.
+
+Please also note that sending messages directly to FCM is not supported by this library. In the past, you could use an insecure `gcm_key` as a proxy for the authentication service. [This was disabled in June 2024](https://firebase.google.com/docs/cloud-messaging/auth-server#authorize-legacy-protocol-send-requests).
+
+Sending WebPush messages to Google Chrome users should not be impacted by this change.

{pywebpush-2.1.2 → pywebpush-2.2.0}/README.md

@@ -1,8 +1,5 @@
 # Webpush Data encryption library for Python
 
-[![Build Status](https://travis-ci.org/web-push-libs/pywebpush.svg?branch=main)](https://travis-ci.org/web-push-libs/pywebpush)
-[![Requirements Status](https://requires.io/github/web-push-libs/pywebpush/requirements.svg?branch=main)](https://requires.io/github/web-push-libs/pywebpush/requirements/?branch=main)
-
 This library is available on [pypi as pywebpush](https://pypi.python.org/pypi/pywebpush).
 Source is available on [github](https://github.com/mozilla-services/pywebpush).
 Please note: This library was designated as a `Critical Project` by PyPi, it is currently
@@ -38,6 +35,11 @@ referenced to the user who requested it, and recall it when there's
 a new push subscription update is left as an exercise for the
 reader.
 
+_*Note:*_ Some platforms (like Microsoft Windows) require additional
+headers specified for the Push call. These additional headers are not
+standard and may be rejected by other Push services. Please see
+[Special Instructions](#special-instructions) below.
+
 ### Sending Data using `webpush()` One Call
 
 In many cases, your code will be sending a single message to many
@@ -56,7 +58,7 @@ webpush(subscription_info,
 This will encode `data`, add the appropriate VAPID auth headers if required and send it to the push server identified
 in the `subscription_info` block.
 
-##### Parameters
+#### Parameters
 
 _subscription_info_ - The `dict` of the subscription info (described above).
 
@@ -81,7 +83,7 @@ e.g. the output of:
 openssl ecparam -name prime256v1 -genkey -noout -out private_key.pem
 ```
 
-##### Example
+#### Example
 
 ```python
 from pywebpush import webpush, WebPushException
@@ -119,7 +121,7 @@ can pass just `wp = WebPusher(subscription_info)`. This will return a `WebPusher
 
 The following methods are available:
 
-#### `.send(data, headers={}, ttl=0, gcm_key="", reg_id="", content_encoding="aes128gcm", curl=False, timeout=None)`
+#### `.send(data, headers={}, ttl=0, reg_id="", content_encoding="aes128gcm", curl=False, timeout=None)`
 
 Send the data using additional parameters. On error, returns a `WebPushException`
 
@@ -131,9 +133,6 @@ _headers_ A `dict` containing any additional headers to send
 
 _ttl_ Message Time To Live on Push Server waiting for the client to reconnect (in seconds)
 
-_gcm_key_ Google Cloud Messaging key (if using the older GCM push system) This is the API key obtained from the Google
-Developer Console.
-
 _reg_id_ Google Cloud Messaging registration ID (will be extracted from endpoint if not specified)
 
 _content_encoding_ ECE content encoding type (defaults to "aes128gcm")
@@ -146,10 +145,10 @@ See [requests documentation](http://docs.python-requests.org/en/master/user/quic
 
 ##### Example
 
-to send from Chrome using the old GCM mode:
+to send to a user on Chrome:
 
 ```python
-WebPusher(subscription_info).send(data, headers, ttl, gcm_key)
+WebPusher(subscription_info).send(data, headers, ttl)
 ```
 
 #### `.encode(data, content_encoding="aes128gcm")`
@@ -162,7 +161,7 @@ _data_ Binary string of data to send
 
 _content_encoding_ ECE content encoding type (defaults to "aes128gcm")
 
-*Note* This will return a `NoData` exception if the data is not present or empty. It is completely
+_*Note*_ This will return a `NoData` exception if the data is not present or empty. It is completely
 valid to send a WebPush notification with no data, but encoding is a no-op in that case. Best not
 to call it if you don't have data.
 
@@ -174,8 +173,7 @@ encoded_data = WebPush(subscription_info).encode(data)
 
 ## Stand Alone Webpush
 
-If you're not really into coding your own solution, there's also a "stand-alone" `pywebpush` command in the
-./bin directory.
+If you're not really into coding your own solution, there's also a "stand-alone" `pywebpush` command in the `./bin` directory.
 
 This uses two files:
 
@@ -201,3 +199,40 @@ If you're interested in just testing your applications WebPush interface, you co
 which will encrypt and send the contents of `stuff_to_send.data`.
 
 See `./bin/pywebpush --help` for available commands and options.
+
+## Special Instructions
+
+### Windows
+
+[Microsoft requires](https://learn.microsoft.com/en-us/windows/apps/design/shell/tiles-and-notifications/push-request-response-headers#request-parameters)
+one extra header and suggests several additional headers. Users have reported that not including
+these headers can cause notifications to fail to appear. These additional headers are non-standard
+and may be rejected by other platforms. You should be cautious including them with calls to
+non-Microsoft platforms, or to non-Microsoft destinations.
+
+As of 2024-Apr-19, Microsoft requires an `X-WNS-Type` header. As an example, you can include this
+header within the command line call:
+
+Content of the `windows_headers.json` file:
+
+```json
+{"X-WNS-Type":"wns/toast", "TTL":600, "Content-Type": "text/xml"}
+```
+
+_*Note*_ : This includes both the `TTL` set to 10 minutes and the required matching `Content-Type` header for `wns/toast`.
+
+```bash
+pywebpush --data stuff_to_send.xml \
+   --info edge_user_info.json \
+   --head windows_headers.json \
+   --claims vapid_claims.json
+```
+
+### Google Cloud Messaging (GCM)
+
+Please note that GCM has been sunset by Google. Providers should
+use [Firebase Cloud Messaging](https://firebase.google.com/support/troubleshooter/fcm/tokens/gcm) instead.
+
+Please also note that sending messages directly to FCM is not supported by this library. In the past, you could use an insecure `gcm_key` as a proxy for the authentication service. [This was disabled in June 2024](https://firebase.google.com/docs/cloud-messaging/auth-server#authorize-legacy-protocol-send-requests).
+
+Sending WebPush messages to Google Chrome users should not be impacted by this change.

{pywebpush-2.1.2 → pywebpush-2.2.0}/README.rst

@@ -1,8 +1,6 @@
 Webpush Data encryption library for Python
 ==========================================
 
-|Build Status| |Requirements Status|
-
 This library is available on `pypi as
 pywebpush <https://pypi.python.org/pypi/pywebpush>`__. Source is
 available on `github <https://github.com/mozilla-services/pywebpush>`__.
@@ -14,12 +12,8 @@ make of that what you will.
 Installation
 ------------
 
-You’ll need to run ``python -m venv venv``. Then
-
-.. code:: bash
-
-   venv/bin/pip install -r requirements.txt
-   venv/bin/python -m pip install -e .
+To work with this repo locally, you’ll need to run
+``python -m venv venv``. Then ``venv/bin/pip install --editable .``
 
 Usage
 -----
@@ -35,12 +29,20 @@ As illustration, a ``subscription_info`` object may look like:
 
 .. code:: json
 
-   {"endpoint": "https://updates.push.services.mozilla.com/push/v1/gAA...", "keys": {"auth": "k8J...", "p256dh": "BOr..."}}
+   {
+     "endpoint": "https://updates.push.services.mozilla.com/push/v1/gAA...",
+     "keys": { "auth": "k8J...", "p256dh": "BOr..." }
+   }
 
 How you send the PushSubscription data to your backend, store it
 referenced to the user who requested it, and recall it when there’s a
 new push subscription update is left as an exercise for the reader.
 
+*Note:* Some platforms (like Microsoft Windows) require additional
+headers specified for the Push call. These additional headers are not
+standard and may be rejected by other Push services. Please see `Special
+Instructions <#special-instructions>`__ below.
+
 Sending Data using ``webpush()`` One Call
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -60,7 +62,8 @@ This will encode ``data``, add the appropriate VAPID auth headers if
 required and send it to the push server identified in the
 ``subscription_info`` block.
 
-**Parameters**
+Parameters
+^^^^^^^^^^
 
 *subscription_info* - The ``dict`` of the subscription info (described
 above).
@@ -78,7 +81,9 @@ standard form.
 authorization (See
 `py_vapid <https://github.com/web-push-libs/vapid/tree/master/python>`__
 for more details). If ``aud`` is not specified, pywebpush will attempt
-to auto-fill from the ``endpoint``.
+to auto-fill from the ``endpoint``. If ``exp`` is not specified or set
+in the past, it will be set to 12 hours from now. In both cases, the
+passed ``dict`` **will be mutated** after the call.
 
 *vapid_private_key* - Either a path to a VAPID EC2 private key PEM file,
 or a string containing the DER representation. (See
@@ -93,7 +98,8 @@ e.g. the output of:
 
    openssl ecparam -name prime256v1 -genkey -noout -out private_key.pem
 
-**Example**
+Example
+^^^^^^^
 
 .. code:: python
 
@@ -134,13 +140,16 @@ object.
 
 The following methods are available:
 
-``.send(data, headers={}, ttl=0, gcm_key="", reg_id="", content_encoding="aes128gcm", curl=False, timeout=None)``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+``.send(data, headers={}, ttl=0, reg_id="", content_encoding="aes128gcm", curl=False, timeout=None)``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Send the data using additional parameters. On error, returns a
 ``WebPushException``
 
-**Parameters**
+.. _parameters-1:
+
+Parameters
+''''''''''
 
 *data* Binary string of data to send
 
@@ -149,9 +158,6 @@ Send the data using additional parameters. On error, returns a
 *ttl* Message Time To Live on Push Server waiting for the client to
 reconnect (in seconds)
 
-*gcm_key* Google Cloud Messaging key (if using the older GCM push
-system) This is the API key obtained from the Google Developer Console.
-
 *reg_id* Google Cloud Messaging registration ID (will be extracted from
 endpoint if not specified)
 
@@ -165,13 +171,16 @@ purposes.
 *timeout* timeout for requests POST query. See `requests
 documentation <http://docs.python-requests.org/en/master/user/quickstart/#timeouts>`__.
 
-**Example**
+.. _example-1:
 
-to send from Chrome using the old GCM mode:
+Example
+'''''''
+
+to send to a user on Chrome:
 
 .. code:: python
 
-   WebPusher(subscription_info).send(data, headers, ttl, gcm_key)
+   WebPusher(subscription_info).send(data, headers, ttl)
 
 ``.encode(data, content_encoding="aes128gcm")``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -179,13 +188,24 @@ to send from Chrome using the old GCM mode:
 Encode the ``data`` for future use. On error, returns a
 ``WebPushException``
 
-**Parameters**
+.. _parameters-2:
+
+Parameters
+''''''''''
 
 *data* Binary string of data to send
 
 *content_encoding* ECE content encoding type (defaults to “aes128gcm”)
 
-**Example**
+*Note* This will return a ``NoData`` exception if the data is not
+present or empty. It is completely valid to send a WebPush notification
+with no data, but encoding is a no-op in that case. Best not to call it
+if you don’t have data.
+
+.. _example-2:
+
+Example
+'''''''
 
 .. code:: python
 
@@ -195,7 +215,7 @@ Stand Alone Webpush
 -------------------
 
 If you’re not really into coding your own solution, there’s also a
-“stand-alone” ``pywebpush`` command in the ./bin directory.
+“stand-alone” ``pywebpush`` command in the ``./bin`` directory.
 
 This uses two files:
 
@@ -207,11 +227,13 @@ This uses two files:
 
 .. code:: json
 
-   {"endpoint": "https://push...",
-    "keys": {
-        "auth": "ab01...",
-        "p256dh": "aa02..."
-    }}
+   {
+     "endpoint": "https://push...",
+     "keys": {
+       "auth": "ab01...",
+       "p256dh": "aa02..."
+     }
+   }
 
 If you’re interested in just testing your applications WebPush
 interface, you could use the Command Line:
@@ -224,7 +246,51 @@ which will encrypt and send the contents of ``stuff_to_send.data``.
 
 See ``./bin/pywebpush --help`` for available commands and options.
 
-.. |Build Status| image:: https://travis-ci.org/web-push-libs/pywebpush.svg?branch=main
-   :target: https://travis-ci.org/web-push-libs/pywebpush
-.. |Requirements Status| image:: https://requires.io/github/web-push-libs/pywebpush/requirements.svg?branch=main
-   :target: https://requires.io/github/web-push-libs/pywebpush/requirements/?branch=main
+Special Instructions
+--------------------
+
+Windows
+~~~~~~~
+
+`Microsoft
+requires <https://learn.microsoft.com/en-us/windows/apps/design/shell/tiles-and-notifications/push-request-response-headers#request-parameters>`__
+one extra header and suggests several additional headers. Users have
+reported that not including these headers can cause notifications to
+fail to appear. These additional headers are non-standard and may be
+rejected by other platforms. You should be cautious including them with
+calls to non-Microsoft platforms, or to non-Microsoft destinations.
+
+As of 2024-Apr-19, Microsoft requires an ``X-WNS-Type`` header. As an
+example, you can include this header within the command line call:
+
+Content of the ``windows_headers.json`` file:
+
+.. code:: json
+
+   {"X-WNS-Type":"wns/toast", "TTL":600, "Content-Type": "text/xml"}
+
+*Note* : This includes both the ``TTL`` set to 10 minutes and the
+required matching ``Content-Type`` header for ``wns/toast``.
+
+.. code:: bash
+
+   pywebpush --data stuff_to_send.xml \
+      --info edge_user_info.json \
+      --head windows_headers.json \
+      --claims vapid_claims.json
+
+Google Cloud Messaging (GCM)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Please note that GCM has been sunset by Google. Providers should use
+`Firebase Cloud
+Messaging <https://firebase.google.com/support/troubleshooter/fcm/tokens/gcm>`__
+instead.
+
+Please also note that sending messages directly to FCM is not supported
+by this library. In the past, you could use an insecure ``gcm_key`` as a
+proxy for the authentication service. `This was disabled in June
+2024 <https://firebase.google.com/docs/cloud-messaging/auth-server#authorize-legacy-protocol-send-requests>`__.
+
+Sending WebPush messages to Google Chrome users should not be impacted
+by this change.

{pywebpush-2.1.2 → pywebpush-2.2.0}/pyproject.toml

@@ -9,7 +9,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pywebpush"
-version = "2.1.2"
+version = "2.2.0"
+requires-python = ">= 3.10"
 license = { text = "MPL-2.0" }
 authors = [{ name = "JR Conlin", email = "src+webpusher@jrconlin.com" }]
 description = "WebPush publication library"

{pywebpush-2.1.2 → pywebpush-2.2.0}/pywebpush/__init__.py

@@ -19,7 +19,6 @@ except ImportError:  # pragma nocover
 import aiohttp
 import http_ece
 import requests
-import six
 from cryptography.hazmat.backends import default_backend
 from cryptography.hazmat.primitives.asymmetric import ec
 from cryptography.hazmat.primitives import serialization
@@ -175,7 +174,7 @@ class WebPusher:
             for k in ["p256dh", "auth"]:
                 if keys.get(k) is None:
                     raise WebPushException("Missing keys value: {}".format(k))
-                if isinstance(keys[k], six.text_type):
+                if isinstance(keys[k], str):
                     keys[k] = bytes(cast(str, keys[k]).encode("utf8"))
             receiver_raw = base64.urlsafe_b64decode(
                 self._repad(cast(bytes, keys["p256dh"]))
@@ -236,7 +235,7 @@ class WebPusher:
             format=serialization.PublicFormat.UncompressedPoint,
         )
 
-        if isinstance(data, six.text_type):
+        if isinstance(data, str):
             data = bytes(data.encode("utf8"))
         if content_encoding == "aes128gcm":
             self.verb("Encrypting to aes128gcm...")
@@ -304,10 +303,7 @@ class WebPusher:
         data: Union[None, bytes] = None,
         headers: Union[None, Dict[str, str]] = None,
         ttl: int = 0,
-        gcm_key: Union[None, str] = None,
-        reg_id: Union[None, str] = None,
         content_encoding: str = "aes128gcm",
-        curl: bool = False,
     ) -> dict:
         """Encode and send the data to the Push Service.
 
@@ -319,16 +315,8 @@ class WebPusher:
             recipient is not online. (Defaults to "0", which discards the
             message immediately if the recipient is unavailable.)
         :type ttl: int
-        :param gcm_key: API key obtained from the Google Developer Console.
-            Needed if endpoint is https://android.googleapis.com/gcm/send
-        :type gcm_key: string
-        :param reg_id: registration id of the recipient. If not provided,
-            it will be extracted from the endpoint.
-        :type reg_id: str
         :param content_encoding: ECE content encoding (defaults to "aes128gcm")
         :type content_encoding: str
-        :param curl: Display output as `curl` command instead of sending
-        :type curl: bool
         """
         # Encode the data.
         if headers is None:
@@ -355,40 +343,8 @@ class WebPusher:
                     "content-encoding": content_encoding,
                 }
             )
-        if gcm_key:
-            # guess if it is a legacy GCM project key or actual FCM key
-            # gcm keys are all about 40 chars (use 100 for confidence),
-            # fcm keys are 153-175 chars
-            if len(gcm_key) < 100:
-                self.verb("Guessing this is legacy GCM...")
-                endpoint = "https://android.googleapis.com/gcm/send"
-            else:
-                self.verb("Guessing this is FCM...")
-                endpoint = "https://fcm.googleapis.com/fcm/send"
-            reg_ids = []
-            if not reg_id:
-                reg_id = cast(str, self.subscription_info["endpoint"]).rsplit("/", 1)[
-                    -1
-                ]
-                self.verb("Fetching out registration id: {}", reg_id)
-            reg_ids.append(reg_id)
-            gcm_data = dict()
-            gcm_data["registration_ids"] = reg_ids
-            if data:
-                buffer = encoded.get("body")
-                if buffer:
-                    gcm_data["raw_data"] = base64.b64encode(buffer).decode("utf8")
-            gcm_data["time_to_live"] = int(headers["ttl"] if "ttl" in headers else ttl)
-            encoded_data = json.dumps(gcm_data)
-            headers.update(
-                {
-                    "Authorization": "key=" + gcm_key,
-                    "Content-Type": "application/json",
-                }
-            )
-        else:
-            encoded_data = encoded.get("body")
-            endpoint = self.subscription_info["endpoint"]
+        encoded_data = encoded.get("body")
+        endpoint = self.subscription_info["endpoint"]
 
         if "ttl" not in headers or ttl:
             self.verb("Generating TTL of 0...")
@@ -424,9 +380,10 @@ class WebPusher:
             **params,
         )
         self.verb(
-            "\nResponse:\n\tcode: {}\n\tbody: {}\n",
+            "\nResponse:\n\tcode: {}\n\tbody: {}\n\theaders: {}",
             resp.status_code,
             resp.text or "Empty",
+            resp.headers or "None"
         )
         return resp
 

{pywebpush-2.1.2 → pywebpush-2.2.0}/pywebpush/__main__.py

@@ -2,6 +2,7 @@ import argparse
 import os
 import json
 import logging
+import math
 
 from requests import JSONDecodeError
 
@@ -15,6 +16,11 @@ def get_config():
     parser.add_argument("--head", help="Header Info JSON file")
     parser.add_argument("--claims", help="Vapid claim file")
     parser.add_argument("--key", help="Vapid private key file path")
+    parser.add_argument(
+        "--wns",
+        help="Include WNS cache header based on TTL",
+        default=False,
+        action="store_true")
     parser.add_argument(
         "--curl",
         help="Don't send, display as curl command",
@@ -53,6 +59,15 @@ def get_config():
                     args.head = json.loads(r.read())
                 except JSONDecodeError as e:
                     raise WebPushException("Could not read the header arguments: {}", e)
+        # Set the default "TTL"
+        args.head["ttl"] = args.head.get("ttl", "0")
+        if args.wns:
+            # NOTE: Microsoft also requires `X-WNS-Type` as
+            # `tile`, `toast`, `badge` or `raw`. This is not provided by this code.
+            if int(args.head.get("ttl", "0")) > 0:
+                args.head["x-wns-cache-policy"] = "cache"
+            else:
+                args.head["x-wns-cache-policy"] = "no-cache"
         if args.claims:
             if not args.key:
                 raise WebPushException("No private --key specified for claims")

{pywebpush-2.1.2 → pywebpush-2.2.0}/pywebpush/tests/test_webpush.py

@@ -329,21 +329,6 @@ class WebpushTestUtils(unittest.TestCase):
         del ci["FOO"]
         assert ci.get("Foo") is None
 
-    @patch("requests.post")
-    def test_gcm(self, mock_post):
-        subscription_info = self._gen_subscription_info(
-            None, endpoint="https://android.googleapis.com/gcm/send/regid123"
-        )
-        headers = {"Crypto-Key": "pre-existing", "Authentication": "bearer vapid"}
-        data = "Mary had a little lamb"
-        wp = WebPusher(subscription_info)
-        wp.send(data, headers, gcm_key="gcm_key_value")
-        pdata = json.loads(mock_post.call_args[1].get("data"))
-        pheaders = mock_post.call_args[1].get("headers")
-        assert pdata["registration_ids"][0] == "regid123"
-        assert pheaders.get("authorization") == "key=gcm_key_value"
-        assert pheaders.get("content-type") == "application/json"
-
     @patch("requests.post")
     def test_timeout(self, mock_post):
         mock_post.return_value.status_code = 200
@@ -406,21 +391,6 @@ class WebPusherAsyncTestCase(WebpushTestUtils, unittest.IsolatedAsyncioTestCase)
         assert pheaders.get("ttl") == "0"
         assert pheaders.get("content-encoding") == "aes128gcm"
 
-    @patch("aiohttp.ClientSession.post", new_callable=AsyncMock)
-    async def test_fcm(self, mock_post):
-        subscription_info = self._gen_subscription_info(
-            None, endpoint="https://android.googleapis.com/fcm/send/regid123"
-        )
-        headers = {"Crypto-Key": "pre-existing", "Authentication": "bearer vapid"}
-        data = "Mary had a little lamb"
-        wp = WebPusher(subscription_info)
-        await wp.send_async(data, headers, gcm_key="gcm_key_value")
-        pdata = json.loads(mock_post.call_args[1].get("data"))
-        pheaders = mock_post.call_args[1].get("headers")
-        assert pdata["registration_ids"][0] == "regid123"
-        assert pheaders.get("authorization") == "key=gcm_key_value"
-        assert pheaders.get("content-type") == "application/json"
-
     @patch("aiohttp.ClientSession.post", new_callable=AsyncMock)
     async def test_timeout(self, mock_post):
         mock_post.return_value.status_code = 200

{pywebpush-2.1.2 → pywebpush-2.2.0}/pywebpush.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pywebpush
-Version: 2.1.2
+Version: 2.2.0
 Summary: WebPush publication library
 Author-email: JR Conlin <src+webpusher@jrconlin.com>
 License: MPL-2.0
@@ -10,6 +10,7 @@ Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: aiohttp
@@ -26,9 +27,6 @@ Dynamic: license-file
 
 # Webpush Data encryption library for Python
 
-[![Build Status](https://travis-ci.org/web-push-libs/pywebpush.svg?branch=main)](https://travis-ci.org/web-push-libs/pywebpush)
-[![Requirements Status](https://requires.io/github/web-push-libs/pywebpush/requirements.svg?branch=main)](https://requires.io/github/web-push-libs/pywebpush/requirements/?branch=main)
-
 This library is available on [pypi as pywebpush](https://pypi.python.org/pypi/pywebpush).
 Source is available on [github](https://github.com/mozilla-services/pywebpush).
 Please note: This library was designated as a `Critical Project` by PyPi, it is currently
@@ -64,6 +62,11 @@ referenced to the user who requested it, and recall it when there's
 a new push subscription update is left as an exercise for the
 reader.
 
+_*Note:*_ Some platforms (like Microsoft Windows) require additional
+headers specified for the Push call. These additional headers are not
+standard and may be rejected by other Push services. Please see
+[Special Instructions](#special-instructions) below.
+
 ### Sending Data using `webpush()` One Call
 
 In many cases, your code will be sending a single message to many
@@ -82,7 +85,7 @@ webpush(subscription_info,
 This will encode `data`, add the appropriate VAPID auth headers if required and send it to the push server identified
 in the `subscription_info` block.
 
-##### Parameters
+#### Parameters
 
 _subscription_info_ - The `dict` of the subscription info (described above).
 
@@ -107,7 +110,7 @@ e.g. the output of:
 openssl ecparam -name prime256v1 -genkey -noout -out private_key.pem
 ```
 
-##### Example
+#### Example
 
 ```python
 from pywebpush import webpush, WebPushException
@@ -145,7 +148,7 @@ can pass just `wp = WebPusher(subscription_info)`. This will return a `WebPusher
 
 The following methods are available:
 
-#### `.send(data, headers={}, ttl=0, gcm_key="", reg_id="", content_encoding="aes128gcm", curl=False, timeout=None)`
+#### `.send(data, headers={}, ttl=0, reg_id="", content_encoding="aes128gcm", curl=False, timeout=None)`
 
 Send the data using additional parameters. On error, returns a `WebPushException`
 
@@ -157,9 +160,6 @@ _headers_ A `dict` containing any additional headers to send
 
 _ttl_ Message Time To Live on Push Server waiting for the client to reconnect (in seconds)
 
-_gcm_key_ Google Cloud Messaging key (if using the older GCM push system) This is the API key obtained from the Google
-Developer Console.
-
 _reg_id_ Google Cloud Messaging registration ID (will be extracted from endpoint if not specified)
 
 _content_encoding_ ECE content encoding type (defaults to "aes128gcm")
@@ -172,10 +172,10 @@ See [requests documentation](http://docs.python-requests.org/en/master/user/quic
 
 ##### Example
 
-to send from Chrome using the old GCM mode:
+to send to a user on Chrome:
 
 ```python
-WebPusher(subscription_info).send(data, headers, ttl, gcm_key)
+WebPusher(subscription_info).send(data, headers, ttl)
 ```
 
 #### `.encode(data, content_encoding="aes128gcm")`
@@ -188,7 +188,7 @@ _data_ Binary string of data to send
 
 _content_encoding_ ECE content encoding type (defaults to "aes128gcm")
 
-*Note* This will return a `NoData` exception if the data is not present or empty. It is completely
+_*Note*_ This will return a `NoData` exception if the data is not present or empty. It is completely
 valid to send a WebPush notification with no data, but encoding is a no-op in that case. Best not
 to call it if you don't have data.
 
@@ -200,8 +200,7 @@ encoded_data = WebPush(subscription_info).encode(data)
 
 ## Stand Alone Webpush
 
-If you're not really into coding your own solution, there's also a "stand-alone" `pywebpush` command in the
-./bin directory.
+If you're not really into coding your own solution, there's also a "stand-alone" `pywebpush` command in the `./bin` directory.
 
 This uses two files:
 
@@ -227,3 +226,40 @@ If you're interested in just testing your applications WebPush interface, you co
 which will encrypt and send the contents of `stuff_to_send.data`.
 
 See `./bin/pywebpush --help` for available commands and options.
+
+## Special Instructions
+
+### Windows
+
+[Microsoft requires](https://learn.microsoft.com/en-us/windows/apps/design/shell/tiles-and-notifications/push-request-response-headers#request-parameters)
+one extra header and suggests several additional headers. Users have reported that not including
+these headers can cause notifications to fail to appear. These additional headers are non-standard
+and may be rejected by other platforms. You should be cautious including them with calls to
+non-Microsoft platforms, or to non-Microsoft destinations.
+
+As of 2024-Apr-19, Microsoft requires an `X-WNS-Type` header. As an example, you can include this
+header within the command line call:
+
+Content of the `windows_headers.json` file:
+
+```json
+{"X-WNS-Type":"wns/toast", "TTL":600, "Content-Type": "text/xml"}
+```
+
+_*Note*_ : This includes both the `TTL` set to 10 minutes and the required matching `Content-Type` header for `wns/toast`.
+
+```bash
+pywebpush --data stuff_to_send.xml \
+   --info edge_user_info.json \
+   --head windows_headers.json \
+   --claims vapid_claims.json
+```
+
+### Google Cloud Messaging (GCM)
+
+Please note that GCM has been sunset by Google. Providers should
+use [Firebase Cloud Messaging](https://firebase.google.com/support/troubleshooter/fcm/tokens/gcm) instead.
+
+Please also note that sending messages directly to FCM is not supported by this library. In the past, you could use an insecure `gcm_key` as a proxy for the authentication service. [This was disabled in June 2024](https://firebase.google.com/docs/cloud-messaging/auth-server#authorize-legacy-protocol-send-requests).
+
+Sending WebPush messages to Google Chrome users should not be impacted by this change.

{pywebpush-2.1.2 → pywebpush-2.2.0}/pywebpush.egg-info/SOURCES.txt

@@ -2,7 +2,6 @@ CHANGELOG.md
 CODE_OF_CONDUCT.md
 LICENSE
 MANIFEST.in
-PULL_REQUEST_TEMPLATE.md
 README.md
 README.rst
 entry_points.txt

pywebpush-2.1.2/PULL_REQUEST_TEMPLATE.md

@@ -1,13 +0,0 @@
-## Description
-
-*_NOTE_*: All commits MUST be signed! See https://docs.github.com/en/github/authenticating-to-github/signing-commits
-
-_Describe these changes._
-
-## Testing
-
-_How should reviewers test?_
-
-## Issue(s)
-
-Closes _#IssueNumber_