sshpk - npm Package Compare versions

Comparing version 1.8.0 to 1.8.1

lib/index.js

@@ -24,3 +24,4 @@ // Copyright 2015 Joyent, Inc.
 	KeyParseError: errs.KeyParseError,
-	SignatureParseError: errs.SignatureParseError
+	SignatureParseError: errs.SignatureParseError,
+	KeyEncryptedError: errs.KeyEncryptedError
 };

package.json

 {
   "name": "sshpk",
-  "version": "1.8.0",
+  "version": "1.8.1",
   "description": "A library for finding and using SSH public keys",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -114,3 +114,3 @@ sshpk
 
-### `parseKey(data[, format = 'auto'[, name]])`
+### `parseKey(data[, format = 'auto'[, options]])`
 
@@ -130,4 +130,8 @@ Parses a key from a given data format and returns a new `Key` object.
                `ssh-keygen -o`
-- `name` -- Optional name for the key being parsed (eg. the filename that
-            was opened). Used to generate Error messages
+- `options` -- Optional Object, extra options, with keys:
+  - `filename` -- Optional String, name for the key being parsed 
+                  (eg. the filename that was opened). Used to generate
+                  Error messages
+  - `passphrase` -- Optional String, encryption passphrase used to decrypt an
+                    encrypted PEM file
 
@@ -217,3 +221,3 @@ ### `Key.isKey(obj)`
 
-### `parsePrivateKey(data[, format = 'auto'[, name]])`
+### `parsePrivateKey(data[, format = 'auto'[, options]])`
 
@@ -233,4 +237,8 @@ Parses a private key from a given data format and returns a new
   - `rfc4253`: raw OpenSSH wire format
-- `name` -- Optional name for the key being parsed (eg. the filename that
-            was opened). Used to generate Error messages
+- `options` -- Optional Object, extra options, with keys:
+  - `filename` -- Optional String, name for the key being parsed 
+                  (eg. the filename that was opened). Used to generate
+                  Error messages
+  - `passphrase` -- Optional String, encryption passphrase used to decrypt an
+                    encrypted PEM file
 
@@ -432,6 +440,17 @@ ### `PrivateKey.isPrivateKey(obj)`
 
-- `keyName` -- `name` that was given to `Key#parse`
+- `keyName` -- `filename` that was given to `Key#parse`
 - `format` -- the `format` that was trying to parse the key
 - `innerErr` -- the inner Error thrown by the format parser
 
+### `KeyEncryptedError`
+
+The key is encrypted with a symmetric key (ie, it is password protected). The
+parsing operation would succeed if it was given the `passphrase` option.
+
+Properties
+
+- `keyName` -- `filename` that was given to `Key#parse`
+- `format` -- the `format` that was trying to parse the key (currently can only
+              be `"pem"`)
+
 Friends of sshpk
@@ -438,0 +457,0 @@ ----------------

No alert changes

Improved metrics

Total package byte prevSize

123998

increased by0.68%

Lines of code

2910

increased by0.03%

Number of lines in readme file

456

increased by4.35%

No dependency changes