Merge pull request #14 from jrconlin/master

jrconlin · jrconlin · commit 7e09a0070dcc · 2016-05-18T10:19:21.000-07:00
Merge 0.4.1 to prod
diff --git a/js/common.js b/js/common.js
@@ -32,7 +32,7 @@ class MozCommon {
             .replace(/\_/g, "/"));
     }
 
-    _strToArray(str) {
+    strToArray(str) {
         /* convert a string into a ByteArray
          *
          * TextEncoders would be faster, but have a habit of altering
@@ -46,7 +46,7 @@ class MozCommon {
         return reply;
     }
 
-    _arrayToStr(array) {
+    arrayToStr(array) {
         /* convert a ByteArray into a string
          */
         return String.fromCharCode.apply(null, new Uint8Array(array));
@@ -56,18 +56,16 @@ class MozCommon {
     /* convert a URL safe base64 raw key to jwk format
     */
         if (typeof(raw) == "string") {
-            raw = this._strToArray(this.fromUrlBase64(raw));
+            raw = this.strToArray(this.fromUrlBase64(raw));
         }
         // Raw is supposed to start with a 0x04, but some libraries don't. sigh.
         if (raw.length == 65 && raw[0] != 4) {
             throw new Error('ERR_PUB_KEY');
         }
 
-        raw= raw.slice(-64);
-        let x = this.toUrlBase64(String.fromCharCode.apply(null,
-            raw.slice(0,32)));
-        let y = this.toUrlBase64(String.fromCharCode.apply(null,
-            raw.slice(32,64)));
+        raw = raw.slice(-64);
+        let x = this.toUrlBase64(this.arrayToStr(raw.slice(0,32)));
+        let y = this.toUrlBase64(this.arrayToSTr(raw.slice(32,64)));
 
         // Convert to a JWK and import it.
         let jwk = {
@@ -85,8 +83,8 @@ class MozCommon {
     JWKToRaw(jwk) {
         /* Convert a JWK object to a "raw" URL Safe base64 string
         */
-        xv = this.fromUrlBase64(jwk.x);
-        yv = this.fromUrlBase64(jwk.y);
+        let xv = this.fromUrlBase64(jwk.x);
+        let yv = this.fromUrlBase64(jwk.y);
         return this.toUrlBase64("\x04" + xv + yv);
     }
 }
diff --git a/js/der_lite.js b/js/der_lite.js
@@ -1,7 +1,12 @@
 'use strict';
 
 class DERLite{
-    constructor() {}
+    constructor(mzcc) {
+        if (mzcc === undefined) {
+            mzcc = new MozCommon();
+        }
+        this.mzcc = mzcc
+    }
 
     /* Simplified DER export and import is provided because a large number of
      * libraries and languages understand DER as a key exchange and storage
@@ -25,29 +30,29 @@ class DERLite{
         return webCrypto.exportKey("jwk", key)
             .then(k => {
                 // verifying key
-                let xv = mzcc.fromUrlBase64(k.x);
-                let yv = mzcc.fromUrlBase64(k.y);
+                let xv = this.mzcc.fromUrlBase64(k.x);
+                let yv = this.mzcc.fromUrlBase64(k.y);
                 // private key
-                let dv = mzcc.fromUrlBase64(k.d);
+                let dv = this.mzcc.fromUrlBase64(k.d);
 
                 // verifying key (public)
                 let vk = '\x00\x04' + xv + yv;
                 // \x02 is integer
                 let int1 = '\x02\x01\x01'; // integer 1
                 // \x04 is octet string
-                let dvstr = '\x04' + mzcc.chr(dv.length) + dv;
+                let dvstr = '\x04' + this.mzcc.chr(dv.length) + dv;
                 let curve_oid = "\x06\x08" +
                     "\x2a\x86\x48\xce\x3d\x03\x01\x07";
                 // \xaX is a construct, low byte is order.
-                let curve_oid_const = '\xa0' + mzcc.chr(curve_oid.length) +
+                let curve_oid_const = '\xa0' + this.mzcc.chr(curve_oid.length) +
                     curve_oid;
                 // \x03 is a bitstring
-                let vk_enc = '\x03' + mzcc.chr(vk.length) + vk;
-                let vk_const = '\xa1' + mzcc.chr(vk_enc.length) + vk_enc;
+                let vk_enc = '\x03' + this.mzcc.chr(vk.length) + vk;
+                let vk_const = '\xa1' + this.mzcc.chr(vk_enc.length) + vk_enc;
                 // \x30 is a sequence start.
                 let seq = int1 + dvstr + curve_oid_const + vk_const;
-                let rder = "\x30" + mzcc.chr(seq.length) + seq;
-                return mzcc.toUrlBase64(rder);
+                let rder = "\x30" + this.mzcc.chr(seq.length) + seq;
+                return this.mzcc.toUrlBase64(rder);
             })
             .catch(err => console.error(err))
     }
@@ -59,7 +64,7 @@ class DERLite{
          * :param der_str: URL safe base64 formatted DER string.
          * :returns: Promise containing the imported private key
          */
-        let der = mzcc._strToArray(mzcc.fromUrlBase64(der_str));
+        let der = this.mzcc.strToArray(this.mzcc.fromUrlBase64(der_str));
         // quick guantlet to see if this is a valid DER
         let cmp = new Uint8Array([2,1,1,4]);
         if (der[0] != 48 ||
@@ -77,9 +82,9 @@ class DERLite{
            ext: true,
            key_ops: key_ops,
            kty: "EC",
-           x: mzcc.toUrlBase64(String.fromCharCode.apply(null, xv)),
-           y: mzcc.toUrlBase64(String.fromCharCode.apply(null, yv)),
-           d: mzcc.toUrlBase64(String.fromCharCode.apply(null, dv)),
+           x: this.mzcc.toUrlBase64(String.fromCharCode.apply(null, xv)),
+           y: this.mzcc.toUrlBase64(String.fromCharCode.apply(null, yv)),
+           d: this.mzcc.toUrlBase64(String.fromCharCode.apply(null, dv)),
         };
 
         console.debug(JSON.stringify(jwk));
@@ -96,8 +101,8 @@ class DERLite{
         return webCrypto.exportKey("jwk", key)
             .then(k => {
                 // raw keys always begin with a 4
-                let xv = mzcc._strToArray(mzcc.fromUrlBase64(k.x));
-                let yv = mzcc._strToArray(mzcc.fromUrlBase64(k.y));
+                let xv = this.mzcc.strToArray(this.mzcc.fromUrlBase64(k.x));
+                let yv = this.mzcc.strToArray(this.mzcc.fromUrlBase64(k.y));
 
                 let point = "\x00\x04" +
                     String.fromCharCode.apply(null, xv) +
@@ -107,10 +112,10 @@ class DERLite{
                 let prefix = "\x30\x13" +  // sequence + length
                     "\x06\x07" + "\x2a\x86\x48\xce\x3d\x02\x01" +
                     "\x06\x08" + "\x2a\x86\x48\xce\x3d\x03\x01\x07"
-                let encPoint = "\x03" + mzcc.chr(point.length) + point
-                let rder = "\x30" + mzcc.chr(prefix.length + encPoint.length) +
+                let encPoint = "\x03" + this.mzcc.chr(point.length) + point
+                let rder = "\x30" + this.mzcc.chr(prefix.length + encPoint.length) +
                     prefix + encPoint;
-                let der = mzcc.toUrlBase64(rder);
+                let der = this.mzcc.toUrlBase64(rder);
                 return der;
             });
     }
@@ -128,7 +133,7 @@ class DERLite{
          *
          */
         if (typeof(derArray) == "string") {
-            derArray = mzcc._strToArray(mzcc.fromUrlBase64(derArray));
+            derArray = this.mzcc.strToArray(this.mzcc.fromUrlBase64(derArray));
         }
         /* Super light weight public key import function */
         let err = new Error(this.lang.errs.ERR_PUB_D_KEY);
@@ -143,9 +148,9 @@ class DERLite{
             throw err;
         }
         // pubkey offset starts at byte 25
-        let x = mzcc.toUrlBase64(String.fromCharCode
+        let x = this.mzcc.toUrlBase64(String.fromCharCode
                 .apply(null, derArray.slice(27, 27+32)));
-        let y = mzcc.toUrlBase64(String.fromCharCode
+        let y = this.mzcc.toUrlBase64(String.fromCharCode
                 .apply(null, derArray.slice(27+32, 27+64)));
 
         // Convert to a JWK and import it.
diff --git a/js/vapid.js b/js/vapid.js
@@ -1,6 +1,6 @@
 /* Javascript VAPID library.
  *
- * Requires: common.js :: mzcc
+ * Requires: common.js
  *
  */
 
@@ -14,9 +14,8 @@ try {
     var webCrypto = window.crypto.subtle;
 }
 
-
 class VapidToken {
-    constructor(aud, sub, exp, lang) {
+    constructor(aud, sub, exp, lang, mzcc) {
         /* Construct a base VAPID token.
          *
          * VAPID allows for self identification of a subscription update.
@@ -26,6 +25,11 @@ class VapidToken {
          * :param exp: Expiration - UTC expiration of this update. Defaults
          *      to now + 24 hours
          */
+
+        if (mzcc == undefined) {
+            mzcc = new MozCommon();
+        }
+        this.mzcc = mzcc;
         this._claims={};
         this._claims['aud'] = aud || "";
         if (sub !== undefined) {
@@ -88,9 +92,9 @@ class VapidToken {
          */
         return webCrypto.exportKey('jwk', this._public_key)
             .then( key => {
-                return mzcc.toUrlBase64("\x04" +
-                    mzcc.fromUrlBase64(key.x) +
-                    mzcc.fromUrlBase64(key.y))
+                return this.mzcc.toUrlBase64("\x04" +
+                    this.mzcc.fromUrlBase64(key.x) +
+                    this.mzcc.fromUrlBase64(key.y))
             })
             .catch(err => {
                 console.error("public raw format", err);
@@ -105,7 +109,7 @@ class VapidToken {
          * :returns: a promise from the imported key.
          */
         if (typeof(raw) == "string") {
-            raw = mzcc._strToArray(mzcc.fromUrlBase64(raw));
+            raw = this.mzcc.strToArray(this.mzcc.fromUrlBase64(raw));
         }
         let err = new Error(this.lang.errs.ERR_PUB_KEY);
 
@@ -115,9 +119,9 @@ class VapidToken {
         }
 
         raw= raw.slice(-64);
-        let x = mzcc.toUrlBase64(String.fromCharCode.apply(null,
+        let x = this.mzcc.toUrlBase64(String.fromCharCode.apply(null,
              raw.slice(0,32)));
-        let y = mzcc.toUrlBase64(String.fromCharCode.apply(null,
+        let y = this.mzcc.toUrlBase64(String.fromCharCode.apply(null,
              raw.slice(32,64)));
 
         // Convert to a JWK and import it.
@@ -139,7 +143,7 @@ class VapidToken {
     sign(claims) {
         /* Sign a claims object and return the headers that can be used to
          * decrypt the string.
-         *         *
+         *
          * :param claims: An object containing the VAPID claims.
          * :returns: a promise containing an object identifying the headers
          * and values to include to specify VAPID auth.
@@ -157,18 +161,19 @@ class VapidToken {
             throw new Error(this.lang.errs.ERR_CLAIM_MIS, "aud");
         }
         let alg = {name:"ECDSA", namedCurve: "P-256", hash:{name:"SHA-256"}};
-        let headStr = mzcc.toUrlBase64(
+        let headStr = this.mzcc.toUrlBase64(
             JSON.stringify({typ:"JWT",alg:"ES256"}));
-        let claimStr = mzcc.toUrlBase64(
+        let claimStr = this.mzcc.toUrlBase64(
             JSON.stringify(claims));
         let content = headStr + "." + claimStr;
-        let signatory = mzcc._strToArray(content);
+        let signatory = this.mzcc.strToArray(content);
         return webCrypto.sign(
             alg,
             this._private_key,
             signatory)
             .then(signature => {
-                let sig = mzcc.toUrlBase64(mzcc._arrayToStr(signature));
+                let sig = this.mzcc.toUrlBase64(
+                    this.mzcc.arrayToStr(signature));
                 /* The headers consist of the constructed JWT as the
                  * "authorization" and the raw Public key as the p256ecdsa
                  * element of "Crypto-Key"
@@ -236,17 +241,18 @@ class VapidToken {
         let signature;
         let key;
         try {
-            signature = mzcc._strToArray(mzcc.fromUrlBase64(items[2]));
+            signature = this.mzcc.strToArray(
+                this.mzcc.fromUrlBase64(items[2]));
         } catch (err) {
             throw new Error(this.lang.errs.ERR_VERIFY_SG + err.message);
         }
         try {
-            key = mzcc._strToArray(mzcc.fromUrlBase64(items[1]));
+            key = this.mzcc.strToArray(this.mzcc.fromUrlBase64(items[1]));
         } catch (err) {
             throw new Error(this.lang.errs.ERR_VERIFY_KE + err.message);
         }
         let content = items.slice(0,2).join('.');
-        let signatory = mzcc._strToArray(content);
+        let signatory = this.mzcc.strToArray(content);
         return webCrypto.verify(
             alg,
             this._public_key,
@@ -257,7 +263,8 @@ class VapidToken {
                    return JSON.parse(
                         String.fromCharCode.apply(
                             null,
-                            mzcc._strToArray(mzcc.fromUrlBase64(items[1]))))
+                            this.mzcc.strToArray(
+                                this.mzcc.fromUrlBase64(items[1]))))
                }
                throw new Error(this.lang.errs.ERR_SIGNATURE);
            })
@@ -285,10 +292,10 @@ class VapidToken {
          * :returns: the signature value to paste back into the Dashboard.
          */
         let alg = {name:"ECDSA", namedCurve: "P-256", hash:{name:"SHA-256"}};
-        let t2v = mzcc._strToArray(string);
+        let t2v = this.mzcc.strToArray(string);
         return webCrypto.sign(alg, this._private_key, t2v)
             .then(signed => {
-                let sig = mzcc.toUrlBase64(mzcc._arrayToStr(signed));
+                let sig = this.mzcc.toUrlBase64(this.mzcc.arrayToStr(signed));
                 return sig;
             });
     }
@@ -303,8 +310,8 @@ class VapidToken {
          * :returns: Boolean indicating successful verification.
          */
         let alg = {name: "ECDSA", namedCurve: "P-256", hash:{name:"SHA-256"}};
-        let vsig = mzcc._strToArray(mzcc.fromUrlBase64(sig));
-        let t2v = mzcc._strToArray(mzcc.fromUrlBase64(string));
+        let vsig = this.mzcc.strToArray(this.mzcc.fromUrlBase64(sig));
+        let t2v = this.mzcc.strToArray(this.mzcc.fromUrlBase64(string));
         return webCrypto.verify(alg, this._public_key, vsig, t2v);
     }
 }
diff --git a/python/MANIFEST.in b/python/MANIFEST.in
@@ -0,0 +1,5 @@
+include *.md
+include *.txt
+include setup.*
+include LICENSE
+recursive-include py_vapid
diff --git a/python/setup.py b/python/setup.py
@@ -3,22 +3,26 @@
 
 from setuptools import setup, find_packages
 
-__version__ = "0.2"
+__version__ = "0.4.1"
+
+
+def read_from(file):
+    reply = []
+    with io.open(os.path.join(here, file), encoding='utf8') as f:
+        for l in f:
+            l = l.strip()
+            if not l:
+                break
+            if l[0] != '#' or l[:2] != '//':
+                reply.append(l)
+    return reply
+
 
 here = os.path.abspath(os.path.dirname(__file__))
 with io.open(os.path.join(here, 'README.md'), encoding='utf8') as f:
     README = f.read()
 with io.open(os.path.join(here, 'CHANGELOG.md'), encoding='utf8') as f:
     CHANGES = f.read()
-with io.open(os.path.join(here, 'requirements.txt'), encoding='utf8') as f:
-    REQS = []
-    for l in f:
-        l = l.strip()
-        if not l:
-            break
-        if l[0] == '#' or l[:2] == '//':
-            continue
-        REQS.append(l)
 
 setup(name="py-vapid",
       version=__version__,
@@ -29,17 +33,19 @@
                    "Programming Language :: Python :: 2",
                    "Programming Language :: Python :: 2.7"
                    ],
-      keywords='vapid',
+      keywords='vapid push webpush',
       author="JR Conlin",
       author_email="src+vapid@jrconlin.com",
       url='https://github.com/mozilla-services/vapid',
       license="MPL2",
       test_suite="nose.collector",
       include_package_data=True,
       zip_safe=False,
-      tests_require=['nose', 'coverage', 'mock>=1.0.1'],
       packages=find_packages(),
-      install_requires=REQS,
+      package_data={'': ['README.md', 'CHANGELOG.md',
+                         'requirements.txt', 'test-requirements.txt']},
+      install_requires=read_from('requirements.txt'),
+      tests_require=read_from('test-requirements.txt'),
       entry_points="""
       [console_scripts]
       vapid = py_vapid.main:main
