Secure one-time secret sharing with zero-knowledge encryption
Project description
zephr
Zero-knowledge one-time secret sharing for AI agents and the humans who orchestrate them. Python SDK for Zephr.
Create a one-time secret link: encrypted on your device and self-destructing after a single retrieval. Pass it between agents, services, and pipelines with no shared infrastructure and no plaintext on the server.
Designed for zero-knowledge secret handoff between independent systems: AI agents, CI/CD pipelines, GitHub Actions, and human operators.
How it works
- A 256-bit key is generated locally. It never reaches Zephr's servers.
- Your secret is encrypted with AES-GCM on your device
- Only the ciphertext is uploaded to Zephr
- The link embeds the key in the URL fragment, which browsers never transmit to servers
- First retrieval atomically consumes the record. A second request returns 410.
Features
- No shared infrastructure: a link is the entire transport mechanism between independent processes
- Zero-knowledge: the server never receives your plaintext or encryption keys
- Local encryption: AES-GCM-256 on your device before any network call
- One-time access: record marked consumed atomically on first retrieval
- Minimal dependencies: only
cryptography(audited, widely trusted) - Anonymous use: no account required, rate-limited per IP
- API key support for higher limits and longer expiry
Installation
pip install zephr
Usage
Create a secret
import zephr
result = zephr.create_secret("my-api-key-12345")
print(result["full_link"])
# https://zephr.io/secret/abc123#v1.key...
The secret is encrypted exactly as provided. No trimming or normalization. Strings that are empty or contain only whitespace raise ValidationError.
Agent A encrypts and hands off the link. Agent B retrieves it exactly once:
# Agent A: encrypt and dispatch
result = zephr.create_secret("sk-live-abc123", expiry_hours=1)
agent_b.dispatch({"credential": result["full_link"]})
# Agent B: consumed atomically on first read
secret = zephr.retrieve_secret(result["full_link"])
Retrieve a secret
import zephr
# Full URL string
secret = zephr.retrieve_secret("https://zephr.io/secret/abc123#v1.key...")
# Split mode
secret = zephr.retrieve_secret({"url": "https://zephr.io/secret/abc123", "key": "v1.key..."})
Retrieval is exactly-once. The server permanently destroys the record on first access.
Options
# Expire in 1 hour
result = zephr.create_secret("secret", expiry_hours=1)
# Expire in 7 days
result = zephr.create_secret("secret", expiry_hours=168)
# Expire in 30 days (Dev/Pro)
result = zephr.create_secret("secret", expiry_hours=720, api_key="zeph_...")
# Split URL and key for separate transmission
result = zephr.create_secret("secret", split=True)
print(result["url"]) # https://zephr.io/secret/abc123
print(result["key"]) # v1.key...
Return value
create_secret() returns a dict.
Standard mode:
{
"mode": "standard",
"full_link": "https://zephr.io/secret/abc123#v1.key...",
"expires_at": "2026-03-12T12:00:00.000Z",
"secret_id": "abc123...", # 22-char base64url ID
}
Split mode:
{
"mode": "split",
"url": "https://zephr.io/secret/abc123",
"key": "v1.key...",
"expires_at": "2026-03-12T12:00:00.000Z",
"secret_id": "abc123...", # 22-char base64url ID
}
retrieve_secret() returns the decrypted secret as a string.
Authentication
The SDK works without an account. No setup required. Free, Dev, and Pro tier features require an API key. Pass it via the api_key parameter. Anonymous requests are capped at 3/day per IP with a 1 h max expiry.
| Tier | Create limit | Max expiry | Max size | Authentication |
|---|---|---|---|---|
| Anonymous | 3/day | 1 h | 6 KB | None |
| Free | 50/month | 7 days | 20 KB | api_key="zeph_..." |
| Dev ($15/mo) | 2,000/month | 30 days | 200 KB | api_key="zeph_..." |
| Pro ($39/mo) | 50,000/month | 30 days | 1 MB | api_key="zeph_..." |
Getting an API key: Log in at zephr.io/account, open the API Keys tab, and create a key. The raw key is shown exactly once. Copy it immediately.
Passing the key:
import os
import zephr
# Via parameter
result = zephr.create_secret("secret", api_key="zeph_...")
# Via environment variable: preferred for CI and scripts
# export ZEPHR_API_KEY=zeph_...
result = zephr.create_secret("secret", api_key=os.environ.get("ZEPHR_API_KEY"))
GitHub Actions: Add ZEPHR_API_KEY as a repository secret, then pass it to your script:
steps:
- run: python share_secret.py
env:
ZEPHR_API_KEY: ${{ secrets.ZEPHR_API_KEY }}
# share_secret.py
import os, zephr
result = zephr.create_secret(
os.environ["MY_SECRET"],
expiry_hours=1,
api_key=os.environ.get("ZEPHR_API_KEY"),
)
print(result["full_link"])
The key is sent as Authorization: Bearer zeph_... on each request. An invalid or revoked key returns HTTP 401.
Error handling
import zephr
try:
result = zephr.create_secret("my secret")
except zephr.ValidationError:
# Invalid input: empty or whitespace-only string, too long, bad expiry_hours
pass
except zephr.ApiError as e:
# Server returned an error
print(e.status_code) # e.g. 429, 401, 403
print(e.code) # e.g. "MONTHLY_LIMIT_EXCEEDED"
except zephr.NetworkError:
# Connection failed or timed out
pass
Common ApiError codes:
| Code | Status | Meaning |
|---|---|---|
INVALID_API_KEY |
401 | Key not found or revoked |
UPGRADE_REQUIRED |
403 | Feature requires a higher tier (e.g. expiry > 1h without an account, or 720h without Dev/Pro) |
ANON_RATE_LIMIT_EXCEEDED |
429 | Anonymous daily limit reached (3/day per IP) |
MONTHLY_LIMIT_EXCEEDED |
429 | Monthly create limit reached for this API key |
PAYLOAD_TOO_LARGE |
413 | Encrypted blob exceeds the tier blob ceiling |
SECRET_NOT_FOUND |
404 | Secret ID does not exist or has expired |
SECRET_ALREADY_CONSUMED |
410 | Secret was already retrieved |
SECRET_EXPIRED |
410 | Secret has passed its expiry time |
Security
- Encrypts on your device before any network call
- AES-GCM-256 with authenticated encryption and built-in tamper detection
- Keys never reach the server. They travel in the URL fragment (RFC 3986 §3.5), which browsers strip before sending requests.
- Sensitive buffers overwritten after use (best-effort in Python)
- No plaintext logging. No analytics in the SDK.
Requirements
- Python 3.10 or higher
cryptography>= 43.0
License
MIT
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file zephr-0.3.0.tar.gz.
File metadata
- Download URL: zephr-0.3.0.tar.gz
- Upload date:
- Size: 15.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3cdda613c77aca51bffdf59405ee348c8dd749ae775a39623195dcbe00876474
|
|
| MD5 |
b36d4658d55eba08481a0c71789531ee
|
|
| BLAKE2b-256 |
5dd64cf07937af55d484662023d7e2f594cbe7d56a52a105c8c1fc034876110f
|
Provenance
The following attestation bundles were made for zephr-0.3.0.tar.gz:
Publisher:
publish-pypi.yml on zephr-io/zephr
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
zephr-0.3.0.tar.gz -
Subject digest:
3cdda613c77aca51bffdf59405ee348c8dd749ae775a39623195dcbe00876474 - Sigstore transparency entry: 1116463240
- Sigstore integration time:
-
Permalink:
zephr-io/zephr@f087f9061ee0cf05fe0620ceb938ab2648a105f5 -
Branch / Tag:
refs/tags/pypi-v0.3.0 - Owner: https://github.com/zephr-io
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@f087f9061ee0cf05fe0620ceb938ab2648a105f5 -
Trigger Event:
push
-
Statement type:
File details
Details for the file zephr-0.3.0-py3-none-any.whl.
File metadata
- Download URL: zephr-0.3.0-py3-none-any.whl
- Upload date:
- Size: 15.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
95bc799cdf4e6b75c1d642fa6a64b7ec8b1d44f9dee90d8625d713547c8fcbbf
|
|
| MD5 |
201037064739d4112c8de8ea211b7797
|
|
| BLAKE2b-256 |
97f027465cc994665e802fd947b81957f7e09da765ec8eaf10e59f14f774a909
|
Provenance
The following attestation bundles were made for zephr-0.3.0-py3-none-any.whl:
Publisher:
publish-pypi.yml on zephr-io/zephr
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
zephr-0.3.0-py3-none-any.whl -
Subject digest:
95bc799cdf4e6b75c1d642fa6a64b7ec8b1d44f9dee90d8625d713547c8fcbbf - Sigstore transparency entry: 1116463292
- Sigstore integration time:
-
Permalink:
zephr-io/zephr@f087f9061ee0cf05fe0620ceb938ab2648a105f5 -
Branch / Tag:
refs/tags/pypi-v0.3.0 - Owner: https://github.com/zephr-io
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@f087f9061ee0cf05fe0620ceb938ab2648a105f5 -
Trigger Event:
push
-
Statement type: