Hyperledger projects require their contributors to sign Git commits to attest to the Developer Certificate Origin (DCO). New developers have provided feedback that this process can be confusing and represents a barrier to contributing to the project.
Hyperledger Indy provides an identity system that can be used by developers to issue verifiable credentials attesting to the DCO. The Sovrin network is a public instance of Indy that would allow third parties to verify Indy credentials that use the network. Using Indy to sign Git commits would not only improve the contributor experience, but would also serve as a great real-world application of the Indy technology.
Successful completion of this project will involve learning skills such as:
- User experience research
- Solution design
- Software engineering
- Collaborating with on open source community
- Agile methodology
- Source control tools
- Digital identity solutions and verifiable credentials
- Standardization process for emerging protocols
- Cryptographic tools and primitives
- Technical writing and documentation
- Presentation and training
- A tool is contributed to the Indy SDK that allows developers to sign Git commits with the Hyperledger DCO using a credential issued on the Sovrin ledger.
- The tool has both unit and integration tests.
- The Indy SDK Getting Started Guide is updated to walk developers through the process of using the tool to obtain a Sovrin credential and use it to sign a contribution to the project.
Relation to Hyperledger
Immediately useful for Hyperledger Indy, but could make it easier to contribute to all Hyperledger projects.
Enrolled in an undergraduate program in a technical subject.
Basic programming experience is required. It is also desirable to have familiarity with Git, Rust, and Python.
As a result of this project, the intern will be familiar with Hyperledger Indy SDK and able to contribute in a variety of ways including improved documentation, testing, and feature development. A good follow on feature would be to integrate Indy credentials with GPG and SSH by exposing ed25519 keys to those tools.
Preferred Hours and Length of Internship
Either full time or part time is acceptable.
Mentor(s) Names and Contact Info
Richard Esplin, firstname.lastname@example.org, esplinr, Evernym
Dave Huseby, email@example.com, dhuseby, Hyperledger
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 (Distributed Identities) using programs such as for example.
This project will be the continuation of the work already done by on the subject. His previous work is here:
This project's working fork:
The main sections of the project are updating the user configuration and the command handling when a signing or verifying operation occur. The actions needed in each section can be listed below and will be evolving as the project evolves.
UPDATE: The request for proposal has been sent to the git mailing list and can be tracked here:
The commits that will be submitted as a patch can be found here:
After receiving feedback from the git community, we opted for a config based approch and a tool-agnostic signing interface. Below is the explained approach sent to the mailing list:
The user configuration would define the signing tool and other parameters as keys, identity and keychain. It would look like this:
[signing] format = openpgp [signing "openpgp"] program = /usr/bin/gpg keyring = "--keyring pubring.kbx --no-default-keyring" identity = "--local-user \"Jane Committer <firstname.lastname@example.org>\"" 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 <email@example.com>\"" \ --signing-openpgp-sign="--sign --status-fd=2 --detach-sign --ascii"
As for tool that don't work natively with the signing interface, a support for helper bash or python scripts will be added.
Below in an illustrative model of the expected outcome:
- 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)
- Git documentation
- Git signing plugin
- Project description and model
- Helper signing script template
- Stretch deliverable: Indy signing tool
- Project presentation
- Recorded presentation
- Git man page
- Other documentation
Update user configuration handling
- Change existing configuration keys to a more normalized new organization (
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
- Integration testing
- Manual testing git with new functionalities and signing programs
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