Business Partner Agent Save Abandoned
The Business Partner Agent is a SSI wallet and controller based on aries cloud agent python.
Business Partner Agent 
Looking for Maintainer
The current maintainers stop active contribution to the further development of the Hyperledger Labs project Business Partner Agent, as well as the related project Business Partner Agent Helm Chart. To give existing users of the Business Partner Agent enough lead time, we are willing to continue maintaining the project for now. For more information see the Hyperledger Discord channel.
We are looking for a new maintainer, if you are interested please contact us via Hyperledger Discord in the business-partner-agent channel.
Short Description
The BPA allows organizations to verify, hold, and issue verifiable credentials.
The Business Partner Agent is built on top of the Hyperledger Self-Sovereign Identity Stack, in particular Hyperledger Indy and Hyperledger Cloud Agent Python.
Most Important Features
- Attach a public organizational profile to your public DID (either did:indy/sov or did:web)
- Add business partners by their public DIDs or via invitations and view their public profiles
- Business partners can be other cloud agents or smartphone wallets
- Basic chat functionality to interact with business partners
- Add documents based on Indy schemas and request verifications from business partners
- Issue verifiable credentials (indy/w3c) to your business partners
- Create templates for presentation requests supporting zero knowledge proofs (selective disclosure and predicate proofs)
- Send and respond to presentation requests (indy/w3c)
Features in Detail
| Role/Feature | Flow | Protocol Version |
|---|---|---|
| Issuer | ||
| auto: issue credential | indy: v1, v2 w3c: v2 |
|
| manual: send credential offer to holder | indy: v1, v2 w3c: v2 |
|
| manual: receive credential proposal from holder | indy: v1, v2 w3c: v2 |
|
| manual: decline credential proposal from holder and provide reason | indy: v1, v2 w3c: v2 |
|
| send credential offer as invitation attachment | indy: v1, v2 | |
| revoke issued credential (requires tails server) | indy: v1, v2 w3c: n/a |
|
| send revocation notification | indy: v1, v2 w3c: n/a |
|
| Holder | ||
| auto: receive credential | indy: v1, v2 w3c: v2 |
|
| manual: send credential proposal to issuer (based on document) | indy: v1, v2 w3c: v2 |
|
| manual: receive credential offer from issuer | indy: v1, v2 w3c: v2 |
|
| manual: decline credential offer from issuer | indy: v1, v2 w3c: v2 |
|
| scheduled revocation check on all received credentials | indy: v1, v2 w3c: n/a |
|
| receive revocation notification | indy: v1, v2 w3c: n/a |
|
| Prover | ||
| auto: send presentation to verifier | indy: v1, v2 w3c: v2 |
|
| auto: answer presentation request | indy: v1, v2 w3c: v2 |
|
| manual: accept/decline presentation request and provide reason | indy: v1, v2 w3c: v2 |
|
| Verifier | ||
| auto: request presentation from prover based on proof template | indy: v1, v2 w3c: v2 |
|
| auto: receive and verify presentation from prover | indy: v1, v2 w3c: v2 |
|
| send presentation request as invitation attachment (backend only) | indy: v1, v2 w3c: v2 |
|
| Proof-Template | ||
| prepared presentation request templates for indy and w3c presentation exchanges | ||
| query by: schema attributes. restrict by: attribute value, predicates (<, >, <=, >=), schema, and issuer did | indy | |
| query by: schema attributes. restrict by: attribute value, schema, and issuer did | w3c | |
| Connection | ||
| connect by did:sov, did:web (if endpoint is aca-py) | did-exchange | |
| receive invitation by URL | connection-protocol, OOB | |
| create invitation (barcode or URL) | connection-protocol, OOB | |
| auto: accept incoming connection | did-exchange, connection-protocol | |
| manual: accept incoming connection | did-exchange, connection-protocol | |
| optional: scheduled trust ping to check connection status | n/a | |
| tag a connection, e.g. as trusted issuer | n/a | |
| Ledger | ||
| send schema to the ledger (requires endorser role) | n/a | |
| create a credential definition on the ledger (requires endorser role) | n/a | |
| Basic Message | ||
| send and receive basic messages via chat window | n/a | |
| Tasks/Activities | ||
| list of tasks that need attention, and list of past activities | n/a | |
| TAA | ||
| if ledger is configured with a TAA, show it and give option to accept | n/a | |
| Read Only Ledger | ||
| if mode is set to web only | n/a | |
| Public Profile | ||
| web accessible (self signed) imprint based on (indy/w3c) credentials or documents | n/a |
Upcoming Features
- Business rules to automate processes
- Endorser support (both as endorser and transaction author)
- Multi-user and roles support
Project Status
A first alpha version of Business Partner Agent is available, see Helm Chart and Docker images It is not ready for production use. Releases are in general considered "alpha", which means API may change at any time, and we do not have explicit / planned system tests (See also Publishing).
Getting Started
The Business Partner Agent supports two modes
- Web mode: Serves a did:web identity and allows to publish a public organizational profile.
- Indy mode: Utilizes an identity on an Hyperledger Indy ledger (default: http://test.bcovrin.vonx.io/)
Both modes are currently coupled with a specific instance of an Indy network in order to read schemas and credential definitions. The agent is started in Indy mode per default and tries to connect with our test network. Please refer to the .env-example file to start the agent in web mode or connect to a different Indy network.
Run a business partner agent with docker-compose or helm
You can run the agent via docker-compose (recommended for e.g. development / debugging) or deploy it into a kubernetes cluster (via helm).
Documentation and Tutorials
User documentation is located at https://hyperledger-labs.github.io/business-partner-agent
Learn how to contribute in Contributing. You can also start by filing an issue.
Regarding release process, we do not follow a strict process yet, nevertheless we follow the guidelines described in Publishing.
Learn what aries protocols can be controlled by the BPA in aca-py-args
Business Partner Agent in Action
- COP26 Presented by BC Goverment and OpenEarth Foundation
- Use Case and Technical Demonstration Playlist
Hyperledger Labs Sponsor
- https://github.com/swcurran Co-Chair of the Aries Working Group
Credits
See Credits
License
Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the LICENSE file. Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/.
Open Source Agenda Badge
