Merge pull request #14 from vitaly-t/secure

adding password hash

README.md

@@ -163,7 +163,11 @@ as it is not used very often, and even when it is used, it is usually either in
 is typically not needed. But if you do need `$` encoded everywhere, pass in `{encodeDollar: true}`.
 
 * `plusForSpace` - Boolean (false) - encodes spaces as `+` instead of `%20`. 
-
+
+* `passwordHash` - Boolean (false)|String - replaces each password symbol with `#`, to generate a secure connection string.
+But when set to a non-empty string, its first symbol is used instead. Symbol `#` will prevent parsing such string again,
+on purpose. But if you want it parsed again, use a different symbol, for example - `passwordHash: '*'` 
+
 ### `static parseHost(host) => {name, port, type} | null`
 
 When using an external list of default hosts, you may need to parse them independently, using this method,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "connection-string",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Advanced URL Connection String parser.",
   "main": "src/index.js",
   "typings": "src/index.d.ts",

src/index.d.ts

@@ -8,6 +8,7 @@ declare enum HostType {
 interface IEncodingOptions {
     encodeDollar?: boolean
     plusForSpace?: boolean
+    passwordHash?: boolean | string
 }
 
 interface IHost {

src/index.js

@@ -176,7 +176,15 @@
             s += '@';
         } else {
             if (this.password) {
-                s += ':' + encode(this.password, options) + '@';
+                s += ':';
+                var h = options.passwordHash;
+                if (h) {
+                    var code = (typeof h === 'string' && h[0]) || '#';
+                    s += new Array(this.password.length + 1).join(code);
+                } else {
+                    s += encode(this.password, options);
+                }
+                s += '@';
             }
         }
         if (Array.isArray(this.hosts)) {

test/main.ts

@@ -21,7 +21,7 @@ a.params = {
     second: 'hello!'
 };
 
-let cs = a.toString({encodeDollar: true, plusForSpace: true});
+let cs = a.toString({encodeDollar: true, plusForSpace: true, passwordHash: '*'});
 a.setDefaults({
     hosts: [
         {name: '[::]', port: 123, type: HostType.IPv4}

test/mainSpec.js

@@ -420,6 +420,10 @@ describe('toString', () => {
         a.params = {};
         expect(a.toString()).toBe('');
     });
+    it('must secure passwords', () => {
+        expect(parse(':abc@').toString({passwordHash: true})).toBe(':###@');
+        expect(parse(':abc@').toString({passwordHash: '123'})).toBe(':111@');
+    });
 });
 
 describe('host.toString()', () => {