GRIN/floonet-rs
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

floonet-rs: hardened nostr-rs-relay for the Grin community
Test and build / test_floonet-rs (push) Has been cancelled
Details

Browse Source 
nostr-rs-relay + a default-deny admission pipeline (kinds 0,3,5,13,1059,
10002,10050,27235 only), NIP-42 auth, neutral NIP-11, a built-in name
authority (paid names via GoblinPay), and a config-toggled co-located
mixnet exit supervisor. Single binary + installer + hardened systemd, or
Docker Compose. Relay core untouched (additive admission + authority).
This commit is contained in:
Goblin
2026-07-02 08:22:18 -04:00
commit 9fa97ebb5c
74 changed files with 30110 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.cargo/config.toml
+2
View File
@@ -0,0 +1,2 @@
[build]
rustflags = ["--cfg", "tokio_unstable"]
.github/workflows/ci.yml
+39
View File
@@ -0,0 +1,39 @@
name: Test and build
on:
push:
branches:
- master
jobs:
test_floonet-rs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Update local toolchain
run: |
sudo apt-get install -y protobuf-compiler
rustup update
rustup component add clippy
rustup install nightly
- name: Toolchain info
run: |
cargo --version --verbose
rustc --version
cargo clippy --version
# - name: Lint
# run: |
# cargo fmt -- --check
# cargo clippy -- -D warnings
- name: Test
run: |
cargo check
cargo test --all
- name: Build
run: |
cargo build --release --locked
.gitignore
+6
View File
@@ -0,0 +1,6 @@
**/target/
nostr.db
nostr.db-*
justfile
result
**/.idea/
.pre-commit-config.yaml
+16
View File
@@ -0,0 +1,16 @@
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.3.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
- id: check-added-large-files
- repo: https://github.com/doublify/pre-commit-rust
rev: v1.0
hooks:
# - id: fmt
- id: cargo-check
- id: clippy
Cargo.lock
Generated
+4354
View File
File diff suppressed because it is too large Load Diff
Cargo.toml
+70
View File
@@ -0,0 +1,70 @@
[package]
name = "floonet-rs"
version = "0.1.0"
edition = "2021"
authors = ["The Floonet Developers", "Greg Heartsfield <scsibug@imap.cc>"]
description = "A hardened Floonet relay for the Grin community Nostr network, forked from nostr-rs-relay"
readme = "README.md"
homepage = "https://floonet.dev"
license = "MIT"
keywords = ["nostr", "server", "grin", "floonet"]
categories = ["network-programming", "web-programming"]
default-run = "floonet-rs"
[dependencies]
clap = { version = "4.0.32", features = ["env", "default", "derive"]}
tracing = "0.1.37"
tracing-appender = "0.2.2"
tracing-subscriber = "0.3.16"
tokio = { version = "1", features = ["full", "tracing", "signal"] }
prost = "0.11"
tonic = "0.8.3"
console-subscriber = "0.1.8"
futures = "0.3"
futures-util = "0.3"
tokio-tungstenite = "0.17"
tungstenite = "0.17"
thiserror = "1"
uuid = { version = "1.1.2", features = ["v4"] }
config = { version = "0.12", features = ["toml"] }
bitcoin_hashes = { version = "0.10", features = ["serde"] }
secp256k1 = {version = "0.21", features = ["rand", "rand-std", "serde", "bitcoin_hashes"] }
serde = { version = "1.0", features = ["derive"] }
serde_json = {version = "1.0", features = ["preserve_order"]}
hex = "0.4"
rusqlite = { version = "0.26", features = ["limits","bundled","modern_sqlite", "trace"]}
r2d2 = "0.8"
r2d2_sqlite = "0.19"
lazy_static = "1.4"
governor = "0.4"
nonzero_ext = "0.3"
hyper = { version="0.14", features=["client", "server","http1","http2","tcp"] }
hyper-rustls = { version = "0.24" }
http = { version = "0.2" }
parse_duration = "2"
rand = "0.8"
const_format = "0.2.28"
regex = "1"
async-trait = "0.1.60"
async-std = "1.12.0"
sqlx = { version ="0.6.2", features=["runtime-tokio-rustls", "postgres", "chrono"]}
chrono = "0.4.23"
prometheus = "0.13.3"
indicatif = "0.17.3"
bech32 = "0.9.1"
url = "2.3.1"
qrcode = { version = "0.12.0", default-features = false, features = ["svg"] }
nostr = { version = "0.18.0", default-features = false, features = ["base", "nip04", "nip19"] }
log = "0.4"
cln-rpc = "0.1.9"
itertools = "0.14.0"
base64 = "0.21"
[target.'cfg(all(not(target_env = "msvc"), not(target_os = "openbsd")))'.dependencies]
tikv-jemallocator = "0.5"
[dev-dependencies]
anyhow = "1"
[build-dependencies]
tonic-build = { version="0.8.3", features = ["prost"] }
Dockerfile
+54
View File
@@ -0,0 +1,54 @@
FROM docker.io/library/rust:1-bookworm as builder
ARG CARGO_LOG
RUN apt-get update \
&& apt-get install -y cmake protobuf-compiler \
&& rm -rf /var/lib/apt/lists/*
RUN USER=root cargo install cargo-auditable
RUN USER=root cargo new --bin floonet-rs
WORKDIR ./floonet-rs
COPY ./Cargo.toml ./Cargo.toml
COPY ./Cargo.lock ./Cargo.lock
# build dependencies only (caching)
RUN cargo auditable build --release --locked
# get rid of starter project code
RUN rm src/*.rs
# copy project source code
COPY ./src ./src
COPY ./proto ./proto
COPY ./assets ./assets
COPY ./build.rs ./build.rs
# build auditable release using locked deps
RUN rm ./target/release/deps/floonet*
RUN cargo auditable build --release --locked
FROM docker.io/library/debian:bookworm-slim
ARG APP=/usr/src/app
ARG APP_DATA=/usr/src/app/db
RUN apt-get update \
&& apt-get install -y ca-certificates tzdata sqlite3 libc6 \
&& rm -rf /var/lib/apt/lists/*
EXPOSE 8080
ENV TZ=Etc/UTC \
APP_USER=appuser
RUN groupadd $APP_USER \
&& useradd -g $APP_USER $APP_USER \
&& mkdir -p ${APP} \
&& mkdir -p ${APP_DATA}
COPY --from=builder /floonet-rs/target/release/floonet-rs ${APP}/floonet-rs
RUN chown -R $APP_USER:$APP_USER ${APP}
USER $APP_USER
WORKDIR ${APP}
ENV RUST_LOG=info,floonet_rs=info
ENV APP_DATA=${APP_DATA}
CMD ./floonet-rs --db ${APP_DATA}
LICENSE
+21
View File
@@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2021 Greg Heartsfield
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
README.md
+274
View File
@@ -0,0 +1,274 @@
# floonet-rs
A hardened [Floonet](https://floonet.dev) relay for the Grin community
Nostr network, forked from
[nostr-rs-relay](https://git.sr.ht/~gheartsfield/nostr-rs-relay).
Floonet is a network of Nostr relays for the Grin community: anyone can
run one, and anyone can run a name authority on it so people can claim
(and optionally pay for) a `name@domain` identity. floonet-rs keeps the
upstream relay core intact and adds four configurable, modular features:
* An **event kind whitelist** (the keystone): default-deny admission.
The relay accepts ONLY the kinds it is configured to allow and rejects
everything else. The shipped set is
`0, 3, 5, 13, 1059, 10002, 10050, 27235`.
* **Authentication**: NIP-42, with optional require-auth-to-write and an
author whitelist.
* A **built-in name authority**: `name@domain` NIP-05 identities with
NIP-98 authenticated self-service registration, served in-process.
Optionally paid in GRIN through GoblinPay.
* A **co-located mixnet exit** (config toggle): wallets can reach this
relay over the mixnet, with no public DNS on the payment path.
The public relay metadata stays neutral on purpose: the NIP-11 document
and landing page never mention payments. The relay only ever sees opaque
gift-wrapped ciphertext, so payment wording would be both inaccurate and
an operational liability.
## Deploy
Pick your comfort level. All three paths end with the same relay.
### 1. Docker Compose (recommended)
Brings up the relay plus a Caddy TLS proxy in one command:
```sh
cp config.toml my-config.toml
# edit my-config.toml: info.relay_url, and [network] address = "0.0.0.0"
echo 'FLOONET_DOMAIN=relay.example.com' > .env
docker compose up -d
```
The relay container is non-root with a read-only root filesystem; Caddy
obtains certificates automatically and forwards the real client IP.
### 2. Binary + installer + systemd
From an unpacked release archive (or a source checkout after building),
the installer drops the binary, a default config, and a hardened
systemd unit; no toolchain needed at install time:
```sh
sudo sh deploy/install.sh
sudo $EDITOR /etc/floonet-rs/config.toml # set info.relay_url
sudo systemctl start floonet-rs
```
Put a TLS proxy in front (see `deploy/Caddyfile`). The unit runs as a
dynamic unprivileged user with a read-only system view
(`ProtectSystem=strict`, `NoNewPrivileges`, `MemoryDenyWriteExecute`,
syscall filtering); only `/var/lib/floonet-rs` is writable.
### 3. Source build
```sh
cargo build --release
./target/release/floonet-rs --config config.toml --db .
```
Requires a protobuf compiler (`protoc`) for the gRPC extension point.
## The whitelist (keystone)
```toml
[limits]
event_kind_allowlist = [0, 3, 5, 13, 1059, 10002, 10050, 27235]
```
Fail-closed semantics, enforced in the write path before anything is
queued for persistence:
* The listed kinds are accepted; **everything else is rejected** with an
`OK false` / `blocked:` message.
* Removing the line keeps the built-in Floonet set. There is no
allow-all: an empty list denies everything.
* To add a kind, add it to the list and restart. Never narrow the list
below what your users' wallets already depend on.
## Authentication (NIP-42)
```toml
[authorization]
nip42_auth = true # send AUTH challenges
require_auth_to_write = true # refuse writes until the client AUTHs
nip42_dms = true # gift wraps only to their recipients
#pubkey_whitelist = ["<hex>"] # restrict authors entirely
```
Unauthenticated writes are refused with an `auth-required:` prefixed OK
message, so compliant clients authenticate and resend.
## Name authority
Enable the built-in authority to serve `name@yourdomain` identities:
```toml
[name_authority]
enabled = true
domain = "example.com"
base_url = "https://example.com" # must match what clients reach
```
Endpoints, all on the relay's own listener:
| Endpoint | Purpose |
| --- | --- |
| `GET /.well-known/nostr.json?name=<name>` | NIP-05 resolution |
| `POST /api/v1/register` | claim a name (NIP-98 auth) |
| `DELETE /api/v1/register/{name}` | release a name (NIP-98 auth) |
| `GET /api/v1/name/{name}` | availability |
| `GET /api/v1/profile/{name}` | name to pubkey |
| `GET /api/v1/by-pubkey/{pubkey}` | reverse lookup |
| `GET /api/v1/health` | liveness |
Rules carried over from goblin-nip05d: lowercase `[a-z0-9._-]` names
(3 to 20 characters, alphanumeric at both ends), a built-in reserved
list plus your own domain labels with look-alike folding (`g0blin`
cannot impersonate `goblin`), one active name per key enforced by the
database, NIP-98 verification with a bounded replay window, per-IP rate
limits, and a release-armed rename cooldown. Claims live in the relay's
own SQLite database (`name_claims` table).
## Charge GRIN for your relay
Paid use is one switch plus a price. Point the relay at your GoblinPay
server and pick a mode:
```toml
[goblinpay]
pay_mode = "name" # or "write", or "off"
url = "https://pay.example.com"
api_token = "<GP_API_TOKEN>"
name_price_grin = 1.0
```
Or keep secrets out of the file entirely and use the environment:
`FLOONET_PAY_MODE`, `FLOONET_GOBLINPAY_URL`, `FLOONET_GOBLINPAY_TOKEN`,
`FLOONET_NAME_PRICE_GRIN`.
* **`pay_mode = "name"`**: claiming a name answers
`402 {"error":"payment_required","pay_url":...}` with a hosted
GoblinPay page (GoblinPay, manual slatepack, or a `grin1` address if
the operator enabled that method). Once the payment confirms on chain,
the same register call succeeds. Clients have everything they need to
send the user straight to the pay page and retry.
* **`pay_mode = "write"`**: publishing requires a paid admission; the
relay reuses its pay-to-relay account model with GoblinPay as the
payment processor.
* A GoblinPay webhook may POST `{"invoice_id": ...}` to `/goblinpay` to
speed things up; the relay always re-verifies the invoice with the
GoblinPay server before admitting anything, so a forged webhook cannot
fake a payment.
Payments admit the pubkey, not the request: after one confirmed payment
a key can claim, release, and re-claim its single name without paying
again (the rename cooldown still applies).
Prices are plain config values; edit and restart to change them. The
public relay metadata stays payment-free regardless of mode.
## Mixnet exit
Flip one toggle and this relay also runs a co-located mixnet exit, so
wallets can reach it over the mixnet:
```toml
[exit]
enabled = true
binary = "/usr/local/bin/floonet-mixexit"
data_dir = "/var/lib/floonet-rs/mixexit"
upstream = "relay.example.com:443" # your public TLS endpoint
```
The exit (bundled in `mixexit/`) is an ordinary unbonded mixnet client:
no node registration, no tokens, no directory listing. It forwards
every accepted stream to the ONE configured upstream, never a
caller-chosen target, so it is structurally not an open proxy and you
carry no exit liability. Wallets run hostname-validated TLS end to end
through the pipe; the exit only ever sees ciphertext.
The exit's mixnet address is stable across restarts (the identity
persists in `data_dir`; back it up). It is printed at startup and
written to `<data_dir>/nym_address.txt`; publish it, for example in the
Floonet relay pool `exit` field, so wallets prefer your exit and fall
back to the public mixnet route when it is down.
Build the exit binary separately (it pulls the mixnet SDK tree):
```sh
cargo build --release --manifest-path mixexit/Cargo.toml
```
The path dependency expects the Goblin `nym` checkout (branch `goblin`)
two directories up; adjust `mixexit/Cargo.toml` for your layout. Verify
with `floonet-mixexit --selftest`, which joins the mixnet, prints the
stable address, and exits.
## Extending: policies and paid resources
Admission is a small ordered pipeline in `src/admission.rs`. Each check
implements one trait:
```rust
pub trait AdmissionPolicy: Send + Sync {
fn check(&self, event: &Event, authed_pubkey: Option<&str>) -> Decision;
}
```
To add a policy (a paid gate, a spam filter, a tag rule), implement the
trait and append it in `Admission::from_settings`; the first denial
wins. To add a kind, edit the config; no code change needed. The gRPC
`event_admission_server` extension point from upstream also remains
available for out-of-process policies.
Paid uses follow the same pattern as names: quote a price, hand the
client a GoblinPay pay page, verify the confirmed invoice, then grant
the resource. Names are the first paid resource; **paid media storage
for GRIN** (NIP-96 HTTP file storage or Blossom content-addressed
blobs, advertised with a kind 10063 server list, priced per upload or
per MB) is the designed-for next example: the same
`402 pay_url -> confirm -> grant` gate applied to an upload endpoint.
## Operational notes
* **Reverse proxy**: terminate TLS at Caddy or nginx and forward
`X-Real-IP` (`remote_ip_header` in the config). All per-IP rate
limiting keys off it.
* **Event size**: keep `max_event_bytes` at its default (256 KB) or
larger; gift-wrapped payloads can be big.
* **Database**: SQLite by default; the schema migrates automatically at
startup (this fork adds `name_claims` at version 19). The name
authority requires the sqlite engine; postgres remains available for
the plain relay.
* **Secrets**: nothing in this repository; the GoblinPay token comes
from the config file (0600) or the environment.
* **Multiple identities, one wallet**: a Goblin wallet can hold several
Nostr identities. If you pay for a name and want to keep it, load the
same wallet and switch to (or add) that npub; different identities
share one wallet.
Upstream documentation for the inherited features lives in `docs/`
(database maintenance, gRPC extensions, reverse proxies, and more) and
in `docs/upstream/README.md`.
## Development
```sh
cargo build --release # build the relay
cargo test # unit + integration tests
```
The integration tests stand up real relays on loopback and cover the
whitelist end to end (allowed kind accepted, disallowed kind rejected),
the name authority round trip (register, resolve, reverse lookup,
conflicts, reserved names, release, cooldown), the paid-name flow
against a stub GoblinPay server, and the payment-free NIP-11 rule.
## License
MIT, same as upstream. The upstream relay is by Greg Heartsfield and
contributors; the Floonet additions are by the Floonet developers.
🤖 Built with AI pair-programming assistance (Claude)
assets/floonet-logo.svg
+1
View File
File diff suppressed because one or more lines are too long
Side by Side

After

Width:  |  Height:  |  Size: 17 KiB

build.rs
+7
View File
@@ -0,0 +1,7 @@
fn main() -> Result<(), Box<dyn std::error::Error>> {
tonic_build::configure()
.build_server(false)
.protoc_arg("--experimental_allow_proto3_optional")
.compile(&["proto/nauthz.proto"], &["proto"])?;
Ok(())
}
config.toml
+221
View File
@@ -0,0 +1,221 @@
# floonet-rs relay configuration.
#
# Every setting shown commented-out is the built-in default. The shipped
# defaults give you a hardened Floonet relay: a default-deny event kind
# whitelist, neutral public metadata, and everything paid switched off.
[info]
# The advertised URL for the Nostr websocket. Set this to your public
# wss:// address; NIP-42 auth validates against it.
relay_url = "wss://relay.example.com/"
# Relay information for clients (NIP-11). Keep these neutral: the public
# relay metadata says nothing about payments, by design.
name = "floonet-rs-relay"
description = "A Floonet relay for the Grin community Nostr network."
# Administrative contact pubkey (32-byte hex, not npub)
#pubkey = "0c2d168a4ae8ca58c9f1ab237b5df682599c6c7ab74307ea8b05684b60405d41"
# Administrative contact URI
#contact = "mailto:contact@example.com"
# Favicon location, relative to the current directory (ICO format).
#favicon = "favicon.ico"
# URL of the relay's icon.
#relay_icon = "https://example.com/img.png"
# Path to a custom relay html landing page. When unset, the relay serves
# a neutral Floonet page with the Floonet logo.
#relay_page = "index.html"
[database]
# Database engine (sqlite/postgres). Defaults to sqlite. The built-in
# name authority requires sqlite.
#engine = "sqlite"
# Directory for SQLite files.
data_directory = "/var/lib/floonet-rs"
# Database connection pool settings for subscribers:
#min_conn = 0
#max_conn = 8
[logging]
# Directory to store log files. Log files roll over daily.
#folder_path = "./log"
#file_prefix = "floonet-rs"
[grpc]
# gRPC extension point for externalized event admission (see
# proto/nauthz.proto). Optional; the built-in admission layer already
# enforces the kind whitelist and auth policies.
#event_admission_server = "http://[::1]:50051"
#restricts_write = true
[network]
# Bind to this network address. Keep loopback and put a reverse proxy
# (Caddy/nginx) in front for TLS; see deploy/Caddyfile.
address = "127.0.0.1"
# Listen on this port
port = 8080
# Read the real client IP from this header. LOAD-BEARING behind a
# reverse proxy: per-IP rate limits key off it.
remote_ip_header = "x-real-ip"
[options]
# Reject events with timestamps too far in the future, in seconds.
reject_future_seconds = 1800
[limits]
# Limit events created per second (server-wide, averaged over a minute).
messages_per_sec = 5
# Limit client subscriptions created per minute.
subscriptions_per_min = 30
# Maximum size of an EVENT message in bytes. Keep this large enough for
# gift-wrapped payloads (the default 256 KB is safe).
#max_event_bytes = 262144
# THE KEYSTONE: default-deny event kind whitelist. The relay accepts
# ONLY these kinds and rejects everything else. Removing the line
# entirely keeps this exact built-in set (never allow-all); an empty
# list denies everything.
#
# 0 profile metadata
# 3 contacts
# 5 delete (NIP-09)
# 13 seal
# 1059 gift wrap (NIP-59)
# 10002 relay list (NIP-65)
# 10050 DM relays (NIP-17)
# 27235 HTTP auth (NIP-98, used by the name authority)
event_kind_allowlist = [0, 3, 5, 13, 1059, 10002, 10050, 27235]
# Rejects imprecise requests (kind-only or author-only scrapes).
limit_scrapers = false
[authorization]
# Restrict event publishing to these authors (32-byte hex pubkeys).
#pubkey_whitelist = [
# "35d26e4690cbe1a898af61cc3515661eb5fa763b57bd0b42e45099c8b32fd50f",
#]
# Enable NIP-42 authentication (the relay sends an AUTH challenge).
#nip42_auth = false
# Send gift wraps and DMs only to their authenticated recipients.
#nip42_dms = false
# With nip42_auth on, refuse writes from clients that have not
# completed AUTH (they receive an `auth-required:` OK message).
#require_auth_to_write = false
[goblinpay]
# Charge GRIN for relay uses via a GoblinPay server. Modes:
# "off" everything is free (default)
# "name" claiming a name at the built-in name authority requires a
# confirmed Grin payment
# "write" publishing events requires a paid admission
# The same keys are readable from the environment instead:
# FLOONET_PAY_MODE, FLOONET_GOBLINPAY_URL, FLOONET_GOBLINPAY_TOKEN,
# FLOONET_NAME_PRICE_GRIN.
#pay_mode = "off"
# Your GoblinPay server and its API token (GP_API_TOKEN). Keep this file
# unreadable to other users (chmod 0600) when a token is set, or pass
# the token via FLOONET_GOBLINPAY_TOKEN.
#url = "https://pay.example.com"
#api_token = ""
# Prices in GRIN, editable any time.
#name_price_grin = 1.0
#admission_price_grin = 1.0
[name_authority]
# The built-in name authority: name@domain NIP-05 identities with
# NIP-98 authenticated self-service registration, served on this relay's
# own listener (/.well-known/nostr.json and /api/v1/*).
#enabled = false
# The bare host names live under (the `@domain` part) and the public
# base URL clients reach. base_url is LOAD-BEARING: NIP-98 auth events
# are verified against it, so it must be https:// and match what
# clients actually use.
#domain = "example.com"
#base_url = "https://example.com"
# Relays advertised in /.well-known/nostr.json. Defaults to this
# relay's own relay_url.
#relays = ["wss://relay.example.com"]
# Name policy.
#name_min = 3
#name_max = 20
#name_change_cooldown_secs = 600
# NIP-98 freshness bound in seconds (with one-time-use replay guard).
#auth_max_age_secs = 60
# Per-IP rate limits (requests per window, window in seconds).
#read_rate_max = 120
#read_rate_window_secs = 60
#write_rate_max = 10
#write_rate_window_secs = 3600
# Optional file of extra reserved names (one per line, # comments).
# The built-in generic list and your own domain labels are always
# reserved, including digit/separator look-alikes.
#reserved_file = "/etc/floonet-rs/reserved"
[exit]
# Co-located mixnet exit. When enabled the relay runs the bundled
# floonet-mixexit binary next to itself: an ordinary unbonded mixnet
# client that forwards every accepted stream to ONE fixed upstream (your
# relay), never a caller-chosen target, so it is structurally not an
# open proxy. Wallets can then reach this relay over the mixnet with no
# public DNS on the payment path; they fall back to the public mixnet
# route when the exit is down.
#enabled = false
# Path to the bundled floonet-mixexit binary.
#binary = "/usr/local/bin/floonet-mixexit"
# Data dir for the persistent mixnet identity. The exit's STABLE mixnet
# address is printed at startup and written to <data_dir>/nym_address.txt;
# publish it (for example in the Floonet relay pool `exit` field) so
# wallets can prefer this exit. Back the directory up: losing it rotates
# the address.
#data_dir = "/var/lib/floonet-rs/mixexit"
# Upstream the exit pipes every stream to. Point it at your PUBLIC TLS
# endpoint so wallets get your real certificate through the mixnet.
# Empty means this relay's local listener (no TLS).
#upstream = "relay.example.com:443"
[verified_users]
# NIP-05 verification of users (upstream feature; the built-in name
# authority is separate). "enabled" enforces, "passive" observes,
# "disabled" does nothing.
#mode = "disabled"
[pay_to_relay]
# Upstream pay-to-relay admission. You normally do NOT edit this
# section: setting goblinpay.pay_mode = "write" configures it for
# GoblinPay automatically. It remains available for operators who want
# the upstream Lightning processors instead.
#enabled = false
#processor = "GoblinPay"
#admission_cost = 1000000000
#cost_per_event = 0
#node_url = ""
#api_secret = ""
#sign_ups = false
#direct_message = false
#terms_message = """
#Use this relay lawfully and without abuse.
#"""
deploy/Caddyfile
+19
View File
@@ -0,0 +1,19 @@
# Caddy reverse proxy for floonet-rs, with automatic HTTPS.
#
# floonet-rs serves everything on one port: the websocket relay, the
# NIP-11 document, the landing page, and (when enabled) the name
# authority endpoints. Point your domain at this host and Caddy obtains
# certificates automatically.
#
# SECURITY-CRITICAL: X-Real-IP must be set from the real client address.
# The relay and the name authority key ALL of their per-IP rate limiting
# off this header (config.toml `remote_ip_header = "x-real-ip"`); if the
# proxy does not set it, every request looks like one client and the
# limiter is defeated. Caddy's {remote_host} is the connecting peer, not
# a forwardable client header.
relay.example.com {
reverse_proxy 127.0.0.1:8080 {
header_up X-Real-IP {remote_host}
}
}
deploy/Caddyfile.compose
+11
View File
@@ -0,0 +1,11 @@
# Caddyfile used by docker-compose.yml. The upstream is the compose
# service name `relay`; FLOONET_DOMAIN is injected from .env.
#
# SECURITY-CRITICAL: X-Real-IP is set from the real client address; the
# relay and name authority key their per-IP rate limiting off it.
{$FLOONET_DOMAIN} {
reverse_proxy relay:8080 {
header_up X-Real-IP {remote_host}
}
}
deploy/floonet-rs.service
+65
View File
@@ -0,0 +1,65 @@
# Hardened systemd unit for floonet-rs on bare metal.
#
# Install (or just run deploy/install.sh):
# sudo install -m0755 floonet-rs /usr/local/bin/
# sudo install -m0755 floonet-mixexit /usr/local/bin/ # optional, mixnet exit
# sudo install -d -m0755 /etc/floonet-rs
# sudo install -m0600 config.toml /etc/floonet-rs/config.toml
# sudo install -m0644 deploy/floonet-rs.service /etc/systemd/system/
# sudo systemctl daemon-reload && sudo systemctl enable --now floonet-rs
#
# The service is locked down: dynamic unprivileged user, read-only
# system, no new privileges; only its state directory is writable.
[Unit]
Description=floonet-rs relay (Floonet relay for the Grin community Nostr network)
After=network-online.target
Wants=network-online.target
[Service]
Type=exec
# DynamicUser allocates a throwaway unprivileged user at runtime. If you
# need a stable owner for the data dir, comment this out and set
# `User=floonet` (create the user first).
DynamicUser=yes
# Managed state at /var/lib/floonet-rs (created and chowned by systemd).
# config.toml's data_directory and exit.data_dir point inside it.
StateDirectory=floonet-rs
StateDirectoryMode=0750
# Optional environment overrides (paid mode without editing config.toml):
# FLOONET_PAY_MODE, FLOONET_GOBLINPAY_URL, FLOONET_GOBLINPAY_TOKEN,
# FLOONET_NAME_PRICE_GRIN. Keep the file 0600 when it holds a token.
#EnvironmentFile=-/etc/floonet-rs/env
ExecStart=/usr/local/bin/floonet-rs --config /etc/floonet-rs/config.toml
Restart=on-failure
RestartSec=2
# --- hardening ---
NoNewPrivileges=yes
ProtectSystem=strict
ProtectHome=yes
PrivateTmp=yes
PrivateDevices=yes
ProtectKernelTunables=yes
ProtectKernelModules=yes
ProtectControlGroups=yes
ProtectClock=yes
ProtectHostname=yes
RestrictNamespaces=yes
RestrictRealtime=yes
RestrictSUIDSGID=yes
LockPersonality=yes
MemoryDenyWriteExecute=yes
SystemCallArchitectures=native
SystemCallFilter=@system-service
SystemCallFilter=~@privileged @resources
# Only the state directory is writable.
ReadWritePaths=/var/lib/floonet-rs
# No raw sockets; only IP (and unix for the database).
RestrictAddressFamilies=AF_INET AF_INET6 AF_UNIX
[Install]
WantedBy=multi-user.target
deploy/install.sh
Executable
+71
View File
@@ -0,0 +1,71 @@
#!/bin/sh
# floonet-rs installer: drops the binary, config, and hardened systemd
# unit. No toolchain needed when run from an unpacked release archive.
#
# Usage:
# sudo sh deploy/install.sh
#
# Looks for the binaries next to this script's parent directory in this
# order: ./floonet-rs (release archive layout), then
# target/release/floonet-rs (source build layout). The optional
# floonet-mixexit binary is installed the same way when present.
#
# Idempotent: re-running upgrades the binaries and unit but never
# overwrites an existing /etc/floonet-rs/config.toml.
set -eu
if [ "$(id -u)" -ne 0 ]; then
echo "error: run as root (sudo sh deploy/install.sh)" >&2
exit 1
fi
here="$(cd "$(dirname "$0")/.." && pwd)"
find_binary() {
name="$1"
for candidate in "$here/$name" "$here/target/release/$name"; do
if [ -x "$candidate" ]; then
echo "$candidate"
return 0
fi
done
return 1
}
relay_bin="$(find_binary floonet-rs)" || {
echo "error: floonet-rs binary not found; build it first (cargo build --release)" >&2
exit 1
}
echo "installing $relay_bin -> /usr/local/bin/floonet-rs"
install -m0755 "$relay_bin" /usr/local/bin/floonet-rs
if exit_bin="$(find_binary floonet-mixexit)"; then
echo "installing $exit_bin -> /usr/local/bin/floonet-mixexit"
install -m0755 "$exit_bin" /usr/local/bin/floonet-mixexit
else
echo "note: floonet-mixexit binary not found; skipping (the mixnet exit"
echo " toggle needs it; see mixexit/README section in README.md)"
fi
install -d -m0755 /etc/floonet-rs
if [ ! -f /etc/floonet-rs/config.toml ]; then
echo "installing default config -> /etc/floonet-rs/config.toml"
install -m0600 "$here/config.toml" /etc/floonet-rs/config.toml
echo ">>> EDIT /etc/floonet-rs/config.toml: set info.relay_url at minimum."
else
echo "keeping existing /etc/floonet-rs/config.toml"
fi
echo "installing systemd unit -> /etc/systemd/system/floonet-rs.service"
install -m0644 "$here/deploy/floonet-rs.service" /etc/systemd/system/floonet-rs.service
systemctl daemon-reload
systemctl enable floonet-rs
echo
echo "done. next steps:"
echo " 1. edit /etc/floonet-rs/config.toml (relay_url, and optionally"
echo " the name authority, paid mode, and mixnet exit sections)"
echo " 2. put a TLS proxy in front (see deploy/Caddyfile)"
echo " 3. systemctl start floonet-rs && journalctl -fu floonet-rs"
docker-compose.yml
+48
View File
@@ -0,0 +1,48 @@
# One-command deploy: the relay plus a Caddy TLS proxy.
#
# 1. cp config.toml my-config.toml
# edit: info.relay_url, and set [network] address = "0.0.0.0"
# (Caddy reaches the relay over the compose network)
# 2. echo 'FLOONET_DOMAIN=relay.example.com' > .env
# 3. docker compose up -d
#
# The relay container runs as a non-root user with a read-only root
# filesystem; only the data volume is writable. Caddy terminates TLS and
# forwards the real client IP in X-Real-IP (load-bearing for the per-IP
# rate limits).
services:
relay:
build: .
restart: unless-stopped
read_only: true
volumes:
- relay-data:/usr/src/app/db
- ./my-config.toml:/usr/src/app/config.toml:ro
environment:
RUST_LOG: warn,floonet_rs=info
# Paid mode without baking secrets into the config file:
# FLOONET_PAY_MODE: "name"
# FLOONET_GOBLINPAY_URL: "https://pay.example.com"
# FLOONET_GOBLINPAY_TOKEN: "..."
# FLOONET_NAME_PRICE_GRIN: "1.0"
expose:
- "8080"
caddy:
image: caddy:2-alpine
restart: unless-stopped
environment:
FLOONET_DOMAIN: ${FLOONET_DOMAIN:?set FLOONET_DOMAIN in .env}
ports:
- "80:80"
- "443:443"
volumes:
- ./deploy/Caddyfile.compose:/etc/caddy/Caddyfile:ro
- caddy-data:/data
- caddy-config:/config
volumes:
relay-data:
caddy-data:
caddy-config:
docs/database-maintenance.md
+129
View File
@@ -0,0 +1,129 @@
# Database Maintenance
`nostr-rs-relay` uses the SQLite embedded database to minimize
dependencies and overall footprint of running a relay. If traffic is
light, the relay should just run with very little need for
intervention. For heavily trafficked relays, there are a number of
steps that the operator may need to take to maintain performance and
limit disk usage.
This maintenance guide is current as of version `0.8.2`. Future
versions may incorporate and automate some of these steps.
## Backing Up the Database
To prevent data loss, the database should be backed up regularly. The
recommended method is to use the `sqlite3` command to perform an
"Online Backup". This can be done while the relay is running, queries
can still run and events will be persisted during the backup.
The following commands will perform a backup of the database to a
dated file, and then compress to minimize size:
```console
BACKUP_FILE=/var/backups/nostr/`date +%Y%m%d_%H%M`.db
sqlite3 -readonly /apps/nostr-relay/nostr.db ".backup $BACKUP_FILE"
sqlite3 $BACKUP_FILE "vacuum;"
bzip2 -9 $BACKUP_FILE
```
Nostr events are very compressible. Expect a compression ratio on the
order of 4:1, resulting in a 75% space saving.
## Vacuuming the Database
As the database is updated, it can become fragmented. Performing a
full `vacuum` will rebuild the entire database file, and can reduce
space. Running this may reduce the size of the database file,
especially if a large amount of data was updated or deleted.
```console
vacuum;
```
## Clearing Hidden Events
When events are deleted, the event is not actually removed from the
database. Instead, a flag `HIDDEN` is set to true for the event,
which excludes it from search results. High volume replacements from
profile or other replaceable events are deleted, not hidden, in the
current version of the relay.
In the current version, removing hidden events should not result in
significant space savings, but it can still be used if there is no
desire to hold on to events that can never be re-broadcast.
```console
PRAGMA foreign_keys = ON;
delete from event where HIDDEN=true;
```
## Manually Removing Events
For a variety of reasons, an operator may wish to remove some events
from the database. The only way of achieving this today is with
manually run SQL commands.
It is recommended to have a good backup prior to manually running SQL
commands!
In all cases, it is mandatory to enable foreign keys, and this must be
done for every connection. Otherwise, you will likely orphan rows in
the `tag` table.
### Deleting Specific Event
```console
PRAGMA foreign_keys = ON;
delete from event where event_hash=x'00000000000c1271675dc86e3e1dd1336827bccabb90dc4c9d3b4465efefe00e';
```
### Querying and Deleting All Events for Pubkey
```console
PRAGMA foreign_keys = ON;
select lower(hex(author)) as author, count(*) as c from event group by author order by c asc;
delete from event where author=x'000000000002c7831d9c5a99f183afc2813a6f69a16edda7f6fc0ed8110566e6';
```
### Querying and Deleting All Events of a Kind
```console
PRAGMA foreign_keys = ON;
select printf('%7d', kind), count(*) as c from event group by kind order by c;
delete from event where kind=70202;
```
### Deleting Old Events
In this scenario, we wish to delete any event that has been stored by
our relay for more than 1 month. Crucially, this is based on when the
event was stored, not when the event says it was created. If an event
has a `created` field of 2 years ago, but was first sent to our relay
yesterday, it would not be deleted in this scenario. Keep in mind, we
do not track anything for re-broadcast events that we already have, so
this is not a very effective way of implementing a "least recently
seen" policy.
```console
PRAGMA foreign_keys = ON;
DELETE FROM event WHERE first_seen < CAST(strftime('%s', date('now', '-30 day')) AS INT);
```
### Delete Profile Events with No Recent Events
Many users create profiles, post a "hello world" event, and then never
appear again (likely using an ephemeral keypair that was lost in the
browser cache). We can find these accounts and remove them after some
time.
```console
PRAGMA foreign_keys = ON;
TODO!
```
docs/grpc-extensions.md
+79
View File
@@ -0,0 +1,79 @@
# gRPC Extensions Design Document
The relay will be extensible through gRPC endpoints, definable in the
main configuration file. These will allow external programs to host
logic for deciding things such as, should this event be persisted,
should this connection be allowed, and should this subscription
request be registered. The primary goal is allow for relay operator
specific functionality that allows them to serve smaller communities
and reduce spam and abuse.
This will likely evolve substantially, the first goal is to get a
basic one-way service that lets an externalized program decide on
event persistence. This does not represent the final state of gRPC
extensibility in `nostr-rs-relay`.
## Considerations
Write event latency must not be significantly affected. However, the
primary reason we are implementing this is spam/abuse protection, so
we are willing to tolerate some increase in latency if that protects
us against outages!
The interface should provide enough information to make simple
decisions, without burdening the relay to do extra queries. The
decision endpoint will be mostly responsible for maintaining state and
gathering additional details.
## Design Overview
A gRPC server may be defined in the `config.toml` file. If it exists,
the relay will attempt to connect to it and send a message for each
`EVENT` command submitted by clients. If a successful response is
returned indicating the event is permitted, the relay continues
processing the event as normal. All existing whitelist, blacklist,
and `NIP-05` validation checks are still performed and MAY still
result in the event being rejected. If a successful response is
returned indicated the decision is anything other than permit, then
the relay MUST reject the event, and return a command result to the
user (using `NIP-20`) indicating the event was blocked (optionally
providing a message).
In the event there is an error in the gRPC interface, event processing
proceeds as if gRPC was disabled (fail open). This allows gRPC
servers to be deployed with minimal chance of causing a full relay
outage.
## Design Details
Currently one procedure call is supported, `EventAdmit`, in the
`Authorization` service. It accepts the following data in order to
support authorization decisions:
- The event itself
- The client IP that submitted the event
- The client's HTTP origin header, if one exists
- The client's HTTP user agent header, if one exists
- The public key of the client, if `NIP-42` authentication was
performed (not supported in the relay yet!)
- The `NIP-05` associated with the event's public key, if it is known
to the relay
A server providing authorization decisions will return the following:
- A decision to permit or deny the event
- An optional message that explains why the event was denied, to be
transmitted to the client
## Security Issues
There is little attempt to secure this interface, since it is intended
for use processes running on the same host. It is recommended to
ensure that the gRPC server providing the API is not exposed to the
public Internet. Authorization server implementations should have
their own security reviews performed.
A slow gRPC server could cause availability issues for event
processing, since this is performed on a single thread. Avoid any
expensive or long-running processes that could result from submitted
events, since any client can initiate a gRPC call to the service.
docs/pay-to-relay.md
+84
View File
@@ -0,0 +1,84 @@
# Pay to Relay Design Document
The relay with use payment as a form of spam prevention. In order to post to the relay a user must pay a set rate. There is also the option to require a payment for each note posted to the relay. There is no cost to read from the relay.
## Configuration
Currently, [LNBits](https://github.com/lnbits/lnbits) is implemented as the payment processor. LNBits exposes a simple API for creating invoices, to use this API create a wallet and on the right side find "API info" you will need to add the invoice/read key to this relays config file.
The below configuration will need to be added to config.toml
```
[pay_to_relay]
# Enable pay to relay
enabled = true
# The cost to be admitted to relay
admission_cost = 1000
# The cost in sats per post
cost_per_event = 0
# Url of lnbits api
node_url = "https://<IP of node>:5001/api/v1/payments"
# LNBits api secret
api_secret = "<LNbits api key>"
# Terms of service
terms_message = """This service ....
"""
# Whether or not new sign ups should be allowed
sign_ups = true
secret_key = "<nostr secret key to send dms>"
```
The LNBits instance must have a signed HTTPS a self signed certificate will not work.
## Design Overview
### Concepts
All authors are initially not admitted to write to the relay. There are two ways to gain access write to the relay. The first is by attempting to post the the relay, upon receiving an event from an author that is not admitted, the relay will send a direct message including the terms of service of the relay and a lighting invoice for the admission cost. Once this invoice is paid the author can write to the relay. For this method to work the author must be reading from the relay. An author can also pay and accept the terms of service via a webpage `https://<relay-url>/join`.
## Design Details
Authors are stored in a dedicated table. This tracks:
* `pubkey`
* `is_admitted` whether on no the admission invoice has been paid, accepting the terms of service.
* `balance` the current balance in sats of the author, used if there is a cost per post
* `tos_accepted_at` the timestamp of when the author accepted the tos
Invoice information is stored in a dedicated table. This tracks:
* `payment_hash` the payment hash of the lighting invoice
* `pubkey` of the author the invoice is issued to
* `invoice` bolt11 invoice
* `amount` in sats
* `status` (Paid/Unpaid/Expired)
* `description`
* `created_at` timestamp of creation
* `confirmed_at` timestamp of payment
### Event Handling
If "pay to relay" is enabled, all incoming events are evaluated to determine whether the author is on the relay's whitelist or if they have paid the admission fee and accepted the terms. If "pay per note" is enabled, there is an additional check to ensure that the author has enough balance, which is then reduced by the cost per note. If the author is on the whitelist, this balance check is not necessary.
### Integration
We have an existing database writer thread, which receives events and
attempts to persist them to disk. Once validated and persisted, these
events are broadcast to all subscribers.
When "pay to relay" is enabled, the writer must check if the author is admitted to post. If the author is not admitted to post the event is forwarded to the payment module. Where an invoice is generated, persisted and broadcast as an direct message to the author.
### Threat Scenarios
Some of these mitigation's are fully implemented, others are documented
simply to demonstrate a mitigation is possible.
### Sign up Spamming
*Threat*: An attacker generates a large number of new pubkeys publishing to the relays. Causing a large number of new invoices to be created for each new pubkey.
*Mitigation*: Rate limit number of new sign ups
### Admitted Author Spamming
*Threat*: An attacker gains write access by paying the admission fee, and then floods the relay with a large number of spam events.
*Mitigation*: The attacker's admission can be revoked and their admission fee will not be refunded. Enabling "cost per event" and increasing the admission cost can also discourage this type of behavior.
docs/reverse-proxy.md
+199
View File
@@ -0,0 +1,199 @@
# Reverse Proxy Setup Guide
It is recommended to run `nostr-rs-relay` behind a reverse proxy such
as `haproxy`, `nginx` or `traefik` to provide TLS termination. Simple examples
for `haproxy`, `nginx` and `traefik` configurations are documented here.
## Minimal HAProxy Configuration
Assumptions:
* HAProxy version is `2.4.10` or greater (older versions not tested).
* Hostname for the relay is `relay.example.com`.
* Your relay should be available over wss://relay.example.com
* Your (NIP-11) relay info page should be available on https://relay.example.com
* SSL certificate is located in `/etc/certs/example.com.pem`.
* Relay is running on port 8080.
* Limit connections to 400 concurrent.
* HSTS (HTTP Strict Transport Security) is desired.
* Only TLS 1.2 or greater is allowed.
```
global
ssl-default-bind-ciphersuites TLS_AES_128_GCM_SHA256:TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256
ssl-default-bind-options prefer-client-ciphers no-sslv3 no-tlsv10 no-tlsv11 no-tls-tickets
frontend fe_prod
mode http
bind :443 ssl crt /etc/certs/example.com.pem alpn h2,http/1.1
bind :80
http-request set-header X-Forwarded-Proto https if { ssl_fc }
redirect scheme https code 301 if !{ ssl_fc }
acl host_relay hdr(host) -i -m beg relay.example.com
use_backend relay if host_relay
# HSTS (1 year)
http-response set-header Strict-Transport-Security max-age=31536000
backend relay
mode http
timeout connect 5s
timeout client 50s
timeout server 50s
timeout tunnel 1h
timeout client-fin 30s
option tcp-check
default-server maxconn 400 check inter 20s fastinter 1s
server relay 127.0.0.1:8080
```
### HAProxy Notes
You may experience WebSocket connection problems with Firefox if
HTTP/2 is enabled, for older versions of HAProxy (2.3.x). Either
disable HTTP/2 (`h2`), or upgrade HAProxy.
## Bare-bones Nginx Configuration
Assumptions:
* `Nginx` version is `1.18.0` (other versions not tested).
* Hostname for the relay is `relay.example.com`.
* SSL certificate and key are located at `/etc/letsencrypt/live/relay.example.com/`.
* Relay is running on port `8080`.
```
http {
server {
listen 443 ssl;
server_name relay.example.com;
ssl_certificate /etc/letsencrypt/live/relay.example.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/relay.example.com/privkey.pem;
ssl_protocols TLSv1.3 TLSv1.2;
ssl_prefer_server_ciphers on;
ssl_ecdh_curve secp521r1:secp384r1;
ssl_ciphers EECDH+AESGCM:EECDH+AES256;
# Optional Diffie-Helmann parameters
# Generate with openssl dhparam -out /etc/ssl/certs/dhparam.pem 4096
#ssl_dhparam /etc/ssl/certs/dhparam.pem;
ssl_session_cache shared:TLS:2m;
ssl_buffer_size 4k;
# OCSP stapling
ssl_stapling on;
ssl_stapling_verify on;
resolver 1.1.1.1 1.0.0.1 [2606:4700:4700::1111] [2606:4700:4700::1001]; # Cloudflare
# Set HSTS to 365 days
add_header Strict-Transport-Security 'max-age=31536000; includeSubDomains; preload' always;
keepalive_timeout 70;
location / {
proxy_pass http://localhost:8080;
proxy_http_version 1.1;
proxy_read_timeout 1d;
proxy_send_timeout 1d;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "Upgrade";
proxy_set_header Host $host;
}
}
}
```
### Nginx Notes
The above configuration was tested on `nginx` `1.18.0` on `Ubuntu` `20.04` and `22.04`
For help installing `nginx` on `Ubuntu`, see [this guide](https://www.digitalocean.com/community/tutorials/how-to-install-nginx-on-ubuntu-20-04).
For guidance on using `letsencrypt` to obtain a cert on `Ubuntu`, including an `nginx` plugin, see [this post](https://www.digitalocean.com/community/tutorials/how-to-secure-nginx-with-let-s-encrypt-on-ubuntu-20-04).
## Example Traefik Configuration
Assumptions:
* `Traefik` version is `2.9` (other versions not tested).
* `Traefik` is used for provisioning of Let's Encrypt certificates.
* `Traefik` is running in `Docker`, using `docker compose` and labels for the static configuration. An equivalent setup using a Traefik config file is possible too (but not covered here).
* Strict Transport Security is enabled.
* Hostname for the relay is `relay.example.com`, email address for ACME certificates provider is `name@example.com`.
* ipv6 is enabled, a viable private ipv6 subnet is specified in the example below.
* Relay is running on port `8080`.
```
version: '3'
networks:
nostr:
enable_ipv6: true
ipam:
config:
- subnet: fd00:db8:a::/64
gateway: fd00:db8:a::1
services:
traefik:
image: traefik:v2.9
networks:
nostr:
command:
- "--log.level=ERROR"
# letsencrypt configuration
- "--certificatesResolvers.http.acme.email==name@example.com"
- "--certificatesResolvers.http.acme.storage=/certs/acme.json"
- "--certificatesResolvers.http.acme.httpChallenge.entryPoint=http"
# define entrypoints
- "--entryPoints.http.address=:80"
- "--entryPoints.http.http.redirections.entryPoint.to=https"
- "--entryPoints.http.http.redirections.entryPoint.scheme=https"
- "--entryPoints.https.address=:443"
- "--entryPoints.https.forwardedHeaders.insecure=true"
- "--entryPoints.https.proxyProtocol.insecure=true"
# docker provider (get configuration from container labels)
- "--providers.docker.endpoint=unix:///var/run/docker.sock"
- "--providers.docker.exposedByDefault=false"
- "--providers.file.directory=/config"
- "--providers.file.watch=true"
ports:
- "80:80"
- "443:443"
volumes:
- "/var/run/docker.sock:/var/run/docker.sock:ro"
- "$(pwd)/traefik/certs:/certs"
- "$(pwd)/traefik/config:/config"
logging:
driver: "local"
restart: always
# example nostr config. only labels: section is relevant for Traefik config
nostr:
image: nostr-rs-relay:latest
container_name: nostr-relay
networks:
nostr:
restart: always
user: 100:100
volumes:
- '$(pwd)/nostr/data:/usr/src/app/db:Z'
- '$(pwd)/nostr/config/config.toml:/usr/src/app/config.toml:ro,Z'
labels:
- "traefik.enable=true"
- "traefik.http.routers.nostr.entrypoints=https"
- "traefik.http.routers.nostr.rule=Host(`relay.example.com`)"
- "traefik.http.routers.nostr.tls.certresolver=http"
- "traefik.http.routers.nostr.service=nostr"
- "traefik.http.services.nostr.loadbalancer.server.port=8080"
- "traefik.http.services.nostr.loadbalancer.passHostHeader=true"
- "traefik.http.middlewares.nostr.headers.sslredirect=true"
- "traefik.http.middlewares.nostr.headers.stsincludesubdomains=true"
- "traefik.http.middlewares.nostr.headers.stspreload=true"
- "traefik.http.middlewares.nostr.headers.stsseconds=63072000"
- "traefik.http.routers.nostr.middlewares=nostr"
```
### Traefik Notes
Traefik will take care of the provisioning and renewal of certificates. In case of an ipv4-only relay, simply detele the `enable_ipv6:` and `ipam:` entries in the `networks:` section of the docker-compose file.
docs/run-as-linux-system-process.md
+40
View File
@@ -0,0 +1,40 @@
# Run as a linux system process
Docker makes it easy to spin up and down environments but it's also possible to run `nostr-rs-relay` as a systemd linux process.
This guide assumes you're on a Linux machine and that Rust is already installed.
## Instructions
### Build nostr-rs-relay from source
Start by building the application from source. Here is how to do that:
1. `git clone https://github.com/scsibug/nostr-rs-relay.git`
2. `cd nostr-rs-relay`
3. `cargo build --release`
### Place the files where they belong
We want to place the nostr-rs-relay binary and the config.toml file where they belong. While still in the root level of the nostr-rs-relay folder you cloned in last step, run the following commands:
1. `sudo cp target/release/nostr-rs-relay /usr/local/bin/`
2. `sudo mkdir /etc/nostr-rs-relay`
2. `sudo cp config.toml /etc/nostr-rs-relay`
### Create the Systemd service file
We need to create a new Systemd service file. These files are placed in the `/etc/systemd/system/` folder where you will find many other services running.
1. `sudo vim /etc/systemd/system/nostr-rs-relay.service`
2. Paste in the contents of [this service file](../contrib/nostr-rs-relay.service). Remember to replace the `User` value with your own username.
3. Save the file and exit your text editor
### Run the service
To get the service running, we need to reload the systemd daemon and enable the service.
1. `sudo systemctl daemon-reload`
2. `sudo systemctl start nostr-rs-relay.service`
3. `sudo systemctl enable nostr-rs-relay.service`
4. `sudo systemctl status nostr-rs-relay.service`
### Tips
#### Logs
The application will write logs to the journal. To read it, execute `sudo journalctl -f -u nostr-rs-relay`
docs/upstream/README.md
+170
View File
@@ -0,0 +1,170 @@
# [nostr-rs-relay](https://git.sr.ht/~gheartsfield/nostr-rs-relay)
This is a [nostr](https://github.com/nostr-protocol/nostr) relay,
written in Rust. It currently supports the entire relay protocol, and
persists data with SQLite. There is experimental support for
Postgresql.
The project master repository is available on
[sourcehut](https://sr.ht/~gheartsfield/nostr-rs-relay/), and is
mirrored on [GitHub](https://github.com/scsibug/nostr-rs-relay).
[![builds.sr.ht status](https://builds.sr.ht/~gheartsfield/nostr-rs-relay/commits/master.svg)](https://builds.sr.ht/~gheartsfield/nostr-rs-relay/commits/master?)
![Github CI](https://github.com/scsibug/nostr-rs-relay/actions/workflows/ci.yml/badge.svg)
## Features
[NIPs](https://github.com/nostr-protocol/nips) with a relay-specific implementation are listed here.
- [x] NIP-01: [Basic protocol flow description](https://github.com/nostr-protocol/nips/blob/master/01.md)
* Core event model
* Hide old metadata events
* Id/Author prefix search
- [x] NIP-02: [Contact List and Petnames](https://github.com/nostr-protocol/nips/blob/master/02.md)
- [ ] NIP-03: [OpenTimestamps Attestations for Events](https://github.com/nostr-protocol/nips/blob/master/03.md)
- [x] NIP-05: [Mapping Nostr keys to DNS-based internet identifiers](https://github.com/nostr-protocol/nips/blob/master/05.md)
- [x] NIP-09: [Event Deletion](https://github.com/nostr-protocol/nips/blob/master/09.md)
- [x] NIP-11: [Relay Information Document](https://github.com/nostr-protocol/nips/blob/master/11.md)
- [x] NIP-12: [Generic Tag Queries](https://github.com/nostr-protocol/nips/blob/master/12.md)
- [x] NIP-15: [End of Stored Events Notice](https://github.com/nostr-protocol/nips/blob/master/15.md)
- [x] NIP-16: [Event Treatment](https://github.com/nostr-protocol/nips/blob/master/16.md)
- [x] NIP-20: [Command Results](https://github.com/nostr-protocol/nips/blob/master/20.md)
- [x] NIP-22: [Event `created_at` limits](https://github.com/nostr-protocol/nips/blob/master/22.md) (_future-dated events only_)
- [ ] NIP-26: [Event Delegation](https://github.com/nostr-protocol/nips/blob/master/26.md) (_implemented, but currently disabled_)
- [x] NIP-28: [Public Chat](https://github.com/nostr-protocol/nips/blob/master/28.md)
- [x] NIP-33: [Parameterized Replaceable Events](https://github.com/nostr-protocol/nips/blob/master/33.md)
- [x] NIP-40: [Expiration Timestamp](https://github.com/nostr-protocol/nips/blob/master/40.md)
- [x] NIP-42: [Authentication of clients to relays](https://github.com/nostr-protocol/nips/blob/master/42.md)
- [x] NIP-91: [AND operator for filters](https://github.com/nostr-protocol/nips/pull/1365)
## Quick Start
The provided `Dockerfile` will compile and build the server
application. Use a bind mount to store the SQLite database outside of
the container image, and map the container's 8080 port to a host port
(7000 in the example below).
The examples below start a rootless podman container, mapping a local
data directory and config file.
```console
$ podman build --pull -t nostr-rs-relay .
$ mkdir data
$ podman unshare chown 100:100 data
$ podman run -it --rm -p 7000:8080 \
--user=100:100 \
-v $(pwd)/data:/usr/src/app/db:Z \
-v $(pwd)/config.toml:/usr/src/app/config.toml:ro,Z \
--name nostr-relay nostr-rs-relay:latest
Nov 19 15:31:15.013 INFO nostr_rs_relay: Starting up from main
Nov 19 15:31:15.017 INFO nostr_rs_relay::server: listening on: 0.0.0.0:8080
Nov 19 15:31:15.019 INFO nostr_rs_relay::server: db writer created
Nov 19 15:31:15.019 INFO nostr_rs_relay::server: control message listener started
Nov 19 15:31:15.019 INFO nostr_rs_relay::db: Built a connection pool "event writer" (min=1, max=4)
Nov 19 15:31:15.019 INFO nostr_rs_relay::db: opened database "/usr/src/app/db/nostr.db" for writing
Nov 19 15:31:15.019 INFO nostr_rs_relay::schema: DB version = 0
Nov 19 15:31:15.054 INFO nostr_rs_relay::schema: database pragma/schema initialized to v7, and ready
Nov 19 15:31:15.054 INFO nostr_rs_relay::schema: All migration scripts completed successfully. Welcome to v7.
Nov 19 15:31:15.521 INFO nostr_rs_relay::db: Built a connection pool "client query" (min=4, max=128)
```
Use a `nostr` client such as
[`noscl`](https://github.com/fiatjaf/noscl) to publish and query
events.
```console
$ noscl publish "hello world"
Sent to 'ws://localhost:8090'.
Seen it on 'ws://localhost:8090'.
$ noscl home
Text Note [81cf...2652] from 296a...9b92 5 seconds ago
hello world
```
A pre-built container is also available on DockerHub:
https://hub.docker.com/r/scsibug/nostr-rs-relay
## Build and Run (without Docker)
Building `nostr-rs-relay` requires an installation of Cargo & Rust: https://www.rust-lang.org/tools/install
The following OS packages will be helpful; on Debian/Ubuntu:
```console
$ sudo apt-get install build-essential cmake protobuf-compiler pkg-config libssl-dev
```
On OpenBSD:
```console
$ doas pkg_add rust protobuf
```
Clone this repository, and then build a release version of the relay:
```console
$ git clone -q https://git.sr.ht/\~gheartsfield/nostr-rs-relay
$ cd nostr-rs-relay
$ cargo build -q -r
```
The relay executable is now located in
`target/release/nostr-rs-relay`. In order to run it with logging
enabled, execute it with the `RUST_LOG` variable set:
```console
$ RUST_LOG=warn,nostr_rs_relay=info ./target/release/nostr-rs-relay
Dec 26 10:31:56.455 INFO nostr_rs_relay: Starting up from main
Dec 26 10:31:56.464 INFO nostr_rs_relay::server: listening on: 0.0.0.0:8080
Dec 26 10:31:56.466 INFO nostr_rs_relay::server: db writer created
Dec 26 10:31:56.466 INFO nostr_rs_relay::db: Built a connection pool "event writer" (min=1, max=2)
Dec 26 10:31:56.466 INFO nostr_rs_relay::db: opened database "./nostr.db" for writing
Dec 26 10:31:56.466 INFO nostr_rs_relay::schema: DB version = 11
Dec 26 10:31:56.467 INFO nostr_rs_relay::db: Built a connection pool "maintenance writer" (min=1, max=2)
Dec 26 10:31:56.467 INFO nostr_rs_relay::server: control message listener started
Dec 26 10:31:56.468 INFO nostr_rs_relay::db: Built a connection pool "client query" (min=4, max=8)
```
You now have a running relay, on port `8080`. Use a `nostr` client or
`websocat` to connect and send/query for events.
## Configuration
The sample [`config.toml`](config.toml) file demonstrates the
configuration available to the relay. This file is optional, but may
be mounted into a docker container like so:
```console
$ docker run -it -p 7000:8080 \
--mount src=$(pwd)/config.toml,target=/usr/src/app/config.toml,type=bind \
--mount src=$(pwd)/data,target=/usr/src/app/db,type=bind \
--mount src=$(pwd)/index.html,target=/usr/src/app/index.html,type=bind \
nostr-rs-relay
```
Options include rate-limiting, event size limits, and network address
settings.
## Reverse Proxy Configuration
For examples of putting the relay behind a reverse proxy (for TLS
termination, load balancing, and other features), see [Reverse
Proxy](docs/reverse-proxy.md).
## Dev Channel
For development discussions, please feel free to use the [sourcehut
mailing list](https://lists.sr.ht/~gheartsfield/nostr-rs-relay-devel).
License
---
This project is MIT licensed.
External Documentation and Links
---
* [BlockChainCaffe's Nostr Relay Setup Guide](https://github.com/BlockChainCaffe/Nostr-Relay-Setup-Guide)
docs/user-verification-nip05.md
+248
View File
@@ -0,0 +1,248 @@
# Author Verification Design Document
The relay will use NIP-05 DNS-based author verification to limit which
authors can publish events to a relay. This document describes how
this feature will operate.
## Considerations
DNS-based author verification is designed to be deployed in relays that
want to prevent spam, so there should be strong protections to prevent
unauthorized authors from persisting data. This includes data needed to
verify new authors.
There should be protections in place to ensure the relay cannot be
used to spam or flood other webservers. Additionally, there should be
protections against server-side request forgery (SSRF).
## Design Overview
### Concepts
All authors are initially "unverified". Unverified authors that submit
appropriate `NIP-05` metadata events become "candidates" for
verification. A candidate author becomes verified when the relay
inspects a kind `0` metadata event for the author with a `nip05` field,
and follows the procedure in `NIP-05` to successfully associate the
author with an internet identifier.
The `NIP-05` procedure verifies an author for a fixed period of time,
configurable by the relay operator. If this "verification expiration
time" (`verify_expiration`) is exceeded without being refreshed, they
are once again unverified.
Verified authors have their status regularly and automatically updated
through scheduled polling to their verified domain, this process is
"re-verification". It is performed based on the configuration setting
`verify_update_frequency`, which defines how long the relay waits
between verification attempts (whether the result was success or
failure).
Authors may change their verification data (the internet identifier from
`NIP-05`) with a new metadata event, which then requires
re-verification. Their old verification remains valid until
expiration.
Performing candidate author verification is a best-effort activity and
may be significantly rate-limited to prevent relays being used to
attack other hosts. Candidate verification (untrusted authors) should
never impact re-verification (trusted authors).
## Operating Modes
The relay may operate in one of three modes. "Disabled" performs no
validation activities, and will never permit or deny events based on
an author's NIP-05 metadata. "Passive" performs NIP-05 validation,
but does not permit or deny events based on the validity or presence
of NIP-05 metadata. "Enabled" will require current and valid NIP-05
metadata for any events to be persisted. "Enabled" mode will
additionally consider domain whitelist/blacklist configuration data to
restrict which author's events are persisted.
## Design Details
### Data Storage
Verification is stored in a dedicated table. This tracks:
* `nip05` identifier
* most recent verification timestamp
* most recent verification failure timestamp
* reference to the metadata event (used for tracking `created_at` and
`pubkey`)
### Event Handling
All events are first validated to ensure the signature is valid.
Incoming events of kind _other_ than metadata (kind `0`) submitted by
clients will be evaluated as follows.
* If the event's author has a current verification, the event is
persisted as normal.
* If the event's author has either no verification, or the
verification is expired, the event is rejected.
If the event is a metadata event, we handle it differently.
We first determine the verification status of the event's pubkey.
* If the event author is unverified, AND the event contains a `nip05`
key, we consider this a verification candidate.
* If the event author is unverified, AND the event does not contain a
`nip05` key, this is not a candidate, and the event is dropped.
* If the event author is verified, AND the event contains a `nip05`
key that is identical to the currently stored value, no special
action is needed.
* If the event author is verified, AND the event contains a different
`nip05` than was previously verified, with a more recent timestamp,
we need to re-verify.
* If the event author is verified, AND the event is missing a `nip05`
key, and the event timestamp is more recent than what was verified,
we do nothing. The current verification will be allowed to expire.
### Candidate Verification
When a candidate verification is requested, a rate limit will be
utilized. If the rate limit is exceeded, new candidate verification
requests will be dropped. In practice, this is implemented by a
size-limited channel that drops events that exceed a threshold.
Candidates are never persisted in the database.
### Re-Verification
Re-verification is straightforward when there has been no change to
the `nip05` key. A new request to the `nip05` domain is performed,
and if successful, the verification timestamp is updated to the
current time. If the request fails due to a timeout or server error,
the failure timestamp is updated instead.
When the the `nip05` key has changed and this event is more recent, we
will create a new verification record, and delete all other records
for the same name.
Regarding creating new records vs. updating: We never update the event
reference or `nip05` identifier in a verification record. Every update
either reset the last failure or last success timestamp.
### Determining Verification Status
In determining if an event is from a verified author, the following
procedure should be used:
Join the verification table with the event table, to provide
verification data alongside the event `created_at` and `pubkey`
metadata. Find the most recent verification record for the author,
based on the `created_at` time.
Reject the record if the success timestamp is not within our
configured expiration time.
Reject records with disallowed domains, based on any whitelists or
blacklists in effect.
If a result remains, the author is treated as verified.
This does give a time window for authors transitioning their verified
status between domains. There may be a period of time in which there
are multiple valid rows in the verification table for a given author.
### Cleaning Up Inactive Verifications
After a author verification has expired, we will continue to check for
it to become valid again. After a configurable number of attempts, we
should simply forget it, and reclaim the space.
### Addition of Domain Whitelist/Blacklist
A set of whitelisted or blacklisted domains may be provided. If both
are provided, only the whitelist is used. In this context, domains
are either "allowed" (present on a whitelist and NOT present on a
blacklist), or "denied" (NOT present on a whitelist and present on a
blacklist).
The processes outlined so far are modified in the presence of these
options:
* Only authors with allowed domains can become candidates for
verification.
* Verification status queries additionally filter out any denied
domains.
* Re-verification processes only proceed with allowed domains.
### Integration
We have an existing database writer thread, which receives events and
attempts to persist them to disk. Once validated and persisted, these
events are broadcast to all subscribers.
When verification is enabled, the writer must check to ensure a valid,
unexpired verification record exists for the author. All metadata
events (regardless of verification status) are forwarded to a verifier
module. If the verifier determines a new verification record is
needed, it is also responsible for persisting and broadcasting the
event, just as the database writer would have done.
## Threat Scenarios
Some of these mitigations are fully implemented, others are documented
simply to demonstrate a mitigation is possible.
### Domain Spamming
*Threat*: A author with a high-volume of events creates a metadata event
with a bogus domain, causing the relay to generate significant
unwanted traffic to a target.
*Mitigation*: Rate limiting for all candidate verification will limit
external requests to a reasonable amount. Currently, this is a simple
delay that slows down the HTTP task.
### Denial of Service for Legitimate Authors
*Threat*: A author with a high-volume of events creates a metadata event
with a domain that is invalid for them, _but which is used by other
legitimate authors_. This triggers rate-limiting against the legitimate
domain, and blocks authors from updating their own metadata.
*Mitigation*: Rate limiting should only apply to candidates, so any
existing verified authors have priority for re-verification. New
authors will be affected, as we can not distinguish between the threat
and a legitimate author. _(Unimplemented)_
### Denial of Service by Consuming Storage
*Threat*: A author creates a high volume of random metadata events with
unique domains, in order to cause us to store large amounts of data
for to-be-verified authors.
*Mitigation*: No data is stored for candidate authors. This makes it
harder for new authors to become verified, but is effective at
preventing this attack.
### Metadata Replay for Verified Author
*Threat*: Attacker replays out-of-date metadata event for a author, to
cause a verification to fail.
*Mitigation*: New metadata events have their signed timestamp compared
against the signed timestamp of the event that has most recently
verified them. If the metadata event is older, it is discarded.
### Server-Side Request Forgery via Metadata
*Threat*: Attacker includes malicious data in the `nip05` event, which
is used to generate HTTP requests against potentially internal
resources. Either leaking data, or invoking webservices beyond their
own privileges.
*Mitigation*: Consider detecting and dropping when the `nip05` field
is an IP address. Allow the relay operator to utilize the `blacklist`
or `whitelist` to constrain hosts that will be contacted. Most
importantly, the verification process is hardcoded to only make
requests to a known url path
(`.well-known/nostr.json?name=<LOCAL_NAME>`). The `<LOCAL_NAME>`
component is restricted to a basic ASCII subset (preventing additional
URL components).
examples/nauthz/Cargo.lock
Generated
+1010
View File
File diff suppressed because it is too large Load Diff
examples/nauthz/Cargo.toml
+13
View File
@@ -0,0 +1,13 @@
[package]
name = "nauthz-server"
version = "0.1.0"
edition = "2021"
[dependencies]
# Common dependencies
tokio = { version = "1.0", features = ["rt-multi-thread", "macros"] }
prost = "0.11"
tonic = "0.8.3"
[build-dependencies]
tonic-build = { version="0.8.3", features = ["prost"] }
examples/nauthz/build.rs
+7
View File
@@ -0,0 +1,7 @@
fn main() -> Result<(), Box<dyn std::error::Error>> {
tonic_build::configure()
.build_server(true)
.protoc_arg("--experimental_allow_proto3_optional")
.compile(&["../../proto/nauthz.proto"], &["../../proto"])?;
Ok(())
}
examples/nauthz/src/main.rs
+60
View File
@@ -0,0 +1,60 @@
use tonic::{transport::Server, Request, Response, Status};
use nauthz_grpc::authorization_server::{Authorization, AuthorizationServer};
use nauthz_grpc::{Decision, EventReply, EventRequest};
pub mod nauthz_grpc {
tonic::include_proto!("nauthz");
}
#[derive(Default)]
pub struct EventAuthz {
allowed_kinds: Vec<u64>,
}
#[tonic::async_trait]
impl Authorization for EventAuthz {
async fn event_admit(
&self,
request: Request<EventRequest>,
) -> Result<Response<EventReply>, Status> {
let reply;
let req = request.into_inner();
let event = req.event.unwrap();
let content_prefix: String = event.content.chars().take(40).collect();
println!("recvd event, [kind={}, origin={:?}, nip05_domain={:?}, tag_count={}, content_sample={:?}]",
event.kind, req.origin, req.nip05.map(|x| x.domain), event.tags.len(), content_prefix);
// Permit any event with a whitelisted kind
if self.allowed_kinds.contains(&event.kind) {
println!("This looks fine! (kind={})", event.kind);
reply = nauthz_grpc::EventReply {
decision: Decision::Permit as i32,
message: None,
};
} else {
println!("Blocked! (kind={})", event.kind);
reply = nauthz_grpc::EventReply {
decision: Decision::Deny as i32,
message: Some(format!("kind {} not permitted", event.kind)),
};
}
Ok(Response::new(reply))
}
}
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let addr = "[::1]:50051".parse().unwrap();
// A simple authorization engine that allows kinds 0-3
let checker = EventAuthz {
allowed_kinds: vec![0, 1, 2, 3],
};
println!("EventAuthz Server listening on {}", addr);
// Start serving
Server::builder()
.add_service(AuthorizationServer::new(checker))
.serve(addr)
.await?;
Ok(())
}
flake.lock
Generated
+103
View File
@@ -0,0 +1,103 @@
{
"nodes": {
"crane": {
"inputs": {
"nixpkgs": [
"nixpkgs"
]
},
"locked": {
"lastModified": 1719249093,
"narHash": "sha256-0q1haa3sw6GbmJ+WhogMnducZGjEaCa/iR6hF2vq80I=",
"owner": "ipetkov",
"repo": "crane",
"rev": "9791c77eb7e98b8d8ac5b0305d47282f994411ca",
"type": "github"
},
"original": {
"owner": "ipetkov",
"repo": "crane",
"type": "github"
}
},
"flake-utils": {
"inputs": {
"systems": "systems"
},
"locked": {
"lastModified": 1710146030,
"narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=",
"owner": "numtide",
"repo": "flake-utils",
"rev": "b1d9ab70662946ef0850d488da1c9019f3a9752a",
"type": "github"
},
"original": {
"owner": "numtide",
"repo": "flake-utils",
"type": "github"
}
},
"nixpkgs": {
"locked": {
"lastModified": 1719254875,
"narHash": "sha256-ECni+IkwXjusHsm9Sexdtq8weAq/yUyt1TWIemXt3Ko=",
"owner": "nixos",
"repo": "nixpkgs",
"rev": "2893f56de08021cffd9b6b6dfc70fd9ccd51eb60",
"type": "github"
},
"original": {
"owner": "nixos",
"ref": "nixos-unstable",
"repo": "nixpkgs",
"type": "github"
}
},
"root": {
"inputs": {
"crane": "crane",
"flake-utils": "flake-utils",
"nixpkgs": "nixpkgs",
"rust-overlay": "rust-overlay"
}
},
"rust-overlay": {
"inputs": {
"nixpkgs": [
"nixpkgs"
]
},
"locked": {
"lastModified": 1765334520,
"narHash": "sha256-jTof2+ir9UPmv4lWksYO6WbaXCC0nsDExrB9KZj7Dz4=",
"owner": "oxalica",
"repo": "rust-overlay",
"rev": "db61f666aea93b28f644861fbddd37f235cc5983",
"type": "github"
},
"original": {
"owner": "oxalica",
"repo": "rust-overlay",
"type": "github"
}
},
"systems": {
"locked": {
"lastModified": 1681028828,
"narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
"owner": "nix-systems",
"repo": "default",
"rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
"type": "github"
},
"original": {
"owner": "nix-systems",
"repo": "default",
"type": "github"
}
}
},
"root": "root",
"version": 7
}
flake.nix
+72
View File
@@ -0,0 +1,72 @@
{
description = "Nostr Relay written in Rust";
inputs = {
nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
flake-utils.url = "github:numtide/flake-utils";
rust-overlay = {
url = "github:oxalica/rust-overlay";
inputs.nixpkgs.follows = "nixpkgs";
inputs.flake-utils.follows = "flake-utils";
};
crane = {
url = "github:ipetkov/crane";
inputs.nixpkgs.follows = "nixpkgs";
};
};
outputs = inputs@{ self, ... }:
inputs.flake-utils.lib.eachDefaultSystem (system:
let
# Import nixpkgs with rust-overlay
overlays = [ (import inputs.rust-overlay) ];
pkgs = import inputs.nixpkgs {
inherit system overlays;
};
# Use Rust 1.81 or later (required by home@0.5.11)
# Using stable.latest should give us at least 1.81
rustToolchain = pkgs.rust-bin.stable.latest.minimal;
# Override pkgs to use the newer Rust toolchain
pkgsWithRust = pkgs.extend (final: prev: {
rustc = rustToolchain;
cargo = rustToolchain;
});
craneLib = inputs.crane.mkLib pkgsWithRust;
src = pkgs.lib.cleanSourceWith {
src = ./.;
filter = path: type:
(pkgs.lib.hasSuffix "\.proto" path) ||
# Default filter from crane (allow .rs files)
(craneLib.filterCargoSources path type)
;
};
crate = craneLib.buildPackage {
name = "floonet-rs";
inherit src;
nativeBuildInputs = [
pkgs.pkg-config
pkgs.protobuf
];
};
in
{
checks = {
inherit crate;
};
packages.default = crate;
formatter = pkgs.nixpkgs-fmt;
devShells.default = pkgs.mkShell {
buildInputs = [
rustToolchain
pkgs.pkg-config
pkgs.protobuf
];
};
});
}
mixexit/Cargo.lock
Generated
+8449
View File
File diff suppressed because it is too large Load Diff
mixexit/Cargo.toml
+27
View File
@@ -0,0 +1,27 @@
# floonet-mixexit: the scoped mixnet exit bundled with a Floonet relay.
#
# Built separately from the relay (it pulls the whole nym-sdk tree):
# cargo build --release --manifest-path mixexit/Cargo.toml
# The nym-sdk path dependency expects the Goblin nym checkout (branch
# `goblin`) two directories up; adjust the path for your layout.
[package]
name = "floonet-mixexit"
version = "0.1.0"
edition = "2024"
license = "Apache-2.0"
description = "Scoped mixnet exit bundled with a Floonet relay: pipes accepted mixnet streams to ONE fixed upstream (never arbitrary targets)."
[workspace]
[dependencies]
## Path dep into the local nym checkout (branch goblin, pinned rev; the
## same checkout the Goblin wallet path-depends on, so both ends speak
## the same MixnetStream protocol).
nym-sdk = { path = "../../nym/sdk/rust/nym-sdk" }
tokio = { version = "1", features = ["rt-multi-thread", "macros", "net", "io-util", "signal"] }
## Only to surface nym-sdk's tracing logs (RUST_LOG-style filtering).
tracing-subscriber = { version = "0.3", features = ["env-filter"] }
[profile.release]
strip = true
mixexit/rustfmt.toml
+2
View File
@@ -0,0 +1,2 @@
hard_tabs = true
edition = "2024"
mixexit/src/main.rs
+184
View File
@@ -0,0 +1,184 @@
// Copyright 2026 The Goblin Developers
//
// 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.
//! floonet-mixexit: the SCOPED mixnet exit bundled with a Floonet relay.
//!
//! An ordinary UNBONDED mixnet client (no nym-node, no pledge, no directory
//! listing) that accepts incoming [`MixnetStream`]s and pipes each one to ONE
//! fixed upstream — the operator's own relay. No per-stream target or host
//! header is honored, so this is structurally NOT an open proxy: the only
//! thing it can ever reach is the configured relay, which is why operators
//! carry zero open-proxy liability and need no exit policy.
//!
//! The mixnet identity persists in `FLOONET_MIXEXIT_DIR`, so `nym_address()`
//! is STABLE across restarts — that address is what wallets pin (relay-pool
//! `exit` field / NIP-11 `nym_exit`). Wallets run hostname-validated TLS
//! (SNI = the relay host) end-to-end THROUGH the pipe, so this exit sees only
//! ciphertext. Design: ~/.claude/plans/floonet-nym-exit.md.
use std::path::PathBuf;
use nym_sdk::mixnet::{MixnetClientBuilder, MixnetStream, StoragePaths};
use tokio::io::copy_bidirectional;
use tokio::net::TcpStream;
const USAGE: &str = "\
floonet-mixexit: scoped mixnet exit for a Floonet relay
Accepts incoming mixnet streams and pipes each one to ONE fixed upstream
(the co-located relay). Per-stream targets are never honored, so this is
structurally not an open proxy. The mixnet identity persists in the data
dir, keeping the mixnet address stable across restarts.
USAGE:
floonet-mixexit [--help | --selftest]
MODES:
(none) serve: accept mixnet streams, pipe each to the upstream
--selftest connect to the mixnet, print the (stable) mixnet address and
exit — never touches the upstream
--help this text
ENVIRONMENT:
FLOONET_MIXEXIT_DIR data dir for the persistent mixnet identity;
the mixnet address is also written to
<dir>/nym_address.txt [default: ./mixexit-data]
FLOONET_EXIT_UPSTREAM fixed host:port every stream is piped to
[default: relay.goblin.st:443]
RUST_LOG nym-sdk log filter [default: warn]
";
/// Data dir for the persistent mixnet identity (`FLOONET_MIXEXIT_DIR`).
fn data_dir() -> PathBuf {
std::env::var_os("FLOONET_MIXEXIT_DIR")
.map(Into::into)
.unwrap_or_else(|| PathBuf::from("./mixexit-data"))
}
/// The ONE upstream every stream is piped to (`FLOONET_EXIT_UPSTREAM`).
fn upstream() -> String {
std::env::var("FLOONET_EXIT_UPSTREAM").unwrap_or_else(|_| "relay.goblin.st:443".to_string())
}
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let mode = std::env::args().nth(1);
match mode.as_deref() {
Some("--help" | "-h") => {
print!("{USAGE}");
return Ok(());
}
None | Some("--selftest") => {}
Some(other) => {
eprintln!("unknown argument: {other}\n\n{USAGE}");
std::process::exit(2);
}
}
tracing_subscriber::fmt()
.with_env_filter(
tracing_subscriber::EnvFilter::try_from_default_env().unwrap_or_else(|_| "warn".into()),
)
.init();
// Persistent identity: same data dir → same keystore (generated on first
// run) → the SAME nym address across restarts. That address is what
// wallets pin, so back this directory up — losing it rotates the address
// and strands wallet pins until the next pool/NIP-11 refresh.
let dir = data_dir();
std::fs::create_dir_all(&dir)?;
let storage_paths = StoragePaths::new_from_dir(&dir)?;
let mut client = MixnetClientBuilder::new_with_default_storage(storage_paths)
.await?
.build()?
.connect_to_mixnet()
.await?;
let address = *client.nym_address();
let address_file = dir.join("nym_address.txt");
std::fs::write(&address_file, format!("{address}\n"))?;
println!("=============================================================");
println!(" floonet-mixexit is on the mixnet. Mixnet address (STABLE, pin");
println!(" this in the relay pool `exit` field / NIP-11 `nym_exit`):");
println!(" {address}");
println!(" also written to {}", address_file.display());
println!("=============================================================");
if mode.as_deref() == Some("--selftest") {
println!("selftest OK");
client.disconnect().await;
return Ok(());
}
let upstream = upstream();
println!("piping every accepted stream to fixed upstream {upstream}");
let mut listener = client.listener()?;
loop {
tokio::select! {
_ = shutdown_signal() => {
println!("shutdown signal received; stopping");
break;
}
accepted = listener.accept() => match accepted {
Some(stream) => {
let upstream = upstream.clone();
tokio::spawn(pipe(stream, upstream));
}
None => {
eprintln!("mixnet stream router stopped; exiting");
break;
}
}
}
}
client.disconnect().await;
println!("floonet-mixexit stopped");
Ok(())
}
/// One accepted stream: TCP to the FIXED upstream (never a caller-chosen
/// target), then bytes both ways until either side closes. Errors are logged
/// and drop only this stream — the accept loop keeps serving.
async fn pipe(mut mix: MixnetStream, upstream: String) {
let mut tcp = match TcpStream::connect(&upstream).await {
Ok(tcp) => tcp,
Err(e) => {
eprintln!("stream dropped: upstream {upstream} connect failed: {e}");
return;
}
};
match copy_bidirectional(&mut mix, &mut tcp).await {
Ok((up, down)) => println!("stream closed ({up} B in → relay, {down} B relay → out)"),
Err(e) => eprintln!("stream ended with error: {e}"),
}
}
/// Resolves on SIGINT (Ctrl-C) or SIGTERM (systemd/docker stop).
async fn shutdown_signal() {
let ctrl_c = tokio::signal::ctrl_c();
#[cfg(unix)]
{
let mut term = tokio::signal::unix::signal(tokio::signal::unix::SignalKind::terminate())
.expect("SIGTERM handler");
tokio::select! {
_ = ctrl_c => {}
_ = term.recv() => {}
}
}
#[cfg(not(unix))]
{
let _ = ctrl_c.await;
}
}
proto/nauthz.proto
+60
View File
@@ -0,0 +1,60 @@
syntax = "proto3";
// Nostr Authorization Services
package nauthz;
// Authorization for actions against a relay
service Authorization {
// Determine if an event should be admitted to the relay
rpc EventAdmit(EventRequest) returns (EventReply) {}
}
message Event {
bytes id = 1; // 32-byte SHA256 hash of serialized event
bytes pubkey = 2; // 32-byte public key of event creator
fixed64 created_at = 3; // UNIX timestamp provided by event creator
uint64 kind = 4; // event kind
string content = 5; // arbitrary event contents
repeated TagEntry tags = 6; // event tag array
bytes sig = 7; // 32-byte signature of the event id
// Individual values for a single tag
message TagEntry {
repeated string values = 1;
}
}
// Event data and metadata for authorization decisions
message EventRequest {
Event event =
1; // the event to be admitted for further relay processing
optional string ip_addr =
2; // IP address of the client that submitted the event
optional string origin =
3; // HTTP origin header from the client, if one exists
optional string user_agent =
4; // HTTP user-agent header from the client, if one exists
optional bytes auth_pubkey =
5; // the public key associated with a NIP-42 AUTH'd session, if
// authentication occurred
optional Nip05Name nip05 =
6; // NIP-05 address associated with the event pubkey, if it is
// known and has been validated by the relay
// A NIP_05 verification record
message Nip05Name {
string local = 1;
string domain = 2;
}
}
// A permit or deny decision
enum Decision {
DECISION_UNSPECIFIED = 0;
DECISION_PERMIT = 1; // Admit this event for further processing
DECISION_DENY = 2; // Deny persisting or propagating this event
}
// Response to a event authorization request
message EventReply {
Decision decision = 1; // decision to enforce
optional string message = 2; // informative message for the client
}
rustfmt.toml
+4
View File
@@ -0,0 +1,4 @@
edition = "2021"
#max_width = 140
#chain_width = 100
#fn_call_width = 100
src/admission.rs
+282
View File
@@ -0,0 +1,282 @@
//! Event admission: composable write-side policies (Floonet addition).
//!
//! Every EVENT a client publishes passes through one `Admission::check`
//! call in the websocket write path, before the event is queued for the
//! database writer. The admission layer is a fixed, ordered list of small
//! policies; the first policy that denies wins. To add a new policy
//! (paid gate, name-authority check, spam filter), implement
//! [`AdmissionPolicy`] and append it in [`Admission::from_settings`].
//!
//! The keystone policy is the default-deny kind whitelist: the relay
//! accepts ONLY the event kinds it was explicitly configured to allow and
//! rejects everything else. If no allowlist is configured at all, the
//! built-in Floonet set applies (fail closed, never fail open).
use crate::config::Settings;
use crate::event::Event;
/// The Floonet default kind whitelist, applied when the operator has not
/// configured `event_kind_allowlist` explicitly. Kinds:
/// 0 profile metadata, 3 contacts, 5 delete (NIP-09), 13 seal,
/// 1059 gift wrap (NIP-59), 10002 relay list (NIP-65),
/// 10050 DM relays (NIP-17), 27235 NIP-98 HTTP auth.
pub const DEFAULT_ALLOWED_KINDS: [u64; 8] = [0, 3, 5, 13, 1059, 10002, 10050, 27235];
/// Outcome of an admission check.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Decision {
/// Event may proceed to the write path.
Allow,
/// Event is rejected before persistence.
Deny {
/// Human-readable reason, sent to the client in the OK message.
reason: String,
/// True when the denial is because the client has not completed
/// NIP-42 AUTH; the client should be told with an
/// `auth-required:` prefixed OK message.
auth_required: bool,
},
}
impl Decision {
fn deny(reason: &str) -> Decision {
Decision::Deny {
reason: reason.to_string(),
auth_required: false,
}
}
fn deny_auth(reason: &str) -> Decision {
Decision::Deny {
reason: reason.to_string(),
auth_required: true,
}
}
}
/// One admission policy. `authed_pubkey` is the NIP-42 authenticated pubkey
/// for this connection, if any.
pub trait AdmissionPolicy: Send + Sync {
fn check(&self, event: &Event, authed_pubkey: Option<&str>) -> Decision;
}
/// Default-deny event kind whitelist (the keystone).
pub struct KindWhitelist {
allowed: Vec<u64>,
}
impl AdmissionPolicy for KindWhitelist {
fn check(&self, event: &Event, _authed_pubkey: Option<&str>) -> Decision {
if self.allowed.contains(&event.kind) {
Decision::Allow
} else {
Decision::deny(&format!(
"event kind {} not accepted by this relay",
event.kind
))
}
}
}
/// Require a completed NIP-42 AUTH before any event is accepted.
pub struct RequireAuth;
impl AdmissionPolicy for RequireAuth {
fn check(&self, _event: &Event, authed_pubkey: Option<&str>) -> Decision {
if authed_pubkey.is_some() {
Decision::Allow
} else {
Decision::deny_auth("authentication required to publish events")
}
}
}
/// Restrict publishing to a fixed set of author pubkeys. Matches the
/// upstream semantics: when pay-to-relay is enabled the whitelist means
/// "posts for free" and is handled by the payment layer instead, so this
/// policy is only installed when pay-to-relay is off.
pub struct PubkeyWhitelist {
allowed: Vec<String>,
}
impl AdmissionPolicy for PubkeyWhitelist {
fn check(&self, event: &Event, _authed_pubkey: Option<&str>) -> Decision {
if self.allowed.contains(&event.pubkey) {
Decision::Allow
} else {
Decision::deny("pubkey is not allowed to publish to this relay")
}
}
}
/// The composed admission pipeline the server consults.
pub struct Admission {
policies: Vec<Box<dyn AdmissionPolicy>>,
}
impl Admission {
/// Build the policy pipeline from settings. Order matters: the kind
/// whitelist runs first (cheapest, and the keystone), then auth, then
/// author restrictions.
pub fn from_settings(settings: &Settings) -> Admission {
let mut policies: Vec<Box<dyn AdmissionPolicy>> = Vec::new();
// Keystone: default-deny kind whitelist. A missing allowlist gets
// the built-in Floonet set; an explicitly empty list denies all.
let allowed = settings
.limits
.event_kind_allowlist
.clone()
.unwrap_or_else(|| DEFAULT_ALLOWED_KINDS.to_vec());
policies.push(Box::new(KindWhitelist { allowed }));
// Optional: require NIP-42 auth to write.
if settings.authorization.nip42_auth && settings.authorization.require_auth_to_write {
policies.push(Box::new(RequireAuth));
}
// Optional: author whitelist (free relays only; paid relays treat
// the whitelist as a fee exemption in the payment layer).
if !settings.pay_to_relay.enabled {
if let Some(whitelist) = &settings.authorization.pubkey_whitelist {
policies.push(Box::new(PubkeyWhitelist {
allowed: whitelist.clone(),
}));
}
}
Admission { policies }
}
/// Check an event against every policy in order; first denial wins.
pub fn check(&self, event: &Event, authed_pubkey: Option<&str>) -> Decision {
for policy in &self.policies {
match policy.check(event, authed_pubkey) {
Decision::Allow => continue,
deny => return deny,
}
}
Decision::Allow
}
}
#[cfg(test)]
mod tests {
use super::*;
fn event_of_kind(kind: u64) -> Event {
let mut e = Event::simple_event();
e.kind = kind;
e
}
fn floonet_settings() -> Settings {
// The shipped defaults already carry the Floonet whitelist.
Settings::default()
}
#[test]
fn default_whitelist_accepts_allowed_kinds() {
let admission = Admission::from_settings(&floonet_settings());
for kind in DEFAULT_ALLOWED_KINDS {
assert_eq!(
admission.check(&event_of_kind(kind), None),
Decision::Allow,
"kind {kind} should be allowed"
);
}
}
#[test]
fn default_whitelist_rejects_disallowed_kinds() {
let admission = Admission::from_settings(&floonet_settings());
// kind 1 (short text note) and other common kinds are NOT accepted.
for kind in [1u64, 4, 6, 7, 42, 1984, 9735, 30023] {
match admission.check(&event_of_kind(kind), None) {
Decision::Deny { auth_required, .. } => {
assert!(!auth_required, "kind rejection is not an auth issue");
}
Decision::Allow => panic!("kind {kind} must be rejected by default"),
}
}
}
#[test]
fn missing_allowlist_falls_back_to_floonet_set_not_allow_all() {
let mut settings = floonet_settings();
settings.limits.event_kind_allowlist = None;
let admission = Admission::from_settings(&settings);
assert_eq!(admission.check(&event_of_kind(1059), None), Decision::Allow);
assert_ne!(admission.check(&event_of_kind(1), None), Decision::Allow);
}
#[test]
fn empty_allowlist_denies_everything() {
let mut settings = floonet_settings();
settings.limits.event_kind_allowlist = Some(vec![]);
let admission = Admission::from_settings(&settings);
assert_ne!(admission.check(&event_of_kind(0), None), Decision::Allow);
assert_ne!(admission.check(&event_of_kind(1059), None), Decision::Allow);
}
#[test]
fn custom_allowlist_is_respected() {
let mut settings = floonet_settings();
settings.limits.event_kind_allowlist = Some(vec![1, 7]);
let admission = Admission::from_settings(&settings);
assert_eq!(admission.check(&event_of_kind(1), None), Decision::Allow);
assert_ne!(admission.check(&event_of_kind(0), None), Decision::Allow);
}
#[test]
fn require_auth_denies_unauthed_writes_with_auth_required() {
let mut settings = floonet_settings();
settings.authorization.nip42_auth = true;
settings.authorization.require_auth_to_write = true;
let admission = Admission::from_settings(&settings);
match admission.check(&event_of_kind(1059), None) {
Decision::Deny { auth_required, .. } => assert!(auth_required),
Decision::Allow => panic!("unauthenticated write must be denied"),
}
// After AUTH, the same event is accepted.
let pk = "aa".repeat(32);
assert_eq!(
admission.check(&event_of_kind(1059), Some(pk.as_str())),
Decision::Allow
);
}
#[test]
fn require_auth_without_nip42_is_inert() {
// require_auth_to_write only makes sense with nip42_auth on; the
// relay never sends a challenge otherwise, so the gate is skipped.
let mut settings = floonet_settings();
settings.authorization.nip42_auth = false;
settings.authorization.require_auth_to_write = true;
let admission = Admission::from_settings(&settings);
assert_eq!(admission.check(&event_of_kind(1059), None), Decision::Allow);
}
#[test]
fn pubkey_whitelist_enforced_when_free() {
let mut settings = floonet_settings();
let good = "aa".repeat(32);
settings.authorization.pubkey_whitelist = Some(vec![good.clone()]);
let admission = Admission::from_settings(&settings);
let mut e = event_of_kind(0);
e.pubkey = good;
assert_eq!(admission.check(&e, None), Decision::Allow);
e.pubkey = "bb".repeat(32);
assert_ne!(admission.check(&e, None), Decision::Allow);
}
#[test]
fn kind_check_runs_before_auth_check() {
let mut settings = floonet_settings();
settings.authorization.nip42_auth = true;
settings.authorization.require_auth_to_write = true;
let admission = Admission::from_settings(&settings);
match admission.check(&event_of_kind(1), None) {
Decision::Deny { auth_required, .. } => {
assert!(!auth_required, "disallowed kind must not leak auth hints");
}
Decision::Allow => panic!("must deny"),
}
}
}
src/bin/bulkloader.rs
+180
View File
@@ -0,0 +1,180 @@
use floonet_rs::config;
use floonet_rs::error::{Error, Result};
use floonet_rs::event::{single_char_tagname, Event};
use floonet_rs::repo::sqlite::{build_pool, PooledConnection};
use floonet_rs::repo::sqlite_migration::{curr_db_version, DB_VERSION};
use floonet_rs::utils::is_lower_hex;
use rusqlite::params;
use rusqlite::{OpenFlags, Transaction};
use std::io;
use std::path::Path;
use std::sync::mpsc;
use std::thread;
use tracing::info;
/// Bulk load JSONL data from STDIN to the database specified in config.toml (or ./nostr.db as a default).
/// The database must already exist, this will not create a new one.
/// Tested against schema v13.
pub fn main() -> Result<()> {
let _trace_sub = tracing_subscriber::fmt::try_init();
println!("Nostr-rs-relay Bulk Loader");
// check for a database file, or create one.
let settings = config::Settings::new(&None)?;
if !Path::new(&settings.database.data_directory).is_dir() {
info!("Database directory does not exist");
return Err(Error::DatabaseDirError);
}
// Get a database pool
let pool = build_pool(
"bulk-loader",
&settings,
OpenFlags::SQLITE_OPEN_READ_WRITE | OpenFlags::SQLITE_OPEN_CREATE,
1,
4,
false,
);
{
// check for database schema version
let mut conn: PooledConnection = pool.get()?;
let version = curr_db_version(&mut conn)?;
info!("current version is: {:?}", version);
// ensure the schema version is current.
if version != DB_VERSION {
info!("version is not current, exiting");
panic!("cannot write to schema other than v{DB_VERSION}");
}
}
// this channel will contain parsed events ready to be inserted
let (event_tx, event_rx) = mpsc::sync_channel(100_000);
// Thread for reading events
let _stdin_reader_handler = thread::spawn(move || {
let stdin = io::stdin();
for readline in stdin.lines() {
if let Ok(line) = readline {
// try to parse a nostr event
let eres: Result<Event, serde_json::Error> = serde_json::from_str(&line);
if let Ok(mut e) = eres {
if let Ok(()) = e.validate() {
e.build_index();
//debug!("Event: {:?}", e);
event_tx.send(Some(e)).ok();
} else {
info!("could not validate event");
}
} else {
info!("error reading event: {:?}", eres);
}
} else {
// error reading
info!("error reading: {:?}", readline);
}
}
info!("finished parsing events");
event_tx.send(None).ok();
let ok: Result<()> = Ok(());
ok
});
let mut conn: PooledConnection = pool.get()?;
let mut events_read = 0;
let event_batch_size = 50_000;
let mut new_events = 0;
let mut has_more_events = true;
while has_more_events {
// begin a transaction
let tx = conn.transaction()?;
// read in batch_size events and commit
for _ in 0..event_batch_size {
match event_rx.recv() {
Ok(Some(e)) => {
events_read += 1;
// ignore ephemeral events
if !(e.kind >= 20000 && e.kind < 30000) {
match write_event(&tx, e) {
Ok(c) => {
new_events += c;
}
Err(e) => {
info!("error inserting event: {:?}", e);
}
}
}
}
Ok(None) => {
// signal that the sender will never produce more
// events
has_more_events = false;
break;
}
Err(_) => {
info!("sender is closed");
// sender is done
}
}
}
info!("committed {} events...", new_events);
tx.commit()?;
conn.execute_batch("pragma wal_checkpoint(truncate)")?;
}
info!("processed {} events", events_read);
info!("stored {} new events", new_events);
// get a connection for writing events
// read standard in.
info!("finished reading input");
Ok(())
}
/// Write an event and update the tag table.
/// Assumes the event has its index built.
fn write_event(tx: &Transaction, e: Event) -> Result<usize> {
let id_blob = hex::decode(&e.id).ok();
let pubkey_blob: Option<Vec<u8>> = hex::decode(&e.pubkey).ok();
let delegator_blob: Option<Vec<u8>> = e.delegated_by.as_ref().and_then(|d| hex::decode(d).ok());
let event_str = serde_json::to_string(&e).ok();
// ignore if the event hash is a duplicate.
let ins_count = tx.execute(
"INSERT OR IGNORE INTO event (event_hash, created_at, kind, author, delegated_by, content, first_seen, hidden) VALUES (?1, ?2, ?3, ?4, ?5, ?6, strftime('%s','now'), FALSE);",
params![id_blob, e.created_at, e.kind, pubkey_blob, delegator_blob, event_str]
)?;
if ins_count == 0 {
return Ok(0);
}
// we want to capture the event_id that had the tag, the tag name, and the tag hex value.
let event_id = tx.last_insert_rowid();
// look at each event, and each tag, creating new tag entries if appropriate.
for t in e.tags.iter().filter(|x| x.len() > 1) {
let tagname = t.first().unwrap();
let tagnamechar_opt = single_char_tagname(tagname);
if tagnamechar_opt.is_none() {
continue;
}
// safe because len was > 1
let tagval = t.get(1).unwrap();
// insert as BLOB if we can restore it losslessly.
// this means it needs to be even length and lowercase.
if (tagval.len() % 2 == 0) && is_lower_hex(tagval) {
tx.execute(
"INSERT INTO tag (event_id, name, value_hex) VALUES (?1, ?2, ?3);",
params![event_id, tagname, hex::decode(tagval).ok()],
)?;
} else {
// otherwise, insert as text
tx.execute(
"INSERT INTO tag (event_id, name, value) VALUES (?1, ?2, ?3);",
params![event_id, tagname, &tagval],
)?;
}
}
if e.is_replaceable() {
//let query = "SELECT id FROM event WHERE kind=? AND author=? ORDER BY created_at DESC LIMIT 1;";
//let count: usize = tx.query_row(query, params![e.kind, pubkey_blob], |row| row.get(0))?;
//info!("found {} rows that /would/ be preserved", count);
match tx.execute(
"DELETE FROM event WHERE kind=? and author=? and id NOT IN (SELECT id FROM event WHERE kind=? AND author=? ORDER BY created_at DESC LIMIT 1);",
params![e.kind, pubkey_blob, e.kind, pubkey_blob],
) {
Ok(_) => {},
Err(x) => {info!("error deleting replaceable event: {:?}",x);}
}
}
Ok(ins_count)
}
src/cli.rs
+20
View File
@@ -0,0 +1,20 @@
use clap::Parser;
#[derive(Parser)]
#[command(about = "A nostr relay written in Rust", author = env!("CARGO_PKG_AUTHORS"), version = env!("CARGO_PKG_VERSION"))]
pub struct CLIArgs {
#[arg(
short,
long,
help = "Use the <directory> as the location of the database",
required = false
)]
pub db: Option<String>,
#[arg(
short,
long,
help = "Use the <file name> as the location of the config file",
required = false
)]
pub config: Option<String>,
}
src/close.rs
+32
View File
@@ -0,0 +1,32 @@
//! Subscription close request parsing
//!
//! Representation and parsing of `CLOSE` messages sent from clients.
use crate::error::{Error, Result};
use serde::{Deserialize, Serialize};
/// Close command in network format
#[derive(Serialize, Deserialize, PartialEq, Eq, Debug, Clone)]
pub struct CloseCmd {
/// Protocol command, expected to always be "CLOSE".
cmd: String,
/// The subscription identifier being closed.
id: String,
}
/// Identifier of the subscription to be closed.
#[derive(Serialize, Deserialize, PartialEq, Eq, Debug, Clone)]
pub struct Close {
/// The subscription identifier being closed.
pub id: String,
}
impl From<CloseCmd> for Result<Close> {
fn from(cc: CloseCmd) -> Result<Close> {
// ensure command is correct
if cc.cmd == "CLOSE" {
Ok(Close { id: cc.id })
} else {
Err(Error::CommandUnknownError)
}
}
}
src/config.rs
+561
View File
@@ -0,0 +1,561 @@
//! Configuration file and settings management
use crate::payment::Processor;
use config::{Config, ConfigError, File};
use serde::{Deserialize, Serialize};
use std::time::Duration;
#[derive(Debug, Serialize, Deserialize, Clone)]
#[allow(unused)]
pub struct Info {
pub relay_url: Option<String>,
pub name: Option<String>,
pub description: Option<String>,
pub pubkey: Option<String>,
pub contact: Option<String>,
pub favicon: Option<String>,
pub relay_icon: Option<String>,
pub relay_page: Option<String>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[allow(unused)]
pub struct Database {
pub data_directory: String,
pub engine: String,
pub in_memory: bool,
pub min_conn: u32,
pub max_conn: u32,
pub connection: String,
pub connection_write: Option<String>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[allow(unused)]
pub struct Grpc {
pub event_admission_server: Option<String>,
pub restricts_write: bool,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[allow(unused)]
pub struct Network {
pub port: u16,
pub address: String,
pub remote_ip_header: Option<String>, // retrieve client IP from this HTTP header if present
pub ping_interval_seconds: u32,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[allow(unused)]
pub struct Options {
pub reject_future_seconds: Option<usize>, // if defined, reject any events with a timestamp more than X seconds in the future
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[allow(unused)]
pub struct Retention {
// TODO: implement
pub max_events: Option<usize>, // max events
pub max_bytes: Option<usize>, // max size
pub persist_days: Option<usize>, // oldest message
pub whitelist_addresses: Option<Vec<String>>, // whitelisted addresses (never delete)
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[allow(unused)]
pub struct Limits {
pub messages_per_sec: Option<u32>, // Artificially slow down event writing to limit disk consumption (averaged over 1 minute)
pub subscriptions_per_min: Option<u32>, // Artificially slow down request (db query) creation to prevent abuse (averaged over 1 minute)
pub db_conns_per_client: Option<u32>, // How many concurrent database queries (not subscriptions) may a client have?
pub max_blocking_threads: usize,
pub max_event_bytes: Option<usize>, // Maximum size of an EVENT message
pub max_ws_message_bytes: Option<usize>,
pub max_ws_frame_bytes: Option<usize>,
pub broadcast_buffer: usize, // events to buffer for subscribers (prevents slow readers from consuming memory)
pub event_persist_buffer: usize, // events to buffer for database commits (block senders if database writes are too slow)
pub event_kind_blacklist: Option<Vec<u64>>,
pub event_kind_allowlist: Option<Vec<u64>>,
pub limit_scrapers: bool,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[allow(unused)]
pub struct Authorization {
pub pubkey_whitelist: Option<Vec<String>>, // If present, only allow these pubkeys to publish events
pub nip42_auth: bool, // if true enables NIP-42 authentication
pub nip42_dms: bool, // if true send DMs only to their authenticated recipients
pub require_auth_to_write: bool, // if true (with nip42_auth), only authenticated clients may publish
}
/// GoblinPay: the Grin payment server used for paid names and paid writes
/// (Floonet addition). One place to configure it; both the built-in name
/// authority and the pay-to-relay admission use these values.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[allow(unused)]
pub struct GoblinPay {
/// Paid mode: "off" (everything free), "name" (claiming a name at the
/// built-in name authority requires a confirmed payment), or "write"
/// (publishing events requires a paid admission).
pub pay_mode: String,
/// Base URL of the GoblinPay server, e.g. `https://pay.example.com`.
pub url: String,
/// GoblinPay API token (`GP_API_TOKEN`); grants invoice create/read.
pub api_token: String,
/// Price of a name in GRIN when `pay_mode = "name"`.
pub name_price_grin: f64,
/// Price of relay admission in GRIN when `pay_mode = "write"`.
pub admission_price_grin: f64,
}
impl GoblinPay {
#[must_use]
pub fn name_price_nanogrin(&self) -> u64 {
grin_to_nanogrin(self.name_price_grin)
}
#[must_use]
pub fn admission_price_nanogrin(&self) -> u64 {
grin_to_nanogrin(self.admission_price_grin)
}
}
/// 1 GRIN = 1_000_000_000 nanogrin.
#[must_use]
pub fn grin_to_nanogrin(grin: f64) -> u64 {
(grin * 1_000_000_000.0).round().max(0.0) as u64
}
/// Built-in name authority (the goblin-nip05d capability), served
/// in-process on the relay's own HTTP listener (Floonet addition).
#[derive(Debug, Clone, Serialize, Deserialize)]
#[allow(unused)]
pub struct NameAuthority {
pub enabled: bool,
/// Bare host the names live under, e.g. `example.com` (the `@domain`
/// part of `name@domain`).
pub domain: String,
/// Public base URL clients reach, e.g. `https://example.com`.
/// LOAD-BEARING: NIP-98 auth events are verified against
/// `<base_url><path>`, so this must be exactly what clients use.
pub base_url: String,
/// Relays advertised in `/.well-known/nostr.json`. Unset means
/// "advertise this relay" (`info.relay_url`).
pub relays: Option<Vec<String>>,
/// Name length bounds in characters.
pub name_min: usize,
pub name_max: usize,
/// Seconds a key must wait to claim a new name after releasing one.
pub name_change_cooldown_secs: u64,
/// Max age (seconds) of an accepted NIP-98 auth event.
pub auth_max_age_secs: i64,
/// Read endpoints: requests per IP per window.
pub read_rate_max: usize,
pub read_rate_window_secs: u64,
/// Write endpoints (register/release): requests per IP per window.
pub write_rate_max: usize,
pub write_rate_window_secs: u64,
/// Optional file of extra reserved names (one per line, # comments).
pub reserved_file: Option<String>,
}
/// The co-located mixnet exit (Floonet addition): when enabled, the relay
/// supervises a bundled `floonet-mixexit` process so wallets can reach
/// this relay over the mixnet without public DNS on the payment path.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[allow(unused)]
pub struct MixnetExit {
pub enabled: bool,
/// Path to the bundled floonet-mixexit binary.
pub binary: String,
/// Data dir for the persistent mixnet identity. The exit's stable
/// mixnet address is written to `<data_dir>/nym_address.txt`.
pub data_dir: String,
/// Upstream host:port the exit pipes every stream to. Empty means this
/// relay's own listener (`127.0.0.1:<network.port>`). Point it at your
/// public TLS endpoint (e.g. `relay.example.com:443`) so wallets see
/// the same certificate through the mixnet.
pub upstream: String,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[allow(unused)]
pub struct PayToRelay {
pub enabled: bool,
pub admission_cost: u64, // Cost to have pubkey whitelisted
pub cost_per_event: u64, // Cost author to pay per event
pub node_url: String,
pub api_secret: String,
pub terms_message: String,
pub sign_ups: bool, // allow new users to sign up to relay
pub direct_message: bool, // Send direct message to user with invoice and terms
pub secret_key: Option<String>,
pub processor: Processor,
pub rune_path: Option<String>, // To access clightning API
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[allow(unused)]
pub struct Diagnostics {
pub tracing: bool, // enables tokio console-subscriber
}
#[derive(Serialize, Deserialize, PartialEq, Eq, Debug, Clone, Copy)]
#[serde(rename_all = "lowercase")]
pub enum VerifiedUsersMode {
Enabled,
Passive,
Disabled,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[allow(unused)]
pub struct VerifiedUsers {
pub mode: VerifiedUsersMode, // Mode of operation: "enabled" (enforce) or "passive" (check only). If none, this is simply disabled.
pub domain_whitelist: Option<Vec<String>>, // If present, only allow verified users from these domains can publish events
pub domain_blacklist: Option<Vec<String>>, // If present, allow all verified users from any domain except these
pub verify_expiration: Option<String>, // how long a verification is cached for before no longer being used
pub verify_update_frequency: Option<String>, // how often to attempt to update verification
pub verify_expiration_duration: Option<Duration>, // internal result of parsing verify_expiration
pub verify_update_frequency_duration: Option<Duration>, // internal result of parsing verify_update_frequency
pub max_consecutive_failures: usize, // maximum number of verification failures in a row, before ceasing future checks
}
impl VerifiedUsers {
pub fn init(&mut self) {
self.verify_expiration_duration = self.verify_expiration_duration();
self.verify_update_frequency_duration = self.verify_update_duration();
}
#[must_use]
pub fn is_enabled(&self) -> bool {
self.mode == VerifiedUsersMode::Enabled
}
#[must_use]
pub fn is_active(&self) -> bool {
self.mode == VerifiedUsersMode::Enabled || self.mode == VerifiedUsersMode::Passive
}
#[must_use]
pub fn is_passive(&self) -> bool {
self.mode == VerifiedUsersMode::Passive
}
#[must_use]
pub fn verify_expiration_duration(&self) -> Option<Duration> {
self.verify_expiration
.as_ref()
.and_then(|x| parse_duration::parse(x).ok())
}
#[must_use]
pub fn verify_update_duration(&self) -> Option<Duration> {
self.verify_update_frequency
.as_ref()
.and_then(|x| parse_duration::parse(x).ok())
}
#[must_use]
pub fn is_valid(&self) -> bool {
self.verify_expiration_duration().is_some() && self.verify_update_duration().is_some()
}
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[allow(unused)]
pub struct Logging {
pub folder_path: Option<String>,
pub file_prefix: Option<String>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[allow(unused)]
pub struct Settings {
pub info: Info,
pub diagnostics: Diagnostics,
pub database: Database,
pub grpc: Grpc,
pub network: Network,
pub limits: Limits,
pub authorization: Authorization,
pub pay_to_relay: PayToRelay,
pub goblinpay: GoblinPay,
pub name_authority: NameAuthority,
pub exit: MixnetExit,
pub verified_users: VerifiedUsers,
pub retention: Retention,
pub options: Options,
pub logging: Logging,
}
impl Settings {
pub fn new(config_file_name: &Option<String>) -> Result<Self, ConfigError> {
let default_settings = Self::default();
// attempt to construct settings with file
let from_file = Self::new_from_default(&default_settings, config_file_name);
match from_file {
Err(e) => {
// pass up the parse error if the config file was specified,
// otherwise use the default config (with a warning).
if config_file_name.is_some() {
Err(e)
} else {
eprintln!("Error reading config file ({:?})", e);
eprintln!("WARNING: Default configuration settings will be used");
Ok(default_settings)
}
}
ok => ok,
}
}
fn new_from_default(
default: &Settings,
config_file_name: &Option<String>,
) -> Result<Self, ConfigError> {
let default_config_file_name = "config.toml".to_string();
let config: &String = match config_file_name {
Some(value) => value,
None => &default_config_file_name,
};
let builder = Config::builder();
let config: Config = builder
// use defaults
.add_source(Config::try_from(default)?)
// override with file contents
.add_source(File::with_name(config))
.build()?;
let mut settings: Settings = config.try_deserialize()?;
// Floonet env overrides, so paid mode can be flipped without
// editing the config file (secrets can stay out of it entirely).
if let Ok(v) = std::env::var("FLOONET_PAY_MODE") {
settings.goblinpay.pay_mode = v;
}
if let Ok(v) = std::env::var("FLOONET_GOBLINPAY_URL") {
settings.goblinpay.url = v;
}
if let Ok(v) = std::env::var("FLOONET_GOBLINPAY_TOKEN") {
settings.goblinpay.api_token = v;
}
if let Ok(v) = std::env::var("FLOONET_NAME_PRICE_GRIN") {
if let Ok(price) = v.parse::<f64>() {
settings.goblinpay.name_price_grin = price;
}
}
// Validate + apply the Floonet paid mode.
match settings.goblinpay.pay_mode.as_str() {
"off" => {}
"name" | "write" => {
assert!(
!settings.goblinpay.url.is_empty(),
"goblinpay.url must be set when goblinpay.pay_mode is enabled"
);
assert!(
!settings.goblinpay.api_token.is_empty(),
"goblinpay.api_token must be set when goblinpay.pay_mode is enabled"
);
if settings.goblinpay.pay_mode == "write" {
// "write" rides the upstream pay-to-relay admission,
// with GoblinPay as the payment processor.
settings.pay_to_relay.enabled = true;
settings.pay_to_relay.processor = Processor::GoblinPay;
settings.pay_to_relay.node_url = settings.goblinpay.url.clone();
settings.pay_to_relay.api_secret = settings.goblinpay.api_token.clone();
settings.pay_to_relay.admission_cost =
settings.goblinpay.admission_price_nanogrin();
if settings.pay_to_relay.terms_message.is_empty() {
settings.pay_to_relay.terms_message =
"Use this relay lawfully and without abuse.".to_string();
}
}
}
other => panic!("goblinpay.pay_mode must be off, name, or write (got `{other}`)"),
}
if settings.name_authority.enabled {
assert!(
!settings.name_authority.domain.is_empty(),
"name_authority.domain must be set"
);
let base = &settings.name_authority.base_url;
assert!(
base.starts_with("https://")
|| base.starts_with("http://127.0.0.1")
|| base.starts_with("http://localhost"),
"name_authority.base_url must be https:// (http only for localhost testing)"
);
assert!(
settings.name_authority.name_min > 0
&& settings.name_authority.name_min <= settings.name_authority.name_max,
"invalid name_authority name length bounds"
);
assert!(
settings.database.engine == "sqlite",
"the built-in name authority requires the sqlite database engine"
);
}
// ensure connection pool size is logical
assert!(
settings.database.min_conn <= settings.database.max_conn,
"Database min_conn setting ({}) cannot exceed max_conn ({})",
settings.database.min_conn,
settings.database.max_conn
);
// ensure durations parse
assert!(
settings.verified_users.is_valid(),
"VerifiedUsers time settings could not be parsed"
);
// initialize durations for verified users
settings.verified_users.init();
// Validate pay to relay settings
if settings.pay_to_relay.enabled {
if settings.pay_to_relay.processor == Processor::ClnRest {
assert!(settings
.pay_to_relay
.rune_path
.as_ref()
.is_some_and(|path| path != "<rune path>"));
} else if settings.pay_to_relay.processor == Processor::LNBits {
assert_ne!(settings.pay_to_relay.api_secret, "");
}
// Should check that url is valid
assert_ne!(settings.pay_to_relay.node_url, "");
assert_ne!(settings.pay_to_relay.terms_message, "");
if settings.pay_to_relay.direct_message {
assert!(settings
.pay_to_relay
.secret_key
.as_ref()
.is_some_and(|key| key != "<nostr nsec>"));
}
}
Ok(settings)
}
}
impl Default for Settings {
fn default() -> Self {
Settings {
info: Info {
relay_url: None,
name: Some("floonet-rs-relay".to_owned()),
description: Some(
"A Floonet relay for the Grin community Nostr network.".to_owned(),
),
pubkey: None,
contact: None,
favicon: None,
relay_icon: None,
relay_page: None,
},
diagnostics: Diagnostics { tracing: false },
database: Database {
data_directory: ".".to_owned(),
engine: "sqlite".to_owned(),
in_memory: false,
min_conn: 4,
max_conn: 8,
connection: "".to_owned(),
connection_write: None,
},
grpc: Grpc {
event_admission_server: None,
restricts_write: false,
},
network: Network {
port: 8080,
ping_interval_seconds: 300,
address: "0.0.0.0".to_owned(),
remote_ip_header: None,
},
limits: Limits {
messages_per_sec: None,
subscriptions_per_min: None,
db_conns_per_client: None,
max_blocking_threads: 16,
max_event_bytes: Some(2 << 17), // 128K
max_ws_message_bytes: Some(2 << 17), // 128K
max_ws_frame_bytes: Some(2 << 17), // 128K
broadcast_buffer: 16384,
event_persist_buffer: 4096,
event_kind_blacklist: None,
// Floonet keystone: default-deny kind whitelist.
event_kind_allowlist: Some(crate::admission::DEFAULT_ALLOWED_KINDS.to_vec()),
limit_scrapers: false,
},
authorization: Authorization {
pubkey_whitelist: None, // Allow any address to publish
nip42_auth: false, // Disable NIP-42 authentication
nip42_dms: false, // Send DMs to everybody
require_auth_to_write: false,
},
pay_to_relay: PayToRelay {
enabled: false,
admission_cost: 4200,
cost_per_event: 0,
terms_message: "".to_string(),
node_url: "".to_string(),
api_secret: "".to_string(),
rune_path: None,
sign_ups: false,
direct_message: false,
secret_key: None,
processor: Processor::LNBits,
},
goblinpay: GoblinPay {
pay_mode: "off".to_owned(),
url: String::new(),
api_token: String::new(),
name_price_grin: 1.0,
admission_price_grin: 1.0,
},
name_authority: NameAuthority {
enabled: false,
domain: String::new(),
base_url: String::new(),
relays: None,
name_min: 3,
name_max: 20,
name_change_cooldown_secs: 600,
auth_max_age_secs: 60,
read_rate_max: 120,
read_rate_window_secs: 60,
write_rate_max: 10,
write_rate_window_secs: 3600,
reserved_file: None,
},
exit: MixnetExit {
enabled: false,
binary: "/usr/local/bin/floonet-mixexit".to_owned(),
data_dir: "./mixexit-data".to_owned(),
upstream: String::new(),
},
verified_users: VerifiedUsers {
mode: VerifiedUsersMode::Disabled,
domain_whitelist: None,
domain_blacklist: None,
verify_expiration: Some("1 week".to_owned()),
verify_update_frequency: Some("1 day".to_owned()),
verify_expiration_duration: None,
verify_update_frequency_duration: None,
max_consecutive_failures: 20,
},
retention: Retention {
max_events: None, // max events
max_bytes: None, // max size
persist_days: None, // oldest message
whitelist_addresses: None, // whitelisted addresses (never delete)
},
options: Options {
reject_future_seconds: None, // Reject events in the future if defined
},
logging: Logging {
folder_path: None,
file_prefix: None,
},
}
}
}
src/conn.rs
+229
View File
@@ -0,0 +1,229 @@
//! Client connection state
use std::collections::HashMap;
use tracing::{debug, trace};
use uuid::Uuid;
use crate::close::Close;
use crate::conn::Nip42AuthState::{AuthPubkey, Challenge, NoAuth};
use crate::error::Error;
use crate::error::Result;
use crate::event::Event;
use crate::subscription::Subscription;
use crate::utils::{host_str, unix_time};
/// A subscription identifier has a maximum length
const MAX_SUBSCRIPTION_ID_LEN: usize = 256;
/// NIP-42 authentication state
pub enum Nip42AuthState {
/// The client is not authenticated yet
NoAuth,
/// The AUTH challenge sent
Challenge(String),
/// The client is authenticated
AuthPubkey(String),
}
/// State for a client connection
pub struct ClientConn {
/// Client IP (either from socket, or configured proxy header
client_ip_addr: String,
/// Unique client identifier generated at connection time
client_id: Uuid,
/// The current set of active client subscriptions
subscriptions: HashMap<String, Subscription>,
/// Per-connection maximum concurrent subscriptions
max_subs: usize,
/// NIP-42 AUTH
auth: Nip42AuthState,
}
impl Default for ClientConn {
fn default() -> Self {
Self::new("unknown".to_owned())
}
}
impl ClientConn {
/// Create a new, empty connection state.
#[must_use]
pub fn new(client_ip_addr: String) -> Self {
let client_id = Uuid::new_v4();
ClientConn {
client_ip_addr,
client_id,
subscriptions: HashMap::new(),
max_subs: 32,
auth: NoAuth,
}
}
#[must_use]
pub fn subscriptions(&self) -> &HashMap<String, Subscription> {
&self.subscriptions
}
/// Check if the given subscription already exists
#[must_use]
pub fn has_subscription(&self, sub: &Subscription) -> bool {
self.subscriptions.values().any(|x| x == sub)
}
/// Get a short prefix of the client's unique identifier, suitable
/// for logging.
#[must_use]
pub fn get_client_prefix(&self) -> String {
self.client_id.to_string().chars().take(8).collect()
}
#[must_use]
pub fn ip(&self) -> &str {
&self.client_ip_addr
}
#[must_use]
pub fn auth_pubkey(&self) -> Option<&String> {
match &self.auth {
AuthPubkey(pubkey) => Some(pubkey),
_ => None,
}
}
#[must_use]
pub fn auth_challenge(&self) -> Option<&String> {
match &self.auth {
Challenge(pubkey) => Some(pubkey),
_ => None,
}
}
/// Add a new subscription for this connection.
/// # Errors
///
/// Will return `Err` if the client has too many subscriptions, or
/// if the provided name is excessively long.
pub fn subscribe(&mut self, s: Subscription) -> Result<()> {
let k = s.get_id();
let sub_id_len = k.len();
// prevent arbitrarily long subscription identifiers from
// being used.
if sub_id_len > MAX_SUBSCRIPTION_ID_LEN {
debug!(
"ignoring sub request with excessive length: ({})",
sub_id_len
);
return Err(Error::SubIdMaxLengthError);
}
// check if an existing subscription exists, and replace if so
if self.subscriptions.contains_key(&k) {
self.subscriptions.remove(&k);
self.subscriptions.insert(k, s.clone());
trace!(
"replaced existing subscription (cid: {}, sub: {:?})",
self.get_client_prefix(),
s.get_id()
);
return Ok(());
}
// check if there is room for another subscription.
if self.subscriptions.len() >= self.max_subs {
return Err(Error::SubMaxExceededError);
}
// add subscription
self.subscriptions.insert(k, s);
trace!(
"registered new subscription, currently have {} active subs (cid: {})",
self.subscriptions.len(),
self.get_client_prefix(),
);
Ok(())
}
/// Remove the subscription for this connection.
pub fn unsubscribe(&mut self, c: &Close) {
// TODO: return notice if subscription did not exist.
self.subscriptions.remove(&c.id);
trace!(
"removed subscription, currently have {} active subs (cid: {})",
self.subscriptions.len(),
self.get_client_prefix(),
);
}
pub fn generate_auth_challenge(&mut self) {
self.auth = Challenge(Uuid::new_v4().to_string());
}
pub fn authenticate(&mut self, event: &Event, relay_url: &str) -> Result<()> {
match &self.auth {
Challenge(_) => (),
AuthPubkey(_) => {
// already authenticated
return Ok(());
}
NoAuth => {
// unexpected AUTH request
return Err(Error::AuthFailure);
}
}
match event.validate() {
Ok(_) => {
if event.kind != 22242 {
return Err(Error::AuthFailure);
}
let curr_time = unix_time();
let past_cutoff = curr_time - 600; // 10 minutes
let future_cutoff = curr_time + 600; // 10 minutes
if event.created_at < past_cutoff || event.created_at > future_cutoff {
return Err(Error::AuthFailure);
}
let mut challenge: Option<&str> = None;
let mut relay: Option<&str> = None;
for tag in &event.tags {
if tag.len() == 2 && tag.first() == Some(&"challenge".into()) {
challenge = tag.get(1).map(|x| x.as_str());
}
if tag.len() == 2 && tag.first() == Some(&"relay".into()) {
relay = tag.get(1).map(|x| x.as_str());
}
}
match (challenge, &self.auth) {
(Some(received_challenge), Challenge(sent_challenge)) => {
if received_challenge != sent_challenge {
return Err(Error::AuthFailure);
}
}
(_, _) => {
return Err(Error::AuthFailure);
}
}
match (relay.and_then(host_str), host_str(relay_url)) {
(Some(received_relay), Some(our_relay)) => {
if received_relay != our_relay {
return Err(Error::AuthFailure);
}
}
(_, _) => {
return Err(Error::AuthFailure);
}
}
self.auth = AuthPubkey(event.pubkey.clone());
trace!(
"authenticated pubkey {} (cid: {})",
event.pubkey.chars().take(8).collect::<String>(),
self.get_client_prefix()
);
Ok(())
}
Err(_) => Err(Error::AuthFailure),
}
}
}
src/db.rs
+481
View File
@@ -0,0 +1,481 @@
//! Event persistence and querying
use crate::config::Settings;
use crate::error::{Error, Result};
use crate::event::Event;
use crate::nauthz;
use crate::notice::Notice;
use crate::payment::PaymentMessage;
use crate::repo::postgres::{PostgresPool, PostgresRepo};
use crate::repo::sqlite::SqliteRepo;
use crate::repo::NostrRepo;
use crate::server::NostrMetrics;
use governor::clock::Clock;
use governor::{Quota, RateLimiter};
use log::LevelFilter;
use nostr::key::FromPkStr;
use nostr::key::Keys;
use r2d2;
use sqlx::pool::PoolOptions;
use sqlx::postgres::PgConnectOptions;
use sqlx::ConnectOptions;
use std::sync::Arc;
use std::thread;
use std::time::{Duration, Instant};
use tracing::{debug, info, trace, warn};
pub type SqlitePool = r2d2::Pool<r2d2_sqlite::SqliteConnectionManager>;
pub type PooledConnection = r2d2::PooledConnection<r2d2_sqlite::SqliteConnectionManager>;
/// Events submitted from a client, with a return channel for notices
pub struct SubmittedEvent {
pub event: Event,
pub notice_tx: tokio::sync::mpsc::Sender<Notice>,
pub source_ip: String,
pub origin: Option<String>,
pub user_agent: Option<String>,
pub auth_pubkey: Option<Vec<u8>>,
}
/// Database file
pub const DB_FILE: &str = "nostr.db";
/// Build repo
/// # Panics
///
/// Will panic if the pool could not be created.
pub async fn build_repo(settings: &Settings, metrics: NostrMetrics) -> Arc<dyn NostrRepo> {
match settings.database.engine.as_str() {
"sqlite" => Arc::new(build_sqlite_pool(settings, metrics).await),
"postgres" => Arc::new(build_postgres_pool(settings, metrics).await),
_ => panic!("Unknown database engine"),
}
}
async fn build_sqlite_pool(settings: &Settings, metrics: NostrMetrics) -> SqliteRepo {
let repo = SqliteRepo::new(settings, metrics);
repo.start().await.ok();
repo.migrate_up().await.ok();
repo
}
async fn build_postgres_pool(settings: &Settings, metrics: NostrMetrics) -> PostgresRepo {
let mut options: PgConnectOptions = settings.database.connection.as_str().parse().unwrap();
options.log_statements(LevelFilter::Debug);
options.log_slow_statements(LevelFilter::Warn, Duration::from_secs(60));
let pool: PostgresPool = PoolOptions::new()
.max_connections(settings.database.max_conn)
.min_connections(settings.database.min_conn)
.idle_timeout(Duration::from_secs(60))
.connect_with(options)
.await
.unwrap();
let write_pool: PostgresPool = match &settings.database.connection_write {
Some(cfg_write) => {
let mut options_write: PgConnectOptions = cfg_write.as_str().parse().unwrap();
options_write.log_statements(LevelFilter::Debug);
options_write.log_slow_statements(LevelFilter::Warn, Duration::from_secs(60));
PoolOptions::new()
.max_connections(settings.database.max_conn)
.min_connections(settings.database.min_conn)
.idle_timeout(Duration::from_secs(60))
.connect_with(options_write)
.await
.unwrap()
}
None => pool.clone(),
};
let repo = PostgresRepo::new(pool, write_pool, metrics);
// Panic on migration failure
let version = repo.migrate_up().await.unwrap();
info!("Postgres migration completed, at v{}", version);
// startup scheduled tasks
repo.start().await.ok();
repo
}
/// Spawn a database writer that persists events to the `SQLite` store.
pub async fn db_writer(
repo: Arc<dyn NostrRepo>,
settings: Settings,
mut event_rx: tokio::sync::mpsc::Receiver<SubmittedEvent>,
bcast_tx: tokio::sync::broadcast::Sender<Event>,
metadata_tx: tokio::sync::broadcast::Sender<Event>,
payment_tx: tokio::sync::broadcast::Sender<PaymentMessage>,
mut shutdown: tokio::sync::broadcast::Receiver<()>,
) -> Result<()> {
// are we performing NIP-05 checking?
let nip05_active = settings.verified_users.is_active();
// are we requriing NIP-05 user verification?
let nip05_enabled = settings.verified_users.is_enabled();
let pay_to_relay_enabled = settings.pay_to_relay.enabled;
let cost_per_event = settings.pay_to_relay.cost_per_event;
debug!("Pay to relay: {}", pay_to_relay_enabled);
//upgrade_db(&mut pool.get()?)?;
// Make a copy of the whitelist
let whitelist = &settings.authorization.pubkey_whitelist.clone();
// get rate limit settings
let rps_setting = settings.limits.messages_per_sec;
let mut most_recent_rate_limit = Instant::now();
let mut lim_opt = None;
let clock = governor::clock::QuantaClock::default();
if let Some(rps) = rps_setting {
if rps > 0 {
info!("Enabling rate limits for event creation ({}/sec)", rps);
let quota = core::num::NonZeroU32::new(rps * 60).unwrap();
lim_opt = Some(RateLimiter::direct(Quota::per_minute(quota)));
}
}
// create a client if GRPC is enabled.
// Check with externalized event admitter service, if one is defined.
let mut grpc_client = if let Some(svr) = settings.grpc.event_admission_server {
Some(nauthz::EventAuthzService::connect(&svr).await)
} else {
None
};
//let gprc_client = settings.grpc.event_admission_server.map(|s| {
// event_admitter_connect(&s);
// });
loop {
if shutdown.try_recv().is_ok() {
info!("shutting down database writer");
break;
}
// call blocking read on channel
let next_event = event_rx.recv().await;
// if the channel has closed, we will never get work
if next_event.is_none() {
break;
}
// track if an event write occurred; this is used to
// update the rate limiter
let mut event_write = false;
let subm_event = next_event.unwrap();
let event = subm_event.event;
let notice_tx = subm_event.notice_tx;
// Check that event kind isn't blacklisted
let kinds_blacklist = &settings.limits.event_kind_blacklist.clone();
if let Some(event_kind_blacklist) = kinds_blacklist {
if event_kind_blacklist.contains(&event.kind) {
debug!(
"rejecting event: {}, blacklisted kind: {}",
&event.get_event_id_prefix(),
&event.kind
);
notice_tx
.try_send(Notice::blocked(event.id, "event kind is blocked by relay"))
.ok();
continue;
}
}
// Check that event kind isn't allowlisted
let kinds_allowlist = &settings.limits.event_kind_allowlist.clone();
if let Some(event_kind_allowlist) = kinds_allowlist {
if !event_kind_allowlist.contains(&event.kind) {
debug!(
"rejecting event: {}, allowlist kind: {}",
&event.get_event_id_prefix(),
&event.kind
);
notice_tx
.try_send(Notice::blocked(event.id, "event kind is blocked by relay"))
.ok();
continue;
}
}
// Set to none until balance is got from db
// Will stay none if user in whitelisted and does not have to pay to post
// When pay to relay is enabled the whitelist is not a list of who can post
// It is a list of who can post for free
let mut user_balance: Option<u64> = None;
if !pay_to_relay_enabled {
// check if this event is authorized.
if let Some(allowed_addrs) = whitelist {
// TODO: incorporate delegated pubkeys
// if the event address is not in allowed_addrs.
if !allowed_addrs.contains(&event.pubkey) {
debug!(
"rejecting event: {}, unauthorized author",
event.get_event_id_prefix()
);
notice_tx
.try_send(Notice::blocked(
event.id,
"pubkey is not allowed to publish to this relay",
))
.ok();
continue;
}
}
} else {
// If the user is on whitelist there is no need to check if the user is admitted or has balance to post
if whitelist.is_none()
|| (whitelist.is_some() && !whitelist.as_ref().unwrap().contains(&event.pubkey))
{
let key = Keys::from_pk_str(&event.pubkey).unwrap();
match repo.get_account_balance(&key).await {
Ok((user_admitted, balance)) => {
// Checks to make sure user is admitted
if !user_admitted {
debug!("user: {}, is not admitted", &event.pubkey);
// If the user is in DB but not admitted
// Send meeage to payment thread to check if outstanding invoice has been paid
payment_tx
.send(PaymentMessage::CheckAccount(event.pubkey))
.ok();
notice_tx
.try_send(Notice::blocked(event.id, "User is not admitted"))
.ok();
continue;
}
// Checks that user has enough balance to post
// TODO: this should send an invoice to user to top up
if balance < cost_per_event {
debug!("user: {}, does not have a balance", &event.pubkey,);
notice_tx
.try_send(Notice::blocked(event.id, "Insufficient balance"))
.ok();
continue;
}
user_balance = Some(balance);
debug!("User balance: {:?}", user_balance);
}
Err(
Error::SqlError(rusqlite::Error::QueryReturnedNoRows)
| Error::SqlxError(sqlx::Error::RowNotFound),
) => {
// User does not exist
info!("Unregistered user");
if settings.pay_to_relay.sign_ups && settings.pay_to_relay.direct_message {
payment_tx
.send(PaymentMessage::NewAccount(event.pubkey))
.ok();
}
let msg = "Pubkey not registered";
notice_tx.try_send(Notice::error(event.id, msg)).ok();
continue;
}
Err(err) => {
warn!("Error checking admission status: {:?}", err);
let msg = "relay experienced an error checking your admission status";
notice_tx.try_send(Notice::error(event.id, msg)).ok();
// Other error
continue;
}
}
}
}
// get a validation result for use in verification and GPRC
let validation = if nip05_active {
Some(repo.get_latest_user_verification(&event.pubkey).await)
} else {
None
};
// check for NIP-05 verification
if nip05_enabled && validation.is_some() {
match validation.as_ref().unwrap() {
Ok(uv) => {
if uv.is_valid(&settings.verified_users) {
info!(
"new event from verified author ({:?},{:?})",
uv.name.to_string(),
event.get_author_prefix()
);
} else {
info!(
"rejecting event, author ({:?} / {:?}) verification invalid (expired/wrong domain)",
uv.name.to_string(),
event.get_author_prefix()
);
notice_tx
.try_send(Notice::blocked(
event.id,
"NIP-05 verification is no longer valid (expired/wrong domain)",
))
.ok();
continue;
}
}
Err(
Error::SqlError(rusqlite::Error::QueryReturnedNoRows)
| Error::SqlxError(sqlx::Error::RowNotFound),
) => {
debug!(
"no verification records found for pubkey: {:?}",
event.get_author_prefix()
);
notice_tx
.try_send(Notice::blocked(
event.id,
"NIP-05 verification needed to publish events",
))
.ok();
continue;
}
Err(e) => {
warn!("checking nip05 verification status failed: {:?}", e);
continue;
}
}
}
// nip05 address
let nip05_address: Option<crate::nip05::Nip05Name> =
validation.and_then(|x| x.ok().map(|y| y.name));
// GRPC check
if let Some(ref mut c) = grpc_client {
trace!("checking if grpc permits");
let grpc_start = Instant::now();
let decision_res = c
.admit_event(
&event,
&subm_event.source_ip,
subm_event.origin,
subm_event.user_agent,
nip05_address,
subm_event.auth_pubkey,
)
.await;
match decision_res {
Ok(decision) => {
if !decision.permitted() {
// GPRC returned a decision to reject this event
info!(
"GRPC rejected event: {:?} (kind: {}) from: {:?} in: {:?} (IP: {:?})",
event.get_event_id_prefix(),
event.kind,
event.get_author_prefix(),
grpc_start.elapsed(),
subm_event.source_ip
);
notice_tx
.try_send(Notice::blocked(
event.id,
&decision.message().unwrap_or_default(),
))
.ok();
continue;
}
}
Err(e) => {
warn!("GRPC server error: {:?}", e);
}
}
}
// send any metadata events to the NIP-05 verifier
if nip05_active && event.is_kind_metadata() {
// we are sending this prior to even deciding if we
// persist it. this allows the nip05 module to
// inspect it, update if necessary, or persist a new
// event and broadcast it itself.
metadata_tx.send(event.clone()).ok();
}
// TODO: cache recent list of authors to remove a DB call.
let start = Instant::now();
if event.is_ephemeral() {
bcast_tx.send(event.clone()).ok();
debug!(
"published ephemeral event: {:?} from: {:?} in: {:?}",
event.get_event_id_prefix(),
event.get_author_prefix(),
start.elapsed()
);
event_write = true;
// send OK message
notice_tx.try_send(Notice::saved(event.id)).ok();
} else {
match repo.write_event(&event).await {
Ok(updated) => {
if updated == 0 {
trace!("ignoring duplicate or deleted event");
notice_tx.try_send(Notice::duplicate(event.id)).ok();
} else {
info!(
"persisted event: {:?} (kind: {}) from: {:?} in: {:?} (IP: {:?})",
event.get_event_id_prefix(),
event.kind,
event.get_author_prefix(),
start.elapsed(),
subm_event.source_ip,
);
event_write = true;
// send this out to all clients
bcast_tx.send(event.clone()).ok();
notice_tx.try_send(Notice::saved(event.id)).ok();
}
}
Err(err) => {
warn!("event insert failed: {:?}", err);
let msg = "relay experienced an error trying to publish the latest event";
notice_tx.try_send(Notice::error(event.id, msg)).ok();
}
}
}
// use rate limit, if defined, and if an event was actually written.
if event_write {
// If pay to relay is diabaled or the cost per event is 0
// No need to update user balance
if pay_to_relay_enabled && cost_per_event > 0 {
// If the user balance is some, user was not on whitelist
// Their balance should be reduced by the cost per event
if let Some(_balance) = user_balance {
let pubkey = Keys::from_pk_str(&event.pubkey)?;
repo.update_account_balance(&pubkey, false, cost_per_event)
.await?;
}
}
if let Some(ref lim) = lim_opt {
if let Err(n) = lim.check() {
let wait_for = n.wait_time_from(clock.now());
// check if we have recently logged rate
// limits, but print out a message only once
// per second.
if most_recent_rate_limit.elapsed().as_secs() > 10 {
warn!(
"rate limit reached for event creation (sleep for {:?}) (suppressing future messages for 10 seconds)",
wait_for
);
// reset last rate limit message
most_recent_rate_limit = Instant::now();
}
// block event writes, allowing them to queue up
thread::sleep(wait_for);
continue;
}
}
}
}
info!("database connection closed");
Ok(())
}
/// Serialized event associated with a specific subscription request.
#[derive(PartialEq, Eq, Debug, Clone)]
pub struct QueryResult {
/// Subscription identifier
pub sub_id: String,
/// Serialized event
pub event: String,
}
src/delegation.rs
+406
View File
@@ -0,0 +1,406 @@
//! Event parsing and validation
use crate::error::Error;
use crate::error::Result;
use crate::event::Event;
use bitcoin_hashes::{sha256, Hash};
use lazy_static::lazy_static;
use regex::Regex;
use secp256k1::{schnorr, Secp256k1, VerifyOnly, XOnlyPublicKey};
use serde::{Deserialize, Serialize};
use std::str::FromStr;
use tracing::{debug, info};
// This handles everything related to delegation, in particular the
// condition/rune parsing and logic.
// Conditions are poorly specified, so we will implement the minimum
// necessary for now.
// fields MUST be either "kind" or "created_at".
// operators supported are ">", "<", "=", "!".
// no operations on 'content' are supported.
// this allows constraints for:
// valid date ranges (valid from X->Y dates).
// specific kinds (publish kind=1,5)
// kind ranges (publish ephemeral events, kind>19999&kind<30001)
// for more complex scenarios (allow delegatee to publish ephemeral
// AND replacement events), it may be necessary to generate and use
// different condition strings, since we do not support grouping or
// "OR" logic.
lazy_static! {
/// Secp256k1 verification instance.
pub static ref SECP: Secp256k1<VerifyOnly> = Secp256k1::verification_only();
}
#[derive(Serialize, Deserialize, PartialEq, Eq, Debug, Clone)]
pub enum Field {
Kind,
CreatedAt,
}
impl FromStr for Field {
type Err = Error;
fn from_str(value: &str) -> Result<Self, Self::Err> {
if value == "kind" {
Ok(Field::Kind)
} else if value == "created_at" {
Ok(Field::CreatedAt)
} else {
Err(Error::DelegationParseError)
}
}
}
#[derive(Serialize, Deserialize, PartialEq, Eq, Debug, Clone)]
pub enum Operator {
LessThan,
GreaterThan,
Equals,
NotEquals,
}
impl FromStr for Operator {
type Err = Error;
fn from_str(value: &str) -> Result<Self, Self::Err> {
if value == "<" {
Ok(Operator::LessThan)
} else if value == ">" {
Ok(Operator::GreaterThan)
} else if value == "=" {
Ok(Operator::Equals)
} else if value == "!" {
Ok(Operator::NotEquals)
} else {
Err(Error::DelegationParseError)
}
}
}
#[derive(Serialize, Deserialize, PartialEq, Eq, Debug, Clone)]
pub struct ConditionQuery {
pub conditions: Vec<Condition>,
}
impl ConditionQuery {
#[must_use]
pub fn allows_event(&self, event: &Event) -> bool {
// check each condition, to ensure that the event complies
// with the restriction.
for c in &self.conditions {
if !c.allows_event(event) {
// any failing conditions invalidates the delegation
// on this event
return false;
}
}
// delegation was permitted unconditionally, or all conditions
// were true
true
}
}
// Verify that the delegator approved the delegation; return a ConditionQuery if so.
#[must_use]
pub fn validate_delegation(
delegator: &str,
delegatee: &str,
cond_query: &str,
sigstr: &str,
) -> Option<ConditionQuery> {
// form the token
let tok = format!("nostr:delegation:{delegatee}:{cond_query}");
// form SHA256 hash
let digest: sha256::Hash = sha256::Hash::hash(tok.as_bytes());
let sig = schnorr::Signature::from_str(sigstr).unwrap();
if let Ok(msg) = secp256k1::Message::from_slice(digest.as_ref()) {
if let Ok(pubkey) = XOnlyPublicKey::from_str(delegator) {
let verify = SECP.verify_schnorr(&sig, &msg, &pubkey);
if verify.is_ok() {
// return the parsed condition query
cond_query.parse::<ConditionQuery>().ok()
} else {
debug!("client sent an delegation signature that did not validate");
None
}
} else {
debug!("client sent malformed delegation pubkey");
None
}
} else {
info!("error converting delegation digest to secp256k1 message");
None
}
}
/// Parsed delegation condition
/// see <https://github.com/nostr-protocol/nips/pull/28#pullrequestreview-1084903800>
/// An example complex condition would be: `kind=1,2,3&created_at<1665265999`
#[derive(Serialize, Deserialize, PartialEq, Eq, Debug, Clone)]
pub struct Condition {
pub field: Field,
pub operator: Operator,
pub values: Vec<u64>,
}
impl Condition {
/// Check if this condition allows the given event to be delegated
#[must_use]
pub fn allows_event(&self, event: &Event) -> bool {
// determine what the right-hand side of the operator is
let resolved_field = match &self.field {
Field::Kind => event.kind,
Field::CreatedAt => event.created_at,
};
match &self.operator {
Operator::LessThan => {
// the less-than operator is only valid for single values.
if self.values.len() == 1 {
if let Some(v) = self.values.first() {
return resolved_field < *v;
}
}
}
Operator::GreaterThan => {
// the greater-than operator is only valid for single values.
if self.values.len() == 1 {
if let Some(v) = self.values.first() {
return resolved_field > *v;
}
}
}
Operator::Equals => {
// equals is interpreted as "must be equal to at least one provided value"
return self.values.iter().any(|&x| resolved_field == x);
}
Operator::NotEquals => {
// not-equals is interpreted as "must not be equal to any provided value"
// this is the one case where an empty list of values could be allowed; even though it is a pointless restriction.
return self.values.iter().all(|&x| resolved_field != x);
}
}
false
}
}
fn str_to_condition(cs: &str) -> Option<Condition> {
// a condition is a string (alphanum+underscore), an operator (<>=!), and values (num+comma)
lazy_static! {
static ref RE: Regex = Regex::new("([[:word:]]+)([<>=!]+)([,[[:digit:]]]*)").unwrap();
}
// match against the regex
let caps = RE.captures(cs)?;
let field = caps.get(1)?.as_str().parse::<Field>().ok()?;
let operator = caps.get(2)?.as_str().parse::<Operator>().ok()?;
// values are just comma separated numbers, but all must be parsed
let rawvals = caps.get(3)?.as_str();
let values = rawvals
.split_terminator(',')
.map(|n| n.parse::<u64>().ok())
.collect::<Option<Vec<_>>>()?;
// convert field string into Field
Some(Condition {
field,
operator,
values,
})
}
/// Parse a condition query from a string slice
impl FromStr for ConditionQuery {
type Err = Error;
fn from_str(value: &str) -> Result<Self, Self::Err> {
// split the string with '&'
let mut conditions = vec![];
let condstrs = value.split_terminator('&');
// parse each individual condition
for c in condstrs {
conditions.push(str_to_condition(c).ok_or(Error::DelegationParseError)?);
}
Ok(ConditionQuery { conditions })
}
}
#[cfg(test)]
mod tests {
use super::*;
// parse condition strings
#[test]
fn parse_empty() -> Result<()> {
// given an empty condition query, produce an empty vector
let empty_cq = ConditionQuery { conditions: vec![] };
let parsed = "".parse::<ConditionQuery>()?;
assert_eq!(parsed, empty_cq);
Ok(())
}
// parse field 'kind'
#[test]
fn test_kind_field_parse() -> Result<()> {
let field = "kind".parse::<Field>()?;
assert_eq!(field, Field::Kind);
Ok(())
}
// parse field 'created_at'
#[test]
fn test_created_at_field_parse() -> Result<()> {
let field = "created_at".parse::<Field>()?;
assert_eq!(field, Field::CreatedAt);
Ok(())
}
// parse unknown field
#[test]
fn unknown_field_parse() {
let field = "unk".parse::<Field>();
assert!(field.is_err());
}
// parse a full conditional query with an empty array
#[test]
fn parse_kind_equals_empty() -> Result<()> {
// given an empty condition query, produce an empty vector
let kind_cq = ConditionQuery {
conditions: vec![Condition {
field: Field::Kind,
operator: Operator::Equals,
values: vec![],
}],
};
let parsed = "kind=".parse::<ConditionQuery>()?;
assert_eq!(parsed, kind_cq);
Ok(())
}
// parse a full conditional query with a single value
#[test]
fn parse_kind_equals_singleval() -> Result<()> {
// given an empty condition query, produce an empty vector
let kind_cq = ConditionQuery {
conditions: vec![Condition {
field: Field::Kind,
operator: Operator::Equals,
values: vec![1],
}],
};
let parsed = "kind=1".parse::<ConditionQuery>()?;
assert_eq!(parsed, kind_cq);
Ok(())
}
// parse a full conditional query with multiple values
#[test]
fn parse_kind_equals_multival() -> Result<()> {
// given an empty condition query, produce an empty vector
let kind_cq = ConditionQuery {
conditions: vec![Condition {
field: Field::Kind,
operator: Operator::Equals,
values: vec![1, 2, 4],
}],
};
let parsed = "kind=1,2,4".parse::<ConditionQuery>()?;
assert_eq!(parsed, kind_cq);
Ok(())
}
// parse multiple conditions
#[test]
fn parse_multi_conditions() -> Result<()> {
// given an empty condition query, produce an empty vector
let cq = ConditionQuery {
conditions: vec![
Condition {
field: Field::Kind,
operator: Operator::GreaterThan,
values: vec![10000],
},
Condition {
field: Field::Kind,
operator: Operator::LessThan,
values: vec![20000],
},
Condition {
field: Field::Kind,
operator: Operator::NotEquals,
values: vec![10001],
},
Condition {
field: Field::CreatedAt,
operator: Operator::LessThan,
values: vec![1_665_867_123],
},
],
};
let parsed =
"kind>10000&kind<20000&kind!10001&created_at<1665867123".parse::<ConditionQuery>()?;
assert_eq!(parsed, cq);
Ok(())
}
// Check for condition logic on event w/ empty values
#[test]
fn condition_with_empty_values() {
let mut c = Condition {
field: Field::Kind,
operator: Operator::GreaterThan,
values: vec![],
};
let e = Event::simple_event();
assert!(!c.allows_event(&e));
c.operator = Operator::LessThan;
assert!(!c.allows_event(&e));
c.operator = Operator::Equals;
assert!(!c.allows_event(&e));
// Not Equals applied to an empty list *is* allowed
// (pointless, but logically valid).
c.operator = Operator::NotEquals;
assert!(c.allows_event(&e));
}
// Check for condition logic on event w/ single value
#[test]
fn condition_kind_gt_event_single() {
let c = Condition {
field: Field::Kind,
operator: Operator::GreaterThan,
values: vec![10],
};
let mut e = Event::simple_event();
// kind is not greater than 10, not allowed
e.kind = 1;
assert!(!c.allows_event(&e));
// kind is greater than 10, allowed
e.kind = 100;
assert!(c.allows_event(&e));
// kind is 10, not allowed
e.kind = 10;
assert!(!c.allows_event(&e));
}
// Check for condition logic on event w/ multi values
#[test]
fn condition_with_multi_values() {
let mut c = Condition {
field: Field::Kind,
operator: Operator::Equals,
values: vec![0, 10, 20],
};
let mut e = Event::simple_event();
// Allow if event kind is in list for Equals
e.kind = 10;
assert!(c.allows_event(&e));
// Deny if event kind is not in list for Equals
e.kind = 11;
assert!(!c.allows_event(&e));
// Deny if event kind is in list for NotEquals
e.kind = 10;
c.operator = Operator::NotEquals;
assert!(!c.allows_event(&e));
// Allow if event kind is not in list for NotEquals
e.kind = 99;
c.operator = Operator::NotEquals;
assert!(c.allows_event(&e));
// Always deny if GreaterThan/LessThan for a list
c.operator = Operator::LessThan;
assert!(!c.allows_event(&e));
c.operator = Operator::GreaterThan;
assert!(!c.allows_event(&e));
}
}
src/error.rs
+192
View File
@@ -0,0 +1,192 @@
//! Error handling
use std::result;
use thiserror::Error;
use tungstenite::error::Error as WsError;
/// Simple `Result` type for errors in this module
pub type Result<T, E = Error> = result::Result<T, E>;
/// Custom error type for Nostr
#[derive(Error, Debug)]
pub enum Error {
#[error("Protocol parse error")]
ProtoParseError,
#[error("Connection error")]
ConnError,
#[error("Client write error")]
ConnWriteError,
#[error("EVENT parse failed")]
EventParseFailed,
#[error("CLOSE message parse failed")]
CloseParseFailed,
#[error("Event invalid signature")]
EventInvalidSignature,
#[error("Event invalid id")]
EventInvalidId,
#[error("Event malformed pubkey")]
EventMalformedPubkey,
#[error("Event could not canonicalize")]
EventCouldNotCanonicalize,
#[error("Event too large")]
EventMaxLengthError(usize),
#[error("Subscription identifier max length exceeded")]
SubIdMaxLengthError,
#[error("Maximum concurrent subscription count reached")]
SubMaxExceededError,
// this should be used if the JSON is invalid
#[error("JSON parsing failed")]
JsonParseFailed(serde_json::Error),
#[error("WebSocket proto error")]
WebsocketError(WsError),
#[error("Command unknown")]
CommandUnknownError,
#[error("SQL error")]
SqlError(rusqlite::Error),
#[error("Config error : {0}")]
ConfigError(config::ConfigError),
#[error("Data directory does not exist")]
DatabaseDirError,
#[error("Database Connection Pool Error")]
DatabasePoolError(r2d2::Error),
#[error("SQL error")]
SqlxError(sqlx::Error),
#[error("Database Connection Pool Error")]
SqlxDatabasePoolError(sqlx::Error),
#[error("Custom Error : {0}")]
CustomError(String),
#[error("Task join error")]
JoinError,
#[error("Hyper Client error")]
HyperError(hyper::Error),
#[error("Hex encoding error")]
HexError(hex::FromHexError),
#[error("Delegation parse error")]
DelegationParseError,
#[error("Channel closed error")]
ChannelClosed,
#[error("Authz error")]
AuthzError,
#[error("Tonic GRPC error")]
TonicError(tonic::Status),
#[error("Invalid AUTH message")]
AuthFailure,
#[error("I/O Error")]
IoError(std::io::Error),
#[error("Event builder error")]
EventError(nostr::event::builder::Error),
#[error("Nostr key error")]
NostrKeyError(nostr::key::Error),
#[error("Payment hash mismatch")]
PaymentHash,
#[error("Error parsing url")]
URLParseError(url::ParseError),
#[error("HTTP error")]
HTTPError(http::Error),
#[error("Unknown/Undocumented")]
UnknownError,
}
//impl From<Box<dyn std::error::Error>> for Error {
// fn from(e: Box<dyn std::error::Error>) -> Self {
// Error::CustomError("error".to_owned())
// }
//}
impl From<hex::FromHexError> for Error {
fn from(h: hex::FromHexError) -> Self {
Error::HexError(h)
}
}
impl From<hyper::Error> for Error {
fn from(h: hyper::Error) -> Self {
Error::HyperError(h)
}
}
impl From<r2d2::Error> for Error {
fn from(d: r2d2::Error) -> Self {
Error::DatabasePoolError(d)
}
}
impl From<tokio::task::JoinError> for Error {
/// Wrap SQL error
fn from(_j: tokio::task::JoinError) -> Self {
Error::JoinError
}
}
impl From<rusqlite::Error> for Error {
/// Wrap SQL error
fn from(r: rusqlite::Error) -> Self {
Error::SqlError(r)
}
}
impl From<sqlx::Error> for Error {
fn from(d: sqlx::Error) -> Self {
Error::SqlxDatabasePoolError(d)
}
}
impl From<serde_json::Error> for Error {
/// Wrap JSON error
fn from(r: serde_json::Error) -> Self {
Error::JsonParseFailed(r)
}
}
impl From<WsError> for Error {
/// Wrap Websocket error
fn from(r: WsError) -> Self {
Error::WebsocketError(r)
}
}
impl From<config::ConfigError> for Error {
/// Wrap Config error
fn from(r: config::ConfigError) -> Self {
Error::ConfigError(r)
}
}
impl From<tonic::Status> for Error {
/// Wrap Config error
fn from(r: tonic::Status) -> Self {
Error::TonicError(r)
}
}
impl From<std::io::Error> for Error {
fn from(r: std::io::Error) -> Self {
Error::IoError(r)
}
}
impl From<nostr::event::builder::Error> for Error {
/// Wrap event builder error
fn from(r: nostr::event::builder::Error) -> Self {
Error::EventError(r)
}
}
impl From<nostr::key::Error> for Error {
/// Wrap nostr key error
fn from(r: nostr::key::Error) -> Self {
Error::NostrKeyError(r)
}
}
impl From<url::ParseError> for Error {
/// Wrap nostr key error
fn from(r: url::ParseError) -> Self {
Error::URLParseError(r)
}
}
impl From<http::Error> for Error {
/// Wrap nostr key error
fn from(r: http::Error) -> Self {
Error::HTTPError(r)
}
}
src/event.rs
+798
View File
@@ -0,0 +1,798 @@
//! Event parsing and validation
use crate::delegation::validate_delegation;
use crate::error::Error::{
CommandUnknownError, EventCouldNotCanonicalize, EventInvalidId, EventInvalidSignature,
EventMalformedPubkey,
};
use crate::error::Result;
use crate::event::EventWrapper::WrappedAuth;
use crate::event::EventWrapper::WrappedEvent;
use crate::nip05;
use crate::utils::unix_time;
use bitcoin_hashes::{sha256, Hash};
use lazy_static::lazy_static;
use secp256k1::{schnorr, Secp256k1, VerifyOnly, XOnlyPublicKey};
use serde::{Deserialize, Deserializer, Serialize};
use serde_json::value::Value;
use serde_json::Number;
use std::collections::HashMap;
use std::collections::HashSet;
use std::str::FromStr;
use tracing::{debug, info};
use crate::subscription::TagOperand;
lazy_static! {
/// Secp256k1 verification instance.
pub static ref SECP: Secp256k1<VerifyOnly> = Secp256k1::verification_only();
}
/// Event command in network format.
#[derive(Serialize, Deserialize, PartialEq, Eq, Debug, Clone)]
pub struct EventCmd {
// expecting static "EVENT"
cmd: String,
event: Event,
}
impl EventCmd {
#[must_use]
pub fn event_id(&self) -> &str {
&self.event.id
}
}
/// Parsed nostr event.
#[derive(Serialize, Deserialize, PartialEq, Eq, Debug, Clone)]
pub struct Event {
pub id: String,
pub pubkey: String,
#[serde(skip)]
pub delegated_by: Option<String>,
pub created_at: u64,
pub kind: u64,
#[serde(deserialize_with = "tag_from_string")]
// NOTE: array-of-arrays may need to be more general than a string container
pub tags: Vec<Vec<String>>,
pub content: String,
pub sig: String,
// Optimization for tag search, built on demand.
#[serde(skip)]
pub tagidx: Option<HashMap<char, HashSet<String>>>,
}
/// Simple tag type for array of array of strings.
type Tag = Vec<Vec<String>>;
/// Deserializer that ensures we always have a [`Tag`].
fn tag_from_string<'de, D>(deserializer: D) -> Result<Tag, D::Error>
where
D: Deserializer<'de>,
{
let opt = Option::deserialize(deserializer)?;
Ok(opt.unwrap_or_default())
}
/// Attempt to form a single-char tag name.
#[must_use]
pub fn single_char_tagname(tagname: &str) -> Option<char> {
// We return the tag character if and only if the tagname consists
// of a single char.
let mut tagnamechars = tagname.chars();
let firstchar = tagnamechars.next();
match firstchar {
Some(_) => {
// check second char
if tagnamechars.next().is_none() {
firstchar
} else {
None
}
}
None => None,
}
}
pub enum EventWrapper {
WrappedEvent(Event),
WrappedAuth(Event),
}
/// Convert network event to parsed/validated event.
impl From<EventCmd> for Result<EventWrapper> {
fn from(ec: EventCmd) -> Result<EventWrapper> {
// ensure command is correct
if ec.cmd == "EVENT" {
ec.event.validate().map(|_| {
let mut e = ec.event;
e.build_index();
e.update_delegation();
WrappedEvent(e)
})
} else if ec.cmd == "AUTH" {
// we don't want to validate the event here, because NIP-42 can be disabled
// it will be validated later during the authentication process
Ok(WrappedAuth(ec.event))
} else {
Err(CommandUnknownError)
}
}
}
impl Event {
#[cfg(test)]
#[must_use]
pub fn simple_event() -> Event {
Event {
id: "0".to_owned(),
pubkey: "0".to_owned(),
delegated_by: None,
created_at: 0,
kind: 0,
tags: vec![],
content: "".to_owned(),
sig: "0".to_owned(),
tagidx: None,
}
}
#[must_use]
pub fn is_kind_metadata(&self) -> bool {
self.kind == 0
}
/// Should this event be persisted?
#[must_use]
pub fn is_ephemeral(&self) -> bool {
self.kind >= 20000 && self.kind < 30000
}
/// Is this event currently expired?
pub fn is_expired(&self) -> bool {
if let Some(exp) = self.expiration() {
exp <= unix_time()
} else {
false
}
}
/// Determine the time at which this event should expire
pub fn expiration(&self) -> Option<u64> {
let default = "".to_string();
let dvals: Vec<&String> = self
.tags
.iter()
.filter(|x| !x.is_empty())
.filter(|x| x.first().unwrap() == "expiration")
.map(|x| x.get(1).unwrap_or(&default))
.take(1)
.collect();
let val_first = dvals.first();
val_first.and_then(|t| t.parse::<u64>().ok())
}
/// Should this event be replaced with newer timestamps from same author?
#[must_use]
pub fn is_replaceable(&self) -> bool {
self.kind == 0
|| self.kind == 3
|| self.kind == 41
|| (self.kind >= 10000 && self.kind < 20000)
}
/// Should this event be replaced with newer timestamps from same author, for distinct `d` tag values?
#[must_use]
pub fn is_param_replaceable(&self) -> bool {
self.kind >= 30000 && self.kind < 40000
}
/// Should this event be replaced with newer timestamps from same author, for distinct `d` tag values?
#[must_use]
pub fn distinct_param(&self) -> Option<String> {
if self.is_param_replaceable() {
let default = "".to_string();
let dvals: Vec<&String> = self
.tags
.iter()
.filter(|x| !x.is_empty())
.filter(|x| x.first().unwrap() == "d")
.map(|x| x.get(1).unwrap_or(&default))
.take(1)
.collect();
let dval_first = dvals.first();
match dval_first {
Some(_) => dval_first.map(|x| x.to_string()),
None => Some(default),
}
} else {
None
}
}
/// Pull a NIP-05 Name out of the event, if one exists
#[must_use]
pub fn get_nip05_addr(&self) -> Option<nip05::Nip05Name> {
if self.is_kind_metadata() {
// very quick check if we should attempt to parse this json
if self.content.contains("\"nip05\"") {
// Parse into JSON
let md_parsed: Value = serde_json::from_str(&self.content).ok()?;
let md_map = md_parsed.as_object()?;
let nip05_str = md_map.get("nip05")?.as_str()?;
return nip05::Nip05Name::try_from(nip05_str).ok();
}
}
None
}
// is this event delegated (properly)?
// does the signature match, and are conditions valid?
// if so, return an alternate author for the event
#[must_use]
pub fn delegated_author(&self) -> Option<String> {
// is there a delegation tag?
let delegation_tag: Vec<String> = self
.tags
.iter()
.filter(|x| x.len() == 4)
.filter(|x| x.first().unwrap() == "delegation")
.take(1)
.next()?
.clone(); // get first tag
//let delegation_tag = self.tag_values_by_name("delegation");
// delegation tags should have exactly 3 elements after the name (pubkey, condition, sig)
// the event is signed by the delagatee
let delegatee = &self.pubkey;
// the delegation tag references the claimed delagator
let delegator: &str = delegation_tag.get(1)?;
let querystr: &str = delegation_tag.get(2)?;
let sig: &str = delegation_tag.get(3)?;
// attempt to get a condition query; this requires the delegation to have a valid signature.
if let Some(cond_query) = validate_delegation(delegator, delegatee, querystr, sig) {
// The signature was valid, now we ensure the delegation
// condition is valid for this event:
if cond_query.allows_event(self) {
// since this is allowed, we will provide the delegatee
Some(delegator.into())
} else {
debug!("an event failed to satisfy delegation conditions");
None
}
} else {
debug!("event had had invalid delegation signature");
None
}
}
/// Update delegation status
pub fn update_delegation(&mut self) {
self.delegated_by = self.delegated_author();
}
/// Build an event tag index
pub fn build_index(&mut self) {
// if there are no tags; just leave the index as None
if self.tags.is_empty() {
return;
}
// otherwise, build an index
let mut idx: HashMap<char, HashSet<String>> = HashMap::new();
// iterate over tags that have at least 2 elements
for t in self.tags.iter().filter(|x| x.len() > 1) {
let tagname = t.first().unwrap();
let tagnamechar_opt = single_char_tagname(tagname);
if tagnamechar_opt.is_none() {
continue;
}
let tagnamechar = tagnamechar_opt.unwrap();
let tagval = t.get(1).unwrap();
// ensure a vector exists for this tag
idx.entry(tagnamechar).or_default();
// get the tag vec and insert entry
let idx_tag_vec = idx.get_mut(&tagnamechar).expect("could not get tag vector");
idx_tag_vec.insert(tagval.clone());
}
// save the tag structure
self.tagidx = Some(idx);
}
/// Create a short event identifier, suitable for logging.
#[must_use]
pub fn get_event_id_prefix(&self) -> String {
self.id.chars().take(8).collect()
}
#[must_use]
pub fn get_author_prefix(&self) -> String {
self.pubkey.chars().take(8).collect()
}
/// Retrieve tag initial values across all tags matching the name
#[must_use]
pub fn tag_values_by_name(&self, tag_name: &str) -> Vec<String> {
self.tags
.iter()
.filter(|x| x.len() > 1)
.filter(|x| x.first().unwrap() == tag_name)
.map(|x| x.get(1).unwrap().clone())
.collect()
}
#[must_use]
pub fn is_valid_timestamp(&self, reject_future_seconds: Option<usize>) -> bool {
if let Some(allowable_future) = reject_future_seconds {
let curr_time = unix_time();
// calculate difference, plus how far future we allow
if curr_time + (allowable_future as u64) < self.created_at {
let delta = self.created_at - curr_time;
debug!(
"event is too far in the future ({} seconds), rejecting",
delta
);
return false;
}
}
true
}
/// Check if this event has a valid signature.
pub fn validate(&self) -> Result<()> {
// TODO: return a Result with a reason for invalid events
// validation is performed by:
// * parsing JSON string into event fields
// * create an array:
// ** [0, pubkey-hex-string, created-at-num, kind-num, tags-array-of-arrays, content-string]
// * serialize with no spaces/newlines
let c_opt = self.to_canonical();
if c_opt.is_none() {
debug!("could not canonicalize");
return Err(EventCouldNotCanonicalize);
}
let c = c_opt.unwrap();
// * compute the sha256sum.
let digest: sha256::Hash = sha256::Hash::hash(c.as_bytes());
let hex_digest = format!("{digest:x}");
// * ensure the id matches the computed sha256sum.
if self.id != hex_digest {
debug!("event id does not match digest");
return Err(EventInvalidId);
}
// * validate the message digest (sig) using the pubkey & computed sha256 message hash.
let sig = schnorr::Signature::from_str(&self.sig).map_err(|_| EventInvalidSignature)?;
if let Ok(msg) = secp256k1::Message::from_slice(digest.as_ref()) {
if let Ok(pubkey) = XOnlyPublicKey::from_str(&self.pubkey) {
SECP.verify_schnorr(&sig, &msg, &pubkey)
.map_err(|_| EventInvalidSignature)
} else {
debug!("client sent malformed pubkey");
Err(EventMalformedPubkey)
}
} else {
info!("error converting digest to secp256k1 message");
Err(EventInvalidSignature)
}
}
/// Convert event to canonical representation for signing.
pub fn to_canonical(&self) -> Option<String> {
// create a JsonValue for each event element
let mut c: Vec<Value> = vec![];
// id must be set to 0
let id = Number::from(0_u64);
c.push(serde_json::Value::Number(id));
// public key
c.push(Value::String(self.pubkey.clone()));
// creation time
let created_at = Number::from(self.created_at);
c.push(serde_json::Value::Number(created_at));
// kind
let kind = Number::from(self.kind);
c.push(serde_json::Value::Number(kind));
// tags
c.push(self.tags_to_canonical());
// content
c.push(Value::String(self.content.clone()));
serde_json::to_string(&Value::Array(c)).ok()
}
/// Convert tags to a canonical form for signing.
fn tags_to_canonical(&self) -> Value {
let mut tags = Vec::<Value>::new();
// iterate over self tags,
for t in &self.tags {
// each tag is a vec of strings
let mut a = Vec::<Value>::new();
for v in t.iter() {
a.push(serde_json::Value::String(v.clone()));
}
tags.push(serde_json::Value::Array(a));
}
serde_json::Value::Array(tags)
}
/// Determine if the given tag and value set intersect with tags in this event.
#[must_use]
pub fn generic_tag_val_intersect(&self, tagname: char, check: &TagOperand) -> bool {
match &self.tagidx {
// check if this is indexable tagname
Some(idx) => match idx.get(&tagname) {
Some(valset) => {
match &check {
TagOperand::And(v) => valset.intersection(v).count() == v.len(),
TagOperand::Or(v) => valset.intersection(v).count() > 0
}
}
None => false,
},
None => false,
}
}
}
impl From<nostr::Event> for Event {
fn from(nostr_event: nostr::Event) -> Self {
Event {
id: nostr_event.id.to_hex(),
pubkey: nostr_event.pubkey.to_string(),
created_at: nostr_event.created_at.as_u64(),
kind: nostr_event.kind.as_u64(),
tags: nostr_event.tags.iter().map(|x| x.as_vec()).collect(),
content: nostr_event.content,
sig: nostr_event.sig.to_string(),
delegated_by: None,
tagidx: None,
}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn event_creation() {
// create an event
let event = Event::simple_event();
assert_eq!(event.id, "0");
}
#[test]
fn event_serialize() -> Result<()> {
// serialize an event to JSON string
let event = Event::simple_event();
let j = serde_json::to_string(&event)?;
assert_eq!(j, "{\"id\":\"0\",\"pubkey\":\"0\",\"created_at\":0,\"kind\":0,\"tags\":[],\"content\":\"\",\"sig\":\"0\"}");
Ok(())
}
#[test]
fn empty_event_tag_match() {
let event = Event::simple_event();
assert!(!event
.generic_tag_val_intersect('e', &TagOperand::Or(HashSet::from(["foo".to_owned(), "bar".to_owned()]))));
}
#[test]
fn single_event_tag_match() {
let mut event = Event::simple_event();
event.tags = vec![vec!["e".to_owned(), "foo".to_owned()]];
event.build_index();
assert!(
event.generic_tag_val_intersect(
'e',
&TagOperand::Or(HashSet::from(["foo".to_owned(), "bar".to_owned()])),
)
);
}
#[test]
fn event_tags_serialize() -> Result<()> {
// serialize an event with tags to JSON string
let mut event = Event::simple_event();
event.tags = vec![
vec![
"e".to_owned(),
"xxxx".to_owned(),
"wss://example.com".to_owned(),
],
vec![
"p".to_owned(),
"yyyyy".to_owned(),
"wss://example.com:3033".to_owned(),
],
];
let j = serde_json::to_string(&event)?;
assert_eq!(j, "{\"id\":\"0\",\"pubkey\":\"0\",\"created_at\":0,\"kind\":0,\"tags\":[[\"e\",\"xxxx\",\"wss://example.com\"],[\"p\",\"yyyyy\",\"wss://example.com:3033\"]],\"content\":\"\",\"sig\":\"0\"}");
Ok(())
}
#[test]
fn event_deserialize() -> Result<()> {
let raw_json = r#"{"id":"1384757da583e6129ce831c3d7afc775a33a090578f888dd0d010328ad047d0c","pubkey":"bbbd9711d357df4f4e498841fd796535c95c8e751fa35355008a911c41265fca","created_at":1612650459,"kind":1,"tags":null,"content":"hello world","sig":"59d0cc47ab566e81f72fe5f430bcfb9b3c688cb0093d1e6daa49201c00d28ecc3651468b7938642869ed98c0f1b262998e49a05a6ed056c0d92b193f4e93bc21"}"#;
let e: Event = serde_json::from_str(raw_json)?;
assert_eq!(e.kind, 1);
assert_eq!(e.tags.len(), 0);
Ok(())
}
#[test]
fn event_canonical() {
let e = Event {
id: "999".to_owned(),
pubkey: "012345".to_owned(),
delegated_by: None,
created_at: 501_234,
kind: 1,
tags: vec![],
content: "this is a test".to_owned(),
sig: "abcde".to_owned(),
tagidx: None,
};
let c = e.to_canonical();
let expected = Some(r#"[0,"012345",501234,1,[],"this is a test"]"#.to_owned());
assert_eq!(c, expected);
}
#[test]
fn event_tag_select() {
let e = Event {
id: "999".to_owned(),
pubkey: "012345".to_owned(),
delegated_by: None,
created_at: 501_234,
kind: 1,
tags: vec![
vec!["j".to_owned(), "abc".to_owned()],
vec!["e".to_owned(), "foo".to_owned()],
vec!["e".to_owned(), "bar".to_owned()],
vec!["e".to_owned(), "baz".to_owned()],
vec![
"p".to_owned(),
"aaaa".to_owned(),
"ws://example.com".to_owned(),
],
],
content: "this is a test".to_owned(),
sig: "abcde".to_owned(),
tagidx: None,
};
let v = e.tag_values_by_name("e");
assert_eq!(v, vec!["foo", "bar", "baz"]);
}
#[test]
fn event_no_tag_select() {
let e = Event {
id: "999".to_owned(),
pubkey: "012345".to_owned(),
delegated_by: None,
created_at: 501_234,
kind: 1,
tags: vec![
vec!["j".to_owned(), "abc".to_owned()],
vec!["e".to_owned(), "foo".to_owned()],
vec!["e".to_owned(), "baz".to_owned()],
vec![
"p".to_owned(),
"aaaa".to_owned(),
"ws://example.com".to_owned(),
],
],
content: "this is a test".to_owned(),
sig: "abcde".to_owned(),
tagidx: None,
};
let v = e.tag_values_by_name("x");
// asking for tags that don't exist just returns zero-length vector
assert_eq!(v.len(), 0);
}
#[test]
fn event_canonical_with_tags() {
let e = Event {
id: "999".to_owned(),
pubkey: "012345".to_owned(),
delegated_by: None,
created_at: 501_234,
kind: 1,
tags: vec![
vec!["#e".to_owned(), "aoeu".to_owned()],
vec![
"#p".to_owned(),
"aaaa".to_owned(),
"ws://example.com".to_owned(),
],
],
content: "this is a test".to_owned(),
sig: "abcde".to_owned(),
tagidx: None,
};
let c = e.to_canonical();
let expected_json = r###"[0,"012345",501234,1,[["#e","aoeu"],["#p","aaaa","ws://example.com"]],"this is a test"]"###;
let expected = Some(expected_json.to_owned());
assert_eq!(c, expected);
}
#[test]
fn ephemeral_event() {
let mut event = Event::simple_event();
event.kind = 20000;
assert!(event.is_ephemeral());
event.kind = 29999;
assert!(event.is_ephemeral());
event.kind = 30000;
assert!(!event.is_ephemeral());
event.kind = 19999;
assert!(!event.is_ephemeral());
}
#[test]
fn replaceable_event() {
let mut event = Event::simple_event();
event.kind = 0;
assert!(event.is_replaceable());
event.kind = 3;
assert!(event.is_replaceable());
event.kind = 10000;
assert!(event.is_replaceable());
event.kind = 19999;
assert!(event.is_replaceable());
event.kind = 20000;
assert!(!event.is_replaceable());
}
#[test]
fn param_replaceable_event() {
let mut event = Event::simple_event();
event.kind = 30000;
assert!(event.is_param_replaceable());
event.kind = 39999;
assert!(event.is_param_replaceable());
event.kind = 29999;
assert!(!event.is_param_replaceable());
event.kind = 40000;
assert!(!event.is_param_replaceable());
}
#[test]
fn param_replaceable_value_case_1() {
// NIP case #1: "tags":[["d",""]]
let mut event = Event::simple_event();
event.kind = 30000;
event.tags = vec![vec!["d".to_owned(), "".to_owned()]];
assert_eq!(event.distinct_param(), Some("".to_string()));
}
#[test]
fn param_replaceable_value_case_2() {
// NIP case #2: "tags":[]: implicit d tag with empty value
let mut event = Event::simple_event();
event.kind = 30000;
assert_eq!(event.distinct_param(), Some("".to_string()));
}
#[test]
fn param_replaceable_value_case_3() {
// NIP case #3: "tags":[["d"]]: implicit empty value ""
let mut event = Event::simple_event();
event.kind = 30000;
event.tags = vec![vec!["d".to_owned()]];
assert_eq!(event.distinct_param(), Some("".to_string()));
}
#[test]
fn param_replaceable_value_case_4() {
// NIP case #4: "tags":[["d",""],["d","not empty"]]: only first d tag is considered
let mut event = Event::simple_event();
event.kind = 30000;
event.tags = vec![
vec!["d".to_owned(), "".to_string()],
vec!["d".to_owned(), "not empty".to_string()],
];
assert_eq!(event.distinct_param(), Some("".to_string()));
}
#[test]
fn param_replaceable_value_case_4b() {
// Variation of #4 with
// NIP case #4: "tags":[["d","not empty"],["d",""]]: only first d tag is considered
let mut event = Event::simple_event();
event.kind = 30000;
event.tags = vec![
vec!["d".to_owned(), "not empty".to_string()],
vec!["d".to_owned(), "".to_string()],
];
assert_eq!(event.distinct_param(), Some("not empty".to_string()));
}
#[test]
fn param_replaceable_value_case_5() {
// NIP case #5: "tags":[["d"],["d","some value"]]: only first d tag is considered
let mut event = Event::simple_event();
event.kind = 30000;
event.tags = vec![
vec!["d".to_owned()],
vec!["d".to_owned(), "second value".to_string()],
vec!["d".to_owned(), "third value".to_string()],
];
assert_eq!(event.distinct_param(), Some("".to_string()));
}
#[test]
fn param_replaceable_value_case_6() {
// NIP case #6: "tags":[["e"]]: same as no tags
let mut event = Event::simple_event();
event.kind = 30000;
event.tags = vec![vec!["e".to_owned()]];
assert_eq!(event.distinct_param(), Some("".to_string()));
}
#[test]
fn expiring_event_none() {
// regular events do not expire
let mut event = Event::simple_event();
event.kind = 7;
event.tags = vec![vec!["test".to_string(), "foo".to_string()]];
assert_eq!(event.expiration(), None);
}
#[test]
fn expiring_event_empty() {
// regular events do not expire
let mut event = Event::simple_event();
event.kind = 7;
event.tags = vec![vec!["expiration".to_string()]];
assert_eq!(event.expiration(), None);
}
#[test]
fn expiring_event_future() {
// a normal expiring event
let exp: u64 = 1676264138;
let mut event = Event::simple_event();
event.kind = 1;
event.tags = vec![vec!["expiration".to_string(), exp.to_string()]];
assert_eq!(event.expiration(), Some(exp));
}
#[test]
fn expiring_event_negative() {
// expiration set to a negative value (invalid)
let exp: i64 = -90;
let mut event = Event::simple_event();
event.kind = 1;
event.tags = vec![vec!["expiration".to_string(), exp.to_string()]];
assert_eq!(event.expiration(), None);
}
#[test]
fn expiring_event_zero() {
// a normal expiring event set to zero
let exp: i64 = 0;
let mut event = Event::simple_event();
event.kind = 1;
event.tags = vec![vec!["expiration".to_string(), exp.to_string()]];
assert_eq!(event.expiration(), Some(0));
}
#[test]
fn expiring_event_fraction() {
// expiration is fractional (invalid)
let exp: f64 = 23.334;
let mut event = Event::simple_event();
event.kind = 1;
event.tags = vec![vec!["expiration".to_string(), exp.to_string()]];
assert_eq!(event.expiration(), None);
}
#[test]
fn expiring_event_multiple() {
// multiple values, we just take the first
let mut event = Event::simple_event();
event.kind = 1;
event.tags = vec![
vec!["expiration".to_string(), (10).to_string()],
vec!["expiration".to_string(), (20).to_string()],
];
assert_eq!(event.expiration(), Some(10));
}
}
src/exit.rs
+86
View File
@@ -0,0 +1,86 @@
//! Co-located mixnet exit supervisor (Floonet addition).
//!
//! When `[exit] enabled = true`, the relay runs the bundled
//! `floonet-mixexit` binary alongside itself and keeps it running. The
//! exit is a scoped pipe: it joins the mixnet as an ordinary unbonded
//! client and forwards every accepted stream to ONE fixed upstream (this
//! relay), never a caller-chosen target, so it is structurally not an
//! open proxy and the operator needs no exit policy.
//!
//! The exit's mixnet identity persists in `exit.data_dir`, so its mixnet
//! address is STABLE across restarts; the binary prints it at startup and
//! writes it to `<data_dir>/nym_address.txt`. Publish that address (for
//! example in the Floonet relay pool `exit` field) so wallets can prefer
//! it and fall back to the public mixnet path when it is down.
//!
//! Wallets run hostname-validated TLS end to end THROUGH the pipe, so the
//! exit only ever sees ciphertext. Point `exit.upstream` at your public
//! TLS endpoint (e.g. `relay.example.com:443`) so the certificate the
//! wallet sees over the mixnet matches the one it pins.
use crate::config::Settings;
use crate::error::{Error, Result};
use std::path::Path;
use std::time::Duration;
use tracing::{error, info, warn};
/// Validate the exit configuration at startup: fail fast on a bad toggle
/// instead of silently running without the exit.
pub fn validate(settings: &Settings) -> Result<()> {
if !settings.exit.enabled {
return Ok(());
}
if !Path::new(&settings.exit.binary).is_file() {
let msg = format!(
"exit.enabled is true but exit.binary `{}` does not exist; \
install floonet-mixexit or disable the exit",
settings.exit.binary
);
error!("{msg}");
return Err(Error::CustomError(msg));
}
Ok(())
}
/// Spawn the supervision task. Must be called from within the tokio
/// runtime. The child is restarted with a backoff if it exits; it is
/// killed when the relay shuts down (kill-on-drop).
pub fn spawn(settings: &Settings) {
if !settings.exit.enabled {
return;
}
let binary = settings.exit.binary.clone();
let data_dir = settings.exit.data_dir.clone();
let upstream = if settings.exit.upstream.is_empty() {
format!("127.0.0.1:{}", settings.network.port)
} else {
settings.exit.upstream.clone()
};
info!(
"mixnet exit enabled: supervising {} (upstream {}, identity in {})",
binary, upstream, data_dir
);
tokio::spawn(async move {
loop {
let child = tokio::process::Command::new(&binary)
.env("FLOONET_MIXEXIT_DIR", &data_dir)
.env("FLOONET_EXIT_UPSTREAM", &upstream)
.kill_on_drop(true)
.spawn();
match child {
Ok(mut child) => match child.wait().await {
Ok(status) => {
warn!("mixnet exit process ended ({status}); restarting in 10s");
}
Err(e) => {
warn!("mixnet exit process wait failed ({e}); restarting in 10s");
}
},
Err(e) => {
error!("mixnet exit failed to start ({e}); retrying in 10s");
}
}
tokio::time::sleep(Duration::from_secs(10)).await;
}
});
}
src/info.rs
+108
View File
@@ -0,0 +1,108 @@
//! Relay metadata using NIP-11
/// Relay Info
use crate::config::Settings;
use serde::{Deserialize, Serialize};
pub const CARGO_PKG_VERSION: Option<&'static str> = option_env!("CARGO_PKG_VERSION");
pub const UNIT: &str = "msats";
/// Limitations of the relay as specified in NIP-111
/// (This nip isn't finalized so may change)
#[derive(Debug, Serialize, Deserialize)]
#[allow(unused)]
pub struct Limitation {
#[serde(skip_serializing_if = "Option::is_none")]
payment_required: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
restricted_writes: Option<bool>,
}
#[derive(Serialize, Deserialize, Debug)]
#[allow(unused)]
pub struct Fees {
#[serde(skip_serializing_if = "Option::is_none")]
admission: Option<Vec<Fee>>,
#[serde(skip_serializing_if = "Option::is_none")]
publication: Option<Vec<Fee>>,
}
#[derive(Serialize, Deserialize, Debug)]
#[allow(unused)]
pub struct Fee {
amount: u64,
unit: String,
}
#[derive(Debug, Serialize, Deserialize)]
#[allow(unused)]
pub struct RelayInfo {
#[serde(skip_serializing_if = "Option::is_none")]
pub id: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub pubkey: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub contact: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub supported_nips: Option<Vec<i64>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub software: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub version: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub limitation: Option<Limitation>,
#[serde(skip_serializing_if = "Option::is_none")]
pub payment_url: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub fees: Option<Fees>,
}
/// Convert an Info configuration into public Relay Info
impl From<Settings> for RelayInfo {
fn from(c: Settings) -> Self {
let mut supported_nips = vec![1, 2, 9, 11, 12, 15, 16, 20, 22, 33, 40];
if c.authorization.nip42_auth {
supported_nips.push(42);
supported_nips.sort();
}
let i = c.info;
// Floonet rule: the public relay information document never
// mentions payments, fees, or a payment URL. The relay only ever
// sees opaque gift-wrapped ciphertext, so payment wording would be
// both inaccurate and an operational liability.
let limitations = Limitation {
payment_required: None,
restricted_writes: Some(
c.pay_to_relay.enabled
|| c.verified_users.is_enabled()
|| c.authorization.pubkey_whitelist.is_some()
|| c.authorization.require_auth_to_write
|| c.grpc.restricts_write,
),
};
RelayInfo {
id: i.relay_url,
name: i.name,
description: i.description,
pubkey: i.pubkey,
contact: i.contact,
supported_nips: Some(supported_nips),
software: Some("https://floonet.dev/floonet-rs".to_owned()),
version: CARGO_PKG_VERSION.map(std::borrow::ToOwned::to_owned),
limitation: Some(limitations),
payment_url: None,
fees: None,
icon: i.relay_icon,
}
}
}
src/lib.rs
+21
View File
@@ -0,0 +1,21 @@
pub mod cli;
pub mod close;
pub mod config;
pub mod conn;
pub mod db;
pub mod delegation;
pub mod error;
pub mod event;
pub mod info;
pub mod admission;
pub mod exit;
pub mod name_authority;
pub mod nauthz;
pub mod nip05;
pub mod notice;
pub mod repo;
pub mod subscription;
pub mod utils;
// Public API for creating relays programmatically
pub mod payment;
pub mod server;
src/main.rs
+112
View File
@@ -0,0 +1,112 @@
//! Server process
use clap::Parser;
use console_subscriber::ConsoleLayer;
use floonet_rs::cli::CLIArgs;
use floonet_rs::config;
use floonet_rs::server::start_server;
use std::fs;
use std::path::Path;
use std::process;
use std::sync::mpsc as syncmpsc;
use std::sync::mpsc::{Receiver as MpscReceiver, Sender as MpscSender};
use std::thread;
#[cfg(all(not(target_env = "msvc"), not(target_os = "openbsd")))]
use tikv_jemallocator::Jemalloc;
use tracing::info;
use tracing_appender::non_blocking::WorkerGuard;
use tracing_subscriber::EnvFilter;
#[cfg(all(not(target_env = "msvc"), not(target_os = "openbsd")))]
#[global_allocator]
static GLOBAL: Jemalloc = Jemalloc;
/// Start running a Nostr relay server.
fn main() {
let args = CLIArgs::parse();
// get config file name from args
let config_file_arg = args.config;
// Ensure the config file is readable if it was explicitly set
if let Some(config_path) = config_file_arg.as_ref() {
let path = Path::new(&config_path);
if !path.exists() {
eprintln!("Config file not found: {}", &config_path);
process::exit(1);
}
if !path.is_file() {
eprintln!("Invalid config file path: {}", &config_path);
process::exit(1);
}
if let Err(err) = fs::metadata(path) {
eprintln!("Error while accessing file metadata: {}", err);
process::exit(1);
}
if let Err(err) = fs::File::open(path) {
eprintln!("Config file is not readable: {}", err);
process::exit(1);
}
}
let mut _log_guard: Option<WorkerGuard> = None;
// configure settings from the config file (defaults to config.toml)
// replace default settings with those read from the config file
let mut settings = config::Settings::new(&config_file_arg).unwrap_or_else(|e| {
eprintln!("Error reading config file ({:?})", e);
process::exit(1);
});
// setup tracing
if settings.diagnostics.tracing {
// enable tracing with tokio-console
ConsoleLayer::builder().with_default_env().init();
} else {
// standard logging
if let Some(path) = &settings.logging.folder_path {
// write logs to a folder
let prefix = match &settings.logging.file_prefix {
Some(p) => p.as_str(),
None => "relay",
};
let file_appender = tracing_appender::rolling::daily(path, prefix);
let (non_blocking, guard) = tracing_appender::non_blocking(file_appender);
let filter = EnvFilter::from_default_env();
// assign to a variable that is not dropped till the program ends
_log_guard = Some(guard);
tracing_subscriber::fmt()
.with_env_filter(filter)
.with_writer(non_blocking)
.try_init()
.unwrap();
} else {
// write to stdout
tracing_subscriber::fmt::try_init().unwrap();
}
}
info!("Starting up from main");
// get database directory from args
let db_dir_arg = args.db;
// update with database location from args, if provided
if let Some(db_dir) = db_dir_arg {
settings.database.data_directory = db_dir;
}
// we should have a 'control plane' channel to monitor and bump
// the server. this will let us do stuff like clear the database,
// shutdown, etc.; for now all this does is initiate shutdown if
// `()` is sent. This will change in the future, this is just a
// stopgap to shutdown the relay when it is used as a library.
let (_, ctrl_rx): (MpscSender<()>, MpscReceiver<()>) = syncmpsc::channel();
// run this in a new thread
let handle = thread::spawn(move || {
if let Err(e) = start_server(&settings, ctrl_rx) {
eprintln!("server terminated with error: {e}");
process::exit(1);
}
});
// block on nostr thread to finish.
handle.join().unwrap();
}
src/name_authority/mod.rs
+791
View File
@@ -0,0 +1,791 @@
//! Built-in name authority (Floonet addition).
//!
//! `name@domain` NIP-05 resolution with NIP-98 authenticated self-service
//! registration, ported from goblin-nip05d and served in-process on the
//! relay's own HTTP listener. Claims live in the relay database
//! (`name_claims` table, sqlite engine); everything else (rate limits,
//! replay window, cooldowns) is in-memory and resets on restart.
//!
//! Endpoints:
//! * `GET /.well-known/nostr.json?name=<name>` NIP-05 resolution
//! * `POST /api/v1/register` claim a name (NIP-98)
//! * `DELETE /api/v1/register/{name}` release a name (NIP-98)
//! * `GET /api/v1/name/{name}` availability
//! * `GET /api/v1/profile/{name}` name -> pubkey
//! * `GET /api/v1/by-pubkey/{pubkey}` pubkey -> name (reverse)
//! * `GET /api/v1/health` liveness
//!
//! Paid names: when `goblinpay.pay_mode = "name"`, a first-time claim
//! returns `402 {"error":"payment_required", "pay_url": ...}` carrying a
//! GoblinPay invoice. Once the payment confirms on chain the same
//! register call succeeds. Payment state reuses the relay's existing
//! `account`/`invoice` tables and the `PaymentProcessor` trait.
pub mod names;
pub mod nip98;
use crate::config::Settings;
use crate::error::{Error, Result};
use crate::payment::goblinpay::GoblinPayPaymentProcessor;
use crate::payment::{InvoiceStatus, PaymentProcessor};
use crate::repo::NostrRepo;
use crate::utils::unix_time;
use hyper::body::HttpBody;
use hyper::{Body, Method, Request, Response, StatusCode};
use nostr::key::FromPkStr;
use nostr::Keys;
use serde_json::json;
use std::collections::HashMap;
use std::net::SocketAddr;
use std::path::Path;
use std::sync::Arc;
use std::sync::Mutex;
use std::time::{Duration, Instant};
use tracing::{error, info, warn};
/// Largest register body we accept (fail closed on anything bigger).
const MAX_BODY_BYTES: u64 = 8192;
/// True when this path belongs to the name authority.
#[must_use]
pub fn is_authority_path(path: &str) -> bool {
path == "/.well-known/nostr.json" || path.starts_with("/api/v1/")
}
/// Resolved paid-names state.
enum PaidNames {
Free,
Paid {
processor: Arc<dyn PaymentProcessor>,
price_nanogrin: u64,
price_grin: f64,
},
}
pub struct Authority {
cfg: crate::config::NameAuthority,
/// Relays advertised in `/.well-known/nostr.json`.
relays: Vec<String>,
/// Operator domain labels + reserved-file names.
extra_reserved: Vec<String>,
/// Header carrying the real client IP (set by the reverse proxy).
remote_ip_header: Option<String>,
/// Claims store: an extra connection to the relay's own sqlite DB
/// (the `name_claims` table is created by the relay migration).
db: Mutex<rusqlite::Connection>,
/// Per-IP sliding windows and per-pubkey cooldowns.
rate: Mutex<HashMap<String, Vec<Instant>>>,
/// Seen NIP-98 auth event ids (one-time use in the freshness window).
seen_auth: Mutex<HashMap<String, Instant>>,
/// Relay repository, reused for paid-name account/invoice state.
repo: Arc<dyn NostrRepo>,
paid: PaidNames,
}
impl Authority {
/// Build the authority from settings. The relay migration has already
/// created the `name_claims` table by the time this runs.
pub fn new(settings: &Settings, repo: Arc<dyn NostrRepo>) -> Result<Authority> {
let cfg = settings.name_authority.clone();
let db_path = Path::new(&settings.database.data_directory).join(crate::db::DB_FILE);
let conn = rusqlite::Connection::open(db_path).map_err(Error::SqlError)?;
conn.busy_timeout(Duration::from_secs(5))
.map_err(Error::SqlError)?;
// The relay migration (v19) creates this table for file-backed
// databases; applying the same idempotent DDL here keeps the
// authority working when the relay runs an in-memory event store.
conn.execute_batch(
"CREATE TABLE IF NOT EXISTS name_claims (
name TEXT PRIMARY KEY,
pubkey TEXT NOT NULL,
created_at INTEGER NOT NULL,
released_at INTEGER
);
CREATE INDEX IF NOT EXISTS name_claims_pubkey_index ON name_claims(pubkey);
CREATE UNIQUE INDEX IF NOT EXISTS name_claims_active_pubkey
ON name_claims(pubkey) WHERE released_at IS NULL;",
)
.map_err(Error::SqlError)?;
let relays = match &cfg.relays {
Some(relays) if !relays.is_empty() => relays.clone(),
_ => settings.info.relay_url.iter().cloned().collect(),
};
// Reserve the operator's own domain labels, then any names from
// the optional reserved file.
let mut extra_reserved = names::domain_reserved(&cfg.domain);
if let Some(path) = cfg.reserved_file.as_ref().filter(|p| !p.is_empty()) {
let text = std::fs::read_to_string(path).map_err(|e| {
Error::CustomError(format!("name_authority.reserved_file `{path}` unreadable: {e}"))
})?;
extra_reserved.extend(
text.lines()
.map(str::trim)
.filter(|l| !l.is_empty() && !l.starts_with('#'))
.map(str::to_lowercase),
);
}
let paid = if settings.goblinpay.pay_mode == "name" {
info!(
"name authority: paid names enabled ({} GRIN per name)",
settings.goblinpay.name_price_grin
);
PaidNames::Paid {
processor: Arc::new(GoblinPayPaymentProcessor::new(
&settings.goblinpay.url,
&settings.goblinpay.api_token,
)),
price_nanogrin: settings.goblinpay.name_price_nanogrin(),
price_grin: settings.goblinpay.name_price_grin,
}
} else {
PaidNames::Free
};
info!(
"name authority enabled: domain={} base_url={} relays={:?} names {}..={} chars",
cfg.domain, cfg.base_url, relays, cfg.name_min, cfg.name_max
);
Ok(Authority {
cfg,
relays,
extra_reserved,
remote_ip_header: settings.network.remote_ip_header.clone(),
db: Mutex::new(conn),
rate: Mutex::new(HashMap::new()),
seen_auth: Mutex::new(HashMap::new()),
repo,
paid,
})
}
// ------------------------------------------------------------------
// Claims store
// ------------------------------------------------------------------
/// Active (non-released) pubkey for a name.
fn lookup(&self, name: &str) -> Option<String> {
self.db
.lock()
.unwrap()
.query_row(
"SELECT pubkey FROM name_claims WHERE name = ?1 AND released_at IS NULL",
[name],
|r| r.get::<_, String>(0),
)
.ok()
}
/// Active name owned by a pubkey.
fn name_of(&self, pubkey: &str) -> Option<String> {
self.db
.lock()
.unwrap()
.query_row(
"SELECT name FROM name_claims WHERE pubkey = ?1 AND released_at IS NULL",
[pubkey],
|r| r.get::<_, String>(0),
)
.ok()
}
// ------------------------------------------------------------------
// Rate limiting / replay / cooldowns (in-memory, reset on restart)
// ------------------------------------------------------------------
/// Record a NIP-98 auth event id as used; false if replayed.
fn auth_event_fresh(&self, event_id: &str) -> bool {
let now = Instant::now();
let window = Duration::from_secs(self.cfg.auth_max_age_secs.max(0) as u64 + 5);
let mut seen = self.seen_auth.lock().unwrap();
seen.retain(|_, t| now.duration_since(*t) < window);
if seen.contains_key(event_id) {
return false;
}
seen.insert(event_id.to_string(), now);
true
}
/// True when an operation in this bucket happened within the window.
fn cooldown_active(&self, bucket: &str, key: &str, window: Duration) -> bool {
let k = format!("{bucket}:{key}");
let now = Instant::now();
let mut map = self.rate.lock().unwrap();
if let Some(hits) = map.get_mut(&k) {
hits.retain(|t| now.duration_since(*t) < window);
return !hits.is_empty();
}
false
}
/// Record a completed operation for cooldown tracking.
fn record_op(&self, bucket: &str, key: &str) {
let k = format!("{bucket}:{key}");
self.rate
.lock()
.unwrap()
.entry(k)
.or_default()
.push(Instant::now());
}
/// Sliding-window per-IP limiter; true when the call is allowed.
fn allow(&self, bucket: &str, ip: &str, max: usize, window: Duration) -> bool {
let key = format!("{bucket}:{ip}");
let now = Instant::now();
let mut map = self.rate.lock().unwrap();
let hits = map.entry(key).or_default();
hits.retain(|t| now.duration_since(*t) < window);
if hits.len() >= max {
return false;
}
hits.push(now);
// Opportunistic global cleanup to bound memory.
if map.len() > 50_000 {
map.retain(|_, v| v.iter().any(|t| now.duration_since(*t) < window));
}
true
}
fn allow_read(&self, ip: &str) -> bool {
self.allow(
"na-read",
ip,
self.cfg.read_rate_max,
Duration::from_secs(self.cfg.read_rate_window_secs),
)
}
fn allow_write(&self, bucket: &str, ip: &str) -> bool {
self.allow(
bucket,
ip,
self.cfg.write_rate_max,
Duration::from_secs(self.cfg.write_rate_window_secs),
)
}
/// Client IP for rate limiting: the configured proxy header when
/// present (load-bearing behind a reverse proxy), else the socket.
fn client_ip(&self, request: &Request<Body>, remote_addr: &SocketAddr) -> String {
self.remote_ip_header
.as_ref()
.and_then(|h| request.headers().get(h.as_str()))
.and_then(|v| v.to_str().ok())
.map(str::to_string)
.unwrap_or_else(|| remote_addr.ip().to_string())
}
// ------------------------------------------------------------------
// HTTP dispatch
// ------------------------------------------------------------------
/// Handle one authority request. Callers route here for any path
/// where [`is_authority_path`] is true.
pub async fn handle(
self: &Arc<Self>,
request: Request<Body>,
remote_addr: SocketAddr,
) -> Response<Body> {
let ip = self.client_ip(&request, &remote_addr);
let method = request.method().clone();
let path = request.uri().path().to_string();
match (method, path.as_str()) {
(Method::GET, "/.well-known/nostr.json") => self.well_known(&request, &ip),
(Method::GET, "/api/v1/health") => text_response(StatusCode::OK, "ok"),
(Method::GET, p) if p.starts_with("/api/v1/name/") => {
self.availability(strip(p, "/api/v1/name/"), &ip)
}
(Method::GET, p) if p.starts_with("/api/v1/profile/") => {
self.profile(strip(p, "/api/v1/profile/"), &ip)
}
(Method::GET, p) if p.starts_with("/api/v1/by-pubkey/") => {
self.by_pubkey(strip(p, "/api/v1/by-pubkey/"), &ip)
}
(Method::POST, "/api/v1/register") => self.register(request, &ip).await,
(Method::DELETE, p) if p.starts_with("/api/v1/register/") => {
self.unregister(strip(p, "/api/v1/register/"), &request, &ip)
}
_ => json_response(StatusCode::NOT_FOUND, json!({"error": "not found"})),
}
}
// ------------------------------------------------------------------
// Read endpoints
// ------------------------------------------------------------------
fn well_known(&self, request: &Request<Body>, ip: &str) -> Response<Body> {
if !self.allow_read(ip) {
return rate_limited();
}
let mut result_names = serde_json::Map::new();
let mut result_relays = serde_json::Map::new();
if let Some(name) = query_param(request, "name").map(|n| n.to_lowercase()) {
if names::valid_name(&name, self.cfg.name_min, self.cfg.name_max) {
if let Some(pk) = self.lookup(&name) {
result_names.insert(name, json!(pk.clone()));
result_relays.insert(pk, json!(self.relays));
}
}
}
json_response(
StatusCode::OK,
json!({ "names": result_names, "relays": result_relays }),
)
}
fn availability(&self, name: &str, ip: &str) -> Response<Body> {
if !self.allow_read(ip) {
return rate_limited();
}
let name = name.to_lowercase();
if !names::valid_name(&name, self.cfg.name_min, self.cfg.name_max) {
return json_response(
StatusCode::OK,
json!({"name": name, "available": false, "reason": "invalid"}),
);
}
if names::is_reserved(&name, &self.extra_reserved) {
return json_response(
StatusCode::OK,
json!({"name": name, "available": false, "reason": "reserved"}),
);
}
if self.lookup(&name).is_some() {
return json_response(
StatusCode::OK,
json!({"name": name, "available": false, "reason": "taken"}),
);
}
json_response(StatusCode::OK, json!({"name": name, "available": true}))
}
fn profile(&self, name: &str, ip: &str) -> Response<Body> {
if !self.allow_read(ip) {
return rate_limited();
}
let name = name.to_lowercase();
if !names::valid_name(&name, self.cfg.name_min, self.cfg.name_max) {
return json_response(StatusCode::NOT_FOUND, json!({"error": "not found"}));
}
match self.lookup(&name) {
Some(pubkey) => {
json_response(StatusCode::OK, json!({"name": name, "pubkey": pubkey}))
}
None => json_response(StatusCode::NOT_FOUND, json!({"error": "not found"})),
}
}
fn by_pubkey(&self, pubkey: &str, ip: &str) -> Response<Body> {
if !self.allow_read(ip) {
return rate_limited();
}
let pubkey = pubkey.to_lowercase();
if !names::valid_pubkey_hex(&pubkey) {
return json_response(StatusCode::NOT_FOUND, json!({"error": "not found"}));
}
match self.name_of(&pubkey) {
Some(name) => {
json_response(StatusCode::OK, json!({"name": name, "pubkey": pubkey}))
}
None => json_response(StatusCode::NOT_FOUND, json!({"error": "not found"})),
}
}
// ------------------------------------------------------------------
// Write endpoints (NIP-98 authenticated)
// ------------------------------------------------------------------
async fn register(&self, request: Request<Body>, ip: &str) -> Response<Body> {
if !self.allow_write("na-reg", ip) {
return rate_limited();
}
// Fail closed on oversized bodies before buffering anything.
if request
.body()
.size_hint()
.upper()
.map_or(true, |n| n > MAX_BODY_BYTES)
{
return json_response(
StatusCode::PAYLOAD_TOO_LARGE,
json!({"error": "body too large"}),
);
}
let auth_header = request
.headers()
.get(hyper::header::AUTHORIZATION)
.and_then(|v| v.to_str().ok())
.map(str::to_string);
let body = match hyper::body::to_bytes(request.into_body()).await {
Ok(b) if (b.len() as u64) <= MAX_BODY_BYTES => b,
_ => {
return json_response(
StatusCode::BAD_REQUEST,
json!({"error": "invalid body"}),
)
}
};
let (auth_pubkey, auth_id) = match nip98::verify_nip98(
auth_header.as_deref(),
"POST",
"/api/v1/register",
&body,
&self.cfg.base_url,
self.cfg.auth_max_age_secs,
) {
Ok(v) => v,
Err(msg) => return json_response(StatusCode::UNAUTHORIZED, json!({"error": msg})),
};
if !self.auth_event_fresh(&auth_id) {
return json_response(
StatusCode::UNAUTHORIZED,
json!({"error": "auth event replayed"}),
);
}
// The cooldown is armed by a *release*, not a claim: it blocks
// registering a new name for the window after letting one go
// (anti-churn). Checked after auth so strangers cannot probe it.
if self.cooldown_active(
"na-namechange",
&auth_pubkey,
Duration::from_secs(self.cfg.name_change_cooldown_secs),
) {
return json_response(
StatusCode::TOO_MANY_REQUESTS,
json!({"error": "name_change_cooldown"}),
);
}
#[derive(serde::Deserialize)]
struct RegisterBody {
name: String,
pubkey: String,
}
let req: RegisterBody = match serde_json::from_slice(&body) {
Ok(r) => r,
Err(_) => {
return json_response(StatusCode::BAD_REQUEST, json!({"error": "invalid body"}))
}
};
let name = req.name.to_lowercase();
let pubkey = req.pubkey.to_lowercase();
if !names::valid_pubkey_hex(&pubkey) {
return json_response(StatusCode::BAD_REQUEST, json!({"error": "invalid pubkey"}));
}
if pubkey != auth_pubkey {
return json_response(
StatusCode::UNAUTHORIZED,
json!({"error": "auth pubkey does not match body pubkey"}),
);
}
if !names::valid_name(&name, self.cfg.name_min, self.cfg.name_max) {
return json_response(StatusCode::BAD_REQUEST, json!({"error": "invalid name"}));
}
if names::is_reserved(&name, &self.extra_reserved) {
return json_response(StatusCode::FORBIDDEN, json!({"error": "name reserved"}));
}
// Existing active registration of this exact name.
if let Some(owner) = self.lookup(&name) {
if owner == pubkey {
return json_response(
StatusCode::OK,
json!({"name": name, "nip05": format!("{name}@{}", self.cfg.domain)}),
);
}
return json_response(StatusCode::CONFLICT, json!({"error": "name taken"}));
}
// One active name per pubkey.
if let Some(existing) = self.name_of(&pubkey) {
return json_response(
StatusCode::CONFLICT,
json!({"error": "pubkey already has a name", "name": existing}),
);
}
// Paid names: the claim only proceeds once this pubkey has a
// confirmed payment. All validity checks ran first, so nobody is
// asked to pay for an unclaimable name.
if let Some(resp) = self.paid_gate(&pubkey).await {
return resp;
}
// INSERT guarded by the name PRIMARY KEY and the partial-unique
// pubkey index. The ON CONFLICT(name) only revives a released
// name; a concurrent double-register is caught by the unique
// index and surfaces as a constraint error -> 409.
let res = self.db.lock().unwrap().execute(
"INSERT INTO name_claims (name, pubkey, created_at) VALUES (?1, ?2, ?3)
ON CONFLICT(name) DO UPDATE SET pubkey = excluded.pubkey,
created_at = excluded.created_at, released_at = NULL
WHERE name_claims.released_at IS NOT NULL",
rusqlite::params![name, pubkey, unix_time()],
);
match res {
// rows == 0 means the ON CONFLICT no-op fired (name already
// active): report a conflict rather than a false success.
Ok(0) => json_response(StatusCode::CONFLICT, json!({"error": "name taken"})),
Ok(_) => {
// Claiming must not arm a cooldown; only release does.
info!("name authority: registered {name} -> {pubkey}");
json_response(
StatusCode::CREATED,
json!({"name": name, "nip05": format!("{name}@{}", self.cfg.domain)}),
)
}
Err(rusqlite::Error::SqliteFailure(e, _))
if e.code == rusqlite::ErrorCode::ConstraintViolation =>
{
json_response(
StatusCode::CONFLICT,
json!({"error": "pubkey already has a name"}),
)
}
Err(e) => {
error!("name authority: db insert failed: {e}");
json_response(
StatusCode::INTERNAL_SERVER_ERROR,
json!({"error": "db error"}),
)
}
}
}
/// The paid gate. Returns None when the claim may proceed (free mode,
/// or this pubkey has a confirmed payment); otherwise the 402/5xx
/// response to send. Payment admits the PUBKEY (relay `account` row),
/// and each invoice is a GoblinPay invoice checked against the
/// GoblinPay server, which only reports paid after on-chain
/// confirmation. Fail closed: any error refuses the claim.
async fn paid_gate(&self, pubkey: &str) -> Option<Response<Body>> {
let PaidNames::Paid {
processor,
price_nanogrin,
price_grin,
} = &self.paid
else {
return None;
};
let keys = match Keys::from_pk_str(pubkey) {
Ok(k) => k,
Err(_) => {
return Some(json_response(
StatusCode::BAD_REQUEST,
json!({"error": "invalid pubkey"}),
))
}
};
// Already paid?
if let Ok((admitted, _)) = self.repo.get_account_balance(&keys).await {
if admitted {
return None;
}
}
// Outstanding invoice? Poll GoblinPay for its status.
if let Ok(Some(invoice)) = self.repo.get_unpaid_invoice(&keys).await {
return match processor.check_invoice(&invoice.payment_hash).await {
Ok(InvoiceStatus::Paid) => {
if self
.repo
.update_invoice(&invoice.payment_hash, InvoiceStatus::Paid)
.await
.is_err()
|| self.repo.admit_account(&keys, *price_nanogrin).await.is_err()
{
return Some(server_error());
}
info!("name authority: payment confirmed for {pubkey}");
None
}
Ok(InvoiceStatus::Unpaid) => Some(payment_required(
&invoice.payment_hash,
&invoice.bolt11,
*price_grin,
*price_nanogrin,
)),
Ok(InvoiceStatus::Expired) => {
self.repo
.update_invoice(&invoice.payment_hash, InvoiceStatus::Expired)
.await
.ok();
Some(self.new_invoice(processor, &keys, *price_grin, *price_nanogrin).await)
}
Err(e) => {
warn!("name authority: goblinpay status check failed: {e:?}");
Some(server_error())
}
};
}
// First contact: create the account row and a fresh invoice.
self.repo.create_account(&keys).await.ok();
Some(self.new_invoice(processor, &keys, *price_grin, *price_nanogrin).await)
}
/// Create and persist a fresh GoblinPay invoice; respond 402 with the
/// hosted pay page so the client can complete the payment.
async fn new_invoice(
&self,
processor: &Arc<dyn PaymentProcessor>,
keys: &Keys,
price_grin: f64,
price_nanogrin: u64,
) -> Response<Body> {
match processor.get_invoice(keys, price_nanogrin).await {
Ok(invoice) => {
if self
.repo
.create_invoice_record(keys, invoice.clone())
.await
.is_err()
{
return server_error();
}
payment_required(
&invoice.payment_hash,
&invoice.bolt11,
price_grin,
price_nanogrin,
)
}
Err(e) => {
warn!("name authority: goblinpay invoice creation failed: {e:?}");
server_error()
}
}
}
fn unregister(&self, name: &str, request: &Request<Body>, ip: &str) -> Response<Body> {
if !self.allow_write("na-unreg", ip) {
return rate_limited();
}
let name = name.to_lowercase();
let path = format!("/api/v1/register/{name}");
let auth_header = request
.headers()
.get(hyper::header::AUTHORIZATION)
.and_then(|v| v.to_str().ok());
let (auth_pubkey, auth_id) = match nip98::verify_nip98(
auth_header,
"DELETE",
&path,
&[],
&self.cfg.base_url,
self.cfg.auth_max_age_secs,
) {
Ok(v) => v,
Err(msg) => return json_response(StatusCode::UNAUTHORIZED, json!({"error": msg})),
};
if !self.auth_event_fresh(&auth_id) {
return json_response(
StatusCode::UNAUTHORIZED,
json!({"error": "auth event replayed"}),
);
}
// Release is always allowed; releasing is what arms the cooldown.
match self.lookup(&name) {
Some(owner) if owner == auth_pubkey => {
let res = self.db.lock().unwrap().execute(
"UPDATE name_claims SET released_at = ?2
WHERE name = ?1 AND released_at IS NULL",
rusqlite::params![name, unix_time()],
);
match res {
Ok(_) => {
self.record_op("na-namechange", &auth_pubkey);
info!("name authority: released {name}");
json_response(StatusCode::OK, json!({"name": name, "released": true}))
}
Err(e) => {
error!("name authority: db release failed: {e}");
server_error()
}
}
}
Some(_) => json_response(StatusCode::FORBIDDEN, json!({"error": "not the owner"})),
None => json_response(StatusCode::NOT_FOUND, json!({"error": "name not found"})),
}
}
}
// ----------------------------------------------------------------------
// Small response helpers
// ----------------------------------------------------------------------
fn strip<'a>(path: &'a str, prefix: &str) -> &'a str {
path.strip_prefix(prefix).unwrap_or("")
}
fn query_param(request: &Request<Body>, key: &str) -> Option<String> {
request.uri().query().and_then(|q| {
q.split('&').find_map(|pair| {
let mut parts = pair.splitn(2, '=');
if parts.next() == Some(key) {
parts.next().map(str::to_string)
} else {
None
}
})
})
}
fn json_response(status: StatusCode, value: serde_json::Value) -> Response<Body> {
Response::builder()
.status(status)
.header("Content-Type", "application/json")
.header("Access-Control-Allow-Origin", "*")
.header("Cache-Control", "no-store")
.body(Body::from(value.to_string()))
.expect("response builder")
}
fn text_response(status: StatusCode, text: &'static str) -> Response<Body> {
Response::builder()
.status(status)
.header("Content-Type", "text/plain")
.body(Body::from(text))
.expect("response builder")
}
fn rate_limited() -> Response<Body> {
json_response(
StatusCode::TOO_MANY_REQUESTS,
json!({"error": "rate_limited"}),
)
}
fn server_error() -> Response<Body> {
json_response(
StatusCode::INTERNAL_SERVER_ERROR,
json!({"error": "internal error"}),
)
}
/// 402 carrying everything a client needs to render or open the GoblinPay
/// pay page, then retry the claim once the payment confirms.
fn payment_required(
invoice_id: &str,
pay_url: &str,
price_grin: f64,
price_nanogrin: u64,
) -> Response<Body> {
json_response(
StatusCode::PAYMENT_REQUIRED,
json!({
"error": "payment_required",
"invoice_id": invoice_id,
"pay_url": pay_url,
"price_grin": price_grin,
"price_nanogrin": price_nanogrin,
}),
)
}
src/name_authority/names.rs
+224
View File
@@ -0,0 +1,224 @@
//! Name and pubkey rules: validity, the reserved list, and look-alike
//! folding that stops digit/separator homographs of reserved terms.
//! Ported from goblin-nip05d (the reference name authority).
/// Built-in reserved names. These are generic infrastructure, role and
/// finance terms that no operator should hand out as a payment identity;
/// they are domain-agnostic on purpose. The operator's own brand is
/// reserved separately and dynamically from their domain (see
/// [`domain_reserved`]); operators can add more via a reserved file.
pub const RESERVED: &[&str] = &[
"admin",
"administrator",
"root",
"support",
"help",
"info",
"mail",
"email",
"www",
"relay",
"nostr",
"pay",
"payment",
"payments",
"wallet",
"official",
"security",
"abuse",
"postmaster",
"hostmaster",
"webmaster",
"contact",
"team",
"staff",
"mod",
"moderator",
"moderators",
"system",
"bot",
"api",
"app",
"dev",
"developer",
"test",
"testing",
"anonymous",
"anon",
"null",
"void",
"owner",
"ceo",
"register",
"registration",
"account",
"accounts",
"verify",
"verified",
"billing",
"donate",
"treasury",
"faucet",
"exchange",
"swap",
"bank",
"money",
"cash",
"fees",
"fee",
"node",
"miner",
"mining",
"explorer",
"status",
"blog",
"news",
"docs",
"wiki",
"store",
"shop",
];
/// True when `name` satisfies the length bounds and character rules: ASCII
/// lowercase alphanumerics plus `. _ -`, starting and ending alphanumeric.
#[must_use]
pub fn valid_name(name: &str, name_min: usize, name_max: usize) -> bool {
let len = name.chars().count();
if !(name_min..=name_max).contains(&len) {
return false;
}
let bytes = name.as_bytes();
let ok_char =
|c: u8| c.is_ascii_lowercase() || c.is_ascii_digit() || matches!(c, b'.' | b'_' | b'-');
if !bytes.iter().all(|&c| ok_char(c)) {
return false;
}
let first = bytes[0];
let last = bytes[bytes.len() - 1];
(first.is_ascii_lowercase() || first.is_ascii_digit())
&& (last.is_ascii_lowercase() || last.is_ascii_digit())
}
/// Fold a name to catch separator/digit look-alikes of reserved terms, so
/// `g0blin`, `g-o-b-l-i-n` and `supp0rt` cannot impersonate a reserved or
/// brand term as a payment identity. Conservative: a name is only blocked
/// when its folded form exactly equals a reserved term's folded form.
#[must_use]
pub fn fold_lookalike(name: &str) -> String {
name.chars()
.filter_map(|c| match c {
'.' | '_' | '-' => None,
'0' => Some('o'),
'1' => Some('i'),
'3' => Some('e'),
'4' => Some('a'),
'5' => Some('s'),
'7' => Some('t'),
'8' => Some('b'),
'9' => Some('g'),
c => Some(c),
})
.collect()
}
/// True when `name` is reserved outright or folds onto a reserved term.
/// The `extra` slice holds the operator's domain labels plus any names
/// from the optional reserved file.
#[must_use]
pub fn is_reserved(name: &str, extra: &[String]) -> bool {
if RESERVED.contains(&name) || extra.iter().any(|r| r == name) {
return true;
}
let folded = fold_lookalike(name);
RESERVED.iter().any(|r| fold_lookalike(r) == folded)
|| extra.iter().any(|r| fold_lookalike(r) == folded)
}
/// Reserved names derived from the operator's own domain, so a domain's
/// brand cannot be claimed (or look-alike-folded) as a payment handle.
/// Each dot label except the final TLD is reserved: `example.com` becomes
/// `["example"]`, `names.acme.example` becomes `["names", "acme"]`. A
/// single-label host (e.g. `localhost`) reserves that label.
#[must_use]
pub fn domain_reserved(domain: &str) -> Vec<String> {
let labels: Vec<&str> = domain
.trim()
.trim_end_matches('.')
.split('.')
.filter(|l| !l.is_empty())
.collect();
let keep = if labels.len() > 1 {
&labels[..labels.len() - 1]
} else {
&labels[..]
};
keep.iter().map(|l| l.to_lowercase()).collect()
}
/// Lowercase 64-char hex pubkey.
#[must_use]
pub fn valid_pubkey_hex(pk: &str) -> bool {
pk.len() == 64
&& pk
.bytes()
.all(|c| c.is_ascii_hexdigit() && !c.is_ascii_uppercase())
}
#[cfg(test)]
mod tests {
use super::*;
const MIN: usize = 3;
const MAX: usize = 20;
#[test]
fn name_validation() {
assert!(valid_name("ada", MIN, MAX));
assert!(valid_name("ada.wren-99_x", MIN, MAX));
assert!(!valid_name("ab", MIN, MAX));
assert!(!valid_name("Ada", MIN, MAX));
assert!(!valid_name(".ada", MIN, MAX));
assert!(!valid_name("ada.", MIN, MAX));
assert!(!valid_name("a d a", MIN, MAX));
assert!(!valid_name(&"a".repeat(21), MIN, MAX));
assert!(valid_name(&"a".repeat(20), MIN, MAX));
assert!(!valid_name("päge", MIN, MAX));
}
#[test]
fn reserved_and_lookalikes() {
assert!(is_reserved("support", &[]));
assert!(is_reserved("supp0rt", &[]));
assert!(is_reserved("adm1n", &[]));
// Brand terms are NOT built in; they come from the domain labels.
assert!(!is_reserved("goblin", &[]));
assert!(is_reserved("acme", &["acme".to_string()]));
assert!(is_reserved("acm3", &["acme".to_string()]));
assert!(!is_reserved("acmecorp", &["acme".to_string()]));
}
#[test]
fn domain_labels_reserved() {
assert_eq!(domain_reserved("goblin.st"), vec!["goblin"]);
assert_eq!(domain_reserved("acme.example"), vec!["acme"]);
assert_eq!(domain_reserved("names.acme.example"), vec!["names", "acme"]);
assert_eq!(domain_reserved("GOBLIN.ST"), vec!["goblin"]);
assert_eq!(domain_reserved("localhost"), vec!["localhost"]);
let extra = domain_reserved("goblin.st");
assert!(is_reserved("goblin", &extra));
assert!(is_reserved("g0blin", &extra));
assert!(is_reserved("g-o-b-l-i-n", &extra));
assert!(!is_reserved("goblinfan", &extra));
}
#[test]
fn pubkey_validation() {
assert!(valid_pubkey_hex(
"91cf9dbbea5e6511fd2bbb190b112055ee4131c5d2bbb9faedf3ee8cbeac0d05"
));
assert!(!valid_pubkey_hex(
"91CF9DBBEA5E6511FD2BBB190B112055EE4131C5D2BBB9FAEDF3EE8CBEAC0D05"
));
assert!(!valid_pubkey_hex("abc"));
}
}
src/name_authority/nip98.rs
+254
View File
@@ -0,0 +1,254 @@
//! NIP-98 HTTP authorization: verify an `Authorization: Nostr <base64>`
//! header carrying a signed kind-27235 event, including signature,
//! freshness, and the `u`/`method`/`payload` tags. The `u` tag is checked
//! against the configured public base URL, so a wrong base_url silently
//! fails every authenticated call (fail closed).
//!
//! Ported from goblin-nip05d, reusing this relay's own event validation
//! (id digest + schnorr signature) instead of an external nostr crate.
use crate::event::Event;
use crate::utils::unix_time;
use base64::Engine;
use bitcoin_hashes::{sha256, Hash};
/// NIP-98 HTTP auth event kind.
pub const HTTP_AUTH_KIND: u64 = 27235;
/// Verify a NIP-98 auth header for `method`+`url_path` over `body`.
/// On success returns (authenticated pubkey hex, auth event id hex).
pub fn verify_nip98(
auth_header: Option<&str>,
method: &str,
url_path: &str,
body: &[u8],
base_url: &str,
auth_max_age_secs: i64,
) -> Result<(String, String), String> {
let auth = auth_header.ok_or("missing Authorization header")?;
let b64 = auth
.strip_prefix("Nostr ")
.ok_or("Authorization scheme must be Nostr")?;
let raw = base64::engine::general_purpose::STANDARD
.decode(b64.trim())
.map_err(|_| "invalid base64 auth event")?;
let event: Event =
serde_json::from_slice(&raw).map_err(|_| "invalid auth event json")?;
event.validate().map_err(|_| "bad event signature")?;
if event.kind != HTTP_AUTH_KIND {
return Err("auth event kind must be 27235".to_string());
}
let age = (unix_time() as i64) - (event.created_at as i64);
// Allow modest backward skew but only a few seconds forward, to bound
// the replay window (paired with one-time event-id enforcement at the
// caller).
if age > auth_max_age_secs || age < -5 {
return Err("auth event expired or post-dated".to_string());
}
let mut u_ok = false;
let mut method_ok = false;
let mut payload_hash: Option<String> = None;
for tag in &event.tags {
match tag.first().map(String::as_str) {
Some("u") => {
if let Some(u) = tag.get(1) {
let expected = format!("{base_url}{url_path}");
let normalized = u.trim_end_matches('/');
u_ok = normalized == expected.trim_end_matches('/');
}
}
Some("method") => {
if let Some(m) = tag.get(1) {
method_ok = m.eq_ignore_ascii_case(method);
}
}
Some("payload") => {
payload_hash = tag.get(1).cloned();
}
_ => {}
}
}
if !u_ok {
return Err("auth event url mismatch".to_string());
}
if !method_ok {
return Err("auth event method mismatch".to_string());
}
if let Some(expect) = payload_hash {
let digest: sha256::Hash = sha256::Hash::hash(body);
let got = format!("{digest:x}");
if !expect.eq_ignore_ascii_case(&got) {
return Err("auth event payload hash mismatch".to_string());
}
} else if !body.is_empty() {
return Err("auth event missing payload hash".to_string());
}
Ok((event.pubkey.clone(), event.id.clone()))
}
#[cfg(test)]
mod tests {
use super::*;
use base64::Engine;
use bitcoin_hashes::{sha256, Hash};
use secp256k1::{KeyPair, Secp256k1, XOnlyPublicKey};
/// Build and sign a real NIP-98 event for tests.
fn signed_auth_event(
url: &str,
method: &str,
body: Option<&[u8]>,
kind: u64,
created_at: u64,
) -> String {
let secp = Secp256k1::new();
let keypair = KeyPair::from_seckey_slice(&secp, &[7u8; 32]).unwrap();
let pubkey = XOnlyPublicKey::from_keypair(&keypair);
let pubkey_hex = pubkey.to_string();
let mut tags: Vec<Vec<String>> = vec![
vec!["u".to_string(), url.to_string()],
vec!["method".to_string(), method.to_string()],
];
if let Some(body) = body {
let digest: sha256::Hash = sha256::Hash::hash(body);
tags.push(vec!["payload".to_string(), format!("{digest:x}")]);
}
let mut event = Event {
id: String::new(),
pubkey: pubkey_hex,
delegated_by: None,
created_at,
kind,
tags,
content: String::new(),
sig: String::new(),
tagidx: None,
};
let canonical = event.to_canonical().unwrap();
let digest: sha256::Hash = sha256::Hash::hash(canonical.as_bytes());
event.id = format!("{digest:x}");
let msg = secp256k1::Message::from_slice(digest.as_ref()).unwrap();
event.sig = secp.sign_schnorr(&msg, &keypair).to_string();
let json = serde_json::to_string(&event).unwrap();
format!(
"Nostr {}",
base64::engine::general_purpose::STANDARD.encode(json)
)
}
#[test]
fn accepts_valid_auth() {
let base = "https://names.example";
let body = br#"{"name":"ada","pubkey":"aa"}"#;
let header = signed_auth_event(
&format!("{base}/api/v1/register"),
"POST",
Some(body),
HTTP_AUTH_KIND,
unix_time(),
);
let res = verify_nip98(
Some(&header),
"POST",
"/api/v1/register",
body,
base,
60,
);
assert!(res.is_ok(), "{res:?}");
}
#[test]
fn rejects_wrong_kind() {
let base = "https://names.example";
let header = signed_auth_event(
&format!("{base}/api/v1/register"),
"POST",
None,
1,
unix_time(),
);
assert!(
verify_nip98(Some(&header), "POST", "/api/v1/register", &[], base, 60).is_err()
);
}
#[test]
fn rejects_stale_event() {
let base = "https://names.example";
let header = signed_auth_event(
&format!("{base}/api/v1/register"),
"POST",
None,
HTTP_AUTH_KIND,
unix_time() - 3600,
);
assert!(
verify_nip98(Some(&header), "POST", "/api/v1/register", &[], base, 60).is_err()
);
}
#[test]
fn rejects_url_mismatch() {
let base = "https://names.example";
let header = signed_auth_event(
"https://evil.example/api/v1/register",
"POST",
None,
HTTP_AUTH_KIND,
unix_time(),
);
assert!(
verify_nip98(Some(&header), "POST", "/api/v1/register", &[], base, 60).is_err()
);
}
#[test]
fn rejects_method_mismatch() {
let base = "https://names.example";
let header = signed_auth_event(
&format!("{base}/api/v1/register"),
"DELETE",
None,
HTTP_AUTH_KIND,
unix_time(),
);
assert!(
verify_nip98(Some(&header), "POST", "/api/v1/register", &[], base, 60).is_err()
);
}
#[test]
fn rejects_payload_tampering() {
let base = "https://names.example";
let body = br#"{"name":"ada"}"#;
let header = signed_auth_event(
&format!("{base}/api/v1/register"),
"POST",
Some(body),
HTTP_AUTH_KIND,
unix_time(),
);
let tampered = br#"{"name":"eve"}"#;
assert!(verify_nip98(
Some(&header),
"POST",
"/api/v1/register",
tampered,
base,
60
)
.is_err());
}
#[test]
fn rejects_missing_header_and_bad_scheme() {
assert!(verify_nip98(None, "POST", "/x", &[], "https://a", 60).is_err());
assert!(verify_nip98(Some("Bearer zzz"), "POST", "/x", &[], "https://a", 60).is_err());
}
}
src/nauthz.rs
+111
View File
@@ -0,0 +1,111 @@
use crate::error::{Error, Result};
use crate::{event::Event, nip05::Nip05Name};
use nauthz_grpc::authorization_client::AuthorizationClient;
use nauthz_grpc::event::TagEntry;
use nauthz_grpc::{Decision, Event as GrpcEvent, EventReply, EventRequest};
use tracing::{info, warn};
pub mod nauthz_grpc {
tonic::include_proto!("nauthz");
}
// A decision for the DB to act upon
pub trait AuthzDecision: Send + Sync {
fn permitted(&self) -> bool;
fn message(&self) -> Option<String>;
}
impl AuthzDecision for EventReply {
fn permitted(&self) -> bool {
self.decision == Decision::Permit as i32
}
fn message(&self) -> Option<String> {
self.message.clone()
}
}
// A connection to an event admission GRPC server
pub struct EventAuthzService {
server_addr: String,
conn: Option<AuthorizationClient<tonic::transport::Channel>>,
}
// conversion of Nip05Names into GRPC type
impl std::convert::From<Nip05Name> for nauthz_grpc::event_request::Nip05Name {
fn from(value: Nip05Name) -> Self {
nauthz_grpc::event_request::Nip05Name {
local: value.local.clone(),
domain: value.domain,
}
}
}
// conversion of event tags into gprc struct
fn tags_to_protobuf(tags: &[Vec<String>]) -> Vec<TagEntry> {
tags.iter()
.map(|x| TagEntry { values: x.clone() })
.collect()
}
impl EventAuthzService {
pub async fn connect(server_addr: &str) -> EventAuthzService {
let mut eas = EventAuthzService {
server_addr: server_addr.to_string(),
conn: None,
};
eas.ready_connection().await;
eas
}
pub async fn ready_connection(&mut self) {
if self.conn.is_none() {
let client = AuthorizationClient::connect(self.server_addr.to_string()).await;
if let Err(ref msg) = client {
warn!("could not connect to nostr authz GRPC server: {:?}", msg);
} else {
info!("connected to nostr authorization GRPC server");
}
self.conn = client.ok();
}
}
pub async fn admit_event(
&mut self,
event: &Event,
ip: &str,
origin: Option<String>,
user_agent: Option<String>,
nip05: Option<Nip05Name>,
auth_pubkey: Option<Vec<u8>>,
) -> Result<Box<dyn AuthzDecision>> {
self.ready_connection().await;
let id_blob = hex::decode(&event.id)?;
let pubkey_blob = hex::decode(&event.pubkey)?;
let sig_blob = hex::decode(&event.sig)?;
if let Some(ref mut c) = self.conn {
let gevent = GrpcEvent {
id: id_blob,
pubkey: pubkey_blob,
sig: sig_blob,
created_at: event.created_at,
kind: event.kind,
content: event.content.clone(),
tags: tags_to_protobuf(&event.tags),
};
let svr_res = c
.event_admit(EventRequest {
event: Some(gevent),
ip_addr: Some(ip.to_string()),
origin,
user_agent,
auth_pubkey,
nip05: nip05.map(nauthz_grpc::event_request::Nip05Name::from),
})
.await?;
let reply = svr_res.into_inner();
Ok(Box::new(reply))
} else {
Err(Error::AuthzError)
}
}
}
src/nip05.rs
+658
View File
@@ -0,0 +1,658 @@
//! User verification using NIP-05 names
//!
//! NIP-05 defines a mechanism for authors to associate an internet
//! address with their public key, in metadata events. This module
//! consumes a stream of metadata events, and keeps a database table
//! updated with the current NIP-05 verification status.
use crate::config::VerifiedUsers;
use crate::error::{Error, Result};
use crate::event::Event;
use crate::repo::NostrRepo;
use hyper::body::HttpBody;
use hyper::client::connect::HttpConnector;
use hyper::Client;
use hyper_rustls::HttpsConnector;
use std::sync::Arc;
use std::time::Duration;
use std::time::Instant;
use std::time::SystemTime;
use tokio::time::Interval;
use tracing::{debug, info, warn};
/// NIP-05 verifier state
pub struct Verifier {
/// Repository for saving/retrieving events and records
repo: Arc<dyn NostrRepo>,
/// Metadata events for us to inspect
metadata_rx: tokio::sync::broadcast::Receiver<Event>,
/// Newly validated events get written and then broadcast on this channel to subscribers
event_tx: tokio::sync::broadcast::Sender<Event>,
/// Settings
settings: crate::config::Settings,
/// HTTP client
client: hyper::Client<HttpsConnector<HttpConnector>, hyper::Body>,
/// After all accounts are updated, wait this long before checking again.
wait_after_finish: Duration,
/// Minimum amount of time between HTTP queries
http_wait_duration: Duration,
/// Interval for updating verification records
reverify_interval: Interval,
}
/// A NIP-05 identifier is a local part and domain.
#[derive(PartialEq, Eq, Debug, Clone)]
pub struct Nip05Name {
pub local: String,
pub domain: String,
}
impl Nip05Name {
/// Does this name represent the entire domain?
#[must_use]
pub fn is_domain_only(&self) -> bool {
self.local == "_"
}
/// Determine the URL to query for verification
fn to_url(&self) -> Option<http::Uri> {
format!(
"https://{}/.well-known/nostr.json?name={}",
self.domain, self.local
)
.parse::<http::Uri>()
.ok()
}
}
// Parsing Nip05Names from strings
impl std::convert::TryFrom<&str> for Nip05Name {
type Error = Error;
fn try_from(inet: &str) -> Result<Self, Self::Error> {
// break full name at the @ boundary.
let components: Vec<&str> = inet.split('@').collect();
if components.len() == 2 {
// check if local name is valid
let local = components[0];
let domain = components[1];
if local
.chars()
.all(|x| x.is_alphanumeric() || x == '_' || x == '-' || x == '.')
{
if domain
.chars()
.all(|x| x.is_alphanumeric() || x == '-' || x == '.')
{
Ok(Nip05Name {
local: local.to_owned(),
domain: domain.to_owned(),
})
} else {
Err(Error::CustomError(
"invalid character in domain part".to_owned(),
))
}
} else {
Err(Error::CustomError(
"invalid character in local part".to_owned(),
))
}
} else {
Err(Error::CustomError("too many/few components".to_owned()))
}
}
}
impl std::fmt::Display for Nip05Name {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}@{}", self.local, self.domain)
}
}
/// Check if the specified username and address are present and match in this response body
fn body_contains_user(username: &str, address: &str, bytes: &hyper::body::Bytes) -> Result<bool> {
// convert the body into json
let body: serde_json::Value = serde_json::from_slice(bytes)?;
// ensure we have a names object.
let names_map = body
.as_object()
.and_then(|x| x.get("names"))
.and_then(serde_json::Value::as_object)
.ok_or_else(|| Error::CustomError("not a map".to_owned()))?;
// get the pubkey for the requested user
let check_name = names_map.get(username).and_then(serde_json::Value::as_str);
// ensure the address is a match
Ok(check_name == Some(address))
}
impl Verifier {
pub fn new(
repo: Arc<dyn NostrRepo>,
metadata_rx: tokio::sync::broadcast::Receiver<Event>,
event_tx: tokio::sync::broadcast::Sender<Event>,
settings: crate::config::Settings,
) -> Result<Self> {
info!("creating NIP-05 verifier");
// setup hyper client
let https = hyper_rustls::HttpsConnectorBuilder::new()
.with_native_roots()
.https_or_http()
.enable_http1()
.build();
let client = Client::builder().build::<_, hyper::Body>(https);
// After all accounts have been re-verified, don't check again
// for this long.
let wait_after_finish = Duration::from_secs(60 * 10);
// when we have an active queue of accounts to validate, we
// will wait this duration between HTTP requests.
let http_wait_duration = Duration::from_secs(1);
// setup initial interval for re-verification. If we find
// there is no work to be done, it will be reset to a longer
// duration.
let reverify_interval = tokio::time::interval(http_wait_duration);
Ok(Verifier {
repo,
metadata_rx,
event_tx,
settings,
client,
wait_after_finish,
http_wait_duration,
reverify_interval,
})
}
/// Perform web verification against a NIP-05 name and address.
pub async fn get_web_verification(
&mut self,
nip: &Nip05Name,
pubkey: &str,
) -> UserWebVerificationStatus {
self.get_web_verification_res(nip, pubkey)
.await
.unwrap_or(UserWebVerificationStatus::Unknown)
}
/// Perform web verification against an `Event` (must be metadata).
pub async fn get_web_verification_from_event(
&mut self,
e: &Event,
) -> UserWebVerificationStatus {
let nip_parse = e.get_nip05_addr();
if let Some(nip) = nip_parse {
self.get_web_verification_res(&nip, &e.pubkey)
.await
.unwrap_or(UserWebVerificationStatus::Unknown)
} else {
UserWebVerificationStatus::Unknown
}
}
/// Perform web verification, with a `Result` return.
async fn get_web_verification_res(
&mut self,
nip: &Nip05Name,
pubkey: &str,
) -> Result<UserWebVerificationStatus> {
// determine if this domain should be checked
if !is_domain_allowed(
&nip.domain,
&self.settings.verified_users.domain_whitelist,
&self.settings.verified_users.domain_blacklist,
) {
return Ok(UserWebVerificationStatus::DomainNotAllowed);
}
let url = nip
.to_url()
.ok_or_else(|| Error::CustomError("invalid NIP-05 URL".to_owned()))?;
let req = hyper::Request::builder()
.method(hyper::Method::GET)
.uri(url.clone())
.header("Accept", "application/json")
.header(
"User-Agent",
format!(
"nostr-rs-relay/{} NIP-05 Verifier",
crate::info::CARGO_PKG_VERSION.unwrap()
),
)
.body(hyper::Body::empty())
.expect("request builder");
let response_fut = self.client.request(req);
if let Ok(response_res) = tokio::time::timeout(Duration::from_secs(5), response_fut).await {
// limit size of verification document to 1MB.
const MAX_ALLOWED_RESPONSE_SIZE: u64 = 1024 * 1024;
let response = response_res?;
let status = response.status();
// Log non-2XX status codes
if !status.is_success() {
info!(
"unexpected status code {} received for account {:?} at URL: {}",
status,
nip.to_string(),
url
);
return Ok(UserWebVerificationStatus::Unknown);
}
// determine content length from response
let response_content_length = match response.body().size_hint().upper() {
Some(v) => v,
None => {
info!(
"missing content length header for account {:?} at URL: {}",
nip.to_string(),
url
);
return Ok(UserWebVerificationStatus::Unknown);
}
};
if response_content_length > MAX_ALLOWED_RESPONSE_SIZE {
info!(
"content length {} exceeded limit of {} bytes for account {:?} at URL: {}",
response_content_length,
MAX_ALLOWED_RESPONSE_SIZE,
nip.to_string(),
url
);
return Ok(UserWebVerificationStatus::Unknown);
}
let (parts, body) = response.into_parts();
// TODO: consider redirects
if parts.status == http::StatusCode::OK {
// parse body, determine if the username / key / address is present
let body_bytes = match hyper::body::to_bytes(body).await {
Ok(bytes) => bytes,
Err(e) => {
info!(
"failed to read response body for account {:?} at URL: {}: {:?}",
nip.to_string(),
url,
e
);
return Ok(UserWebVerificationStatus::Unknown);
}
};
match body_contains_user(&nip.local, pubkey, &body_bytes) {
Ok(true) => Ok(UserWebVerificationStatus::Verified),
Ok(false) => Ok(UserWebVerificationStatus::Unverified),
Err(e) => {
info!(
"error parsing response body for account {:?}: {:?}",
nip.to_string(),
e
);
Ok(UserWebVerificationStatus::Unknown)
}
}
} else {
info!(
"unexpected status code {} for account {:?}",
parts.status,
nip.to_string()
);
Ok(UserWebVerificationStatus::Unknown)
}
} else {
info!("timeout verifying account {:?}", nip);
Ok(UserWebVerificationStatus::Unknown)
}
}
/// Perform NIP-05 verifier tasks.
pub async fn run(&mut self) {
// use this to schedule periodic re-validation tasks
// run a loop, restarting on failure
loop {
let res = self.run_internal().await;
match res {
Err(Error::ChannelClosed) => {
// channel was closed, we are shutting down
return;
}
Err(e) => {
info!("error in verifier: {:?}", e);
}
_ => {}
}
}
}
/// Internal select loop for performing verification
async fn run_internal(&mut self) -> Result<()> {
tokio::select! {
m = self.metadata_rx.recv() => {
match m {
Ok(e) => {
if let Some(naddr) = e.get_nip05_addr() {
info!("got metadata event for ({:?},{:?})", naddr.to_string() ,e.get_author_prefix());
// Process a new author, checking if they are verified:
let check_verified = self.repo.get_latest_user_verification(&e.pubkey).await;
// ensure the event we got is more recent than the one we have, otherwise we can ignore it.
if let Ok(last_check) = check_verified {
if e.created_at <= last_check.event_created {
// this metadata is from the same author as an existing verification.
// it is older than what we have, so we can ignore it.
debug!("received older metadata event for author {:?}", e.get_author_prefix());
return Ok(());
}
}
// old, or no existing record for this user. In either case, we just create a new one.
let start = Instant::now();
let v = self.get_web_verification_from_event(&e).await;
info!(
"checked name {:?}, result: {:?}, in: {:?}",
naddr.to_string(),
v,
start.elapsed()
);
// sleep to limit how frequently we make HTTP requests for new metadata events. This should limit us to 4 req/sec.
tokio::time::sleep(Duration::from_millis(250)).await;
// if this user was verified, we need to write the
// record, persist the event, and broadcast.
if let UserWebVerificationStatus::Verified = v {
self.create_new_verified_user(&naddr.to_string(), &e).await?;
}
}
},
Err(tokio::sync::broadcast::error::RecvError::Lagged(c)) => {
warn!("incoming metadata events overwhelmed buffer, {} events dropped",c);
}
Err(tokio::sync::broadcast::error::RecvError::Closed) => {
info!("metadata broadcast channel closed");
return Err(Error::ChannelClosed);
}
}
},
_ = self.reverify_interval.tick() => {
// check and see if there is an old account that needs
// to be reverified
self.do_reverify().await?;
},
}
Ok(())
}
/// Reverify the oldest user verification record.
async fn do_reverify(&mut self) -> Result<()> {
let reverify_setting = self
.settings
.verified_users
.verify_update_frequency_duration;
let max_failures = self.settings.verified_users.max_consecutive_failures;
// get from settings, but default to 6hrs between re-checking an account
let reverify_dur = reverify_setting.unwrap_or_else(|| Duration::from_secs(60 * 60 * 6));
// find all verification records that have success or failure OLDER than the reverify_dur.
let now = SystemTime::now();
let earliest = now - reverify_dur;
let earliest_epoch = earliest
.duration_since(SystemTime::UNIX_EPOCH)
.map(|x| x.as_secs())
.unwrap_or(0);
let vr = self.repo.get_oldest_user_verification(earliest_epoch).await;
match vr {
Ok(ref v) => {
let new_status = self.get_web_verification(&v.name, &v.address).await;
match new_status {
UserWebVerificationStatus::Verified => {
// freshly verified account, update the
// timestamp.
self.repo.update_verification_timestamp(v.rowid).await?;
info!("verification updated for {}", v.to_string());
}
UserWebVerificationStatus::DomainNotAllowed
| UserWebVerificationStatus::Unknown => {
// server may be offline, or temporarily
// blocked by the config file. Note the
// failure so we can process something
// else.
// have we had enough failures to give up?
if v.failure_count >= max_failures as u64 {
info!(
"giving up on verifying {:?} after {} failures",
v.name, v.failure_count
);
self.repo.delete_verification(v.rowid).await?;
} else {
// record normal failure, incrementing failure count
info!("verification failed for {}", v.to_string());
self.repo.fail_verification(v.rowid).await?;
}
}
UserWebVerificationStatus::Unverified => {
// domain has removed the verification, drop
// the record on our side.
info!("verification rescinded for {}", v.to_string());
self.repo.delete_verification(v.rowid).await?;
}
}
}
Err(
Error::SqlError(rusqlite::Error::QueryReturnedNoRows)
| Error::SqlxError(sqlx::Error::RowNotFound),
) => {
// No users need verification. Reset the interval to
// the next verification attempt.
let start = tokio::time::Instant::now() + self.wait_after_finish;
self.reverify_interval = tokio::time::interval_at(start, self.http_wait_duration);
}
Err(ref e) => {
warn!(
"Error when checking for NIP-05 verification records: {:?}",
e
);
}
}
Ok(())
}
/// Persist an event, create a verification record, and broadcast.
// TODO: have more event-writing logic handled in the db module.
// Right now, these events avoid the rate limit. That is
// acceptable since as soon as the user is registered, this path
// is no longer used.
// TODO: refactor these into spawn_blocking
// calls to get them off the async executors.
async fn create_new_verified_user(&mut self, name: &str, event: &Event) -> Result<()> {
let start = Instant::now();
// we should only do this if we are enabled. if we are
// disabled/passive, the event has already been persisted.
let should_write_event = self.settings.verified_users.is_enabled();
if should_write_event {
match self.repo.write_event(event).await {
Ok(updated) => {
if updated != 0 {
info!(
"persisted event (new verified pubkey): {:?} in {:?}",
event.get_event_id_prefix(),
start.elapsed()
);
self.event_tx.send(event.clone()).ok();
}
}
Err(err) => {
warn!("event insert failed: {:?}", err);
if let Error::SqlError(r) = err {
warn!("because: : {:?}", r);
}
}
}
}
// write the verification record
self.repo
.create_verification_record(&event.id, name)
.await?;
Ok(())
}
}
/// Result of checking user's verification status against DNS/HTTP.
#[derive(PartialEq, Eq, Debug, Clone)]
pub enum UserWebVerificationStatus {
Verified, // user is verified, as of now.
DomainNotAllowed, // domain blacklist or whitelist denied us from attempting a verification
Unknown, // user's status could not be determined (timeout, server error)
Unverified, // user's status is not verified (successful check, name / addr do not match)
}
/// A NIP-05 verification record.
#[derive(PartialEq, Eq, Debug, Clone)]
// Basic information for a verification event. Gives us all we need to assert a NIP-05 address is good.
pub struct VerificationRecord {
pub rowid: u64, // database row for this verification event
pub name: Nip05Name, // address being verified
pub address: String, // pubkey
pub event: String, // event ID hash providing the verification
pub event_created: u64, // when the metadata event was published
pub last_success: Option<u64>, // the most recent time a verification was provided. None if verification under this name has never succeeded.
pub last_failure: Option<u64>, // the most recent time verification was attempted, but could not be completed.
pub failure_count: u64, // how many consecutive failures have been observed.
}
/// Check with settings to determine if a given domain is allowed to
/// publish.
#[must_use]
pub fn is_domain_allowed(
domain: &str,
whitelist: &Option<Vec<String>>,
blacklist: &Option<Vec<String>>,
) -> bool {
// if there is a whitelist, domain must be present in it.
if let Some(wl) = whitelist {
// workaround for Vec contains not accepting &str
return wl.iter().any(|x| x == domain);
}
// otherwise, check that user is not in the blacklist
if let Some(bl) = blacklist {
return !bl.iter().any(|x| x == domain);
}
true
}
impl VerificationRecord {
/// Check if the record is recent enough to be considered valid,
/// and the domain is allowed.
#[must_use]
pub fn is_valid(&self, verified_users_settings: &VerifiedUsers) -> bool {
//let settings = SETTINGS.read().unwrap();
// how long a verification record is good for
let nip05_expiration = &verified_users_settings.verify_expiration_duration;
if let Some(e) = nip05_expiration {
if !self.is_current(e) {
return false;
}
}
// check domains
is_domain_allowed(
&self.name.domain,
&verified_users_settings.domain_whitelist,
&verified_users_settings.domain_blacklist,
)
}
/// Check if this record has been validated since the given
/// duration.
fn is_current(&self, d: &Duration) -> bool {
match self.last_success {
Some(s) => {
// current time - duration
let now = SystemTime::now();
let cutoff = now - *d;
let cutoff_epoch = cutoff
.duration_since(SystemTime::UNIX_EPOCH)
.map(|x| x.as_secs())
.unwrap_or(0);
s > cutoff_epoch
}
None => false,
}
}
}
impl std::fmt::Display for VerificationRecord {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"({:?},{:?})",
self.name.to_string(),
self.address.chars().take(8).collect::<String>()
)
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn local_from_inet() {
let addr = "bob@example.com";
let parsed = Nip05Name::try_from(addr);
assert!(parsed.is_ok());
let v = parsed.unwrap();
assert_eq!(v.local, "bob");
assert_eq!(v.domain, "example.com");
}
#[test]
fn not_enough_sep() {
let addr = "bob_example.com";
let parsed = Nip05Name::try_from(addr);
assert!(parsed.is_err());
}
#[test]
fn too_many_sep() {
let addr = "foo@bob@example.com";
let parsed = Nip05Name::try_from(addr);
assert!(parsed.is_err());
}
#[test]
fn invalid_local_name() {
// non-permitted ascii chars
assert!(Nip05Name::try_from("foo!@example.com").is_err());
assert!(Nip05Name::try_from("foo @example.com").is_err());
assert!(Nip05Name::try_from(" foo@example.com").is_err());
assert!(Nip05Name::try_from("f oo@example.com").is_err());
assert!(Nip05Name::try_from("foo<@example.com").is_err());
// unicode dash
assert!(Nip05Name::try_from("foo‐bar@example.com").is_err());
// emoji
assert!(Nip05Name::try_from("foo😭bar@example.com").is_err());
}
#[test]
fn invalid_domain_name() {
// non-permitted ascii chars
assert!(Nip05Name::try_from("foo@examp!e.com").is_err());
assert!(Nip05Name::try_from("foo@ example.com").is_err());
assert!(Nip05Name::try_from("foo@exa mple.com").is_err());
assert!(Nip05Name::try_from("foo@example .com").is_err());
assert!(Nip05Name::try_from("foo@exa<mple.com").is_err());
// unicode dash
assert!(Nip05Name::try_from("foobar@exa‐mple.com").is_err());
// emoji
assert!(Nip05Name::try_from("foobar@ex😭ample.com").is_err());
}
#[test]
fn to_url() {
let nip = Nip05Name::try_from("foobar@example.com").unwrap();
assert_eq!(
nip.to_url(),
Some(
"https://example.com/.well-known/nostr.json?name=foobar"
.parse()
.unwrap()
)
);
}
}
src/notice.rs
+112
View File
@@ -0,0 +1,112 @@
pub enum EventResultStatus {
Saved,
Duplicate,
Invalid,
Blocked,
RateLimited,
Error,
Restricted,
}
pub struct EventResult {
pub id: String,
pub msg: String,
pub status: EventResultStatus,
}
pub enum Notice {
Message(String),
EventResult(EventResult),
AuthChallenge(String),
}
impl EventResultStatus {
#[must_use]
pub fn to_bool(&self) -> bool {
match self {
Self::Duplicate | Self::Saved => true,
Self::Invalid | Self::Blocked | Self::RateLimited | Self::Error | Self::Restricted => {
false
}
}
}
#[must_use]
pub fn prefix(&self) -> &'static str {
match self {
Self::Saved => "saved",
Self::Duplicate => "duplicate",
Self::Invalid => "invalid",
Self::Blocked => "blocked",
Self::RateLimited => "rate-limited",
Self::Error => "error",
Self::Restricted => "restricted",
}
}
}
impl Notice {
//pub fn err(err: error::Error, id: String) -> Notice {
// Notice::err_msg(format!("{}", err), id)
//}
#[must_use]
pub fn message(msg: String) -> Notice {
Notice::Message(msg)
}
fn prefixed(id: String, msg: &str, status: EventResultStatus) -> Notice {
let msg = format!("{}: {}", status.prefix(), msg);
Notice::EventResult(EventResult { id, msg, status })
}
#[must_use]
pub fn invalid(id: String, msg: &str) -> Notice {
Notice::prefixed(id, msg, EventResultStatus::Invalid)
}
#[must_use]
pub fn blocked(id: String, msg: &str) -> Notice {
Notice::prefixed(id, msg, EventResultStatus::Blocked)
}
#[must_use]
pub fn rate_limited(id: String, msg: &str) -> Notice {
Notice::prefixed(id, msg, EventResultStatus::RateLimited)
}
#[must_use]
pub fn duplicate(id: String) -> Notice {
Notice::prefixed(id, "", EventResultStatus::Duplicate)
}
#[must_use]
pub fn error(id: String, msg: &str) -> Notice {
Notice::prefixed(id, msg, EventResultStatus::Error)
}
#[must_use]
pub fn restricted(id: String, msg: &str) -> Notice {
Notice::prefixed(id, msg, EventResultStatus::Restricted)
}
/// NIP-42: an OK=false with the machine-readable `auth-required:`
/// prefix, telling the client to AUTH and resend.
#[must_use]
pub fn auth_required(id: String, msg: &str) -> Notice {
Notice::EventResult(EventResult {
id,
msg: format!("auth-required: {msg}"),
status: EventResultStatus::Restricted,
})
}
#[must_use]
pub fn saved(id: String) -> Notice {
Notice::EventResult(EventResult {
id,
msg: "".into(),
status: EventResultStatus::Saved,
})
}
}
src/payment/cln_rest.rs
+137
View File
@@ -0,0 +1,137 @@
use std::{fs, str::FromStr};
use async_trait::async_trait;
use cln_rpc::{
model::{
requests::InvoiceRequest,
responses::{InvoiceResponse, ListinvoicesInvoicesStatus, ListinvoicesResponse},
},
primitives::{Amount, AmountOrAny},
};
use config::ConfigError;
use http::{header::CONTENT_TYPE, HeaderValue, Uri};
use hyper::{client::HttpConnector, Client};
use hyper_rustls::HttpsConnector;
use nostr::Keys;
use rand::random;
use crate::{
config::Settings,
error::{Error, Result},
};
use super::{InvoiceInfo, InvoiceStatus, PaymentProcessor};
#[derive(Clone)]
pub struct ClnRestPaymentProcessor {
client: hyper::Client<HttpsConnector<HttpConnector>, hyper::Body>,
settings: Settings,
rune_header: HeaderValue,
}
impl ClnRestPaymentProcessor {
pub fn new(settings: &Settings) -> Result<Self> {
let rune_path = settings
.pay_to_relay
.rune_path
.clone()
.ok_or(ConfigError::NotFound("rune_path".to_string()))?;
let rune = String::from_utf8(fs::read(rune_path)?)
.map_err(|_| ConfigError::Message("Rune should be UTF8".to_string()))?;
let mut rune_header = HeaderValue::from_str(rune.trim())
.map_err(|_| ConfigError::Message("Invalid Rune header".to_string()))?;
rune_header.set_sensitive(true);
let https = hyper_rustls::HttpsConnectorBuilder::new()
.with_native_roots()
.https_only()
.enable_http1()
.build();
let client = Client::builder().build::<_, hyper::Body>(https);
Ok(Self {
client,
settings: settings.clone(),
rune_header,
})
}
}
#[async_trait]
impl PaymentProcessor for ClnRestPaymentProcessor {
async fn get_invoice(&self, key: &Keys, amount: u64) -> Result<InvoiceInfo, Error> {
let random_number: u16 = random();
let memo = format!("{}: {}", random_number, key.public_key());
let body = InvoiceRequest {
cltv: None,
deschashonly: None,
expiry: None,
preimage: None,
exposeprivatechannels: None,
fallbacks: None,
amount_msat: AmountOrAny::Amount(Amount::from_sat(amount)),
description: memo.clone(),
label: "Nostr".to_string(),
};
let uri = Uri::from_str(&format!(
"{}/v1/invoice",
&self.settings.pay_to_relay.node_url
))
.map_err(|_| ConfigError::Message("Bad node URL".to_string()))?;
let req = hyper::Request::builder()
.method(hyper::Method::POST)
.uri(uri)
.header(CONTENT_TYPE, HeaderValue::from_static("application/json"))
.header("Rune", self.rune_header.clone())
.body(hyper::Body::from(serde_json::to_string(&body)?))
.expect("request builder");
let res = self.client.request(req).await?;
let body = hyper::body::to_bytes(res.into_body()).await?;
let invoice_response: InvoiceResponse = serde_json::from_slice(&body)?;
Ok(InvoiceInfo {
pubkey: key.public_key().to_string(),
payment_hash: invoice_response.payment_hash.to_string(),
bolt11: invoice_response.bolt11,
amount,
memo,
status: InvoiceStatus::Unpaid,
confirmed_at: None,
})
}
async fn check_invoice(&self, payment_hash: &str) -> Result<InvoiceStatus, Error> {
let uri = Uri::from_str(&format!(
"{}/v1/listinvoices?payment_hash={}",
&self.settings.pay_to_relay.node_url, payment_hash
))
.map_err(|_| ConfigError::Message("Bad node URL".to_string()))?;
let req = hyper::Request::builder()
.method(hyper::Method::POST)
.uri(uri)
.header(CONTENT_TYPE, HeaderValue::from_static("application/json"))
.header("Rune", self.rune_header.clone())
.body(hyper::Body::empty())
.expect("request builder");
let res = self.client.request(req).await?;
let body = hyper::body::to_bytes(res.into_body()).await?;
let invoice_response: ListinvoicesResponse = serde_json::from_slice(&body)?;
let invoice = invoice_response
.invoices
.first()
.ok_or(Error::CustomError("Invoice not found".to_string()))?;
let status = match invoice.status {
ListinvoicesInvoicesStatus::PAID => InvoiceStatus::Paid,
ListinvoicesInvoicesStatus::UNPAID => InvoiceStatus::Unpaid,
ListinvoicesInvoicesStatus::EXPIRED => InvoiceStatus::Expired,
};
Ok(status)
}
}
src/payment/goblinpay.rs
+166
View File
@@ -0,0 +1,166 @@
//! GoblinPay payment processor (Floonet addition).
//!
//! Talks to a GoblinPay server (the Grin payment backend) over its REST
//! API, using the same `PaymentProcessor` trait the Lightning processors
//! implement:
//!
//! * `POST /invoice` (Bearer `GP_API_TOKEN`) creates an invoice; the
//! response carries a hosted `pay_url` the payer opens to complete a
//! Grin payment (GoblinPay, manual slatepack, or a `grin1` address if
//! the operator enabled that method).
//! * `GET /invoice/{id}` returns the invoice's current status
//! (`open` / `paid` / `expired`); GoblinPay marks it paid only after
//! the payment confirms on chain (payment proof held server-side).
//!
//! Mapping onto the relay's invoice model: `payment_hash` holds the
//! GoblinPay `invoice_id`, and the `invoice` column (named `bolt11` in
//! code, an upstream Lightning artifact) holds the hosted `pay_url`.
//! Amounts are nanogrin (1 GRIN = 1_000_000_000 nanogrin).
//!
//! A GoblinPay webhook may POST `{"invoice_id": ...}` to this relay's
//! `/goblinpay` endpoint to speed up admission; the relay always
//! re-verifies with the GoblinPay server before admitting, so a forged
//! webhook cannot fake a payment (fail closed).
use http::Uri;
use hyper::client::connect::HttpConnector;
use hyper::Client;
use hyper_rustls::HttpsConnector;
use nostr::Keys;
use serde::{Deserialize, Serialize};
use async_trait::async_trait;
use std::str::FromStr;
use crate::error::Error;
use super::{InvoiceInfo, InvoiceStatus, PaymentProcessor};
/// JSON body for `POST /invoice`.
#[derive(Serialize, Debug)]
struct CreateInvoiceBody {
/// Amount in nanogrin.
amount_grin: u64,
/// The relay's reference for this invoice.
order_ref: String,
memo: String,
}
/// The slice of GoblinPay's invoice JSON the relay needs.
#[derive(Deserialize, Debug)]
struct InvoiceResponse {
invoice_id: String,
pay_url: String,
status: String,
}
#[derive(Clone)]
pub struct GoblinPayPaymentProcessor {
client: hyper::Client<HttpsConnector<HttpConnector>, hyper::Body>,
/// GoblinPay server base URL, no trailing slash.
base_url: String,
/// Bearer token (`GP_API_TOKEN`).
api_token: String,
}
impl GoblinPayPaymentProcessor {
pub fn new(base_url: &str, api_token: &str) -> Self {
// https in production; plain http is accepted so a local GoblinPay
// instance can be tested without certificates.
let https = hyper_rustls::HttpsConnectorBuilder::new()
.with_native_roots()
.https_or_http()
.enable_http1()
.build();
let client = Client::builder().build::<_, hyper::Body>(https);
Self {
client,
base_url: base_url.trim_end_matches('/').to_string(),
api_token: api_token.to_string(),
}
}
fn status_from(&self, status: &str) -> InvoiceStatus {
match status {
"paid" => InvoiceStatus::Paid,
"open" => InvoiceStatus::Unpaid,
// Unknown statuses are treated as expired: fail closed.
_ => InvoiceStatus::Expired,
}
}
}
#[async_trait]
impl PaymentProcessor for GoblinPayPaymentProcessor {
/// Create a GoblinPay invoice for `amount` nanogrin.
async fn get_invoice(&self, key: &Keys, amount: u64) -> Result<InvoiceInfo, Error> {
let pubkey = key.public_key().to_string();
let memo = format!("floonet relay: {pubkey}");
let body = CreateInvoiceBody {
amount_grin: amount,
order_ref: format!("floonet:{pubkey}"),
memo: memo.clone(),
};
let uri = Uri::from_str(&format!("{}/invoice", self.base_url))
.map_err(|_| Error::CustomError("invalid goblinpay url".to_string()))?;
let req = hyper::Request::builder()
.method(hyper::Method::POST)
.uri(uri)
.header("Authorization", format!("Bearer {}", self.api_token))
.header("Content-Type", "application/json")
.body(hyper::Body::from(serde_json::to_string(&body)?))
.expect("request builder");
let res = self.client.request(req).await?;
if !res.status().is_success() {
return Err(Error::CustomError(format!(
"goblinpay create invoice failed: HTTP {}",
res.status()
)));
}
let body = hyper::body::to_bytes(res.into_body()).await?;
let invoice: InvoiceResponse = serde_json::from_slice(&body)?;
Ok(InvoiceInfo {
pubkey,
payment_hash: invoice.invoice_id,
bolt11: invoice.pay_url,
amount,
memo,
status: self.status_from(&invoice.status),
confirmed_at: None,
})
}
/// Ask GoblinPay for the invoice's current status. GoblinPay only
/// reports `paid` after the Grin payment confirmed on chain.
async fn check_invoice(&self, payment_hash: &str) -> Result<InvoiceStatus, Error> {
// The id is server-generated, but never let a crafted value alter
// the request path.
if !payment_hash
.chars()
.all(|c| c.is_ascii_alphanumeric() || c == '-' || c == '_')
{
return Err(Error::CustomError("invalid invoice id".to_string()));
}
let uri = Uri::from_str(&format!("{}/invoice/{}", self.base_url, payment_hash))
.map_err(|_| Error::CustomError("invalid goblinpay url".to_string()))?;
let req = hyper::Request::builder()
.method(hyper::Method::GET)
.uri(uri)
.header("Authorization", format!("Bearer {}", self.api_token))
.body(hyper::Body::empty())
.expect("request builder");
let res = self.client.request(req).await?;
if !res.status().is_success() {
return Err(Error::CustomError(format!(
"goblinpay check invoice failed: HTTP {}",
res.status()
)));
}
let body = hyper::body::to_bytes(res.into_body()).await?;
let invoice: InvoiceResponse = serde_json::from_slice(&body)?;
Ok(self.status_from(&invoice.status))
}
}
src/payment/lnbits.rs
+176
View File
@@ -0,0 +1,176 @@
//! LNBits payment processor
use http::Uri;
use hyper::client::connect::HttpConnector;
use hyper::Client;
use hyper_rustls::HttpsConnector;
use nostr::Keys;
use serde::{Deserialize, Serialize};
use serde_json::Value;
use async_trait::async_trait;
use rand::Rng;
use std::str::FromStr;
use url::Url;
use crate::{config::Settings, error::Error};
use super::{InvoiceInfo, InvoiceStatus, PaymentProcessor};
const APIPATH: &str = "/api/v1/payments/";
/// Info LNBits expects in create invoice request
#[derive(Serialize, Deserialize, Debug)]
pub struct LNBitsCreateInvoice {
out: bool,
amount: u64,
memo: String,
webhook: String,
unit: String,
internal: bool,
expiry: u64,
}
/// Invoice response for LN bits
#[derive(Debug, Serialize, Deserialize)]
pub struct LNBitsCreateInvoiceResponse {
payment_hash: String,
payment_request: String,
}
/// LNBits call back response
/// Used when an invoice is paid
/// lnbits to post the status change to relay
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct LNBitsCallback {
pub checking_id: String,
pub pending: bool,
pub amount: u64,
pub memo: String,
pub time: u64,
pub bolt11: String,
pub preimage: String,
pub payment_hash: String,
pub wallet_id: String,
pub webhook: String,
pub webhook_status: Option<String>,
}
/// LN Bits repose for check invoice endpoint
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct LNBitsCheckInvoiceResponse {
paid: bool,
}
#[derive(Clone)]
pub struct LNBitsPaymentProcessor {
/// HTTP client
client: hyper::Client<HttpsConnector<HttpConnector>, hyper::Body>,
settings: Settings,
}
impl LNBitsPaymentProcessor {
pub fn new(settings: &Settings) -> Self {
// setup hyper client
let https = hyper_rustls::HttpsConnectorBuilder::new()
.with_native_roots()
.https_only()
.enable_http1()
.build();
let client = Client::builder().build::<_, hyper::Body>(https);
Self {
client,
settings: settings.clone(),
}
}
}
#[async_trait]
impl PaymentProcessor for LNBitsPaymentProcessor {
/// Calls LNBits api to ger new invoice
async fn get_invoice(&self, key: &Keys, amount: u64) -> Result<InvoiceInfo, Error> {
let random_number: u16 = rand::thread_rng().gen();
let memo = format!("{}: {}", random_number, key.public_key());
let callback_url = Url::parse(
&self
.settings
.info
.relay_url
.clone()
.unwrap()
.replace("ws", "http"),
)?
.join("lnbits")?;
let body = LNBitsCreateInvoice {
out: false,
amount,
memo: memo.clone(),
webhook: callback_url.to_string(),
unit: "sat".to_string(),
internal: false,
expiry: 3600,
};
let url = Url::parse(&self.settings.pay_to_relay.node_url)?.join(APIPATH)?;
let uri = Uri::from_str(url.as_str().strip_suffix('/').unwrap_or(url.as_str())).unwrap();
let req = hyper::Request::builder()
.method(hyper::Method::POST)
.uri(uri)
.header("X-Api-Key", &self.settings.pay_to_relay.api_secret)
.body(hyper::Body::from(serde_json::to_string(&body)?))
.expect("request builder");
let res = self.client.request(req).await?;
// Json to Struct of LNbits callback
let body = hyper::body::to_bytes(res.into_body()).await?;
let invoice_response: LNBitsCreateInvoiceResponse = serde_json::from_slice(&body)?;
Ok(InvoiceInfo {
pubkey: key.public_key().to_string(),
payment_hash: invoice_response.payment_hash,
bolt11: invoice_response.payment_request,
amount,
memo,
status: InvoiceStatus::Unpaid,
confirmed_at: None,
})
}
/// Calls LNBits Api to check the payment status of invoice
async fn check_invoice(&self, payment_hash: &str) -> Result<InvoiceStatus, Error> {
let url = Url::parse(&self.settings.pay_to_relay.node_url)?
.join(APIPATH)?
.join(payment_hash)?;
let uri = Uri::from_str(url.as_str()).unwrap();
let req = hyper::Request::builder()
.method(hyper::Method::GET)
.uri(uri)
.header("X-Api-Key", &self.settings.pay_to_relay.api_secret)
.body(hyper::Body::empty())
.expect("request builder");
let res = self.client.request(req).await?;
// Json to Struct of LNbits callback
let body = hyper::body::to_bytes(res.into_body()).await?;
let invoice_response: Value = serde_json::from_slice(&body)?;
let status = if let Ok(invoice_response) =
serde_json::from_value::<LNBitsCheckInvoiceResponse>(invoice_response)
{
if invoice_response.paid {
InvoiceStatus::Paid
} else {
InvoiceStatus::Unpaid
}
} else {
InvoiceStatus::Expired
};
Ok(status)
}
}
src/payment/mod.rs
+287
View File
@@ -0,0 +1,287 @@
use crate::error::{Error, Result};
use crate::event::Event;
use crate::payment::cln_rest::ClnRestPaymentProcessor;
use crate::payment::goblinpay::GoblinPayPaymentProcessor;
use crate::payment::lnbits::LNBitsPaymentProcessor;
use crate::repo::NostrRepo;
use serde::{Deserialize, Serialize};
use std::sync::Arc;
use tracing::{info, warn};
use async_trait::async_trait;
use nostr::key::{FromPkStr, FromSkStr};
use nostr::{key::Keys, Event as NostrEvent, EventBuilder};
pub mod cln_rest;
pub mod goblinpay;
pub mod lnbits;
/// Payment handler
pub struct Payment {
/// Repository for saving/retrieving events and events
repo: Arc<dyn NostrRepo>,
/// Newly validated events get written and then broadcast on this channel to subscribers
event_tx: tokio::sync::broadcast::Sender<Event>,
/// Payment message sender
payment_tx: tokio::sync::broadcast::Sender<PaymentMessage>,
/// Payment message receiver
payment_rx: tokio::sync::broadcast::Receiver<PaymentMessage>,
/// Settings
settings: crate::config::Settings,
// Nostr Keys
nostr_keys: Option<Keys>,
/// Payment Processor
processor: Arc<dyn PaymentProcessor>,
}
#[async_trait]
pub trait PaymentProcessor: Send + Sync {
/// Get invoice from processor
async fn get_invoice(&self, keys: &Keys, amount: u64) -> Result<InvoiceInfo, Error>;
/// Check payment status of an invoice
async fn check_invoice(&self, payment_hash: &str) -> Result<InvoiceStatus, Error>;
}
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
pub enum Processor {
LNBits,
ClnRest,
GoblinPay,
}
/// Possible states of an invoice
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, sqlx::Type)]
#[sqlx(type_name = "status")]
pub enum InvoiceStatus {
Unpaid,
Paid,
Expired,
}
impl std::fmt::Display for InvoiceStatus {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
InvoiceStatus::Paid => write!(f, "Paid"),
InvoiceStatus::Unpaid => write!(f, "Unpaid"),
InvoiceStatus::Expired => write!(f, "Expired"),
}
}
}
/// Invoice information
#[derive(Debug, Clone)]
pub struct InvoiceInfo {
pub pubkey: String,
pub payment_hash: String,
pub bolt11: String,
pub amount: u64,
pub status: InvoiceStatus,
pub memo: String,
pub confirmed_at: Option<u64>,
}
/// Message variants for the payment channel
#[derive(Debug, Clone)]
pub enum PaymentMessage {
/// New account
NewAccount(String),
/// Check account,
CheckAccount(String),
/// Account Admitted
AccountAdmitted(String),
/// Invoice generated
Invoice(String, InvoiceInfo),
/// Invoice call back
/// Payment hash is passed
// This may have to be changed to better support other processors
InvoicePaid(String),
}
impl Payment {
pub fn new(
repo: Arc<dyn NostrRepo>,
payment_tx: tokio::sync::broadcast::Sender<PaymentMessage>,
payment_rx: tokio::sync::broadcast::Receiver<PaymentMessage>,
event_tx: tokio::sync::broadcast::Sender<Event>,
settings: crate::config::Settings,
) -> Result<Self> {
info!("Create payment handler");
// Create nostr key from sk string
let nostr_keys = if let Some(secret_key) = &settings.pay_to_relay.secret_key {
Some(Keys::from_sk_str(secret_key)?)
} else {
None
};
// Create processor kind defined in settings
let processor: Arc<dyn PaymentProcessor> = match &settings.pay_to_relay.processor {
Processor::LNBits => Arc::new(LNBitsPaymentProcessor::new(&settings)),
Processor::ClnRest => Arc::new(ClnRestPaymentProcessor::new(&settings)?),
Processor::GoblinPay => Arc::new(GoblinPayPaymentProcessor::new(
&settings.pay_to_relay.node_url,
&settings.pay_to_relay.api_secret,
)),
};
Ok(Payment {
repo,
payment_tx,
payment_rx,
event_tx,
settings,
nostr_keys,
processor,
})
}
/// Perform Payment tasks
pub async fn run(&mut self) {
loop {
let res = self.run_internal().await;
if let Err(e) = res {
info!("error in payment: {:?}", e);
}
}
}
/// Internal select loop for preforming payment operations
async fn run_internal(&mut self) -> Result<()> {
tokio::select! {
m = self.payment_rx.recv() => {
match m {
Ok(PaymentMessage::NewAccount(pubkey)) => {
info!("payment event for {:?}", pubkey);
// REVIEW: This will need to change for cost per event
let amount = self.settings.pay_to_relay.admission_cost;
let invoice_info = self.get_invoice_info(&pubkey, amount).await?;
// TODO: should handle this error
self.payment_tx.send(PaymentMessage::Invoice(pubkey, invoice_info)).ok();
},
// Gets the most recent unpaid invoice from database
// Checks LNbits to verify if paid/unpaid
Ok(PaymentMessage::CheckAccount(pubkey)) => {
let keys = Keys::from_pk_str(&pubkey)?;
if let Ok(Some(invoice_info)) = self.repo.get_unpaid_invoice(&keys).await {
match self.check_invoice_status(&invoice_info.payment_hash).await? {
InvoiceStatus::Paid => {
self.repo.admit_account(&keys, self.settings.pay_to_relay.admission_cost).await?;
self.payment_tx.send(PaymentMessage::AccountAdmitted(pubkey)).ok();
}
_ => {
self.payment_tx.send(PaymentMessage::Invoice(pubkey, invoice_info)).ok();
}
}
} else {
let amount = self.settings.pay_to_relay.admission_cost;
let invoice_info = self.get_invoice_info(&pubkey, amount).await?;
self.payment_tx.send(PaymentMessage::Invoice(pubkey, invoice_info)).ok();
}
}
Ok(PaymentMessage::InvoicePaid(payment_hash)) => {
if self.check_invoice_status(&payment_hash).await?.eq(&InvoiceStatus::Paid) {
let pubkey = self.repo
.update_invoice(&payment_hash, InvoiceStatus::Paid)
.await?;
let key = Keys::from_pk_str(&pubkey)?;
self.repo.admit_account(&key, self.settings.pay_to_relay.admission_cost).await?;
}
}
Ok(_) => {
// For this variant nothing need to be done here
// it is used by `server`
}
Err(err) => warn!("Payment RX: {err}")
}
}
}
Ok(())
}
/// Sends Nostr DM to pubkey that requested invoice
/// Two events the terms followed by the bolt11 invoice
pub async fn send_admission_message(
&self,
pubkey: &str,
invoice_info: &InvoiceInfo,
) -> Result<()> {
let nostr_keys = match &self.nostr_keys {
Some(key) => key,
None => return Err(Error::CustomError("Nostr key not defined".to_string())),
};
// Create Nostr key from pk
let key = Keys::from_pk_str(pubkey)?;
let pubkey = key.public_key();
// Event DM with terms of service
let message_event: NostrEvent = EventBuilder::new_encrypted_direct_msg(
nostr_keys,
pubkey,
&self.settings.pay_to_relay.terms_message,
)?
.to_event(nostr_keys)?;
// Event DM with invoice
let invoice_event: NostrEvent =
EventBuilder::new_encrypted_direct_msg(nostr_keys, pubkey, &invoice_info.bolt11)?
.to_event(nostr_keys)?;
// Persist DM events to DB
self.repo.write_event(&message_event.clone().into()).await?;
self.repo.write_event(&invoice_event.clone().into()).await?;
// Broadcast DM events
self.event_tx.send(message_event.clone().into()).ok();
self.event_tx.send(invoice_event.clone().into()).ok();
Ok(())
}
/// Get Invoice Info
/// If the has an active invoice that will be return
/// Otherwise a new invoice will be generated by the payment processor
pub async fn get_invoice_info(&self, pubkey: &str, amount: u64) -> Result<InvoiceInfo> {
// If user is already in DB this will be false
// This avoids recreating admission invoices
// I think it will continue to send DMs with the invoice
// If client continues to try and write to the relay (will be same invoice)
let key = Keys::from_pk_str(pubkey)?;
if !self.repo.create_account(&key).await? {
if let Ok(Some(invoice_info)) = self.repo.get_unpaid_invoice(&key).await {
return Ok(invoice_info);
}
}
let key = Keys::from_pk_str(pubkey)?;
let invoice_info = self.processor.get_invoice(&key, amount).await?;
// Persist invoice to DB
self.repo
.create_invoice_record(&key, invoice_info.clone())
.await?;
if self.settings.pay_to_relay.direct_message {
// Admission event invoice and terms to pubkey that is joining
self.send_admission_message(pubkey, &invoice_info).await?;
}
Ok(invoice_info)
}
/// Check paid status of invoice with LNbits
pub async fn check_invoice_status(&self, payment_hash: &str) -> Result<InvoiceStatus, Error> {
// Check base if passed expiry time
let status = self.processor.check_invoice(payment_hash).await?;
self.repo
.update_invoice(payment_hash, status.clone())
.await?;
Ok(status)
}
}
src/repo/mod.rs
+98
View File
@@ -0,0 +1,98 @@
use crate::db::QueryResult;
use crate::error::Result;
use crate::event::Event;
use crate::nip05::VerificationRecord;
use crate::payment::{InvoiceInfo, InvoiceStatus};
use crate::subscription::Subscription;
use crate::utils::unix_time;
use async_trait::async_trait;
use nostr::Keys;
use rand::Rng;
pub mod postgres;
pub mod postgres_migration;
pub mod sqlite;
pub mod sqlite_migration;
#[async_trait]
pub trait NostrRepo: Send + Sync {
/// Start the repository (any initialization or maintenance tasks can be kicked off here)
async fn start(&self) -> Result<()>;
/// Run migrations and return current version
async fn migrate_up(&self) -> Result<usize>;
/// Persist event to database
async fn write_event(&self, e: &Event) -> Result<u64>;
/// Perform a database query using a subscription.
///
/// The [`Subscription`] is converted into a SQL query. Each result
/// is published on the `query_tx` channel as it is returned. If a
/// message becomes available on the `abandon_query_rx` channel, the
/// query is immediately aborted.
async fn query_subscription(
&self,
sub: Subscription,
client_id: String,
query_tx: tokio::sync::mpsc::Sender<QueryResult>,
mut abandon_query_rx: tokio::sync::oneshot::Receiver<()>,
) -> Result<()>;
/// Perform normal maintenance
async fn optimize_db(&self) -> Result<()>;
/// Create a new verification record connected to a specific event
async fn create_verification_record(&self, event_id: &str, name: &str) -> Result<()>;
/// Update verification timestamp
async fn update_verification_timestamp(&self, id: u64) -> Result<()>;
/// Update verification record as failed
async fn fail_verification(&self, id: u64) -> Result<()>;
/// Delete verification record
async fn delete_verification(&self, id: u64) -> Result<()>;
/// Get the latest verification record for a given pubkey.
async fn get_latest_user_verification(&self, pub_key: &str) -> Result<VerificationRecord>;
/// Get oldest verification before timestamp
async fn get_oldest_user_verification(&self, before: u64) -> Result<VerificationRecord>;
/// Create a new account
async fn create_account(&self, pubkey: &Keys) -> Result<bool>;
/// Admit an account
async fn admit_account(&self, pubkey: &Keys, admission_cost: u64) -> Result<()>;
/// Gets user balance if they are an admitted pubkey
async fn get_account_balance(&self, pubkey: &Keys) -> Result<(bool, u64)>;
/// Update account balance
async fn update_account_balance(
&self,
pub_key: &Keys,
positive: bool,
new_balance: u64,
) -> Result<()>;
/// Create invoice record
async fn create_invoice_record(&self, pubkey: &Keys, invoice_info: InvoiceInfo) -> Result<()>;
/// Update Invoice for given payment hash
async fn update_invoice(&self, payment_hash: &str, status: InvoiceStatus) -> Result<String>;
/// Get the most recent invoice for a given pubkey
/// invoice must be unpaid and not expired
async fn get_unpaid_invoice(&self, pubkey: &Keys) -> Result<Option<InvoiceInfo>>;
}
// Current time, with a slight forward jitter in seconds
pub(crate) fn now_jitter(sec: u64) -> u64 {
// random time between now, and 10min in future.
let mut rng = rand::thread_rng();
let jitter_amount = rng.gen_range(0..sec);
let now = unix_time();
now.saturating_add(jitter_amount)
}
src/repo/postgres.rs
+1063
View File
File diff suppressed because it is too large Load Diff
src/repo/postgres_migration.rs
+320
View File
@@ -0,0 +1,320 @@
use crate::repo::postgres::PostgresPool;
use async_trait::async_trait;
use sqlx::{Executor, Postgres, Transaction};
#[async_trait]
pub trait Migration {
fn serial_number(&self) -> i64;
async fn run(&self, tx: &mut Transaction<Postgres>);
}
struct SimpleSqlMigration {
pub serial_number: i64,
pub sql: Vec<&'static str>,
}
#[async_trait]
impl Migration for SimpleSqlMigration {
fn serial_number(&self) -> i64 {
self.serial_number
}
async fn run(&self, tx: &mut Transaction<Postgres>) {
for sql in self.sql.iter() {
tx.execute(*sql).await.unwrap();
}
}
}
/// Execute all migrations on the database.
pub async fn run_migrations(db: &PostgresPool) -> crate::error::Result<usize> {
prepare_migrations_table(db).await;
run_migration(m001::migration(), db).await;
let m002_result = run_migration(m002::migration(), db).await;
if m002_result == MigrationResult::Upgraded {
m002::rebuild_tags(db).await?;
}
run_migration(m003::migration(), db).await;
run_migration(m004::migration(), db).await;
run_migration(m005::migration(), db).await;
Ok(current_version(db).await as usize)
}
async fn current_version(db: &PostgresPool) -> i64 {
sqlx::query_scalar("SELECT max(serial_number) FROM migrations;")
.fetch_one(db)
.await
.unwrap()
}
async fn prepare_migrations_table(db: &PostgresPool) {
sqlx::query("CREATE TABLE IF NOT EXISTS migrations (serial_number bigint)")
.execute(db)
.await
.unwrap();
}
// Running a migration was either unnecessary, or completed
#[derive(PartialEq, Eq, Debug, Clone)]
enum MigrationResult {
Upgraded,
NotNeeded,
}
async fn run_migration(migration: impl Migration, db: &PostgresPool) -> MigrationResult {
let row: i64 =
sqlx::query_scalar("SELECT COUNT(*) AS count FROM migrations WHERE serial_number = $1")
.bind(migration.serial_number())
.fetch_one(db)
.await
.unwrap();
if row > 0 {
return MigrationResult::NotNeeded;
}
let mut transaction = db.begin().await.unwrap();
migration.run(&mut transaction).await;
sqlx::query("INSERT INTO migrations VALUES ($1)")
.bind(migration.serial_number())
.execute(&mut transaction)
.await
.unwrap();
transaction.commit().await.unwrap();
MigrationResult::Upgraded
}
mod m001 {
use crate::repo::postgres_migration::{Migration, SimpleSqlMigration};
pub const VERSION: i64 = 1;
pub fn migration() -> impl Migration {
SimpleSqlMigration {
serial_number: VERSION,
sql: vec![
r#"
-- Events table
CREATE TABLE "event" (
id bytea NOT NULL,
pub_key bytea NOT NULL,
created_at timestamp with time zone NOT NULL,
kind integer NOT NULL,
"content" bytea NOT NULL,
hidden bit(1) NOT NULL DEFAULT 0::bit(1),
delegated_by bytea NULL,
first_seen timestamp with time zone NOT NULL DEFAULT now(),
CONSTRAINT event_pkey PRIMARY KEY (id)
);
CREATE INDEX event_created_at_idx ON "event" (created_at,kind);
CREATE INDEX event_pub_key_idx ON "event" (pub_key);
CREATE INDEX event_delegated_by_idx ON "event" (delegated_by);
-- Tags table
CREATE TABLE "tag" (
id int8 NOT NULL GENERATED BY DEFAULT AS IDENTITY,
event_id bytea NOT NULL,
"name" varchar NOT NULL,
value bytea NOT NULL,
CONSTRAINT tag_fk FOREIGN KEY (event_id) REFERENCES "event"(id) ON DELETE CASCADE
);
CREATE INDEX tag_event_id_idx ON tag USING btree (event_id, name);
CREATE INDEX tag_value_idx ON tag USING btree (value);
-- NIP-05 Verification table
CREATE TABLE "user_verification" (
id int8 NOT NULL GENERATED BY DEFAULT AS IDENTITY,
event_id bytea NOT NULL,
"name" varchar NOT NULL,
verified_at timestamptz NULL,
failed_at timestamptz NULL,
fail_count int4 NULL DEFAULT 0,
CONSTRAINT user_verification_pk PRIMARY KEY (id),
CONSTRAINT user_verification_fk FOREIGN KEY (event_id) REFERENCES "event"(id) ON DELETE CASCADE
);
CREATE INDEX user_verification_event_id_idx ON user_verification USING btree (event_id);
CREATE INDEX user_verification_name_idx ON user_verification USING btree (name);
"#,
],
}
}
}
mod m002 {
use async_std::stream::StreamExt;
use indicatif::{ProgressBar, ProgressStyle};
use sqlx::Row;
use std::time::Instant;
use tracing::info;
use crate::event::{single_char_tagname, Event};
use crate::repo::postgres::PostgresPool;
use crate::repo::postgres_migration::{Migration, SimpleSqlMigration};
use crate::utils::is_lower_hex;
pub const VERSION: i64 = 2;
pub fn migration() -> impl Migration {
SimpleSqlMigration {
serial_number: VERSION,
sql: vec![
r#"
-- Add tag value column
ALTER TABLE tag ADD COLUMN value_hex bytea;
-- Remove not-null constraint
ALTER TABLE tag ALTER COLUMN value DROP NOT NULL;
-- Add value index
CREATE INDEX tag_value_hex_idx ON tag USING btree (value_hex);
"#,
],
}
}
pub async fn rebuild_tags(db: &PostgresPool) -> crate::error::Result<()> {
// Check how many events we have to process
let start = Instant::now();
let mut tx = db.begin().await.unwrap();
let mut update_tx = db.begin().await.unwrap();
// Clear out table
sqlx::query("DELETE FROM tag;")
.execute(&mut update_tx)
.await?;
{
let event_count: i64 = sqlx::query_scalar("SELECT COUNT(*) from event;")
.fetch_one(&mut tx)
.await
.unwrap();
let bar = ProgressBar::new(event_count.try_into().unwrap())
.with_message("rebuilding tags table");
bar.set_style(
ProgressStyle::with_template(
"[{elapsed_precise}] {bar:40.white/blue} {pos:>7}/{len:7} [{percent}%] {msg}",
)
.unwrap(),
);
let mut events =
sqlx::query("SELECT id, content FROM event ORDER BY id;").fetch(&mut tx);
while let Some(row) = events.next().await {
bar.inc(1);
// get the row id and content
let row = row.unwrap();
let event_id: Vec<u8> = row.get(0);
let event_bytes: Vec<u8> = row.get(1);
let event: Event = serde_json::from_str(&String::from_utf8(event_bytes).unwrap())?;
for t in event.tags.iter().filter(|x| x.len() > 1) {
let tagname = t.first().unwrap();
let tagnamechar_opt = single_char_tagname(tagname);
if tagnamechar_opt.is_none() {
continue;
}
// safe because len was > 1
let tagval = t.get(1).unwrap();
// insert as BLOB if we can restore it losslessly.
// this means it needs to be even length and lowercase.
if (tagval.len() % 2 == 0) && is_lower_hex(tagval) {
let q = "INSERT INTO tag (event_id, \"name\", value, value_hex) VALUES ($1, $2, NULL, $3) ON CONFLICT DO NOTHING;";
sqlx::query(q)
.bind(&event_id)
.bind(tagname)
.bind(hex::decode(tagval).ok())
.execute(&mut update_tx)
.await?;
} else {
let q = "INSERT INTO tag (event_id, \"name\", value, value_hex) VALUES ($1, $2, $3, NULL) ON CONFLICT DO NOTHING;";
sqlx::query(q)
.bind(&event_id)
.bind(tagname)
.bind(tagval.as_bytes())
.execute(&mut update_tx)
.await?;
}
}
}
update_tx.commit().await?;
bar.finish();
}
info!("rebuilt tags in {:?}", start.elapsed());
Ok(())
}
}
mod m003 {
use crate::repo::postgres_migration::{Migration, SimpleSqlMigration};
pub const VERSION: i64 = 3;
pub fn migration() -> impl Migration {
SimpleSqlMigration {
serial_number: VERSION,
sql: vec![
r#"
-- Add unique constraint on tag
ALTER TABLE tag ADD CONSTRAINT unique_constraint_name UNIQUE (event_id, "name", value, value_hex);
"#,
],
}
}
}
mod m004 {
use crate::repo::postgres_migration::{Migration, SimpleSqlMigration};
pub const VERSION: i64 = 4;
pub fn migration() -> impl Migration {
SimpleSqlMigration {
serial_number: VERSION,
sql: vec![
r#"
-- Add expiration time for events
ALTER TABLE event ADD COLUMN expires_at timestamp(0) with time zone;
-- Index expiration time
CREATE INDEX event_expires_at_idx ON "event" (expires_at);
"#,
],
}
}
}
mod m005 {
use crate::repo::postgres_migration::{Migration, SimpleSqlMigration};
pub const VERSION: i64 = 5;
pub fn migration() -> impl Migration {
SimpleSqlMigration {
serial_number: VERSION,
sql: vec![
r#"
-- Create account table
CREATE TABLE "account" (
pubkey varchar NOT NULL,
is_admitted BOOLEAN NOT NULL DEFAULT FALSE,
balance BIGINT NOT NULL DEFAULT 0,
tos_accepted_at TIMESTAMP,
CONSTRAINT account_pkey PRIMARY KEY (pubkey)
);
CREATE TYPE status AS ENUM ('Paid', 'Unpaid', 'Expired');
CREATE TABLE "invoice" (
payment_hash varchar NOT NULL,
pubkey varchar NOT NULL,
invoice varchar NOT NULL,
amount BIGINT NOT NULL,
status status NOT NULL DEFAULT 'Unpaid',
description varchar,
created_at timestamp,
confirmed_at timestamp,
CONSTRAINT invoice_payment_hash PRIMARY KEY (payment_hash),
CONSTRAINT invoice_pubkey_fkey FOREIGN KEY (pubkey) REFERENCES account (pubkey) ON DELETE CASCADE
);
"#,
],
}
}
}
src/repo/sqlite.rs
+1614
View File
File diff suppressed because it is too large Load Diff
src/repo/sqlite_migration.rs
+885
View File
@@ -0,0 +1,885 @@
//! Database schema and migrations
use crate::db::PooledConnection;
use crate::error::Result;
use crate::event::{single_char_tagname, Event};
use crate::utils::is_lower_hex;
use const_format::formatcp;
use indicatif::{ProgressBar, ProgressStyle};
use rusqlite::limits::Limit;
use rusqlite::params;
use rusqlite::Connection;
use std::cmp::Ordering;
use std::time::Instant;
use tracing::{debug, error, info};
/// Startup DB Pragmas
pub const STARTUP_SQL: &str = r##"
PRAGMA main.synchronous = NORMAL;
PRAGMA foreign_keys = ON;
PRAGMA journal_size_limit = 32768;
PRAGMA temp_store = 2; -- use memory, not temp files
PRAGMA main.cache_size = 20000; -- 80MB max cache size per conn
pragma mmap_size = 0; -- disable mmap (default)
"##;
/// Latest database version
pub const DB_VERSION: usize = 19;
/// Schema definition
const INIT_SQL: &str = formatcp!(
r##"
-- Database settings
PRAGMA encoding = "UTF-8";
PRAGMA journal_mode = WAL;
PRAGMA auto_vacuum = FULL;
PRAGMA main.synchronous=NORMAL;
PRAGMA foreign_keys = ON;
PRAGMA application_id = 1654008667;
PRAGMA user_version = {};
-- Event Table
CREATE TABLE IF NOT EXISTS event (
id INTEGER PRIMARY KEY,
event_hash BLOB NOT NULL, -- 32-byte SHA256 hash
first_seen INTEGER NOT NULL, -- when the event was first seen (not authored!) (seconds since 1970)
created_at INTEGER NOT NULL, -- when the event was authored
expires_at INTEGER, -- when the event expires and may be deleted
author BLOB NOT NULL, -- author pubkey
delegated_by BLOB, -- delegator pubkey (NIP-26)
kind INTEGER NOT NULL, -- event kind
hidden INTEGER, -- relevant for queries
content TEXT NOT NULL -- serialized json of event object
);
-- Event Indexes
CREATE UNIQUE INDEX IF NOT EXISTS event_hash_index ON event(event_hash);
CREATE INDEX IF NOT EXISTS author_index ON event(author);
CREATE INDEX IF NOT EXISTS kind_index ON event(kind);
CREATE INDEX IF NOT EXISTS created_at_index ON event(created_at);
CREATE INDEX IF NOT EXISTS delegated_by_index ON event(delegated_by);
CREATE INDEX IF NOT EXISTS event_composite_index ON event(kind,created_at);
CREATE INDEX IF NOT EXISTS kind_author_index ON event(kind,author);
CREATE INDEX IF NOT EXISTS kind_created_at_index ON event(kind,created_at);
CREATE INDEX IF NOT EXISTS author_created_at_index ON event(author,created_at);
CREATE INDEX IF NOT EXISTS author_kind_index ON event(author,kind);
CREATE INDEX IF NOT EXISTS event_expiration ON event(expires_at);
-- Tag Table
-- Tag values are stored as either a BLOB (if they come in as a
-- hex-string), or TEXT otherwise.
-- This means that searches need to select the appropriate column.
-- We duplicate the kind/created_at to make indexes much more efficient.
CREATE TABLE IF NOT EXISTS tag (
id INTEGER PRIMARY KEY,
event_id INTEGER NOT NULL, -- an event ID that contains a tag.
name TEXT, -- the tag name ("p", "e", whatever)
value TEXT, -- the tag value, if not hex.
value_hex BLOB, -- the tag value, if it can be interpreted as a lowercase hex string.
created_at INTEGER NOT NULL, -- when the event was authored
kind INTEGER NOT NULL, -- event kind
FOREIGN KEY(event_id) REFERENCES event(id) ON UPDATE CASCADE ON DELETE CASCADE
);
CREATE INDEX IF NOT EXISTS tag_val_index ON tag(value);
CREATE INDEX IF NOT EXISTS tag_composite_index ON tag(event_id,name,value);
CREATE INDEX IF NOT EXISTS tag_name_eid_index ON tag(name,event_id,value);
CREATE INDEX IF NOT EXISTS tag_covering_index ON tag(name,kind,value,created_at,event_id);
-- NIP-05 User Validation
CREATE TABLE IF NOT EXISTS user_verification (
id INTEGER PRIMARY KEY,
metadata_event INTEGER NOT NULL, -- the metadata event used for this validation.
name TEXT NOT NULL, -- the nip05 field value (user@domain).
verified_at INTEGER, -- timestamp this author/nip05 was most recently verified.
failed_at INTEGER, -- timestamp a verification attempt failed (host down).
failure_count INTEGER DEFAULT 0, -- number of consecutive failures.
FOREIGN KEY(metadata_event) REFERENCES event(id) ON UPDATE CASCADE ON DELETE CASCADE
);
CREATE INDEX IF NOT EXISTS user_verification_name_index ON user_verification(name);
CREATE INDEX IF NOT EXISTS user_verification_event_index ON user_verification(metadata_event);
-- Create account table
CREATE TABLE IF NOT EXISTS account (
pubkey TEXT PRIMARY KEY,
is_admitted INTEGER NOT NULL DEFAULT 0,
balance INTEGER NOT NULL DEFAULT 0,
tos_accepted_at INTEGER
);
-- Create account index
CREATE INDEX IF NOT EXISTS user_pubkey_index ON account(pubkey);
-- Invoice table
CREATE TABLE IF NOT EXISTS invoice (
payment_hash TEXT PRIMARY KEY,
pubkey TEXT NOT NULL,
invoice TEXT NOT NULL,
amount INTEGER NOT NULL,
status TEXT CHECK ( status IN ('Paid', 'Unpaid', 'Expired' ) ) NOT NUll DEFAULT 'Unpaid',
description TEXT,
created_at INTEGER NOT NULL,
confirmed_at INTEGER,
CONSTRAINT invoice_pubkey_fkey FOREIGN KEY (pubkey) REFERENCES account (pubkey) ON DELETE CASCADE
);
-- Create invoice index
CREATE INDEX IF NOT EXISTS invoice_pubkey_index ON invoice(pubkey);
-- Name authority claims (Floonet). One row per claimed name; a release
-- sets released_at instead of deleting, and the partial unique index
-- enforces one ACTIVE name per pubkey at the database layer.
CREATE TABLE IF NOT EXISTS name_claims (
name TEXT PRIMARY KEY,
pubkey TEXT NOT NULL,
created_at INTEGER NOT NULL,
released_at INTEGER
);
CREATE INDEX IF NOT EXISTS name_claims_pubkey_index ON name_claims(pubkey);
CREATE UNIQUE INDEX IF NOT EXISTS name_claims_active_pubkey
ON name_claims(pubkey) WHERE released_at IS NULL;
"##,
DB_VERSION
);
/// Determine the current application database schema version.
pub fn curr_db_version(conn: &mut Connection) -> Result<usize> {
let query = "PRAGMA user_version;";
let curr_version = conn.query_row(query, [], |row| row.get(0))?;
Ok(curr_version)
}
/// Determine event count
pub fn db_event_count(conn: &mut Connection) -> Result<usize> {
let query = "SELECT count(*) FROM event;";
let count = conn.query_row(query, [], |row| row.get(0))?;
Ok(count)
}
/// Determine tag count
pub fn db_tag_count(conn: &mut Connection) -> Result<usize> {
let query = "SELECT count(*) FROM tag;";
let count = conn.query_row(query, [], |row| row.get(0))?;
Ok(count)
}
fn mig_init(conn: &mut PooledConnection) -> usize {
match conn.execute_batch(INIT_SQL) {
Ok(()) => {
info!(
"database pragma/schema initialized to v{}, and ready",
DB_VERSION
);
}
Err(err) => {
error!("update (init) failed: {}", err);
panic!("database could not be initialized");
}
}
DB_VERSION
}
/// Upgrade DB to latest version, and execute pragma settings
pub fn upgrade_db(conn: &mut PooledConnection) -> Result<usize> {
// check the version.
let mut curr_version = curr_db_version(conn)?;
info!("DB version = {:?}", curr_version);
debug!(
"SQLite max query parameters: {}",
conn.limit(Limit::SQLITE_LIMIT_VARIABLE_NUMBER)
);
debug!(
"SQLite max table/blob/text length: {} MB",
(f64::from(conn.limit(Limit::SQLITE_LIMIT_LENGTH)) / f64::from(1024 * 1024)).floor()
);
debug!(
"SQLite max SQL length: {} MB",
(f64::from(conn.limit(Limit::SQLITE_LIMIT_SQL_LENGTH)) / f64::from(1024 * 1024)).floor()
);
match curr_version.cmp(&DB_VERSION) {
// Database is new or not current
Ordering::Less => {
// initialize from scratch
if curr_version == 0 {
curr_version = mig_init(conn);
}
// for initialized but out-of-date schemas, proceed to
// upgrade sequentially until we are current.
if curr_version == 1 {
curr_version = mig_1_to_2(conn)?;
}
if curr_version == 2 {
curr_version = mig_2_to_3(conn)?;
}
if curr_version == 3 {
curr_version = mig_3_to_4(conn)?;
}
if curr_version == 4 {
curr_version = mig_4_to_5(conn)?;
}
if curr_version == 5 {
curr_version = mig_5_to_6(conn)?;
}
if curr_version == 6 {
curr_version = mig_6_to_7(conn)?;
}
if curr_version == 7 {
curr_version = mig_7_to_8(conn)?;
}
if curr_version == 8 {
curr_version = mig_8_to_9(conn)?;
}
if curr_version == 9 {
curr_version = mig_9_to_10(conn)?;
}
if curr_version == 10 {
curr_version = mig_10_to_11(conn)?;
}
if curr_version == 11 {
curr_version = mig_11_to_12(conn)?;
}
if curr_version == 12 {
curr_version = mig_12_to_13(conn)?;
}
if curr_version == 13 {
curr_version = mig_13_to_14(conn)?;
}
if curr_version == 14 {
curr_version = mig_14_to_15(conn)?;
}
if curr_version == 15 {
curr_version = mig_15_to_16(conn)?;
}
if curr_version == 16 {
curr_version = mig_16_to_17(conn)?;
}
if curr_version == 17 {
curr_version = mig_17_to_18(conn)?;
}
if curr_version == 18 {
curr_version = mig_18_to_19(conn)?;
}
if curr_version == DB_VERSION {
info!(
"All migration scripts completed successfully. Welcome to v{}.",
DB_VERSION
);
}
}
// Database is current, all is good
Ordering::Equal => {
debug!("Database version was already current (v{DB_VERSION})");
}
// Database is newer than what this code understands, abort
Ordering::Greater => {
panic!(
"Database version is newer than supported by this executable (v{curr_version} > v{DB_VERSION})",
);
}
}
// Setup PRAGMA
conn.execute_batch(STARTUP_SQL)?;
debug!("SQLite PRAGMA startup completed");
Ok(DB_VERSION)
}
pub fn rebuild_tags(conn: &mut PooledConnection) -> Result<()> {
// Check how many events we have to process
let count = db_event_count(conn)?;
let update_each_percent = 0.05;
let mut percent_done = 0.0;
let mut events_processed = 0;
let start = Instant::now();
let tx = conn.transaction()?;
{
// Clear out table
tx.execute("DELETE FROM tag;", [])?;
let mut stmt = tx.prepare("select id, content from event order by id;")?;
let mut tag_rows = stmt.query([])?;
while let Some(row) = tag_rows.next()? {
if (events_processed as f32) / (count as f32) > percent_done {
info!("Tag update {}% complete...", (100.0 * percent_done).round());
percent_done += update_each_percent;
}
// we want to capture the event_id that had the tag, the tag name, and the tag hex value.
let event_id: u64 = row.get(0)?;
let event_json: String = row.get(1)?;
let event: Event = serde_json::from_str(&event_json)?;
// look at each event, and each tag, creating new tag entries if appropriate.
for t in event.tags.iter().filter(|x| x.len() > 1) {
let tagname = t.first().unwrap();
let tagnamechar_opt = single_char_tagname(tagname);
if tagnamechar_opt.is_none() {
continue;
}
// safe because len was > 1
let tagval = t.get(1).unwrap();
// insert as BLOB if we can restore it losslessly.
// this means it needs to be even length and lowercase.
if (tagval.len() % 2 == 0) && is_lower_hex(tagval) {
tx.execute(
"INSERT INTO tag (event_id, name, value_hex) VALUES (?1, ?2, ?3);",
params![event_id, tagname, hex::decode(tagval).ok()],
)?;
} else {
// otherwise, insert as text
tx.execute(
"INSERT INTO tag (event_id, name, value) VALUES (?1, ?2, ?3);",
params![event_id, tagname, &tagval],
)?;
}
}
events_processed += 1;
}
}
tx.commit()?;
info!("rebuilt tags in {:?}", start.elapsed());
Ok(())
}
// Migration Scripts
fn mig_1_to_2(conn: &mut PooledConnection) -> Result<usize> {
// only change is adding a hidden column to events.
let upgrade_sql = r##"
ALTER TABLE event ADD hidden INTEGER;
UPDATE event SET hidden=FALSE;
PRAGMA user_version = 2;
"##;
match conn.execute_batch(upgrade_sql) {
Ok(()) => {
info!("database schema upgraded v1 -> v2");
}
Err(err) => {
error!("update (v1->v2) failed: {}", err);
panic!("database could not be upgraded");
}
}
Ok(2)
}
fn mig_2_to_3(conn: &mut PooledConnection) -> Result<usize> {
// this version lacks the tag column
info!("database schema needs update from 2->3");
let upgrade_sql = r##"
CREATE TABLE IF NOT EXISTS tag (
id INTEGER PRIMARY KEY,
event_id INTEGER NOT NULL, -- an event ID that contains a tag.
name TEXT, -- the tag name ("p", "e", whatever)
value TEXT, -- the tag value, if not hex.
value_hex BLOB, -- the tag value, if it can be interpreted as a hex string.
FOREIGN KEY(event_id) REFERENCES event(id) ON UPDATE CASCADE ON DELETE CASCADE
);
PRAGMA user_version = 3;
"##;
// TODO: load existing refs into tag table
match conn.execute_batch(upgrade_sql) {
Ok(()) => {
info!("database schema upgraded v2 -> v3");
}
Err(err) => {
error!("update (v2->v3) failed: {}", err);
panic!("database could not be upgraded");
}
}
// iterate over every event/pubkey tag
let tx = conn.transaction()?;
{
let mut stmt = tx.prepare("select event_id, \"e\", lower(hex(referenced_event)) from event_ref union select event_id, \"p\", lower(hex(referenced_pubkey)) from pubkey_ref;")?;
let mut tag_rows = stmt.query([])?;
while let Some(row) = tag_rows.next()? {
// we want to capture the event_id that had the tag, the tag name, and the tag hex value.
let event_id: u64 = row.get(0)?;
let tag_name: String = row.get(1)?;
let tag_value: String = row.get(2)?;
// this will leave behind p/e tags that were non-hex, but they are invalid anyways.
if is_lower_hex(&tag_value) {
tx.execute(
"INSERT INTO tag (event_id, name, value_hex) VALUES (?1, ?2, ?3);",
params![event_id, tag_name, hex::decode(&tag_value).ok()],
)?;
}
}
}
info!("Updated tag values");
tx.commit()?;
Ok(3)
}
fn mig_3_to_4(conn: &mut PooledConnection) -> Result<usize> {
info!("database schema needs update from 3->4");
let upgrade_sql = r##"
-- incoming metadata events with nip05
CREATE TABLE IF NOT EXISTS user_verification (
id INTEGER PRIMARY KEY,
metadata_event INTEGER NOT NULL, -- the metadata event used for this validation.
name TEXT NOT NULL, -- the nip05 field value (user@domain).
verified_at INTEGER, -- timestamp this author/nip05 was most recently verified.
failed_at INTEGER, -- timestamp a verification attempt failed (host down).
failure_count INTEGER DEFAULT 0, -- number of consecutive failures.
FOREIGN KEY(metadata_event) REFERENCES event(id) ON UPDATE CASCADE ON DELETE CASCADE
);
CREATE INDEX IF NOT EXISTS user_verification_name_index ON user_verification(name);
CREATE INDEX IF NOT EXISTS user_verification_event_index ON user_verification(metadata_event);
PRAGMA user_version = 4;
"##;
match conn.execute_batch(upgrade_sql) {
Ok(()) => {
info!("database schema upgraded v3 -> v4");
}
Err(err) => {
error!("update (v3->v4) failed: {}", err);
panic!("database could not be upgraded");
}
}
Ok(4)
}
fn mig_4_to_5(conn: &mut PooledConnection) -> Result<usize> {
info!("database schema needs update from 4->5");
let upgrade_sql = r##"
DROP TABLE IF EXISTS event_ref;
DROP TABLE IF EXISTS pubkey_ref;
PRAGMA user_version=5;
"##;
match conn.execute_batch(upgrade_sql) {
Ok(()) => {
info!("database schema upgraded v4 -> v5");
}
Err(err) => {
error!("update (v4->v5) failed: {}", err);
panic!("database could not be upgraded");
}
}
Ok(5)
}
fn mig_5_to_6(conn: &mut PooledConnection) -> Result<usize> {
info!("database schema needs update from 5->6");
// We need to rebuild the tags table. iterate through the
// event table. build event from json, insert tags into a
// fresh tag table. This was needed due to a logic error in
// how hex-like tags got indexed.
let start = Instant::now();
let tx = conn.transaction()?;
{
// Clear out table
tx.execute("DELETE FROM tag;", [])?;
let mut stmt = tx.prepare("select id, content from event order by id;")?;
let mut tag_rows = stmt.query([])?;
while let Some(row) = tag_rows.next()? {
let event_id: u64 = row.get(0)?;
let event_json: String = row.get(1)?;
let event: Event = serde_json::from_str(&event_json)?;
// look at each event, and each tag, creating new tag entries if appropriate.
for t in event.tags.iter().filter(|x| x.len() > 1) {
let tagname = t.first().unwrap();
let tagnamechar_opt = single_char_tagname(tagname);
if tagnamechar_opt.is_none() {
continue;
}
// safe because len was > 1
let tagval = t.get(1).unwrap();
// insert as BLOB if we can restore it losslessly.
// this means it needs to be even length and lowercase.
if (tagval.len() % 2 == 0) && is_lower_hex(tagval) {
tx.execute(
"INSERT INTO tag (event_id, name, value_hex) VALUES (?1, ?2, ?3);",
params![event_id, tagname, hex::decode(tagval).ok()],
)?;
} else {
// otherwise, insert as text
tx.execute(
"INSERT INTO tag (event_id, name, value) VALUES (?1, ?2, ?3);",
params![event_id, tagname, &tagval],
)?;
}
}
}
tx.execute("PRAGMA user_version = 6;", [])?;
}
tx.commit()?;
info!("database schema upgraded v5 -> v6 in {:?}", start.elapsed());
// vacuum after large table modification
let start = Instant::now();
conn.execute("VACUUM;", [])?;
info!("vacuumed DB after tags rebuild in {:?}", start.elapsed());
Ok(6)
}
fn mig_6_to_7(conn: &mut PooledConnection) -> Result<usize> {
info!("database schema needs update from 6->7");
let upgrade_sql = r##"
ALTER TABLE event ADD delegated_by BLOB;
CREATE INDEX IF NOT EXISTS delegated_by_index ON event(delegated_by);
PRAGMA user_version = 7;
"##;
match conn.execute_batch(upgrade_sql) {
Ok(()) => {
info!("database schema upgraded v6 -> v7");
}
Err(err) => {
error!("update (v6->v7) failed: {}", err);
panic!("database could not be upgraded");
}
}
Ok(7)
}
fn mig_7_to_8(conn: &mut PooledConnection) -> Result<usize> {
info!("database schema needs update from 7->8");
// Remove redundant indexes, and add a better multi-column index.
let upgrade_sql = r##"
DROP INDEX IF EXISTS created_at_index;
DROP INDEX IF EXISTS kind_index;
CREATE INDEX IF NOT EXISTS event_composite_index ON event(kind,created_at);
PRAGMA user_version = 8;
"##;
match conn.execute_batch(upgrade_sql) {
Ok(()) => {
info!("database schema upgraded v7 -> v8");
}
Err(err) => {
error!("update (v7->v8) failed: {}", err);
panic!("database could not be upgraded");
}
}
Ok(8)
}
fn mig_8_to_9(conn: &mut PooledConnection) -> Result<usize> {
info!("database schema needs update from 8->9");
// Those old indexes were actually helpful...
let upgrade_sql = r##"
CREATE INDEX IF NOT EXISTS created_at_index ON event(created_at);
CREATE INDEX IF NOT EXISTS event_composite_index ON event(kind,created_at);
PRAGMA user_version = 9;
"##;
match conn.execute_batch(upgrade_sql) {
Ok(()) => {
info!("database schema upgraded v8 -> v9");
}
Err(err) => {
error!("update (v8->v9) failed: {}", err);
panic!("database could not be upgraded");
}
}
Ok(9)
}
fn mig_9_to_10(conn: &mut PooledConnection) -> Result<usize> {
info!("database schema needs update from 9->10");
// Those old indexes were actually helpful...
let upgrade_sql = r##"
CREATE INDEX IF NOT EXISTS tag_composite_index ON tag(event_id,name,value_hex,value);
PRAGMA user_version = 10;
"##;
match conn.execute_batch(upgrade_sql) {
Ok(()) => {
info!("database schema upgraded v9 -> v10");
}
Err(err) => {
error!("update (v9->v10) failed: {}", err);
panic!("database could not be upgraded");
}
}
Ok(10)
}
fn mig_10_to_11(conn: &mut PooledConnection) -> Result<usize> {
info!("database schema needs update from 10->11");
// Those old indexes were actually helpful...
let upgrade_sql = r##"
CREATE INDEX IF NOT EXISTS tag_name_eid_index ON tag(name,event_id,value_hex);
reindex;
pragma optimize;
PRAGMA user_version = 11;
"##;
match conn.execute_batch(upgrade_sql) {
Ok(()) => {
info!("database schema upgraded v10 -> v11");
}
Err(err) => {
error!("update (v10->v11) failed: {}", err);
panic!("database could not be upgraded");
}
}
Ok(11)
}
fn mig_11_to_12(conn: &mut PooledConnection) -> Result<usize> {
info!("database schema needs update from 11->12");
let start = Instant::now();
let tx = conn.transaction()?;
{
// Lookup every replaceable event
let mut stmt = tx.prepare("select kind,author from event where kind in (0,3,41) or (kind>=10000 and kind<20000) order by id;")?;
let mut replaceable_rows = stmt.query([])?;
info!("updating replaceable events; this could take awhile...");
while let Some(row) = replaceable_rows.next()? {
// we want to capture the event_id that had the tag, the tag name, and the tag hex value.
let event_kind: u64 = row.get(0)?;
let event_author: Vec<u8> = row.get(1)?;
tx.execute(
"UPDATE event SET hidden=TRUE WHERE hidden!=TRUE and kind=? and author=? and id NOT IN (SELECT id FROM event WHERE kind=? AND author=? ORDER BY created_at DESC LIMIT 1)",
params![event_kind, event_author, event_kind, event_author],
)?;
}
tx.execute("PRAGMA user_version = 12;", [])?;
}
tx.commit()?;
info!(
"database schema upgraded v11 -> v12 in {:?}",
start.elapsed()
);
// vacuum after large table modification
let start = Instant::now();
conn.execute("VACUUM;", [])?;
info!(
"vacuumed DB after hidden event cleanup in {:?}",
start.elapsed()
);
Ok(12)
}
fn mig_12_to_13(conn: &mut PooledConnection) -> Result<usize> {
info!("database schema needs update from 12->13");
let upgrade_sql = r##"
CREATE INDEX IF NOT EXISTS kind_author_index ON event(kind,author);
reindex;
pragma optimize;
PRAGMA user_version = 13;
"##;
match conn.execute_batch(upgrade_sql) {
Ok(()) => {
info!("database schema upgraded v12 -> v13");
}
Err(err) => {
error!("update (v12->v13) failed: {}", err);
panic!("database could not be upgraded");
}
}
Ok(13)
}
fn mig_13_to_14(conn: &mut PooledConnection) -> Result<usize> {
info!("database schema needs update from 13->14");
let upgrade_sql = r##"
CREATE INDEX IF NOT EXISTS kind_index ON event(kind);
CREATE INDEX IF NOT EXISTS kind_created_at_index ON event(kind,created_at);
pragma optimize;
PRAGMA user_version = 14;
"##;
match conn.execute_batch(upgrade_sql) {
Ok(()) => {
info!("database schema upgraded v13 -> v14");
}
Err(err) => {
error!("update (v13->v14) failed: {}", err);
panic!("database could not be upgraded");
}
}
Ok(14)
}
fn mig_14_to_15(conn: &mut PooledConnection) -> Result<usize> {
info!("database schema needs update from 14->15");
let upgrade_sql = r##"
CREATE INDEX IF NOT EXISTS author_created_at_index ON event(author,created_at);
CREATE INDEX IF NOT EXISTS author_kind_index ON event(author,kind);
PRAGMA user_version = 15;
"##;
match conn.execute_batch(upgrade_sql) {
Ok(()) => {
info!("database schema upgraded v14 -> v15");
}
Err(err) => {
error!("update (v14->v15) failed: {}", err);
panic!("database could not be upgraded");
}
}
// clear out hidden events
let clear_hidden_sql = r##"DELETE FROM event WHERE HIDDEN=true;"##;
info!("removing hidden events; this may take awhile...");
match conn.execute_batch(clear_hidden_sql) {
Ok(()) => {
info!("all hidden events removed");
}
Err(err) => {
error!("delete failed: {}", err);
panic!("could not remove hidden events");
}
}
Ok(15)
}
fn mig_15_to_16(conn: &mut PooledConnection) -> Result<usize> {
let count = db_event_count(conn)?;
info!("database schema needs update from 15->16 (this may take a few minutes)");
let upgrade_sql = r##"
DROP TABLE tag;
CREATE TABLE tag (
id INTEGER PRIMARY KEY,
event_id INTEGER NOT NULL, -- an event ID that contains a tag.
name TEXT, -- the tag name ("p", "e", whatever)
value TEXT, -- the tag value, if not hex.
created_at INTEGER NOT NULL, -- when the event was authored
kind INTEGER NOT NULL, -- event kind
FOREIGN KEY(event_id) REFERENCES event(id) ON UPDATE CASCADE ON DELETE CASCADE
);
CREATE INDEX IF NOT EXISTS tag_val_index ON tag(value);
CREATE INDEX IF NOT EXISTS tag_composite_index ON tag(event_id,name,value);
CREATE INDEX IF NOT EXISTS tag_name_eid_index ON tag(name,event_id,value);
CREATE INDEX IF NOT EXISTS tag_covering_index ON tag(name,kind,value,created_at,event_id);
"##;
let start = Instant::now();
let tx = conn.transaction()?;
let bar = ProgressBar::new(count.try_into().unwrap()).with_message("rebuilding tags table");
bar.set_style(
ProgressStyle::with_template(
"[{elapsed_precise}] {bar:40.white/blue} {pos:>7}/{len:7} [{percent}%] {msg}",
)
.unwrap(),
);
{
tx.execute_batch(upgrade_sql)?;
let mut stmt =
tx.prepare("select id, kind, created_at, content from event order by id;")?;
let mut tag_rows = stmt.query([])?;
let mut count = 0;
while let Some(row) = tag_rows.next()? {
count += 1;
if count % 10 == 0 {
bar.inc(10);
}
let event_id: u64 = row.get(0)?;
let kind: u64 = row.get(1)?;
let created_at: u64 = row.get(2)?;
let event_json: String = row.get(3)?;
let event: Event = serde_json::from_str(&event_json)?;
// look at each event, and each tag, creating new tag entries if appropriate.
for t in event.tags.iter().filter(|x| x.len() > 1) {
let tagname = t.first().unwrap();
let tagnamechar_opt = single_char_tagname(tagname);
if tagnamechar_opt.is_none() {
continue;
}
// safe because len was > 1
let tagval = t.get(1).unwrap();
// otherwise, insert as text
tx.execute(
"INSERT INTO tag (event_id, name, value, kind, created_at) VALUES (?1, ?2, ?3, ?4, ?5);",
params![event_id, tagname, &tagval, kind, created_at],
)?;
}
}
tx.execute("PRAGMA user_version = 16;", [])?;
}
bar.finish();
tx.commit()?;
info!(
"database schema upgraded v15 -> v16 in {:?}",
start.elapsed()
);
Ok(16)
}
fn mig_16_to_17(conn: &mut PooledConnection) -> Result<usize> {
info!("database schema needs update from 16->17");
let upgrade_sql = r##"
ALTER TABLE event ADD COLUMN expires_at INTEGER;
CREATE INDEX IF NOT EXISTS event_expiration ON event(expires_at);
PRAGMA user_version = 17;
"##;
match conn.execute_batch(upgrade_sql) {
Ok(()) => {
info!("database schema upgraded v16 -> v17");
}
Err(err) => {
error!("update (v16->v17) failed: {}", err);
panic!("database could not be upgraded");
}
}
Ok(17)
}
fn mig_17_to_18(conn: &mut PooledConnection) -> Result<usize> {
info!("database schema needs update from 17->18");
let upgrade_sql = r##"
-- Create invoices table
CREATE TABLE IF NOT EXISTS invoice (
payment_hash TEXT PRIMARY KEY,
pubkey TEXT NOT NULL,
invoice TEXT NOT NULL,
amount INTEGER NOT NULL,
status TEXT CHECK ( status IN ('Paid', 'Unpaid', 'Expired' ) ) NOT NUll DEFAULT 'Unpaid',
description TEXT,
created_at INTEGER NOT NULL,
confirmed_at INTEGER,
CONSTRAINT invoice_pubkey_fkey FOREIGN KEY (pubkey) REFERENCES account (pubkey) ON DELETE CASCADE
);
-- Create invoice index
CREATE INDEX IF NOT EXISTS invoice_pubkey_index ON invoice(pubkey);
-- Create account table
CREATE TABLE IF NOT EXISTS account (
pubkey TEXT PRIMARY KEY,
is_admitted INTEGER NOT NULL DEFAULT 0,
balance INTEGER NOT NULL DEFAULT 0,
tos_accepted_at INTEGER
);
-- Create account index
CREATE INDEX IF NOT EXISTS account_pubkey_index ON account(pubkey);
pragma optimize;
PRAGMA user_version = 18;
"##;
match conn.execute_batch(upgrade_sql) {
Ok(()) => {
info!("database schema upgraded v17 -> v18");
}
Err(err) => {
error!("update (v17->v18) failed: {}", err);
panic!("database could not be upgraded");
}
}
Ok(18)
}
fn mig_18_to_19(conn: &mut PooledConnection) -> Result<usize> {
info!("database schema needs update from 18->19");
let upgrade_sql = r##"
-- Name authority claims (Floonet). One row per claimed name; a release
-- sets released_at instead of deleting, and the partial unique index
-- enforces one ACTIVE name per pubkey at the database layer.
CREATE TABLE IF NOT EXISTS name_claims (
name TEXT PRIMARY KEY,
pubkey TEXT NOT NULL,
created_at INTEGER NOT NULL,
released_at INTEGER
);
CREATE INDEX IF NOT EXISTS name_claims_pubkey_index ON name_claims(pubkey);
CREATE UNIQUE INDEX IF NOT EXISTS name_claims_active_pubkey
ON name_claims(pubkey) WHERE released_at IS NULL;
PRAGMA user_version = 19;
"##;
match conn.execute_batch(upgrade_sql) {
Ok(()) => {
info!("database schema upgraded v18 -> v19");
}
Err(err) => {
error!("update (v18->v19) failed: {}", err);
panic!("database could not be upgraded");
}
}
Ok(19)
}
src/server.rs
+1671
View File
File diff suppressed because it is too large Load Diff
src/subscription.rs
+703
View File
@@ -0,0 +1,703 @@
//! Subscription and filter parsing
use crate::error::Result;
use crate::event::Event;
use serde::de::Unexpected;
use serde::ser::SerializeMap;
use serde::{Deserialize, Deserializer, Serialize, Serializer};
use serde_json::Value;
use std::collections::HashMap;
use std::collections::HashSet;
use std::ops::Deref;
/// Subscription identifier and set of request filters
#[derive(Serialize, PartialEq, Eq, Debug, Clone)]
pub struct Subscription {
pub id: String,
pub filters: Vec<ReqFilter>,
}
/// Tag query is AND or OR operation
#[derive(Serialize, PartialEq, Eq, Debug, Clone)]
pub enum TagOperand {
And(HashSet<String>),
Or(HashSet<String>),
}
impl Deref for TagOperand {
type Target = HashSet<String>;
fn deref(&self) -> &Self::Target {
match self {
TagOperand::Or(v) => v,
TagOperand::And(v) => v,
}
}
}
/// Filter for requests
///
/// Corresponds to client-provided subscription request elements. Any
/// element can be present if it should be used in filtering, or
/// absent ([`None`]) if it should be ignored.
#[derive(PartialEq, Eq, Debug, Clone)]
pub struct ReqFilter {
/// Event hashes
pub ids: Option<Vec<String>>,
/// Event kinds
pub kinds: Option<Vec<u64>>,
/// Events published after this time
pub since: Option<u64>,
/// Events published before this time
pub until: Option<u64>,
/// List of author public keys
pub authors: Option<Vec<String>>,
/// Limit number of results
pub limit: Option<u64>,
/// Set of tags
pub tags: Option<HashMap<char, TagOperand>>,
/// Force no matches due to malformed data
// we can't represent it in the req filter, so we don't want to
// erroneously match. This basically indicates the req tried to
// do something invalid.
pub force_no_match: bool,
}
impl Serialize for ReqFilter {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
let mut map = serializer.serialize_map(None)?;
if let Some(ids) = &self.ids {
map.serialize_entry("ids", &ids)?;
}
if let Some(kinds) = &self.kinds {
map.serialize_entry("kinds", &kinds)?;
}
if let Some(until) = &self.until {
map.serialize_entry("until", until)?;
}
if let Some(since) = &self.since {
map.serialize_entry("since", since)?;
}
if let Some(limit) = &self.limit {
map.serialize_entry("limit", limit)?;
}
if let Some(authors) = &self.authors {
map.serialize_entry("authors", &authors)?;
}
// serialize tags
if let Some(tags) = &self.tags {
for (k, v) in tags {
map.serialize_entry(&format!("#{k}"), v)?;
}
}
map.end()
}
}
impl<'de> Deserialize<'de> for ReqFilter {
fn deserialize<D>(deserializer: D) -> Result<ReqFilter, D::Error>
where
D: Deserializer<'de>,
{
let received: Value = Deserialize::deserialize(deserializer)?;
let filter = received.as_object().ok_or_else(|| {
serde::de::Error::invalid_type(
Unexpected::Other("reqfilter is not an object"),
&"a json object",
)
})?;
let mut rf = ReqFilter {
ids: None,
kinds: None,
since: None,
until: None,
authors: None,
limit: None,
tags: None,
force_no_match: false,
};
let empty_string = "".into();
let mut ts: Option<HashMap<char, TagOperand>> = None;
// iterate through each key, and assign values that exist
for (key, val) in filter {
// ids
if key == "ids" {
let raw_ids: Option<Vec<String>> = Deserialize::deserialize(val).ok();
if let Some(a) = raw_ids.as_ref() {
if a.contains(&empty_string) {
return Err(serde::de::Error::invalid_type(
Unexpected::Other("prefix matches must not be empty strings"),
&"a json object",
));
}
}
rf.ids = raw_ids;
} else if key == "kinds" {
rf.kinds = Deserialize::deserialize(val).ok();
} else if key == "since" {
rf.since = Deserialize::deserialize(val).ok();
} else if key == "until" {
rf.until = Deserialize::deserialize(val).ok();
} else if key == "limit" {
rf.limit = Deserialize::deserialize(val).ok();
} else if key == "authors" {
let raw_authors: Option<Vec<String>> = Deserialize::deserialize(val).ok();
if let Some(a) = raw_authors.as_ref() {
if a.contains(&empty_string) {
return Err(serde::de::Error::invalid_type(
Unexpected::Other("prefix matches must not be empty strings"),
&"a json object",
));
}
}
rf.authors = raw_authors;
} else if key.starts_with('#') && key.len() > 1 && key.len() < 4 && val.is_array() {
if ts.is_none() {
// Initialize the tag if necessary
ts = Some(HashMap::new());
}
if let Some(m) = ts.as_mut() {
let tag_vals: Option<Vec<String>> = Deserialize::deserialize(val).ok();
if let Some(v) = tag_vals {
let hs = v.into_iter().collect::<HashSet<_>>();
let hs_op = match key.len() {
2 => Some(TagOperand::Or(hs)),
3 => {
if key.chars().nth(2).unwrap() == '&' {
Some(TagOperand::And(hs))
} else {
None
}
}
_ => None,
};
if let Some(hs_some) = hs_op {
m.insert(key.chars().nth(1).unwrap(), hs_some);
}
}
};
}
}
rf.tags = ts;
Ok(rf)
}
}
impl<'de> Deserialize<'de> for Subscription {
/// Custom deserializer for subscriptions, which have a more
/// complex structure than the other message types.
fn deserialize<D>(deserializer: D) -> Result<Subscription, D::Error>
where
D: Deserializer<'de>,
{
let mut v: Value = Deserialize::deserialize(deserializer)?;
// this should be a 3-or-more element array.
// verify the first element is a String, REQ
// get the subscription from the second element.
// convert each of the remaining objects into filters
// check for array
let va = v
.as_array_mut()
.ok_or_else(|| serde::de::Error::custom("not array"))?;
// check length
if va.len() < 3 {
return Err(serde::de::Error::custom("not enough fields"));
}
let mut i = va.iter_mut();
// get command ("REQ") and ensure it is a string
let req_cmd_str: serde_json::Value = i.next().unwrap().take();
let req = req_cmd_str
.as_str()
.ok_or_else(|| serde::de::Error::custom("first element of request was not a string"))?;
if req != "REQ" {
return Err(serde::de::Error::custom("missing REQ command"));
}
// ensure sub id is a string
let sub_id_str: serde_json::Value = i.next().unwrap().take();
let sub_id = sub_id_str
.as_str()
.ok_or_else(|| serde::de::Error::custom("missing subscription id"))?;
let mut filters = vec![];
for fv in i {
let f: ReqFilter = serde_json::from_value(fv.take())
.map_err(|_| serde::de::Error::custom("could not parse filter"))?;
// create indexes
filters.push(f);
}
filters.dedup();
Ok(Subscription {
id: sub_id.to_owned(),
filters,
})
}
}
impl Subscription {
/// Get a copy of the subscription identifier.
#[must_use]
pub fn get_id(&self) -> String {
self.id.clone()
}
/// Determine if any filter is requesting historical (database)
/// queries. If every filter has limit:0, we do not need to query the DB.
#[must_use]
pub fn needs_historical_events(&self) -> bool {
self.filters.iter().any(|f| f.limit != Some(0))
}
/// Determine if this subscription matches a given [`Event`]. Any
/// individual filter match is sufficient.
#[must_use]
pub fn interested_in_event(&self, event: &Event) -> bool {
for f in &self.filters {
if f.interested_in_event(event) {
return true;
}
}
false
}
/// Is this subscription defined as a scraper query
pub fn is_scraper(&self) -> bool {
for f in &self.filters {
let mut precision = 0;
if f.ids.is_some() {
precision += 2;
}
if f.authors.is_some() {
precision += 1;
}
if f.kinds.is_some() {
precision += 1;
}
if f.tags.is_some() {
precision += 1;
}
if precision < 2 {
return true;
}
}
false
}
}
fn prefix_match(prefixes: &[String], target: &str) -> bool {
for prefix in prefixes {
if target.starts_with(prefix) {
return true;
}
}
// none matched
false
}
impl ReqFilter {
fn ids_match(&self, event: &Event) -> bool {
self.ids
.as_ref()
.map_or(true, |vs| prefix_match(vs, &event.id))
}
fn authors_match(&self, event: &Event) -> bool {
self.authors
.as_ref()
.map_or(true, |vs| prefix_match(vs, &event.pubkey))
}
fn delegated_authors_match(&self, event: &Event) -> bool {
if let Some(delegated_pubkey) = &event.delegated_by {
self.authors
.as_ref()
.map_or(true, |vs| prefix_match(vs, delegated_pubkey))
} else {
false
}
}
fn tag_match(&self, event: &Event) -> bool {
// get the hashset from the filter.
if let Some(map) = &self.tags {
for (key, val) in map.iter() {
let tag_match = event.generic_tag_val_intersect(*key, val);
// if there is no match for this tag, the match fails.
if !tag_match {
return false;
}
// if there was a match, we move on to the next one.
}
}
// if the tag map is empty, the match succeeds (there was no filter)
true
}
/// Check if this filter either matches, or does not care about the kind.
fn kind_match(&self, kind: u64) -> bool {
self.kinds.as_ref().map_or(true, |ks| ks.contains(&kind))
}
/// Determine if all populated fields in this filter match the provided event.
#[must_use]
pub fn interested_in_event(&self, event: &Event) -> bool {
// self.id.as_ref().map(|v| v == &event.id).unwrap_or(true)
self.ids_match(event)
&& self.since.map_or(true, |t| event.created_at >= t)
&& self.until.map_or(true, |t| event.created_at <= t)
&& self.kind_match(event.kind)
&& (self.authors_match(event) || self.delegated_authors_match(event))
&& self.tag_match(event)
&& !self.force_no_match
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn empty_request_parse() -> Result<()> {
let raw_json = "[\"REQ\",\"some-id\",{}]";
let s: Subscription = serde_json::from_str(raw_json)?;
assert_eq!(s.id, "some-id");
assert_eq!(s.filters.len(), 1);
assert_eq!(s.filters.first().unwrap().authors, None);
Ok(())
}
#[test]
fn incorrect_header() {
let raw_json = "[\"REQUEST\",\"some-id\",\"{}\"]";
assert!(serde_json::from_str::<Subscription>(raw_json).is_err());
}
#[test]
fn req_missing_filters() {
let raw_json = "[\"REQ\",\"some-id\"]";
assert!(serde_json::from_str::<Subscription>(raw_json).is_err());
}
#[test]
fn req_empty_authors_prefix() {
let raw_json = "[\"REQ\",\"some-id\",{\"authors\": [\"\"]}]";
assert!(serde_json::from_str::<Subscription>(raw_json).is_err());
}
#[test]
fn req_empty_ids_prefix() {
let raw_json = "[\"REQ\",\"some-id\",{\"ids\": [\"\"]}]";
assert!(serde_json::from_str::<Subscription>(raw_json).is_err());
}
#[test]
fn req_empty_ids_prefix_mixed() {
let raw_json = "[\"REQ\",\"some-id\",{\"ids\": [\"\",\"aaa\"]}]";
assert!(serde_json::from_str::<Subscription>(raw_json).is_err());
}
#[test]
fn legacy_filter() {
// legacy field in filter
let raw_json = "[\"REQ\",\"some-id\",{\"kind\": 3}]";
assert!(serde_json::from_str::<Subscription>(raw_json).is_ok());
}
#[test]
fn dupe_filter() -> Result<()> {
let raw_json = r#"["REQ","some-id",{"kinds": [1984]}, {"kinds": [1984]}]"#;
let s: Subscription = serde_json::from_str(raw_json)?;
assert_eq!(s.filters.len(), 1);
Ok(())
}
#[test]
fn dupe_filter_many() -> Result<()> {
// duplicate filters in different order
let raw_json = r#"["REQ","some-id",{"kinds":[1984]},{"kinds":[1984]},{"kinds":[1984]},{"kinds":[1984]}]"#;
let s: Subscription = serde_json::from_str(raw_json)?;
assert_eq!(s.filters.len(), 1);
Ok(())
}
#[test]
fn author_filter() -> Result<()> {
let raw_json = r#"["REQ","some-id",{"authors": ["test-author-id"]}]"#;
let s: Subscription = serde_json::from_str(raw_json)?;
assert_eq!(s.id, "some-id");
assert_eq!(s.filters.len(), 1);
let first_filter = s.filters.first().unwrap();
assert_eq!(
first_filter.authors,
Some(vec!("test-author-id".to_owned()))
);
Ok(())
}
#[test]
fn interest_author_prefix_match() -> Result<()> {
// subscription with a filter for ID
let s: Subscription = serde_json::from_str(r#"["REQ","xyz",{"authors": ["abc"]}]"#)?;
let e = Event {
id: "foo".to_owned(),
pubkey: "abcd".to_owned(),
delegated_by: None,
created_at: 0,
kind: 0,
tags: Vec::new(),
content: "".to_owned(),
sig: "".to_owned(),
tagidx: None,
};
assert!(s.interested_in_event(&e));
Ok(())
}
#[test]
fn interest_id_prefix_match() -> Result<()> {
// subscription with a filter for ID
let s: Subscription = serde_json::from_str(r#"["REQ","xyz",{"ids": ["abc"]}]"#)?;
let e = Event {
id: "abcd".to_owned(),
pubkey: "".to_owned(),
delegated_by: None,
created_at: 0,
kind: 0,
tags: Vec::new(),
content: "".to_owned(),
sig: "".to_owned(),
tagidx: None,
};
assert!(s.interested_in_event(&e));
Ok(())
}
#[test]
fn interest_id_nomatch() -> Result<()> {
// subscription with a filter for ID
let s: Subscription = serde_json::from_str(r#"["REQ","xyz",{"ids": ["xyz"]}]"#)?;
let e = Event {
id: "abcde".to_owned(),
pubkey: "".to_owned(),
delegated_by: None,
created_at: 0,
kind: 0,
tags: Vec::new(),
content: "".to_owned(),
sig: "".to_owned(),
tagidx: None,
};
assert!(!s.interested_in_event(&e));
Ok(())
}
#[test]
fn interest_until() -> Result<()> {
// subscription with a filter for ID and time
let s: Subscription =
serde_json::from_str(r#"["REQ","xyz",{"ids": ["abc"], "until": 1000}]"#)?;
let e = Event {
id: "abc".to_owned(),
pubkey: "".to_owned(),
delegated_by: None,
created_at: 50,
kind: 0,
tags: Vec::new(),
content: "".to_owned(),
sig: "".to_owned(),
tagidx: None,
};
assert!(s.interested_in_event(&e));
Ok(())
}
#[test]
fn interest_range() -> Result<()> {
// subscription with a filter for ID and time
let s_in: Subscription =
serde_json::from_str(r#"["REQ","xyz",{"ids": ["abc"], "since": 100, "until": 200}]"#)?;
let s_before: Subscription =
serde_json::from_str(r#"["REQ","xyz",{"ids": ["abc"], "since": 100, "until": 140}]"#)?;
let s_after: Subscription =
serde_json::from_str(r#"["REQ","xyz",{"ids": ["abc"], "since": 160, "until": 200}]"#)?;
let e = Event {
id: "abc".to_owned(),
pubkey: "".to_owned(),
delegated_by: None,
created_at: 150,
kind: 0,
tags: Vec::new(),
content: "".to_owned(),
sig: "".to_owned(),
tagidx: None,
};
assert!(s_in.interested_in_event(&e));
assert!(!s_before.interested_in_event(&e));
assert!(!s_after.interested_in_event(&e));
Ok(())
}
#[test]
fn interest_time_and_id() -> Result<()> {
// subscription with a filter for ID and time
let s: Subscription =
serde_json::from_str(r#"["REQ","xyz",{"ids": ["abc"], "since": 1000}]"#)?;
let e = Event {
id: "abc".to_owned(),
pubkey: "".to_owned(),
delegated_by: None,
created_at: 50,
kind: 0,
tags: Vec::new(),
content: "".to_owned(),
sig: "".to_owned(),
tagidx: None,
};
assert!(!s.interested_in_event(&e));
Ok(())
}
#[test]
fn interest_time_and_id2() -> Result<()> {
// subscription with a filter for ID and time
let s: Subscription = serde_json::from_str(r#"["REQ","xyz",{"id":"abc", "since": 1000}]"#)?;
let e = Event {
id: "abc".to_owned(),
pubkey: "".to_owned(),
delegated_by: None,
created_at: 1001,
kind: 0,
tags: Vec::new(),
content: "".to_owned(),
sig: "".to_owned(),
tagidx: None,
};
assert!(s.interested_in_event(&e));
Ok(())
}
#[test]
fn interest_id() -> Result<()> {
// subscription with a filter for ID
let s: Subscription = serde_json::from_str(r#"["REQ","xyz",{"id":"abc"}]"#)?;
let e = Event {
id: "abc".to_owned(),
pubkey: "".to_owned(),
delegated_by: None,
created_at: 0,
kind: 0,
tags: Vec::new(),
content: "".to_owned(),
sig: "".to_owned(),
tagidx: None,
};
assert!(s.interested_in_event(&e));
Ok(())
}
#[test]
fn authors_single() -> Result<()> {
// subscription with a filter for ID
let s: Subscription = serde_json::from_str(r#"["REQ","xyz",{"authors":["abc"]}]"#)?;
let e = Event {
id: "123".to_owned(),
pubkey: "abc".to_owned(),
delegated_by: None,
created_at: 0,
kind: 0,
tags: Vec::new(),
content: "".to_owned(),
sig: "".to_owned(),
tagidx: None,
};
assert!(s.interested_in_event(&e));
Ok(())
}
#[test]
fn authors_multi_pubkey() -> Result<()> {
// check for any of a set of authors, against the pubkey
let s: Subscription = serde_json::from_str(r#"["REQ","xyz",{"authors":["abc", "bcd"]}]"#)?;
let e = Event {
id: "123".to_owned(),
pubkey: "bcd".to_owned(),
delegated_by: None,
created_at: 0,
kind: 0,
tags: Vec::new(),
content: "".to_owned(),
sig: "".to_owned(),
tagidx: None,
};
assert!(s.interested_in_event(&e));
Ok(())
}
#[test]
fn authors_multi_no_match() -> Result<()> {
// check for any of a set of authors, against the pubkey
let s: Subscription = serde_json::from_str(r#"["REQ","xyz",{"authors":["abc", "bcd"]}]"#)?;
let e = Event {
id: "123".to_owned(),
pubkey: "xyz".to_owned(),
delegated_by: None,
created_at: 0,
kind: 0,
tags: Vec::new(),
content: "".to_owned(),
sig: "".to_owned(),
tagidx: None,
};
assert!(!s.interested_in_event(&e));
Ok(())
}
#[test]
fn serialize_filter() -> Result<()> {
let s: Subscription = serde_json::from_str(
r##"["REQ","xyz",{"authors":["abc", "bcd"], "since": 10, "until": 20, "limit":100, "#e": ["foo", "bar"], "#d": ["test"]}]"##,
)?;
let f = s.filters.first();
let serialized = serde_json::to_string(&f)?;
let serialized_wrapped = format!(r##"["REQ", "xyz",{}]"##, serialized);
let parsed: Subscription = serde_json::from_str(&serialized_wrapped)?;
let parsed_filter = parsed.filters.first();
if let Some(pf) = parsed_filter {
assert_eq!(pf.since, Some(10));
assert_eq!(pf.until, Some(20));
assert_eq!(pf.limit, Some(100));
} else {
assert!(false, "filter could not be parsed");
}
Ok(())
}
#[test]
fn is_scraper() -> Result<()> {
assert!(serde_json::from_str::<Subscription>(
r#"["REQ","some-id",{"kinds": [1984],"since": 123,"limit":1}]"#
)?
.is_scraper());
assert!(serde_json::from_str::<Subscription>(
r#"["REQ","some-id",{"kinds": [1984]},{"kinds": [1984],"authors":["aaaa"]}]"#
)?
.is_scraper());
assert!(!serde_json::from_str::<Subscription>(
r#"["REQ","some-id",{"kinds": [1984],"authors":["aaaa"]}]"#
)?
.is_scraper());
assert!(
!serde_json::from_str::<Subscription>(r#"["REQ","some-id",{"ids": ["aaaa"]}]"#)?
.is_scraper()
);
assert!(!serde_json::from_str::<Subscription>(
r##"["REQ","some-id",{"#p": ["aaaa"],"kinds":[1,4]}]"##
)?
.is_scraper());
Ok(())
}
}
src/utils.rs
+72
View File
@@ -0,0 +1,72 @@
//! Common utility functions
use bech32::FromBase32;
use std::time::SystemTime;
use url::Url;
/// Seconds since 1970.
#[must_use]
pub fn unix_time() -> u64 {
SystemTime::now()
.duration_since(SystemTime::UNIX_EPOCH)
.map(|x| x.as_secs())
.unwrap_or(0)
}
/// Check if a string contains only hex characters.
#[must_use]
pub fn is_hex(s: &str) -> bool {
s.chars().all(|x| char::is_ascii_hexdigit(&x))
}
/// Check if string is a nip19 string
pub fn is_nip19(s: &str) -> bool {
s.starts_with("npub") || s.starts_with("note")
}
pub fn nip19_to_hex(s: &str) -> Result<String, bech32::Error> {
let (_hrp, data, _checksum) = bech32::decode(s)?;
let data = Vec::<u8>::from_base32(&data)?;
Ok(hex::encode(data))
}
/// Check if a string contains only lower-case hex chars.
#[must_use]
pub fn is_lower_hex(s: &str) -> bool {
s.chars().all(|x| {
(char::is_ascii_lowercase(&x) || char::is_ascii_digit(&x)) && char::is_ascii_hexdigit(&x)
})
}
pub fn host_str(url: &str) -> Option<String> {
Url::parse(url)
.ok()
.and_then(|u| u.host_str().map(|s| s.to_string()))
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn lower_hex() {
let hexstr = "abcd0123";
assert!(is_lower_hex(hexstr));
}
#[test]
fn nip19() {
let hexkey = "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d";
let nip19key = "npub180cvv07tjdrrgpa0j7j7tmnyl2yr6yr7l8j4s3evf6u64th6gkwsyjh6w6";
assert!(!is_nip19(hexkey));
assert!(is_nip19(nip19key));
}
#[test]
fn nip19_hex() {
let nip19key = "npub180cvv07tjdrrgpa0j7j7tmnyl2yr6yr7l8j4s3evf6u64th6gkwsyjh6w6";
let expected = "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d";
let got = nip19_to_hex(nip19key).unwrap();
assert_eq!(expected, got);
}
}
tests/cli.rs
+10
View File
@@ -0,0 +1,10 @@
#[cfg(test)]
mod tests {
use floonet_rs::cli::CLIArgs;
#[test]
fn cli_tests() {
use clap::CommandFactory;
CLIArgs::command().debug_assert();
}
}
tests/common/mod.rs
+115
View File
@@ -0,0 +1,115 @@
use anyhow::{anyhow, Result};
use floonet_rs::config;
use floonet_rs::server::start_server;
//use http::{Request, Response};
use hyper::{Client, StatusCode, Uri};
use std::net::TcpListener;
use std::sync::atomic::{AtomicU16, Ordering};
use std::sync::mpsc as syncmpsc;
use std::sync::mpsc::{Receiver as MpscReceiver, Sender as MpscSender};
use std::thread;
use std::thread::JoinHandle;
use std::time::Duration;
use tracing::{debug, info};
pub struct Relay {
pub port: u16,
pub handle: JoinHandle<()>,
pub shutdown_tx: MpscSender<()>,
}
pub fn start_relay() -> Result<Relay> {
start_relay_with(|_| {})
}
/// Start a relay, letting the caller adjust settings after the defaults
/// (port and loopback bind are already set; the closure may read
/// `settings.network.port`).
pub fn start_relay_with(configure: impl FnOnce(&mut config::Settings)) -> Result<Relay> {
// setup tracing
let _trace_sub = tracing_subscriber::fmt::try_init();
info!("Starting a new relay");
// replace default settings
let mut settings = config::Settings::default();
// identify open port
info!("Checking for address...");
let port = get_available_port().unwrap();
info!("Found open port: {}", port);
// bind to local interface only
settings.network.address = "127.0.0.1".to_owned();
settings.network.port = port;
// create an in-memory DB with multiple readers
settings.database.in_memory = true;
settings.database.min_conn = 4;
settings.database.max_conn = 8;
configure(&mut settings);
let (shutdown_tx, shutdown_rx): (MpscSender<()>, MpscReceiver<()>) = syncmpsc::channel();
let handle = thread::spawn(move || {
// server will block the thread it is run on.
let _ = start_server(&settings, shutdown_rx);
});
// how do we know the relay has finished starting up?
Ok(Relay {
port,
handle,
shutdown_tx,
})
}
// check if the server is healthy via HTTP request
async fn server_ready(relay: &Relay) -> Result<bool> {
let uri: String = format!("http://127.0.0.1:{}/", relay.port);
let client = Client::new();
let uri: Uri = uri.parse().unwrap();
let res = client.get(uri).await?;
Ok(res.status() == StatusCode::OK)
}
pub async fn wait_for_healthy_relay(relay: &Relay) -> Result<()> {
// TODO: maximum time to wait for server to become healthy.
// give it a little time to start up before we start polling
tokio::time::sleep(Duration::from_millis(10)).await;
loop {
let server_check = server_ready(relay).await;
match server_check {
Ok(true) => {
// server responded with 200-OK.
break;
}
Ok(false) => {
// server responded with an error, we're done.
return Err(anyhow!("Got non-200-OK from relay"));
}
Err(_) => {
// server is not yet ready, probably connection refused...
debug!("Relay not ready, will try again...");
tokio::time::sleep(Duration::from_millis(10)).await;
}
}
}
info!("relay is ready");
Ok(())
// simple message sent to web browsers
//let mut request = Request::builder()
// .uri("https://www.rust-lang.org/")
// .header("User-Agent", "my-awesome-agent/1.0");
}
// from https://elliotekj.com/posts/2017/07/25/find-available-tcp-port-rust/
// This needed some modification; if multiple tasks all ask for open ports, they will tend to get the same one.
// instead we should try to try these incrementally/globally.
static PORT_COUNTER: AtomicU16 = AtomicU16::new(4030);
fn get_available_port() -> Option<u16> {
let startsearch = PORT_COUNTER.fetch_add(10, Ordering::SeqCst);
if startsearch >= 20000 {
// wrap around
PORT_COUNTER.store(4030, Ordering::Relaxed);
}
(startsearch..20000).find(|port| port_is_available(*port))
}
pub fn port_is_available(port: u16) -> bool {
info!("checking on port {}", port);
TcpListener::bind(("127.0.0.1", port)).is_ok()
}
tests/conn.rs
+356
View File
@@ -0,0 +1,356 @@
#[cfg(test)]
mod tests {
use bitcoin_hashes::hex::ToHex;
use bitcoin_hashes::sha256;
use bitcoin_hashes::Hash;
use secp256k1::rand;
use secp256k1::{KeyPair, Secp256k1, XOnlyPublicKey};
use floonet_rs::conn::ClientConn;
use floonet_rs::error::Error;
use floonet_rs::event::Event;
use floonet_rs::utils::unix_time;
const RELAY: &str = "wss://nostr.example.com/";
#[test]
fn test_generate_auth_challenge() {
let mut client_conn = ClientConn::new("127.0.0.1".into());
assert_eq!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
client_conn.generate_auth_challenge();
assert_ne!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
let last_auth_challenge = client_conn.auth_challenge().cloned();
client_conn.generate_auth_challenge();
assert_ne!(client_conn.auth_challenge(), None);
assert_ne!(
client_conn.auth_challenge().unwrap(),
&last_auth_challenge.unwrap()
);
assert_eq!(client_conn.auth_pubkey(), None);
}
#[test]
fn test_authenticate_with_valid_event() {
let mut client_conn = ClientConn::new("127.0.0.1".into());
assert_eq!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
client_conn.generate_auth_challenge();
assert_ne!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
let challenge = client_conn.auth_challenge().unwrap();
let event = auth_event(challenge);
let result = client_conn.authenticate(&event, RELAY);
assert!(matches!(result, Ok(())));
assert_eq!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), Some(&event.pubkey));
}
#[test]
fn test_fail_to_authenticate_in_invalid_state() {
let mut client_conn = ClientConn::new("127.0.0.1".into());
assert_eq!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
let event = auth_event(&"challenge".into());
let result = client_conn.authenticate(&event, RELAY);
assert!(matches!(result, Err(Error::AuthFailure)));
}
#[test]
fn test_authenticate_when_already_authenticated() {
let mut client_conn = ClientConn::new("127.0.0.1".into());
assert_eq!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
client_conn.generate_auth_challenge();
assert_ne!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
let challenge = client_conn.auth_challenge().unwrap().clone();
let event = auth_event(&challenge);
let result = client_conn.authenticate(&event, RELAY);
assert!(matches!(result, Ok(())));
assert_eq!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), Some(&event.pubkey));
let event1 = auth_event(&challenge);
let result1 = client_conn.authenticate(&event1, RELAY);
assert!(matches!(result1, Ok(())));
assert_eq!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), Some(&event.pubkey));
assert_ne!(client_conn.auth_pubkey(), Some(&event1.pubkey));
}
#[test]
fn test_fail_to_authenticate_with_invalid_event() {
let mut client_conn = ClientConn::new("127.0.0.1".into());
assert_eq!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
client_conn.generate_auth_challenge();
assert_ne!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
let challenge = client_conn.auth_challenge().unwrap();
let mut event = auth_event(challenge);
event.sig = event.sig.chars().rev().collect::<String>();
let result = client_conn.authenticate(&event, RELAY);
assert!(matches!(result, Err(Error::AuthFailure)));
}
#[test]
fn test_fail_to_authenticate_with_invalid_event_kind() {
let mut client_conn = ClientConn::new("127.0.0.1".into());
assert_eq!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
client_conn.generate_auth_challenge();
assert_ne!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
let challenge = client_conn.auth_challenge().unwrap();
let event = auth_event_with_kind(challenge, 9999999999999999);
let result = client_conn.authenticate(&event, RELAY);
assert!(matches!(result, Err(Error::AuthFailure)));
}
#[test]
fn test_fail_to_authenticate_with_expired_timestamp() {
let mut client_conn = ClientConn::new("127.0.0.1".into());
assert_eq!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
client_conn.generate_auth_challenge();
assert_ne!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
let challenge = client_conn.auth_challenge().unwrap();
let event = auth_event_with_created_at(challenge, unix_time() - 1200); // 20 minutes
let result = client_conn.authenticate(&event, RELAY);
assert!(matches!(result, Err(Error::AuthFailure)));
}
#[test]
fn test_fail_to_authenticate_with_future_timestamp() {
let mut client_conn = ClientConn::new("127.0.0.1".into());
assert_eq!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
client_conn.generate_auth_challenge();
assert_ne!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
let challenge = client_conn.auth_challenge().unwrap();
let event = auth_event_with_created_at(challenge, unix_time() + 1200); // 20 minutes
let result = client_conn.authenticate(&event, RELAY);
assert!(matches!(result, Err(Error::AuthFailure)));
}
#[test]
fn test_fail_to_authenticate_without_tags() {
let mut client_conn = ClientConn::new("127.0.0.1".into());
assert_eq!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
client_conn.generate_auth_challenge();
assert_ne!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
let event = auth_event_without_tags();
let result = client_conn.authenticate(&event, RELAY);
assert!(matches!(result, Err(Error::AuthFailure)));
}
#[test]
fn test_fail_to_authenticate_without_challenge() {
let mut client_conn = ClientConn::new("127.0.0.1".into());
assert_eq!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
client_conn.generate_auth_challenge();
assert_ne!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
let event = auth_event_without_challenge();
let result = client_conn.authenticate(&event, RELAY);
assert!(matches!(result, Err(Error::AuthFailure)));
}
#[test]
fn test_fail_to_authenticate_without_relay() {
let mut client_conn = ClientConn::new("127.0.0.1".into());
assert_eq!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
client_conn.generate_auth_challenge();
assert_ne!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
let challenge = client_conn.auth_challenge().unwrap();
let event = auth_event_without_relay(challenge);
let result = client_conn.authenticate(&event, RELAY);
assert!(matches!(result, Err(Error::AuthFailure)));
}
#[test]
fn test_fail_to_authenticate_with_invalid_challenge() {
let mut client_conn = ClientConn::new("127.0.0.1".into());
assert_eq!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
client_conn.generate_auth_challenge();
assert_ne!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
let event = auth_event(&"invalid challenge".into());
let result = client_conn.authenticate(&event, RELAY);
assert!(matches!(result, Err(Error::AuthFailure)));
}
#[test]
fn test_fail_to_authenticate_with_invalid_relay() {
let mut client_conn = ClientConn::new("127.0.0.1".into());
assert_eq!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
client_conn.generate_auth_challenge();
assert_ne!(client_conn.auth_challenge(), None);
assert_eq!(client_conn.auth_pubkey(), None);
let challenge = client_conn.auth_challenge().unwrap();
let event = auth_event_with_relay(challenge, &"xyz".into());
let result = client_conn.authenticate(&event, RELAY);
assert!(matches!(result, Err(Error::AuthFailure)));
}
fn auth_event(challenge: &String) -> Event {
create_auth_event(Some(challenge), Some(&RELAY.into()), 22242, unix_time())
}
fn auth_event_with_kind(challenge: &String, kind: u64) -> Event {
create_auth_event(Some(challenge), Some(&RELAY.into()), kind, unix_time())
}
fn auth_event_with_created_at(challenge: &String, created_at: u64) -> Event {
create_auth_event(Some(challenge), Some(&RELAY.into()), 22242, created_at)
}
fn auth_event_without_challenge() -> Event {
create_auth_event(None, Some(&RELAY.into()), 22242, unix_time())
}
fn auth_event_without_relay(challenge: &String) -> Event {
create_auth_event(Some(challenge), None, 22242, unix_time())
}
fn auth_event_without_tags() -> Event {
create_auth_event(None, None, 22242, unix_time())
}
fn auth_event_with_relay(challenge: &String, relay: &String) -> Event {
create_auth_event(Some(challenge), Some(relay), 22242, unix_time())
}
fn create_auth_event(
challenge: Option<&String>,
relay: Option<&String>,
kind: u64,
created_at: u64,
) -> Event {
let secp = Secp256k1::new();
let key_pair = KeyPair::new(&secp, &mut rand::thread_rng());
let public_key = XOnlyPublicKey::from_keypair(&key_pair);
let mut tags: Vec<Vec<String>> = vec![];
if let Some(c) = challenge {
let tag = vec!["challenge".into(), c.into()];
tags.push(tag);
}
if let Some(r) = relay {
let tag = vec!["relay".into(), r.into()];
tags.push(tag);
}
let mut event = Event {
id: "0".to_owned(),
pubkey: public_key.to_hex(),
delegated_by: None,
created_at,
kind,
tags,
content: "".to_owned(),
sig: "0".to_owned(),
tagidx: None,
};
let c = event.to_canonical().unwrap();
let digest: sha256::Hash = sha256::Hash::hash(c.as_bytes());
let msg = secp256k1::Message::from_slice(digest.as_ref()).unwrap();
let sig = secp.sign_schnorr(&msg, &key_pair);
event.id = format!("{digest:x}");
event.sig = sig.to_hex();
event
}
}
tests/integration_test.rs
+80
View File
@@ -0,0 +1,80 @@
use anyhow::Result;
use futures::SinkExt;
use futures::StreamExt;
use std::thread;
use std::time::Duration;
use tokio_tungstenite::connect_async;
use tracing::info;
mod common;
#[tokio::test]
async fn start_and_stop() -> Result<()> {
// this will be the common pattern for acquiring a new relay:
// start a fresh relay, on a port to-be-provided back to us:
let relay = common::start_relay()?;
// wait for the relay's webserver to start up and deliver a page:
common::wait_for_healthy_relay(&relay).await?;
let port = relay.port;
// just make sure we can startup and shut down.
// if we send a shutdown message before the server is listening,
// we will get a SendError. Keep sending until someone is
// listening.
loop {
let shutdown_res = relay.shutdown_tx.send(());
match shutdown_res {
Ok(()) => {
break;
}
Err(_) => {
thread::sleep(Duration::from_millis(100));
}
}
}
// wait for relay to shutdown
let thread_join = relay.handle.join();
assert!(thread_join.is_ok());
// assert that port is now available.
assert!(common::port_is_available(port));
Ok(())
}
#[tokio::test]
async fn relay_home_page() -> Result<()> {
// get a relay and wait for startup...
let relay = common::start_relay()?;
common::wait_for_healthy_relay(&relay).await?;
// tell relay to shutdown
let _res = relay.shutdown_tx.send(());
Ok(())
}
//#[tokio::test]
// Still inwork
#[allow(dead_code)]
async fn publish_test() -> Result<()> {
// get a relay and wait for startup
let relay = common::start_relay()?;
common::wait_for_healthy_relay(&relay).await?;
// open a non-secure websocket connection.
let (mut ws, _res) = connect_async(format!("ws://localhost:{}", relay.port)).await?;
// send a simple pre-made message
let simple_event = r#"["EVENT", {"content": "hello world","created_at": 1691239763,
"id":"f3ce6798d70e358213ebbeba4886bbdfacf1ecfd4f65ee5323ef5f404de32b86",
"kind": 1,
"pubkey": "79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798",
"sig": "30ca29e8581eeee75bf838171dec818af5e6de2b74f5337de940f5cc91186534c0b20d6cf7ad1043a2c51dbd60b979447720a471d346322103c83f6cb66e4e98",
"tags": []}]"#;
ws.send(simple_event.into()).await?;
// get response from server, confirm it is an array with first element "OK"
let event_confirm = ws.next().await;
ws.close(None).await?;
info!("event confirmed: {:?}", event_confirm);
// open a new connection, and wait for some time to get the event.
let (mut sub_ws, _res) = connect_async(format!("ws://localhost:{}", relay.port)).await?;
let event_sub = r#"["REQ", "simple", {}]"#;
sub_ws.send(event_sub.into()).await?;
// read from subscription
let _ws_next = sub_ws.next().await;
let _res = relay.shutdown_tx.send(());
Ok(())
}
tests/name_authority.rs
+377
View File
@@ -0,0 +1,377 @@
//! End-to-end tests for the built-in name authority: NIP-98 registration
//! round trip, NIP-05 resolution, reverse lookup, one-name-per-key,
//! reserved names, release + cooldown, plus the paid-name flow against a
//! fake GoblinPay server (402 until the invoice reports paid). Also
//! verifies the NIP-11 document stays payment-free.
use anyhow::Result;
use base64::Engine;
use bitcoin_hashes::{sha256, Hash};
use floonet_rs::event::Event;
use floonet_rs::utils::unix_time;
use hyper::service::{make_service_fn, service_fn};
use hyper::{Body, Client, Request, Server, StatusCode};
use secp256k1::{KeyPair, Secp256k1, XOnlyPublicKey};
use serde_json::{json, Value};
use std::convert::Infallible;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;
mod common;
/// A test identity that can sign NIP-98 auth events.
struct Signer {
secp: Secp256k1<secp256k1::All>,
keypair: KeyPair,
pub pubkey_hex: String,
}
impl Signer {
fn new(seed: u8) -> Signer {
let secp = Secp256k1::new();
let keypair = KeyPair::from_seckey_slice(&secp, &[seed; 32]).unwrap();
let pubkey_hex = XOnlyPublicKey::from_keypair(&keypair).to_string();
Signer {
secp,
keypair,
pubkey_hex,
}
}
/// `Authorization: Nostr <b64>` header for method+url over body.
fn nip98(&self, url: &str, method: &str, body: &[u8]) -> String {
let mut tags: Vec<Vec<String>> = vec![
vec!["u".to_string(), url.to_string()],
vec!["method".to_string(), method.to_string()],
// A nonce keeps every auth event id unique, so back-to-back
// requests in the same second are not misread as replays.
vec!["nonce".to_string(), format!("{:x}", rand_u64())],
];
if !body.is_empty() {
let digest: sha256::Hash = sha256::Hash::hash(body);
tags.push(vec!["payload".to_string(), format!("{digest:x}")]);
}
let mut event = Event {
id: "0".to_owned(),
pubkey: self.pubkey_hex.clone(),
delegated_by: None,
created_at: unix_time(),
kind: 27235,
tags,
content: String::new(),
sig: "0".to_owned(),
tagidx: None,
};
let canonical = event.to_canonical().unwrap();
let digest: sha256::Hash = sha256::Hash::hash(canonical.as_bytes());
let msg = secp256k1::Message::from_slice(digest.as_ref()).unwrap();
event.id = format!("{digest:x}");
event.sig = self.secp.sign_schnorr(&msg, &self.keypair).to_string();
let json = serde_json::to_string(&event).unwrap();
format!(
"Nostr {}",
base64::engine::general_purpose::STANDARD.encode(json)
)
}
}
fn rand_u64() -> u64 {
use std::time::{SystemTime, UNIX_EPOCH};
// Cheap uniqueness for test nonces.
SystemTime::now()
.duration_since(UNIX_EPOCH)
.unwrap()
.as_nanos() as u64
}
async fn get_json(url: &str) -> Result<(StatusCode, Value)> {
let client = Client::new();
let res = client.get(url.parse()?).await?;
let status = res.status();
let bytes = hyper::body::to_bytes(res.into_body()).await?;
Ok((status, serde_json::from_slice(&bytes)?))
}
async fn register(
base: &str,
signer: Option<&Signer>,
name: &str,
pubkey: &str,
) -> Result<(StatusCode, Value)> {
let body = json!({"name": name, "pubkey": pubkey}).to_string();
let mut builder = Request::builder()
.method("POST")
.uri(format!("{base}/api/v1/register"))
.header("Content-Type", "application/json");
if let Some(signer) = signer {
builder = builder.header(
"Authorization",
signer.nip98(&format!("{base}/api/v1/register"), "POST", body.as_bytes()),
);
}
let res = Client::new()
.request(builder.body(Body::from(body))?)
.await?;
let status = res.status();
let bytes = hyper::body::to_bytes(res.into_body()).await?;
Ok((status, serde_json::from_slice(&bytes)?))
}
async fn unregister(base: &str, signer: &Signer, name: &str) -> Result<(StatusCode, Value)> {
let url = format!("{base}/api/v1/register/{name}");
let req = Request::builder()
.method("DELETE")
.uri(&url)
.header("Authorization", signer.nip98(&url, "DELETE", &[]))
.body(Body::empty())?;
let res = Client::new().request(req).await?;
let status = res.status();
let bytes = hyper::body::to_bytes(res.into_body()).await?;
Ok((status, serde_json::from_slice(&bytes)?))
}
/// Fresh file-backed data directory (exercises the v19 migration).
fn temp_data_dir(tag: &str) -> String {
let dir = std::env::temp_dir().join(format!("floonet-rs-test-{tag}-{}", rand_u64()));
std::fs::create_dir_all(&dir).unwrap();
dir.to_string_lossy().into_owned()
}
fn authority_relay(data_dir: &str) -> Result<common::Relay> {
let data_dir = data_dir.to_owned();
common::start_relay_with(move |settings| {
settings.database.in_memory = false;
settings.database.data_directory = data_dir;
settings.name_authority.enabled = true;
settings.name_authority.domain = "names.example".to_owned();
settings.name_authority.base_url = format!("http://127.0.0.1:{}", settings.network.port);
settings.name_authority.name_change_cooldown_secs = 600;
})
}
#[tokio::test]
async fn name_authority_round_trip() -> Result<()> {
let data_dir = temp_data_dir("authority");
let relay = authority_relay(&data_dir)?;
common::wait_for_healthy_relay(&relay).await?;
let base = format!("http://127.0.0.1:{}", relay.port);
let alice = Signer::new(11);
let bob = Signer::new(22);
// Health.
let res = Client::new()
.get(format!("{base}/api/v1/health").parse()?)
.await?;
assert_eq!(res.status(), StatusCode::OK);
// Availability before any claim.
let (status, body) = get_json(&format!("{base}/api/v1/name/ada")).await?;
assert_eq!(status, StatusCode::OK);
assert_eq!(body["available"], json!(true));
// Unauthenticated register is refused.
let (status, _) = register(&base, None, "ada", &alice.pubkey_hex).await?;
assert_eq!(status, StatusCode::UNAUTHORIZED);
// NIP-98 authenticated register succeeds.
let (status, body) = register(&base, Some(&alice), "ada", &alice.pubkey_hex).await?;
assert_eq!(status, StatusCode::CREATED, "{body}");
assert_eq!(body["nip05"], json!("ada@names.example"));
// NIP-05 resolution.
let (status, body) =
get_json(&format!("{base}/.well-known/nostr.json?name=ada")).await?;
assert_eq!(status, StatusCode::OK);
assert_eq!(body["names"]["ada"], json!(alice.pubkey_hex));
// Reverse lookup.
let (status, body) =
get_json(&format!("{base}/api/v1/by-pubkey/{}", alice.pubkey_hex)).await?;
assert_eq!(status, StatusCode::OK);
assert_eq!(body["name"], json!("ada"));
// Same name, different key: conflict.
let (status, _) = register(&base, Some(&bob), "ada", &bob.pubkey_hex).await?;
assert_eq!(status, StatusCode::CONFLICT);
// One active name per key.
let (status, body) = register(&base, Some(&alice), "ada2", &alice.pubkey_hex).await?;
assert_eq!(status, StatusCode::CONFLICT, "{body}");
// Reserved and look-alike names are refused.
let (status, _) = register(&base, Some(&bob), "admin", &bob.pubkey_hex).await?;
assert_eq!(status, StatusCode::FORBIDDEN);
let (status, _) = register(&base, Some(&bob), "supp0rt", &bob.pubkey_hex).await?;
assert_eq!(status, StatusCode::FORBIDDEN);
// The operator's own domain label is reserved too.
let (status, _) = register(&base, Some(&bob), "names", &bob.pubkey_hex).await?;
assert_eq!(status, StatusCode::FORBIDDEN);
// Release, then the release-armed cooldown blocks a fresh claim.
let (status, body) = unregister(&base, &alice, "ada").await?;
assert_eq!(status, StatusCode::OK, "{body}");
let (status, body) = register(&base, Some(&alice), "lovelace", &alice.pubkey_hex).await?;
assert_eq!(status, StatusCode::TOO_MANY_REQUESTS, "{body}");
assert_eq!(body["error"], json!("name_change_cooldown"));
// The released name resolves to nobody.
let (_, body) = get_json(&format!("{base}/.well-known/nostr.json?name=ada")).await?;
assert_eq!(body["names"], json!({}));
let _res = relay.shutdown_tx.send(());
std::fs::remove_dir_all(&data_dir).ok();
Ok(())
}
#[tokio::test]
async fn nip11_and_landing_are_payment_free() -> Result<()> {
let relay = common::start_relay()?;
common::wait_for_healthy_relay(&relay).await?;
let base = format!("http://127.0.0.1:{}", relay.port);
// NIP-11 document: neutral Floonet identity, zero payment wording.
let req = Request::builder()
.method("GET")
.uri(&base)
.header("Accept", "application/nostr+json")
.body(Body::empty())?;
let res = Client::new().request(req).await?;
assert_eq!(res.status(), StatusCode::OK);
let bytes = hyper::body::to_bytes(res.into_body()).await?;
let text = String::from_utf8(bytes.to_vec())?;
let info: Value = serde_json::from_str(&text)?;
assert_eq!(info["name"], json!("floonet-rs-relay"));
for banned in ["payment", "fees", "sats", "msats", "invoice", "slatepack"] {
assert!(
!text.to_lowercase().contains(banned),
"NIP-11 must not mention `{banned}`: {text}"
);
}
// Landing page shows the Floonet branding and references the logo.
let res = Client::new().get(base.parse()?).await?;
let bytes = hyper::body::to_bytes(res.into_body()).await?;
let html = String::from_utf8(bytes.to_vec())?;
assert!(html.contains("/logo.svg"), "landing must show the logo");
assert!(
!html.to_lowercase().contains("payment"),
"landing must not mention payments"
);
// The logo itself is served.
let res = Client::new().get(format!("{base}/logo.svg").parse()?).await?;
assert_eq!(res.status(), StatusCode::OK);
assert_eq!(
res.headers().get("content-type").unwrap(),
"image/svg+xml"
);
let _res = relay.shutdown_tx.send(());
Ok(())
}
/// Minimal fake GoblinPay: POST /invoice and GET /invoice/{id}, with a
/// shared "paid" flag the test flips.
async fn fake_goblinpay(paid: Arc<AtomicBool>) -> Result<String> {
let make_svc = make_service_fn(move |_conn| {
let paid = paid.clone();
async move {
Ok::<_, Infallible>(service_fn(move |req: Request<Body>| {
let paid = paid.clone();
async move {
let authed = req
.headers()
.get("Authorization")
.and_then(|v| v.to_str().ok())
== Some("Bearer test-gp-token");
let status = if paid.load(Ordering::SeqCst) {
"paid"
} else {
"open"
};
let response = if !authed {
hyper::Response::builder()
.status(401)
.body(Body::from(r#"{"error":"unauthorized"}"#))
.unwrap()
} else {
hyper::Response::builder()
.status(200)
.header("Content-Type", "application/json")
.body(Body::from(
json!({
"invoice_id": "inv-test-1",
"token": "tok1",
"pay_url": "http://pay.invalid/pay/tok1",
"status": status,
})
.to_string(),
))
.unwrap()
};
Ok::<_, Infallible>(response)
}
}))
}
});
let server = Server::bind(&"127.0.0.1:0".parse()?).serve(make_svc);
let addr = server.local_addr();
tokio::spawn(async move {
let _ = server.await;
});
Ok(format!("http://{addr}"))
}
#[tokio::test]
async fn paid_names_require_confirmed_goblinpay_payment() -> Result<()> {
let paid = Arc::new(AtomicBool::new(false));
let gp_url = fake_goblinpay(paid.clone()).await?;
let data_dir = temp_data_dir("paid");
let relay = {
let data_dir = data_dir.clone();
common::start_relay_with(move |settings| {
settings.database.in_memory = false;
settings.database.data_directory = data_dir;
settings.name_authority.enabled = true;
settings.name_authority.domain = "names.example".to_owned();
settings.name_authority.base_url =
format!("http://127.0.0.1:{}", settings.network.port);
settings.goblinpay.pay_mode = "name".to_owned();
settings.goblinpay.url = gp_url;
settings.goblinpay.api_token = "test-gp-token".to_owned();
settings.goblinpay.name_price_grin = 2.5;
})?
};
common::wait_for_healthy_relay(&relay).await?;
let base = format!("http://127.0.0.1:{}", relay.port);
let alice = Signer::new(33);
// Unpaid: register answers 402 with the GoblinPay pay page.
let (status, body) = register(&base, Some(&alice), "ada", &alice.pubkey_hex).await?;
assert_eq!(status, StatusCode::PAYMENT_REQUIRED, "{body}");
assert_eq!(body["error"], json!("payment_required"));
assert_eq!(body["pay_url"], json!("http://pay.invalid/pay/tok1"));
assert_eq!(body["invoice_id"], json!("inv-test-1"));
assert_eq!(body["price_grin"], json!(2.5));
assert_eq!(body["price_nanogrin"], json!(2_500_000_000u64));
// Still unpaid on retry: the same outstanding invoice comes back.
let (status, body) = register(&base, Some(&alice), "ada", &alice.pubkey_hex).await?;
assert_eq!(status, StatusCode::PAYMENT_REQUIRED, "{body}");
assert_eq!(body["invoice_id"], json!("inv-test-1"));
// Payment confirms on chain (GoblinPay now reports paid): claim works.
paid.store(true, Ordering::SeqCst);
let (status, body) = register(&base, Some(&alice), "ada", &alice.pubkey_hex).await?;
assert_eq!(status, StatusCode::CREATED, "{body}");
assert_eq!(body["nip05"], json!("ada@names.example"));
// And the name resolves.
let (_, body) = get_json(&format!("{base}/.well-known/nostr.json?name=ada")).await?;
assert_eq!(body["names"]["ada"], json!(alice.pubkey_hex));
let _res = relay.shutdown_tx.send(());
std::fs::remove_dir_all(&data_dir).ok();
Ok(())
}
tests/whitelist.rs
+103
View File
@@ -0,0 +1,103 @@
//! End-to-end tests for the Floonet default-deny kind whitelist: a real
//! relay, a real websocket, real signed events. An allowed kind gets
//! OK=true; a disallowed kind gets OK=false with a `blocked:` reason.
use anyhow::Result;
use bitcoin_hashes::{sha256, Hash};
use floonet_rs::event::Event;
use floonet_rs::utils::unix_time;
use futures::SinkExt;
use futures::StreamExt;
use secp256k1::{rand, KeyPair, Secp256k1, XOnlyPublicKey};
use serde_json::Value;
mod common;
/// Build a signed event of `kind` and return (event_json, event_id).
fn signed_event(kind: u64, content: &str) -> (String, String) {
let secp = Secp256k1::new();
let key_pair = KeyPair::new(&secp, &mut rand::thread_rng());
let public_key = XOnlyPublicKey::from_keypair(&key_pair);
let mut event = Event {
id: "0".to_owned(),
pubkey: public_key.to_string(),
delegated_by: None,
created_at: unix_time(),
kind,
tags: vec![],
content: content.to_owned(),
sig: "0".to_owned(),
tagidx: None,
};
let canonical = event.to_canonical().unwrap();
let digest: sha256::Hash = sha256::Hash::hash(canonical.as_bytes());
let msg = secp256k1::Message::from_slice(digest.as_ref()).unwrap();
let sig = secp.sign_schnorr(&msg, &key_pair);
event.id = format!("{digest:x}");
event.sig = sig.to_string();
let json = serde_json::to_string(&event).unwrap();
(format!(r#"["EVENT",{json}]"#), event.id)
}
/// Publish a message and return the relay's OK frame for that event id.
async fn publish_and_get_ok(port: u16, msg: &str, event_id: &str) -> Result<Value> {
let (mut ws, _res) = tokio_tungstenite::connect_async(format!("ws://127.0.0.1:{port}")).await?;
ws.send(msg.into()).await?;
// Read frames until the OK for our event id shows up.
while let Some(frame) = ws.next().await {
let frame = frame?;
if let Ok(text) = frame.into_text() {
if let Ok(value) = serde_json::from_str::<Value>(&text) {
if value.get(0).and_then(Value::as_str) == Some("OK")
&& value.get(1).and_then(Value::as_str) == Some(event_id)
{
ws.close(None).await.ok();
return Ok(value);
}
}
}
}
anyhow::bail!("no OK frame received for event {event_id}");
}
#[tokio::test]
async fn whitelist_accepts_allowed_kind_and_rejects_disallowed() -> Result<()> {
let relay = common::start_relay()?;
common::wait_for_healthy_relay(&relay).await?;
// Kind 1 (short text note) is NOT in the Floonet whitelist: rejected.
let (msg, id) = signed_event(1, "hello world");
let ok = publish_and_get_ok(relay.port, &msg, &id).await?;
assert_eq!(
ok.get(2).and_then(Value::as_bool),
Some(false),
"kind 1 must be rejected: {ok}"
);
let reason = ok.get(3).and_then(Value::as_str).unwrap_or_default();
assert!(
reason.starts_with("blocked:"),
"rejection must be a blocked: OK message, got {reason}"
);
// Kind 0 (profile metadata) IS in the whitelist: accepted.
let (msg, id) = signed_event(0, r#"{"name":"floonet-test"}"#);
let ok = publish_and_get_ok(relay.port, &msg, &id).await?;
assert_eq!(
ok.get(2).and_then(Value::as_bool),
Some(true),
"kind 0 must be accepted: {ok}"
);
// Kind 1059 (gift wrap) IS in the whitelist: accepted.
let (msg, id) = signed_event(1059, "opaque ciphertext");
let ok = publish_and_get_ok(relay.port, &msg, &id).await?;
assert_eq!(
ok.get(2).and_then(Value::as_bool),
Some(true),
"kind 1059 must be accepted: {ok}"
);
let _res = relay.shutdown_tx.send(());
Ok(())
}