userAdityaa/caravel
1
1
Fork 0
forked from coracle/caravel
Code Pull Requests Activity

chore: encrypt tenant NWC URL at rest and stop secret exposure in tenant APIs

Browse Source
This commit is contained in:
Aditya Chaudhary
2026-05-02 17:05:54 +05:45
parent b1e3747ddb
commit a33d628739
12 changed files with 153 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
backend/.env.template
+1
View File
@@ -28,5 +28,6 @@ LIVEKIT_API_SECRET=
# Billing
NWC_URL= # Nostr Wallet Connect URL for generating Lightning invoices
NWC_URL_CIPHER_KEY= # 32-byte hex/base64 secp256k1 secret key used for NIP-44 encryption of tenant nwc_url at rest
STRIPE_SECRET_KEY= # Required Stripe API secret key (sk_...)
STRIPE_WEBHOOK_SECRET=whsec_test_00000000000000000000000000 # Webhook signing secret (use real value in production)
backend/README.md
+1
View File
@@ -44,6 +44,7 @@ Environment variables:
| `LIVEKIT_API_KEY` | LiveKit API key sent to zooid | _optional_ |
| `LIVEKIT_API_SECRET` | LiveKit API secret sent to zooid | _optional_ |
| `NWC_URL` | Platform NWC URL used to generate BOLT11 invoices | _required for invoice generation_ |
| `NWC_URL_CIPHER_KEY` | 32-byte hex/base64 secp256k1 secret key used for NIP-44 encryption of tenant `nwc_url` at rest | _required when tenant `nwc_url` is used_ |
| `STRIPE_SECRET_KEY` | Stripe API secret key used for billing API operations | _required_ |
| `STRIPE_WEBHOOK_SECRET` | Stripe webhook signing secret used to verify `Stripe-Signature` headers | _required_ |
| `ROBOT_SECRET` | Robot Nostr secret key | _required_ |
backend/src/api.rs
+35 -6
View File
@@ -445,6 +445,18 @@ struct IdentityResponse {
is_admin: bool,
}
#[derive(Serialize)]
struct TenantResponse {
pubkey: String,
nwc_url: String,
nwc_configured: bool,
nwc_error: Option<String>,
created_at: i64,
stripe_customer_id: String,
stripe_subscription_id: Option<String>,
past_due_at: Option<i64>,
}
#[derive(Deserialize)]
struct CreateRelayRequest {
tenant: String,
@@ -486,7 +498,7 @@ async fn list_tenants(
state.api.require_admin(&pubkey)?;
match state.api.query.list_tenants().await {
Ok(tenants) => Ok(ok(StatusCode::OK, tenants)),
Ok(tenants) => Ok(ok(StatusCode::OK, scrub_tenants_for_response(tenants))),
Err(e) => Ok(err(
StatusCode::INTERNAL_SERVER_ERROR,
"internal",
@@ -515,7 +527,7 @@ async fn create_tenant(
let pubkey = state.api.extract_auth_pubkey(&headers)?;
match state.api.query.get_tenant(&pubkey).await {
Ok(Some(t)) => Ok(ok(StatusCode::OK, t)),
Ok(Some(t)) => Ok(ok(StatusCode::OK, scrub_tenant_for_response(t))),
Ok(None) => {
let stripe_customer_id = match state.api.billing.stripe_create_customer(&pubkey).await {
Ok(id) => id,
@@ -539,10 +551,10 @@ async fn create_tenant(
};
match state.api.command.create_tenant(&tenant).await {
Ok(()) => Ok(ok(StatusCode::OK, tenant)),
Ok(()) => Ok(ok(StatusCode::OK, scrub_tenant_for_response(tenant))),
Err(e) if matches!(map_unique_error(&e), Some("pubkey-exists")) => {
match state.api.query.get_tenant(&pubkey).await {
Ok(Some(t)) => Ok(ok(StatusCode::OK, t)),
Ok(Some(t)) => Ok(ok(StatusCode::OK, scrub_tenant_for_response(t))),
Ok(None) => Ok(err(
StatusCode::INTERNAL_SERVER_ERROR,
"internal",
@@ -585,7 +597,7 @@ async fn get_tenant(
let auth = state.api.extract_auth_pubkey(&headers)?;
state.api.require_admin_or_tenant(&auth, &pubkey)?;
let tenant = state.api.get_tenant_or_404(&pubkey).await?;
Ok(ok(StatusCode::OK, tenant))
Ok(ok(StatusCode::OK, scrub_tenant_for_response(tenant)))
}
async fn list_relays(
@@ -1122,7 +1134,7 @@ async fn update_tenant(
}
});
}
Ok(ok(StatusCode::OK, tenant))
Ok(ok(StatusCode::OK, scrub_tenant_for_response(tenant)))
}
Err(e) => Ok(err(
StatusCode::INTERNAL_SERVER_ERROR,
@@ -1131,3 +1143,20 @@ async fn update_tenant(
)),
}
}
fn scrub_tenant_for_response(tenant: Tenant) -> TenantResponse {
TenantResponse {
pubkey: tenant.pubkey,
nwc_url: String::new(),
nwc_configured: !tenant.nwc_url.is_empty(),
nwc_error: tenant.nwc_error,
created_at: tenant.created_at,
stripe_customer_id: tenant.stripe_customer_id,
stripe_subscription_id: tenant.stripe_subscription_id,
past_due_at: tenant.past_due_at,
}
}
fn scrub_tenants_for_response(tenants: Vec<Tenant>) -> Vec<TenantResponse> {
tenants.into_iter().map(scrub_tenant_for_response).collect()
}
backend/src/command.rs
+5 -2
View File
@@ -5,6 +5,7 @@ use tokio::sync::broadcast;
use crate::models::{
Activity, RELAY_STATUS_ACTIVE, RELAY_STATUS_DELINQUENT, RELAY_STATUS_INACTIVE, Relay, Tenant,
};
use crate::nwc_url_cipher;
#[derive(Clone)]
pub struct Command {
@@ -70,6 +71,7 @@ impl Command {
anyhow::bail!("stripe_customer_id is required");
}
let encrypted_nwc_url = nwc_url_cipher::encrypt_nwc_url(&tenant.nwc_url)?;
let mut tx = self.pool.begin().await?;
sqlx::query(
@@ -77,7 +79,7 @@ impl Command {
VALUES (?, ?, ?, ?)",
)
.bind(&tenant.pubkey)
.bind(&tenant.nwc_url)
.bind(&encrypted_nwc_url)
.bind(tenant.created_at)
.bind(&tenant.stripe_customer_id)
.execute(&mut *tx)
@@ -92,10 +94,11 @@ impl Command {
}
pub async fn update_tenant(&self, tenant: &Tenant) -> Result<()> {
let encrypted_nwc_url = nwc_url_cipher::encrypt_nwc_url(&tenant.nwc_url)?;
let mut tx = self.pool.begin().await?;
sqlx::query("UPDATE tenant SET nwc_url = ? WHERE pubkey = ?")
.bind(&tenant.nwc_url)
.bind(&encrypted_nwc_url)
.bind(&tenant.pubkey)
.execute(&mut *tx)
.await?;
backend/src/lib.rs
+1
View File
@@ -3,6 +3,7 @@ pub mod billing;
pub mod command;
pub mod infra;
pub mod models;
pub mod nwc_url_cipher;
pub mod pool;
pub mod query;
pub mod robot;
backend/src/main.rs
+1
View File
@@ -3,6 +3,7 @@ mod billing;
mod command;
mod infra;
mod models;
mod nwc_url_cipher;
mod pool;
mod query;
mod robot;
backend/src/nwc_url_cipher.rs
+94
View File
@@ -0,0 +1,94 @@
use anyhow::{Result, anyhow};
use base64::Engine;
use nostr_sdk::prelude::{Keys, SecretKey, nip44};
const NIP44_ENVELOPE_PREFIX: &str = "enc:nip44:v2:";
const LEGACY_ENVELOPE_PREFIX: &str = "enc:v1:";
const KEY_LEN: usize = 32;
pub fn is_encrypted_nwc_url(value: &str) -> bool {
value.starts_with(NIP44_ENVELOPE_PREFIX) || value.starts_with(LEGACY_ENVELOPE_PREFIX)
}
pub fn encrypt_nwc_url(value: &str) -> Result<String> {
if value.is_empty() {
return Ok(String::new());
}
let keys = parse_cipher_keys()?;
let payload = nip44::encrypt(
keys.secret_key(),
&keys.public_key(),
value,
nip44::Version::V2,
)
.map_err(|e| anyhow!("failed to encrypt nwc_url with NIP-44: {e}"))?;
Ok(format!("{NIP44_ENVELOPE_PREFIX}{payload}"))
}
pub fn decrypt_nwc_url(value: &str) -> Result<String> {
if value.is_empty() {
return Ok(String::new());
}
if value.starts_with(LEGACY_ENVELOPE_PREFIX) {
return Err(anyhow!(
"unsupported legacy encrypted nwc_url envelope; re-save tenant configuration"
));
}
let Some(payload) = value.strip_prefix(NIP44_ENVELOPE_PREFIX) else {
return Ok(value.to_string());
};
let keys = parse_cipher_keys()?;
nip44::decrypt(keys.secret_key(), &keys.public_key(), payload)
.map_err(|e| anyhow!("failed to decrypt nwc_url with NIP-44: {e}"))
}
fn parse_cipher_keys() -> Result<Keys> {
let key = parse_cipher_key()?;
let secret_key = SecretKey::from_slice(&key)
.map_err(|e| anyhow!("NWC_URL_CIPHER_KEY must be a valid secp256k1 secret key: {e}"))?;
Ok(Keys::new(secret_key))
}
fn parse_cipher_key() -> Result<[u8; KEY_LEN]> {
let raw = std::env::var("NWC_URL_CIPHER_KEY")
.map_err(|_| anyhow!("missing NWC_URL_CIPHER_KEY environment variable"))?;
let trimmed = raw.trim();
if trimmed.is_empty() {
return Err(anyhow!("missing NWC_URL_CIPHER_KEY environment variable"));
}
let key_bytes = if let Ok(decoded_hex) = hex::decode(trimmed) {
if decoded_hex.len() == KEY_LEN {
decoded_hex
} else {
decode_base64_key(trimmed)?
}
} else {
decode_base64_key(trimmed)?
};
if key_bytes.len() != KEY_LEN {
return Err(anyhow!(
"NWC_URL_CIPHER_KEY must decode to exactly {KEY_LEN} bytes"
));
}
let mut key = [0u8; KEY_LEN];
key.copy_from_slice(&key_bytes);
Ok(key)
}
fn decode_base64_key(value: &str) -> Result<Vec<u8>> {
base64::engine::general_purpose::STANDARD
.decode(value)
.or_else(|_| base64::engine::general_purpose::URL_SAFE_NO_PAD.decode(value))
.map_err(|e| {
anyhow!("NWC_URL_CIPHER_KEY must be a 32-byte hex/base64 secp256k1 secret key: {e}")
})
}
backend/src/query.rs
+9 -3
View File
@@ -2,6 +2,7 @@ use anyhow::Result;
use sqlx::SqlitePool;
use crate::models::{Activity, Plan, Relay, Tenant};
use crate::nwc_url_cipher;
#[derive(Clone)]
pub struct Query {
@@ -21,7 +22,7 @@ impl Query {
)
.fetch_all(&self.pool)
.await?;
Ok(rows)
rows.into_iter().map(decrypt_tenant_nwc_url).collect()
}
pub async fn get_tenant(&self, pubkey: &str) -> Result<Option<Tenant>> {
@@ -33,7 +34,7 @@ impl Query {
.bind(pubkey)
.fetch_optional(&self.pool)
.await?;
Ok(row)
row.map(decrypt_tenant_nwc_url).transpose()
}
pub fn list_plans() -> Vec<Plan> {
@@ -158,7 +159,7 @@ impl Query {
.bind(stripe_customer_id)
.fetch_optional(&self.pool)
.await?;
Ok(row)
row.map(decrypt_tenant_nwc_url).transpose()
}
pub async fn get_invoice_nwc_payment_state(&self, invoice_id: &str) -> Result<Option<String>> {
@@ -224,3 +225,8 @@ impl Query {
Ok(found.is_some())
}
}
fn decrypt_tenant_nwc_url(mut tenant: Tenant) -> Result<Tenant> {
tenant.nwc_url = nwc_url_cipher::decrypt_nwc_url(&tenant.nwc_url)?;
Ok(tenant)
}
frontend/src/lib/api.ts
+1
View File
@@ -99,6 +99,7 @@ export type UpdateRelayInput = {
export type Tenant = {
pubkey: string
nwc_url: string
nwc_configured: boolean
created_at: number
stripe_customer_id: string
stripe_subscription_id: string | null
frontend/src/lib/hooks.ts
+1 -1
View File
@@ -135,7 +135,7 @@ export const reactivateRelayById = (id: string) => reactivateRelay(id)
export async function tenantNeedsPaymentSetup(): Promise<boolean> {
const tenant = await getTenant(account()!.pubkey)
return !tenant.nwc_url && !tenant.stripe_subscription_id
return !tenant.nwc_configured && !tenant.stripe_subscription_id
}
export async function getLatestOpenInvoice(): Promise<Invoice | null> {
frontend/src/pages/Account.tsx
+3 -3
View File
@@ -18,9 +18,9 @@ export default function Account() {
const invoicesLoading = useMinLoading(() => invoices.loading)
const hasBillingChanges = createMemo(() => {
const current = tenant()?.nwc_url?.trim() ?? ""
const next = nwcUrl().trim()
return current !== next
if (next) return true
return tenant()?.nwc_configured ?? false
})
createEffect(() => {
@@ -169,7 +169,7 @@ export default function Account() {
<p class="text-xs text-gray-500 mt-0.5">{periodLabel()}</p>
</Show>
</div>
<div class="flex items-center gap-2 flex-shrink-0">
<div class="flex items-center gap-2 shrink-0">
<Show when={isOpen()}>
<span class="text-xs text-blue-600 font-medium">Pay now</span>
</Show>
frontend/src/pages/relays/RelayDetail.tsx
+1 -1
View File
@@ -52,7 +52,7 @@ export default function RelayDetail() {
if (!isPaidRelay()) return false
const t = tenant()
if (!t) return false
return !t.nwc_url
return !t.nwc_configured
})
return (