简体中文

alocals3

alocals3 is a local S3-like object store focused on fast local development and internal workloads.

The current main branch is Rust-first:

• Server: pure Rust binary, no Python runtime required.
• Metadata backend: SQLite or PostgreSQL.
• Object payloads: local filesystem with SHA-256 based sharding.
• Python client: wheel package backed by Rust networking through reqwest.
• Python target: Python 3.12+ with PyO3 abi3-py312 limited API.

The project implements an S3-compatible subset, not the full AWS S3 API surface.

Quick Start

Build and run the Rust server:

PYO3_NO_PYTHON=1 cargo build --release --no-default-features --features server,server-binary --bin alocals3-server

target/release/alocals3-server \
  --host 127.0.0.1 \
  --port 8000 \
  --database-url "sqlite:///./alocals3.db" \
  --storage-root ./data

Background garbage collection is enabled by default. It periodically removes object files that are no longer referenced by the database and removes database records whose files are missing. Candidates must be older than the GC grace period before they are deleted.

target/release/alocals3-server \
  --gc-interval-secs 300 \
  --gc-grace-secs 300 \
  --gc-start-delay-secs 30

Set --disable-gc to disable background GC. --gc-interval-secs 0 and ALOCALS3_GC_INTERVAL_SECS=0 are equivalent.

Run the reproducible GC correctness suite:

./examples/gc_correctness.sh

It covers orphan files, missing-file records, stale temp files, live/shared object retention, grace-period behavior, GC disable modes, and orphan-path reuse races. Latest local result:

GC correctness and race scenarios passed
orphan_files_deleted=1 missing_records_deleted=1 stale_tmp_files_deleted=1
remaining_objects: grace=1 disable_flag=1 interval_zero=1 race=30

Use PostgreSQL instead of SQLite:

target/release/alocals3-server \
  --host 127.0.0.1 \
  --port 8000 \
  --database-url "postgresql://user:password@127.0.0.1:5432/alocals3" \
  --storage-root ./data

Install the Python client from source:

python3.12 -m venv .venv
source .venv/bin/activate
python -m pip install -U pip maturin
python -m pip install -e .

Build Artifacts

Release helper scripts live in scripts:

# Linux static server plus Python 3.12+ ABI3 wheel
scripts/build-linux-release.sh

# macOS arm64, macOS 11 deployment baseline
scripts/build-macos-release.sh

# Windows 10+ PowerShell
.\scripts\build-windows-release.ps1

Linux server builds default to x86_64-unknown-linux-musl; Linux wheels default to manylinux_2_28. macOS builds default to aarch64-apple-darwin with MACOSX_DEPLOYMENT_TARGET=11.0.

The wheel is configured as Python 3.12+ ABI3 via PyO3 abi3-py312. It is not a cp312-cp312 wheel unless the ABI3 feature is removed.

Platform wheels include the Rust server executable and install an alocals3-server command. Standalone server artifacts are also named alocals3-server on Unix-like platforms and alocals3-server.exe on Windows.

Configuration

Server CLI flags:

• --host: bind host, default 127.0.0.1
• --port: bind port, default 8000
• --database-url: SQLite or PostgreSQL URL
• --storage-root: object payload root directory
• --log-level: log level or tracing_subscriber filter directive, default info
• --max-upload-size: maximum upload body size in bytes, default 0 disables the axum body limit
• --auth-enabled <true|false>: explicitly enable or disable authentication, default false
• --service-token: bearer token for the internal /s3 API; empty by default
• --user-auth-secret: HMAC secret for the read-only /api/object API; empty by default
• --object-auth-cookie: browser access-token cookie name, default alocals3-auth-cookie
• --version: print server version and author information

Environment variables:

• ALOCALS3_DATABASE_URL: default sqlite:///./alocals3.db
• ALOCALS3_STORAGE_ROOT: default ./data
• ALOCALS3_LOG_LEVEL: default info
• ALOCALS3_MAX_UPLOAD_SIZE: default 0
• ALOCALS3_AUTH_ENABLED: authentication switch, default false; the CLI flag takes precedence
• ALOCALS3_SERVICE_TOKEN: bearer token required by /s3 when authentication is enabled
• ALOCALS3_USER_AUTH_SECRET: HMAC secret used to validate Lauraycs access tokens on /api/object
• ALOCALS3_OBJECT_AUTH_COOKIE: access-token cookie name, default alocals3-auth-cookie

Authentication

Authentication is controlled explicitly by --auth-enabled <true|false> (or ALOCALS3_AUTH_ENABLED). Credentials no longer implicitly enable it:

• With --auth-enabled true, /s3 requires Authorization: Bearer <service-token>, while /api/object/{bucket}/{key} requires a valid HMAC user token. Both --service-token and --user-auth-secret are required; the server refuses to start if either is empty.
• With --auth-enabled false (the default), both API families are accessible without credentials. Token and secret values may remain configured, but are ignored until authentication is enabled.
• /healthz does not require authentication.

The switch and credentials can all be supplied directly on the command line:

SERVICE_TOKEN="$(openssl rand -hex 32)"
USER_AUTH_SECRET="$(openssl rand -hex 32)"

target/release/alocals3-server \
  --auth-enabled true \
  --service-token "$SERVICE_TOKEN" \
  --user-auth-secret "$USER_AUTH_SECRET" \
  --object-auth-cookie "alocals3-auth-cookie" \
  --database-url "sqlite:///./alocals3.db" \
  --storage-root ./data

Environment variables are also supported. For the remaining examples, export the same values before starting the server and clients:

export ALOCALS3_AUTH_ENABLED=true
export ALOCALS3_SERVICE_TOKEN="$SERVICE_TOKEN"
export ALOCALS3_USER_AUTH_SECRET="$USER_AUTH_SECRET"
export ALOCALS3_OBJECT_AUTH_COOKIE="alocals3-auth-cookie" # optional

Use the protected /s3 API with curl or the Python client:

curl -H "Authorization: Bearer ${ALOCALS3_SERVICE_TOKEN}" \
  http://127.0.0.1:8000/s3

# The CLI and Python client also read ALOCALS3_SERVICE_TOKEN automatically.
python -m alocals3.client --endpoint http://127.0.0.1:8000 LIST_BUCKETS

from alocals3.client import ALocalS3Client

with ALocalS3Client(
    "http://127.0.0.1:8000",
    service_token="the-same-service-token-as-the-server",
) as client:
    print(client.list_buckets())

A user access token has the form <payload>.<signature>. payload is the unpadded URL-safe Base64 encoding of <username>|<access>|<expires-unix-seconds>|<nonce>, and signature is the lowercase hex HMAC-SHA256 of the encoded payload using ALOCALS3_USER_AUTH_SECRET. The server requires a non-empty username and nonce, checks the expiry and signature, and currently carries the access field without interpreting it as an authorization rule. Lauraycs normally issues this token; the following standalone example shows the exact wire format:

USER_TOKEN="$(python - <<'PY'
import base64, hashlib, hmac, os, secrets, time

raw = f"demo-user|read|{int(time.time()) + 3600}|{secrets.token_hex(16)}"
payload = base64.urlsafe_b64encode(raw.encode()).rstrip(b"=").decode()
signature = hmac.new(
    os.environ["ALOCALS3_USER_AUTH_SECRET"].encode(),
    payload.encode(),
    hashlib.sha256,
).hexdigest()
print(f"{payload}.{signature}")
PY
)"

curl -H "Authorization: Bearer ${USER_TOKEN}" \
  http://127.0.0.1:8000/api/object/demo/file.bin

Browsers may send the same token in the cookie configured by ALOCALS3_OBJECT_AUTH_COOKIE; for example, Cookie: alocals3-auth-cookie=<user-token>. A Bearer header takes precedence when both are present. Amazon S3 does not define an authentication cookie name; its SigV4 authentication uses the Authorization header, query parameters, or browser POST fields. alocals3-auth-cookie is therefore an alocals3-specific name, not an x-amz-* protocol field. CloudFront signed-cookie names are not used because CloudFront's three-cookie signature format is a different protocol.

To disable authentication explicitly, restart with the CLI switch set to false (this overrides ALOCALS3_AUTH_ENABLED=true):

target/release/alocals3-server \
  --auth-enabled false \
  --database-url "sqlite:///./alocals3.db" \
  --storage-root ./data

Run an unauthenticated deployment only on a trusted development machine.

Database URL examples:

• SQLite: sqlite:///./alocals3.db
• PostgreSQL: postgresql://user:password@127.0.0.1:5432/alocals3

Use an absolute SQLite path in scripts and services to avoid accidentally writing to different database files from different working directories. PostgreSQL is recommended for sustained concurrent workloads.

Logging is written to stderr. Common levels are debug, info, warn, and error; full EnvFilter directives such as warn,alocals3_server=debug are also accepted.

Uploads are not capped by the server body extractor by default. The current implementation buffers each uploaded object in memory before writing it to disk, so practical limits are still determined by process memory and available storage. Set --max-upload-size to restore an explicit byte limit.

Storage Layout

• Bucket and object metadata is stored in SQLite or PostgreSQL.
• Object bytes are stored on local disk.
• Blob paths are content-addressed and sharded:
  • sha256(<object bytes>) = <digest>
  • {storage_root}/objects/{digest[:2]}/{digest[2:4]}/{digest}

Object keys, bucket names, prefixes, delimiters, and continuation tokens are UTF-8 text. Client path parameters are UTF-8 percent-encoded automatically; pass raw strings such as logs/data.txt or logs/数据.txt, not pre-encoded URL fragments.

HTTP API

• GET /healthz: health check
• GET /s3: list buckets
• PUT /s3/{bucket}: create bucket
• DELETE /s3/{bucket}: delete empty bucket
• GET /s3/{bucket}/objects: list objects
• GET /s3/{bucket}?list-type=2: S3-style ListObjectsV2
• PUT /s3/{bucket}/{key}: upload object
• GET /s3/{bucket}/{key}: download object
• HEAD /s3/{bucket}/{key}: object metadata
• DELETE /s3/{bucket}/{key}: delete object
• GET|HEAD /api/object/{bucket}/{key}: authenticated, read-only browser object access

Supported object features:

• ETag is the MD5 hex digest of the object body.
• Range requests return 206 or 416.
• If-None-Match and If-Match are supported for PUT.
• Content-MD5 is validated on PUT.
• If-None-Match is supported for GET and HEAD.

PUT /s3/{bucket}/{key} returns:

• 201: new object created
• 200: existing object overwritten
• 400: invalid Content-MD5
• 412: conditional request failed

Client Usage

The Python runtime dependency list is intentionally empty. HTTP networking is implemented in Rust, not httpx.

import asyncio
from pathlib import Path

from alocals3.client import ALocalS3Client, ALocalS3ClientAsync

with ALocalS3Client(
    "http://127.0.0.1:8000",
    disable_proxy=True,
    service_token="the-internal-service-token",
) as client:
    client.create_bucket("demo")
    info = client.put_object("demo", "logs/数据.txt", Path("data.txt"))
    print(info["etag"])
    copied = client.copy_object(
        "demo", "logs/数据.txt", "demo", "logs/copied.txt",
        metadata={"foo": "bar"},
    )

    data, headers = client.get_object_range("demo", "logs/数据.txt", "bytes=0-99")
    print(len(data), headers.get("content-range"))

    with client.open("s3://demo/logs/数据.txt", "r") as f:
        print(f.read())

    with client.open("s3://demo/logs/from-open.txt", "wb") as f:
        f.write(b"hello from file-like API\n")

    client.get_object_to_file("demo", "logs/数据.txt", Path("copy.txt"))


async def main() -> None:
    async with ALocalS3ClientAsync("http://127.0.0.1:8000", disable_proxy=True) as client:
        print(await client.list_buckets())
        async with client.open("s3://demo/logs/from-async-open.txt", "wb") as f:
            await f.write(b"hello from async file-like API\n")
        async with client.open("s3://demo/logs/from-async-open.txt", "rb") as f:
            print(await f.read())


asyncio.run(main())

CLI:

python -m alocals3.client --endpoint http://127.0.0.1:8000 CREATE_BUCKET demo
python -m alocals3.client --endpoint http://127.0.0.1:8000 PUT demo file.bin ./file.bin
python -m alocals3.client --endpoint http://127.0.0.1:8000 COPY demo file.bin demo copy.bin --metadata foo=bar
python -m alocals3.client --endpoint http://127.0.0.1:8000 GET demo file.bin ./copy.bin
python -m alocals3.client --endpoint http://127.0.0.1:8000 LIST_OBJECTS_V2 demo --prefix logs/ --delimiter /

CopyObject is also available through the S3-compatible PUT form using x-amz-copy-source. It reuses the source content-addressed blob, so it performs no object-byte copy and remains O(1) with respect to object size. User metadata headers (x-amz-meta-*) are persisted; use x-amz-metadata-directive: REPLACE to replace metadata during a copy (the default is COPY).

Migrate SQLite to PostgreSQL

Stop writers or take a SQLite snapshot first, then run:

alocals3-migrate2pg \
  --source sqlite:///./alocals3.db \
  --target postgresql://user:password@127.0.0.1:5432/alocals3

The command migrates metadata only. Keep the same --storage-root (or move the storage directory separately), because object blobs are referenced by relative content-addressed paths. The migration is idempotent and commits all migrated bucket/object rows in one PostgreSQL transaction.

Set disable_proxy=True or pass --disable-proxy to ignore proxy environment variables such as HTTP_PROXY, HTTPS_PROXY, ALL_PROXY, and NO_PROXY.

client.open() is file-like but not an in-memory object wrapper:

• Read modes ("rb" / "r") create a Rust-backed streaming HTTP reader. open() sends the request and reads response headers, but object bytes are pulled from the network when the returned file object's read() path runs.
• Write modes ("wb" / "w") spool writes to a Rust-owned temporary file. The HTTP PUT is sent when the file is closed or the with block exits successfully. If the with block exits with an exception, the upload is discarded.
• cache_path= is best-effort and is populated as bytes pass through the file-like object; cache write failures do not fail the network operation.
• For asyncio code, ALocalS3ClientAsync.open() returns an async file-like object for async with. It provides awaitable read(), readline(), readinto(), write(), flush(), close(), and discard() methods backed by the same Rust implementation.

Benchmark the Python file-like API with a large object:

./examples/benchmark_file_like.sh

Validate stream multiplexing and Range-based resume reads:

./examples/benchmark_stream_multiplex.sh

The current file-like API supports resume reads through range_header="bytes=N-". Upload resume is not implemented yet; write modes spool to a Rust-owned temporary file and use one HTTP PUT on close.

Curl Examples

curl -i -X PUT http://127.0.0.1:8000/s3/demo
curl -i -X PUT --data-binary @file.bin http://127.0.0.1:8000/s3/demo/file.bin
curl -i http://127.0.0.1:8000/s3/demo/file.bin
curl -i -H "Range: bytes=0-99" http://127.0.0.1:8000/s3/demo/file.bin
curl -sS "http://127.0.0.1:8000/s3/demo?list-type=2&prefix=logs/&delimiter=/&max-keys=100"

Conditional PUT:

curl -i -X PUT -H "If-None-Match: *" --data-binary @file.bin \
  http://127.0.0.1:8000/s3/demo/file.bin

curl -i -X PUT -H 'If-Match: "d41d8cd98f00b204e9800998ecf8427e"' --data-binary @file.bin \
  http://127.0.0.1:8000/s3/demo/file.bin

MD5_B64=$(openssl md5 -binary file.bin | openssl base64)
curl -i -X PUT -H "Content-MD5: ${MD5_B64}" --data-binary @file.bin \
  http://127.0.0.1:8000/s3/demo/file.bin

Consistency Notes

• Object bytes are written through a temporary file and atomic rename.
• Metadata updates are committed through the selected database backend.
• This is not a single distributed transaction across database and filesystem.
• Under process or machine failure, orphan blob files may exist. The Python package no longer ships an alternate storage backend or Python server path; operational cleanup should be handled outside the request path.

Updates

updates.md

License

The MIT License