177 Commits

Author SHA1 Message Date
Tom Limoncelli
2ef26f4c90 Update RELEASE_ENGINEERING.md 2020-04-29 20:38:58 -04:00
Tom Limoncelli
6a53644a62 Update CHANGELOG.md 2020-04-29 20:36:37 -04:00
Tom Limoncelli
6c83f606da Revert "Fix how vcs_relative_path first resolves an absolute path (#304)"
This reverts commit 87b7cd0eae.
2020-04-29 19:46:13 -04:00
James Ottaway
87b7cd0eae Fix how vcs_relative_path first resolves an absolute path (#304) 2020-04-27 08:51:24 -04:00
Lucas Ramage
90418566e3 Respect PREFIX variable for copy-install (#294) 2020-02-01 10:10:25 -05:00
Travis Paul
35ebdabe81 Documentation: Add pkgsrc install instructions (#292)
Available in pkgsrc (via pkgin) as scm-blackbox
2020-01-27 12:25:06 -05:00
Joshua B
02c3edb9e6 Add better support for Windows (#291) 2019-10-02 09:01:32 -04:00
Tom Limoncelli
51ed419354 Clarify gpg version usage (#290) 2019-09-19 16:43:37 -04:00
Tom Limoncelli
31240d18e2 Doc: Missing closing parenthesis
Missing closing parenthesis
2019-08-30 07:33:46 -04:00
sblondon
5ee696239d Missing closing parenthesis
A `)` parenthesis is missing in the README file. This PR adds it.
2019-08-30 12:50:40 +02:00
Ben Holden-Crowther
155140d24c Documentation: Fix capitalization in heading (#281)
Very simple change
2019-04-20 17:04:59 -04:00
Reut Sharabani
79a9e978b0 Fix typo in readme file (#278)
"machine secure machine" -> "secure machine"
2019-04-20 17:04:23 -04:00
Pierre Gordon
f67d15638f BUG: blackbox_initialize output uses keyrings instead of $BLACKBOXDATA (#284) 2019-03-22 08:59:19 -04:00
Sirio Balmelli
292f1e5f74 DOCUMENTATION: Promote 'getting started' to a section, enumerate steps (#283)
Explicitly wrap lines in sub-paragraphs with '\'.

This is an attempt to have "getting started" stan out and improve
user-approachability (admittedly, subjective).

Signed-off-by: Sirio Balmelli <sirio@b-ad.ch>
2019-03-04 13:20:53 -05:00
Johannes Liebermann
226a84ba3c Commit changes to gitignore when deregistering (#282) 2019-01-09 10:43:24 -05:00
Tom Limoncelli
6bb21bb83a Documentation: Update copyright year
Update license date
2019-01-03 10:28:45 -05:00
Ben Holden-Crowther
b0136641f0 Update license date
To 2019
2019-01-03 14:41:29 +00:00
Tom Limoncelli
ad66e58bfe RELEASE_ENGINEERING.md 2018-12-19 20:20:44 -05:00
Tom Limoncelli
70e8c625e5 Add support for NetBSD and SunOS (SmartOS)
Add support for NetBSD and SunOS (SmartOS)
2018-12-09 07:32:44 -05:00
Tom Limoncelli
d6f997e8df README.md: Minor fixes 2018-12-07 13:49:38 -05:00
Travis Paul
e17c44aa61 Add NetBSD and SmartOS to list of supported OSes. 2018-12-03 09:19:27 -06:00
Travis Paul
f681872c4d Remove -n 1 argument from the xargs invocation in blackbox_shred_all_files.
The -I and -n options are mutually-exclusive, don't work as
expected with xargs from SunOS, and appear to be unecessary anyway.
2018-11-30 13:51:01 +08:00
Travis Paul
3594a3124e Bash from pkgsrc has a flag to disable importing functions unless explicitly enabled.
The patch was created in response to ShellShock and still remains:
https://www.mail-archive.com/smartos-discuss@lists.smartos.org/msg01247.html
https://github.com/NetBSD/pkgsrc/blob/trunk/shells/bash/patches/patch-shell.c
2018-11-30 13:49:15 +08:00
Travis Paul
fd3ad2fcea Add better support for NetBSD and SunOS in test scripts. 2018-11-30 10:59:21 +08:00
Travis Paul
3a491aad01 Add NetBSD and SunOS (SmartOS) support to _stack_lib.sh. 2018-11-29 14:01:54 +08:00
Travis Paul
b3b0604be7 Add NetBSD and SunOS support to cp_permissions.
Note that this likely won't work on Solaris without Coreutils as
Solaris lacks stat(1). SmartOS has stat from Coreutils in base
and the chmod(1) from it's OpenSolaris heritage. Using the chmod
from either Coreutils or Solaris will work the same (in this case)
on SmartOS.
2018-11-29 13:31:47 +08:00
Travis Paul
6408b622bf Add NetBSD and SunOS support to md5sum_file. 2018-11-29 12:47:37 +08:00
Tom Limoncelli
ab1430b74d Testing: Fix confidence test. 2018-10-03 10:46:07 -04:00
Kamil Wilczek
17ce90125b .blackbox is now the default config directory for new repos. (#272)
- _blackbox_common.sh sets the default Blackbox directory
  for the new repositories using the first entry of the
  BLACKBOX_CANDIDATES array. This small change sets the
  first entry to the new .blackbox dir (instead of the keyring/live)
2018-10-03 09:09:11 -04:00
Tobias Dubois
9d305233ca Add blackbox_decrypt_file (#270)
Add a command for decrypting single files. It is currently just an alias
for blackbox_edit_start.
It is meant to be a more obvious command for decrypting a single file
without editing it.

Fixes #268
2018-09-27 07:31:03 -04:00
r-savu
dc9fa326f4 Improved compatibility: change"/bin/[x]" to "/usr/bin/env [x]" (#265)
changed paths of the form "/bin/[x]" into "/usr/bin/env [x]" (#265)
2018-08-13 10:39:15 -04:00
winter0mute
74de17a4f6 Add blackbox_less. (#263)
* Add blackbox_view and use PAGER (default to less)
2018-07-26 10:24:32 -04:00
Ben Creasy
ebaa22a981 add nix method of install (#261) 2018-07-10 10:44:34 -07:00
Tom Limoncelli
0b8c3df70b Linked setting up of GPG key (#260) 2018-07-05 08:26:19 -07:00
Tom Limoncelli
918632436a Reformat README.md 2018-07-05 10:31:14 -04:00
Tom Limoncelli
d268a9e16a Release v1.20180615 2018-06-18 21:17:11 -04:00
Tom Limoncelli
ad2bc19b33 Merge branch 'master' of work-github.com:StackExchange/blackbox 2018-06-18 21:15:25 -04:00
Ben Limmer
1988a883a0 Restore make manual-install with warning. (#258) 2018-06-15 20:04:07 -04:00
Tom Limoncelli
a7f5e717eb Update CHANGELOG.md 2018-06-15 09:37:05 -04:00
Tom Limoncelli
4cf649f4cf Merge pull request #257 from StackExchange/docfix
Fix #256: Clarify .blackbox vs keyrings/live in README.md
2018-06-15 09:23:54 -04:00
Tom Limoncelli
69c0360a99 Clarify .blackbox vs keyrings/live in README.md 2018-06-15 09:22:05 -04:00
Tom Limoncelli
07546c6205 Whitespace 2018-05-31 17:01:24 -04:00
Tom Limoncelli
17d1a1a98b Fix whitespace. 2018-04-30 13:50:00 -04:00
Tom Limoncelli
8f6bef8542 Merge pull request #248 from tullis/fix-removeadmin-suggested-command
Suggest committing changes to pubring.gpg when running blackbox_removeadmin
2018-04-11 07:56:11 -04:00
Ben Tullis
7cebec9450 Ensure that git commits the changes to pubring.gpg when running blackbox_removeadmin
This relates to https://github.com/StackExchange/blackbox/issues/247 where it has been observed that the blackbox_removeadmin script prompts the user to run an incorrect command after running blackbox_removeadmin. This commit simply adds pubring.gpg to the list of files to be committed.
2018-04-11 11:06:14 +01:00
jciskey
906ecd0f82 Fix typo (#246) 2018-03-12 06:45:32 -04:00
Tom Limoncelli
6efbd24c58 Improve installation instructions (#244)
* Clarify manual-install -> symlinks-install
2018-02-22 13:46:42 -05:00
Tom Limoncelli
b9e456019b Add missing library: libffi-dev 2018-02-12 08:06:55 -05:00
Kwok-kuen Cheung
5162cb1cac Fix replacing-expired-keys link in README (#241) 2018-02-06 06:08:29 -05:00
Tom Limoncelli
6a04a6599f Merge pull request #239 from benhc123/patch-15
quick corrections
2018-01-07 13:58:21 -05:00
Ben Holden-Crowther
cbfce0b9f0 quick corrections 2018-01-07 18:42:07 +00:00
Tom Limoncelli
f94f2e339e Merge pull request #238 from benhc123/patch-14
Corrections on new section
2018-01-06 11:12:42 -05:00
Ben Holden-Crowther
34c132b713 Corrections on new section 2018-01-06 15:13:35 +00:00
Pim Snel
0c4cdace10 Fix problems when gpg2 is installed next to gpg (#237)
* implement fixes from https://stackoverflow.com/questions/44247308/blackbox-gpg-decrypt-fails-dont-know-ctb-00
* fix problems when working with gpg2 next to gpg. Add's readme section
* fix anchor
2018-01-05 08:05:57 -05:00
Mike Newswanger
5f6e91659e Merge pull request #231 from benhc123/patch-10
BlackBox vs Blackbox or blackbox
2018-01-02 10:03:53 -05:00
Mike Newswanger
001915dacb Merge pull request #232 from benhc123/patch-11
"BlackBox" vs "blackbox"
2018-01-02 10:03:30 -05:00
Mike Newswanger
7d8979ea1b Merge pull request #233 from benhc123/patch-12
BlackBox vs Blackbox
2018-01-02 10:03:07 -05:00
Mike Newswanger
8656b10d44 Merge pull request #236 from benhc123/patch-13
Update license year
2018-01-02 10:02:42 -05:00
Ben Holden-Crowther
058d765a07 Update license year 2017-12-31 16:17:44 +00:00
Ben Holden-Crowther
0028fa49fb BlackBox vs Blackbox 2017-12-15 21:49:48 +00:00
Ben Holden-Crowther
b70a215c61 "BlackBox" vs "blackbox" 2017-12-15 21:48:26 +00:00
Ben Holden-Crowther
90c34b5e0c BlackBox vs Blackbox or blackbox
consistency
2017-12-15 21:46:47 +00:00
Tom Limoncelli
292eb07768 Merge pull request #230 from benhc123/patch-9
Spelling
2017-12-15 14:51:43 -05:00
Ben Holden-Crowther
3203a7aa10 Spelling 2017-12-15 12:35:20 +00:00
Ben Holden-Crowther
242c34955e Spelling (#229) 2017-12-14 21:08:44 -05:00
Ben Holden-Crowther
8e0e96be5e Doc: fix typos (#228)
And another one :)
2017-12-14 17:31:34 -05:00
Ben Holden-Crowther
eb4ad38548 Misspelling (#227) 2017-12-14 17:30:16 -05:00
Ben Holden-Crowther
7f085fc32c Spelling (#226) 2017-12-14 06:01:19 -05:00
Ben Holden-Crowther
0f0d813392 docs: Fix spacing (#225)
tiny spacing correction
2017-12-12 14:38:35 -05:00
Tom Limoncelli
174b0d5ba5 Improve README.md formatting
Improve formatting
2017-12-10 07:28:48 -05:00
Ben Holden-Crowther
6a9bc745f1 Improve formatting
link
2017-12-10 12:15:36 +00:00
Tom Limoncelli
89566f7dd2 Merge pull request #223 from jinnko/master
Exclude our default keyring from import
2017-11-11 08:47:21 -08:00
Jinn Koriech
3fda14fd23 Exclude our default keyring from import
By default GPG will continue to perform actions against our default keyring.

During the keychain import stage this results in the export of both the
keyring for the repository we're working on, plus our own default keyring.
The import phase then continues to import all these exported keys, which
include the entries from our default keyring, for which all those entries
already exist.  If you have a lot of keys in your default keyring this takes a
long time, and can be noisy due to validation, yet offers absolutely no value.

To avoid all this overhead we only need to pass the `--no-default-keyring`
option to GPG during this export phase.  The result will still be what we're
expecting - i.e. that all entries from the repository pubring are imported
into our default keyring.
2017-11-11 09:34:59 +00:00
Tom Limoncelli
9ff5892ddf .gitattributes not created in some situations
Replaces https://github.com/StackExchange/blackbox/pull/146
2017-11-07 10:57:08 -05:00
Jon Bardin
043b66dc50 Fixes issue were .gitignore is not included in the commit when you register new file (#206)
* this should fix the .gitignore not be including in the commit when registering a new file
2017-11-07 07:52:34 -08:00
Tom Limoncelli
972abfc03f CI 2017-09-18 17:31:02 -04:00
Aymeric Beaumet
60e782a09e Store keys in .blackbox directory (#218) 2017-09-17 18:13:36 -04:00
Tom Limoncelli
103106e08f "make clean" should be idempotent. 2017-09-17 17:39:14 -04:00
Tom Limoncelli
ca99a1ebb4 Revert redundant circleci badge 2017-09-16 11:07:51 -04:00
Tom Limoncelli
318e21b4c8 Add CircleCI badge 2017-09-16 10:54:11 -04:00
Tom Limoncelli
57b5f59ca7 Fixing circleci 2017-09-16 10:40:12 -04:00
Paul Romero
53cc02e419 Corrected English in README (#209)
Nonsensical English corrected
2017-09-15 12:00:30 -04:00
Aymeric Beaumet
3cbfb2ba8c Update readme with CircleCI link (#216) 2017-09-15 11:40:39 -04:00
Aymeric Beaumet
2e894ea86f Run the tests on a CI (#215)
* Add CircleCI and make tests pass on ubuntu:16.04
* Add badge to readme
* Add debian stable to CircleCI
* Fix pkill on CircleCI debian
2017-09-15 11:15:12 -04:00
James Gregory
0626efa7e8 Fixed Alpine compatibility (chmod) (#212) 2017-09-01 05:01:20 -07:00
Jessica Evans
c60ca184f3 Made LICENSE link (#210) 2017-08-28 04:24:27 -07:00
Paul Romero
0ec0cd3762 Formatting improvements (#208)
Converted raw URLs to links
2017-08-24 04:23:09 -07:00
BHC
4528796279 Update license year (#205)
to 2017
2017-08-22 10:29:15 -07:00
Patrick Sanders
b483f65c0b direct repobase message to stderr (#204) 2017-08-17 08:57:04 -07:00
Tom Limoncelli
ced82815cf Improve tip about storing GPG keys 2017-08-08 09:56:23 -04:00
Tom Limoncelli
a3032aec07 NEW: .gitattributes Set Unix-only files to eol=lf 2017-07-14 14:38:00 -04:00
Jinn Koriech
c91b29be12 Silence 'not changed' output during keychain import (#200)
Previously the keychain import appears to have redirected stderr to stdout,
silenced lines that indicate a key has 'not changed' then send the output back
to stdout.  This behaviour has been carried over to the new GnuPG-2.1
compatible implementation.
2017-07-04 10:32:48 -04:00
Tom Limoncelli
9468ea69ec Improve info about expired GPG keys. 2017-06-16 12:04:08 -04:00
Tom Limoncelli
9966283368 Blackbox should work with Windows better WRT crlf. 2017-06-16 08:16:07 -04:00
Tom Limoncelli
25fd63f792 Update CHANGELOG.md 2017-06-11 08:34:57 -04:00
Tom Limoncelli
7c4fa4f4be tools/confidence_test.sh: Add explicit test for external tools. 2017-06-01 09:48:25 -04:00
Tom Limoncelli
9006c04c66 tools/auto_system_test: Add comments. 2017-06-01 09:48:13 -04:00
Tom Limoncelli
800fe098a6 "gpg --export" should export LANG=C.UTF-8 to be safe. 2017-05-29 19:39:01 -04:00
Tom Limoncelli
7029e44453 tools/confidence_test.sh: "export LANG=C.UTF-8" to be safe. 2017-05-29 19:37:56 -04:00
Tom Limoncelli
48cc17ac0a "make test" now uses "expect" to not prompt for passwords. 2017-05-29 19:31:26 -04:00
Tom Limoncelli
d78faf59d0 tools/confidence_test.sh: Set pinentry program to pinentry-tty 2017-05-29 19:09:36 -04:00
Robert Taylor
09a62cb1d2 Fixing physical_directory_of function for cases when target directory lives in root. (#194) 2017-05-29 18:00:06 -04:00
Tom Limoncelli
7649c9f00b Fix https://github.com/StackExchange/blackbox/issues/193
Add unit tests to tools/confidence_test.sh to verify admin operations work.
2017-05-15 11:10:01 -04:00
tlimoncelli@stackoverflow.com
1a22f77c82 Improve FreeBSD compatibility 2017-05-15 07:50:30 -04:00
tlimoncelli@stackoverflow.com
4bc97049ab tools/confidence_test.sh: now works with gnupg-2.0 and gnupg-2.1 2017-05-14 18:48:59 -04:00
tlimoncelli@stackoverflow.com
50ac1697c3 tools/confidence_test.sh: now works with gnupg-2.0 again 2017-05-14 17:52:27 -04:00
tlimoncelli@stackoverflow.com
eaa6d06b3e tools/confidence_test.sh: Handle gpg 2.1's new pubring filename. 2017-05-13 11:12:53 -04:00
tlimoncelli@stackoverflow.com
9c6f13fb80 blackbox_shred_all_files: BUGFIX: Does not shred files with spaces. 2017-05-13 11:12:05 -04:00
tlimoncelli@stackoverflow.com
849ec3138b blackbox_removeadmin: Disable gpg's confirmation. 2017-05-13 11:11:39 -04:00
Tom Limoncelli
49892c307c Sync mk_rpm_fpmdir from master 2017-05-04 10:23:10 -04:00
Tom Limoncelli
53ed9d601a Update CHANGELOG.md 2017-05-03 13:09:26 -04:00
Matthew
be425ed76c shred_file() outputs warning message to stderr. (#192) 2017-05-02 06:33:07 -04:00
Simon Gate
8728290122 Don't complain about GPG_AGENT_INFO if using newer gpg-agent (#189) 2017-04-26 08:34:20 -04:00
William Belle
2f2289b5e3 Fix typo on README (#187)
Thanks!
2017-03-24 09:04:25 -04:00
Graham Lyons
44c9934293 Use the rm command with -P as a shred fallback (#179)
* Use the `rm` command with `-P` as a shred fallback

The newer versions of OSX (Sierra) have neither `shred` nor `srm`.
They do have `rm` with the `-P` option, so we can fall back to that
before resorting to plain old `rm`.

* Add double-quotes and braces to the shell variable.

We should treat the variable as a string, and we should also be safe
when interpolating it.
2017-03-10 08:20:43 -05:00
Tom Limoncelli
cf984c26ee "make test" should be an alias for "make confidence". 2017-02-22 19:31:55 +00:00
Tom Limoncelli
5df0d21be6 make_tempdir must create shorter paths. 2017-02-20 12:15:05 -05:00
Tom Limoncelli
2d1410599d Fixing "make confidence" (HT to 98b928c0e8) 2017-02-20 16:47:33 +00:00
Tom Limoncelli
9bee252e24 README.md: Add info about our new mailing list. 2017-02-20 10:54:17 -05:00
Tom Limoncelli
e91344d404 Add a CHANGELOG.md 2017-02-16 15:41:59 -05:00
Tino Breddin
bd0fcd181c [FreeBSD] Fix use of chmod (#180)
LGTM

Thanks for the fix!
2017-01-20 17:12:57 -05:00
Ben Watson
818db98506 Requiring a file to be entered to finish editing (#175)
* Requiring a file to be entered to finish editing

Running blackbox_edit_end without an argument doesn't currently print out a warning that no files are being changed. A developer in my team who was new to Blackbox committed a decrypted file (and made no changes to the GPG file) as they didn't realise the command hadn't worked.

The check I've added should help to avoid these errors.

* Adding argument check to start editing
2016-12-12 14:07:33 +00:00
Joseph Herlant
1b7c8c880b Remove the key from the keyring when removing an admin (#173)
Thanks for the submission!
2016-11-22 13:43:08 -05:00
Tino Breddin
fba77f092a Add FreeBSD support (#172) 2016-11-08 13:49:42 -05:00
tlimoncelli@stackexchange.com
3e9091722c Merge branch 'jvanasco-feature-listadmins' 2016-10-07 16:19:41 -04:00
tlimoncelli@stackexchange.com
57dc69a928 Merge branch 'feature-listadmins' of https://github.com/jvanasco/blackbox into jvanasco-feature-listadmins 2016-10-07 16:19:13 -04:00
Jason Price
598896ef48 Add list admins commandline tool. (#170)
* adding a list_admins command

* updating README and V2 ideas to include list_admins

* fix documentation misses

* add list_admins to the toolchain
2016-10-06 11:26:43 -04:00
Dave Jachimiak
31cf506684 ignore backup files and secring.gpg in $BLACKBOXDATA (#169) 2016-09-23 09:26:22 -04:00
Jon Bardin
4fe27a04c9 Allow parallel shredding of files (#167)
* to log which files were shredded
* allow parallel shredding of files ot lower time to shred
2016-08-31 09:29:54 -04:00
Tom Limoncelli
f108d80027 Merge pull request #164 from josegonzalez/patch-1
Check return value contents
2016-05-26 13:47:41 -04:00
Jose Diaz-Gonzalez
21c0b68213 Check return value contents
Closes #156
2016-05-26 11:54:14 -04:00
Tom Limoncelli
65f40f8f6e Merge pull request #160 from dorfsmay/master
Use PKGNAME variable defined above.
2016-05-23 10:02:08 -04:00
Tom Limoncelli
f7a100fa8d Merge pull request #163 from amosshapira/master
#162: Added instructions to make "git diff" work
2016-05-23 10:00:58 -04:00
Amos Shapira
2be3ddaddf Added instructions to make "git diff" work
Added a paragraph about configuring `git` to decrypt files for diff/log
2016-05-22 11:45:41 +10:00
Yves Dorfsman
1ae578b7cf Tilde doesn't get expanded when in between quotes. 2016-05-20 16:15:15 -06:00
Yves Dorfsman
c3f7e12890 Use PKGNAME variable defined above. 2016-05-20 15:08:46 -06:00
Tom Limoncelli
eaadca8871 Merge pull request #158 from mettjus/patch-1
Improve command list in README
2016-05-16 09:32:51 -04:00
mettjus
4a32c95f53 Improve command list in README
Explicitly display for each command if it requires a target (a file or a key) or it doesn't.
2016-05-13 23:47:23 +02:00
tlimoncelli@stackexchange.com
1354628ed5 Version2-Ideas.md: Windows compatibility clarification. 2016-05-10 15:01:27 -04:00
jonathan vanasco
435a3c073f added blackbox_listadmins, which just displays active admins via cat "$BB_ADMINS" 2016-04-25 12:53:36 -04:00
tal@whatexit.org
1b6c6eadc9 Initial draft. 2016-04-24 09:14:56 -04:00
Tom Limoncelli
ead98b03ca Merge pull request #147 from billrawlinson/mingw-gpgagent
remove MinGW dependecy on GpG4Win (gpg-agent) in readme.md
2016-04-23 06:59:08 -04:00
Tom Limoncelli
93a01c82c8 Merge pull request #150 from jvanasco/fixes-subversion
Fixes for subversion
2016-04-23 06:58:22 -04:00
jonathan vanasco
4bb9c055ca added docs 2016-04-22 17:32:25 -04:00
jonathan vanasco
f8c1653e09 some updates for subversion 2016-04-22 17:30:28 -04:00
Bill Rawlinson
de05e1f8e7 remove MinGW dependecy on GpG4Win (gpg-agent)
The gpg-agent that ships with GpG4Win is a version 2 gpg agent and only works with gpg2.  The gpg in MinGW is gpg 1.x and it doesn't pick up this gpg-agent.

However, everything still works - you just have to enter your password for each file you decrypt.  Slightly onerous but not a huge deal breaker.

I notice there is  away to specify your own gpg versoin in the _blackbox_common.sh file but I don't really know how that works.  If someone were to specify to use gpg2 then they could probably use the agent in Gpg4Win but I don't know and don't know how to test that.
2016-04-15 14:28:15 -04:00
Tom Limoncelli
ef08dcc6b3 Merge pull request #145 from billrawlinson/MingwGpgAndMkTemp
Mingw gpg and mk temp
2016-04-14 11:07:54 -04:00
Bill Rawlinson
b9d5cd7716 specify git version
Older git for windows MinGW didn't support updating the plain text files in keyfiles/live/blackbox-admins.txt and blackbox-files.txt due to an error `cannot make pipe for process substitution function not supported`

The newer version of Git (which is also more secure) also resolves this issue.
2016-04-14 10:00:53 -04:00
Bill Rawlinson
fa68b56927 added link to git 2016-04-14 09:22:18 -04:00
Bill Rawlinson
8769474035 added documentation for MINGW users 2016-04-14 09:21:05 -04:00
tal@whatexit.org
1643ea7fd9 "make confidence": Use GID numbers, not names. Makes tests less fragile. 2016-03-15 21:22:29 -04:00
tal@whatexit.org
3a4a79284c Add more debugging output to "make confidence" 2016-03-15 19:14:09 -04:00
Tom Limoncelli
bf36197c5b Merge pull request #143 from danslimmon/noshredwarn
Warn user if there isn't a secure deletion utility
2016-03-14 15:02:06 -04:00
Dan Slimmon
fc63e24dcf Warn user if there isn't a secure deletion utility
Otherwise, somebody with neither shred nor srm installed could blithely
go on using Blackbox assuming that their working copies are getting
securely deleted.
2016-03-14 18:53:29 +00:00
Tom Limoncelli
ee1bbc8092 Merge pull request #142 from sobolevn/master
added git-secret into "Alternatives" section
2016-03-12 15:16:31 -08:00
sobolevn
3e8578d687 added git-secret into Alternatives 2016-03-10 17:26:39 +03:00
tlimoncelli@stackoverflow.com
a9dc14c7b0 _stack_lib.sh: Take upstream changes. 2016-02-29 17:22:12 +00:00
tlimoncelli@stackoverflow.com
d2fde2c2a9 Merge upstream mk_rpm_fpmdir 2016-02-29 16:53:33 +00:00
tlimoncelli@stackoverflow.com
7e175e5d9c Merge from upstream. 2016-02-29 16:25:27 +00:00
Tom Limoncelli
9f6c3f15c0 Merge pull request #140 from unixorn/make-package-iteration-iterate
Set release default to the number of commits in the repo instead of always using 1
2016-02-28 10:32:20 -05:00
Joe Block
673eaae95b Deal with being built within a burst tarball instead of a git clone 2016-02-27 06:50:50 -08:00
Joe Block
982f2f0045 Set release default to the number of commits in the repo instead of always using 1 2016-02-26 14:38:12 -08:00
Tom Limoncelli
aa68cd34ad Merge pull request #138 from unixorn/make-OUTPUTDIR-overridable
Make OUTPUTDIR overridable
2016-02-26 16:50:39 -05:00
Joe Block
e004ebb384 Make OUTPUTDIR overridable
Users (like me on my Jenkins server) may not want to put output debs and
rpms in ~.
2016-02-26 13:35:15 -08:00
Tom Limoncelli
9013350a68 Merge pull request #136 from trenton42/patch-1
Update README.md
2016-02-17 11:44:00 -05:00
Trenton Broughton
44e5ae6143 Update README.md
Added homebrew install method to Installation Instructions
2016-02-17 11:33:44 -05:00
tlimoncelli@stackoverflow.com
27a86758c7 Pass README.md and RELEASE_ENGINEERING.md through markdownfmt. Update TOC. 2016-01-21 23:42:57 -05:00
tlimoncelli@stackoverflow.com
f7a159d685 README.md: Add process for updating expired keys. HT @chishaku 2016-01-21 11:06:11 -05:00
Tom Limoncelli
63edd45499 Merge pull request #134 from pra85/patch-1
Update license year to 2016
2016-01-19 09:38:36 -05:00
Prayag Verma
d9064a9a26 Update license year to 2016 2016-01-16 17:50:03 +05:30
Tom Limoncelli
88e9e99f57 Merge pull request #132 from StackExchange/tlim_gitignore
When updating .gitignore, "git add" it.
2016-01-06 12:10:07 -05:00
Tom Limoncelli
46b44b4f19 Merge pull request #131 from chandlermelton/master
remove unencrypted file from .gitignore when deregistering
2016-01-06 11:05:25 -05:00
tlimoncelli@stackoverflow.com
34559499a2 Improve README.md for first timers 2016-01-06 10:11:34 -05:00
tlimoncelli@stackoverflow.com
c394b964e8 When updating .gitignore, "git add" it. 2015-12-30 14:41:22 +00:00
Chandler Melton
4ea164fbd3 remove unencrypted file from .gitignore when deregistering 2015-12-16 15:54:28 -06:00
Tom Limoncelli
921c5e6957 Merge pull request #130 from leowzukw/patch-1
Add alternative software to the Readme
2015-12-14 12:53:18 -05:00
Leo Wzukw
e03ef89332 Add alternative software to the Readme
Very similar program, would be interesting too.
2015-12-14 18:50:18 +01:00
36 changed files with 1389 additions and 516 deletions

56
.circleci/config.yml Normal file
View File

@@ -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

5
.gitattributes vendored Normal file
View File

@@ -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

87
CHANGELOG.md Normal file
View File

@@ -0,0 +1,87 @@
Release v1.20200429
NOTE: While there is now support for NetBSD and SunOS/SmartOS, the
release process only tests on macOS and CentOS7 because that's all I
have access to.
* Fix tools that break when ".." or "." are used in a path (#304)
* Respect PREFIX variable for copy-install (#294)
* Documentation: Add pkgsrc install instructions (#292)
* Improve support for Windows (#291)
* Clarify gpg version usage (#290)
* Many documentation fixes
* DOCUMENTATION: Promote 'getting started' to a section, enumerate steps (#283)
* Commit changes to gitignore when deregistering (#282)
* Add support for NetBSD and SunOS (SmartOS)
* Defend against ShellShock
* .blackbox is now the default config directory for new repos. (#272)
* Add blackbox_decrypt_file (#270)
* Improved compatibility: change"/bin/[x]" to "/usr/bin/env [x]" (#265)
* Add blackbox_less. (#263)
* add nix method of install (#261)
* Linked setting up of GPG key (#260)
Release v1.20180618
* Restore `make manual-install` with warning. (#258)
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
* "make test" is an alias for "make confidence"
* macOS: make_tempdir must create shorter paths
* Fix "make confidence" for newer version of Git
* README.md: Add info about our new mailing list
Release v1.20170611
* confidence_test.sh verifies external tools exist
* confidence_test.sh more reliable for non-UTF8 users
* "make test" no longer prompts for passwords
* blackbox works better when target directory lives in root (#194)
* Add confidence_test.sh tests for admin operations
* blackbox_list_admins fails (#193)
* confidence_test.sh works better on FreeBSD
* tools/confidence_test.sh: now works with gnupg-2.0 and gnupg-2.1
* Blackbox now officially supports both gnupg-2.0 and gnupg-2.1
* 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.

View File

@@ -1,6 +1,6 @@
The MIT License (MIT)
Copyright (c) 2014-2015 Stack Exchange, Inc.
Copyright (c) 2014-2019 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

View File

@@ -1,17 +1,23 @@
SHELL=/bin/sh
PREFIX?=/usr/local
PKGNAME=stack_blackbox
BASEDIR?=$(HOME)
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 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 ${PREFIX}/bin/'
@echo ' make copy-install Copy "bin" files to ${PREFIX}/bin/'
@echo ' make copy-uninstall Remove blackbox files from ${PREFIX}/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
@@ -30,14 +36,14 @@ packages-rpm-debug:
@echo BUILD:
@PKGRELEASE=99 make packages
@echo ITEMS TO BE PACKAGED:
find ~/rpmbuild-$(PKGNAME)/installroot -type f
find $(BASEDIR)/rpmbuild-$(PKGNAME)/installroot -type f
@echo ITEMS ACTUALLY IN PACKAGE:
@rpm -qpl $$(cat ~/rpmbuild-$(PKGNAME)/bin-packages.txt)
@rpm -qpl $$(cat $(BASEDIR)/rpmbuild-$(PKGNAME)/bin-packages.txt)
local-rpm:
@PKGRELEASE=1 make packages
-@sudo rpm -e $(PKGNAME)
sudo rpm -i $$(cat ~/rpmbuild-$(PKGNAME)/bin-packages.txt)
sudo rpm -i $$(cat $(BASEDIR)/rpmbuild-$(PKGNAME)/bin-packages.txt)
lock-rpm:
sudo yum versionlock add $(PKGNAME)
@@ -48,14 +54,26 @@ unlock-rpm:
#
# Manual install
#
manual-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
symlinks-install:
@echo "Symlinking files from ./bin to ${PREFIX}/bin"
@cd bin && for f in `find . -type f -iname "*" ! -iname "Makefile"`; do ln -fs `pwd`/$$f $(PREFIX)/bin/$$f; done
@echo 'Done.'
manual-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
manual-install:
@echo '***************************************************************'
@echo '* DEPRECATED *'
@echo '* `make manual-install` is now called `make symlinks-install` *'
@echo '***************************************************************'
$(MAKE) symlinks-install
copy-install:
@echo "Copying files from ./bin to ${PREFIX}/bin"
@cd bin && for f in `find . -type f -iname "*" ! -iname "Makefile"`; do cp `pwd`/$$f $(PREFIX)/bin/$$f; done
@echo 'Done.'
copy-uninstall:
@echo "Removing blackbox files from ${PREFIX}/bin"
@cd bin && for f in `find . -type f -iname "*" ! -iname "Makefile"`; do rm $(PREFIX)/bin/$$f; done
@echo 'Done.'
#
@@ -63,7 +81,7 @@ manual-uninstall:
#
packages-deb: tools/mk_deb_fpmdir.stack_blackbox.txt
cd tools && PKGRELEASE="$${PKGRELEASE}" PKGDESCRIPTION="Safely store secrets in git/hg/svn repos using GPG encryption" ./mk_deb_fpmdir stack_blackbox mk_deb_fpmdir.stack_blackbox.txt
cd tools && OUTPUTDIR=$(OUTPUTDIR) PKGRELEASE="$${PKGRELEASE}" PKGDESCRIPTION="Safely store secrets in git/hg/svn repos using GPG encryption" ./mk_deb_fpmdir stack_blackbox mk_deb_fpmdir.stack_blackbox.txt
# Make mk_deb_fpmdir.vcs_blackbox.txt from mk_rpm_fpmdir.stack_blackbox.txt:
tools/mk_deb_fpmdir.stack_blackbox.txt: tools/mk_rpm_fpmdir.stack_blackbox.txt
@@ -75,12 +93,12 @@ packages-deb-debug: tools/mk_deb_fpmdir.stack_blackbox.txt
@echo ITEMS TO BE PACKAGED:
find ~/debbuild-$(PKGNAME)/installroot -type f
@echo ITEMS ACTUALLY IN PACKAGE:
@dpkg --contents $$(cat ~/debbuild-$(PKGNAME)/bin-packages.txt)
@dpkg --contents $$(cat $(BASEDIR)/debbuild-$(PKGNAME)/bin-packages.txt)
local-deb:
@PKGRELEASE=1 make packages
-@sudo dpkg -e $(PKGNAME)
sudo dpkg -i $$(cat ~/rpmbuild-$(PKGNAME)/bin-packages.txt)
sudo dpkg -i $$(cat $(BASEDIR)/rpmbuild-$(PKGNAME)/bin-packages.txt)
#
# MacPorts builds
@@ -115,15 +133,15 @@ 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:
#
test: confidence
confidence:
@if [ -e ~/.gnupg ]; then echo ERROR: '~/.gnupg should not exist. If it does, bugs may polute your .gnupg configuration. If the code has no bugs everything will be fine. Do you feel lucky?'; false ; fi
@if which >/dev/null gpg-agent ; then pkill gpg-agent ; rm -rf /tmp/tmp.* ; fi
@export PATH="$(PWD)/bin:/usr/local/bin:/bin:/usr/bin:/usr/local/sbin:/usr/sbin:/sbin:/opt/local/bin:$(PATH)" ; tools/confidence_test.sh
tools/confidence_test.sh
@export PATH="$(PWD)/bin:$(PREFIX)/bin:/usr/local/bin:/bin:/usr/bin:/usr/local/sbin:/usr/sbin:/sbin:/opt/local/bin:$(PATH)" ; tools/auto_system_test
@if which >/dev/null gpg-agent ; then pkill gpg-agent ; fi
@if [ -e ~/.gnupg ]; then echo ERROR: '~/.gnupg was created which means the scripts might be poluting GnuPG configuration. Fix this bug.'; false ; fi

778
README.md

File diff suppressed because it is too large Load Diff

View File

@@ -1,20 +1,69 @@
# Branches and Tags:
Table of Contents:
==================
- [Branches and Tags:](#branches-and-tags)
- [Testing:](#testing)
- [Build Tasks](#build-tasks)
- [Stable Releases](#stable-releases)
- [Production Releases](#production-releases)
- [Updating MacPorts (automatic)](#updating-macports-automatic)
- [Updating MacPorts (manual)](#updating-macports-manual)
Branches and Tags:
==================
There are 3 branches/tags:
* **HEAD:** The cutting edge of development.
* **tag stable:** Stable enough for use by most people.
* **tag production:** Burned in long enough that we are confident it can be widely adopted.
- **HEAD:** The cutting edge of development.
- **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
Testing
=======
# Stable Releases
Tips:
* macOS: `brew install gpg pinentry`
* FreeBSD: `pkg install gpg gmake`
* CentOS7: `yum install gpg`
To run a suite of tests:
```
cd ~/src/github.com/StackExchange/blackbox
make test
```
FYI: For FreeBSD, use `gmake test`
Build Tasks
===========
Stable Releases
===============
Marking the software to be "stable":
Step 1. Tag it.
Step 1. Update CHANGELOG.md
Use "git log" to see what has changed and update CHANGELOG.md.
For a new release, add:
```
echo Release v1.$(date +%Y%m%d)
```
Commit with:
```
git commit -m'Update CHANGELOG.md' CHANGELOG.md
```
Step 2. Tag it.
```
git pull
@@ -24,11 +73,10 @@ git tag stable
git push origin tag stable
```
Step 2. Mark your calendar 1 week from today to check
to see if this should be promoted to production.
Step 3. Mark your calendar 1 week from today to check to see if this should be promoted to production.
# Production Releases
Production Releases
===================
If no bugs have been reported a full week after a stable tag has been pushed, mark the release to be "production".
@@ -44,7 +92,14 @@ git tag "$R"
git push origin tag "$R"
```
# Updating MacPorts (automatic)
Step 4. Get credit!
Record the fact that you did this release in your weekly accomplishments file.
Updating MacPorts (automatic)
=============================
Step 1: Generate the Portfile
@@ -58,37 +113,39 @@ Step 2: Submit the update request.
Submit the diff file as a bug as instructed. The instructions should look like this:
* PLEASE OPEN A TICKET WITH THIS INFORMATION:
https://trac.macports.org/newticket
* Summary: `vcs_blackbox @1.20150222 Update to latest upstream`
* Description: ```New upstream of vcs_blackbox.
github.setup and checksums updated.```
* Type: `update`
* Component: `ports`
* Port: `vcs_blackbox`
* Keywords: `maintainer haspatch`
* Attach this file: `Portfile-vcs_blackbox.diff`
- PLEASE OPEN A TICKET WITH THIS INFORMATION: https://trac.macports.org/newticket
- Summary: `vcs_blackbox @1.20150222 Update to latest upstream`
- Description: `New upstream of vcs_blackbox.
github.setup and checksums updated.`
- Type: `update`
- Component: `ports`
- Port: `vcs_blackbox`
- Keywords: `maintainer haspatch`
- Attach this file: `Portfile-vcs_blackbox.diff`
Step 3: Watch for the update to happen.
# Updating MacPorts (manual)
This is the old, manual, procedure. If the automated procedure fails to work, these notes may or may not be helpful.
Updating MacPorts (manual)
==========================
The ultimate result of the script should be the output of `diff -u Portfile.orig Portfile` which is sent as an attachment to MacPorts. The new `Portfile` should have these changes:
This is the old, manual, procedure. If the automated procedure fails to work, these notes may or may not be helpful.
1. The `github.setup` line should have a new version number.
2. The `checksums` line(s) should have updated checksums.
The ultimate result of the script should be the output of `diff -u Portfile.orig Portfile` which is sent as an attachment to MacPorts. The new `Portfile` should have these changes:
1. The `github.setup` line should have a new version number.
2. The `checksums` line(s) should have updated checksums.
How to generate the checksums?
The easiest way is to to make a Portfile with incorrect checksums, then run `sudo port -v checksum vcs_blackbox` to see what they should have been. Fix the file, and try again until the checksum command works.
The easiest way is to to make a Portfile with incorrect checksums, then run `sudo port -v checksum vcs_blackbox` to see what they should have been. Fix the file, and try again until the checksum command works.
Next run `port lint vcs_blackbox` and make sure it has no errors.
Some useful commands:
Change repos in sources.conf:
```
sudo vi /opt/local/etc/macports/sources.conf
Add this line early in the file:
@@ -96,16 +153,19 @@ sudo vi /opt/local/etc/macports/sources.conf
```
Add a local repo:
```
fgrep >/dev/null -x 'file:///var/tmp/ports' /opt/local/etc/macports/sources.conf || sudo sed -i -e '1s@^@file:///var/tmp/ports\'$'\n@' /opt/local/etc/macports/sources.conf
```
Remove the local repo:
```
sudo sed -i -e '\@^file:///var/tmp/ports@d' /opt/local/etc/macports/sources.conf
```
Test a Portfile:
```
sudo port uninstall vcs_blackbox
sudo port clean --all vcs_blackbox

97
Version2-Ideas.md Normal file
View File

@@ -0,0 +1,97 @@
# Ideas for BlackBox Version 2
I'm writing this to solicit feedback and encourage discussion.
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
to a larger system used by dozens (hundreds?) of organizations. Not
all the design decisions were "forward looking".
These are the things I'd like to change someday.
[TOC]
## Change the commmand names
There should be one program, with subcommands that have names that make more sense:
* `blackbox init`
* `blackbox register <filename> <...>`
* `blackbox deregister <filename> <...>`
* `blackbox edit <filename> <...>`
* `blackbox decrypt <filename> <...>`
* `blackbox encrypt <filename> <...>`
* `blackbox decrypt_all`
* `blackbox addadmin <key>`
* `blackbox removeadmin <key>`
* `blackbox cat <filename> <...>`
* `blackbox diff <filename> <...>`
* `blackbox list_files`
* `blackbox list_admins`
* `blackbox shred_all`
* `blackbox update_all`
* `blackbox whatsnew`
Backwards compatibility: The old commands would simply call the new commands.
## Change the "keyrings" directory
The name "keyrings" was unfortunate. First, it should probably begin with a ".". Second, it stores more than just keyrings. Lastly, I'm finding that in most cases we want many repos to refer to the same keyring, which is not supported very well.
A better system would be:
1. If `$BLACKBOX_CONFIG` is set, use that directory.
2. If the repo base directory has a file called ".blackbox_external", read that file as if you are reading `$BLACKBOX_CONFIG`
3. If the repo base directory has a "keyrings" directory, use that.
4. If the repo base directory has a ".blackboxconfig" directory, use that.
Some thoughts on .blackbox_external:
I'm not sure what the format should be, but I want it to be simple and expandable. It should support support "../../dir/name" and "/long/path". However some day we may want to include a Git URL and have the system automatically get the keychain from it. That means the format has to be something like directory:../dir/name so that later we can add git:the_url.
Backwards compatibility: "keyrings" would be checked before .blackbox
## Repo-less mode
I can't imagine storing files that aren't in a repo. I just put everything in repos lately. I use it more than I use NFS. That said, I have received feedback that people would like the ability to disable automatic committing of files.
I prefer the file commits to be automatic because when they were manual, people often accidentally committed the plaintext file instead of the GPG file. Fixing such mistakes is a PITA and, of yeah, a big security nightmare.
That said, I'm willing to have a "repo-less" mode.
When this mode is triggered, no add/commit/ignore tasks are done. The search for the keyrings directory still uses `$BLACKBOX_CONFIG` but if that is unset it looks for .blackbox_config in the current directory, then recursively ".." until we hit "/".
I think (but I'm not sure) this would benefit the entire system because it would force us to re-think what VCS actions are done when.
I think (but I'm not sure) that a simple way to implement this would be to add an environment variable that overrides the automatic VCS detection. When set to "none", all VCS operations would basically become no-ops. (This could be done by writing a plug-in that does nothing for all the vcs_* calls)
Backwards compatibility: This would add a "none" VCS, not remove any existing functionality.
## Is "bash" the right language?
`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 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.
The system is basically unusable on Windows without Cygwin or MINGW. A rewrite in python or go would make it work better on Windows, which currently requires Cygwin or MinGW (which is a bigger investment than installing Python). On the other hand, maybe Ubuntu-on-Windows makes that a non-issue.
As long as the code is in `bash` the configuration files like `blackbox-files.txt` and `blackbox-admins.txt` have problems. Filenames with carriage returns aren't supported. If this was in Python/Go/etc. those files could be json or some format with decent quoting and we could handle funny file names better. On the other hand, maybe it is best that we don't support funny filenames... we shouldn't enable bad behavior.
How important is itto blackbox users that the system is written in "bash"?
## Ditch the project and use git-crypt
People tell me that git-crypt is better because, as a plug-in, automagically supports "git diff", "git log" and "git blame".
However, I've never used it so I don't have any idea whether git-crypt is any better than blackbox.
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?

View File

@@ -15,9 +15,15 @@ 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?
#
# The order of candidates matter. The first entry of the array
# sets the default Blackbox directory for all new repositories.
declare -a BLACKBOXDATA_CANDIDATES
BLACKBOXDATA_CANDIDATES=(
'.blackbox'
'keyrings/live'
)
# If $EDITOR is not set, set it to "vi":
: "${EDITOR:=vi}" ;
@@ -28,7 +34,7 @@ source "${0%/*}"/_stack_lib.sh
function physical_directory_of() {
local d=$(dirname "$1")
local f=$(basename "$1")
(cd "$d" && echo "$(pwd -P)/$f" )
(cd "$d" && echo "$(pwd -P | sed 's/\/$//')/$f" )
}
# Set REPOBASE to the top of the repository
@@ -62,6 +68,21 @@ export REPOBASE=$(physical_directory_of "$REPOBASE")
# FIXME: Verify this function by checking for .hg or .git
# after determining what we believe to be the answer.
if [[ -n "$BLACKBOX_REPOBASE" ]]; then
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}"
@@ -122,7 +143,7 @@ function fail_if_not_on_cryptlist() {
if ! is_on_cryptlist "$name" ; then
echo "ERROR: $name not found in $BB_FILES" >&2
echo "PWD=$(/bin/pwd)" >&2
echo "PWD=$(/usr/bin/env pwd)" >&2
echo 'Exiting...' >&2
exit 1
fi
@@ -158,8 +179,23 @@ function get_encrypted_filename() {
# Prepare keychain for use.
function prepare_keychain() {
local keyringasc
echo '========== Importing keychain: START' >&2
$GPG --import "$(get_pubring_path)" 2>&1 | egrep -v 'not changed$' >&2
# Works with gpg 2.0
#$GPG --import "$(get_pubring_path)" 2>&1 | egrep -v 'not changed$' >&2
# Works with gpg 2.0 and 2.1
# NB: We must export the keys to a format that can be imported.
make_self_deleting_tempfile keyringasc
export LANG="C.UTF-8"
#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
}
@@ -177,7 +213,8 @@ function add_filename_to_cryptlist() {
else
echo "========== Adding file to list."
touch "$BB_FILES"
sort -u -o "$BB_FILES" <(echo "$name") "$BB_FILES"
echo "$name" >> "$BB_FILES"
sort -u -o "$BB_FILES" "$BB_FILES"
fi
}
@@ -272,7 +309,11 @@ function shred_file() {
#NOTE: srm by default uses 35-pass Gutmann algorithm
CMD=srm
OPT=-f
elif _F=$(mktemp); rm -P "${_F}" >/dev/null 2>/dev/null ; then
CMD=rm
OPT=-Pf
else
echo "shred_file: WARNING: No secure deletion utility (shred or srm) present; using insecure rm" >&2
CMD=rm
OPT=-f
fi
@@ -368,9 +409,15 @@ function file_contains_line() {
function md5sum_file() {
# Portably generate the MD5 hash of file $1.
case $(uname -s) in
Darwin )
Darwin | FreeBSD )
md5 -r "$1" | awk '{ print $1 }'
;;
NetBSD )
md5 -q "$1"
;;
SunOS )
digest -a md5 "$1"
;;
Linux | CYGWIN* | MINGW* )
md5sum "$1" | awk '{ print $1 }'
;;
@@ -387,8 +434,18 @@ function cp_permissions() {
Darwin )
chmod $( stat -f '%p' "$1" ) "${@:2}"
;;
Linux | CYGWIN* | MINGW* )
chmod --reference "$1" "${@:2}"
FreeBSD | NetBSD )
chmod $( stat -f '%p' "$1" | sed -e "s/^100//" ) "${@:2}"
;;
SunOS )
chmod $( stat -c '%a' "$1" ) "${@:2}"
;;
Linux | CYGWIN* | MINGW* | SunOS )
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)'
@@ -562,10 +619,11 @@ function vcs_ignore_hg() {
# Git
function vcs_ignore_git() {
vcs_ignore_generic_file "$(vcs_ignore_file_path)" "$file"
git add "$REPOBASE/.gitignore"
}
# Subversion
function vcs_ignore_svn() {
svn propset svn:ignore "$(vcs_relative_path "$file")"
svn propset svn:ignore "$file" "$(vcs_relative_path)"
}
# Perforce
function vcs_ignore_p4() {
@@ -603,6 +661,7 @@ function vcs_notice_hg() {
# Git
function vcs_notice_git() {
vcs_notice_generic_file "$REPOBASE/.gitignore" "$file"
git add "$REPOBASE/.gitignore"
}
# Subversion
function vcs_notice_svn() {
@@ -632,3 +691,20 @@ function vcs_notice_generic_file() {
echo "WARNING: If so, manually update the ignore file"
fi
}
function gpg_agent_version_check() {
if ! hash 'gpg-agent' &> /dev/null; then
return 1
fi
local gpg_agent_version=$(gpg-agent --version | head -1 | awk '{ print $3 }' | tr -d '\n')
semverLT $gpg_agent_version "2.1.0"
}
function gpg_agent_notice() {
if [[ $(gpg_agent_version_check) == '0' && -z $GPG_AGENT_INFO ]];then
echo 'WARNING: You probably want to run gpg-agent as'
echo 'you will be asked for your passphrase many times.'
echo 'Example: $ eval $(gpg-agent --daemon)'
read -r -p 'Press CTRL-C now to stop. ENTER to continue: '
fi
}

View File

@@ -53,11 +53,11 @@ function create_self_deleting_tempfile() {
local filename
case $(uname -s) in
Darwin )
: "${TMPDIR:=/tmp}"
Darwin | FreeBSD )
: "${TMPDIR:=/tmp}" ;
filename=$(mktemp -t _stacklib_.XXXXXXXX )
;;
Linux | CYGWIN* | MINGW* )
Linux | CYGWIN* | MINGW* | NetBSD | SunOS )
filename=$(mktemp)
;;
* )
@@ -74,11 +74,11 @@ function create_self_deleting_tempdir() {
local filename
case $(uname -s) in
Darwin )
: "${TMPDIR:=/tmp}"
Darwin | FreeBSD )
: "${TMPDIR:=/tmp}" ;
filename=$(mktemp -d -t _stacklib_.XXXXXXXX )
;;
Linux | CYGWIN* | MINGW* )
Linux | CYGWIN* | MINGW* | NetBSD | SunOS )
filename=$(mktemp -d)
;;
* )
@@ -98,11 +98,11 @@ function make_self_deleting_tempfile() {
local name
case $(uname -s) in
Darwin )
: "${TMPDIR:=/tmp}"
Darwin | FreeBSD )
: "${TMPDIR:=/tmp}" ;
name=$(mktemp -t _stacklib_.XXXXXXXX )
;;
Linux | CYGWIN* | MINGW* )
Linux | CYGWIN* | MINGW* | NetBSD | SunOS )
name=$(mktemp)
;;
* )
@@ -120,11 +120,14 @@ function make_tempdir() {
local name
case $(uname -s) in
Darwin )
: "${TMPDIR:=/tmp}"
name=$(mktemp -d -t _stacklib_.XXXXXXXX )
Darwin | FreeBSD )
: "${TMPDIR:=/tmp}" ;
# The full path to the temp directory must be short.
# This is used by blackbox's testing suite to make a fake GNUPGHOME,
# which needs to fit within sockaddr_un.sun_path (see unix(7)).
name=$(mktemp -d -t SO )
;;
Linux | CYGWIN* | MINGW* )
Linux | CYGWIN* | MINGW* | NetBSD | SunOS )
name=$(mktemp -d)
;;
* )
@@ -157,14 +160,14 @@ function fail_if_not_running_as_root() {
function fail_if_in_root_directory() {
# Verify nobody has tricked us into being in "/".
case $(uname -s) in
Darwin )
Darwin | FreeBSD | NetBSD )
if [[ $(stat -f'%i' / ) == $(stat -f'%i' . ) ]] ; then
echo 'SECURITY ALERT: The current directory is the root directory.'
echo 'Exiting...'
exit 1
fi
;;
Linux | CYGWIN* | MINGW* )
Linux | CYGWIN* | MINGW* | SunOS )
if [[ $(stat -c'%i' / ) == $(stat -c'%i' . ) ]] ; then
echo 'SECURITY ALERT: The current directory is the root directory.'
echo 'Exiting...'
@@ -177,3 +180,109 @@ function fail_if_in_root_directory() {
;;
esac
}
function semverParseInto() {
local RE='[^0-9]*\([0-9]*\)[.]\([0-9]*\)[.]\([0-9]*\)\([0-9A-Za-z-]*\)'
#MAJOR
eval $2=`echo $1 | sed -e "s#$RE#\1#"`
#MINOR
eval $3=`echo $1 | sed -e "s#$RE#\2#"`
#MINOR
eval $4=`echo $1 | sed -e "s#$RE#\3#"`
#SPECIAL
eval $5=`echo $1 | sed -e "s#$RE#\4#"`
}
function semverEQ() {
local MAJOR_A=0
local MINOR_A=0
local PATCH_A=0
local SPECIAL_A=0
local MAJOR_B=0
local MINOR_B=0
local PATCH_B=0
local SPECIAL_B=0
semverParseInto $1 MAJOR_A MINOR_A PATCH_A SPECIAL_A
semverParseInto $2 MAJOR_B MINOR_B PATCH_B SPECIAL_B
if [ $MAJOR_A -ne $MAJOR_B ]; then
return 1
fi
if [ $MINOR_A -ne $MINOR_B ]; then
return 1
fi
if [ $PATCH_A -ne $PATCH_B ]; then
return 1
fi
if [[ "_$SPECIAL_A" != "_$SPECIAL_B" ]]; then
return 1
fi
return 0
}
function semverLT() {
local MAJOR_A=0
local MINOR_A=0
local PATCH_A=0
local SPECIAL_A=0
local MAJOR_B=0
local MINOR_B=0
local PATCH_B=0
local SPECIAL_B=0
semverParseInto $1 MAJOR_A MINOR_A PATCH_A SPECIAL_A
semverParseInto $2 MAJOR_B MINOR_B PATCH_B SPECIAL_B
if [ $MAJOR_A -lt $MAJOR_B ]; then
return 0
fi
if [[ $MAJOR_A -le $MAJOR_B && $MINOR_A -lt $MINOR_B ]]; then
return 0
fi
if [[ $MAJOR_A -le $MAJOR_B && $MINOR_A -le $MINOR_B && $PATCH_A -lt $PATCH_B ]]; then
return 0
fi
if [[ "_$SPECIAL_A" == "_" ]] && [[ "_$SPECIAL_B" == "_" ]] ; then
return 1
fi
if [[ "_$SPECIAL_A" == "_" ]] && [[ "_$SPECIAL_B" != "_" ]] ; then
return 1
fi
if [[ "_$SPECIAL_A" != "_" ]] && [[ "_$SPECIAL_B" == "_" ]] ; then
return 0
fi
if [[ "_$SPECIAL_A" < "_$SPECIAL_B" ]]; then
return 0
fi
return 1
}
function semverGT() {
semverEQ $1 $2
local EQ=$?
semverLT $1 $2
local LT=$?
if [ $EQ -ne 0 ] && [ $LT -ne 0 ]; then
return 0
else
return 1
fi
}

View File

@@ -19,7 +19,8 @@ KEYNAME="$1"
# Add the email address to the BB_ADMINS file. Remove any duplicates.
# The file must exist for sort to act as we expect.
touch "$BB_ADMINS"
sort -fdu -o "$BB_ADMINS" <(echo "$1") "$BB_ADMINS"
echo "$1" >> "$BB_ADMINS"
sort -fdu -o "$BB_ADMINS" "$BB_ADMINS"
# Add the user's key to the keychain.

View File

@@ -14,9 +14,7 @@
export PATH=/usr/bin:/bin:"$PATH"
set -e
source "${0%/*}/_blackbox_common.sh"
if [[ -z $GPG_AGENT_INFO ]]; then
eval $(gpg-agent --daemon)
fi
gpg_agent_notice
exec blackbox_postdeploy "$@"

15
bin/blackbox_decrypt_file Executable file
View File

@@ -0,0 +1,15 @@
#!/usr/bin/env bash
#
# blackbox_decrypt_file -- Decrypt one or more blackbox files.
#
set -e
source "${0%/*}/_blackbox_common.sh"
if [ $# -eq 0 ]; then
echo >&2 "Please provide at least one file to decrypt"
exit 1
fi
"${BLACKBOX_HOME}/blackbox_edit_start" "$@"

View File

@@ -26,9 +26,10 @@ fail_if_not_exists "$encrypted_file" "Please specify an existing file."
prepare_keychain
remove_filename_from_cryptlist "$unencrypted_file"
vcs_remove "$encrypted_file"
vcs_notice "$unencrypted_file"
vcs_add "$BB_FILES"
vcs_commit "Removing from blackbox: ${unencrypted_file}" "$BB_FILES" "$encrypted_file"
vcs_commit "Removing from blackbox: ${unencrypted_file}" "$BB_FILES" "$encrypted_file" "$(vcs_ignore_file_path)"
echo "========== UPDATING VCS: DONE"
echo "Local repo updated. Please push when ready."
echo " $VCS_TYPE push"

View File

@@ -7,13 +7,7 @@
set -e
source "${0%/*}/_blackbox_common.sh"
if [[ -z $GPG_AGENT_INFO ]]; then
echo 'WARNING: You probably want to run gpg-agent as'
echo 'you will be asked for your passphrase many times.'
echo 'Example: $ eval $(gpg-agent --daemon)'
read -r -p 'Press CTRL-C now to stop. ENTER to continue: '
fi
gpg_agent_notice
prepare_keychain
modified_files=()

View File

@@ -9,6 +9,11 @@ source "${0%/*}/_blackbox_common.sh"
next_steps=()
if [ $# -eq 0 ]; then
echo >&2 "Please provide at least one file for which editing has finished"
exit 1
fi
for param in "$@" ; do
unencrypted_file=$(get_unencrypted_filename "$param")

View File

@@ -7,6 +7,11 @@
set -e
source "${0%/*}/_blackbox_common.sh"
if [ $# -eq 0 ]; then
echo >&2 "Please provide at least one file to start editing"
exit 1
fi
for param in "$@" ; do
unencrypted_file=$(get_unencrypted_filename "$param")

View File

@@ -19,10 +19,15 @@ if [[ $1 != 'yes' ]]; then
fi
fi
if [[ $VCS_TYPE = "unknown" ]]; then
echo 'Not in a known VCS directory'
exit 1
fi
change_to_vcs_root
echo VCS_TYPE: $VCS_TYPE
vcs_ignore keyrings/live/pubring.gpg~ keyrings/live/pubring.kbx~ keyrings/live/secring.gpg
vcs_ignore "${BLACKBOXDATA}/pubring.gpg~" "${BLACKBOXDATA}/pubring.kbx~" "${BLACKBOXDATA}/secring.gpg"
# Make directories
mkdir -p "${KEYRINGDIR}"
@@ -30,11 +35,29 @@ vcs_add "${KEYRINGDIR}"
touch "$BLACKBOXDATA/$BB_ADMINS_FILE" "$BLACKBOXDATA/$BB_FILES_FILE"
vcs_add "$BLACKBOXDATA/$BB_ADMINS_FILE" "$BLACKBOXDATA/$BB_FILES_FILE"
IGNOREFILE="$(vcs_ignore_file_path)"
test -f "$IGNOREFILE" && vcs_add "$IGNOREFILE"
if [[ $VCS_TYPE = "git" ]]; then
# Make a suggestion:
echo
echo
echo 'NEXT STEP: You need to manually check these in:'
echo ' ' $VCS_TYPE commit -m\'INITIALIZE BLACKBOX\' keyrings "$IGNOREFILE"
# 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
echo '`subversion` automatically tracks the ignored files; you just need to commit.'
else
IGNOREFILE="$(vcs_ignore_file_path)"
test -f "$IGNOREFILE" && vcs_add "$IGNOREFILE"
# Make a suggestion:
echo
echo
echo 'NEXT STEP: You need to manually check these in:'
echo ' ' $VCS_TYPE commit -m\'INITIALIZE BLACKBOX\' "$BLACKBOXDATA" "$IGNOREFILE"
fi

8
bin/blackbox_list_admins Executable file
View File

@@ -0,0 +1,8 @@
#!/usr/bin/env bash
#
# blackbox_list_admins -- List authorized admins
#
set -e
source "${0%/*}/_blackbox_common.sh"
cat "$BB_ADMINS"

18
bin/blackbox_listadmins Executable file
View File

@@ -0,0 +1,18 @@
#!/usr/bin/env bash
#
# blackbox_listadmins -- List active admins for keyring
#
# Example:
# blackbox_listadmins
#
set -e
source "${0%/*}/_blackbox_common.sh"
fail_if_not_in_repo
# simply display the contents of the admins file
cat "$BB_ADMINS"

View File

@@ -36,7 +36,7 @@ function register_new_file() {
echo "========== UPDATING REPO:"
shred_file "$unencrypted_file"
if "$SECRETSEXPOSED" ; then
if [[ "$SECRETSEXPOSED" == "true" ]] ; then
vcs_remove "$unencrypted_file"
vcs_add "$encrypted_file"
fi
@@ -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
@@ -52,5 +52,9 @@ for target in "$@"; do
done
echo "========== UPDATING VCS: DONE"
echo "Local repo updated. Please push when ready."
echo " $VCS_TYPE push"
if [[ $VCS_TYPE = "svn" ]]; then
echo "Local repo updated and file pushed to source control (unless an error was displayed)."
else
echo "Local repo updated. Please push when ready."
echo " $VCS_TYPE push"
fi

View File

@@ -20,8 +20,15 @@ KEYNAME="$1"
# Remove the email address from the BB_ADMINS file.
remove_line "$BB_ADMINS" "$KEYNAME"
# remove the admin key from the pubring
$GPG --no-permission-warning --homedir="$KEYRINGDIR" --batch --yes --delete-key "$KEYNAME" || true
pubring_path=$(get_pubring_path)
vcs_add "$pubring_path" "$KEYRINGDIR/trustdb.gpg" "$BB_ADMINS"
# Make a suggestion:
echo
echo
echo 'NEXT STEP: Check these into the repo. Probably with a command like...'
echo $VCS_TYPE commit -m\'REMOVED ADMIN: $KEYNAME\' "$BLACKBOXDATA/$BB_ADMINS_FILE"
echo $VCS_TYPE commit -m\'REMOVED ADMIN: $KEYNAME\' "$BLACKBOXDATA/$(basename ${pubring_path})" "$BLACKBOXDATA/trustdb.gpg" "$BLACKBOXDATA/$BB_ADMINS_FILE"

View File

@@ -21,13 +21,30 @@ source "${0%/*}/_blackbox_common.sh"
change_to_vcs_root
echo '========== FILES BEING SHREDDED:'
while IFS= read <&99 -r unencrypted_file; do
unencrypted_file=$(get_unencrypted_filename "$unencrypted_file")
encrypted_file=$(get_encrypted_filename "$unencrypted_file")
exported_internal_shred_file() {
source "$1/_blackbox_common.sh"
#unencrypted_file=$(get_unencrypted_filename "$2")
unencrypted_file="$2"
if [[ -f "$unencrypted_file" ]]; then
echo " $unencrypted_file"
echo " SHRED: $unencrypted_file"
shred_file "$unencrypted_file"
else
echo "NOT FOUND: $unencrypted_file"
fi
done 99<"$BB_FILES"
}
export -f exported_internal_shred_file
DEREFERENCED_BIN_DIR="${0%/*}"
MAX_PARALLEL_SHRED=10
bash_args=
if bash --help | grep import-functions >/dev/null 2>/dev/null; then
bash_args=--import-functions
fi
export IFS=
tr '\n' '\0' <"$BB_FILES" | xargs -0 -I{} -P $MAX_PARALLEL_SHRED bash $bash_args -c "exported_internal_shred_file $DEREFERENCED_BIN_DIR \"{}\"" $DEREFERENCED_BIN_DIR/fake
echo '========== DONE.'

View File

@@ -7,13 +7,7 @@
set -e
source "${0%/*}/_blackbox_common.sh"
if [[ -z $GPG_AGENT_INFO ]]; then
echo 'WARNING: You probably want to run gpg-agent as'
echo 'you will be asked for your passphrase many times.'
echo 'Example: $ eval $(gpg-agent --daemon)'
read -r -p 'Press CTRL-C now to stop. ENTER to continue: '
fi
gpg_agent_notice
disclose_admins
prepare_keychain

20
bin/blackbox_view Executable file
View File

@@ -0,0 +1,20 @@
#!/usr/bin/env bash
#
# blackbox_view -- Decrypt a file, view it, shred it
#
set -e
source "${0%/*}/_blackbox_common.sh"
for param in "$@" ; do
shreddable=0
unencrypted_file=$(get_unencrypted_filename "$param")
if [[ ! -e "$unencrypted_file" ]]; then
"${BLACKBOX_HOME}/blackbox_edit_start" "$param"
shreddable=1
fi
${PAGER:-less} "$unencrypted_file"
if [[ $shreddable = 1 ]]; then
shred_file "$unencrypted_file"
fi
done

View File

@@ -14,13 +14,7 @@ then
fi
fail_if_not_in_repo
if [[ -z $GPG_AGENT_INFO ]]; then
echo 'WARNING: You probably want to run gpg-agent as'
echo 'you will be asked for your passphrase many times.'
echo 'Example: $ eval $(gpg-agent --daemon)'
read -r -p 'Press CTRL-C now to stop. ENTER to continue: '
fi
gpg_agent_notice
COLUMNS=`tput cols`
FILE=$1

View File

@@ -1,4 +1,4 @@
#!/bin/zsh
#!/usr/bin/env zsh
# The MIT License (MIT)
# Copyright (c) 2014 Stack Exchange, Inc.

25
tools/auto_system_test Executable file
View File

@@ -0,0 +1,25 @@
#!/usr/bin/env expect
# Run the confidence test non-interactively. Since the script
# asks for passphrases, we use "expect" to simulate keyboard data entry.
# Run the test:
spawn tools/confidence_test.sh
# As we run the confidence test, respond with the right password.
# We do this for up to 300 times to prevent an infinite loop.
set times 0;
while { $times < 300 } {
expect {
# The script outputs what the password will be, and we save
# that info in $pw any time we see the text.
"my password is the lowercase letter a" { set pw "a\n" ; exp_continue }
"my password is the lowercase letter b" { set pw "b\n" ; exp_continue }
# If the passphrase is requested, send it.
"Passphrase:" { send $pw ; exp_continue }
# If we reach EOF, exit this loop.
eof { break }
}
set times [ expr $times+1];
}

View File

@@ -1,7 +1,30 @@
#!/usr/bin/env bash
blackbox_home=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )/../bin
export PATH="${blackbox_home}:/usr/local/bin:/bin:/usr/bin:/usr/local/sbin:/usr/sbin:/sbin:/opt/local/bin"
export PATH="${blackbox_home}:/usr/local/bin:/bin:/usr/bin:/usr/local/sbin:/usr/sbin:/sbin:/opt/local/bin:/usr/pkg/bin:/usr/pkg/gnu/bin:${blackbox_home}"
export LANG=C.UTF-8 # Required ro "gpg --export" to work properly.
# TODO(tlim): The tests are hardcoded to this directory. This should be fixed.
export BLACKBOXDATA=keyrings/live
# This script requires many utilities, some are not
# required by the usual blackbox scripts. Test to make
# sure we have them all.
e=false
for i in blackbox_addadmin blackbox_list_admins blackbox_register_new_file \
cat git gpg gpg-agent mkdir pinentry pinentry-tty rm tar which ; do
if ! which >/dev/null 2>&1 $i ; then
echo ERROR: Command not in PATH: $i
e=true
fi
done
if $e ; then
echo 'Exiting. Please install the above commands.'
echo 'This script requires many utilities not required by blackbox itself.'
echo PATH="$PATH"
exit 1
fi
set -e
. _stack_lib.sh
@@ -19,10 +42,15 @@ cd "$test_repository"
make_self_deleting_tempdir fake_alice_home
make_self_deleting_tempdir fake_bob_home
export GNUPGHOME="$fake_alice_home"
#echo 'pinentry-program' "$(which pinentry-insecure-fake)" >> "$GNUPGHOME/gpg-agent.conf"
echo 'pinentry-program' "$(which pinentry-tty)" >> "$GNUPGHOME/gpg-agent.conf"
#pinentry-program "${blackbox_home}/pinentry-fake-insecure"
eval "$(gpg-agent --homedir "$fake_alice_home" --daemon)"
GPG_AGENT_INFO_ALICE="$GPG_AGENT_INFO"
export GNUPGHOME="$fake_bob_home"
#echo 'pinentry-program' "$(which pinentry-insecure-fake)" >> "$GNUPGHOME/gpg-agent.conf"
echo 'pinentry-program' "$(which pinentry-tty)" >> "$GNUPGHOME/gpg-agent.conf"
eval "$(gpg-agent --homedir "$fake_bob_home" --daemon)"
GPG_AGENT_INFO_BOB="$GPG_AGENT_INFO"
@@ -31,6 +59,7 @@ function become_alice() {
export GPG_AGENT_INFO="$GPG_AGENT_INFO_ALICE"
echo BECOMING ALICE: GNUPGHOME="$GNUPGHOME AGENT=$GPG_AGENT_INFO"
mkdir -p .git ; touch .git/config
git init
git config user.name "Alice Example"
git config user.email alice@example.com
}
@@ -46,7 +75,6 @@ function become_bob() {
PHASE 'Alice creates a repo. She creates secret.txt.'
become_alice
git init
echo 'this is my secret' >secret.txt
@@ -82,7 +110,11 @@ git commit -m'INITIALIZE BLACKBOX' keyrings .gitignore
PHASE 'and adds herself as an admin.'
blackbox_addadmin alice@example.com
git commit -m'NEW ADMIN: alice@example.com' keyrings/live/pubring.gpg keyrings/live/trustdb.gpg keyrings/live/blackbox-admins.txt
git commit -m'NEW ADMIN: alice@example.com' keyrings/live/pubring.??? keyrings/live/trustdb.gpg keyrings/live/blackbox-admins.txt
make_self_deleting_tempfile adminlist1
blackbox_list_admins >"$adminlist1"
assert_file_md5hash "$adminlist1" "aa1db827772e1d51d453b844394b7617"
PHASE 'Bob arrives.'
@@ -110,14 +142,18 @@ gpg --no-permission-warning --batch --gen-key "$gpgconfig"
echo '========== Bob enrolls himself too.'
blackbox_addadmin bob@example.com
git commit -m'NEW ADMIN: alice@example.com' keyrings/live/pubring.gpg keyrings/live/trustdb.gpg keyrings/live/blackbox-admins.txt
git commit -m'NEW ADMIN: alice@example.com' keyrings/live/pubring.??? keyrings/live/trustdb.gpg keyrings/live/blackbox-admins.txt
make_self_deleting_tempfile adminlist2
blackbox_list_admins >"$adminlist2"
assert_file_md5hash "$adminlist2" "0b82b0b3c96e6e5dd5faf60493fe5cf7"
PHASE 'Alice does the second part to enroll bob.'
become_alice
PHASE 'She enrolls bob.'
gpg --import keyrings/live/pubring.gpg
# TODO(tlim) That --import can be eliminated... maybe?
#gpg --import $(get_pubring_path)
## TODO(tlim) That --import can be eliminated... maybe?
PHASE 'She enrolls secrets.txt.'
blackbox_register_new_file secret.txt
@@ -185,33 +221,30 @@ assert_file_md5hash secret.txt "d3e6bbdfc76fae7fd0a921f3408db1d1"
PHASE 'appears.'
become_bob
PHASE 'Bob makes sure he has all new keys.'
gpg --import keyrings/live/pubring.gpg
#PHASE 'Bob makes sure he has all new keys.'
#gpg --import keyrings/live/pubring.???
# Pick a GID to use:
# This users's default group:
DEFAULT_GID_NAME=$(id -gn)
DEFAULT_GID_NUM=$(id -g)
# Pick a group that is not the default group:
TEST_GID_NUM=$(id -G | fmt -1 | tail -n +2 | grep -xv "$(id -u)" | head -n 1)
TEST_GID_NAME=$(python -c 'import grp; print grp.getgrgid('"$TEST_GID_NUM"').gr_name')
echo "DEFAULT_GID_NAME=$DEFAULT_GID_NAME"
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"
echo "TEST_GID_NAME=$TEST_GID_NAME"
PHASE 'Bob postdeploys... default.'
blackbox_postdeploy
assert_file_exists secret.txt
assert_file_exists secret.txt.gpg
assert_file_md5hash secret.txt "08a3fa763a05c018a38e9924363b97e7"
assert_file_group secret.txt "$DEFAULT_GID_NAME"
assert_file_group secret.txt "$DEFAULT_GID_NUM"
PHASE 'Bob postdeploys... with a GID.'
blackbox_postdeploy "$TEST_GID_NUM"
assert_file_exists secret.txt
assert_file_exists secret.txt.gpg
assert_file_md5hash secret.txt "08a3fa763a05c018a38e9924363b97e7"
assert_file_group secret.txt "$TEST_GID_NAME"
assert_file_group secret.txt "$TEST_GID_NUM"
PHASE 'Bob cleans up the secret.'
rm secret.txt
@@ -220,6 +253,10 @@ PHASE 'Bob removes Alice.'
blackbox_removeadmin alice@example.com
assert_line_not_exists 'alice@example.com' keyrings/live/blackbox-admins.txt
make_self_deleting_tempfile adminlist3
blackbox_list_admins >"$adminlist3"
assert_file_md5hash "$adminlist3" "aadbfafd76ea66ff40dbfd239a69067f"
PHASE 'Bob reencrypts files so alice can not access them.'
blackbox_update_all_files
@@ -316,6 +353,7 @@ PHASE 'Bob shreds all exposed files.'
assert_file_exists 'my/path/to/relsecrets.txt'
assert_file_exists 'secret.txt'
blackbox_shred_all_files
which blackbox_shred_all_files
assert_file_missing '!important!.txt'
assert_file_missing '#andpounds.txt'
assert_file_missing 'mistake.txt'
@@ -393,6 +431,10 @@ fi
# Cleanup:
blackbox_removeadmin abba@notarealuser.com
make_self_deleting_tempfile adminlist4
blackbox_list_admins >"$adminlist4"
assert_file_md5hash "$adminlist4" "aadbfafd76ea66ff40dbfd239a69067f"
# TODO: Create a new directory. "git clone" the repo into it.

View File

@@ -22,13 +22,27 @@ shift
# Defaults that can be overridden:
# All packages are 1.0 unless otherwise specifed:
: ${PKGVERSION:=1.0} ;
# If there is no iteration setting, assume "1":
: ${PKGRELEASE:=1}
# If there is no iteration set, default to use the number of commits in the repository:
if [[ -z "${PKGRELEASE}" ]]; then
PKGRELEASE=$(git rev-list HEAD --count)
if [[ $? != 0 ]]; then
# We're not in a git repo, fall back to 1 so we cope with being built from
# a tarball
PKGRELEASE=1
fi
fi
# If there is no epoch, assume 0
: ${PKGEPOCH:=0}
# The DEB is output here: (should be a place that can be wiped)
OUTPUTDIR="${HOME}/debbuild-$PACKAGENAME"
# Allow us to set a different OUTPUTDIR if we're building in CI/CD
if [[ -z "${OUTPUTDIR}" ]]; then
# The DEB is output here: (should be a place that can be wiped)
OUTPUTDIR="${HOME}/debbuild-${PACKAGENAME}"
else
echo "Using $OUTPUTDIR for OUTPUTDIR instead of ${HOME}/debbuild-${PACKAGENAME}"
fi
# The TeamCity templates expect to find the list of artifacts here:
DEB_BIN_LIST="${OUTPUTDIR}/bin-packages.txt"
@@ -36,6 +50,7 @@ DEB_BIN_LIST="${OUTPUTDIR}/bin-packages.txt"
# Clean the output dir.
rm -rf "$OUTPUTDIR"
mkdir -p "$OUTPUTDIR/installroot"
# Copy the files into place:

View File

@@ -9,7 +9,9 @@ exec /usr/bin/blackbox_edit ../bin/blackbox_edit
exec /usr/bin/blackbox_edit_end ../bin/blackbox_edit_end
exec /usr/bin/blackbox_edit_start ../bin/blackbox_edit_start
exec /usr/bin/blackbox_initialize ../bin/blackbox_initialize
exec /usr/bin/blackbox_listadmins ../bin/blackbox_listadmins
exec /usr/bin/blackbox_list_files ../bin/blackbox_list_files
exec /usr/bin/blackbox_list_admins ../bin/blackbox_list_admins
exec /usr/bin/blackbox_postdeploy ../bin/blackbox_postdeploy
exec /usr/bin/blackbox_register_new_file ../bin/blackbox_register_new_file
exec /usr/bin/blackbox_removeadmin ../bin/blackbox_removeadmin

View File

@@ -9,7 +9,9 @@ exec bin/blackbox_edit ../bin/blackbox_edit
exec bin/blackbox_edit_end ../bin/blackbox_edit_end
exec bin/blackbox_edit_start ../bin/blackbox_edit_start
exec bin/blackbox_initialize ../bin/blackbox_initialize
exec bin/blackbox_listadmins ../bin/blackbox_listadmins
exec bin/blackbox_list_files ../bin/blackbox_list_files
exec bin/blackbox_list_admins ../bin/blackbox_list_admins
exec bin/blackbox_postdeploy ../bin/blackbox_postdeploy
exec bin/blackbox_register_new_file ../bin/blackbox_register_new_file
exec bin/blackbox_removeadmin ../bin/blackbox_removeadmin

View File

@@ -19,28 +19,78 @@ set -e
PACKAGENAME=${1?"First arg must be the package name."}
shift
# What is my name?
CMDNAME=$(basename $0)
# Defaults that can be overridden:
# All packages are 1.0 unless otherwise specifed:
# Packages are 1.0 unless otherwise specifed:
: ${PKGVERSION:=1.0} ;
# If there is no iteration setting, assume "1":
: ${PKGRELEASE:=1}
# If there is no iteration set, default to use the number of commits in the repository:
if [[ -z "${PKGRELEASE}" ]]; then
PKGRELEASE=$(git rev-list HEAD --count)
if [[ $? != 0 ]]; then
# We're not in a git repo, fall back to 1 so we cope with being built from
# a tarball
PKGRELEASE=1
fi
fi
# If there is no epoch, assume 0
: ${PKGEPOCH:=0}
# The RPM is output here: (should be a place that can be wiped)
OUTPUTDIR="${HOME}/rpmbuild-$PACKAGENAME"
# The TeamCity templates expect to find the list of artifacts here:
# If no arch defined, assume any. Other good values include "native".
: ${PKGARCH:=all}
# NOTE: If we later compile code, we set this to "native", which
# FPM will translate to the correct value for local conditions.
# Allow us to set a different OUTPUTDIR if we're building in CI/CD
if [[ -z "${OUTPUTDIR}" ]]; then
# The RPM is output here: (should be a place that can be wiped)
OUTPUTDIR="${HOME}/rpmbuild-${PACKAGENAME}"
else
echo "Using ${OUTPUTDIR} for OUTPUTDIR instead of ${HOME}/rpmbuild-${PACKAGENAME}"
fi
INSTALLROOT="$OUTPUTDIR/installroot"
# StackOverflow's TeamCity templates expect to find the list of artifacts here:
RPM_BIN_LIST="${OUTPUTDIR}/bin-packages.txt"
# -- Now the real work can be done.
# Clean the output dir.
rm -rf "$OUTPUTDIR"
mkdir -p "$OUTPUTDIR/installroot"
mkdir -p "$INSTALLROOT"
# Copy the files into place:
# If there is a build script, execute it.
BUILDSCRIPTNAME="./build.${PACKAGENAME}.sh"
if [[ -x $BUILDSCRIPTNAME ]]; then
echo "========== $BUILDSCRIPTNAME FOUND. Running."
if [[ $PKGARCH == "all" ]]; then
echo 'WARNING: PKGARCH=all (which may not what you want)'
# If you are using a build.*.sh script, you probably want to
# set PKGARCH to "native" before you run mk_rpm_fpmdir.
fi
$BUILDSCRIPTNAME "$INSTALLROOT" "${PKGVERSION}"
# If we used the build build.*.sh script, it must do all compilation.
# Therefore, we disable the automagic GO build feature.
GO_COMPILE=false
else
GO_COMPILE=true
fi
# If there are additional args for fpm, read them into a variable. There is
# a chdir later, therefore we can't rely on the file path working at that time.
FPM_OPTIONS_FILE="./fpm_opts.${PACKAGENAME}.sh"
if [[ -f $FPM_OPTIONS_FILE ]]; then
echo "========== $FPM_OPTIONS_FILE FOUND. Loading."
FPM_OPTIONS=$(<$FPM_OPTIONS_FILE)
fi
# Warning: The contents of the file are evaluated therefore
# quotes and special chars must be quoted.
# Copy any static files into place:
set -o pipefail # Error out if any manifest is not found.
cat """$@""" | while read -a arr ; do
cat "$@" | while read -a arr ; do
PERM="${arr[0]}"
case $PERM in
\#*) continue ;; # Skip comments.
@@ -48,24 +98,39 @@ cat """$@""" | while read -a arr ; do
read) PERM=0744 ;;
*) ;;
esac
DST="$OUTPUTDIR/installroot/${arr[1]}"
DST="$INSTALLROOT/${arr[1]}"
SRC="${arr[2]}"
if [[ $SRC == "cmd/"* || $SRC == *"/cmd/"* ]]; then
( cd $(dirname "$SRC" ) && go build -a -v )
if [[ ${#arr[@]} != 3 ]] ; then
echo "ERROR: Line must contain 3 items."
echo "DEBUG NUM=${#arr[@]} PERM=$PERM DST=$DST SRC=$SRC"
exit 1
fi
if $GO_COMPILE && [[ $SRC == "cmd/"* || $SRC == *"/cmd/"* ]]; then
echo "========== BUILD&COPY $SRC"
( cd $(dirname "$SRC" ) && go get -d && go build )
PKGARCH=native
else
echo "========== COPY $SRC"
fi
if [[ ! -f "$SRC" ]]; then
echo "${CMDNAME}: ERROR: File not found: $SRC"
exit 1
fi
install -D -T -b -m "$PERM" -T "$SRC" "$DST"
done
# Build the RPM:
set -x
# Build the RPM out of what is found in $INSTALLROOT:
cd "$OUTPUTDIR" && fpm -s dir -t rpm \
-a all \
-a "${PKGARCH}" \
-n "${PACKAGENAME}" \
--epoch "${PKGEPOCH}" \
--version "${PKGVERSION}" \
--iteration "${PKGRELEASE}" \
${PKGDESCRIPTION:+ --description="${PKGDESCRIPTION}"} \
${PKGVENDOR:+ --vendor="${PKGVENDOR}"} \
-C "$OUTPUTDIR/installroot" \
${FPM_OPTIONS:+ $FPM_OPTIONS} \
-C "$INSTALLROOT" \
.
# TeamCity templates for RPMS expect to find

View File

@@ -11,7 +11,9 @@ exec /usr/blackbox/bin/blackbox_edit ../bin/blackbox_edit
exec /usr/blackbox/bin/blackbox_edit_end ../bin/blackbox_edit_end
exec /usr/blackbox/bin/blackbox_edit_start ../bin/blackbox_edit_start
exec /usr/blackbox/bin/blackbox_initialize ../bin/blackbox_initialize
exec /usr/blackbox/bin/blackbox_listadmins ../bin/blackbox_listadmins
exec /usr/blackbox/bin/blackbox_list_files ../bin/blackbox_list_files
exec /usr/blackbox/bin/blackbox_list_admins ../bin/blackbox_list_admins
exec /usr/blackbox/bin/blackbox_postdeploy ../bin/blackbox_postdeploy
exec /usr/blackbox/bin/blackbox_register_new_file ../bin/blackbox_register_new_file
exec /usr/blackbox/bin/blackbox_removeadmin ../bin/blackbox_removeadmin

View File

@@ -1,4 +1,4 @@
#!/bin/sh
#!/usr/bin/env sh
# Test profile.d-usrblackbox.sh

View File

@@ -1,5 +1,15 @@
#!/usr/bin/env bash
# NB: This is copied from _blackbox_common.sh
function get_pubring_path() {
: "${KEYRINGDIR:=keyrings/live}" ;
if [[ -f "${KEYRINGDIR}/pubring.gpg" ]]; then
echo "${KEYRINGDIR}/pubring.gpg"
else
echo "${KEYRINGDIR}/pubring.kbx"
fi
}
function PHASE() {
echo '********************'
echo '********************'
@@ -11,9 +21,15 @@ function PHASE() {
function md5sum_file() {
# Portably generate the MD5 hash of file $1.
case $(uname -s) in
Darwin )
Darwin | FreeBSD )
md5 -r "$1" | awk '{ print $1 }'
;;
NetBSD )
md5 -q "$1"
;;
SunOS )
digest -a md5 "$1"
;;
Linux )
md5sum "$1" | awk '{ print $1 }'
;;
@@ -37,7 +53,7 @@ function assert_file_missing() {
function assert_file_exists() {
if [[ ! -e "$1" ]]; then
echo "ASSERT FAILED: ${1} should exist."
echo "PWD=$(/bin/pwd -P)"
echo "PWD=$(/usr/bin/env pwd -P)"
#echo "LS START"
#ls -la
#echo "LS END"
@@ -62,11 +78,11 @@ function assert_file_group() {
assert_file_exists "$file"
case $(uname -s) in
Darwin|FreeBSD )
found=$(stat -f '%Sg' "$file")
Darwin | FreeBSD | NetBSD )
found=$(stat -f '%Dg' "$file")
;;
Linux )
found=$(stat -c '%G' "$file")
Linux | SunOS )
found=$(stat -c '%g' "$file")
;;
CYGWIN* )
echo "ASSERT_FILE_GROUP: Running on Cygwin. Not being tested."
@@ -78,8 +94,10 @@ function assert_file_group() {
;;
esac
echo "DEBUG: assert_file_group X${wanted}X vs. X${found}X"
echo "DEBUG:" $(which stat)
if [[ "$wanted" != "$found" ]]; then
echo "ASSERT FAILED: $file chgrp wanted=$wanted found=$found"
echo "ASSERT FAILED: $file chgrp group wanted=$wanted found=$found"
exit 1
fi
}
@@ -90,11 +108,11 @@ function assert_file_perm() {
assert_file_exists "$file"
case $(uname -s) in
Darwin|FreeBSD )
Darwin | FreeBSD | NetBSD )
found=$(stat -f '%Sp' "$file")
;;
# NB(tlim): CYGWIN hasn't been tested. It might be more like Darwin.
Linux | CYGWIN* )
Linux | CYGWIN* | SunOS )
found=$(stat -c '%A' "$file")
;;
* )
@@ -103,8 +121,10 @@ function assert_file_perm() {
;;
esac
echo "DEBUG: assert_file_perm X${wanted}X vs. X${found}X"
echo "DEBUG:" $(which stat)
if [[ "$wanted" != "$found" ]]; then
echo "ASSERT FAILED: $file chgrp wanted=$wanted found=$found"
echo "ASSERT FAILED: $file chgrp perm wanted=$wanted found=$found"
exit 1
fi
}