f31eeaa603
* feat(connect): peppol connector foundation: capability, ledger/budget service, quota Adds the storage + package shape for brokering Peppol through the connector with the same one-address + rate-budget model as bank/skatteverket: a peppol capability (connector-gated, free on hosted), peppol as a ledger + upstream service, a conservative rate budget, and a migration extending the ledger service CHECK and the per-key limits (peppol_connections_per_company). Proxy route + instance-side Qvalia reroute follow. Switch-on gated on the Qvalia brokering-terms check. (cherry picked from commit 3cc0da6a3, migration renumbered 20260902190000) Signed-off-by: Jakob Wennberg <jakob.wennberg@arcim.io> Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MMUUom4fUk6zi4xYZSSfat * feat(connect): Peppol through the connector: hosted proxy, instance transport, ownership ledger Completes the Peppol upstream for self-hosted instances on the connector (WS3): an instance with a connector key carrying the peppol scope and no Qvalia keys of its own sends and receives e-invoices through Arcim's contracted access point, the same way bank and Skatteverket already route. Hosted: app/api/connect/peppol/[...path] speaks the PeppolTransport operations (lookup, submit, status, evidence, recipient PUT/DELETE, inbound list/xml) rather than proxying Qvalia paths, because the Qvalia account is shared by every hosted company and every instance: reads must be scoped to what the caller owns, and the inbound read endpoint is destructive for the whole account. Ownership: a receiving registration is a ledger row (service peppol, participant id in account_uids, sha256 in handle_hash so one key holds a participant at a time); outbound submissions land in the new connector_peppol_submissions table and gate status/evidence; inbound documents are served from the hosted archive filtered by the participants the key holds. Per-company quota (peppol_connections_per_company), the shared PEPPOL_RECEIVING_MAX_REGISTRATIONS cap, and the global peppol rate budget apply. Provider failures cross as CONNECTOR_UPSTREAM_ERROR with the adapter's retryable flag (422 or 502). Instance: lib/invoices/transports/connector.ts implements PeppolTransport over that API and registers itself in connector mode (key present, no QVALIA_* keys); getPeppolTransportAvailability() defaults to it when no provider is selected, so an instance needs no PEPPOL_TRANSPORT_PROVIDER. Webhooks are not brokered; the existing outbound status poll covers it. Hosted is byte-identical: it has its own keys, so connector mode is never on. Docs: SELF-HOSTING.md, SOVEREIGN.md, .env.example. Switch-on for third-party instances stays gated on the Qvalia brokering-terms check; without the scope every operation answers 403. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MMUUom4fUk6zi4xYZSSfat Signed-off-by: Jakob Wennberg <311770904+jakobwennberg-oss@users.noreply.github.com> * fix(connect): authorize Peppol participants per key, harden the proxy after review Review follow-ups on #2177. Authorization: a key may only register (and send as) participant identifiers Arcim recorded on the key at issuance (connector_keys.peppol_participants, migration 20260902191000) or the licensee's own org number, and a document may only be submitted as a sender the key has registered; X-Connector-Company stays an opaque per-company ref. Cap: the shared access-point cap now counts fresh pending reservations and is re-checked after this request's own reservation, so concurrent registrations cannot both pass. Inbound: both halves of the participant id are filtered in the archive query (over-fetched, then exact-pair checked), so foreign rows sharing an identifier cannot consume the limit. Delete: deregistration is a required transport capability, checked before the ledger row is revoked, and registration refuses an access point that cannot deregister. Instance transport: the hosted URL must be https (loopback http only, same rule as getConnectorConfig), and the response body is read inside the timeout window with body-read failures mapped to retryable transport errors. issue-connector-key.ts gains --peppol-participants and --peppol-connections-per-company. Declined: NOT VALID on the ledger CHECK (the table is empty until keys are issued; the validated scan is instant). Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MMUUom4fUk6zi4xYZSSfat Signed-off-by: Jakob Wennberg <311770904+jakobwennberg-oss@users.noreply.github.com> * fix(connect): bind Peppol ownership to the instance company, query exact participant pairs Second review round on #2177. Ownership is now (key, company_ref), not key alone: a sender must be registered under the same company header, status and evidence reads look the submission up under the header company, DELETE and re-registration refuse a participant the key holds for another company, so one company on a multi-company instance cannot act on another company's registration through the shared key. The instance transport resolves the owning company from its own peppol_deliveries / peppol_registrations rows before status, evidence and deregistration calls (deps.companyFor, deps.companyForParticipant, wired in transports/index.ts). Inbound listing stays key-wide (the instance routes documents to its own companies by its own registrations). The archive query now runs one exact-pair query per scheme (scheme fixed, that scheme's identifiers), so neither foreign nor cross-pair rows can consume the limit. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MMUUom4fUk6zi4xYZSSfat Signed-off-by: Jakob Wennberg <311770904+jakobwennberg-oss@users.noreply.github.com> --------- Signed-off-by: Jakob Wennberg <jakob.wennberg@arcim.io> Signed-off-by: Jakob Wennberg <311770904+jakobwennberg-oss@users.noreply.github.com> Co-authored-by: Jakob Wennberg <311770904+jakobwennberg-oss@users.noreply.github.com> Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
120 lines
4.4 KiB
TypeScript
120 lines
4.4 KiB
TypeScript
import crypto from 'node:crypto'
|
|
import type { SupabaseClient } from '@supabase/supabase-js'
|
|
import { createServiceClientNoCookies } from '@/lib/auth/api-keys'
|
|
import { CONNECTOR_KEY_PREFIX, type ConnectorKeyStatus } from '../contract'
|
|
|
|
/**
|
|
* Hosted-side connector key primitives. Mirrors lib/auth/api-keys.ts for
|
|
* `gnubok_sk_` API keys: 32 CSPRNG bytes, SHA-256 at rest (the hash is the
|
|
* lookup; a slow KDF adds nothing on a 256-bit random secret and would sit on
|
|
* the hot path of every proxied request), atomic validate + rate-limit in a
|
|
* SECURITY DEFINER RPC that only service_role may execute.
|
|
*/
|
|
|
|
export function generateConnectorKey(): { key: string; hash: string; prefix: string } {
|
|
const random = crypto.randomBytes(32).toString('base64url')
|
|
const key = `${CONNECTOR_KEY_PREFIX}${random}`
|
|
return { key, hash: hashConnectorKey(key), prefix: key.slice(0, CONNECTOR_KEY_PREFIX.length + 8) }
|
|
}
|
|
|
|
export function hashConnectorKey(key: string): string {
|
|
return crypto.createHash('sha256').update(key).digest('hex')
|
|
}
|
|
|
|
export function isConnectorKeyFormat(key: string): boolean {
|
|
return key.startsWith(CONNECTOR_KEY_PREFIX) && key.length > CONNECTOR_KEY_PREFIX.length + 16
|
|
}
|
|
|
|
export interface ConnectorKeyLimits {
|
|
bank_connections_per_company: number
|
|
skv_connections_per_company: number
|
|
/** Active Peppol receiving registrations per company ("one address"). */
|
|
peppol_connections_per_company: number
|
|
sync_min_interval_s: number
|
|
}
|
|
|
|
export const DEFAULT_CONNECTOR_LIMITS: ConnectorKeyLimits = {
|
|
bank_connections_per_company: 1,
|
|
skv_connections_per_company: 1,
|
|
peppol_connections_per_company: 1,
|
|
sync_min_interval_s: 0,
|
|
}
|
|
|
|
export interface ValidatedConnectorKey {
|
|
id: string
|
|
orgNumber: string
|
|
instanceUrl: string | null
|
|
scopes: string[]
|
|
status: ConnectorKeyStatus
|
|
currentPeriodEnd: string | null
|
|
limits: ConnectorKeyLimits
|
|
}
|
|
|
|
export type ConnectorKeyValidation =
|
|
| { ok: true; key: ValidatedConnectorKey }
|
|
| { ok: false; status: 401 | 403 | 429; code: 'CONNECTOR_KEY_INVALID' | 'CONNECTOR_KEY_SUSPENDED' | 'CONNECTOR_RATE_LIMITED'; error: string }
|
|
| { ok: false; status: 503; code: 'CONNECTOR_VALIDATION_UNAVAILABLE'; error: string }
|
|
|
|
/**
|
|
* Validate a presented key: format check, RPC lookup (atomic rate-limit
|
|
* increment), status mapping. Never throws on a bad key.
|
|
*
|
|
* A database/RPC error maps to 503, NEVER 401: the instance-side sync treats
|
|
* 401/403 as key revocation and deletes its entire connector grant cache
|
|
* (lib/connect/instance/sync.ts), so answering a hosted pooler blip with 401
|
|
* would let a transient hosted incident destroy a paying instance's 72h
|
|
* offline grace. 503 lands in the sync's keep-grants branch. Only a genuine
|
|
* empty result (unknown or revoked key) is 401. This deliberately diverges
|
|
* from the api-keys precedent, where a spurious 401 costs one request.
|
|
*/
|
|
export async function validateConnectorKey(
|
|
key: string,
|
|
supabase: SupabaseClient = createServiceClientNoCookies(),
|
|
): Promise<ConnectorKeyValidation> {
|
|
if (!isConnectorKeyFormat(key)) {
|
|
return { ok: false, status: 401, code: 'CONNECTOR_KEY_INVALID', error: 'Invalid connector key' }
|
|
}
|
|
const { data, error } = await supabase.rpc('validate_and_increment_connector_key', {
|
|
p_key_hash: hashConnectorKey(key),
|
|
})
|
|
if (error) {
|
|
return {
|
|
ok: false,
|
|
status: 503,
|
|
code: 'CONNECTOR_VALIDATION_UNAVAILABLE',
|
|
error: 'Connector key validation temporarily unavailable',
|
|
}
|
|
}
|
|
if (!data || (Array.isArray(data) && data.length === 0)) {
|
|
return { ok: false, status: 401, code: 'CONNECTOR_KEY_INVALID', error: 'Invalid connector key' }
|
|
}
|
|
const row = (Array.isArray(data) ? data[0] : data) as {
|
|
connector_key_id: string
|
|
org_number: string
|
|
instance_url: string | null
|
|
scopes: string[] | null
|
|
status: string
|
|
current_period_end: string | null
|
|
rate_limited: boolean
|
|
limits: Partial<ConnectorKeyLimits> | null
|
|
}
|
|
if (row.status !== 'active') {
|
|
return { ok: false, status: 403, code: 'CONNECTOR_KEY_SUSPENDED', error: 'Connector key is suspended' }
|
|
}
|
|
if (row.rate_limited) {
|
|
return { ok: false, status: 429, code: 'CONNECTOR_RATE_LIMITED', error: 'Rate limit exceeded' }
|
|
}
|
|
return {
|
|
ok: true,
|
|
key: {
|
|
id: row.connector_key_id,
|
|
orgNumber: row.org_number,
|
|
instanceUrl: row.instance_url,
|
|
scopes: row.scopes ?? [],
|
|
status: 'active',
|
|
currentPeriodEnd: row.current_period_end,
|
|
limits: { ...DEFAULT_CONNECTOR_LIMITS, ...(row.limits ?? {}) },
|
|
},
|
|
}
|
|
}
|