• Stars
    star
    373
  • Rank 114,600 (Top 3 %)
  • Language
    Python
  • License
    Apache License 2.0
  • Created over 5 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Hyperledger Aries Cloud Agent Python (ACA-Py) is a foundation for building decentralized identity applications and services running in non-mobile environments.

Hyperledger Aries Cloud Agent - Python

pypi releases codecov

An easy to use Aries agent for building SSI services using any language that supports sending/receiving HTTP requests.

Full access to an organized set of all of the ACA-Py documents is available at https://aca-py.org. Check it out! It's much easier to navigate then finding all the documentation here.

Overview

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) using DIDComm messaging and Hyperledger 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.

ACA-Py is built on the Aries concepts and features that make up Aries Interop Profile (AIP) 1.0, and most of the features in AIP 2.0. ACA-Py’s supported Aries protocols include, most importantly, protocols for issuing, verifying, and holding verifiable credentials using both Hyperledger AnonCreds verifiable credential format, and the W3C Standard Verifiable Credential format using JSON-LD with LD-Signatures and BBS+ Signatures.

To use ACA-Py you create a business logic controller that "talks to" ACA-Py (sending HTTP requests and receiving webhook notifications), and ACA-Py handles the Aries and DIDComm functionality. That controller can be built in any language that supports making and receiving HTTP requests; knowledge of Python is not needed. Together, this means you can focus on building VC solutions using familiar web development technologies, instead of having to learn the nuts and bolts of low-level cryptography and Trust over IP-type Aries protocols.

This checklist-style overview document provides a full list of the features in ACA-Py. The following is a list of some of the core features needed for a production deployment, with a link to detailed information about the capability.

Multi-Tenant

ACA-Py supports "multi-tenant" scenarios. In these scenarios, one (scalable) instance of ACA-Py uses one database instance, and are together capable of managing separate secure storage (for private keys, DIDs, credentials, etc.) for many different actors. This enables (for example) an "issuer-as-a-service", where an enterprise may have many VC issuers, each with different identifiers, using the same instance of ACA-Py to interact with VC holders as required. Likewise, an ACA-Py instance could be a "cloud wallet" for many holders (e.g. people or organizations) that, for whatever reason, cannot use a mobile device for a wallet. Learn more about multi-tenant deployments here.

Mediator Service

Startup options allow the use of an ACA-Py as an Aries mediator 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 from Indicio Technologies. Learn more about deploying a mediator here. See the Aries Mediator Service for a "best practices" configuration of an Aries mediator.

Indy Transaction Endorsing

ACA-Py supports a Transaction Endorsement protocol, for agents that don't have write access to an Indy ledger. Endorser support is documented here.

Scaled Deployments

ACA-Py supports deployments in scaled environments such as in Kubernetes environments where ACA-Py and its storage components can be horizontally scaled as needed to handle the load.

Example Uses

The business logic you use with ACA-Py is limited only by your imagination. Possible applications include:

  • An interface to a legacy system to issue verifiable credentials
  • An authentication service based on the presentation of verifiable credential proofs
  • An enterprise wallet to hold and present verifiable credentials about that enterprise
  • A user interface for a person to use a wallet not stored on a mobile device
  • An application embedded in an IoT device, capable of issuing verifiable credentials about collected data
  • A persistent connection to other agents that enables secure messaging and notifications
  • Custom code to implement a new service.

Getting Started

For those new to SSI, Aries and ACA-Py, there are a couple of Linux Foundation edX courses that provide a good starting point.

The latter is the most useful for developers wanting to get a solid basis in using ACA-Py and other Aries Frameworks.

Also included here is a much more concise (but less maintained) Getting Started Guide that will take you from knowing next to nothing about decentralized identity to developing Aries-based business apps and services. You’ll run some Indy apps, ACA-Py apps and developer-oriented demos. The guide has a table of contents so you can skip the parts you already know.

Understanding the Architecture

There is an architectural deep dive webinar presented by the ACA-Py team, and slides from the webinar are also available. The picture below gives a quick overview of the architecture, showing an instance of ACA-Py, a controller and the interfaces between the controller and ACA-Py, and the external paths to other agents and public ledgers on the Internet.

drawing

You can extend Aca-Py using plug-ins, which can be loaded at runtime. Plug-ins are mentioned in the webinar and are described in more detail here.

Installation and Usage

An "install and go" page for developers is available if you are comfortable with Trust over IP and Aries concepts. ACA-Py can be run with Docker without installation (highly recommended), or can be installed from PyPi. In the /demo directory there is a full set of demos for developers to use in getting started, and the demo read me is a great starting point for developers to use an "in-browser" approach to run a zero-install example. The Read the Docs overview is also a way to reference the modules and APIs that make up an ACA-Py instance.

If you would like to develop on ACA-Py locally note that we use Poetry for dependency management and packaging, if you are unfamiliar with poetry please see our cheat sheet

About the ACA-Py Admin API

The overview of ACA-Py’s API is a great starting place for learning about the ACA-Py API when you are starting to build your own controller.

An ACA-Py instance puts together an OpenAPI-documented REST interface based on the protocols that are loaded. This is used by a controller application (written in any language) to manage the behaviour of the agent. The controller can initiate actions (e.g. issuing a credential) and can respond to agent events (e.g. sending a presentation request after a connection is accepted). Agent events are delivered to the controller as webhooks to a configured URL.

Technical note: the administrative API exposed by the agent for the controller to use must be protected with an API key (using the --admin-api-key command line arg) or deliberately left unsecured using the --admin-insecure-mode command line arg. The latter should not be used other than in development if the API is not otherwise secured.

Troubleshooting

There are a number of resources for getting help with ACA-Py and troubleshooting any problems you might run into. The Troubleshooting document contains some guidance about issues that have been experienced in the past. Feel free to submit PRs to supplement the troubleshooting document! Searching the ACA-Py GitHub issues will often uncover challenges that others have experienced, often with answers to solving those challenges. As well, there is the "aries-cloudagent-python" channel on the Hyperledger Discord chat server (invitation here).

Credit

The initial implementation of ACA-Py was developed by the Government of British Columbia’s Digital Trust Team in Canada. To learn more about what’s happening with decentralized identity and digital trust in British Columbia, checkout the BC Digital Trust website.

See the MAINTAINERS.md file for a list of the current ACA-Py maintainers, and the guidelines for becoming a Maintainer. We'd love to have you join the team if you are willing and able to carry out the duties of a Maintainer.

Contributing

Pull requests are welcome! Please read our contributions guide and submit your PRs. We enforce developer certificate of origin (DCO) commit signing — guidance on this is available. We also welcome issues submitted about problems you encounter in using ACA-Py.

License

Apache License Version 2.0

More Repositories

1

fabric

Hyperledger Fabric is an enterprise-grade permissioned distributed ledger framework for developing solutions and applications. Its modular and versatile design satisfies a broad range of industry use cases. It offers a unique approach to consensus that enables performance at scale while preserving privacy.
Go
14,808
star
2

hyperledger

Hyperledger is a Collaborative Project at The Linux Foundation.
3,702
star
3

fabric-samples

Samples for Hyperledger Fabric
Go
2,611
star
4

besu

An enterprise-grade Java-based, Apache 2.0 licensed Ethereum client https://wiki.hyperledger.org/display/besu
Java
1,314
star
5

solang

Solidity Compiler for Solana and Polkadot
Rust
1,180
star
6

fabric-sdk-java

Java
1,098
star
7

fabric-sdk-go

Go
885
star
8

cello

Operating System for Enterprise Blockchain
Python
850
star
9

fabric-sdk-node

Hyperledger Fabric SDK for Node https://wiki.hyperledger.org/display/fabric
JavaScript
777
star
10

indy-node

The server portion of a distributed ledger purpose-built for decentralized identity.
Python
647
star
11

caliper

A blockchain benchmark framework to measure performance of multiple blockchain solutions https://wiki.hyperledger.org/display/caliper
JavaScript
605
star
12

fabric-ca

Go
426
star
13

firefly

Hyperledger FireFly is the first open source Supernode: a complete stack for enterprises to build and scale secure Web3 applications. The FireFly API for digital assets, data flows, and blockchain transactions makes it radically faster to build production-ready apps on popular chains and protocols.
Go
423
star
14

iroha

Iroha - A simple, enterprise-grade decentralized ledger
C++
395
star
15

fabric-sdk-py

Hyperledger Fabric Python SDK
Python
394
star
16

bevel

An automation framework for rapidly and consistently deploying production-ready DLT platforms
Smarty
317
star
17

aries-rfcs

Hyperledger Aries is infrastructure for blockchain-rooted, peer-to-peer interactions
Python
311
star
18

fabric-chaincode-java

Hyperledger Fabric Contract and Chaincode implementation for Java https://wiki.hyperledger.org/display/fabric
Java
290
star
19

cacti

Hyperledger Cacti is a new approach to the blockchain interoperability problem
TypeScript
289
star
20

aries

Hyperledger Aries is infrastructure for blockchain-rooted, peer-to-peer interactions
257
star
21

bevel-operator-fabric

Hyperledger Fabric Kubernetes operator - Hyperledger Fabric operator for Kubernetes (v2.3, v2.4 and v2.5)
Go
239
star
22

fabric-chaincode-node

Hyperledger Fabric Node.js Smart Contracts
JavaScript
229
star
23

indy-plenum

Plenum Byzantine Fault Tolerant Protocol
Python
209
star
24

aries-framework-javascript

Aries Framework JavaScript (Built using TypeScript)
TypeScript
208
star
25

fabric-gateway-java

Hyperledger Fabric Gateway SDK for Java https://wiki.hyperledger.org/display/fabric
Java
201
star
26

fabric-contract-api-go

Packages for the implementation of the contract API for use in Go chaincode
Go
192
star
27

fabric-test

A collection of utilities used to test the core Hyperledger Fabric projects
Go
150
star
28

fabric-private-chaincode

FPC enables Confidential Chaincode Execution for Hyperledger Fabric using Intel SGX.
Go
147
star
29

fabric-chaincode-go

Hyperledger Fabric Packages for Go Chaincode
Go
130
star
30

aries-mobile-agent-react-native

Aries Mobile Agent React Native - Part of the Aries Bifold effort to provide SSI capabilities in a production ready app.
TypeScript
125
star
31

fabric-gateway

Go, Node and Java client API for Hyperledger Fabric v2.4+
Java
121
star
32

iroha-python

Python library for Hyperledger Iroha, a simple distributed ledger.
Python
104
star
33

caliper-benchmarks

Sample benchmark files for Hyperledger Caliper https://wiki.hyperledger.org/display/caliper
JavaScript
96
star
34

iroha-javascript

JavaScript library for Iroha, a Distributed Ledger Technology (blockchain) platform.
JavaScript
93
star
35

iroha-ios

iOS Swift library for Iroha, a simple distributed ledger
Objective-C
91
star
36

fabric-docs-i18n

Hyperledger Fabric is an enterprise-grade permissioned distributed ledger framework for developing solutions and applications. Its modular and versatile design satisfies a broad range of industry use cases. It offers a unique approach to consensus that enables performance at scale while preserving privacy.
Makefile
85
star
37

firefly-ethconnect

Ethereum connectivity bridge for Web Services & async Messaging APIs - familiar to Enterprise Apps
Go
72
star
38

indy-hipe

Hyperledger Indy Project Enhancements
TeX
71
star
39

web3j-evm

A library for running an embedded Ethereum EVM in-process on a JVM
Kotlin
61
star
40

aries-vcx

aries-vcx is set of crates to work with DIDs, DID Documents, DIDComm, Verifiable Credentials and Hyperledger Aries.
Rust
61
star
41

besu-docs

Documentation for Hyperledger Besu enterprise-grade Java-based, Apache 2.0 licensed Ethereum client https://wiki.hyperledger.org/display/besu
CSS
56
star
42

aries-agent-test-harness

Aries agent test framework, with agent backchannel support
Python
56
star
43

anoncreds-rs

anoncreds-rs
Rust
53
star
44

web3j-cli

Command-line interface for web3j
Java
53
star
45

aries-askar

Secure storage designed for Hyperledger Aries agents.
Rust
49
star
46

firefly-cli

FireFly Command Line Interface (CLI)
Go
47
star
47

indy-vdr

A library and proxy server for interacting with Hyperledger Indy Node ledger instances
Rust
47
star
48

aries-acapy-controllers

Web controllers for the Aries Cloud Agent - Python (ACA-Py)
HTML
44
star
49

fabric-protos-go

Generated Go bindings for fabric-protos
Go
44
star
50

anoncreds-spec

The specification for AnonCreds verifiable credential exchange.
CSS
39
star
51

fabric-protos

Makefile
38
star
52

web3j-docs

Web3j documentation repository.
35
star
53

firefly-ui

FireFly UI
TypeScript
31
star
54

toc

Hyperledger TOC documents
29
star
55

firefly-fabconnect

REST API to interact with a Fabric network and event streaming via websocket
Go
29
star
56

aries-mediator-service

HTML
29
star
57

fabric-rfcs

RFC process for Hyperledger Fabric. The RFC (request for comments) process is intended to provide a consistent and controlled path for major changes to Fabric and other official project components. https://wiki.hyperledger.org/display/fabric
29
star
58

iroha-java

Kotlin
28
star
59

iroha-ed25519

RFC8032 compatible Ed25519 implementation with pluggable hash (sha2-512, sha3-512)
Assembly
28
star
60

aries-framework-javascript-ext

Extension libraries for Aries Framework JavaScript
TypeScript
25
star
61

fabric-config

Hyperledger Fabric Packages for channel configuration transactions. Documentation at https://pkg.go.dev/github.com/hyperledger/fabric-config/configtx.
Go
24
star
62

web3j-unit

Smart contract testing framework via integrated EVM and various Ethereum clients
Kotlin
22
star
63

firefly-tokens-erc1155

ERC1155 token integration
TypeScript
21
star
64

aries-staticagent-python

Aries Static Agent library for Python
Python
20
star
65

firefly-transaction-manager

Blockchain transaction manager for Hyperledger FireFly. Integrates public blockchains through a pluggable FireFly Connector API framework. Extensible policy engine for managing gas & resubmission. Confirmation manager for managing finality on both transactions and event streams.
Go
20
star
66

fabric-cli

Go
19
star
67

indy-node-container

Providing Containers to run Indy Node
Shell
19
star
68

fabric-admin-sdk

Fabric SDK for Admin Capability services
Go
19
star
69

firefly-samples

Samples for FireFly
TypeScript
18
star
70

firefly-tokens-erc20-erc721

ERC20 and ERC721 token integration
TypeScript
18
star
71

indy-did-method

Indy DID Method Specification
CSS
17
star
72

indy-node-monitor

Python
14
star
73

firefly-helm-charts

Firefly Helm Charts
Smarty
14
star
74

aries-framework-swift

A Swift framework for Aries.
Swift
14
star
75

aries-javascript-docs

A documentation site for the Aries JavaScript ecosystem.
TypeScript
13
star
76

indy-shared-rs

Shared Rust data types and utility functions for Hyperledger Indy.
Rust
13
star
77

firefly-evmconnect

Firefly EVM Connect
Go
12
star
78

firefly-sdk-nodejs

FireFly SDK for Node.js
TypeScript
11
star
79

anoncreds-v2-rs

Anonymous Credential Exchange 2.0
Rust
11
star
80

firefly-sandbox

Hyperledger FireFly Sandbox
TypeScript
10
star
81

firefly-dataexchange-https

TypeScript
10
star
82

aries-mobile-test-harness

An acceptance test framework for testing mobile Aries wallets utilizing Python, Behave, Appium, and a mobile device cloud service.
Python
10
star
83

besu-native

Java
8
star
84

indy-test-automation

Automation tools for testing of Indy Project components.
Python
8
star
85

aries-socketdock

Websocket Relay Service for use with clustered Mediators
Python
8
star
86

anoncreds-tex

anoncreds
TeX
7
star
87

anoncreds-spec-v2

CSS
7
star
88

firefly-signer

Signing, Keystore, ABI and RLP encoding utilities for EVM / Ethereum / secp256k1 based blockchains. Written in Go with an enterprise friendly Apache 2.0 license, and a runtime JSON/RPC proxy server. Part of the Hyperledger FireFly project
Go
7
star
89

aries-framework-kotlin

aries-framework-kotlin
Kotlin
6
star
90

firefly-cordaconnect

Java
6
star
91

iroha-2-docs

TypeScript
6
star
92

hyperledger.github.io

HTML
6
star
93

hyperledger-hip

Hyperledger Improvement Proposal (HIP)
6
star
94

aries-acapy-tools

Hyperledger Aries
Python
6
star
95

firefly-fir

5
star
96

indy-did-networks

indy-did-networks
5
star
97

governance

5
star
98

aries-endorser-service

endorser-service
Python
5
star
99

fabric-amcl

Go
4
star
100

anoncreds-revocation

JavaScript
4
star