Metadata-Version: 2.4
Name: agentaddress
Version: 0.10.0
Summary: Reference Python implementation of the Agent Address Protocol (AAP).
Project-URL: Homepage, https://agentaddress.org
Project-URL: Source, https://github.com/agentaddress/aap-python
Author: Chris Evans
License: Copyright 2026 Chris Evans
        
                                         Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
License-File: LICENSE
Keywords: aap,agent,agents,did,didcomm,ed25519
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.11
Requires-Dist: cryptography<49,>=42
Requires-Dist: httpx>=0.27
Requires-Dist: jsonschema>=4.20
Requires-Dist: pycryptodome<4,>=3.23
Requires-Dist: rfc8785>=0.1
Provides-Extra: dev
Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
Requires-Dist: pytest>=8; extra == 'dev'
Requires-Dist: respx>=0.21; extra == 'dev'
Requires-Dist: ruff>=0.5; extra == 'dev'
Description-Content-Type: text/markdown

# agentaddress

Reference Python implementation of the [Agent Address Protocol](https://agentaddress.org).

For a complete, runnable example of using this SDK inside a real agent host, see
[aap-hermes](https://github.com/agentaddress/aap-hermes) — an open-source host
implementation built on top of `agentaddress`.

## Install

```bash
pip install agentaddress
```

## Quick example

```python
from aap import (
    Address,
    AgentCard,
    Envelope,
    generate_encryption_keypair,
    generate_keypair,
    encode_b64url,
)

# Generate an identity.
private_seed, public_key = generate_keypair()
encryption_private_key, encryption_public_key = generate_encryption_keypair()

# Build and sign an Agent Card envelope.
card = AgentCard(
    address="chris^chrisevans.id",
    did="did:web:chrisevans.id#agent",
    public_key=encode_b64url(public_key),
    encryption_key=encode_b64url(encryption_public_key),
    endpoints=[{"type": "didcomm", "uri": "https://api.agentaddress.org"}],
)

envelope = Envelope(
    type="aap.envelope/v1",
    payload_type=AgentCard.PAYLOAD_TYPE,
    payload=card.to_dict(),
    iss="did:web:chrisevans.id#agent",
    iat="2026-05-19T12:00:00Z",
).sign(private_seed)

# Verify on the other end.
assert envelope.verify(public_key)
```

## Resolving an address

```python
from aap import AAPClient, load_or_generate

identity = load_or_generate()
client = AAPClient(
    relay_url="https://api.agentaddress.org",
    seed=identity.private_seed,
    public_key=identity.public_key,
    encryption_private_key=identity.encryption_private_key,
    address=identity.address,
)

card = await client.resolve_agent_card("chris^chrisevans.id")
peer_signing_key = await client.resolve_peer("chris^chrisevans.id")
```

`AAPClient.resolve_agent_card()` performs authenticated AgentCard resolution:
it checks the card belongs to the requested address, requires the envelope
issuer to equal that address, verifies the envelope with the card's
`public_key`, confirms the card's `did:web` domain matches the address domain,
and pins the address key to detect unexpected rotation.

## Scope

v0.7.0 promotes `aap` from a reference protocol codec to a full agent SDK.
In addition to the v0.1-v0.6 envelope codec, address format, payload types,
and resolution primitives, the SDK now includes:

- **Relay HTTP client** (`aap.client.AAPClient`) — register your agent,
  send end-to-end encrypted signed envelopes, poll for inbound, resolve peer
  AgentCards.
- **Wire-format helpers** (`aap.messages`) — build and unwrap the
  `aap.message/v1` chat payload + the `aap.routing-envelope/v1` outer.
- **End-to-end encryption** (`aap.encryption`) — RFC 9180 HPKE base mode using
  X25519, HKDF-SHA256, and ChaCha20-Poly1305. The relay sees the signed outer
  route needed to authenticate and meter the sender, but not the encrypted
  inner envelope or its payload.
- **Verifier flows** (`aap.verifier_client`, `aap.verifiers`,
  `aap.discovery`) — verifier OTP, trust-list cache, per-verifier pubkey
  resolution from signed trust lists, signed verifier start/confirm responses,
  signed discovery queries, and signed discovery query responses.
- **Service catalog** (`aap.services`) — fetch + cache published
  signed `/.well-known/aap-services` catalogs, verify them against the
  business agent key, validate payloads against `input_schema`, build signed
  request/response envelopes.
- **Relationships, group flow, followups** (`aap.relationships`,
  `aap.group_flow`, `aap.service_followups`) — envelope builders for the
  relationship handshake, group-conversation primitives, and
  business-initiated recurring outreach. Relationship records are persisted
  only through verified proposal/accept handshakes; callers provide the signed
  envelopes and authenticated participant keys, and the store derives the row.
  Relationship revocations likewise require a signed revoke envelope and are
  persisted as revocation proofs before the active row is removed.
- **Group conversations** (`aap.conversations`) — local membership is the
  authorization source for group chat, so receivers should commit group-state
  events through `ConversationStore.accept_invitation()`,
  `apply_membership_update()`, `apply_leave()`, and `apply_complete()`. These
  methods verify signed envelopes, enforce current-convener authority, validate
  membership diffs and convener handoff, and persist event nonces/proofs to
  reject replay.
- **Persistent state stores** (`aap.stores`) — all the JSON-backed stores
  that an agent needs (attestations, pending proposals/responses/consents,
  identity bindings, outbound contacts, pending verifications,
  pending introductions, service-request groups, etc.). Each takes a
  `base_dir: Path` on construction so hosts choose their own filesystem
  layout.

The earlier scope notes (v0.1-v0.6) describe how the codec grew. Host
plugins like [aap-hermes](https://github.com/agentaddress/aap-hermes) build
on top of this SDK to integrate with their respective agent runtimes.

OPRF discovery, revocation, SD-JWT, and the contact-proof primitive come in
subsequent releases.

## Encryption model

Each AgentCard advertises a separate X25519 `encryption_key`. Before relay
submission, the SDK encrypts the complete signed `aap.envelope/v1` into an
`aap.encrypted-envelope/v1`. Recipients decrypt first, then verify the original
Ed25519 signature.

The relay can still see the sender address, recipient address, and delivery
timing. HPKE protects message confidentiality and integrity, but this
asynchronous single-message design does not provide forward secrecy after
compromise of a recipient's long-term X25519 private key. TLS remains required
for transport security and metadata protection from passive network observers.

## Transport security

Configurable relay, verifier, and trusted-verifier-list URLs must use HTTPS.
For local development only, the SDK accepts HTTP URLs whose host is loopback,
including `localhost`, `127.0.0.0/8`, and `::1`. Other HTTP URLs fail before
any network request is attempted.

## Local State

SDK-managed JSON state files are written atomically with file mode `0600`.
This covers identity material, replay caches, verifier/trust caches,
attestations, relationships, conversations, service request ledgers, and
pending consent/verification state. Host-owned files remain the host's
responsibility.

## AgentCard authentication

`AAPClient` accepts an AgentCard only when:

- its envelope issuer exactly matches the requested AAP address;
- the card address exactly matches the requested AAP address;
- the card's `did:web` domain belongs to the requested AAP address domain; and
- the envelope signature verifies with the card's advertised Ed25519 `public_key`.

AgentCard signing keys are pinned by address on first use. Pass
`agent_card_key_pins_path` to `AAPClient` for persistent pins. A changed key
fails closed; call `forget_agent_card_key_pin()` only after independently
confirming an intentional key rotation.

AgentCard envelopes must also pass timestamp freshness checks. By default, the
SDK rejects cards issued more than 30 days ago or more than five minutes in the
future.

## Verified Identity Badges

Trusted verifier lists are signed `aap.trusted-verifiers/v1` envelopes issued by
`aap-trust-root^agentaddress.org`. `TrustListCache` requires the
trust-root Ed25519 public key and rejects unsigned, wrongly signed, stale, or
wrong-issuer lists. Each verifier entry carries the verifier's Ed25519
`public_key`, so `VerifierPubkeyCache` resolves keys from the signed list rather
than fetching mutable key JSON from verifier-hosted endpoints.

Verifier OTP helpers also require the selected verifier domain and public key.
`start_sms_verification()` / `start_email_verification()` accept only signed
`aap.verify-start-response/v1` envelopes from `verifier^<domain>` whose
`request_nonce` matches the signed start request. `confirm_sms_verification()` /
`confirm_email_verification()` send signed confirm requests, accept only signed
`aap.verify-confirm-response/v1` wrappers, and verify the returned
`VerificationAttestation` envelope before returning it.

Discovery identity summaries are rendered only from verifier-signed
attestations. `extract_searcher_identities()` requires the current trusted
verifier entries plus verifier public keys, and ignores attached attestations
that are untrusted, expired, signed by the wrong key, or for a different
subject address.

## Inbound Receive Policy

Hosts should run relay-delivered messages through `validate_inbound_envelope()`
before payload dispatch. It decrypts encrypted envelopes, verifies the sender
signature, enforces timestamp freshness, and can attach a replay cache.
`validate_inbound_chat()` adds the chat-specific relationship gate for simpler
hosts: by default, encrypted chat is accepted only from active `friend` or
`admin` relationships.

## Outbound Raw Envelopes

`AAPClient.send_envelope_raw()` is for protocol events that are not plain chat,
such as relationship, group, service, and follow-up envelopes. Before encrypting
or posting, the SDK verifies that the pre-built envelope is signed by the client
identity, has `iss == client.address`, and carries a fresh `iat` timestamp.
Invalid raw envelopes fail locally instead of being sent to the relay.

## Follow-Up Grants

Follow-up grants are signed permission slips for business-initiated reminders.
`FollowupGrantStore.record_issued()` and `record_received()` require the
counterparty public key and store a grant only when the signature verifies, the
envelope issuer matches the counterparty address, the timestamp is fresh, and
the grant nonce has not been stored before.

## Service Responses

Service catalogs are published as signed `aap.service-catalog/v1` envelopes.
`ServiceCatalogCache` requires an authenticated public-key resolver, usually
`AAPClient.resolve_peer`, and accepts a catalog only when the envelope issuer
matches the catalog agent, the agent belongs to the requested domain, the
signature verifies, and the catalog timestamp is fresh.

`ServiceResponse` payloads include their own nonce in addition to the original
request nonce. `ServiceRequestStore` records signed outbound requests and
accepts a response only when it is signed by the expected business, references a
pending request, matches the requested service id, and uses a fresh response
nonce.

## SDK example: send a chat message

```python
import asyncio
from pathlib import Path
from aap.client import AAPClient
from aap.identity import load_or_generate

async def main():
    identity = load_or_generate(
        identity_path=Path("~/.my-agent/aap.json").expanduser(),
        env_seed_b64=None,
        address="alice^example.com",
    )
    client = AAPClient(
        relay_url="https://relay.example.com",
        seed=identity.private_seed,
        public_key=identity.public_key,
        encryption_private_key=identity.encryption_private_key,
        encryption_public_key=identity.encryption_public_key,
        address=identity.address,
        agent_card_key_pins_path=Path("~/.my-agent/aap-agent-card-key-pins.json").expanduser(),
    )
    try:
        await client.register()
        await client.send_envelope(to="bob^example.com", text="hello")
    finally:
        await client.close()

asyncio.run(main())
```

## License

Apache 2.0.
