chore: Jul 2022 update (#148)

Now that this is one of the Critical Projects (thanks?) I should
update it to be more modern, clean up some of the crap, and
run it through flake8 at least.

Author: jrconlin

CHANGELOG.md

@@ -4,7 +4,7 @@
 bug: accept all VAPID key instances (thanks @mthu)
 
 ## 1.13.0 (2021-03-15)
-Support requests_session param in webpush fn too
+Support requests_session param in webpush fn too (thanks @bwindels)
 
 ## 1.12.0 (2021-03-15)
 chore: library update, remove nose tests

README.md

@@ -1,23 +1,22 @@
-[![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)
-
 # Webpush Data encryption library for Python
 
-This is a work in progress.
+[![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).
+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
+maintained by [a single person](https://xkcd.com/2347/). I still accept PRs and Issues, but
+make of that what you will.
 
 ## Installation
 
-You'll need to run `python virtualenv`.
+You'll need to run `python -m venv venv`.
 Then
 
-```
-bin/pip install -r requirements.txt
-bin/python setup.py develop
+```bash
+venv/bin/pip install -r requirements.txt
+venv/bin/python setup.py develop
 ```
 
 ## Usage
@@ -82,7 +81,7 @@ a base64 encoded DER formatted private key, or the path to an OpenSSL exported p
 
 e.g. the output of:
 
-```
+```bash
 openssl ecparam -name prime256v1 -genkey -noout -out private_key.pem
 ```
 

README.rst

@@ -1,21 +1,25 @@
-|Build Status| |Requirements Status|
-
 Webpush Data encryption library for Python
 ==========================================
 
-This is a work in progress. This library is available on `pypi as
+|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>`__.
+Please note: This library was designated as a ``Critical Project`` by
+PyPi, it is currently maintained by `a single
+person <https://xkcd.com/2347/>`__. I still accept PRs and Issues, but
+make of that what you will.
 
 Installation
 ------------
 
-You’ll need to run ``python virtualenv``. Then
+You’ll need to run ``python -m venv venv``. Then
 
-::
+.. code:: bash
 
-   bin/pip install -r requirements.txt
-   bin/python setup.py develop
+   venv/bin/pip install -r requirements.txt
+   venv/bin/python setup.py develop
 
 Usage
 -----
@@ -85,7 +89,7 @@ file.
 
 e.g. the output of:
 
-::
+.. code:: bash
 
    openssl ecparam -name prime256v1 -genkey -noout -out private_key.pem
 
@@ -193,11 +197,13 @@ 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.
 
-This uses two files: \* the *data* file, which contains the message to
-send, in whatever form you like. \* the *subscription info* file, which
-contains the subscription information as JSON encoded data. This is
-usually returned by the Push ``subscribe`` method and looks something
-like:
+This uses two files:
+
+-  the *data* file, which contains the message to send, in whatever form
+   you like.
+-  the *subscription info* file, which contains the subscription
+   information as JSON encoded data. This is usually returned by the
+   Push ``subscribe`` method and looks something like:
 
 .. code:: json
 

pywebpush/__init__.py

@@ -7,6 +7,7 @@
 import json
 import os
 import time
+import logging
 
 try:
     from urllib.parse import urlparse
@@ -164,7 +165,7 @@ def __init__(self, subscription_info, requests_session=None,
 
     def verb(self, msg, *args, **kwargs):
         if self.verbose:
-            print(msg.format(*args, **kwargs))
+            logging.info(msg.format(*args, **kwargs))
 
     def _repad(self, data):
         """Add base64 padding to the end of a string, if required"""
@@ -198,6 +199,7 @@ def encode(self, data, content_encoding="aes128gcm"):
         if content_encoding == "aesgcm":
             self.verb("Generating salt for aesgcm...")
             salt = os.urandom(16)
+            logging.debug("Salt: {}".format(salt))
         # The server key is an ephemeral ECDH key used only for this
         # transaction
         server_key = ec.generate_private_key(ec.SECP256R1, default_backend())
@@ -442,7 +444,7 @@ def webpush(subscription_info,
     vapid_headers = None
     if vapid_claims:
         if verbose:
-            print("Generating VAPID headers...")
+            logging.info("Generating VAPID headers...")
         if not vapid_claims.get('aud'):
             url = urlparse(subscription_info.get('endpoint'))
             aud = "{}://{}".format(url.scheme, url.netloc)
@@ -454,24 +456,31 @@ def webpush(subscription_info,
             # encryption lives for 12 hours
             vapid_claims['exp'] = int(time.time()) + (12 * 60 * 60)
             if verbose:
-                print("Setting VAPID expry to {}...".format(
+                logging.info("Setting VAPID expry to {}...".format(
                     vapid_claims['exp']))
         if not vapid_private_key:
             raise WebPushException("VAPID dict missing 'private_key'")
         if isinstance(vapid_private_key, Vapid01):
+            if verbose:
+                logging.info("Looks like we already have a valid VAPID key")
             vv = vapid_private_key
         elif os.path.isfile(vapid_private_key):
             # Presume that key from file is handled correctly by
             # py_vapid.
+            if verbose:
+                logging.info(
+                    "Reading VAPID key from file {}".format(vapid_private_key))
             vv = Vapid.from_file(
                 private_key_file=vapid_private_key)  # pragma no cover
         else:
+            if verbose:
+                logging.info("Reading VAPID key from arguments")
             vv = Vapid.from_string(private_key=vapid_private_key)
         if verbose:
-            print("\t claims: {}".format(vapid_claims))
+            logging.info("\t claims: {}".format(vapid_claims))
         vapid_headers = vv.sign(vapid_claims)
         if verbose:
-            print("\t headers: {}".format(vapid_headers))
+            logging.info("\t headers: {}".format(vapid_headers))
         headers.update(vapid_headers)
 
     response = WebPusher(

pywebpush/__main__.py

@@ -1,8 +1,11 @@
 import argparse
 import os
 import json
+import logging
 
-from pywebpush import webpush
+from requests import JSONDecodeError
+
+from pywebpush import webpush, WebPushException
 
 
 def get_config():
@@ -21,25 +24,37 @@ def get_config():
     args = parser.parse_args()
 
     if not args.info:
-        raise Exception("Subscription Info argument missing.")
+        raise WebPushException("Subscription Info argument missing.")
     if not os.path.exists(args.info):
-        raise Exception("Subscription Info file missing.")
+        raise WebPushException("Subscription Info file missing.")
     try:
         with open(args.info) as r:
-            args.sub_info = json.loads(r.read())
+            try:
+                args.sub_info = json.loads(r.read())
+            except JSONDecodeError as e:
+                raise WebPushException(
+                    "Could not read the subscription info file: {}", e)
         if args.data:
             with open(args.data) as r:
                 args.data = r.read()
         if args.head:
             with open(args.head) as r:
-                args.head = json.loads(r.read())
+                try:
+                    args.head = json.loads(r.read())
+                except JSONDecodeError as e:
+                    raise WebPushException(
+                        "Could not read the header arguments: {}", e)
         if args.claims:
             if not args.key:
-                raise Exception("No private --key specified for claims")
+                raise WebPushException("No private --key specified for claims")
             with open(args.claims) as r:
-                args.claims = json.loads(r.read())
+                try:
+                    args.claims = json.loads(r.read())
+                except JSONDecodeError as e:
+                    raise WebPushException(
+                        "Could not read the VAPID claims file {}".format(e))
     except Exception as ex:
-        print("Couldn't read input {}.".format(ex))
+        logging.error("Couldn't read input {}.".format(ex))
         raise ex
     return args
 
@@ -60,7 +75,7 @@ def main():
             headers=args.head)
         print(result)
     except Exception as ex:
-        print("ERROR: {}".format(ex))
+        logging.error("{}".format(ex))
 
 
 if __name__ == "__main__":

pywebpush/tests/test_webpush.py

@@ -80,7 +80,8 @@ def test_init(self):
         push = WebPusher(subscription_info)
         assert push.subscription_info != subscription_info
         assert push.subscription_info['keys'] != subscription_info['keys']
-        assert push.subscription_info['endpoint'] == subscription_info['endpoint']
+        assert push.subscription_info['endpoint'] == \
+            subscription_info['endpoint']
         assert push.receiver_key == rk_decode
         assert push.auth_key == b'\x93\xc2U\xea\xc8\xddn\x10"\xd6}\xff,0K\xbc'