Classes
AssuranceCampaignStore
Constructors
Constructor
new AssuranceCampaignStore(): AssuranceCampaignStore;
Returns
Methods
create()
create(campaign: AuthorizationCampaign): void;
Parameters
| Parameter | Type |
|---|---|
campaign | AuthorizationCampaign |
Returns
void
get()
get(id: string): AuthorizationCampaign;
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
publish()
publish(campaign: AuthorizationCampaign): void;
Parameters
| Parameter | Type |
|---|---|
campaign | AuthorizationCampaign |
Returns
void
replace()
replace(campaign: AuthorizationCampaign): void;
Parameters
| Parameter | Type |
|---|---|
campaign | AuthorizationCampaign |
Returns
void
subscribe()
subscribe(listener: (campaign: AssuranceVisualizationSnapshot) => void): () => void;
Parameters
| Parameter | Type |
|---|---|
listener | (campaign: AssuranceVisualizationSnapshot) => void |
Returns
(): void;
Returns
void
AssuranceInputError
Extends
Error
Constructors
Constructor
new AssuranceInputError(message?: string): AssuranceInputError;
Parameters
| Parameter | Type |
|---|---|
message? | string |
Returns
Inherited from
Error.constructor
Constructor
new AssuranceInputError(message?: string, options?: ErrorOptions): AssuranceInputError;
Parameters
| Parameter | Type |
|---|---|
message? | string |
options? | ErrorOptions |
Returns
Inherited from
Error.constructor
Constructor
new AssuranceInputError(message?: string, options?: ErrorOptions): AssuranceInputError;
Parameters
| Parameter | Type |
|---|---|
message? | string |
options? | ErrorOptions |
Returns
Inherited from
Error.constructor
Properties
AuthorizationCampaign
Constructors
Constructor
new AuthorizationCampaign(options: CreateAuthorizationCampaignOptions): AuthorizationCampaign;
Parameters
| Parameter | Type |
|---|---|
options | CreateAuthorizationCampaignOptions |
Returns
Properties
| Property | Modifier | Type |
|---|---|---|
context | readonly | AssuranceCampaignContext |
id | readonly | string |
maxRuns | readonly | number |
target | readonly | LocalFirebaseTarget |
Accessors
observations
Get Signature
get observations(): AssuranceObservation[];
Returns
report
Get Signature
get report(): AuthorizationCampaignReport;
Returns
Methods
addActor()
addActor(actor: AssuranceActor): AssuranceActor;
Parameters
| Parameter | Type |
|---|---|
actor | AssuranceActor |
Returns
addInvariant()
addInvariant(invariant: SecurityInvariant): SecurityInvariant;
Parameters
| Parameter | Type |
|---|---|
invariant | SecurityInvariant |
Returns
addObservation()
addObservation(observation: AssuranceObservation): AssuranceObservation;
Parameters
| Parameter | Type |
|---|---|
observation | AssuranceObservation |
Returns
addProbe()
addProbe(probe: AssuranceProbe): AssuranceProbe;
Parameters
| Parameter | Type |
|---|---|
probe | AssuranceProbe |
Returns
export()
export(): CampaignExport;
Returns
exportSecurityCases()
exportSecurityCases(options?: {
includeCandidates?: boolean;
}): SecurityCase[];
Parameters
| Parameter | Type |
|---|---|
options? | { includeCandidates?: boolean; } |
options.includeCandidates? | boolean |
Returns
inspect()
inspect(probeId: string): AssuranceProbeResult;
Parameters
| Parameter | Type |
|---|---|
probeId | string |
Returns
map()
map(batch: CampaignMapBatch): CampaignMapCounts;
Add actors, observations, and probes as one batch.
The batch is validated whole before any of it is kept, so a rejected batch leaves the campaign exactly as it was and the caller can send the corrected batch unchanged. Adding item by item would keep the items before the bad one, and the corrected batch would then be refused for duplicating what the first attempt already added.
References resolve against the batch as well as the campaign, so an observation may name an actor that arrives beside it.
Parameters
| Parameter | Type |
|---|---|
batch | CampaignMapBatch |
Returns
CampaignMapCounts
minimize()
minimize(probeId: string): Promise<MinimizationResult>;
Parameters
| Parameter | Type |
|---|---|
probeId | string |
Returns
Promise<MinimizationResult>
propose()
propose(input: ProposalInput): AssuranceProbe[];
Parameters
| Parameter | Type |
|---|---|
input | ProposalInput |
Returns
run()
run(probeIds?: string[]): Promise<AuthorizationCampaignReport>;
Parameters
| Parameter | Type |
|---|---|
probeIds? | string[] |
Returns
Promise<AuthorizationCampaignReport>
spec()
spec(probeIds?: string[]): AuthorizationCampaignSpec;
Parameters
| Parameter | Type |
|---|---|
probeIds? | string[] |
Returns
verifyRules()
verifyRules(options: {
id?: string;
includeCandidates?: boolean;
rules: {
firestore?: string;
rtdb?: {
rules: Record<string, unknown>;
};
rtdbInstances?: Record<string, {
rules: Record<string, unknown>;
}>;
storage?: string;
storageBuckets?: Record<string, string>;
};
}): Promise<AuthorizationCampaignReport>;
Parameters
| Parameter | Type |
|---|---|
options | { id?: string; includeCandidates?: boolean; rules: { firestore?: string; rtdb?: { rules: Record<string, unknown>; }; rtdbInstances?: Record<string, { rules: Record<string, unknown>; }>; storage?: string; storageBuckets?: Record<string, string>; }; } |
options.id? | string |
options.includeCandidates? | boolean |
options.rules | { firestore?: string; rtdb?: { rules: Record<string, unknown>; }; rtdbInstances?: Record<string, { rules: Record<string, unknown>; }>; storage?: string; storageBuckets?: Record<string, string>; } |
options.rules.firestore? | string |
options.rules.rtdb? | { rules: Record<string, unknown>; } |
options.rules.rtdb.rules | Record<string, unknown> |
options.rules.rtdbInstances? | Record<string, { rules: Record<string, unknown>; }> |
options.rules.storage? | string |
options.rules.storageBuckets? | Record<string, string> |
Returns
Promise<AuthorizationCampaignReport>
visualization()
visualization(): AssuranceVisualizationSnapshot;
Returns
AssuranceVisualizationSnapshot
Interfaces
ActorEvidence
Properties
AssuranceActor
Properties
| Property | Type |
|---|---|
acquisition | ActorAcquisition |
id | string |
AssuranceAttachment
Properties
| Property | Type |
|---|---|
coverageGaps | AssuranceCoverageGap[] |
inventory | AssuranceAttachmentInventory |
source | AssuranceAttachmentSource |
target | LocalFirebaseTarget |
AssuranceAttachmentInput
Properties
AssuranceAttachmentInventory
Properties
AssuranceAttachmentSource
Properties
AssuranceCampaignContext
Properties
| Property | Type |
|---|---|
attachment? | { coverageGaps: AssuranceCoverageGap[]; inventory: AssuranceAttachmentInventory; source: AssuranceAttachmentSource; } |
attachment.coverageGaps | AssuranceCoverageGap[] |
attachment.inventory | AssuranceAttachmentInventory |
attachment.source | AssuranceAttachmentSource |
AssuranceCoverageGap
Properties
| Property | Type |
|---|---|
code | string |
reason | string |
service | "auth" | AssuranceService | "attachment" |
AssuranceEventEvidence
Properties
AssuranceObservation
Properties
| Property | Type |
|---|---|
actorId | string |
description? | string |
id | string |
operation | FirebaseOperation |
result | "ALLOW" |
source | "captured" | "authored" | "discovered" |
AssuranceProbe
Properties
| Property | Type | Description |
|---|---|---|
actorId | string | - |
control | FirebaseOperation | - |
id | string | - |
invariantId | string | - |
mutation | ProbeMutation | - |
requires? | CapabilityDependency[] | Graph nodes this probe’s verdict depends on. Each is resolved live against the conformance graph statuses: a node the graph derives non-supported makes the engine abstain (engine-gap), and a node the graph does not model is a campaign authoring error (invalid-probe). |
AssuranceProbeResult
Properties
| Property | Type |
|---|---|
actorEvidence | ActorEvidence |
campaignId | string |
classification | ProbeClassification |
control | OperationEvidence |
invariant | SecurityInvariant |
mutation | OperationEvidence |
mutationSpec | ProbeMutation |
probeId | string |
qualification | EngineQualification |
stateDiff? | StateDiff |
targetHash | string |
AssuranceReportSummary
Properties
| Property | Type |
|---|---|
candidateSignals | number |
controlsPassed | number |
engineGaps | number |
invalidProbes | number |
localCounterexamples | number |
noCounterexamples | number |
probes | number |
AssuranceToolDeps
Properties
| Property | Type |
|---|---|
attachmentProvider? | AssuranceAttachmentProvider |
fetchImpl? | typeof fetch |
onCampaignUpdate? | (campaign: AssuranceVisualizationSnapshot) => void |
projectDir? | string |
sandbox? | LocalSandbox |
store? | AssuranceCampaignStore |
AssuranceVisualizationSnapshot
Credential-free projection safe to hand to Studio visualization code.
Properties
| Property | Type |
|---|---|
campaignId | string |
context? | AssuranceCampaignContext |
observations | AssuranceObservation[] |
probes | AssuranceProbe[] |
report? | AuthorizationCampaignReport |
schema | "pyric.assurance.visualization.v1" |
verifications? | AuthorizationCampaignReport[] |
AuthFixtureUser
Properties
AuthorizationCampaignReport
Properties
| Property | Type |
|---|---|
campaignId | string |
localOnly | { engine: "pyric-local-sandboxes"; network: "forbid"; } |
localOnly.engine | "pyric-local-sandboxes" |
localOnly.network | "forbid" |
results | AssuranceProbeResult[] |
schema | "pyric.assurance.report.v1" |
summary | AssuranceReportSummary |
targetHash | string |
AuthorizationCampaignSpec
Properties
| Property | Type |
|---|---|
actors | AssuranceActor[] |
id | string |
invariants | SecurityInvariant[] |
probes | AssuranceProbe[] |
schema | "pyric.assurance.campaign.v1" |
target | LocalFirebaseTarget |
CampaignExport
Properties
| Property | Type |
|---|---|
campaign | AuthorizationCampaignSpec |
cases | SecurityCase[] |
context? | AssuranceCampaignContext |
observations | AssuranceObservation[] |
report? | AuthorizationCampaignReport |
schema | "pyric.assurance.export.v1" |
verifications? | AuthorizationCampaignReport[] |
CapabilityRequirement
Properties
CreateAuthorizationCampaignOptions
Properties
| Property | Type |
|---|---|
context? | AssuranceCampaignContext |
id | string |
safety? | { maxRuns?: number; network?: "forbid"; } |
safety.maxRuns? | number |
safety.network? | "forbid" |
target | LocalFirebaseTarget |
DeriveAssuranceDeps
Properties
| Property | Modifier | Type |
|---|---|---|
attachmentProvider? | readonly | AssuranceAttachmentProvider |
fetchImpl? | readonly | typeof fetch |
projectDir? | readonly | string |
sandbox? | readonly | LocalSandbox |
store? | readonly | AssuranceCampaignStore |
DeriveAssuranceInput
Properties
| Property | Modifier | Type |
|---|---|---|
campaignId? | readonly | string |
includeHeuristic? | readonly | boolean |
includeStaticChecks? | readonly | boolean |
root? | readonly | string |
url? | readonly | string |
DeriveAssuranceResult
Properties
| Property | Modifier | Type |
|---|---|---|
campaignId | readonly | string |
counts | readonly | DeriveDiagnosticCounts |
diagnostics | readonly | AssuranceDiagnostic[] |
studioUrl? | readonly | string |
DeriveDiagnosticCounts
Properties
| Property | Modifier | Type |
|---|---|---|
byCertainty | readonly | Readonly<Record<DiagnosticCertainty, number>> |
bySeverity | readonly | Readonly<Record<DiagnosticSeverity, number>> |
total | readonly | number |
EngineQualification
Properties
| Property | Type | Description |
|---|---|---|
classification? | "engine-gap" | "invalid-probe" | How an unsupported qualification must be classified. Absent when the qualification is supported. engine-gap is the default abstention (a target-specific check failed, or a required graph node is derived non-supported); invalid-probe overrides it when the campaign names a graph node the engine does not know. |
engine | "pyric-local-sandboxes" | - |
requirements | CapabilityRequirement[] | - |
supported | boolean | - |
FirestoreOperation
Properties
| Property | Type |
|---|---|
data? | Record<string, unknown> |
method | "delete" | "get" | "list" | "create" | "update" | "set" | "merge" |
path | string |
query? | { limit?: number; orderBy?: { direction?: "asc" | "desc"; field: string; }[]; where?: FirestoreQueryConstraint[]; } |
query.limit? | number |
query.orderBy? | { direction?: "asc" | "desc"; field: string; }[] |
query.where? | FirestoreQueryConstraint[] |
service | "firestore" |
FirestoreQueryConstraint
Properties
| Property | Type |
|---|---|
field | string |
op | | "<" | "<=" | "==" | "!=" | ">=" | ">" | "in" | "not-in" | "array-contains" | "array-contains-any" |
value | unknown |
LocalFirebaseTarget
Properties
| Property | Type |
|---|---|
network | "forbid" |
rules | { firestore?: string; rtdb?: { rules: Record<string, unknown>; }; rtdbInstances?: Record<string, { rules: Record<string, unknown>; }>; storage?: string; storageBuckets?: Record<string, string>; } |
rules.firestore? | string |
rules.rtdb? | { rules: Record<string, unknown>; } |
rules.rtdb.rules | Record<string, unknown> |
rules.rtdbInstances? | Record<string, { rules: Record<string, unknown>; }> |
rules.storage? | string |
rules.storageBuckets? | Record<string, string> |
schema | "pyric.assurance.target.v1" |
state | { auth?: { providers?: Record<string, boolean>; users: AuthFixtureUser[]; }; firestore?: Record<string, Record<string, unknown>>; rtdb?: unknown; rtdbInstances?: Record<string, unknown>; storage?: StorageObjectFixture[]; storageBuckets?: Record<string, StorageObjectFixture[]>; storageConfig?: { crossServiceIam?: "granted" | "denied"; undeployedBucketPolicy?: "allow" | "deny"; }; } |
state.auth? | { providers?: Record<string, boolean>; users: AuthFixtureUser[]; } |
state.auth.providers? | Record<string, boolean> |
state.auth.users | AuthFixtureUser[] |
state.firestore? | Record<string, Record<string, unknown>> |
state.rtdb? | unknown |
state.rtdbInstances? | Record<string, unknown> |
state.storage? | StorageObjectFixture[] |
state.storageBuckets? | Record<string, StorageObjectFixture[]> |
state.storageConfig? | { crossServiceIam?: "granted" | "denied"; undeployedBucketPolicy?: "allow" | "deny"; } |
state.storageConfig.crossServiceIam? | "granted" | "denied" |
state.storageConfig.undeployedBucketPolicy? | "allow" | "deny" |
MinimizationResult
Properties
| Property | Type |
|---|---|
changed | boolean |
probe | AssuranceProbe |
probeId | string |
removedPayloadFields | string[] |
result | AssuranceProbeResult |
MutationCandidate
Extends
Properties
| Property | Type |
|---|---|
description | string |
dimension | MutationDimension |
id? | string |
operation | FirebaseOperation |
OperationEvidence
Properties
| Property | Type |
|---|---|
decision | AssuranceDecision |
error? | { code?: string; message: string; } |
error.code? | string |
error.message | string |
events | AssuranceEventEvidence[] |
operation | FirebaseOperation |
output? | unknown |
ProbeMutation
Extended by
Properties
| Property | Type |
|---|---|
description | string |
dimension | MutationDimension |
operation | FirebaseOperation |
ProposalInput
Properties
| Property | Type |
|---|---|
invariantId | string |
mutations | MutationCandidate[] |
observationId | string |
RtdbOperation
Properties
RunSecurityCasesInput
Properties
| Property | Type |
|---|---|
actors | AssuranceActor[] |
campaignId | string |
cases | SecurityCase[] |
target | LocalFirebaseTarget |
SandboxAttachmentProviderOptions
Properties
SecurityCase
Properties
| Property | Type |
|---|---|
actorId | string |
campaignId | string |
control | FirebaseOperation |
expect | "ALLOW" | "DENY" |
id | string |
invariant | SecurityInvariant |
mutation | ProbeMutation |
qualification | EngineQualification |
requires? | CapabilityDependency[] |
schema | "pyric.assurance.case.v1" |
SecurityInvariant
Properties
| Property | Type |
|---|---|
confidence | "authoritative" | "strong" | "tentative" |
expected | "ALLOW" | "DENY" |
id | string |
service | AssuranceService | "cross-service" |
source | "agent" | "captured" | "declared" | "authored-test" | "derived" |
statement | string |
StateDiff
Properties
StorageObjectFixture
Properties
StorageOperation
Properties
Type Aliases
ActorAcquisition
type ActorAcquisition =
| {
kind: "anonymous-request";
}
| {
kind: "anonymous-account";
}
| {
email: string;
kind: "password";
password: string;
}
| {
kind: "fixture-user";
uid: string;
}
| {
kind: "synthetic";
token?: Record<string, unknown>;
uid: string;
};
AssuranceAttachmentProvider()
type AssuranceAttachmentProvider = (input: AssuranceAttachmentInput) => Promise<AssuranceAttachment>;
Parameters
| Parameter | Type |
|---|---|
input | AssuranceAttachmentInput |
Returns
Promise<AssuranceAttachment>
AssuranceDecision
type AssuranceDecision = "ALLOW" | "DENY" | "ERROR" | "UNSUPPORTED";
AssuranceService
type AssuranceService = "firestore" | "rtdb" | "storage";
FirebaseOperation
type FirebaseOperation =
| FirestoreOperation
| RtdbOperation
| StorageOperation;
MutationDimension
type MutationDimension = "path" | "query" | "payload" | "operation";
ProbeClassification
type ProbeClassification =
| "local-counterexample"
| "candidate-signal"
| "no-counterexample"
| "engine-gap"
| "invalid-probe";
Variables
ASSURANCE_CAMPAIGN_SCHEMA
const ASSURANCE_CAMPAIGN_SCHEMA: "pyric.assurance.campaign.v1";
ASSURANCE_REPORT_SCHEMA
const ASSURANCE_REPORT_SCHEMA: "pyric.assurance.report.v1";
ASSURANCE_TARGET_SCHEMA
const ASSURANCE_TARGET_SCHEMA: "pyric.assurance.target.v1";
defaultAssuranceCampaignStore
const defaultAssuranceCampaignStore: AssuranceCampaignStore;
Functions
createAssuranceTools()
function createAssuranceTools(deps?: AssuranceToolDeps): ToolHandler<unknown, unknown>[];
Parameters
| Parameter | Type |
|---|---|
deps? | AssuranceToolDeps |
Returns
ToolHandler<unknown, unknown>[]
createAuthorizationCampaign()
function createAuthorizationCampaign(options: CreateAuthorizationCampaignOptions): AuthorizationCampaign;
Parameters
| Parameter | Type |
|---|---|
options | CreateAuthorizationCampaignOptions |
Returns
createSandboxAttachmentProvider()
function createSandboxAttachmentProvider(sandbox: Sandbox, options?: SandboxAttachmentProviderOptions): AssuranceAttachmentProvider;
Clone the sandbox currently hosting the connected bridge peer. The URL is an origin assertion and source for explicit rules metadata; no arbitrary host is contacted and the returned campaign target itself keeps networking forbidden.
Parameters
| Parameter | Type |
|---|---|
sandbox | Sandbox |
options? | SandboxAttachmentProviderOptions |
Returns
deriveAssurance()
function deriveAssurance(input?: DeriveAssuranceInput, deps?: DeriveAssuranceDeps): Promise<DeriveAssuranceResult>;
Parameters
| Parameter | Type |
|---|---|
input? | DeriveAssuranceInput |
deps? | DeriveAssuranceDeps |
Returns
Promise<DeriveAssuranceResult>
qualifyProbe()
function qualifyProbe(target: LocalFirebaseTarget, probe: AssuranceProbe): EngineQualification;
Parameters
| Parameter | Type |
|---|---|
target | LocalFirebaseTarget |
probe | AssuranceProbe |
Returns
runAuthorizationCampaign()
function runAuthorizationCampaign(spec: AuthorizationCampaignSpec): Promise<AuthorizationCampaignReport>;
Parameters
| Parameter | Type |
|---|---|
spec | AuthorizationCampaignSpec |
Returns
Promise<AuthorizationCampaignReport>
runSecurityCases()
function runSecurityCases(input: RunSecurityCasesInput): Promise<AuthorizationCampaignReport>;
Re-run exported expectations against a candidate local target. Each case keeps its known-good control and explicit negative expectation, so a rules change must preserve the application workflow and reject the boundary case.
Parameters
| Parameter | Type |
|---|---|
input | RunSecurityCasesInput |
Returns
Promise<AuthorizationCampaignReport>
runStaticAssurancePasses()
function runStaticAssurancePasses(project: LoadedAssuranceProject, runtime?: LiveRuntimeClone): AssuranceDiagnostic[];
Parameters
| Parameter | Type |
|---|---|
project | LoadedAssuranceProject |
runtime? | LiveRuntimeClone |
Returns
AssuranceDiagnostic[]
summarizeDiagnosticCounts()
function summarizeDiagnosticCounts(diagnostics: readonly AssuranceDiagnostic[]): DeriveDiagnosticCounts;
Parameters
| Parameter | Type |
|---|---|
diagnostics | readonly AssuranceDiagnostic[] |
Returns
References
ASSURANCE_BROADCAST_CHANNEL
Re-exports ASSURANCE_BROADCAST_CHANNEL
ASSURANCE_BROWSER_EVENT
Re-exports ASSURANCE_BROWSER_EVENT
publishAssuranceVisualization
Re-exports publishAssuranceVisualization
subscribeAssuranceVisualizations
Re-exports subscribeAssuranceVisualizations