Directories
¶
| Path | Synopsis |
|---|---|
|
Package adapter defines the provider adapter contract and the normalized upstream error taxonomy (ADR-0008).
|
Package adapter defines the provider adapter contract and the normalized upstream error taxonomy (ADR-0008). |
|
anthropic
Package anthropic is the native Anthropic Messages API adapter — the one hand-built translation in v0.1 (ADR-0003/0008).
|
Package anthropic is the native Anthropic Messages API adapter — the one hand-built translation in v0.1 (ADR-0003/0008). |
|
openaicompat
Package openaicompat is the catch-all provider adapter (ADR-0008 §2/§3): one adapter, many providers, driven entirely by preset data (presets/*.yaml).
|
Package openaicompat is the catch-all provider adapter (ADR-0008 §2/§3): one adapter, many providers, driven entirely by preset data (presets/*.yaml). |
|
Package assemble resolves the enabled compliance packs into a deterministic policy plan (ADR-0021): one entry per distinct policy id (the shared transform runs once), the set-valued config unioned across packs, every framework citation accumulated, and validated fail-closed against the implemented entity set.
|
Package assemble resolves the enabled compliance packs into a deterministic policy plan (ADR-0021): one entry per distinct policy id (the shared transform runs once), the set-valued config unioned across packs, every framework citation accumulated, and validated fail-closed against the implemented entity set. |
|
Package audit produces PORTUNUS's tamper-evident audit log — the artifact auditors and regulators actually touch (ADR-0007).
|
Package audit produces PORTUNUS's tamper-evident audit log — the artifact auditors and regulators actually touch (ADR-0007). |
|
Package auth authenticates gateway clients and produces the audit actor + authorization identity for a request (ADR-0019).
|
Package auth authenticates gateway clients and produces the audit actor + authorization identity for a request (ADR-0019). |
|
Package config loads, validates, and defaults portunus.yaml — the single file that configures a v0.1 deployment (ADR-0003 §IN-7).
|
Package config loads, validates, and defaults portunus.yaml — the single file that configures a v0.1 deployment (ADR-0003 §IN-7). |
|
Package emit is the audit emission layer: it turns a completed engine Exchange — plus the inputs only the orchestrator holds (the original prompt, the response, provider gen_ai metadata, trace context, actor auth) — into typed audit events and appends them to the tamper-evident chain (ADR-0007 §2).
|
Package emit is the audit emission layer: it turns a completed engine Exchange — plus the inputs only the orchestrator holds (the original prompt, the response, provider gen_ai metadata, trace context, actor auth) — into typed audit events and appends them to the tamper-evident chain (ADR-0007 §2). |
|
Package engine implements the Exchange pipeline — the heart of PORTUNUS (ADR-0005).
|
Package engine implements the Exchange pipeline — the heart of PORTUNUS (ADR-0005). |
|
Package gateway is the assembler: it wires a resolved configuration into a running server — the engine (request tokenize → dispatch → response detokenize, ADR-0005 §1), the provider adapter + dispatcher (ADR-0008), the audit emitter, and client authentication (ADR-0019).
|
Package gateway is the assembler: it wires a resolved configuration into a running server — the engine (request tokenize → dispatch → response detokenize, ADR-0005 §1), the provider adapter + dispatcher (ADR-0008), the audit emitter, and client authentication (ADR-0019). |
|
Package policy contains PORTUNUS's policy implementations — one subpackage per policy, flat and discoverable (ADR-0005, ADR-0009).
|
Package policy contains PORTUNUS's policy implementations — one subpackage per policy, flat and discoverable (ADR-0005, ADR-0009). |
|
injectionguard
Package injectionguard is PORTUNUS's deterministic prompt-injection heuristic detector — the always-on, pure-Go layer of the layered guard (ADR-0022 §2, ADR-0003 §5).
|
Package injectionguard is PORTUNUS's deterministic prompt-injection heuristic detector — the always-on, pure-Go layer of the layered guard (ADR-0022 §2, ADR-0003 §5). |
|
piidetect
Package piidetect is PORTUNUS's deterministic PII recognizer engine — it decides WHAT to tokenize (ADR-0006 §1, ADR-0016).
|
Package piidetect is PORTUNUS's deterministic PII recognizer engine — it decides WHAT to tokenize (ADR-0006 §1, ADR-0016). |
|
piitokenize
Package piitokenize is PORTUNUS's reversible PII tokenization policy (pii.tokenize) — the crown-jewel transform (ADR-0006).
|
Package piitokenize is PORTUNUS's reversible PII tokenization policy (pii.tokenize) — the crown-jewel transform (ADR-0006). |
|
Package registry merges the embedded pack and preset catalogs with user overrides into the validated, effective set the engine runs (ADR-0005 §4, ADR-0008 §3).
|
Package registry merges the embedded pack and preset catalogs with user overrides into the validated, effective set the engine runs (ADR-0005 §4, ADR-0008 §3). |
|
Package server is PORTUNUS's HTTP front door: the OpenAI-compatible surfaces /v1/chat/completions and /v1/responses, listener lifecycle, and SSE plumbing (ADR-0003, ADR-0008).
|
Package server is PORTUNUS's HTTP front door: the OpenAI-compatible surfaces /v1/chat/completions and /v1/responses, listener lifecycle, and SSE plumbing (ADR-0003, ADR-0008). |
|
Package store provides PORTUNUS's embedded persistence: a single SQLite file via the pure-Go driver, keeping the zero-dependency single-binary promise (ADR-0003, ADR-0009; supersedes ADR-0001's Postgres-first plan for v0.1 — Postgres arrives in v0.2 behind these same interfaces).
|
Package store provides PORTUNUS's embedded persistence: a single SQLite file via the pure-Go driver, keeping the zero-dependency single-binary promise (ADR-0003, ADR-0009; supersedes ADR-0001's Postgres-first plan for v0.1 — Postgres arrives in v0.2 behind these same interfaces). |
|
Package vault stores PII↔token mappings — the most sensitive component of any PORTUNUS deployment (ADR-0006).
|
Package vault stores PII↔token mappings — the most sensitive component of any PORTUNUS deployment (ADR-0006). |
Click to show internal directories.
Click to hide internal directories.