You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+61-7Lines changed: 61 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,27 +11,81 @@ The Heka Identity Platform is intended to speed up adoption of decentralized ide
11
11
12
12
## Core Components
13
13
14
-
The Heka Identity Platform delivers a complete decentralized identity solution composed of two primary applications:
14
+
The platform is composed of the following components:
15
15
16
-
1.**Mobile Wallet (Verifiable Credentials Holder)**: A cross-platform mobile application (built with React Native) for end users to receive, store, and present verifiable credentials.
17
-
2.**Identity Service**: A backend service (built with NestJS) that primarily acts as a Verifiable Credentials Issuer and Verifier, while also supporting Holder capabilities for cloud (custodial) wallet scenarios.
16
+
-**[Heka Wallet](./heka-wallet)** (Verifiable Credentials Holder): Cross-platform mobile application (built with React Native) for end users to receive, store, and present verifiable credentials.
17
+
-**[Identity Service](./heka-identity-service)**: Backend service (built with NestJS) that primarily acts as a Verifiable Credentials Issuer and Verifier, while also supporting Holder capabilities for cloud (custodial) wallet scenarios.
18
+
-**[Identity Service Web UI](./heka-identity-service-web-ui)**: Web UI application for Identity Service — allows managing schemas, credential templates, and issuance / verification flows.
19
+
-**[Auth Service](./heka-auth-service)**: Authentication service used by the Identity Service for tenant and user authentication.
18
20
19
21
The implementation is based on the **DSR SSI Toolkit** and leverages well-established open-source frameworks: **OWF Credo** and **OWF Bifold**.
20
22
21
-
## Scope and Supported Standards
23
+
## High-level Architecture
24
+
25
+
```mermaid
26
+
flowchart LR
27
+
Wallet[Heka Wallet<br/>Holder]
28
+
WebUI[Identity Service Web UI<br/>Issuer / Verifier Client]
29
+
Auth[Auth Service]
30
+
IS[Identity Service<br/>Issuer / Verifier Wallet]
31
+
Hedera[(Hiero / Hedera Ledger)]
32
+
33
+
WebUI -->|login / register| Auth
34
+
WebUI -->|REST API + JWT| IS
35
+
Auth -.->|issues JWTs trusted by| IS
36
+
Wallet <-->|OID4VC / DIDComm| IS
37
+
IS -->|DIDs / AnonCreds Resources| Hedera
38
+
Wallet -->|DIDs and AnonCreds Resources resolution| Hedera
39
+
```
40
+
41
+
## Getting Started
42
+
43
+
Each component is set up and run independently. For specific setup and configuration steps, please refer to specific README files in component folders.
44
+
45
+
The recommended approach for exploring the platform is the following:
46
+
- Set up and get familiar with core functional components - [Identity Service](./heka-identity-service) and [Heka Wallet (Mobile application)](./heka-wallet)
47
+
- Explore the [Identity Service Web UI](./heka-identity-service-web-ui) and [Auth Service](./heka-auth-service) components. These are more general-purpose applications that still represent a crucial piece for complete experience and testing capabilities
48
+
- Once you get familiar with the baseline functionality of a platform, feel free to check out the [demo folder](./demo) to explore various decentralized identity use cases implemented with Heka Identity Platform
49
+
50
+
## Supported Identity Standards
22
51
23
52
The platform supports a wide range of global decentralized identity standards, including:
Apart from providing support for standard decentralized identity flows, the platform aims to enable use cases that emerge from synergy between identity and Agentic AI.
61
+
This includes (but is not limited to) VC-based trust models for AI agents and the Agentic Economy.
62
+
63
+
Initial supported use cases:
64
+
65
+
-**VC-based authorization for agents**: [OID4VP In-Task Authorization Extension for Agent2Agent (A2A) protocol](https://github.com/DSRCorporation/a2a-oid4vp-in-task-auth-extension/blob/main/v1/spec.md)
66
+
67
+
## Roadmap
68
+
69
+
See [roadmap](./ROADMAP.md) for the platform's planned scope and timeline — covering core maintenance, emerging protocol support, AI / agentic economy integrations, and other development directions.
28
70
29
71
## Demos
30
72
31
73
Please see the [demo folder](./demo) to explore demos showcasing various decentralized identity use cases implemented with Heka Identity Platform.
32
74
33
75
-[Agent-to-Agent (A2A) + OID4VP integration](./demo/a2a-oid4vp): A demo showcasing OID4VP-based authentication for AI agents leveraging Agent2Agent (A2A) protocol
34
76
77
+
Also, feel free to explore Heka-based demos available on YouTube:
78
+
79
+
-[Agent2Agent interactions with Just-In-Time authorization via OpenID for Verifiable Credentials](https://www.youtube.com/watch?v=3JgFZBGXXXI)
80
+
81
+
## Hiero Identity Community
82
+
83
+
For details and references on how to engage with the Hiero Identity community, please see [Hiero Identity Collaboration Hub repo](https://github.com/hiero-ledger/identity-collaboration-hub).
84
+
85
+
### LFDT mentorship program
86
+
87
+
Heka Identity Platform is a core component for an upcoming LFDT mentorship project - [Hiero Contributor Identity Verification Prototype](https://mentorship.lfx.linuxfoundation.org/project/64c64daa-ffdb-4871-82f5-01c1bdc7fecc/).
88
+
35
89
## Governance
36
90
37
91
The Heka Identity Platform operates under the governance of the **Hiero Technical Steering Committee (TSC)**, in alignment with existing Hiero project policies.
> **Note** The roadmap reflects the current development plan and is subject to change.
4
+
5
+
## Scope
6
+
7
+
- Core maintenance, platform updates and community support
8
+
- Adoption and support for emerging protocols and standards (keeping up with evolving industry)
9
+
- Foundational support for modern AI & agentic economy use cases and protocols (AP2 + x402, ERC-8004, etc.)
10
+
- Continued prototyping and integration of identity solutions in Hiero ecosystem (Contributor Identity Verification mentorship program, Hiero-specific identity features and cross-project integrations)
Copy file name to clipboardExpand all lines: demo/a2a-oid4vp/README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ The agent is configured to require the user to present a verifiable credential v
16
16
The following mapping applies for roles/parties described in [OID4VP In-Task Authentication extension spec](https://github.com/DSRCorporation/a2a-oid4vp-in-task-auth-extension/blob/main/v1/spec.md):
17
17
- A2A Client → [CLI client](src/cli.ts)
18
18
- A2A Server → [Demo Agent Server](src/agent/index.ts)
19
-
- OID4VP Wallet → [Heka Mobile Wallet](../../heka-wallet)
@@ -81,7 +81,7 @@ However, there are values that need to be manually set up:
81
81
82
82
Other supported values:
83
83
-`DEMO_AGENT_PORT` - Port to be used by the Demo Agent server, defaults to `10003`
84
-
-`CLI_CLIENT_PORT` - Port to be used by CLI Client inbound transport (DidComm inbound transport, used for Mobile Wallet invocation), defaults to `3010`
84
+
-`CLI_CLIENT_PORT` - Port to be used by CLI Client inbound transport (DIDComm inbound transport, used for Heka Wallet invocation), defaults to `3010`
85
85
-`IDENTITY_SERVICE_URL` - URL of local instance of Heka Identity Service, defaults to `http://localhost:3000`. Must be changed if host, port, or API prefix configuration of the instance differs from default values
86
86
-`IDENTITY_SERVICE_ACCESS_TOKEN` - Heka Identity Service API token, default value is a demo token with extremely long validity period. Must be changed if JWT configuration for Heka Identity Service instance was changed
87
87
@@ -168,7 +168,7 @@ In a second terminal, start the CLI Client:
168
168
yarn client
169
169
```
170
170
171
-
The CLI Client will start an inbound DidComm transport that will use port 3010 (can be changed using `CLI_CLIENT_PORT` env variable).
171
+
The CLI Client will start an inbound DIDComm transport that will use port 3010 (can be changed using `CLI_CLIENT_PORT` env variable).
172
172
173
173
### 7. Try out integration with the Agent
174
174
@@ -181,7 +181,7 @@ mechanics of leveraging Heka Identity Platform for Agent-to-Agent (A2A) protocol
181
181
it is critical to treat any agent operating outside of your direct control as a
182
182
potentially untrusted entity.
183
183
184
-
The demonstrated flow involves usage of OID4VP Response Mode `direct_post` that is vulnerable to Session Fixation attacks ([Ref](https://openid.net/specs/openid-4-verifiable-presentations-1_0.html#name-session-fixation)). Production deployments must provide an additonal security mechanism to prevent such attacks.
184
+
The demonstrated flow involves usage of OID4VP Response Mode `direct_post` that is vulnerable to Session Fixation attacks ([Ref](https://openid.net/specs/openid-4-verifiable-presentations-1_0.html#name-session-fixation)). Production deployments must provide an additional security mechanism to prevent such attacks.
185
185
186
186
All data received from an external agent—including but not limited to its AgentCard,
187
187
messages, artifacts, and task statuses—should be handled as untrusted input. For
0 commit comments