Skip to content

Commit d068726

Browse files
committed
Update after move to new GitHub org
Signed-off-by: Stephen Curran <swcurran@gmail.com>
1 parent e4c9b5d commit d068726

File tree

19 files changed

+202
-41
lines changed

19 files changed

+202
-41
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Indy-VDR (Verifiable Data Registry)
22

3-
[<img src="https://raw.githubusercontent.com/hyperledger/indy-node/master/collateral/logos/indy-logo.png" width="50%" height="auto">](https://github.com/hyperledger/indy-sdk/)
3+
[<img src="https://raw.githubusercontent.com/hyperledger-indy/indy-node/master/collateral/logos/indy-logo.png" width="50%" height="auto">](https://github.com/hyperledger-indy/indy-sdk/)
44

5-
[![Unit Tests](https://github.com/hyperledger/indy-vdr/workflows/Unit%20Tests/badge.svg)](https://github.com/hyperledger/indy-vdr/actions)
5+
[![Unit Tests](https://github.com/hyperledger-indy/indy-vdr/workflows/Unit%20Tests/badge.svg)](https://github.com/hyperledger-indy/indy-vdr/actions)
66
[![Python Package](https://img.shields.io/pypi/v/indy-vdr.svg)](https://pypi.org/project/indy-vdr/)
77

88
- [Introduction](#introduction)
@@ -16,7 +16,7 @@
1616

1717
## Introduction
1818

19-
This library is derived from [Hyperledger Indy SDK](https://github.com/hyperledger/indy-sdk) for the more limited use case of connecting to an [Indy Node](https://github.com/hyperledger/indy-node) blockchain ledger. It is written in Rust and currently includes a Python wrapper and a standalone proxy server.
19+
This library is derived from [Hyperledger Indy SDK](https://github.com/hyperledger-indy/indy-sdk) for the more limited use case of connecting to an [Indy Node](https://github.com/hyperledger-indy/indy-node) blockchain ledger. It is written in Rust and currently includes a Python wrapper and a standalone proxy server.
2020

2121
_This library is still in development and there are currently no standard release packages._
2222

@@ -90,7 +90,7 @@ Indy VDR contains a DID Resolver to resolve DIDs and dereference DID Urls to led
9090

9191
## Connecting to a Ledger
9292

93-
Whether using the library or the proxy server, you will need a `genesis.txn` file containing the set of pool genesis transactions. You can run a local pool in Docker using [VON-Network](https://github.com/bcgov/von-network) or follow the [Indy-SDK instructions](https://github.com/hyperledger/indy-sdk#how-to-start-local-nodes-pool-with-docker).
93+
Whether using the library or the proxy server, you will need a `genesis.txn` file containing the set of pool genesis transactions. You can run a local pool in Docker using [VON-Network](https://github.com/bcgov/von-network) or follow the [Indy-SDK instructions](https://github.com/hyperledger-indy/indy-sdk#how-to-start-local-nodes-pool-with-docker).
9494

9595
However the library is used, the `RUST_LOG` environment variable may be set in order to adjust the volume of logging messages produced. Acceptable values are `error`, `warn`, `info`, `debug`, and `trace`. The `RUST_BACKTRACE` environment variable may also be set to `full` for extended output in the case of fatal errors.
9696

@@ -108,4 +108,4 @@ The following environment variables can be used to configure indy-vdr behavior:
108108
- Join us on the Hyperledger Discord. Guidance at [chat.hyperledger.org](https://chat.hyperledger.org).
109109
- Developer certificate of origin (DCO) are required in all Hyperledger repositories,
110110
so to get your pull requests accepted, you must certify your commits by signing off on each commit.
111-
More information can be found in [Signing Commits](https://github.com/hyperledger/indy-sdk/docs/contributors/signing-commits.md) article.
111+
More information can be found in [Signing Commits](https://github.com/hyperledger-indy/indy-sdk/docs/contributors/signing-commits.md) article.

SECURITY.md

Lines changed: 167 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,172 @@
1-
# Hyperledger Security Policy
1+
# Hyperledger Indy Security Policy
22

3-
## Reporting a Security Bug
3+
[Hyperledger security vulnerability disclosure policy]: /governing-documents/security.md
44

5-
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.
5+
## About this document
66

7-
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).
7+
This document defines how security vulnerability reporting is handled in the
8+
Hyperledger Indy project. The approach aligns with the [Hyperledger
9+
Foundation's Security Vulnerability Reporting
10+
policy](https://toc.hyperledger.org/governing-documents/security.html). Please
11+
review that document to understand the basis of the security reporting for
12+
Hyperledger Indy.
813

9-
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”.
14+
The Hyperledger Security Vulnerability policy borrows heavily from the
15+
recommendations of the OpenSSF Vulnerability Disclosure working group. For
16+
up-to-date information on the latest recommendations related to vulnerability
17+
disclosures, please visit the [GitHub of that working
18+
group](https://github.com/ossf/wg-vulnerability-disclosures).
1019

11-
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).
20+
If you are already familiar with the security policies of Hyperledger Indy, and
21+
ready to report a vulnerability, please jump to [Report
22+
Intakes](#report-intakes).
23+
24+
## Outline
25+
26+
This document has the following sections:
27+
28+
- [Hyperledger Indy Security Policy](#hyperledger-indy-security-policy)
29+
- [About this document](#about-this-document)
30+
- [Outline](#outline)
31+
- [What Is a Vulnerability Disclosure Policy?](#what-is-a-vulnerability-disclosure-policy)
32+
- [Security Team](#security-team)
33+
- [Discussion Forums](#discussion-forums)
34+
- [Report Intakes](#report-intakes)
35+
- [CNA/CVE Reporting](#cnacve-reporting)
36+
- [Embargo List](#embargo-list)
37+
- [(GitHub) Security Advisories](#github-security-advisories)
38+
- [Private Patch Deployment Infrastructure](#private-patch-deployment-infrastructure)
39+
40+
## What Is a Vulnerability Disclosure Policy?
41+
42+
No piece of software is perfect. All software (at least, all software of a
43+
certain size and complexity) has bugs. In open source development, members of
44+
the community or the public find bugs and report them to the project. A
45+
vulnerability disclosure policy explains how this process functions from the
46+
perspective of the project.
47+
48+
This vulnerability disclosure policy explains the rules and guidelines for
49+
Hyperledger Indy. It is intended to act as both a reference for
50+
outsiders–including both bug reporters and those looking for information on the
51+
project's security practices–as well as a set of rules that maintainers and
52+
contributors have agreed to follow.
53+
54+
## Security Team
55+
56+
The current Hyperledger Indy security team is:
57+
58+
| Name | Email ID | Discord ID | Area/Specialty |
59+
| -------------- | --------------------------------- | ------------- | -------------------- |
60+
| Stephen Curran | swcurran@cloudcompass.ca | swcurran | |
61+
| Wade Barnes | wade@neoterictech.ca | WadeBarnes | Security, Operations |
62+
| Sam Curren | sam@indicio.tech | TelegramSam | Security |
63+
| Renata Toktar | renata.toktar@dsr-corporation.com | Renata.toktar | Security |
64+
65+
The security team for Hyperledger Indy must include at least three Indy
66+
Maintainers that agree to carry out the following duties and responsibilities.
67+
Members are added and removed from the team via approved Pull Requests to this
68+
repository. For additional background into the role of the security team, see
69+
the [People Infrastructure] section of the Hyperledger Security Policy.
70+
71+
[People Infrastructure]: https://toc.hyperledger.org/governing-documents/security.html#people-infrastructure
72+
73+
**Responsibilities:**
74+
75+
1. Acknowledge the receipt of vulnerability reports to the reporter within 2
76+
business days.
77+
78+
2. Assess the issue. Engage with the reporter to ask any outstanding questions
79+
about the report and how to reproduce it. If the report was received by email
80+
and may be a security vulnerability, open a GitHub Security Advisory on the
81+
repository to manage the report. If the report is not considered a
82+
vulnerability, then the reporter should be informed and this process can be
83+
halted. If the report is a regular bug (but not a security vulnerability), the
84+
reporter should be informed (if necessary) of the regular process for reporting
85+
issues.
86+
87+
1. Some issues may require more time and resources to correct. If a particular
88+
report is complex, discuss an embargo period with the reporter during which
89+
time the report will not be publicly disclosed. The embargo period should be
90+
negotiated with the reporter and must not be longer than 90 days.
91+
92+
1. If necessary, create a private patch development infrastructure for the issue
93+
by emailing the [Hyperledger Community Architects].
94+
95+
[Hyperledger Community Architects]: mailto:community-architects@hyperledger.org
96+
97+
5. Request a CVE for the issue (see the [CNA/CVE Reporting](#cnacve-reporting)
98+
section).
99+
100+
6. Decide a date for the public release of the vulnerability report, the date
101+
the embargo period ends.
102+
103+
7. If applicable, notify members of the embargo list of the vulnerability,
104+
upcoming patch and release, as described above.
105+
106+
8. Publish a new (software) release in which the vulnerability is addressed.
107+
108+
9. Publicly disclose the issue within 48 hours after the release via a
109+
GitHub security advisory (see the [(GitHub) Security
110+
Advisories](#github-security-advisories) section for details).
111+
112+
## Discussion Forums
113+
114+
Discussions about each reported vulnerability should be carried out in the
115+
private GitHub security advisory about the vulnerability. If necessary, a private
116+
channel specific to the issue may be created on the Hyperledger Discord server
117+
with invited participants added to the discussion.
118+
119+
## Report Intakes
120+
121+
Hyperledger Indy has the following ways to submit security
122+
vulnerabilities. While the security team members will do their best to
123+
respond to bugs disclosed in all possible ways, it is encouraged for bug
124+
finders to report through the following approved channels:
125+
126+
- Email the [Hyperledger Foundation security
127+
list](mailto:security@lists.hyperledger.org): To report a security issue, please
128+
send an email with the name of the project/repository, a description of the issue, the
129+
steps you took to create the issue, affected versions, and if known,
130+
mitigations. If in triaging the email, the security team determines the issue may be
131+
a security vulnerability, a [GitHub security vulnerability report] will be
132+
opened.
133+
- Open a [GitHub security vulnerability report]: Open a draft security advisory
134+
on the "Security" tab of this GitHub repository. See [GitHub Security
135+
Advisories](#github-security-advisories) to learn more about the security
136+
infrastructure in GitHub.
137+
138+
[GitHub security vulnerability report]: https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability
139+
140+
## CNA/CVE Reporting
141+
142+
Hyperledger Indy maintains a list of **Common Vulnerabilities and Exposures
143+
(CVE)** and uses GitHub as its **CVE numbering authority (CNA)** for issuing
144+
CVEs.
145+
146+
## Embargo List
147+
148+
Hyperledger Indy does **NOT** currently maintain a private embargo list.
149+
150+
If you wish to be added to the embargo list, please email the [Hyperledger
151+
Foundation security mailing list](mailto:security@lists.hyperledger.org),
152+
including the project name (Hyperledger Indy) and reason for being added
153+
to the embargo list. Requests will be assessed by the Hyperledger Indy
154+
security team in conjunction with the appropriate Hyperledger Staff, and a
155+
decision will be made to accommodate or not the request.
156+
157+
For more information about embargo lists, please see the [Embargo List section
158+
of the Hyperledger Security
159+
Policy](https://toc.hyperledger.org/governing-documents/security.html#embargo-list).
160+
161+
## (GitHub) Security Advisories
162+
163+
Hyperledger Indy uses GitHub Security Advisories to manage the public
164+
disclosure of security vulnerabilities.
165+
166+
## Private Patch Deployment Infrastructure
167+
168+
In creating patches and new releases that address security vulnerabilities,
169+
Hyperledger Indy **MAY** use the private development features of GitHub for
170+
security vulnerabilities. GitHub has [extensive
171+
documentation](https://docs.github.com/en/code-security/security-advisories/repository-security-advisories)
172+
about these features.

ci/indy-pool.dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FROM ghcr.io/hyperledger/indy-node-container/indy_node:1.13.2-ubuntu20-1.2.10
1+
FROM ghcr.io/hyperledger-indy/indy-node-container/indy_node:1.13.2-ubuntu20-1.2.10
22
RUN pip3 install "supervisor~=4.2"
33

44
RUN echo "[supervisord]\n\

libindy_vdr/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ edition = "2021"
99
rust-version = "1.85"
1010
license = "Apache-2.0"
1111
readme = "../README.md"
12-
repository = "https://github.com/hyperledger/indy-vdr/"
12+
repository = "https://github.com/hyperledger-indy/indy-vdr/"
1313
categories = ["authentication", "cryptography"]
1414
keywords = ["hyperledger", "indy", "ssi", "verifiable", "credentials"]
1515

libindy_vdr/tests/rich_schema.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -437,10 +437,10 @@ mod rs_chain {
437437
},
438438
"algorithm": {
439439
"description": "This encoding transforms an RFC3339 - formatted datetime object into the number of seconds since January 1, 1970(the Unix epoch).",
440-
"documentation": "https://github.com/hyperledger/indy-hipe/commit/3a39665fd384254f08316eef6230c2f411b8f765",
441-
"implementation": "https://github.com/hyperledger/indy-hipe/commit/3a39665fd384254f08316eef6230c2f411b8f869",
440+
"documentation": "https://github.com/hyperledger-indy/indy-hipe/commit/3a39665fd384254f08316eef6230c2f411b8f765",
441+
"implementation": "https://github.com/hyperledger-indy/indy-hipe/commit/3a39665fd384254f08316eef6230c2f411b8f869",
442442
},
443-
"testVectors": "https://github.com/hyperledger/indy-hipe/commit/3a39665fd384254f08316eef6230c2f411b8f766"
443+
"testVectors": "https://github.com/hyperledger-indy/indy-hipe/commit/3a39665fd384254f08316eef6230c2f411b8f766"
444444
});
445445
return RSContent(json_c.to_string());
446446
}

wrappers/golang/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=for-the-badge)](https://pkg.go.dev/github.com/hyperledger/indy-vdr/wrappers/golang/vdr)
1+
[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=for-the-badge)](https://pkg.go.dev/github.com/hyperledger-indy/indy-vdr/wrappers/golang/vdr)
22

33
# Run demo
44

wrappers/golang/cmd/demo/demo.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ import (
99
"net/http"
1010
"os"
1111

12-
"github.com/hyperledger/indy-vdr/wrappers/golang/crypto"
13-
"github.com/hyperledger/indy-vdr/wrappers/golang/identifiers"
14-
"github.com/hyperledger/indy-vdr/wrappers/golang/vdr"
12+
"github.com/hyperledger-indy/indy-vdr/wrappers/golang/crypto"
13+
"github.com/hyperledger-indy/indy-vdr/wrappers/golang/identifiers"
14+
"github.com/hyperledger-indy/indy-vdr/wrappers/golang/vdr"
1515
"github.com/mr-tron/base58"
1616
)
1717

wrappers/golang/go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module github.com/hyperledger/indy-vdr/wrappers/golang
1+
module github.com/hyperledger-indy/indy-vdr/wrappers/golang
22

33
go 1.16
44

wrappers/javascript/indy-vdr-nodejs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ docker exec $(docker ps -aqf "ancestor=test_pool") cat /var/lib/indy/sandbox/poo
5050
yarn test:local-build
5151
```
5252

53-
> **Note**: If you want to use this library in a cross-platform environment you need to import methods from the `@hyperledger/indy-vdr-shared` package instead. This is a platform independent package that allows to register the native bindings. The `@hyperledger/indy-vdr-nodejs` package uses this package under the hood. See the [Indy VDR Shared README](https://github.com/hyperledger/indy-vdr/tree/main/wrappers/javascript/indy-vdr-shared/README.md) for documentation on how to use this package.
53+
> **Note**: If you want to use this library in a cross-platform environment you need to import methods from the `@hyperledger/indy-vdr-shared` package instead. This is a platform independent package that allows to register the native bindings. The `@hyperledger/indy-vdr-nodejs` package uses this package under the hood. See the [Indy VDR Shared README](https://github.com/hyperledger-indy/indy-vdr/tree/main/wrappers/javascript/indy-vdr-shared/README.md) for documentation on how to use this package.
5454
5555
## Version Compatibility
5656

wrappers/javascript/indy-vdr-nodejs/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
"description": "Nodejs wrapper for Indy Vdr",
66
"source": "src/index",
77
"main": "build/index",
8-
"homepage": "https://github.com/hyperledger/indy-vdr/tree/main/wrappers/javascript/indy-vdr-nodejs",
8+
"homepage": "https://github.com/hyperledger-indy/indy-vdr/tree/main/wrappers/javascript/indy-vdr-nodejs",
99
"author": "Hyperledger (https://github.com/hyperledger)",
1010
"repository": {
1111
"type": "git",
12-
"url": "https://github.com/hyperledger/indy-vdr",
12+
"url": "https://github.com/hyperledger-indy/indy-vdr",
1313
"directory": "wrappers/javascript/indy-vdr-nodejs"
1414
},
1515
"publishConfig": {
@@ -51,7 +51,7 @@
5151
},
5252
"binary": {
5353
"version": "v0.4.4",
54-
"host": "https://github.com/hyperledger/indy-vdr/releases/download",
54+
"host": "https://github.com/hyperledger-indy/indy-vdr/releases/download",
5555
"packageName": "library-{platform}-{arch}.tar.gz"
5656
},
5757
"engines": {

0 commit comments

Comments
 (0)