shhh 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 326b0b0a82ce4ceb7e3a56a32f1f9546f88b9c83
-  data.tar.gz: c58225fb321bb2d459567f96140237829efcaef0
+  metadata.gz: 8be044ac1a326bd26c343102e64650b364ca6825
+  data.tar.gz: ae67a04259e58203f3d6cf54a1f7e22ebfe61279
 SHA512:
-  metadata.gz: 4dfcedd479814b71b5a0f0d4372e717fbcc66bd44e95b4053806cb280f9147aaa84bedac3c60793fc74ce12e45acf189f5df60ead4cc885bf1be9798b97a9475
-  data.tar.gz: 51eec0fd771a16205bc349a3f1de230c8623c942b4021655c3986d9bb6e4e2e4f9f13c736a8f1d558c0b126c2c63b73cd27e5d71efef9f66c01c65bcf8c27024
+  metadata.gz: a334844785be58e522aa97add26d34961799885540dffcc5f584939cad872bab7f97a0229fcefcd4856c0123cd19bc15e12602784a6ac28fdf94b14cb6762510
+  data.tar.gz: 273554d3ce0ffb40c60b878761fd60255df7d00366d1627812600536e5cf9528d5878b145fc82ce51b858205d9b5d25688d54d0e8069d35383d17ab5b9df2735

data/README.md

@@ -27,7 +27,7 @@ You see, security is an incredibly wide topic. The tools around security tend to
 > * Automatic detection of password-protected keys, 
 > * and more...
 
-The main point behind this gem is to allow you to store sensitive application shhh in your source code repo as `AES-256-CBC`-encrypted files or strings (this is the same encryption algorithm that US Government uses internally). The output of the encryption is always a (urlsafe) `base64`-encoded string, without the linebreaks.
+The main point behind this gem is to allow you to store sensitive application secrets in your source code repo as `AES-256-CBC`-encrypted files or strings (this is the same encryption algorithm that US Government uses internally). The output of the encryption is always a (urlsafe) `base64`-encoded string, without the linebreaks.
  
 The private key (encrypted or not) is also a base64-encoded string, typically 45 characters long (unless it's password encrypted, in which case it is considerably longer). 
  
@@ -64,9 +64,9 @@ This library relies on the existance of the 32-byte private key (aka, *a secret*
 
 > In fact, we put together a separate file that discusses strategies for protecting your encryption keys, for example you can read about [how to use Mac OS-X Keychain Access application](https://github.com/kigster/shhh/blob/master/MANAGING-KEYS.md) and other methods. Additions and discussion are welcome. Please contribute!
 
-You can use one key for all encrypted fields, or many keys – perhaps one per deployment environment, etc. While you can have per-field shhh, it seems like an overkill.
+You can use one key for all encrypted fields, or many keys – perhaps one per deployment environment, etc. While you can have per-field private key, it seems like an overkill.
 
-__NOTE: it is considered a bad practice to check in the private key into the version control.__  If you keep your secret out of your repo, you can check-in encrypted shhh file directly into the repo. As long as the private key itself is safe, the data in your encrypted  will be next to impossible to extract. 
+__NOTE: it is considered a bad practice to check in the private key into the version control.__  If you keep your secret out of your repo, you can check-in encrypted key file directly into the repo. As long as the private key itself is safe, the data in your encrypted  will be next to impossible to extract. 
 
 ### Command Line (CLI)
  
@@ -129,30 +129,32 @@ You can use this to add an existing key that can be used with the `shhh` later.
 
 ####  Encryption and Decryption
 
-This may be a good time to take a look at the full help message for the `shhh` tool:
+This may be a good time to take a look at the full help message for the `shhh` tool, shown naturally with a `-h` or `--help` option.
 
 ```bash
-❯ exe/shhh -h
+❯ shhh -h
+
 Usage:
     shhh [options]
 Modes:
-    -t, --edit                    decrypt, open encr. file in vim
     -e, --encrypt                 encrypt mode
     -d, --decrypt                 decrypt mode
-Private Key:
+    -t, --edit                    decrypt, open an encr. file in vim
+Create a private key:
     -g, --generate                generate a new private key
     -p, --password                encrypt the key with a password
-    -c, --copy                    copy the new key to a clipboard
+    -c, --copy                    copy the new key to the clipboard
+Provide a private key:
+    -i, --interactive             Paste or type the key interactively
     -k, --private-key  [key]      private key as a string
-    -K, --key-file     [key-file] file containing the key
-    -x, --keychain     [key-name] name of the generic password entry
-    -X, --delete-key   [key-name] delete keychain entry with that name
+    -K, --keyfile      [key-file] private key from a file
+Use your KeyChain password entry to store a private key:
+    -x, --keychain     [key-name] add to, or read the key from Keychain
+    --keychain-del     [key-name] delete keychain entry with that name
 Data:
     -s, --string       [string]   specify a string to encrypt/decrypt
     -f, --file         [file]     filename to read from
     -o, --output       [file]     filename to write to
-Data:
-    -i, --interactive             ask for a key interactively
     -b, --backup                  create a backup file in the edit mode
 Flags:
     -v, --verbose                 show additional information

data/lib/shhh/app/cli.rb

@@ -177,21 +177,22 @@ module Shhh
           o.string '-k', '--private-key', '[key]   '.bold.blue + '   private key as a string'
           o.string '-K', '--keyfile', '[key-file]'.bold.blue + ' private key from a file'
           if Shhh::App.is_osx?
-            o.string '-x', '--keychain', '[key-name] '.bold.blue + 'private key to/from a password entry'
+            o.separator 'Use your KeyChain password entry to store a private key:'.bold.yellow
+            o.string '-x', '--keychain', '[key-name] '.bold.blue + 'add to, or read the key from Keychain'
             o.string '--keychain-del', '[key-name] '.bold.blue + 'delete keychain entry with that name'
           end
           o.separator 'Data:'.bold.yellow
           o.string '-s', '--string', '[string]'.bold.blue + '   specify a string to encrypt/decrypt'
           o.string '-f', '--file', '[file]  '.bold.blue + '   filename to read from'
           o.string '-o', '--output', '[file]  '.bold.blue + '   filename to write to'
-          o.bool '-b', '--backup', '           create a backup file in the edit mode'
+          o.bool '-b',  '--backup',      '           create a backup file in the edit mode'
           o.separator 'Flags:'.bold.yellow
-          o.bool '-v', '--verbose', '           show additional information'
-          o.bool '-T', '--trace', '           print a backtrace of any errors'
-          o.bool '-E', '--examples', '           show several examples'
-          o.bool '-V', '--version', '           print library version'
-          o.bool '-N', '--no-color', '           disable color output'
-          o.bool '-e', '--encrypt', '           encrypt mode'
+          o.bool '-v',  '--verbose',     '           show additional information'
+          o.bool '-T',  '--trace',       '           print a backtrace of any errors'
+          o.bool '-E',  '--examples',    '           show several examples'
+          o.bool '-V',  '--version',     '           print library version'
+          o.bool '-N',  '--no-color',    '           disable color output'
+          o.bool '-e',  '--encrypt',     '           encrypt mode'
           o.separator ''
         end
       rescue StandardError => e

data/lib/shhh/app/commands/show_examples.rb

@@ -47,6 +47,18 @@ Diff:
 ---' + '
 # (c) 2016 Konstantin Gredeskoul.  All rights reserved.'.green.bold)
 
+
+          if Shhh::App.is_osx?
+          output << example(comment: 'generate a new password-encrypted key, save it to your Keychain:',
+                            command: 'shhh -gpx mykey -o ~/.key')
+
+          output << example(comment: 'use the new key to encrypt a file:',
+                            command: 'shhh -x mykey -e -f password.txt -o passwords.enc')
+
+          output << example(comment: 'use the new key to inline-edit the encrypted file:',
+                            command: 'shhh -x mykey -t -f shhh.yml')
+          end
+
           output.flatten.compact.join("\n")
         end
 

data/lib/shhh/version.rb

@@ -1,3 +1,3 @@
 module Shhh
-  VERSION = '1.4.0'
+  VERSION = '1.4.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shhh
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Konstantin Gredeskoul