Update CHANGELOG.md

Fix #256: Clarify .blackbox vs keyrings/live in README.md

.circleci/config.yml

@@ -0,0 +1,56 @@
+version: 2
+
+workflows:
+  version: 2
+  build_and_test:
+    jobs:
+      - debian
+      - ubuntu
+
+jobs:
+
+  debian:
+    docker:
+      - image: debian:9.1
+    steps:
+      - checkout
+      - run:
+          name: 'Installing'
+          command: |
+            apt-get update -y
+            apt-get install -y build-essential expect git gnupg2 pinentry-tty procps rpm ruby-dev libffi-dev
+            gem install fpm
+      - run:
+          name: 'Cleaning'
+          command: |
+            rm -rf ~/.gpnupg
+            make clean
+      - run:
+          name: 'Testing'
+          command: |
+            GPG=gpg2 make test
+            make packages-deb
+            make packages-rpm
+
+  ubuntu:
+    docker:
+      - image: ubuntu:16.04
+    steps:
+      - checkout
+      - run:
+          name: 'Installing'
+          command: |
+            apt-get update -y
+            apt-get install -y build-essential expect git gnupg2 pinentry-tty procps rpm ruby-dev libffi-dev
+            gem install fpm
+      - run:
+          name: 'Cleaning'
+          command: |
+            rm -rf ~/.gpnupg
+            make clean
+      - run:
+          name: 'Testing'
+          command: |
+            GPG=gpg2 make test
+            make packages-deb
+            make packages-rpm

.gitattributes

@@ -0,0 +1,5 @@
+bin/** text eol=lf
+tools/** text eol=lf
+Makefile text eol=lf
+Portfile text eol=lf
+blackbox.plugin.zsh text eol=lf

CHANGELOG.md

@@ -1,7 +1,36 @@
-Release v1.20170127
-
-* Starting CHANGELOG.
+Release v1.20180615
 
+* Standardize on .blackbox for config. Use keyrings/live for backwards compatibility.
+* Store keys in .blackbox directory (#218)
+* Suggest committing changes to pubring.gpg when running blackbox_removeadmin (#248)
+* Fix typo (#246)
+* Improve installation instructions (#244)
+* Fix replacing-expired-keys link in README (#241)
+* Fix problems when gpg2 is installed next to gpg (#237)
+* Many documentation corrections, updates, etc.
+* Exclude default keyring from import (#223)
+* .gitattributes not always updated (PR#146)
+* Fix bugs related to updating .gitattributes (PR#146)
+* Update readme with CircleCI link (#216)
+* Run the tests on a CI (#215)
+* Fixed Alpine compatibility (chmod) (#212)
+* direct repobase message to stderr (#204)
+* Improve Windows compatibility
+* NEW: .gitattributes Set Unix-only files to eol=lf
+* Silence 'not changed' output during keychain import (#200)
+* Improve FreeBSD compatibility
+* shred_file() outputs warning message to stderr. (#192)
+* Don't complain about GPG_AGENT_INFO if using newer gpg-agent (#189)
+* [FreeBSD] Fix use of chmod (#180)
+* Requiring a file to be entered to finish editing (#175)
+* Remove the key from the keyring when removing an admin (#173)
+* Add FreeBSD support (#172)
+* Add list admins commandline tool. (#170)
+ignore backup files and secring.gpg in $BLACKBOXDATA (#169)
+Allow parallel shredding of files (#167)
+* Add/improve Mingw support
+* Make "make confidence" less fragile
+* And a lot, lot more.
 
 Release v1.20170309
 
@@ -24,3 +53,7 @@ Release v1.20170611
 * blackbox_shred_all_files: BUGFIX: Does not shred files with spaces
 * blackbox_removeadmin: disable gpg's confirmation
 * Sync mk_rpm_fpmdir from master
+
+Release v1.20170127
+
+* Starting CHANGELOG.

LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2016 Stack Exchange, Inc.
+Copyright (c) 2014-2018 Stack Exchange, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -6,15 +6,18 @@ OUTPUTDIR?="$(BASEDIR)/debbuild-${PKGNAME}"
 
 all:
 	@echo 'Menu:'
-	@echo '  make update            Update any generated files'
-	@echo '  make packages          Make RPM packages'
-	@echo '  make packages-deb      Make DEB packages'
-	@echo '  make test              Run tests'
-	@echo '  make install           (incomplete)'
+	@echo '  make update             Update any generated files'
+	@echo '  make packages-rpm       Make RPM packages'
+	@echo '  make packages-deb       Make DEB packages'
+	@echo '  make symlinks-install   Make symlinks in /usr/local/bin/'
+	@echo '  make copy-install       Copy "bin" files to /usr/local/bin/'
+	@echo '  make usrlocal-uninstall Remove blackbox files from /usr/local/bin/'
+	@echo '  make test               Run tests'
 
 install:
 	@echo 'To install, copy the files from bin to somewhere in your PATH.'
-	@echo 'Or, if you use RPMs, "make packages" and install the result.'
+	@echo 'The README.md document gives more details.'
+	@echo 'Or run "make" (with no options) for more info.'
 
 # The default package type is RPM.
 packages: packages-rpm
@@ -51,12 +54,17 @@ unlock-rpm:
 #
 # Manual install
 #
-manual-install:
+symlinks-install:
 	@echo 'Symlinking files from ./bin to /usr/local/bin'
 	@cd bin && for f in `find . -type f -iname "*" ! -iname "Makefile"`; do ln -fs `pwd`/$$f /usr/local/bin/$$f; done
 	@echo 'Done.'
 
-manual-uninstall:
+copy-install:
+	@echo 'Copying files from ./bin to /usr/local/bin'
+	@cd bin && for f in `find . -type f -iname "*" ! -iname "Makefile"`; do cp `pwd`/$$f /usr/local/bin/$$f; done
+	@echo 'Done.'
+
+usrlocal-uninstall:
 	@echo 'Removing blackbox files from /usr/local/bin'
 	@cd bin && for f in `find . -type f -iname "*" ! -iname "Makefile"`; do rm /usr/local/bin/$$f; done
 	@echo 'Done.'
@@ -118,7 +126,7 @@ uninstall-stow:
 update: tools/mk_deb_fpmdir.stack_blackbox.txt tools/mk_macports.vcs_blackbox.txt
 
 clean:
-	rm tools/mk_deb_fpmdir.stack_blackbox.txt tools/mk_macports.vcs_blackbox.txt
+	rm -f tools/mk_deb_fpmdir.stack_blackbox.txt tools/mk_macports.vcs_blackbox.txt
 
 #
 # System Test:

README.md

@@ -1,4 +1,4 @@
-BlackBox
+BlackBox [![CircleCI](https://circleci.com/gh/StackExchange/blackbox.svg?style=shield)](https://circleci.com/gh/StackExchange/workflows/blackbox)
 ========
 
 Safely store secrets in a VCS repo (i.e. Git, Mercurial, Subversion or Perforce). These commands make it easy for you to Gnu Privacy Guard (GPG) encrypt specific files in a repo so they are "encrypted at rest" in your repository. However, the scripts make it easy to decrypt them when you need to view or edit them, and decrypt them for use in production. Originally written for Puppet, BlackBox now works with any Git or Mercurial repository.
@@ -14,30 +14,31 @@ Table of Contents
 - [Table of Contents](#table-of-contents)
 - [Overview](#overview)
 - [Why is this important?](#why-is-this-important)
-- [Installation Instructions:](#installation-instructions)
-- [Commands:](#commands)
-- [Compatibility:](#compatibility)
+- [Installation Instructions](#installation-instructions)
+- [Commands](#commands)
+- [Compatibility](#compatibility)
 - [How is the encryption done?](#how-is-the-encryption-done)
 - [What does this look like to the typical user?](#what-does-this-look-like-to-the-typical-user)
 - [How to use the secrets with Puppet?](#how-to-use-the-secrets-with-puppet)
-  - [Entire files:](#entire-files)
-  - [Small strings:](#small-strings)
+  - [Entire files](#entire-files)
+  - [Small strings](#small-strings)
 - [How to enroll a new file into the system?](#how-to-enroll-a-new-file-into-the-system)
 - [How to remove a file from the system?](#how-to-remove-a-file-from-the-system)
 - [How to indoctrinate a new user into the system?](#how-to-indoctrinate-a-new-user-into-the-system)
 - [How to remove a user from the system?](#how-to-remove-a-user-from-the-system)
-- [Enabling Blackbox For a Repo](#enabling-blackbox-for-a-repo)
+- [Enabling BlackBox For a Repo](#enabling-blackbox-for-a-repo)
 - [Set up automated users or “role accounts”](#set-up-automated-users-or-role-accounts)
-- [Replace expired keys:](#replace-expired-keys)
-- [Some common errors:](#some-common-errors)
-- [Using Blackbox without a repo](#using-blackbox-without-a-repo)
-- [Some Subversion gotchas:](#some-subversion-gotchas)
+- [Replacing expired keys](#replacing-expired-keys)
+- [Some common errors](#some-common-errors)
+- [Using BlackBox on Windows](#using-blackbox-on-windows)
+- [Using BlackBox without a repo](#using-blackbox-without-a-repo)
+- [Some Subversion gotchas](#some-subversion-gotchas)
+- [Using Blackbox when gpg2 is installed next to gpg](#using-blackbox-when-gpg2-is-installed-next-to-gpg)
 - [How to submit bugs or ask questions?](#how-to-submit-bugs-or-ask-questions)
 - [Developer Info](#developer-info)
 - [Alternatives](#alternatives)
 - [License](#license)
 
-
 Overview
 ========
 
@@ -60,20 +61,21 @@ NOT SO OBVIOUSLY when we store "secrets" in a VCS repo like Git or Mercurial, su
 
 The ability to be open and transparent about our code, with the exception of a few specific files, is key to the kind of collaboration that DevOps and modern IT practitioners need to do.
 
-Installation Instructions:
-==========================
+Installation Instructions
+=========================
 
--	*The MacPorts Way*: `sudo port install vcs_blackbox`
--	*The Homebrew Way*: `brew install blackbox`
--	*The RPM way*: Check out the repo and make an RPM via `make packages-rpm`; now you can distribute the RPM via local methods.
--	*The Debian/Ubuntu way*: Check out the repo and install [fpm](https://github.com/jordansissel/fpm). Now you can make a DEB `make packages-deb` that can be distributed via local methods.
--	*The hard way*: Copy all the files in "bin" to your "bin".
--	*The manual way*: `make manual-install` to install. `make manual-uninstall` to uninstall.
--	*The Antigen Way*: Add `antigen bundle StackExchange/blackbox` to your .zshrc
--	*The Zgen Way*: Add `zgen load StackExchange/blackbox` to your .zshrc where you're loading your other plugins.
+- *The hard way (manual*: Copy all the files in "bin" to your "bin".
+- *The hard way (automatic)*: `make copy-install` will copy the bin files into /usr/local/bin (uninstall with `make usrlocal-uninstall`).
+- *The symlinks way*: `make symlinks-install` will make symlinks of the bin files into /usr/local/bin (uninstall with `make usrlocal-uninstall`) (useful when doing development)
+- *The MacPorts Way*: `sudo port install vcs_blackbox`
+- *The Homebrew Way*: `brew install blackbox`
+- *The RPM way*: Check out the repo and make an RPM via `make packages-rpm`; now you can distribute the RPM via local methods. (Requires [fpm](https://github.com/jordansissel/fpm).)
+- *The Debian/Ubuntu way*: Check out the repo and make a DEB via `make packages-deb`; now you can distribute the DEB via local methods. (Requires [fpm](https://github.com/jordansissel/fpm).)
+- *The Antigen Way*: Add `antigen bundle StackExchange/blackbox` to your .zshrc
+- *The Zgen Way*: Add `zgen load StackExchange/blackbox` to your .zshrc where you're loading your other plugins.
 
-Commands:
-=========
+Commands
+========
 
 | Name:                               | Description:                                                            |
 |-------------------------------------|-------------------------------------------------------------------------|
@@ -95,52 +97,82 @@ Commands:
 | `blackbox_update_all_files`         | Decrypt then re-encrypt all files. Useful after keys are changed        |
 | `blackbox_whatsnew <file>`          | show what has changed in the last commit for a given file               |
 
-Compatibility:
-==============
+Compatibility
+=============
 
-Blackbox automatically determines which VCS you are using and does the right thing. It has a plug-in architecture to make it easy to extend to work with other systems. It has been tested to work with many operating systems.
+BlackBox automatically determines which VCS you are using and does the right thing. It has a plug-in architecture to make it easy to extend to work with other systems. It has been tested to work with many operating systems.
 
--	Version Control systems
-	-	`git` -- The Git
-	-	`hg` -- Mercurial
-	-	`svn` -- SubVersion (Thanks, Ben Drasin!)
-	-	`p4` -- Perforce
-	-	none -- The files can be decrypted outside of a repo if the keyrings directory is intact
--	Operating system
-	-	CentOS / RedHat
-	-	MacOS X
-	-	Cygwin (Thanks, Ben Drasin!)
-	-	MinGW (git bash on windows) **See Note Below**
+- Version Control systems
+  - `git` -- The Git
+  - `hg` -- Mercurial
+  - `svn` -- SubVersion (Thanks, Ben Drasin!)
+  - `p4` -- Perforce
+  - none -- The files can be decrypted outside of a repo if the `.blackbox` directory is intact
+- Operating system
+  - CentOS / RedHat
+  - MacOS X
+  - Cygwin (Thanks, Ben Drasin!) **See Note Below**
+  - MinGW (git bash on windows) **See Note Below**
 
 To add or fix support for a VCS system, look for code at the end of `bin/_blackbox_common.sh`
 
 To add or fix support for a new operating system, look for the case statements in `bin/_blackbox_common.sh` and `bin/_stack_lib.sh` and maybe `tools/confidence_test.sh`
 
-Note: Cywin support requires the following packages:
+Using BlackBox on Windows
+=========================
 
--	Normal operation:
-	-	gnupg
-	-	git or mercurial or subversion or perforce (as appropriate)
--	Development (if you will be adding code and want to run the confidence test)
-	-	procps
-	-	make
-	-	git (the confidence test currently only tests git)
+BlackBox can be used with Cygwin or MinGW.
 
-Note: MinGW (comes with Git for Windows) support requires the following additional installations
--	Normal operation:
-	-	[Git for Windows](https://git-scm.com/) (not tested with Mercurial)
-		-	Git Bash MINTTY returns a MinGW console.  So when you install make sure you pick `MINTTY` instead of windows console.  You'll be executing blackbox from the Git Bash prompt.
-		-	You need at least version 2.8.1 of Git for Windows.
-	-	[GnuWin32](https://sourceforge.net/projects/getgnuwin32/files/) - needed for various tools not least of which is mktemp which is used by blackbox
-		-	after downloading the install just provides you with some batch files.  Because of prior issues at sourceforge and to make sure you get the latest version of each package the batch files handle the brunt of the work of getting the correct packages and installing them for you.
-		-	from a **windows command prompt** run `download.bat`  once it has completed run `install.bat` then add the path for those tools to your PATH (ex: `PATH=%PATH%;c:\GnuWin32\bin`)
--	Development: 
-	-	unknown
+### Protect the line endings
+
+BlackBox assumes that `blackbox-admins.txt` and `blackbox-files.txt` will have
+LF line endings. Windows users should be careful to configure Git or other systems
+to not convert or "fix" those files.
+
+If you use Git, add the following lines to your `.gitattributes` file:
+
+    **/blackbox-admins.txt text eol=lf
+    **/blackbox-files.txt text eol=lf
+
+The latest version of `blackbox_initialize` will create a `.gitattributes` file in the `$BLACKBOXDATA`
+directory (usually `.blackbox`) for you.
+
+### Cygwin
+
+Cygwin support requires the following packages:
+
+Normal operation:
+
+- gnupg
+- git or mercurial or subversion or perforce (as appropriate)
+
+Development (if you will be adding code and want to run the confidence test)
+
+- procps
+- make
+- git (the confidence test currently only tests git)
+
+### MinGW
+
+MinGW (comes with Git for Windows) support requires the following:
+
+Normal operation:
+
+- [Git for Windows](https://git-scm.com/) (not tested with Mercurial)
+  - Git Bash MINTTY returns a MinGW console.  So when you install make sure you pick `MINTTY` instead of windows console.  You'll be executing blackbox from the Git Bash prompt.
+  - You need at least version 2.8.1 of Git for Windows.
+- [GnuWin32](https://sourceforge.net/projects/getgnuwin32/files/) - needed for various tools not least of which is mktemp which is used by blackbox
+  - after downloading the install just provides you with some batch files.  Because of prior issues at sourceforge and to make sure you get the latest version of each package the batch files handle the brunt of the work of getting the correct packages and installing them for you.
+  - from a **windows command prompt** run `download.bat`  once it has completed run `install.bat` then add the path for those tools to your PATH (ex: `PATH=%PATH%;c:\GnuWin32\bin`)
+
+Development:
+
+- unknown (if you develop Blackbox under MinGW, please let us know if any additional packages are required to run `make test`)
 
 How is the encryption done?
 ===========================
 
-GPG has many different ways to encrypt a file. BlackBox uses the mode that lets you specify a list of keys that can decrypt the messsage.
+GPG has many different ways to encrypt a file. BlackBox uses the mode that lets you specify a list of keys that can decrypt the message.
 
 If you have 5 people ("admins") that should be able to access the secrets, each creates a GPG key and adds their public key to the keychain. The GPG command used to encrypt the file lists all 5 key names, and therefore any 1 key can decrypt the file.
 
@@ -154,20 +186,20 @@ To remove someone's access, remove that admin's key name (i.e. email address) fr
 
 *If you use Puppet, why didn't you just use hiera-eyaml?* There are 4 reasons:
 
-1.	This works with any Git or Mercurial repo, even if you aren't using Puppet.
-2.	hiera-eyaml decrypts "on demand" which means your Puppet Master now uses a lot of CPU to decrypt keys every time it is contacted. It slows down your master, which, in my case, is already slow enough.
-3.	This works with binary files, without having to ASCIIify them and paste them into a YAML file. Have you tried to do this with a cert that is 10K long and changes every few weeks? Ick.
-4.	hiera-eyaml didn't exist when I wrote this.
+1. This works with any Git or Mercurial repo, even if you aren't using Puppet.
+2. hiera-eyaml decrypts "on demand" which means your Puppet Master now uses a lot of CPU to decrypt keys every time it is contacted. It slows down your master, which, in my case, is already slow enough.
+3. This works with binary files, without having to ASCIIify them and paste them into a YAML file. Have you tried to do this with a cert that is 10K long and changes every few weeks? Ick.
+4. hiera-eyaml didn't exist when I wrote this.
 
 What does this look like to the typical user?
 =============================================
 
--	If you need to, start the GPG Agent: `eval $(gpg-agent --daemon)`
--	Decrypt the file so it is editable: `blackbox_edit_start FILENAME`
--	(You will need to enter your GPG passphrase.)
--	Edit FILENAME as you desire: `vim FILENAME`
--	Re-encrypt the file: `blackbox_edit_end FILENAME`
--	Commit the changes. `git commit -a` or `hg commit`
+- If you need to, start the GPG Agent: `eval $(gpg-agent --daemon)`
+- Decrypt the file so it is editable: `blackbox_edit_start FILENAME`
+- (You will need to enter your GPG passphrase.)
+- Edit FILENAME as you desire: `vim FILENAME`
+- Re-encrypt the file: `blackbox_edit_end FILENAME`
+- Commit the changes. `git commit -a` or `hg commit`
 
 Wait... it can be even easier than that! Run `blackbox_edit FILENAME`, and it'll decrypt the file in a temp file and call `$EDITOR` on it, re-encrypting again after the editor is closed.
 
@@ -228,8 +260,8 @@ The variable `$the_password` will contain "my secret password" and can be used a
 How to enroll a new file into the system?
 =========================================
 
--	If you need to, start the GPG Agent: `eval $(gpg-agent --daemon)`
--	Add the file to the system:
+- If you need to, start the GPG Agent: `eval $(gpg-agent --daemon)`
+- Add the file to the system:
 
 ```
 blackbox_register_new_file path/to/file.name.key
@@ -261,7 +293,9 @@ blackbox_deregister_file path/to/file.name.key
 How to indoctrinate a new user into the system?
 ===============================================
 
-`keyrings/live/blackbox-admins.txt` is a file that lists which users are able to decrypt files. (More pedantically, it is a list of the GnuPG key names that the file is encrypted for.)
+FYI: Your repo may use `keyrings/live` instead of `.blackbox`. See "Where is the configuration stored?"
+
+`.blackbox/blackbox-admins.txt` is a file that lists which users are able to decrypt files. (More pedantically, it is a list of the GnuPG key names that the file is encrypted for.)
 
 To join the list of people that can edit the file requires three steps; You create a GPG key and add it to the key ring. Then, someone that already has access adds you to the system. Lastly, you should test your access.
 
@@ -273,7 +307,7 @@ If you don't already have a GPG key, here's how to generate one:
 gpg --gen-key
 ```
 
-Pick defaults for encryption settings, 0 expiration. Pick a VERY GOOD passphrase. Store the private key securely. Tip: Store it on a secure machine, or one with little or no internet access, with full-disk-encryption, etc. Your employer problably has rules about how to store such things.
+Pick defaults for encryption settings, 0 expiration. Pick a VERY GOOD passphrase. Store a backup of the private key someplace secure. For example, keep the backup copy on a USB drive that is locked in safe.  Or, at least put it on a machine secure machine with little or no internet access, full-disk-encryption, etc. Your employer probably has rules about how to store such things.
 
 Now that you have a GPG key, add yourself as an admin:
 
@@ -290,7 +324,7 @@ blackbox_addadmin tal@example.com
 When the command completes successfully, instructions on how to commit these changes will be output. Run the command as given to commit the changes. It will look like this:
 
 ```
-git commit -m'NEW ADMIN: tal@example.com' keyrings/live/pubring.gpg keyrings/live/trustdb.gpg keyrings/live/blackbox-admins.txt
+git commit -m'NEW ADMIN: tal@example.com' .blackbox/pubring.gpg .blackbox/trustdb.gpg .blackbox/blackbox-admins.txt
 ```
 
 Then push it to the repo:
@@ -314,7 +348,7 @@ Ask someone that already has access to re-encrypt the data files. This gives you
 Pre-check: Verify the new keys look good.
 
 ```
-$ gpg --homedir=keyrings/live --list-keys 
+gpg --homedir=.blackbox --list-keys
 ```
 
 For example, examine the key name (email address) to make sure it conforms to corporate standards.
@@ -322,7 +356,7 @@ For example, examine the key name (email address) to make sure it conforms to co
 Import the keychain into your personal keychain and reencrypt:
 
 ```
-gpg --import keyrings/live/pubring.gpg
+gpg --import .blackbox/pubring.gpg
 blackbox_update_all_files
 ```
 
@@ -358,27 +392,61 @@ When the command completes, you will be given a reminder to check in the change
 
 Note that their keys will still be in the key ring, but they will go unused. If you'd like to clean up the keyring, use the normal GPG commands and check in the file.
 
+FYI: Your repo may use `keyrings/live` instead of `.blackbox`. See "Where is the configuration stored?"
+
 ```
-gpg --homedir=keyrings/live --list-keys
-gpg --homedir=keyrings/live --delete-key olduser@example.com
-git commit -m'Cleaned olduser@example.com from keyring'  keyrings/live/*
+gpg --homedir=.blackbox --list-keys
+gpg --homedir=.blackbox --delete-key olduser@example.com
+git commit -m'Cleaned olduser@example.com from keyring'  .blackbox/*
 ```
 
+FYI: Your repo may use `keyrings/live` instead of `.blackbox`. See "Where is the configuration stored?"
+
 The key ring only has public keys. There are no secret keys to delete.
 
 Remember that this person did have access to all the secrets at one time. They could have made a copy. Therefore, to be completely secure, you should change all passwords, generate new SSL keys, and so on just like when anyone that had privileged access leaves an organization.
 
-Enabling Blackbox For a Repo
+Where is the configuration stored? .blackbox vs. keyrings/live
+==============================================================
+
+Blackbox stores its configuration data in the `.blackbox` subdirectory.  Older
+repos use `keyrings/live`.  For backwards compatibility either will work.
+
+All documentation refers to `.blackbox`.
+
+You can convert an old repo by simply renaming the directory:
+
+```
+mv keyrings/live .blackbox
+rmdir keyrings
+```
+
+There is no technical reason to convert old repos except that it is less
+confusing to users.
+
+This change was made in commit 60e782a0, release v1.20180615.
+
+The details:
+
+- First Blackbox checks `$BLACKBOXDATA`. If this environment variable is set, this is the directory that will be used. If it lists a directory that does not exist, Blackbox will print an error and exit.
+- If `$BLACKBOXDATA` is not set: (which is the typical use case)
+  - Blackbox will first try `keyrings/live` and use it if it exists.
+  - Otherwise the default `.blackbox` will be used.  If `.blackbox` does not exist, Blackbox will print an error and exit.
+
+
+Enabling BlackBox For a Repo
 ============================
 
 Overview:
 
 To add "blackbox" to a git or mercurial repo, you'll need to do the following:
 
-1.	Run the initialize script. This adds a few files to your repo in a directory called "keyrings".
-2.	For the first user, create a GPG key and add it to the key ring.
-3.	Encrypt the files you want to be "secret".
-4.	For any automated user (one that must be able to decrypt without a passphrase), create a GPG key and create a subkey with an empty passphrase.
+1. Run the initialize script. This adds a few files to your repo in a directory called ".blackbox".
+2. For the first user, create a GPG key and add it to the key ring.
+3. Encrypt the files you want to be "secret".
+4. For any automated user (one that must be able to decrypt without a passphrase), create a GPG key and create a subkey with an empty passphrase.
+
+FYI: Your repo may use `keyrings/live` instead of `.blackbox`. See "Where is the configuration stored?"
 
 ### Run the initialize script.
 
@@ -429,6 +497,8 @@ Set up automated users or "role accounts"
 
 i.e. This is how a Puppet Master can have access to the unencrypted data.
 
+FYI: Your repo may use `keyrings/live` instead of `.blackbox`. See "Where is the configuration stored?"
+
 An automated user (a "role account") is one that that must be able to decrypt without a passphrase. In general you'll want to do this for the user that pulls the files from the repo to the master. This may be automated with Jenkins CI or other CI system.
 
 GPG keys have to have a passphrase. However, passphrases are optional on subkeys. Therefore, we will create a key with a passphrase then create a subkey without a passphrase. Since the subkey is very powerful, it should be created on a very secure machine.
@@ -441,9 +511,9 @@ ProTip: If asked to generate entropy, consider running this on the same machine
 
 For the rest of this doc, you'll need to make the following substitutions:
 
--	ROLEUSER: svc_deployacct or whatever your role account's name is.
--	NEWMASTER: the machine this role account exists on.
--	SECUREHOST: The machine you use to create the keys.
+- ROLEUSER: svc_deployacct or whatever your role account's name is.
+- NEWMASTER: the machine this role account exists on.
+- SECUREHOST: The machine you use to create the keys.
 
 NOTE: This should be more automated/scripted. Patches welcome.
 
@@ -491,9 +561,9 @@ Command> save
 Now securely export this directory to NEWMASTER:
 
 ```
-$ gpg --homedir . --export -a svc_sadeploy >/tmp/NEWMASTER/pubkey.txt
-$ tar cvf /tmp/keys.tar .
-$ rsync -avP /tmp/keys.tar NEWMASTER:/tmp/.
+gpg --homedir . --export -a svc_sadeploy >/tmp/NEWMASTER/pubkey.txt
+tar cvf /tmp/keys.tar .
+rsync -avP /tmp/keys.tar NEWMASTER:/tmp/.
 ```
 
 On NEWMASTER, receive the new GnuPG config:
@@ -508,12 +578,12 @@ cd ~/.gnupg && tar xpvf /tmp/keys.tar
 Back on SECUREHOST, import the pubkey into the repository.
 
 ```
-$ cd keyrings/live
+$ cd .blackbox
 $ gpg --homedir . --import /tmp/NEWMASTER/pubkey.txt
 ```
 -->
 
-Back on SECUREHOST, add the new email address to keyrings/live/blackbox-admins.txt:
+Back on SECUREHOST, add the new email address to .blackbox/blackbox-admins.txt:
 
 ```
 cd /path/to/the/repo
@@ -523,14 +593,14 @@ blackbox_addadmin $KEYNAME /tmp/NEWMASTER
 Verify that secring.gpg is a zero-length file. If it isn't, you have somehow added a private key to the keyring. Start over.
 
 ```
-$ cd keyrings/live
-$ ls -l secring.gpg
+cd .blackbox
+ls -l secring.gpg
 ```
 
 Commit the recent changes:
 
 ```
-$ cd keyrings/live
+cd .blackbox
 git commit -m"Adding key for KEYNAME" pubring.gpg trustdb.gpg blackbox-admins.txt
 ```
 
@@ -547,7 +617,7 @@ On NEWMASTER, import the keys and decrypt the files:
 
 ```
 sudo -u svc_sadeploy bash   # Become the role account.
-gpg --import /etc/puppet/keyrings/live/pubring.gpg
+gpg --import /etc/puppet/.blackbox/pubring.gpg
 export PATH=$PATH:/path/to/blackbox/bin
 blackbox_postdeploy
 sudo -u puppet cat /etc/puppet/hieradata/blackbox.yaml # or any encrypted file.
@@ -555,7 +625,7 @@ sudo -u puppet cat /etc/puppet/hieradata/blackbox.yaml # or any encrypted file.
 
 ProTip: If you get "gpg: decryption failed: No secret key" then you forgot to re-encrypt blackbox.yaml with the new key.
 
-On SECUREHOST, securerly delete your files:
+On SECUREHOST, securely delete your files:
 
 ```
 cd /tmp/NEWMASTER
@@ -568,19 +638,30 @@ rm -rf /tmp/NEWMASTER
 
 Also shred any other temporary files you may have made.
 
-Replace expired keys:
-=====================
+Replacing expired keys
+======================
 
-If any one admin's key expires, you can no longer encrypt files. You will need to replace the key and re-encrypt.
-
--	Step 0: You see this error:
+If someone's key has already expired, blackbox will stop
+encrypting.  You see this error:
 
 ```
 $ blackbox_edit_end modified_file.txt
 --> Error: can't re-encrypt because a key has expired.
 ```
 
--	Step 1. Administrator removes expired user:
+FYI: Your repo may use `keyrings/live` instead of `.blackbox`. See "Where is the configuration stored?"
+
+You can also detect keys that are about to expire by issuing this command and manually reviewing the "expired:" dates:
+
+    gpg --homedir=.blackbox  --list-keys
+
+or... list UIDs that will expire within 1 month from today: (Warning: this also lists keys without an expiration date)
+
+    gpg --homedir=.blackbox --list-keys  --with-colons --fixed-list-mode  | grep ^uid | awk -F: '$6 < '$(( $(date +%s) + 2592000))
+
+Here's how to replace the key:
+
+- Step 1. Administrator removes expired user:
 
 Warning: This process will erase any unencrypted files that you were in the process of editing. Copy them elsewhere and restore the changes when done.
 
@@ -589,31 +670,31 @@ blackbox_removeadmin expired_user@example.com
 # This next command overwrites any changed unencrypted files. See warning above.
 blackbox_update_all_files
 git commit -m "Re-encrypt all files"
-gpg --homedir=keyrings/live --delete-key expired_user@example.com
-git commit -m 'Cleaned expired_user@example.com from keyring'  keyrings/live/*
+gpg --homedir=.blackbox --delete-key expired_user@example.com
+git commit -m 'Cleaned expired_user@example.com from keyring'  .blackbox/*
 git push
 ```
 
--	Step 2. Expired user adds an updated key:
+- Step 2. Expired user adds an updated key:
 
 ```
 git pull
 blackbox_addadmin updated_user@example.com
-git commit -m'NEW ADMIN: updated_user@example.com keyrings/live/pubring.gpg keyrings/live/trustdb.gpg keyrings/live/blackbox-admins.txt
+git commit -m'NEW ADMIN: updated_user@example.com .blackbox/pubring.gpg .blackbox/trustdb.gpg .blackbox/blackbox-admins.txt
 git push
 ```
 
--	Step 3. Administrator re-encrypts all files with the updated key of the expired user:
+- Step 3. Administrator re-encrypts all files with the updated key of the expired user:
 
 ```
 git pull
-gpg --import keyrings/live/pubring.gpg 
+gpg --import .blackbox/pubring.gpg
 blackbox_update_all_files
 git commit -m "Re-encrypt all files"
 git push
 ```
 
--	Step 4: Clean up:
+- Step 4: Clean up:
 
 Any files that were temporarily copied in the first step so as to not be overwritten can now be copied back and re-encrypted with the `blackbox_edit_end` command.
 
@@ -624,11 +705,13 @@ Any files that were temporarily copied in the first step so as to not be overwri
 It's possible to tell Git to decrypt versions of the file before running them through `git diff` or `git log`. To achieve this do:
 
 - Add the following to `.gitattributes` at the top of the git repository:
+
 ```
 *.gpg diff=blackbox
 ```
 
 - Add the following to `.git/config`:
+
 ```
 [diff "blackbox"]
     textconv = gpg --use-agent -q --batch --decrypt
@@ -636,33 +719,50 @@ It's possible to tell Git to decrypt versions of the file before running them th
 
 And now commands like `git log -p file.gpg` will show a nice log of the changes in the encrypted file.
 
-Some common errors:
-===================
+Some common errors
+==================
 
-`gpg: filename: skipped: No public key` -- Usually this means there is an item in `keyrings/live/blackbox-admins.txt` that is not the name of the key. Either something invalid was inserted (like a filename instead of a username) or a user has left the organization and their key was removed from the keychain, but their name wasn't removed from the blackbox-admins.txt file.
+`gpg: filename: skipped: No public key` -- Usually this means there is an item in `.blackbox/blackbox-admins.txt` that is not the name of the key. Either something invalid was inserted (like a filename instead of a username) or a user has left the organization and their key was removed from the keychain, but their name wasn't removed from the blackbox-admins.txt file.
 
 `gpg: decryption failed: No secret key` -- Usually means you forgot to re-encrypt the file with the new key.
 
-`Error: can't re-encrypt because a key has expired.` -- A user's key has expired and can't be used to encrypt any more. Follow the[Replace expired keys](#replace-expired-keys) tip.
+`Error: can't re-encrypt because a key has expired.` -- A user's key has expired and can't be used to encrypt any more. Follow the [Replace expired keys](#replace-expired-keys) tip.
+
+FYI: Your repo may use `keyrings/live` instead of `.blackbox`. See "Where is the configuration stored?"
 
 Using Blackbox without a repo
 =============================
 
-If the files are copied out of a repo they can still be decrypted and edited. Obviously edits, changes to keys, and such will be lost if they are made outside the repo. Also note that commands are most likely to only work if run from the base directory (i.e. the parent to the keyrings directory).
+If the files are copied out of a repo they can still be decrypted and edited. Obviously edits, changes to keys, and such will be lost if they are made outside the repo. Also note that commands are most likely to only work if run from the base directory (i.e. the parent to the .blackbox directory).
 
 The following commands have been tested outside a repo:
 
--	`blackbox_postdeploy`
--	`blackbox_edit_start`
--	`blackbox_edit_end`
+- `blackbox_postdeploy`
+- `blackbox_edit_start`
+- `blackbox_edit_end`
 
-Some Subversion gotchas:
-========================
+Some Subversion gotchas
+=======================
 
-The current implementation will store the blackbox in `/keyrings` at the root of the entire repo.  this will create an issue between environments that have different roots (ie, checking out `/` on development vs `/releases/foo` in production).  To get around this, you can `export BLACKBOX_REPOBASE=/path/to/repo` and set a specific base for your repo.
+The current implementation will store the blackbox in `/keyrings` at the root of the entire repo.  This will create an issue between environments that have different roots (i.e. checking out `/` on development vs `/releases/foo` in production). To get around this, you can `export BLACKBOX_REPOBASE=/path/to/repo` and set a specific base for your repo.
 
 This was originally written for git and supports a two-phase commit, in which `commit` is a local commit and "push" sends the change upstream to the version control server when something is registered or deregistered with the system.  The current implementation will immediately `commit` a file (to the upstream subversion server) when you execute a `blackbox_*` command.
 
+Using Blackbox when gpg2 is installed next to gpg
+=================================================
+
+In some situations, team members or automated roles need to install gpg
+2.x alongside the system gpg version 1.x to catch up with the team's gpg
+version. On Ubuntu 16, you can ```apt-get install gnupg2``` which
+installs the binary gpg2. If you want to use this gpg2 binary, run every
+blackbox command with GPG=gpg2.
+
+For example:
+
+```
+GPG=gpg2 blackbox_postdeploy
+```
+
 How to submit bugs or ask questions?
 ====================================
 
@@ -670,9 +770,7 @@ We welcome questions, bug reports and feedback!
 
 The best place to start is to join the [blackbox-project mailing list](https://groups.google.com/d/forum/blackbox-project) and ask there.
 
-Bugs are tracked here in Github. Please feel free to files bugs yourself:
-
--	https://github.com/StackExchange/blackbox/issues
+Bugs are tracked here in Github. Please feel free to [report bugs](https://github.com/StackExchange/blackbox/issues) yourself.
 
 Developer Info
 ==============
@@ -695,24 +793,26 @@ This runs through a number of system tests. It creates a repo, encrypts files, d
 
 Please submit tests with code changes:
 
-The best way to change Blackbox is via Test Driven Development. First add a test to `tools/confidence.sh`. This test should fail, and demonstrate the need for the change you are about to make. Then fix the bug or add the feature you want. When you are done, `make confidence` should pass all tests. The PR you submit should include your code as well as the new test. This way the confidence tests accumulate as the system grows as we know future changes don't break old features.
+The best way to change BlackBox is via Test Driven Development. First add a test to `tools/confidence.sh`. This test should fail, and demonstrate the need for the change you are about to make. Then fix the bug or add the feature you want. When you are done, `make confidence` should pass all tests. The PR you submit should include your code as well as the new test. This way the confidence tests accumulate as the system grows as we know future changes don't break old features.
 
 Note: The tests currently assume "git" and have been tested only on CentOS, Mac OS X, and Cygwin. Patches welcome!
 
 Alternatives
 ============
 
-Here are other open source packages that do something similar to Blackbox. If you like them better than Blackbox, please use them.
+Here are other open source packages that do something similar to BlackBox. If you like them better than BlackBox, please use them.
 
--	git-crypt: https://www.agwa.name/projects/git-crypt/
--	Pass: http://www.zx2c4.com/projects/password-store/
--	Transcrypt: https://github.com/elasticdog/transcrypt
--	Keyringer: https://keyringer.pw/
--	git-secret: https://github.com/sobolevn/git-secret
+- [git-crypt](https://www.agwa.name/projects/git-crypt/)
+- [Pass](http://www.zx2c4.com/projects/password-store/)
+- [Transcrypt](https://github.com/elasticdog/transcrypt)
+- [Keyringer](https://keyringer.pw/)
+- [git-secret](https://github.com/sobolevn/git-secret)
 
 git-crypt has the best git integration. Once set up it is nearly transparent to the users. However it only works with git.
 
+
 License
 =======
 
-This content is released under the MIT License. See the LICENSE.txt file.
+This content is released under the MIT License.
+See the [LICENSE.txt](LICENSE.txt) file.

RELEASE_ENGINEERING.md

@@ -17,7 +17,7 @@ There are 3 branches/tags:
 -	**tag stable:** Stable enough for use by most people.
 -	**tag production:** Burned in long enough that we are confident it can be widely adopted.
 
-If you are packaging Blackbox for distribution, you should track the *tag production*. You might also want to provide a separate package that tracks *tag stable:* for early adopters.
+If you are packaging BlackBox for distribution, you should track the *tag production*. You might also want to provide a separate package that tracks *tag stable:* for early adopters.
 
 Build Tasks
 ===========
@@ -99,6 +99,7 @@ Submit the diff file as a bug as instructed. The instructions should look like t
 
 Step 3: Watch for the update to happen.
 
+
 Updating MacPorts (manual)
 ==========================
 

Version2-Ideas.md

@@ -1,12 +1,12 @@
-# Ideas for blackbox Version 2
+# Ideas for BlackBox Version 2
 
 I'm writing this to solicit feedback and encourage discussion.
 
-Here are my thoughts on a "verison 2" of blackbox.  This is where
+Here are my thoughts on a "version 2" of BlackBox.  This is where
 I list ideas that would require major changes to the system. They
 might break backwards compatibility, though usually not.
 
-Blackbox grew from a few simple shell scripts used at StackOverflow.com
+BlackBox grew from a few simple shell scripts used at StackOverflow.com
 to a larger system used by dozens (hundreds?) of organizations. Not
 all the design decisions were "forward looking".
 
@@ -75,7 +75,7 @@ Backwards compatibility: This would add a "none" VCS, not remove any existing fu
 
 `bash` is fairly universal. It even exists on Windows.  However it is not the right language for large systems. Writing the acceptance tests is quite a bear.  Managing ".gitignore" files in bash is impossible and the current implementation fails in many cases.
 
-`python` is my second favorite langauge. It would make the code cleaner and more testable. However it is not installed everywhere.  I would also want to write it in Python3 (why start a new project in Python2?) but sadly Python3 is less common.  It is a chicken vs. egg situation.
+`python` is my second favorite language. It would make the code cleaner and more testable. However it is not installed everywhere.  I would also want to write it in Python3 (why start a new project in Python2?) but sadly Python3 is less common.  It is a chicken vs. egg situation.
 
 `go` is my favorite language. I could probably rewrite this in go in a weekend. However, now the code is compiled, not interpreted. Therefore we lose the ability to just "git clone" and have the tools you want.  Not everyone has a Go compiler installed on every machine.
 
@@ -94,4 +94,4 @@ However, I've never used it so I don't have any idea whether git-crypt is any be
 
 Of course, git-crypt doesn't work with SVN, HG, or any other VCS.  Is blackbox's strong point the fact that it support so many VCS systems?  To be honest, it originally only supported HG and GIT because I was at a company that used HG but then changed to GIT.  Supporting anything else was thanks to contributors. Heck, HG support hasn't even been tested recently (by me) since we've gone all git where I work.
 
-How important is this to blackbox users?
+How important is this to BlackBox users?

bin/_blackbox_common.sh

@@ -15,9 +15,12 @@ source "${0%/*}"/_stack_lib.sh
 # Where are we?
 : "${BLACKBOX_HOME:="$(cd "${0%/*}" ; pwd)"}" ;
 
-# Where in the VCS repo should the blackbox data be found?
-: "${BLACKBOXDATA:=keyrings/live}" ;   # If BLACKBOXDATA not set, set it.
-
+# What are the candidates for the blackbox data directory?
+declare -a BLACKBOXDATA_CANDIDATES
+BLACKBOXDATA_CANDIDATES=(
+  'keyrings/live'
+  '.blackbox'
+)
 
 # If $EDITOR is not set, set it to "vi":
 : "${EDITOR:=vi}" ;
@@ -63,10 +66,20 @@ export REPOBASE=$(physical_directory_of "$REPOBASE")
 # after determining what we believe to be the answer.
 
 if [[ -n "$BLACKBOX_REPOBASE" ]]; then
-	echo "Using custom repobase: $BLACKBOX_REPOBASE"
+	echo "Using custom repobase: $BLACKBOX_REPOBASE" >&2
 	export REPOBASE="$BLACKBOX_REPOBASE"
 fi
 
+if [ -z "$BLACKBOXDATA" ] ; then
+  BLACKBOXDATA="${BLACKBOXDATA_CANDIDATES[0]}"
+  for candidate in ${BLACKBOXDATA_CANDIDATES[@]} ; do
+    if [ -d "$REPOBASE/$candidate" ] ; then
+      BLACKBOXDATA="$candidate"
+      break
+    fi
+  done
+fi
+
 KEYRINGDIR="$REPOBASE/$BLACKBOXDATA"
 BB_ADMINS_FILE="blackbox-admins.txt"
 BB_ADMINS="${KEYRINGDIR}/${BB_ADMINS_FILE}"
@@ -171,8 +184,15 @@ function prepare_keychain() {
   # NB: We must export the keys to a format that can be imported.
   make_self_deleting_tempfile keyringasc
   export LANG="C.UTF-8"
-  $GPG --export --keyring "$(get_pubring_path)" >"$keyringasc"
-  $GPG --import "$keyringasc"
+
+  #if gpg2 is installed next to gpg like on ubuntu 16
+  if [[ "$GPG" != "gpg2" ]]; then
+    $GPG --export --no-default-keyring --keyring "$(get_pubring_path)" >"$keyringasc"
+    $GPG --import "$keyringasc" 2>&1 | egrep -v 'not changed$' >&2
+  else
+    $GPG --keyring "$(get_pubring_path)" --export | $GPG --import
+  fi
+
   echo '========== Importing keychain: DONE' >&2
 }
 
@@ -408,7 +428,11 @@ function cp_permissions() {
       chmod $( stat -f '%p' "$1" | sed -e "s/^100//" ) "${@:2}"
       ;;
     Linux | CYGWIN* | MINGW* )
-      chmod --reference "$1" "${@:2}"
+      if [[ -e /etc/alpine-release ]]; then
+        chmod $( stat -c '%a' "$1" ) "${@:2}"
+      else
+        chmod --reference "$1" "${@:2}"
+      fi
       ;; 
     * )
       echo 'ERROR: Unknown OS. Exiting. (cp_permissions)'

bin/blackbox_initialize

@@ -35,6 +35,18 @@ vcs_add "${KEYRINGDIR}"
 touch "$BLACKBOXDATA/$BB_ADMINS_FILE" "$BLACKBOXDATA/$BB_FILES_FILE"
 vcs_add "$BLACKBOXDATA/$BB_ADMINS_FILE" "$BLACKBOXDATA/$BB_FILES_FILE"
 
+if [[ $VCS_TYPE = "git" ]]; then
+
+  # Set .gitattributes so that Windows users don't break the admin files.
+  FILE="$BLACKBOXDATA/.gitattributes"
+  touch "$FILE"
+  LINE='blackbox-admins.txt text eol=lf'
+  grep -qF "$LINE" "$FILE" || echo "$LINE" >> "$FILE"
+  LINE='blackbox-files.txt text eol=lf'
+  grep -qF "$LINE" "$FILE" || echo "$LINE" >> "$FILE"
+
+fi
+
 if [[ $VCS_TYPE = "svn" ]]; then
 	echo
 	echo

bin/blackbox_register_new_file

@@ -44,7 +44,7 @@ function register_new_file() {
   vcs_ignore "$unencrypted_file"
   echo 'NOTE: "already tracked!" messages are safe to ignore.'
   vcs_add "$BB_FILES" "$encrypted_file"
-  vcs_commit "registered in blackbox: ${unencrypted_file}" "$BB_FILES" "$encrypted_file"
+  vcs_commit "registered in blackbox: ${unencrypted_file}" "$BB_FILES" "$encrypted_file" "$(vcs_ignore_file_path)"
 }
 
 for target in "$@"; do

bin/blackbox_removeadmin

@@ -31,4 +31,4 @@ vcs_add "$pubring_path" "$KEYRINGDIR/trustdb.gpg" "$BB_ADMINS"
 echo
 echo
 echo 'NEXT STEP: Check these into the repo.  Probably with a command like...'
-echo $VCS_TYPE commit -m\'REMOVED ADMIN: $KEYNAME\' "$BLACKBOXDATA/trustdb.gpg" "$BLACKBOXDATA/$BB_ADMINS_FILE"
+echo $VCS_TYPE commit -m\'REMOVED ADMIN: $KEYNAME\' "$BLACKBOXDATA/$(basename ${pubring_path})" "$BLACKBOXDATA/trustdb.gpg" "$BLACKBOXDATA/$BB_ADMINS_FILE"

bin/blackbox_shred_all_files

@@ -24,6 +24,7 @@ echo '========== FILES BEING SHREDDED:'
 
 exported_internal_shred_file() {
   source "$1/_blackbox_common.sh"
+  #unencrypted_file=$(get_unencrypted_filename "$2")
   unencrypted_file="$2"
   if [[ -f "$unencrypted_file" ]]; then
     echo "    SHRED: $unencrypted_file"

tools/confidence_test.sh

@@ -225,7 +225,7 @@ become_bob
 # This users's default group:
 DEFAULT_GID_NUM=$(id -g)
 # Pick a group that is not the default group:
-TEST_GID_NUM=$(id -G | fmt -1 | sort -rn | grep -xv "$(id -u)" | grep -xv "$(id -g)" | head -1)
+TEST_GID_NUM=$(grep -v "$DEFAULT_GID_NUM" /etc/group | cut -d: -f3 | sort -rn | head -1)
 echo "DEFAULT_GID_NUM=$DEFAULT_GID_NUM"
 echo "TEST_GID_NUM=$TEST_GID_NUM"