Skip to content
This repository was archived by the owner on Jan 13, 2025. It is now read-only.

Commit d6f99c6

Browse files
authored
Merge pull request #125 from swcurran/0.12.2rc1
0.12.2rc1
2 parents 789b2e3 + 74a019b commit d6f99c6

31 files changed

+131
-108
lines changed

docs/CHANGELOG.md

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,28 @@
11
# Aries Cloud Agent Python Changelog
22

3+
## 0.12.2rc1
4+
5+
A patch release to add the verification of a linkage between an inbound message and its associated connection (if any) before processing the message. Also adds some additional cleanup/fix PRs from the main branch (see list below) that might be useful for deployments currently using [Release 0.12.1](#0121).
6+
7+
### 0.12.2rc1 Breaking Changes
8+
9+
There are no breaking changes in this release.
10+
11+
#### 0.12.2rc1 Categorized List of Pull Requests
12+
13+
- Dependency update and release PR
14+
- Patch release 0.12.x [\#3121](https://github.com/hyperledger/aries-cloudagent-python/pull/3121) [jamshale](https://github.com/jamshale)
15+
- Release management pull requests
16+
- 0.12.2rc1 [\#3123](https://github.com/hyperledger/aries-cloudagent-python/pull/3123) [swcurran](https://github.com/swcurran)
17+
- PRs cherry-picked into [\#3121](https://github.com/hyperledger/aries-cloudagent-python/pull/3120) from the `main` branch:
18+
- Check connection is ready in all connection required handlers [\#3095](https://github.com/hyperledger/aries-cloudagent-python/pull/3095) [jamshale](https://github.com/jamshale)
19+
- fix: multiuse invites with did peer 4 [\#3112](https://github.com/hyperledger/aries-cloudagent-python/pull/3112) [dbluhm](https://github.com/dbluhm)
20+
- fix: respond to did:peer:1 with did:peer:4 [\#3050](https://github.com/hyperledger/aries-cloudagent-python/pull/3050) [dbluhm](https://github.com/dbluhm)
21+
- feat: soft binding for plugin flexibility [\#3010](https://github.com/hyperledger/aries-cloudagent-python/pull/3010) [dbluhm](https://github.com/dbluhm)
22+
- feat: inject profile and session [\#2997](https://github.com/hyperledger/aries-cloudagent-python/pull/2997) [dbluhm](https://github.com/dbluhm)
23+
- feat: external signature suite provider interface [\#2835](https://github.com/hyperledger/aries-cloudagent-python/pull/2835) [dbluhm](https://github.com/dbluhm)
24+
- fix(interop): overly strict validation [\#2943](https://github.com/hyperledger/aries-cloudagent-python/pull/2943) [dbluhm](https://github.com/dbluhm)
25+
326
## 0.12.1
427

528
### April 26, 2024
@@ -64,7 +87,7 @@ Much progress has been made on `did:peer` support in this release, with the hand
6487

6588
[Qualified DIDs]: https://aca-py.org/latest/features/QualifiedDIDs/
6689
[Credo-TS]: https://github.com/openwallet-foundation/credo-ts
67-
[Aries Interop Profile v2.0]: https://github.com/hyperledger/aries-rfcs/tree/0.12.1/concepts/0302-aries-interop-profile#aries-interop-profile-version-20
90+
[Aries Interop Profile v2.0]: https://github.com/hyperledger/aries-rfcs/tree/0.12.2rc1/concepts/0302-aries-interop-profile#aries-interop-profile-version-20
6891

6992
Work continues towards supporting ledger agnostic [AnonCreds], and the new [Hyperledger AnonCreds Rust] library. Some of that work is in this release, the rest will be in the next release.
7093

@@ -937,9 +960,9 @@ those published to the [Hyperledger Package Repository under
937960
aries-cloudagent-python].
938961

939962
[Hyperledger Package Repository under aries-cloudagent-python]: https://github.com/orgs/hyperledger/packages?repo_name=aries-cloudagent-python
940-
[publish.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.1/.github/workflows/publish.yml
941-
[publish-indy.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.1/.github/workflows/publish-indy.yml
942-
[Container Images and Github Actions]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.1/ContainerImagesAndGithubActions.md
963+
[publish.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.2rc1/.github/workflows/publish.yml
964+
[publish-indy.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.2rc1/.github/workflows/publish-indy.yml
965+
[Container Images and Github Actions]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.2rc1/ContainerImagesAndGithubActions.md
943966

944967
### Breaking Changes and Upgrades
945968

@@ -953,7 +976,7 @@ case is that an ACA-Py instance publishes a public DID on a ledger with a
953976
DIDComm `service` in the DIDDoc. Other agents resolve that DID, and attempt to
954977
establish a connection with the ACA-Py instance using the `service` endpoint.
955978
This is called an "implicit" connection in [RFC 0023 DID
956-
Exchange](https://github.com/hyperledger/aries-rfcs/blob/0.12.1/features/0023-did-exchange/README.md).
979+
Exchange](https://github.com/hyperledger/aries-rfcs/blob/0.12.2rc1/features/0023-did-exchange/README.md).
957980

958981
#### PR [\#1913](https://github.com/hyperledger/aries-cloudagent-python/pull/1913) -- Unrevealed attributes in presentations
959982

@@ -1399,7 +1422,7 @@ However, anyone else using an external queue should be aware of the impact of th
13991422
included in the release.
14001423

14011424
For those that have an existing deployment of ACA-Py with long-lasting connection records, an upgrade is needed to use
1402-
[RFC 434 Out of Band](https://github.com/hyperledger/aries-rfcs/tree/0.12.1/features/0434-outofband) and the "reuse connection" as the invitee. In PR #1453
1425+
[RFC 434 Out of Band](https://github.com/hyperledger/aries-rfcs/tree/0.12.2rc1/features/0434-outofband) and the "reuse connection" as the invitee. In PR #1453
14031426
(details below) a performance improvement was made when finding a connection for reuse. The new approach
14041427
(adding a tag to the connection to enable searching) applies only to connections made using this ACA-Py
14051428
release and later, and "as-is" connections made using earlier releases of ACA-Py will not be found as reuse

docs/PUBLISHING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ Once you have the list of PRs:
128128

129129
9. Immediately after it is merged, create a new GitHub tag representing the
130130
version. The tag name and title of the release should be the same as the
131-
version in [pyproject.toml](https://github.com/hyperledger/aries-cloudagent-python/tree/0.12.1/pyproject.toml). Use
131+
version in [pyproject.toml](https://github.com/hyperledger/aries-cloudagent-python/tree/0.12.2rc1/pyproject.toml). Use
132132
the "Generate Release Notes" capability to get a sequential listing of the
133133
PRs in the release, to complement the manually curated Changelog. Verify on
134134
PyPi that the version is published.
@@ -144,8 +144,8 @@ Once you have the list of PRs:
144144
Additional information about the container image publication process can be
145145
found in the document [Container Images and Github Actions](./deploying/ContainerImagesAndGithubActions.md).
146146

147-
[publish.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.1/.github/workflows/publish.yml
148-
[publish-indy.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.1/.github/workflows/publish-indy.yml
147+
[publish.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.2rc1/.github/workflows/publish.yml
148+
[publish-indy.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.2rc1/.github/workflows/publish-indy.yml
149149

150150
11. Update the ACA-Py Read The Docs site by building the new "latest" (main
151151
branch) and activating and building the new release. Appropriate permissions

docs/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Check it out! It's much easier to navigate than this GitHub repo for reading the
1212

1313
## Overview
1414

15-
Hyperledger Aries Cloud Agent Python (ACA-Py) is a foundation for building Verifiable Credential (VC) ecosystems. It operates in the second and third layers of the [Trust Over IP framework (PDF)](https://trustoverip.org/wp-content/uploads/2020/05/toip_050520_primer.pdf) using [DIDComm messaging](https://github.com/hyperledger/aries-rfcs/tree/0.12.1/concepts/0005-didcomm) and [Hyperledger Aries](https://www.hyperledger.org/use/aries) protocols. The "cloud" in the name means that ACA-Py runs on servers (cloud, enterprise, IoT devices, and so forth), and is not designed to run on mobile devices.
15+
Hyperledger Aries Cloud Agent Python (ACA-Py) is a foundation for building Verifiable Credential (VC) ecosystems. It operates in the second and third layers of the [Trust Over IP framework (PDF)](https://trustoverip.org/wp-content/uploads/2020/05/toip_050520_primer.pdf) using [DIDComm messaging](https://github.com/hyperledger/aries-rfcs/tree/0.12.2rc1/concepts/0005-didcomm) and [Hyperledger Aries](https://www.hyperledger.org/use/aries) protocols. The "cloud" in the name means that ACA-Py runs on servers (cloud, enterprise, IoT devices, and so forth), and is not designed to run on mobile devices.
1616

17-
ACA-Py is built on the Aries concepts and features that make up [Aries Interop Profile (AIP) 2.0](https://github.com/hyperledger/aries-rfcs/tree/0.12.1/concepts/0302-aries-interop-profile#aries-interop-profile-version-20). [ACA-Py’s supported Aries protocols](./features/SupportedRFCs.md) include, most importantly, protocols for issuing, verifying, and holding verifiable credentials using both [Hyperledger AnonCreds] verifiable credential format, and the [W3C Standard Verifiable Credential Data Model] format using JSON-LD with LD-Signatures and BBS+ Signatures. Coming soon -- issuing and presenting [Hyperledger AnonCreds] verifiable credentials using the [W3C Standard Verifiable Credential Data Model] format.
17+
ACA-Py is built on the Aries concepts and features that make up [Aries Interop Profile (AIP) 2.0](https://github.com/hyperledger/aries-rfcs/tree/0.12.2rc1/concepts/0302-aries-interop-profile#aries-interop-profile-version-20). [ACA-Py’s supported Aries protocols](./features/SupportedRFCs.md) include, most importantly, protocols for issuing, verifying, and holding verifiable credentials using both [Hyperledger AnonCreds] verifiable credential format, and the [W3C Standard Verifiable Credential Data Model] format using JSON-LD with LD-Signatures and BBS+ Signatures. Coming soon -- issuing and presenting [Hyperledger AnonCreds] verifiable credentials using the [W3C Standard Verifiable Credential Data Model] format.
1818

1919
[Hyperledger AnonCreds]: https://www.hyperledger.org/use/anoncreds
2020
[W3C Standard Verifiable Credential Data Model]: https://www.w3.org/TR/vc-data-model/
@@ -30,7 +30,7 @@ ACA-Py supports "multi-tenant" scenarios. In these scenarios, one (scalable) ins
3030

3131
### Mediator Service
3232

33-
Startup options allow the use of an ACA-Py as an Aries [mediator](https://github.com/hyperledger/aries-rfcs/tree/0.12.1/concepts/0046-mediators-and-relays#summary) using core Aries protocols to coordinate its mediation role. Such an ACA-Py instance receives, stores and forwards messages to Aries agents that (for example) lack an addressable endpoint on the Internet such as a mobile wallet. A live instance of a public mediator based on ACA-Py is available [here](https://indicio-tech.github.io/mediator/) from Indicio Technologies. Learn more about deploying a mediator [here](./features/Mediation.md). See the [Aries Mediator Service](https://github.com/hyperledger/aries-mediator-service) for a "best practices" configuration of an Aries mediator.
33+
Startup options allow the use of an ACA-Py as an Aries [mediator](https://github.com/hyperledger/aries-rfcs/tree/0.12.2rc1/concepts/0046-mediators-and-relays#summary) using core Aries protocols to coordinate its mediation role. Such an ACA-Py instance receives, stores and forwards messages to Aries agents that (for example) lack an addressable endpoint on the Internet such as a mobile wallet. A live instance of a public mediator based on ACA-Py is available [here](https://indicio-tech.github.io/mediator/) from Indicio Technologies. Learn more about deploying a mediator [here](./features/Mediation.md). See the [Aries Mediator Service](https://github.com/hyperledger/aries-mediator-service) for a "best practices" configuration of an Aries mediator.
3434

3535
### Indy Transaction Endorsing
3636

docs/aca-py.org.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ In addition to this documentation site, the ACA-Py community also maintains an
1818
ACA-Py internals documentation site. The internals documentation consists of the
1919
`docstrings` extracted from the ACA-Py Python code and covers all of the
2020
(non-test) modules in the codebase. Check it out on the [Aries Cloud
21-
Agent-Python ReadTheDocs site](https://aries-cloud-agent-python.readthedocs.io/en/0.12.1).
21+
Agent-Python ReadTheDocs site](https://aries-cloud-agent-python.readthedocs.io/en/0.12.2rc1).
2222
As with this site, the ReadTheDocs documentation is version specific.
2323

2424
Got questions?

docs/demo/Aries-Workshop.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,4 +266,4 @@ yourself, with your Sandbox tenant. Once you review the code, you should have an
266266
excellent idea of how you can add these same capabilities to your line of
267267
business application.
268268

269-
[Traction Issuance Demo]: https://github.com/hyperledger/aries-acapy-controllers/tree/0.12.1/TractionIssuanceDemo
269+
[Traction Issuance Demo]: https://github.com/hyperledger/aries-acapy-controllers/tree/0.12.2rc1/TractionIssuanceDemo

docs/demo/AriesPostmanDemo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Create a new postman workspace labeled "acapy-demo".
3232

3333
### Importing the environment
3434

35-
In the environment tab from the left, click the import button. You can paste this [link](https://raw.githubusercontent.com/hyperledger/aries-cloudagent-python/main/demo/postman/environment.json) which is the [environment file](https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.1/demo/postman/environment.json) in the ACA-Py repository.
35+
In the environment tab from the left, click the import button. You can paste this [link](https://raw.githubusercontent.com/hyperledger/aries-cloudagent-python/main/demo/postman/environment.json) which is the [environment file](https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.2rc1/demo/postman/environment.json) in the ACA-Py repository.
3636

3737
Make sure you have the environment set as your active environment.
3838

docs/demo/Endorser.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This approach runs Faber as an un-privileged agent, and starts a dedicated Endor
88

99
Start a VON Network instance and a Tails server:
1010

11-
- Following the [Building and Starting](https://github.com/bcgov/von-network/blob/0.12.1/docs/UsingVONNetwork.md#building-and-starting) section of the VON Network Tutorial to get ledger started. You can leave off the `--logs` option if you want to use the same terminal for running both VON Network and the Tails server. When you are finished with VON Network, follow the [Stopping And Removing a VON Network](https://github.com/bcgov/von-network/blob/main/docs/UsingVONNetwork.md#stopping-and-removing-a-von-network) instructions.
11+
- Following the [Building and Starting](https://github.com/bcgov/von-network/blob/0.12.2rc1/docs/UsingVONNetwork.md#building-and-starting) section of the VON Network Tutorial to get ledger started. You can leave off the `--logs` option if you want to use the same terminal for running both VON Network and the Tails server. When you are finished with VON Network, follow the [Stopping And Removing a VON Network](https://github.com/bcgov/von-network/blob/main/docs/UsingVONNetwork.md#stopping-and-removing-a-von-network) instructions.
1212
- Run an AnonCreds revocation registry tails server in order to support revocation by following the instructions in the [Alice gets a Phone](https://github.com/hyperledger/aries-cloudagent-python/blob/master/demo/AliceGetsAPhone.md#run-an-instance-of-indy-tails-server) demo.
1313

1414
Start up Faber as Author (note the tails file size override, to allow testing of the revocation registry roll-over):

0 commit comments

Comments
 (0)