diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..9b1a58c9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,13 @@ +## How to contribute + +You are encouraged to contribute to the repository by **forking and submitting a pull request**. + +For significant changes, please open an issue first to discuss the proposed changes to avoid re-work. + +(If you are new to GitHub, you might start with a [basic tutorial](https://help.github.com/articles/set-up-git) and check out a more detailed guide to [pull requests](https://help.github.com/articles/using-pull-requests/).) + +Pull requests will be evaluated by the repository guardians on a schedule and if deemed beneficial will be committed to the master. Pull requests should have a descriptive name and include an summary of all changes made in the pull request description. + +If you would like to propose a significant change, please open an issue first to discuss the work with the community. + +All contributors retain the original copyright to their stuff, but by contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users **under the terms of the license under which this project is distributed.** \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..bf1d61ca --- /dev/null +++ b/LICENSE @@ -0,0 +1,192 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + Copyright 2017 Sovrin Foundation + Copyright 2020 Province of British Columbia + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 00000000..fcb917c6 --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1,99 @@ +# Maintainers + + + +## Active Maintainers + +| Name | Github | LFID | +|---------------------|--------------------|------| +| Artem Ivanov | Artemkaaas | | +| Renata Toktar | Toktar | | +| Alexander Sherbakov | ashcherbakov | | +| Wade Barnes | WadeBarnes | | + +## Becoming a Maintainer + +Indy-Besu welcomes community contribution. +Each community member may progress to become a maintainer. + +How to become a maintainer: + +- Contribute significantly to the code in this repository. + +### Maintainers contribution requirement + +The requirement to be able to be proposed as a maintainer is: + +- 5 significant changes on code have been authored in this repos by the proposed maintainer and accepted (merged PRs). + +### Maintainers approval process + +The following steps must occur for a contributor to be "upgraded" as a maintainer: + +- The proposed maintainer has the sponsorship of at least one other maintainer. + - This sponsoring maintainer will create a proposal PR modifying the list of + maintainers. (see [proposal PR template](#proposal-pr-template).) + - The proposed maintainer accepts the nomination and expresses a willingness + to be a long-term (more than 6 month) committer by adding a comment in the proposal PR. + - The PR will be communicated in all appropriate communication channels + including at least [indy-contributors channel on Hyperledger Discord](https://discord.gg/hyperledger), + the [mailing list](https://lists.hyperledger.org/g/indy) + and any maintainer/community call. +- Approval by at least 3 current maintainers within two weeks of the proposal or + an absolute majority (half the total + 1) of current maintainers. + - Maintainers will vote by approving the proposal PR. +- No veto raised by another maintainer within the voting timeframe. + - All vetoes must be accompanied by a public explanation as a comment in the + proposal PR. + - A veto can be retracted, in that case the voting timeframe is reset and all approvals are removed. + - It is bad form to veto, retract, and veto again. + +The proposed maintainer becomes a maintainer either: + +- when two weeks have passed without veto since the third approval of the proposal PR, +- or an absolute majority of maintainers approved the proposal PR. + +In either case, no maintainer raised and stood by a veto. + +## Removing Maintainers + +Being a maintainer is not a status symbol or a title to be maintained indefinitely. + +It will occasionally be necessary and appropriate to move a maintainer to emeritus status. + +This can occur in the following situations: + +- Resignation of a maintainer. +- Violation of the Code of Conduct warranting removal. +- Inactivity. + - A general measure of inactivity will be no commits or code review comments + for two reporting quarters, although this will not be strictly enforced if + the maintainer expresses a reasonable intent to continue contributing. + - Reasonable exceptions to inactivity will be granted for known long term + leave such as parental leave and medical leave. +- Other unspecified circumstances. + +As for adding a maintainer, the record and governance process for moving a +maintainer to emeritus status is recorded using review approval in the PR making that change. + +Returning to active status from emeritus status uses the same steps as adding a +new maintainer. + +Note that the emeritus maintainer always already has the required significant contributions. +There is no contribution prescription delay. + +## Proposal PR template + +```markdown +I propose to add [maintainer github handle] as a Indy-Besu project maintainer. + +[maintainer github handle] contributed with many high quality commits: + +- [list significant achievements] + +Here are [their past contributions on Indy-Besu project](https://github.com/hyperledger/indy-besu/commits?author=[user github handle]). + +Voting ends two weeks from today. + +For more information on this process see the Becoming a Maintainer section in the MAINTAINERS.md file. +``` diff --git a/README.md b/README.md index aa316030..fdf192b2 100644 --- a/README.md +++ b/README.md @@ -2,38 +2,40 @@ ## Goals and ideas -* Provide a replacement for [Hyperledger Indy](https://www.hyperledger.org/projects/hyperledger-indy) ecosystem that provides support for verifiable credentials: - * Components to replace: - * Distributed ledger: [Indy Node](https://github.com/hyperledger/indy-node) and [Indy Plenum](https://github.com/hyperledger/indy-plenum) - * Client library: [Indy SDK](https://github.com/hyperledger/indy-sdk/tree/main) - * Capability to migrate the data from the original Indy Ledger +* Provide a replacement for [Hyperledger Indy](https://www.hyperledger.org/projects/hyperledger-indy) ecosystem that + provides support for verifiable credentials: + * Components to replace: + * Distributed ledger: [Indy Node](https://github.com/hyperledger/indy-node) + and [Indy Plenum](https://github.com/hyperledger/indy-plenum) + * Client library: [Indy SDK](https://github.com/hyperledger/indy-sdk/tree/main) + * Capability to migrate the data from the original Indy Ledger * Distributed ledger requirements: - * Public Permissioned Blockchain - * Control the validator nodes - * Control the user permissions - * EVM compatible Blockchain - * Capability to deploy on different networks - * Based on existing open-source blockchain framework with a good performance, sufficient adoption, and wide community - * Capability to work without tokens and fees - * Stable consensus protocol + * Public Permissioned Blockchain + * Control the validator nodes + * Control the user permissions + * EVM compatible Blockchain + * Capability to deploy on different networks + * Based on existing open-source blockchain framework with a good performance, sufficient adoption, and wide + community + * Capability to work without tokens and fees + * Stable consensus protocol * Functional requirements: - * Interoperability: - * Capability to use existing DID's and identifiers: - * Support [indy](https://hyperledger.github.io/indy-did-method/) DID method - * Support [sov](https://sovrin-foundation.github.io/sovrin/spec/did-method-spec-template.html) DID method - * Identifiers previously stored on the client side should be resolvable on the new Ledger - * Capability to use the ledger as an [AnonCreds Registry](https://hyperledger.github.io/anoncreds-methods-registry/) - * Compatibility with the latest [AnonCreds Specification](https://hyperledger.github.io/anoncreds-spec/) - * Extensibility: - * Capability to integrate new pieces of functionality easily - * Capability to use [ETHR](https://github.com/decentralized-identity/ethr-did-resolver/blob/master/doc/did-method-spec.md) DID method - * Integration with the [AnonCreds Registry](https://hyperledger.github.io/anoncreds-methods-registry/) - * Integration with `Permissioned` modules - * Data validity: - * Neglect `gas` efficiency in favour general validation of the stored data - * Basic [DID Documents](https://www.w3.org/TR/did-core/) validation - * Basic [AnonCreds entities](https://hyperledger.github.io/anoncreds-spec/#anoncreds-setup-data-flow) validation - * Basic state consistency validation + * Interoperability: + * Capability to use existing DID's and identifiers: + * Support [indy](https://hyperledger.github.io/indy-did-method/) DID method + * Support [sov](https://sovrin-foundation.github.io/sovrin/spec/did-method-spec-template.html) DID method + * Identifiers previously stored on the client side should be resolvable on the new Ledger + * Capability to use the ledger as + an [AnonCreds Registry](https://hyperledger.github.io/anoncreds-methods-registry/) + * Compatibility with the latest [AnonCreds Specification](https://hyperledger.github.io/anoncreds-spec/) + * Extensibility: + * Capability to integrate new pieces of functionality easily + * Capability to + use [ETHR](https://github.com/decentralized-identity/ethr-did-resolver/blob/master/doc/did-method-spec.md) DID + method + * Integration with the [AnonCreds Registry](https://hyperledger.github.io/anoncreds-methods-registry/) + * Integration with `Permissioned` modules + * Do only basic state consistency validation ## Design documentation @@ -45,7 +47,10 @@ See [design document](./docs/README.md) covering the main ledger aspects. - [Docker and Docker-compose](https://docs.docker.com/compose/install/) v2 or higher -> ⚠️ **Note**: If on MacOS or Windows, please ensure that you allow docker to use upto 4G of memory under the _Resources_ section. The [Docker for Mac](https://docs.docker.com/docker-for-mac/) and [Docker Desktop](https://docs.docker.com/docker-for-windows/) sites have details on how to do this at the "Resources" heading +> ⚠️ **Note**: If on MacOS or Windows, please ensure that you allow docker to use upto 4G of memory under the +_Resources_ section. The [Docker for Mac](https://docs.docker.com/docker-for-mac/) +> and [Docker Desktop](https://docs.docker.com/docker-for-windows/) sites have details on how to do this at the " +> Resources" heading ### Commands @@ -57,7 +62,7 @@ See [design document](./docs/README.md) covering the main ledger aspects. ```bash ./network/scripts/run.sh --blockscout ``` - or + or ```bash ./network/scripts/run.sh -b ``` @@ -76,4 +81,15 @@ See [design document](./docs/README.md) covering the main ledger aspects. See [README.md](/smart_contracts/README.md). +## Contributing +Pull requests are welcome! Please read our [contributions guide](./CONTRIBUTING.md) +and submit your PRs. We enforce [developer certificate of origin](https://developercertificate.org/) (DCO) commit +signing. See guidance [here](https://github.com/apps/dco). + +We also welcome issues submitted about problems you encounter in using +`Indy-Besu`, `VDR` or any of the VDR wrappers. + +## License + +[Apache License Version 2.0](./LICENSE) diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..52dd88ef --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,11 @@ +# Hyperledger Security Policy + +## Reporting a Security Bug + +If you think you have discovered a security issue in any of the Hyperledger projects, we'd love to hear from you. We will take all security bugs seriously and if confirmed upon investigation we will patch it within a reasonable amount of time and release a public security bulletin discussing the impact and credit the discoverer. + +There are two ways to report a security bug. The easiest is to email a description of the flaw and any related information (e.g. reproduction steps, version) to [security at hyperledger dot org](mailto:security@hyperledger.org). + +The other way is to file a confidential security bug in our [JIRA bug tracking system](https://jira.hyperledger.org). Be sure to set the “Security Level” to “Security issue”. + +The process by which the Hyperledger Security Team handles security bugs is documented further in our [Defect Response page](https://wiki.hyperledger.org/display/HYP/Defect+Response) on our [wiki](https://wiki.hyperledger.org). \ No newline at end of file