Update: export RSA keys as PEM

cisco · Dec 11, 2015 · e6ef2ef · e6ef2ef
2 parents b55d60f + 654ccb7
commit e6ef2ef
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 1 deletion.
diff --git a/AUTHORS b/AUTHORS
@@ -3,3 +3,4 @@
 
 Matthew A. Miller <linuxwolf@outer-planes.net>
 Ian W. Remmel <design@ianwremmel.com>
+Joe Hildebrand <joe-github@cursive.net>
diff --git a/lib/jwk/basekey.js b/lib/jwk/basekey.js
@@ -321,6 +321,32 @@ var JWKBaseKeyObject = function(kty, ks, props, cfg) {
     }
   });
 
+  /**
+   * @method JWK.Key#toPEM
+   * @description
+   * Returns the PEM representation of this Key as a string.
+   *
+   * @param {Boolean} [isPrivate=false] `true` if private parameters should be
+   *        included.
+   * @returns {string} The PEM-encoded string
+   */
+  Object.defineProperty(this, "toPEM", {
+    value: function(isPrivate) {
+      if (isPrivate === null) {
+        isPrivate = false;
+      }
+
+      if (!cfg.convertToPEM) {
+        throw new Error("Unsupported key type for PEM encoding");
+      }
+      var k = (isPrivate) ? keys.private : keys.public;
+      if (!k) {
+        throw new Error("Invalid key");
+      }
+      return cfg.convertToPEM.call(this, k, isPrivate);
+    }
+  });
+
   /**
    * @method JWK.Key#toObject
    * @description

diff --git a/lib/jwk/rsakey.js b/lib/jwk/rsakey.js
@@ -6,6 +6,7 @@
 "use strict";
 
 var forge = require("../deps/forge.js");
+var rsau = require("../algorithms/rsa-util");
 
 var JWK = {
   BaseKey: require("./basekey.js"),
@@ -95,6 +96,14 @@ var JWKRsaCfg = {
   },
   verifyKey: function(alg, keys) {
     return keys.public;
+  },
+
+  convertToPEM: function(key, isPrivate) {
+    var k = rsau.convertToForge(key, !isPrivate);
+    if (!isPrivate) {
+      return forge.pki.publicKeyToPem(k);
+    }
+    return forge.pki.privateKeyToPem(k);
   }
 };
 

diff --git a/package.json b/package.json
@@ -21,7 +21,8 @@
   "author": "Cisco Systems, Inc. <https://www.cisco.com>",
   "contributors": [
     "Matthew A. Miller <linuxwolf@outer-planes.net>",
-    "Ian W. Remmel <design@ianwremmel.com>"
+    "Ian W. Remmel <design@ianwremmel.com>",
+    "Joe Hildebrand <joe-github@cursive.net>"
   ],
   "license": "Apache-2.0",
   "dependencies": {

diff --git a/test/jwk/rsakey-test.js b/test/jwk/rsakey-test.js
@@ -347,6 +347,17 @@ describe("jwk/RSA", function() {
           kid: "someid"
         });
         assert.deepEqual(key.toJSON(true), json);
+        var priv_pem = key.toPEM(true);
+        assert.isString(priv_pem);
+        assert.match(priv_pem, /^-----BEGIN RSA PRIVATE KEY-----\r\n/);
+        assert.match(priv_pem, /\r\n-----END RSA PRIVATE KEY-----\r\n$/);
+
+        var pub_pem = key.toPEM();
+        assert.isString(pub_pem);
+        assert.match(pub_pem, /^-----BEGIN PUBLIC KEY-----\r\n/);
+        assert.match(pub_pem, /\r\n-----END PUBLIC KEY-----\r\n$/);
+
+        assert.equal(pub_pem, key.toPEM(false));
       });
 
       return promise;