...
Page properties | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
Richard Esplin, richard.esplin@evernym.com, esplinr, Evernym
Dave Huseby, dhuseby@linuxfoundation.org, dhuseby, Hyperledger
Mentee
...
Project Plan
Git integration with external signing tools
Currently git supports signing / verifying commits and tags using GPG only. The goal of this project is to make the git signing interface compatible with external signing tools and with DIDs (Distributed Identities) using programs such as bettersign for example.
This project will be the continuation of the work already done by David Huseby on the subject. His previous work is here:
This project's working fork:
[signing]
format = openpgp
[signing "openpgp"]
program = /usr/bin/gpg
keyring = "--keyring pubring.kbx --no-default-keyring"
identity = "--local-user \"Jane Committer <jane@hackers.com>\""
sign = "$program --sign --status-fd=2 --detach-sign --ascii"
verify = $program --verify --status-fd=2"
[signing "openpgp.signature"]
regex = "^-----BEGIN PGP SIGNATURE-----$[^-]*^-----END PGP SIGNATURE-----$"
multiline = true
And the same goes for the command line:
git commit \
--sign
--signing-format=openpgp \
--signing-openpgp-program="/usr/bin/gpg" \
--signing-openpgp-keyring="--keyring pubring.kbx --no-default-keyring" \
--signing-openpgp-identity="--local-user \"Jane Committer <jane@hackers.com>\"" \
--signing-openpgp-sign="--sign --status-fd=2 --detach-sign --ascii"
Milestones
- Submit project proposal (June 18 2019)
- Review previous work (June 25)
- RFC with the technical design document sent to git mailing list (July 15 2019)
- Receive feedback (August 31)
- RFC patchbomb to the mailing list (September 30 2019)
- Second RFC to the mailing list (October 22 2019)
- Reveive Feedback (November 10 2019)
- Update code to support the config based approach (November 10 2019)
- Implement a Python Indy signing tool for DIDs (November 15 2019)
- Refine implementation and follow through to landing (November 15 2019)
Deliverables
- Git documentation
- Git signing plugin
- Project description and model
- Helper signing script template
- Stretch deliverable: Indy signing tool
- Project presentation
- Recorded presentation
Detailed Steps
Update documentation
- Git man page
- Other documentation
Update user configuration handling
- Change existing configuration keys to a more normalized new organization (
commit.gpgSign
tocommit.sign,
gpg.program
tosigning.openpgp.program,
gpg.<format>.program
tosigning.<format>.program)
Debug the git_signing_config and the openpgp_config/x509_config functions and verify that all unit tests pass.
Add new unit tests to verify that all deprecated aliases work as expected and produce good warnings.
Add new unit tests to verify that all new configuration keys work.
- Implement a config based signing interface
Add Helper scripts template
- Bash template
- Python template
Testing
- Integration testing
- Manual testing git with new functionalities and signing programs
Back-burner Tasks
These are secondary tasks to do while waiting for feedback or assistance, or finished early:
- Learn Rust
- Learn about Indy SDK, Indy CLI, and Verifiable Credentials
- Signing through the Indy CLI
- Contribute to BetterSign