aperture: the L402 aware reverse proxy

v1.0.0

Install and run Aperture, the L402 Lightning reverse proxy from Lightning Labs. Use when creating L402 paywalls, configuring paid API endpoints, hosting paid content for other agents, or testing L402 authentication flows.

0· 1.1k·0 current·0 all-time

Install

OpenClaw Prompt Flow

Install with OpenClaw

Best for remote or guided setup. Copy the exact prompt, then paste it into OpenClaw for roasbeef/aperture.

Previewing Install & Setup.
Prompt PreviewInstall & Setup
Install the skill "aperture: the L402 aware reverse proxy" (roasbeef/aperture) from ClawHub.
Skill page: https://clawhub.ai/roasbeef/aperture
Keep the work scoped to this skill only.
After install, inspect the skill metadata and help me finish setup.
Use only the metadata you can verify from ClawHub; do not invent missing requirements.
Ask before making any broader environment changes.

Command Line

CLI Commands

Use the direct CLI path if you want to install manually and keep every step visible.

OpenClaw CLI

Canonical install target

openclaw skills install roasbeef/aperture

ClawHub CLI

Package manager switcher

npx clawhub@latest install aperture
Security Scan
VirusTotalVirusTotal
Benign
View report →
OpenClawOpenClaw
Suspicious
high confidence
!
Purpose & Capability
The SKILL.md and scripts clearly implement and install Lightning Labs' Aperture (go install github.com/lightninglabs/aperture). That purpose legitimately requires access to an LND node's TLS cert and invoice macaroon for creating invoices. However, the registry metadata declares no required config paths, env vars, or credentials even though the included scripts read/write ~/.lnd and ~/.aperture and reference invoice.macaroon. The omission of required config/credential declarations is an incoherence.
!
Instruction Scope
The runtime instructions and bundled scripts perform actions beyond simply running a proxy: they auto-generate ~/.aperture/aperture.yaml, auto-detect and read LND macaroon directories and TLS cert paths, suggest baking or copying invoice macaroons, and start aperture as a background service. Reading macaroons and TLS certs is necessary for L402 but is sensitive behavior and should be explicitly declared. The instructions also reference another skill (macaroon-bakery) to create macaroons, which extends the privilege surface.
Install Mechanism
The install script uses `go install github.com/lightninglabs/aperture/cmd/aperture@...` and the templates/docker-compose uses the official lightninglabs/aperture image. These are standard, traceable upstream sources and not high-risk downloads from arbitrary servers. No suspicious URL shorteners or personal servers are used.
!
Credentials
The skill metadata lists no required env vars or config paths, yet the scripts access $HOME/.lnd (macaroons, tls) and write persistent files to $HOME/.aperture. Access to invoice.macaroon (and potentially other macaroons) is sensitive and should be declared. The skill also suggests baking macaroons via another skill, which may require broader LND privileges if misused.
Persistence & Privilege
The skill writes configuration to ~/.aperture, starts Aperture as a background process, and creates a persistent sqlite DB at ~/.aperture/aperture.db. It does not set always:true and does not modify other skills' configs. Persistent files and a background service are expected for this functionality, but users should be aware that it creates on-disk artifacts and a running process.
What to consider before installing
This skill appears to bundle scripts to install and run the real Aperture proxy and will need access to your local Lightning node credentials (invoice macaroon) and TLS cert to create invoices. That behavior is coherent with the proxy's purpose, but the registry metadata does not disclose those config paths or secrets—treat that as a red flag. Before installing: - Inspect the included scripts (they are provided) and confirm you trust github.com/lightninglabs/aperture as the upstream. Consider pinning to a specific release instead of @latest. - Do not supply or expose admin macaroons. Use an invoice-only macaroon as recommended; verify the macaroon's capabilities before using it. - Prefer running the proxy in an isolated environment or container (the repo includes a docker-compose template) rather than on a host with your real Bitcoin/LND wallet. - Be aware the skill will create ~/.aperture and a sqlite DB and may run a background process; review logs (~/.aperture/aperture-start.log) after startup. - If you need stronger assurances, verify the binary source (git tag, commit hash) and consider building from source locally rather than using go install @latest. If you aren't comfortable with the skill reading macaroons/TLS certs or creating background services on your machine, do not install it or run it only in an isolated test environment.

Like a lobster shell, security has layers — review code before you run it.

latestvk97ct1c90t6r2jwy7xnqvjsg5x80zw2j
1.1kdownloads
0stars
1versions
Updated 1mo ago
v1.0.0
MIT-0

Aperture - L402 Lightning Reverse Proxy

Aperture is a reverse proxy that implements the L402 protocol, enabling payment-gated API access via the Lightning Network. It sits in front of your backend services and requires Lightning micropayments before granting access.

Source: github.com/lightninglabs/aperture

Quick Start

# 1. Install aperture
skills/aperture/scripts/install.sh

# 2. Generate config (connects to local lnd)
skills/aperture/scripts/setup.sh

# 3. Ensure invoice.macaroon exists (required for L402 invoice creation)
#    If not present, bake one with the macaroon-bakery skill:
skills/macaroon-bakery/scripts/bake.sh --role invoice-only \
    --save-to ~/.lnd/data/chain/bitcoin/mainnet/invoice.macaroon

# 4. Start aperture
skills/aperture/scripts/start.sh

# 5. Test with lnget
lnget -k --no-pay https://localhost:8081/api/test

How Aperture Works

  1. Client requests a protected resource through Aperture
  2. Aperture responds with HTTP 402 + WWW-Authenticate: L402 header containing a macaroon and a Lightning invoice
  3. Client pays the invoice and obtains the preimage
  4. Client retries with Authorization: L402 <macaroon>:<preimage>
  5. Aperture validates the token and proxies to the backend service

Installation

skills/aperture/scripts/install.sh

This will:

  • Verify Go is installed
  • Run go install github.com/lightninglabs/aperture/cmd/aperture@latest
  • Verify aperture is on $PATH

To install manually:

go install github.com/lightninglabs/aperture/cmd/aperture@latest

Or build from source:

git clone https://github.com/lightninglabs/aperture.git
cd aperture
make install

Setup

skills/aperture/scripts/setup.sh

This generates ~/.aperture/aperture.yaml from the config template with sensible defaults. The setup script auto-detects the local lnd node paths.

Options:

# Custom network
setup.sh --network testnet

# Custom lnd paths
setup.sh --lnd-host localhost:10009 \
         --lnd-tls ~/.lnd/tls.cert \
         --lnd-macdir ~/.lnd/data/chain/bitcoin/mainnet

# Custom listen port
setup.sh --port 8081

# Disable TLS (development only)
setup.sh --insecure

# Disable auth (no payments required)
setup.sh --no-auth

Running Aperture

Start

skills/aperture/scripts/start.sh

Starts aperture as a background process reading ~/.aperture/aperture.yaml.

Options:

start.sh --foreground         # Run in foreground
start.sh --config /path/to   # Custom config path

Stop

skills/aperture/scripts/stop.sh

Configuration

Config file: ~/.aperture/aperture.yaml

Invoice Macaroon Requirement

Aperture requires invoice.macaroon in the configured macdir to create Lightning invoices for L402 challenges. This is not the same as admin.macaroon. If the macaroon is missing, aperture will fail to start or will return errors when clients request paid resources.

To bake an invoice macaroon with the macaroon-bakery skill:

skills/macaroon-bakery/scripts/bake.sh --role invoice-only \
    --save-to ~/.lnd/data/chain/bitcoin/mainnet/invoice.macaroon

The setup.sh script will warn you if invoice.macaroon is not found at the expected path.

Minimal Agent Configuration

This is the minimal config for an agent hosting paid endpoints with a local lnd node:

listenaddr: "localhost:8081"
insecure: true
debuglevel: "info"
dbbackend: "sqlite"
sqlite:
  dbfile: "~/.aperture/aperture.db"

authenticator:
  network: "mainnet"
  lndhost: "localhost:10009"
  tlspath: "~/.lnd/tls.cert"
  macdir: "~/.lnd/data/chain/bitcoin/mainnet"

services:
  - name: "my-api"
    hostregexp: ".*"
    pathregexp: "^/api/.*$"
    address: "127.0.0.1:8080"
    protocol: http
    price: 100

Service Configuration

Each service entry defines a backend to protect:

services:
  - name: "service-name"
    # Match requests by host (regex).
    hostregexp: "^api.example.com$"

    # Match requests by path (regex).
    pathregexp: "^/paid/.*$"

    # Backend address to proxy to.
    address: "127.0.0.1:8080"

    # Protocol: http or https.
    protocol: http

    # Static price in satoshis.
    price: 100

    # Macaroon capabilities granted at base tier.
    capabilities: "read,write"

    # Token expiry in seconds (31557600 = 1 year).
    timeout: 31557600

    # Paths exempt from payment.
    authwhitelistpaths:
      - "^/health$"
      - "^/public/.*$"

    # Per-endpoint rate limits (token bucket).
    ratelimits:
      - pathregexp: "^/api/query.*$"
        requests: 10
        per: 1s
        burst: 20

Authentication Backends

Direct LND Connection

authenticator:
  network: "mainnet"
  lndhost: "localhost:10009"
  tlspath: "~/.lnd/tls.cert"
  macdir: "~/.lnd/data/chain/bitcoin/mainnet"

Lightning Node Connect (LNC)

authenticator:
  network: "mainnet"
  passphrase: "your-pairing-phrase"
  mailboxaddress: "mailbox.terminal.lightning.today:443"

Disable Authentication

authenticator:
  disable: true

Database Backends

SQLite (recommended for agents):

dbbackend: "sqlite"
sqlite:
  dbfile: "~/.aperture/aperture.db"

PostgreSQL:

dbbackend: "postgres"
postgres:
  host: "localhost"
  port: 5432
  user: "aperture"
  password: "secret"
  dbname: "aperture"

TLS Configuration

# Auto Let's Encrypt certificate.
autocert: true
servername: "api.example.com"

# Or disable TLS (development/local only).
insecure: true

If neither is set, Aperture generates self-signed certs in ~/.aperture/.

Dynamic Pricing

Connect to a gRPC price server instead of static prices:

services:
  - name: "my-api"
    dynamicprice:
      enabled: true
      grpcaddress: "127.0.0.1:10010"
      insecure: false
      tlscertpath: "/path/to/pricer/tls.cert"

Hosting Paid Content for Agents

A common pattern is hosting information that other agents pay to access:

# 1. Start a simple HTTP backend with your content
mkdir -p /tmp/paid-content
echo '{"data": "valuable information"}' > /tmp/paid-content/info.json
cd /tmp/paid-content && python3 -m http.server 8080 &

# 2. Configure aperture to protect it
skills/aperture/scripts/setup.sh --insecure --port 8081

# 3. Start aperture
skills/aperture/scripts/start.sh

# 4. Other agents can now pay and fetch
lnget --max-cost 100 https://localhost:8081/api/info.json

Integration with lnget and lnd

With all three components running:

# Verify lnd is running
skills/lnd/scripts/lncli.sh getinfo

# Start aperture (uses same lnd for invoice generation)
skills/aperture/scripts/start.sh

# Fetch a paid resource
lnget --max-cost 1000 https://localhost:8081/api/data

# Check tokens
lnget tokens list

File Locations

PathPurpose
~/.aperture/aperture.yamlConfiguration file
~/.aperture/aperture.dbSQLite database
~/.aperture/tls.certTLS certificate
~/.aperture/tls.keyTLS private key
~/.aperture/aperture.logLog file

Troubleshooting

Port already in use

Change listenaddr in config to a different port, or use setup.sh --port.

LND connection refused

Verify lnd is running and wallet is unlocked. Check lndhost, tlspath, and macdir in the config point to the correct lnd instance.

No 402 challenge returned

Check that the request path matches a service's pathregexp and is not in authwhitelistpaths. Verify authenticator.disable is not true.

Token validation fails

The client must present the exact macaroon from the challenge with the correct preimage. Verify the preimage matches the payment hash.

Comments

Loading comments...