https://github.com/fedi-e2ee/pkd-client-php

PHP Client for the Public Key Directory
https://github.com/fedi-e2ee/pkd-client-php

client-side fediverse library php public-key-directory

Last synced: about 1 month ago
JSON representation

PHP Client for the Public Key Directory

• Host: GitHub
• URL: https://github.com/fedi-e2ee/pkd-client-php
• Owner: fedi-e2ee
• License: isc
• Created: 2025-10-18T00:13:29.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2026-02-13T02:19:09.000Z (about 1 month ago)
• Last Synced: 2026-02-13T06:32:45.102Z (about 1 month ago)
• Topics: client-side, fediverse, library, php, public-key-directory
• Language: PHP
• Homepage: https://publickey.directory
• Size: 235 KB
• Stars: 8
• Watchers: 0
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Fediverse Public Key Directory PHP Client

[![CI](https://github.com/fedi-e2ee/pkd-client-php/actions/workflows/ci.yml/badge.svg)](https://github.com/fedi-e2ee/pkd-client-php/actions/workflows/ci.yml)

[![Psalm](https://github.com/fedi-e2ee/pkd-client-php/actions/workflows/psalm.yml/badge.svg)](https://github.com/fedi-e2ee/pkd-client-php/actions/workflows/psalm.yml)

[![PHPStan](https://github.com/fedi-e2ee/pkd-client-php/actions/workflows/phpstan.yml/badge.svg)](https://github.com/fedi-e2ee/pkd-client-php/actions/workflows/phpstan.yml)

[![Fuzzing](https://github.com/fedi-e2ee/pkd-client-php/actions/workflows/fuzz.yml/badge.svg)](https://github.com/fedi-e2ee/pkd-client-php/actions/workflows/fuzz.yml)

[![Mutation](https://github.com/fedi-e2ee/pkd-client-php/actions/workflows/infection.yml/badge.svg)](https://github.com/fedi-e2ee/pkd-client-php/actions/workflows/infection.yml)

[![Integration Tests](https://github.com/fedi-e2ee/pkd-client-php/actions/workflows/integration.yml/badge.svg)](https://github.com/fedi-e2ee/pkd-client-php/actions/workflows/integration.yml)

[![Semgrep](https://github.com/fedi-e2ee/pkd-client-php/actions/workflows/semgrep.yml/badge.svg)](https://github.com/fedi-e2ee/pkd-client-php/actions/workflows/semgrep.yml)

This is an implementation of the client-side component of the

[Public Key Directory specification](https://github.com/fedi-e2ee/public-key-directory-specification), written in PHP.

See [`fedi-e2ee/pkd-server-php`](https://github.com/fedi-e2ee/pkd-server-php) for the reference implementation of the

server-side component written in PHP.

## Installation

```terminal

composer require fedi-e2ee/pkd-client

```

## Usage

```php

fetchPublicKeys('soatok@furry.engineer');

var_dump($publicKeys); // array

// Fetch auxiliary data with Merkle proof verification (recommended)

// 'age' is an alias for the latest version; i.e., 'age-v1'.

$auxData = $client->fetchAuxData('soatok@furry.engineer', 'age');

var_dump($auxData); // array

```

### Verified Methods (Recommended)

The `fetch*()` methods verify Merkle inclusion proofs, ensuring each key or auxiliary data item is properly committed to

the PKD's append-only Merkle tree:

* `fetchPublicKeys(string $actor)` → `VerifiedPublicKey[]`

* `fetchAuxData(string $actor, string $auxDataType)` → `VerifiedAuxData[]`

These methods throw `ClientException` if proof verification fails.

### Unverified Methods (For Troubleshooting Only)

> [!WARNING]

> These APIs do not validate Merkle inclusion proofs. Use with caution!

If you need to fetch public keys or auxiliary data without verifying the Merkle inclusion proofs, these methods are 

available too:

* `fetchUnverifiedPublicKeys(string $actor)` → `PublicKey[]`

* `fetchUnverifiedAuxData(string $actor, string $auxDataType)` → `AuxData[]`

### Hash Function Validation

The verified methods accept an optional `$hashFunc` parameter (default: `'sha256'`). Only cryptographically secure hash

functions are accepted: `sha256`, `sha384`, `sha512`, and `blake2b`.

Attempting to use any other hash function will throw a `ClientException`.