secrez 1.0.3 → 1.1.0

package/README.md

@@ -181,48 +181,6 @@ Running Secrez in different containers (with the `-c` option), you can set up mu
 secrez -c ~/data/secrez
 ```
 
-## How to set up a Git repo for the data
-
-The best way to go is to set up a repo on your own server. If you can't do that, using a private repo on a service like GitHub is not a bad option. Let's see how you can configure it in this second case.
-
-First, you go to GitHub and create a new private repo. Don't add anything like README, Licence, etc. In the next page, GitHub will show you the command you must run to set up it locally. Here is an example, imagining that your data are in the default folder
-
-```
-git --init --main-branch main
-git --remote-url git@github.com:sullof/jarrabish.git
-```
-
-To push any change run
-```
-git -p
-```
-and, if you pushed changes to the repo on some other computer, to pull and merge, run
-```
-git -P
-```
-Notice that the lowercase `p` is an alias for `push` and the uppercase `P` for `pull`.
-
-### What if I have a private remote repo?
-
-You should use Git anyway, to have a safe backup of your data. In this case, just run
-```
-git --init
-```
-to set the repo up. After, use `git -p` to commit your changes. It will allow you to reverse the data in case some critical error occurs. When you have a private repo, you can just add the remote url (see example above).
-
-If you need more, you can run commands using Shell, like
-```
-shell "cd ~/.secrez && git log"
-```
-However, if you like to do some reset, you should quit and run the commands directly in the shell.
-
-**Be careful when you do anything inside your container, you can irreversibly damage your data.**
-
-### What about Mercurial or Subversion?
-
-You can use a different version control system.  
-If you do so, though, be careful to correctly set up in the directory the equivalent of `.gitignore` to avoid pushing to the repo also data that must exist only locally.
-
 ## The commands
 
 ```
@@ -451,6 +409,17 @@ Secrez does not want to compete with password managers. So, don't expect in the
 
 ## History
 
+__1.1.0__
+* Remove `git`. If used carefully, the command was helpful, but still it is at risk of creating conflicts. After long thoughts, I disapproved my own proposal at: https://github.com/secrez/secrez/pull/163 
+
+__1.0.4__
+* Fix wrong example in `import`
+
+__1.0.3__
+* `git` asks to quit Secrez and merge manually if there are remote changes
+* `totp` allows to add a totp code to an existing yaml file using the option `--set` (see the examples)
+* Default duration before clipboard reverse for `totp` is now 8 seconds
+
 __1.0.2__
 * Export and Import can encrypt/decrypt files using shared keys generated from a specified public key
 * Can export ecrypted file for the user itself, files that can be decrypted only from inside the secrez account that exported them 
@@ -790,18 +759,18 @@ Thanks a lot for any contribution 😉
 ## Test coverage
 
 ```
-  162 passing (24s)
+  162 passing (28s)
   1 pending
 
 -----------------------|---------|----------|---------|---------|-----------------------------------
 File                   | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s                 
 -----------------------|---------|----------|---------|---------|-----------------------------------
-All files              |    69.9 |    56.05 |   71.76 |   69.84 |                                   
+All files              |   71.33 |    58.19 |   71.98 |   71.28 |                                   
  src                   |   59.63 |    54.79 |      55 |   61.32 |                                   
   Command.js           |   79.66 |    78.72 |   76.92 |   83.93 | 35,54-59,68,71,95                 
   PreCommand.js        |   21.95 |    11.54 |   14.29 |   21.95 | 9-95,108                          
   cliConfig.js         |     100 |      100 |     100 |     100 |                                   
- src/commands          |   79.17 |    63.61 |   89.24 |   78.97 |                                   
+ src/commands          |   81.58 |    66.85 |   89.95 |    81.4 |                                   
   Alias.js             |   90.54 |    77.36 |     100 |   90.41 | 85,96,118,145,149,154,164         
   Bash.js              |      75 |        0 |   66.67 |      75 | 20-21                             
   Cat.js               |    98.9 |    88.89 |     100 |    98.9 | 144                               
@@ -815,7 +784,6 @@ All files              |    69.9 |    56.05 |   71.76 |   69.84 |
   Edit.js              |   13.58 |        0 |      40 |   13.58 | 78-193                            
   Export.js            |   90.91 |       68 |     100 |   90.91 | 109,114-115,120,130,137,140       
   Find.js              |   93.59 |    86.67 |     100 |   93.42 | 90,153,192-196,202                
-  Git.js               |   15.07 |        0 |      50 |   15.07 | 74-178                            
   Help.js              |     100 |       80 |     100 |     100 | 30                                
   Import.js            |    93.2 |    85.48 |     100 |    93.1 | ...06,308,321,327,369,384-390,417 
   Lcat.js              |     100 |    85.71 |     100 |     100 | 55                                
@@ -832,7 +800,7 @@ All files              |    69.9 |    56.05 |   71.76 |   69.84 |
   Shell.js             |   88.24 |       60 |     100 |   88.24 | 39,54                             
   Ssh.js               |      25 |        0 |      40 |      25 | 64-104                            
   Tag.js               |   98.04 |    92.31 |     100 |   97.94 | 123,164                           
-  Totp.js              |   97.53 |    76.74 |     100 |   97.53 | 150-151                           
+  Totp.js              |   96.47 |    74.47 |     100 |   96.47 | 164-165,209                       
   Touch.js             |     100 |    71.43 |     100 |     100 | 57,68                             
   Use.js               |   96.77 |    89.47 |     100 |   96.77 | 65                                
   Ver.js               |      90 |    66.67 |     100 |      90 | 27                                
@@ -856,18 +824,14 @@ All files              |    69.9 |    56.05 |   71.76 |   69.84 |
   MainPromptMock.js    |     100 |      100 |   66.67 |     100 |                                   
   MultiEditorPrompt.js |      25 |        0 |       0 |      25 | 8-35                              
   SigintManager.js     |      25 |        0 |      20 |      25 | 11-37                             
- src/utils             |   69.92 |     62.1 |   56.25 |   69.55 |                                   
+ src/utils             |   69.92 |    63.28 |   56.25 |   69.55 |                                   
   AliasManager.js      |     100 |    91.67 |     100 |     100 | 48                                
   ContactManager.js    |   71.43 |       60 |   85.71 |   71.43 | 13,36-38                          
   Fido2Client.js       |   15.38 |        0 |   11.11 |   15.38 | 15-101                            
-  HelpProto.js         |    91.6 |    83.08 |     100 |   91.45 | 44,137-138,155-160,179            
+  HelpProto.js         |    91.6 |    84.06 |     100 |   91.45 | 44,137-138,155-160,179            
   Logger.js            |   63.64 |    56.25 |   36.84 |   62.79 | ...38-50,58,66-70,75,85,89,94,107 
 -----------------------|---------|----------|---------|---------|-----------------------------------
 
-> secrez@1.0.3 posttest /Users/sullof/Projects/Personal/secrez/packages/secrez
-> nyc check-coverage --statements 65 --branches 50 --functions 65 --lines 65
-
-
 ```
 
 

package/package.json

@@ -1,73 +1,73 @@
 {
-	"name": "secrez",
-	"version": "1.0.3",
-	"license": "MIT",
-	"scripts": {
-		"dev": "cross-env NODE_ENV=dev bin/secrez.js -c `pwd`/tmp/secrez-dev -i 1e3 -l `pwd`/tmp",
-		"lint": "eslint -c .eslintrc 'src/**/*.js' 'bin/*.js' 'test/*.test.js' 'test/**/*.js' 'test/**/**/*.js'",
-		"test-only": "cross-env NODE_ENV=test ./node_modules/.bin/mocha test/*.test.js test/**/*.test.js test/**/**/*.js --exit",
-		"test": "cross-env NODE_ENV=test nyc --reporter=lcov --reporter=text ./node_modules/.bin/_mocha test/*.test.js test/**/*.test.js test/**/**/*.js --exit",
-		"posttest": "nyc check-coverage --statements 65 --branches 50 --functions 65 --lines 65",
-		"build-helpers": "cd test/helpers/os && ./build.sh"
-	},
-	"nyc": {
-		"include": "src",
-		"exclude": []
-	},
-	"dependencies": {
-		"@secrez/core": "~1.0.3",
-		"@secrez/crypto": "~1.0.1",
-		"@secrez/fs": "~1.0.3",
-		"@secrez/hub": "~0.2.1",
-		"@secrez/utils": "~1.0.2",
-		"case": "^1.6.3",
-		"chalk": "^3.0.0",
-		"clipboardy": "^2.3.0",
-		"command-line-args": "^5.1.1",
-		"external-editor": "^3.1.0",
-		"fs-extra": "^9.1.0",
-		"homedir": "^0.6.0",
-		"inquirer": "^7.1.0",
-		"inquirer-command-prompt": "^0.1.0",
-		"jimp": "^0.13.0",
-		"lodash": "^4.17.15",
-		"otplib": "^12.0.1",
-		"qrcode-reader": "^1.0.4",
-		"superagent": "^5.3.1",
-		"tiny-cli-editor": "^0.1.1"
-	},
-	"devDependencies": {
-		"@secrez/courier": "~0.2.2",
-		"@secrez/test-helpers": "~1.0.2",
-		"chai": "^4.2.0",
-		"chalk": "^3.0.0",
-		"cross-env": "^7.0.2",
-		"eslint": "^6.8.0",
-		"eslint-plugin-node": "^11.0.0",
-		"mocha": "^7.1.1",
-		"nyc": "^15.1.0",
-		"test-console": "^1.1.0"
-	},
-	"bin": {
-		"secrez": "bin/secrez.js"
-	},
-	"preferGlobal": true,
-	"description": "A secrets manager in times of crypto coins.",
-	"main": "src/index.js",
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/secrez/secrez.git"
-	},
-	"author": {
-		"name": "Francesco Sullo",
-		"email": "francesco@sullo.co"
-	},
-	"bugs": {
-		"url": "https://github.com/secrez/secrez/issues"
-	},
-	"homepage": "https://github.com/secrez/secrez#readme",
-	"engines": {
-		"node": ">=10.0.0"
-	},
-	"gitHead": "42cbc519dd2802a1e03c6203bb724c726c2bfb79"
+  "name": "secrez",
+  "version": "1.1.0",
+  "license": "MIT",
+  "scripts": {
+    "dev": "cross-env NODE_ENV=dev bin/secrez.js -c `pwd`/tmp/secrez-dev -i 1e3 -l `pwd`/tmp",
+    "lint": "eslint -c .eslintrc 'src/**/*.js' 'bin/*.js' 'test/*.test.js' 'test/**/*.js' 'test/**/**/*.js'",
+    "test-only": "cross-env NODE_ENV=test ./node_modules/.bin/mocha test/*.test.js test/**/*.test.js test/**/**/*.js --exit",
+    "test": "cross-env NODE_ENV=test nyc --reporter=lcov --reporter=text ./node_modules/.bin/_mocha test/*.test.js test/**/*.test.js test/**/**/*.js --exit",
+    "posttest": "nyc check-coverage --statements 65 --branches 50 --functions 65 --lines 65",
+    "build-helpers": "cd test/helpers/os && ./build.sh"
+  },
+  "nyc": {
+    "include": "src",
+    "exclude": []
+  },
+  "dependencies": {
+    "@secrez/core": "workspace:~1.0.3",
+    "@secrez/crypto": "workspace:~1.0.1",
+    "@secrez/fs": "workspace:~1.0.3",
+    "@secrez/hub": "workspace:~0.2.1",
+    "@secrez/utils": "workspace:~1.0.2",
+    "case": "^1.6.3",
+    "chalk": "^3.0.0",
+    "clipboardy": "^2.3.0",
+    "command-line-args": "^5.1.1",
+    "external-editor": "^3.1.0",
+    "fs-extra": "^9.1.0",
+    "homedir": "^0.6.0",
+    "inquirer": "^7.1.0",
+    "inquirer-command-prompt": "^0.1.0",
+    "jimp": "^0.13.0",
+    "lodash": "^4.17.15",
+    "otplib": "^12.0.1",
+    "qrcode-reader": "^1.0.4",
+    "superagent": "^5.3.1",
+    "tiny-cli-editor": "^0.1.1"
+  },
+  "devDependencies": {
+    "@secrez/courier": "workspace:~0.2.2",
+    "@secrez/test-helpers": "workspace:~1.0.2",
+    "chai": "^4.2.0",
+    "chalk": "^3.0.0",
+    "cross-env": "^7.0.2",
+    "eslint": "^6.8.0",
+    "eslint-plugin-node": "^11.0.0",
+    "mocha": "^7.1.1",
+    "nyc": "^15.1.0",
+    "test-console": "^1.1.0"
+  },
+  "bin": {
+    "secrez": "bin/secrez.js"
+  },
+  "preferGlobal": true,
+  "description": "A secrets manager in times of crypto coins.",
+  "main": "src/index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/secrez/secrez.git"
+  },
+  "author": {
+    "name": "Francesco Sullo",
+    "email": "francesco@sullo.co"
+  },
+  "bugs": {
+    "url": "https://github.com/secrez/secrez/issues"
+  },
+  "homepage": "https://github.com/secrez/secrez#readme",
+  "engines": {
+    "node": ">=10.0.0"
+  },
+  "gitHead": "42cbc519dd2802a1e03c6203bb724c726c2bfb79"
 }

package/src/commands/Import.js

@@ -99,8 +99,8 @@ class Import extends require('../Command') {
       examples: [
         ['import seed.json', 'copies seed.json from the disk into the current directory'],
         ['import seed.json.secrez --password s8eeuhwy36534', 'imports seed.json and decrypts it using the specified password'],
-        ['import seed.json.secrez -d', 'imports seed.json trying to decrypt it using the key shared with the contact who encrypted the data'],
-        ['import seed.json.secrez -d --public-key Tush76/u+..... ', 'imports seed.json trying to decrypt it using a shared key generated using the specified public key'],
+        ['import seed.json.secrez', 'imports seed.json trying to decrypt it using the key shared with the contact who encrypted the data'],
+        ['import seed.json.secrez--public-key Tush76/u+..... ', 'imports seed.json trying to decrypt it using a shared key generated using the specified public key'],
         ['import -m ethKeys', 'copies ethKeys and remove it from the disk'],
         ['import -p ~/passwords', 'imports all the text files in the folder passwords'],
         ['import -b -p ~/passwords', 'imports all the files, included binaries'],

package/src/commands/Totp.js

@@ -47,11 +47,23 @@ class Totp extends require('../Command') {
         alias: 'i',
         type: String
       },
+      {
+        name: 'set',
+        alias: 's',
+        type: String
+      },
+      {
+        name: 'force',
+        type: Boolean
+      },
       {
         name: 'test',
         type: String
       }
     ]
+    this.defaults = {
+      duration: 8
+    }
   }
 
   help() {
@@ -61,6 +73,8 @@ class Totp extends require('../Command') {
       ],
       examples: [
         ['totp coinbase.yml', 'prints a totp code and copies it to the clipboard for 5 seconds'],
+        ['totp coinbase.yml -s "9syh 34rd ge6s hey3 u874"', 'set up a totp code, if not set yet'],
+        ['totp github.com.yml -s USyehAA35TSE --force', 'update an existing totp code'],
         ['totp coinbase.yml -d 2', 'keeps it in the clipboard for 2 seconds'],
         ['totp github.yml --from-clipboard', 'get a secret from a qr code copied in the clipboard and add a field "totp" with the secret in "github.yml"'],
         ['totp github.yml --from-image qrcode.png', 'get a secret from the image'],
@@ -144,7 +158,7 @@ class Totp extends require('../Command') {
   }
 
   async totp(options = {}) {
-    let secret
+    let secret = options.set
     let originalPath = options.path
     if (options.test) {
       const token = authenticator.generate(options.test.replace(/\s/g, ''))
@@ -191,6 +205,9 @@ class Totp extends require('../Command') {
             throw new Error('The yml is malformed')
           }
           if (secret) {
+            if (parsed.totp && !options.force) {
+              throw new Error('A totp already set. Use the "--force" option to override it')
+            }
             parsed.totp = secret
             let entry = node.getEntry()
             entry.set('content', yamlStringify(parsed))
@@ -206,7 +223,7 @@ class Totp extends require('../Command') {
               const token = authenticator.generate(totp)
               this.prompt.commands.copy.copy({
                 thisString: token,
-                duration: [options.duration || 5],
+                duration: [options.duration || this.defaults.duration],
                 noBeep: options.noBeep
               })
               return token
@@ -230,7 +247,7 @@ class Totp extends require('../Command') {
       } else {
         this.Logger.grey('TOTP token: ' + this.chalk.bold.black(token))
         if (!options.test) {
-          this.Logger.grey(`It will stay in the clipboard for ${options.duration || 5} seconds`)
+          this.Logger.grey(`It will stay in the clipboard for ${options.duration || this.defaults.duration} seconds`)
         }
       }
     } catch (e) {

package/src/utils/HelpProto.js

@@ -108,7 +108,7 @@ class HelpProto {
           let m = max - x
           if (example.length <= m) {
             elem = spacer + ' '.repeat(x) + example
-            str.push(elem + ' '.repeat(tot - elem.length))
+            str.push(elem + ' '.repeat(tot > elem.length ? tot - elem.length : 3))
             break
           } else {
             j = -1
@@ -125,7 +125,7 @@ class HelpProto {
             }
             let good = example.substring(0, li)
             elem = spacer + ' '.repeat(x) + good
-            str.push(elem + ' '.repeat(tot - elem.length))
+            str.push(elem + ' '.repeat(tot > elem.length ? tot - elem.length : 3))
             example = example.substring(li + 1)
             i++
             // console.log(i, example)

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2017-present, Francesco Sullo <francesco@sullo.co>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.