Skip to content

Commit bf593f8

Browse files
committed
chore: a2a sample (v0.0.1)
1 parent e32e67a commit bf593f8

24 files changed

+4065
-0
lines changed

examples/a2a/.dockerignore

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Ignore Python cache
2+
__pycache__/
3+
*.pyc
4+
5+
# Ignore Git files
6+
.git/
7+
.gitignore
8+
9+
# Ignore local env files
10+
.env
11+
*.env
12+
13+
# Ignore IDE/editor folders
14+
.vscode/
15+
.idea/
16+
17+
# Ignore Docker related leftovers
18+
docker-compose.override.yml
19+
20+
# Ignore OpenAPI in Docker build context if needed
21+
!hr_agent/openapi.yaml

examples/a2a/.env.example

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Google Cloud
2+
GOOGLE_API_KEY=
3+
4+
# HR (Staff0)
5+
HR_AUTH0_DOMAIN=
6+
7+
HR_AGENT_AUTH0_AUDIENCE=https://staff0/agent
8+
HR_API_AUTH0_AUDIENCE=https://staff0/
9+
10+
HR_AGENT_BASE_URL=http://localhost:8080
11+
HR_API_BASE_URL=http://hr-api:8081
12+
13+
# HR AGENT to HR API client (auth method: CIBA)
14+
HR_AGENT_AUTH0_CLIENT_ID=
15+
HR_AGENT_AUTH0_CLIENT_SECRET=
16+
17+
# BANK AGENT to HR AGENT client (auth method: Client Credentials)
18+
BANK_AGENT_AUTH0_CLIENT_ID=
19+
BANK_AGENT_AUTH0_CLIENT_ASSERTION_SIGNING_KEY_PATH=./certs/bank_agent_private_key.pem
20+
21+
# Bank
22+
BANK_AGENT_BASE_URL=http://bank-agent:5000
23+
BANK_AGENT_BENEFICIARY_COMPANIES=STAFF0
24+
25+
# Optional
26+
HR_AGENT_PORT=8080
27+
HR_API_PORT=8081
28+
BANK_AGENT_PORT=5000
29+
FLASK_ENV=development

examples/a2a/LICENSE

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

examples/a2a/Makefile

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# ====================
2+
# Load environment variables from .env
3+
# ====================
4+
5+
include .env
6+
export $(shell sed 's/=.*//' .env)
7+
8+
# ====================
9+
# Config Variables
10+
# ====================
11+
12+
ENV_FILE=.env
13+
14+
# ====================
15+
# HR Agent Variables
16+
# ====================
17+
18+
HR_AGENT_IMAGE_NAME=hr-agent
19+
HR_AGENT_DOCKERFILE=hr_agent/Dockerfile
20+
21+
# ====================
22+
# HR API Variables
23+
# ====================
24+
25+
HR_API_IMAGE_NAME=hr-api
26+
HR_API_DOCKERFILE=hr_api/Dockerfile
27+
28+
# ====================
29+
# Local Docker HR Agent
30+
# ====================
31+
32+
build-hr-agent:
33+
docker build -t $(HR_AGENT_IMAGE_NAME) -f $(HR_AGENT_DOCKERFILE) .
34+
35+
run-hr-agent:
36+
docker run --env-file $(ENV_FILE) -p $(HR_AGENT_PORT):$(HR_AGENT_PORT) $(HR_AGENT_IMAGE_NAME)
37+
38+
rebuild-run-hr-agent: build-hr-agent run-hr-agent
39+
40+
# ====================
41+
# Local Docker HR API
42+
# ====================
43+
44+
build-hr-api:
45+
docker build -t $(HR_API_IMAGE_NAME) -f $(HR_API_DOCKERFILE) .
46+
47+
run-hr-api:
48+
docker run --env-file $(ENV_FILE) -p $(HR_API_PORT):$(HR_API_PORT) $(HR_API_IMAGE_NAME)
49+
50+
rebuild-run-hr-api: build-hr-api run-hr-api
51+
52+
# ====================
53+
# Local All
54+
# ====================
55+
run:
56+
@{ \
57+
docker-compose up --build & \
58+
poetry run adk web & \
59+
wait; \
60+
}

examples/a2a/README.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Auth0 + Google A2A & ADK sample
2+
3+
## Getting Started
4+
5+
### Prerequisites
6+
7+
1. Get a [Gemini API key](https://ai.google.dev/gemini-api/docs/api-key).
8+
2. Configure your Auth0 tenant with the following:
9+
10+
- APIs
11+
- HR API
12+
- Audience: `https://staff0/`
13+
- Permissions: `read:employee`
14+
- HR Agent
15+
- Audience: `https://staff0/agent`
16+
- Applications
17+
- Bank Agent
18+
- Grant Types: `Client Credentials`
19+
- Credentials: `Private Key JWT`
20+
- APIs: `HR Agent`
21+
- HR Agent
22+
- Grant Types: `Client Credentials`, `Client Initiated Backchannel Authentication (CIBA)`
23+
- APIs: `Auth0 Management API` (enabled permissions: `read:users`), `HR API` (enabled permissions: `read:employee`)
24+
- Push Notifications using [Auth0 Guardian](https://auth0.com/docs/secure/multi-factor-authentication/auth0-guardian) must be `enabled`.
25+
- A test user enrolled in Guardian MFA.
26+
27+
3. Install [Poetry](https://python-poetry.org/)
28+
29+
```shell
30+
pipx install poetry
31+
```
32+
33+
4. Install [Google ADK](https://google.github.io/adk-docs/)
34+
35+
```shell
36+
pipx install google-adk
37+
```
38+
39+
5. Install [Docker](https://docs.docker.com/engine/install/)
40+
41+
### Setup
42+
43+
Copy the `.env.example` file to `.env` and fill in the required variables.
44+
45+
### How to run it
46+
47+
1. **Install Dependencies**
48+
49+
```shell
50+
poetry install
51+
```
52+
53+
2. **Run HR Agent, HR API and Bank Agent**
54+
55+
```shell
56+
make run
57+
```
58+
59+
3. **Open the Bank Agent Chatbot by navigating to [http://localhost:8000/dev-ui?app=bank_agent](http://localhost:8000/dev-ui?app=bank_agent)**
60+
61+
## How it works
62+
63+
```mermaid
64+
sequenceDiagram
65+
participant User as User
66+
participant BankAgent as Bank Agent
67+
participant Auth0 as Auth0 (staff0.auth0.com)
68+
participant Staff0_HR_Agent as Staff0 HR Agent
69+
participant Staff0_HR_API as Staff0 HR API
70+
71+
User->>BankAgent: I want to open an account
72+
BankAgent->>User: Please provide your employment details
73+
User->>BankAgent: I work at Staff0
74+
BankAgent->>User: You may be eligible for extra benefits, let me verify your employment...
75+
BankAgent->>Staff0_HR_Agent: Get A2A Agent Card
76+
Staff0_HR_Agent-->>BankAgent: Agent Card
77+
BankAgent->>Auth0: Request access token (client credentials)
78+
Auth0-->>BankAgent: Access Token
79+
BankAgent->>Staff0_HR_Agent: Verify employment details (Access Token)
80+
Staff0_HR_Agent->>Auth0: Request access token (CIBA)
81+
Auth0->>User: Push notification to approve access
82+
User-->>Auth0: Approves access
83+
Auth0-->>Staff0_HR_Agent: Access Token
84+
Staff0_HR_Agent->>Staff0_HR_API: Retrieve employment details (Access Token)
85+
Staff0_HR_API-->>Staff0_HR_Agent: Employment details
86+
Staff0_HR_Agent-->>BankAgent: Verification result
87+
BankAgent->>User: You are eligible for extra benefits
88+
```
89+
90+
---
91+
92+
<p align="center">
93+
<picture>
94+
<source media="(prefers-color-scheme: light)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_light_mode.png" width="150">
95+
<source media="(prefers-color-scheme: dark)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_dark_mode.png" width="150">
96+
<img alt="Auth0 Logo" src="https://cdn.auth0.com/website/sdks/logos/auth0_light_mode.png" width="150">
97+
</picture>
98+
</p>
99+
<p align="center">Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout <a href="https://auth0.com/why-auth0">Why Auth0?</a></p>
100+
<p align="center">
101+
This project is licensed under the Apache 2.0 license. See the <a href="/LICENSE"> LICENSE</a> file for more info.</p>

examples/a2a/adk.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[project]
2+
pyproject_path = "./pyproject.toml"
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
from .agent import root_agent
2+
3+
__all__ = ["root_agent"]

0 commit comments

Comments
 (0)