You may need to add an admin who can handle the encrypted data in this repository.
Do this procedure whenever a new person needs to handle secure information.
Only the developers responsible for this software will be granted access to this repository.
Additionally, some robot services that have subkeys registered may be admins. These keys won’t edit the content of the admin file, but they must be able to decrypt the content of the entire repository to do their job–run CI/CD testing and deployment.
This is a two step process that involves the following people:
The process goes something like this:
The admin does most of the work, but the user must initiate that work by adding their public key in a PR.
You can do all of the work by using the development containers in the ./devtools/bin directory.
This example uses the run-py2.7 script to launch the relevant container.
Let’s begin with the person who wants to be added.
Start the py2.7 (or equivalent) container.
SEA-ML-RUPP1:f5-ansible trupp$ ./devtools/bin/run-py2.7
Within this container, use the gpg2 –gen-key command to create a keypair. For example:
root@d7f809815281:/here# gpg2 --gen-key gpg (GnuPG) 2.1.20; Copyright (C) 2017 Free Software Foundation, Inc. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. Note: Use "gpg2 --full-generate-key" for a full featured key generation dialog. GnuPG needs to construct a user ID to identify your key. Real name: Foo Bar Email address: email@example.com You selected this USER-ID: "Foo Bar <firstname.lastname@example.org>" Change (N)ame, (E)mail, or (O)kay/(Q)uit? O gpg: key DBB462DE79ADE8C9 marked as ultimately trusted gpg: directory '/gpg/openpgp-revocs.d' created gpg: revocation certificate stored as '/gpg/openpgp-revocs.d/80E..................................8C9.rev' public and secret key created and signed. pub rsa2048 2017-10-11 [SC] [expires: 2019-10-11] 80E..................................8C9 80E..................................8C9 uid Foo Bar <email@example.com> sub rsa2048 2017-10-11 [E] [expires: 2019-10-11] root@d7f809815281:/here#
When done, you should see your email address when using the gpg2 –list-keys command.
You must have an initial keypair to use for encryption. If you do not, follow the instructions in the Creating a keypair section.
Now, start the container:
SEA-ML-RUPP1:f5-ansible trupp$ ./devtools/bin/run-py2.7
This command leaves you at a new shell prompt. Now create a new branch that contains the pull request with your admin addition in it. You can do this with git:
SEA-ML-RUPP1:f5-ansible trupp$ git checkout -b add-admin upstream/devel
git should notify you that you have changed branches.
Next, run the blackbox_addadmin command to change the necessary files for adding you as an admin. The single argument to this command is the email address that you specified when you created your initial key pair.
When this command finishes, several new files show as modified. Additionally, the blackbox_addadmin command tells you which command to use to commit these changes.
root@d7f809815281:/here# blackbox_addadmin firstname.lastname@example.org gpg: key DBB462DE79ADE8C9: public key "Foo Bar <email@example.com>" imported gpg: Total number processed: 1 gpg: imported: 1 NEXT STEP: You need to manually check these in: git commit -m'NEW ADMIN: firstname.lastname@example.org' keyrings/live/pubring.kbx keyrings/live/trustdb.gpg keyrings/live/blackbox-admins.txt root@d7f809815281:/here#
A git status command also illustrates this.
root@d7f809815281:/here# git status | grep keyrings modified: keyrings/live/blackbox-admins.txt modified: keyrings/live/pubring.kbx root@d7f809815281:/here#
Follow the instructions and commit those files.
git commit -m'NEW ADMIN: email@example.com' keyrings/live/pubring.kbx keyrings/live/trustdb.gpg keyrings/live/blackbox-admins.txt
You may now push the PR to the GitHub repository and follow the normal PR process.
First, verify and merge the PR the user sent.
Next, merge the PR into the repository. After that, rebase your own fork of the code to include this new merge commit.
git fetch upstream git stash git rebase upstream/devel git stash apply
With the new changes in your source tree, it’s time to re-encrypt all of the private files with the new user’s public key.
To do that, you can use the blackbox_update_all_files command from inside any of the development containers.
root@a710b12b1e97:/here# blackbox_update_all_files ========== blackbox administrators are: firstname.lastname@example.org HypePDSvc email@example.com ========== Importing keychain: START gpg: key DBE7B40B4ACC6C92: public key "Kat Austria <firstname.lastname@example.org>" imported gpg: Total number processed: 10 gpg: imported: 1 gpg: unchanged: 9 ========== Importing keychain: DONE ========== ENCRYPTED FILES TO BE RE-ENCRYPTED: devtools/secrets/jenkins_jobs.ini.secret.gpg ... test/runner/roles/harness/vars/TwoArmed-bigiq-5.3.0.yaml.gpg test/runner/roles/harness/vars/TwoArmed-iworkflow-2.1.0.yaml.gpg ========== FILES IN THE WAY: devtools/secrets/jenkins_jobs.ini.secret test/heat/jenkins-secondary-params.yaml test/pipeline/ci.f5.f5-ansible-public-to-private-parameters.include.yaml test/runner/roles/harness/vars/TwoArmed-bigip-12.1.2-hf1.yaml WARNING: This will overwrite any unencrypted files laying about. Press CTRL-C now to stop. ENTER to continue:
Press ENTER to proceed and re-encrypt all of the secrets. You will be asked for your own encryption password in the process.
... ========== RE-ENCRYPTING FILES: ========== PROCESSING "devtools/secrets/jenkins_jobs.ini.secret" ========== Encrypting: devtools/secrets/jenkins_jobs.ini.secret ========== Encrypting: DONE ... ========== PROCESSING "test/runner/roles/harness/vars/TwoArmed-iworkflow-2.1.0.yaml" ========== EXTRACTED test/runner/roles/harness/vars/TwoArmed-iworkflow-2.1.0.yaml ========== Encrypting: test/runner/roles/harness/vars/TwoArmed-iworkflow-2.1.0.yaml ========== Encrypting: DONE ========== COMMITING TO VCS: [devel f7021f1] Re-encrypted keys 35 files changed, 49 insertions(+) rewrite devtools/secrets/jenkins_jobs.ini.secret.gpg (100%) ... rewrite test/runner/roles/harness/vars/TwoArmed-bigiq-5.3.0.yaml.gpg (100%) rewrite test/runner/roles/harness/vars/TwoArmed-iworkflow-2.1.0.yaml.gpg (100%) ========== DONE. Likely next step: git push
blackbox will tell you what the likely next step is: git push. If you view the git log, you can see there is a new commit there for the re-encryption process.
commit f7021f14193d7d81f22920c2dbe0f16d90f08f17 Author: Tim Rupp <email@example.com> Date: Tue Nov 7 00:30:07 2017 +0000 Re-encrypted keys
Therefore, do the push as requested. When done, the new maintainer will have the ability to decrypt the secrets.