Skip to content

Commit

Permalink
Uses .example suffix on testing submission key
Browse files Browse the repository at this point in the history
Added to the "validate" step, same as with config.json, so developers
must copy a file to `sd-journalist.sec` in order for the provisioning to
succeed. Using the test key provided in the repo will work, or
developers can provide another submission key, used with a hardware
instance for interactive testing.

In the process, I updated the config.json to use ".example"
consistently, since it was ".sample" in some places.
  • Loading branch information
Conor Schaefer committed Nov 12, 2018
1 parent 95dffef commit a307f4b
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
config.json
*.swp
builder/build/*
sd-journalist.sec

# Byte-compiled / optimized / DLL files
__pycache__/
Expand Down
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,9 @@ validate: assert-dom0 ## Checks for local requirements in dev env
@bash -c "test -e config.json" || \
{ echo "ERROR: missing 'config.json'!" && \
echo "Create from 'config.json.example'." && exit 1 ; }
@bash -c "test -e sd-journalist.sec" || \
{ echo "ERROR: missing 'sd-journalist.sec" && \
echo "Create from 'sd-journalist.sec.example'." && exit 1 ; }

.PHONY: flake8
flake8: ## Lints all Python files with flake8
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,8 @@ Qubes uses SaltStack internally for VM provisionining and configuration manageme
- The [SecureDrop Client](https://github.com/freedomofpress/securedrop-client) is installed in `sd-svs` and will be used to access the SecureDrop server Journalist Interface via the SecureDrop proxy.
- The [SecureDrop Proxy](https://github.com/freedomofpress/securedrop-proxy) is installed in `sd-proxy` to communicate to the SecureDrop server Journalist Interface via `sd-whonix`.
- Within `sd-svs`, the SecureDrop client will open all submissions in the `sd-svs-disp` disposable VM.
- `config.json.sample` is an example config file for the provisioning process. Before use, you should copy it to `config.json`, and adjust to reflect your environment.

- `config.json.example` is an example config file for the provisioning process. Before use, you should copy it to `config.json`, and adjust to reflect your environment.
- `sd-journalist.sec.example` is an example GPG private key for use in decrypting submissions. It must match the public key set on a SecureDrop server used for testing. Before use, you should copy it to `sd-journalist.sec`, or store the submission key used with your SecureDrop server as `sd-journalist.sec`.

### Development

Expand Down
File renamed without changes.
File renamed without changes.

0 comments on commit a307f4b

Please sign in to comment.