canic_host/deployment_truth/
model.rs

1use serde::{Deserialize, Serialize};
2
3///
4/// DeploymentPlanV1
5///
6#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
7pub struct DeploymentPlanV1 {
8    pub schema_version: u32,
9    pub plan_id: String,
10    pub deployment_identity: DeploymentIdentityV1,
11    pub trust_domain: TrustDomainV1,
12    pub fleet_template: String,
13    pub runtime_variant: String,
14    pub authority_profile: AuthorityProfileV1,
15    pub role_artifacts: Vec<RoleArtifactV1>,
16    pub expected_canisters: Vec<ExpectedCanisterV1>,
17    pub expected_pool: Vec<ExpectedPoolCanisterV1>,
18    pub expected_verifier_readiness: VerifierReadinessExpectationV1,
19    pub unresolved_assumptions: Vec<DeploymentAssumptionV1>,
20}
21
22///
23/// DeploymentInventoryV1
24///
25#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
26pub struct DeploymentInventoryV1 {
27    pub schema_version: u32,
28    pub inventory_id: String,
29    pub observed_at: String,
30    pub observed_identity: Option<DeploymentIdentityV1>,
31    pub local_config: LocalDeploymentConfigV1,
32    pub observed_canisters: Vec<ObservedCanisterV1>,
33    pub observed_pool: Vec<ObservedPoolCanisterV1>,
34    pub observed_artifacts: Vec<ObservedArtifactV1>,
35    pub observed_verifier_readiness: VerifierReadinessObservationV1,
36    pub unresolved_observations: Vec<DeploymentObservationGapV1>,
37}
38
39///
40/// DeploymentReceiptV1
41///
42#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
43pub struct DeploymentReceiptV1 {
44    pub schema_version: u32,
45    pub operation_id: String,
46    pub plan_id: String,
47    pub execution_context: Option<DeploymentExecutionContextV1>,
48    pub operation_status: DeploymentExecutionStatusV1,
49    pub started_at: String,
50    pub finished_at: Option<String>,
51    pub operator_principal: Option<String>,
52    pub root_principal: Option<String>,
53    pub previous_observed_deployment_epoch: Option<u64>,
54    pub phase_receipts: Vec<PhaseReceiptV1>,
55    pub role_phase_receipts: Vec<RolePhaseReceiptV1>,
56    pub final_inventory_id: Option<String>,
57    pub command_result: DeploymentCommandResultV1,
58}
59
60///
61/// DeploymentExecutionContextV1
62///
63#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
64pub struct DeploymentExecutionContextV1 {
65    pub workspace_root: Option<String>,
66    pub icp_root: Option<String>,
67    pub artifact_roots: Vec<String>,
68    pub backend: DeploymentExecutorBackendV1,
69    pub backend_capabilities: Vec<DeploymentExecutorCapabilityV1>,
70}
71
72///
73/// DeploymentExecutionPreflightV1
74///
75#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
76pub struct DeploymentExecutionPreflightV1 {
77    pub schema_version: u32,
78    pub plan_id: String,
79    pub safety_report_id: String,
80    pub authority_plan_id: String,
81    pub backend: DeploymentExecutorBackendV1,
82    pub status: DeploymentExecutionPreflightStatusV1,
83    pub planned_phases: Vec<String>,
84    pub required_capabilities: Vec<DeploymentExecutorCapabilityV1>,
85    pub missing_capabilities: Vec<DeploymentExecutorCapabilityV1>,
86    pub blockers: Vec<SafetyFindingV1>,
87}
88
89///
90/// DeploymentExecutionPreflightStatusV1
91///
92#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
93pub enum DeploymentExecutionPreflightStatusV1 {
94    Ready,
95    Blocked,
96}
97
98///
99/// DeploymentExecutorBackendV1
100///
101#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
102pub enum DeploymentExecutorBackendV1 {
103    CurrentCli,
104    PocketIc,
105    DirectAgent,
106    Other { name: String },
107}
108
109///
110/// DeploymentExecutorCapabilityV1
111///
112#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
113pub enum DeploymentExecutorCapabilityV1 {
114    CreateCanister,
115    CanisterStatus,
116    UpdateSettings,
117    InstallCode,
118    Call,
119    Query,
120    StageArtifact,
121}
122
123///
124/// ArtifactTransportV1
125///
126#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
127pub enum ArtifactTransportV1 {
128    LocalCli,
129    WasmStore,
130    DirectAgent,
131}
132
133///
134/// StagingReceiptV1
135///
136#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
137pub struct StagingReceiptV1 {
138    pub schema_version: u32,
139    pub role: String,
140    pub artifact_identity: String,
141    pub transport: ArtifactTransportV1,
142    pub wasm_store_locator: Option<String>,
143    pub prepared_chunk_hashes: Vec<String>,
144    pub published_chunk_count: usize,
145    pub verified_postcondition: VerifiedPostconditionV1,
146}
147
148///
149/// RoleArtifactSourceV1
150///
151#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
152pub struct RoleArtifactSourceV1 {
153    pub role: String,
154    pub kind: RoleArtifactSourceKindV1,
155    pub locator: Option<String>,
156    pub previous_receipt_kind: Option<PreviousArtifactReceiptKindV1>,
157    pub previous_receipt_lineage_digest: Option<String>,
158    pub expected_wasm_sha256: Option<String>,
159    pub expected_wasm_gz_sha256: Option<String>,
160    pub expected_candid_sha256: Option<String>,
161    pub expected_canonical_embedded_config_sha256: Option<String>,
162}
163
164///
165/// RolePromotionInputV1
166///
167#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
168pub struct RolePromotionInputV1 {
169    pub role: String,
170    pub promotion_level: PromotionArtifactLevelV1,
171    pub source: RoleArtifactSourceV1,
172    pub require_byte_identical_wasm: bool,
173    pub require_target_embedded_config: bool,
174    pub target_store_has_artifact: Option<bool>,
175}
176
177///
178/// RolePromotionPolicyV1
179///
180#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
181pub struct RolePromotionPolicyV1 {
182    pub role: String,
183    pub allowed_promotion_levels: Vec<PromotionArtifactLevelV1>,
184    pub requirements: Vec<PromotionPolicyRequirementV1>,
185}
186
187///
188/// PromotionPolicyRequirementV1
189///
190#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
191pub enum PromotionPolicyRequirementV1 {
192    SameSourceRevision,
193    SameCargoFeatures,
194    TargetConfigDigest,
195    ByteIdenticalWasm,
196    SealedBytes,
197}
198
199///
200/// PromotionPolicyClaimV1
201///
202#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
203pub enum PromotionPolicyClaimV1 {
204    ByteIdenticalWasm,
205    TargetConfigDigest,
206}
207
208///
209/// PromotionPolicyCheckV1
210///
211#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
212pub struct PromotionPolicyCheckV1 {
213    pub schema_version: u32,
214    pub check_id: String,
215    pub promotion_policy_check_digest: String,
216    pub status: PromotionReadinessStatusV1,
217    pub roles: Vec<RolePromotionPolicyDecisionV1>,
218    pub blockers: Vec<SafetyFindingV1>,
219}
220
221///
222/// RolePromotionPolicyDecisionV1
223///
224#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
225pub struct RolePromotionPolicyDecisionV1 {
226    pub role: String,
227    pub requested_promotion_level: PromotionArtifactLevelV1,
228    pub allowed_promotion_levels: Vec<PromotionArtifactLevelV1>,
229    pub requirements: Vec<PromotionPolicyRequirementV1>,
230    pub claims: Vec<PromotionPolicyClaimV1>,
231    pub level_allowed: bool,
232    pub policy_satisfied: bool,
233}
234
235///
236/// PromotionArtifactLevelV1
237///
238#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
239pub enum PromotionArtifactLevelV1 {
240    SealedWasm,
241    SourceBuild,
242}
243
244///
245/// BuildRecipeIdentityV1
246///
247#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
248pub struct BuildRecipeIdentityV1 {
249    pub recipe_id: String,
250    pub source_kind: RoleArtifactSourceKindV1,
251    pub source_revision: String,
252    pub source_tree_clean: bool,
253    pub package_or_role_selector: String,
254    pub cargo_profile: String,
255    pub cargo_features_digest: String,
256    pub cargo_lock_digest: String,
257    pub rust_toolchain: String,
258    pub builder_version: String,
259    pub target_triple: String,
260    pub linker_identity: String,
261    pub deterministic_build_mode: String,
262    pub wasm_opt_version: String,
263    pub compression_identity: String,
264}
265
266///
267/// BuildMaterializationInputV1
268///
269#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
270pub struct BuildMaterializationInputV1 {
271    pub materialization_input_id: String,
272    pub build_recipe_id: String,
273    pub canonical_embedded_config_sha256: String,
274    pub network: String,
275    pub root_trust_anchor: String,
276    pub runtime_variant: String,
277}
278
279///
280/// BuildMaterializationResultV1
281///
282#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
283pub struct BuildMaterializationResultV1 {
284    pub materialization_result_id: String,
285    pub build_recipe_id: String,
286    pub materialization_input_digest: String,
287    pub wasm_sha256: String,
288    pub wasm_gz_sha256: String,
289    pub installed_module_hash: String,
290    pub candid_sha256: String,
291}
292
293///
294/// BuildMaterializationEvidenceV1
295///
296#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
297pub struct BuildMaterializationEvidenceV1 {
298    pub schema_version: u32,
299    pub evidence_id: String,
300    pub materialization_evidence_digest: String,
301    pub recipe: BuildRecipeIdentityV1,
302    pub materialization_input: BuildMaterializationInputV1,
303    pub materialization_result: BuildMaterializationResultV1,
304    pub computed_materialization_input_digest: String,
305    pub recipe_id_matches_input: bool,
306    pub recipe_id_matches_result: bool,
307    pub materialization_input_digest_matches_result: bool,
308}
309
310///
311/// PromotionMaterializationIdentityReportV1
312///
313#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
314pub struct PromotionMaterializationIdentityReportV1 {
315    pub schema_version: u32,
316    pub report_id: String,
317    pub materialization_identity_report_digest: String,
318    pub status: PromotionReadinessStatusV1,
319    pub roles: Vec<RolePromotionMaterializationIdentityV1>,
320    pub output_groups: Vec<PromotionMaterializationOutputGroupV1>,
321    pub blockers: Vec<SafetyFindingV1>,
322}
323
324///
325/// RolePromotionMaterializationIdentityV1
326///
327#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
328pub struct RolePromotionMaterializationIdentityV1 {
329    pub role: String,
330    pub evidence_id: String,
331    pub materialization_evidence_digest: String,
332    pub recipe_id: String,
333    pub materialization_input_id: String,
334    pub materialization_result_id: String,
335    pub materialization_input_digest: String,
336    pub canonical_embedded_config_sha256: String,
337    pub network: String,
338    pub root_trust_anchor: String,
339    pub runtime_variant: String,
340    pub wasm_sha256: String,
341    pub wasm_gz_sha256: String,
342    pub installed_module_hash: String,
343    pub candid_sha256: String,
344}
345
346///
347/// PromotionMaterializationOutputGroupV1
348///
349#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
350pub struct PromotionMaterializationOutputGroupV1 {
351    pub output_identity_key: String,
352    pub roles: Vec<String>,
353    pub wasm_sha256: String,
354    pub wasm_gz_sha256: String,
355    pub installed_module_hash: String,
356    pub candid_sha256: String,
357}
358
359///
360/// PromotionArtifactIdentityReportV1
361///
362#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
363pub struct PromotionArtifactIdentityReportV1 {
364    pub schema_version: u32,
365    pub report_id: String,
366    pub artifact_identity_report_digest: String,
367    pub status: PromotionReadinessStatusV1,
368    pub summary: PromotionArtifactIdentitySummaryV1,
369    pub roles: Vec<RolePromotionArtifactIdentityV1>,
370    pub identity_groups: Vec<PromotionArtifactIdentityGroupV1>,
371    pub blockers: Vec<SafetyFindingV1>,
372}
373
374///
375/// PromotionArtifactIdentitySummaryV1
376///
377#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
378pub struct PromotionArtifactIdentitySummaryV1 {
379    pub role_count: usize,
380    pub identity_group_count: usize,
381    pub shared_identity_group_count: usize,
382    pub digest_pinned_role_count: usize,
383    pub source_build_role_count: usize,
384    pub deferred_identity_role_count: usize,
385}
386
387///
388/// PromotionWasmStoreIdentityReportV1
389///
390#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
391pub struct PromotionWasmStoreIdentityReportV1 {
392    pub schema_version: u32,
393    pub report_id: String,
394    pub wasm_store_identity_report_digest: String,
395    pub status: PromotionReadinessStatusV1,
396    pub roles: Vec<RolePromotionWasmStoreIdentityV1>,
397    pub blockers: Vec<SafetyFindingV1>,
398}
399
400///
401/// RolePromotionWasmStoreIdentityV1
402///
403#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
404pub struct RolePromotionWasmStoreIdentityV1 {
405    pub role: String,
406    pub artifact_identity: String,
407    pub transport: ArtifactTransportV1,
408    pub wasm_store_locator: Option<String>,
409    pub prepared_chunk_hashes: Vec<String>,
410    pub published_chunk_count: usize,
411    pub verified_postcondition: VerifiedPostconditionV1,
412}
413
414///
415/// PromotionWasmStoreCatalogEntryV1
416///
417#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
418pub struct PromotionWasmStoreCatalogEntryV1 {
419    pub locator: String,
420    pub artifact_identity: String,
421    pub published_chunk_count: usize,
422}
423
424///
425/// PromotionWasmStoreCatalogVerificationV1
426///
427#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
428pub struct PromotionWasmStoreCatalogVerificationV1 {
429    pub schema_version: u32,
430    pub verification_id: String,
431    pub wasm_store_catalog_verification_digest: String,
432    pub wasm_store_identity_report_id: String,
433    pub status: PromotionReadinessStatusV1,
434    pub roles: Vec<RolePromotionWasmStoreCatalogVerificationV1>,
435    pub blockers: Vec<SafetyFindingV1>,
436}
437
438///
439/// RolePromotionWasmStoreCatalogVerificationV1
440///
441#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
442pub struct RolePromotionWasmStoreCatalogVerificationV1 {
443    pub role: String,
444    pub wasm_store_locator: String,
445    pub expected_artifact_identity: String,
446    pub observed_artifact_identity: Option<String>,
447    pub expected_published_chunk_count: usize,
448    pub observed_published_chunk_count: Option<usize>,
449    pub catalog_entry_present: bool,
450    pub catalog_matches: bool,
451    pub catalog_observation_digest: String,
452}
453
454///
455/// PromotionArtifactIdentityGroupV1
456///
457#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
458pub struct PromotionArtifactIdentityGroupV1 {
459    pub identity_key: String,
460    pub identity_kind: PromotionArtifactIdentityKindV1,
461    pub roles: Vec<String>,
462    pub source_kinds: Vec<RoleArtifactSourceKindV1>,
463    pub source_locators: Vec<String>,
464    pub digest_pinned: bool,
465    pub wasm_sha256: Option<String>,
466    pub wasm_gz_sha256: Option<String>,
467    pub candid_sha256: Option<String>,
468    pub canonical_embedded_config_sha256: Option<String>,
469}
470
471///
472/// RolePromotionArtifactIdentityV1
473///
474#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
475pub struct RolePromotionArtifactIdentityV1 {
476    pub role: String,
477    pub promotion_level: PromotionArtifactLevelV1,
478    pub source_kind: RoleArtifactSourceKindV1,
479    pub source_locator: Option<String>,
480    pub identity_kind: PromotionArtifactIdentityKindV1,
481    pub digest_pinned: bool,
482    pub wasm_sha256: Option<String>,
483    pub wasm_gz_sha256: Option<String>,
484    pub candid_sha256: Option<String>,
485    pub canonical_embedded_config_sha256: Option<String>,
486}
487
488///
489/// PromotionArtifactIdentityKindV1
490///
491#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
492pub enum PromotionArtifactIdentityKindV1 {
493    SealedWasm,
494    SealedCompressedWasm,
495    SealedWasmAndCompressedWasm,
496    SourceBuild,
497    Deferred,
498}
499
500///
501/// PromotionReadinessV1
502///
503#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
504pub struct PromotionReadinessV1 {
505    pub schema_version: u32,
506    pub readiness_id: String,
507    pub promotion_readiness_digest: String,
508    pub target_plan_id: String,
509    pub status: PromotionReadinessStatusV1,
510    pub roles: Vec<RolePromotionReadinessV1>,
511    pub blockers: Vec<SafetyFindingV1>,
512    pub warnings: Vec<SafetyFindingV1>,
513}
514
515///
516/// PromotionPlanTransformV1
517///
518#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
519pub struct PromotionPlanTransformV1 {
520    pub schema_version: u32,
521    pub transform_id: String,
522    pub target_plan_id: String,
523    pub promoted_plan_id: String,
524    pub promotion_plan_lineage_digest: String,
525    pub promoted_plan: DeploymentPlanV1,
526    pub roles: Vec<RolePromotionPlanTransformV1>,
527}
528
529///
530/// ArtifactPromotionPlanV1
531///
532#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
533pub struct ArtifactPromotionPlanV1 {
534    pub schema_version: u32,
535    pub plan_id: String,
536    pub artifact_promotion_plan_digest: String,
537    pub generated_at: String,
538    pub status: PromotionReadinessStatusV1,
539    pub target_plan_id: String,
540    pub promoted_plan_id: String,
541    pub promotion_plan_lineage_digest: String,
542    pub readiness: PromotionReadinessV1,
543    pub artifact_identity_report: PromotionArtifactIdentityReportV1,
544    pub transform: PromotionPlanTransformV1,
545    pub target_execution_lineage: Option<PromotionTargetExecutionLineageV1>,
546    pub blockers: Vec<SafetyFindingV1>,
547}
548
549///
550/// ArtifactPromotionProvenanceReportV1
551///
552#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
553pub struct ArtifactPromotionProvenanceReportV1 {
554    pub schema_version: u32,
555    pub report_id: String,
556    pub status: PromotionReadinessStatusV1,
557    pub artifact_promotion_plan_id: String,
558    pub artifact_promotion_plan_digest: String,
559    pub target_plan_id: String,
560    pub promoted_plan_id: String,
561    pub promotion_plan_lineage_digest: String,
562    pub provenance_report_digest: String,
563    pub readiness_id: String,
564    pub artifact_identity_report_id: String,
565    pub transform_id: String,
566    pub target_execution_lineage_id: Option<String>,
567    pub wasm_store_identity_report_id: Option<String>,
568    pub wasm_store_identity_report_digest: Option<String>,
569    pub wasm_store_catalog_verification_id: Option<String>,
570    pub wasm_store_catalog_verification_digest: Option<String>,
571    pub materialization_identity_report_id: Option<String>,
572    pub materialization_identity_report_digest: Option<String>,
573    pub execution_attempted: bool,
574    pub roles: Vec<RolePromotionProvenanceV1>,
575    pub blockers: Vec<SafetyFindingV1>,
576}
577
578///
579/// ArtifactPromotionExecutionReceiptV1
580///
581#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
582pub struct ArtifactPromotionExecutionReceiptV1 {
583    pub schema_version: u32,
584    pub receipt_id: String,
585    pub execution_receipt_digest: String,
586    pub artifact_promotion_plan_id: String,
587    pub artifact_promotion_plan_digest: String,
588    pub provenance_report_id: String,
589    pub provenance_report_digest: String,
590    pub provenance_status: PromotionReadinessStatusV1,
591    pub promoted_plan_id: String,
592    pub promotion_plan_lineage_digest: String,
593    pub operation_id: String,
594    pub operation_status: DeploymentExecutionStatusV1,
595    pub command_result: DeploymentCommandResultV1,
596    pub started_at: String,
597    pub finished_at: Option<String>,
598    pub deployment_receipt: DeploymentReceiptV1,
599    pub roles: Vec<RolePromotionExecutionReceiptV1>,
600}
601
602///
603/// RolePromotionExecutionReceiptV1
604///
605#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
606pub struct RolePromotionExecutionReceiptV1 {
607    pub role: String,
608    pub promotion_level: PromotionArtifactLevelV1,
609    pub materialization_evidence_id: Option<String>,
610    pub materialization_evidence_digest: Option<String>,
611    pub wasm_store_locator: Option<String>,
612    pub wasm_store_catalog_observation_digest: Option<String>,
613    pub role_phase_result: Option<RolePhaseResultV1>,
614    pub artifact_digest: Option<String>,
615    pub observed_module_hash_after: Option<String>,
616    pub canonical_embedded_config_sha256: Option<String>,
617}
618
619///
620/// RolePromotionProvenanceV1
621///
622#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
623pub struct RolePromotionProvenanceV1 {
624    pub role: String,
625    pub promotion_level: PromotionArtifactLevelV1,
626    pub source_kind: RoleArtifactSourceKindV1,
627    pub artifact_identity_changed: bool,
628    pub embedded_config_changed: bool,
629    pub target_materialization_preserved: bool,
630    pub materialization_evidence_id: Option<String>,
631    pub materialization_evidence_digest: Option<String>,
632    pub wasm_store_locator: Option<String>,
633    pub wasm_store_catalog_observation_digest: Option<String>,
634}
635
636///
637/// PromotionPlanTransformEvidenceV1
638///
639#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
640pub struct PromotionPlanTransformEvidenceV1 {
641    pub schema_version: u32,
642    pub evidence_id: String,
643    pub promotion_plan_transform_evidence_digest: String,
644    pub generated_at: String,
645    pub transform: PromotionPlanTransformV1,
646}
647
648///
649/// PromotionTargetExecutionLineageV1
650///
651#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
652pub struct PromotionTargetExecutionLineageV1 {
653    pub schema_version: u32,
654    pub lineage_id: String,
655    pub generated_at: String,
656    pub target_execution_lineage_digest: String,
657    pub transform: PromotionPlanTransformV1,
658    pub execution_preflight: DeploymentExecutionPreflightV1,
659    pub execution_attempted: bool,
660}
661
662///
663/// RolePromotionPlanTransformV1
664///
665#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
666pub struct RolePromotionPlanTransformV1 {
667    pub role: String,
668    pub promotion_level: PromotionArtifactLevelV1,
669    pub source_kind: RoleArtifactSourceKindV1,
670    pub source_locator: Option<String>,
671    pub artifact_source_before: ArtifactSourceV1,
672    pub artifact_source_after: ArtifactSourceV1,
673    pub wasm_sha256_before: Option<String>,
674    pub wasm_sha256_after: Option<String>,
675    pub wasm_gz_sha256_before: Option<String>,
676    pub wasm_gz_sha256_after: Option<String>,
677    pub candid_sha256_before: Option<String>,
678    pub candid_sha256_after: Option<String>,
679    pub canonical_embedded_config_sha256_before: Option<String>,
680    pub canonical_embedded_config_sha256_after: Option<String>,
681    pub artifact_identity_changed: bool,
682    pub embedded_config_changed: bool,
683    pub target_materialization_preserved: bool,
684    pub source_build_materialization: Option<RolePromotionMaterializationLinkV1>,
685}
686
687///
688/// RolePromotionMaterializationLinkV1
689///
690#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
691pub struct RolePromotionMaterializationLinkV1 {
692    pub role: String,
693    pub evidence_id: String,
694    pub materialization_evidence_digest: String,
695    pub recipe_id: String,
696    pub materialization_input_id: String,
697    pub materialization_result_id: String,
698    pub materialization_input_digest: String,
699    pub wasm_sha256: String,
700    pub wasm_gz_sha256: String,
701    pub installed_module_hash: String,
702    pub candid_sha256: String,
703}
704
705///
706/// PromotionReadinessStatusV1
707///
708#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
709pub enum PromotionReadinessStatusV1 {
710    Ready,
711    Blocked,
712}
713
714///
715/// RolePromotionReadinessV1
716///
717#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
718pub struct RolePromotionReadinessV1 {
719    pub role: String,
720    pub promotion_level: PromotionArtifactLevelV1,
721    pub source_kind: RoleArtifactSourceKindV1,
722    pub source_locator: Option<String>,
723    pub source_wasm_sha256: Option<String>,
724    pub source_wasm_gz_sha256: Option<String>,
725    pub target_wasm_sha256: Option<String>,
726    pub target_wasm_gz_sha256: Option<String>,
727    pub source_canonical_embedded_config_sha256: Option<String>,
728    pub target_canonical_embedded_config_sha256: Option<String>,
729    pub byte_identical_wasm: Option<bool>,
730    pub embedded_config_identical: Option<bool>,
731    pub target_store_has_artifact: Option<bool>,
732    pub restage_required: bool,
733}
734
735///
736/// RoleArtifactSourceKindV1
737///
738#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
739pub enum RoleArtifactSourceKindV1 {
740    WorkspacePackage,
741    PublishedPackage,
742    LocalWasm,
743    LocalWasmGz,
744    PreviousReceiptArtifact,
745    CanonicalWasmStoreDefault,
746}
747
748///
749/// PreviousArtifactReceiptKindV1
750///
751#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
752pub enum PreviousArtifactReceiptKindV1 {
753    DeploymentReceipt,
754    StagingReceipt,
755}
756
757///
758/// AuthorityReceiptV1
759///
760#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
761pub struct AuthorityReceiptV1 {
762    pub schema_version: u32,
763    pub operation_id: String,
764    pub check_id: Option<String>,
765    pub reconciliation_plan_id: String,
766    pub authority_report_id: String,
767    pub inventory_id: String,
768    pub authority_profile_hash: Option<String>,
769    pub operation_status: DeploymentExecutionStatusV1,
770    pub started_at: String,
771    pub finished_at: Option<String>,
772    pub attempted_actions: Vec<AuthorityAttemptedActionV1>,
773    pub verified_controller_observations: Vec<AuthorityControllerObservationV1>,
774    pub hard_failures: Vec<SafetyFindingV1>,
775    pub unresolved_observation_gaps: Vec<DeploymentObservationGapV1>,
776    pub unresolved_external_actions: Vec<AuthorityExternalActionV1>,
777    pub command_result: DeploymentCommandResultV1,
778}
779
780///
781/// AuthorityDryRunEvidenceV1
782///
783#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
784pub struct AuthorityDryRunEvidenceV1 {
785    pub schema_version: u32,
786    pub evidence_id: String,
787    pub check_id: String,
788    pub generated_at: String,
789    pub reconciliation_plan: AuthorityReconciliationPlanV1,
790    pub authority_report: AuthorityReportV1,
791    pub authority_receipt: AuthorityReceiptV1,
792}
793
794///
795/// AuthorityAttemptedActionV1
796///
797#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
798pub struct AuthorityAttemptedActionV1 {
799    pub subject: String,
800    pub canister_id: Option<String>,
801    pub role: Option<String>,
802    pub action: AuthorityActionV1,
803    pub result: RolePhaseResultV1,
804    pub error: Option<String>,
805}
806
807///
808/// AuthorityControllerObservationV1
809///
810#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
811pub struct AuthorityControllerObservationV1 {
812    pub subject: String,
813    pub canister_id: Option<String>,
814    pub role: Option<String>,
815    pub state: AuthorityReconciliationStateV1,
816    pub action: AuthorityActionV1,
817    pub observed_controllers: Vec<String>,
818    pub desired_controllers: Vec<String>,
819    pub controller_delta: AuthorityControllerDeltaV1,
820}
821
822///
823/// RoleArtifactManifestV1
824///
825#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
826pub struct RoleArtifactManifestV1 {
827    pub schema_version: u32,
828    pub manifest_id: String,
829    pub network: String,
830    pub artifact_root: Option<String>,
831    pub role_artifacts: Vec<RoleArtifactV1>,
832    pub unresolved_artifacts: Vec<DeploymentObservationGapV1>,
833}
834
835///
836/// DeploymentDiffV1
837///
838#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
839pub struct DeploymentDiffV1 {
840    pub schema_version: u32,
841    pub plan_identity: DeploymentIdentityV1,
842    pub observed_identity: Option<DeploymentIdentityV1>,
843    pub artifact_diff: Vec<DiffItemV1>,
844    pub controller_diff: Vec<DiffItemV1>,
845    pub pool_diff: Vec<DiffItemV1>,
846    pub embedded_config_diff: Vec<DiffItemV1>,
847    pub module_hash_diff: Vec<DiffItemV1>,
848    pub verifier_readiness_diff: Vec<DiffItemV1>,
849    pub resume_safety: ResumeSafetyV1,
850    pub hard_failures: Vec<SafetyFindingV1>,
851    pub warnings: Vec<SafetyFindingV1>,
852    pub resumable_phases: Vec<String>,
853}
854
855///
856/// SafetyReportV1
857///
858#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
859pub struct SafetyReportV1 {
860    pub schema_version: u32,
861    pub report_id: String,
862    pub diff_id: Option<String>,
863    pub status: SafetyStatusV1,
864    pub summary: String,
865    pub hard_failures: Vec<SafetyFindingV1>,
866    pub warnings: Vec<SafetyFindingV1>,
867    pub next_actions: Vec<String>,
868}
869
870///
871/// DeploymentCheckV1
872///
873#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
874pub struct DeploymentCheckV1 {
875    pub schema_version: u32,
876    pub check_id: String,
877    pub plan: DeploymentPlanV1,
878    pub inventory: DeploymentInventoryV1,
879    pub diff: DeploymentDiffV1,
880    pub report: SafetyReportV1,
881}
882
883///
884/// LifecycleAuthorityReportV1
885///
886#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
887pub struct LifecycleAuthorityReportV1 {
888    pub schema_version: u32,
889    pub report_id: String,
890    pub report_digest: String,
891    pub check_id: String,
892    pub plan_id: String,
893    pub inventory_id: String,
894    pub authorities: Vec<LifecycleAuthorityV1>,
895    pub external_action_required_count: usize,
896    pub blocked_count: usize,
897}
898
899///
900/// LifecycleAuthorityV1
901///
902#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
903pub struct LifecycleAuthorityV1 {
904    pub subject: String,
905    pub canister_id: Option<String>,
906    pub role: Option<String>,
907    pub control_class: CanisterControlClassV1,
908    pub lifecycle_mode: LifecycleModeV1,
909    pub observed_controllers: Vec<String>,
910    pub expected_deployment_controllers: Vec<String>,
911    pub external_controllers: Vec<String>,
912    pub required_controllers: Vec<String>,
913    pub consent_requirements: Vec<ConsentRequirementV1>,
914    pub allowed_upgrade_modes: Vec<LifecycleUpgradeModeV1>,
915    pub verification_requirements: Vec<LifecycleVerificationRequirementV1>,
916    pub external_action_required: bool,
917    pub blocked: bool,
918    pub blockers: Vec<String>,
919    pub warnings: Vec<String>,
920    pub reason: String,
921}
922
923///
924/// LifecycleModeV1
925///
926#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
927pub enum LifecycleModeV1 {
928    DirectDeploymentAuthority,
929    ProposalRequired,
930    DelegatedInstallRequired,
931    ExternalCompletionOnly,
932    VerifyOnly,
933    MustNotTouch,
934    UnknownUnsafeBlocked,
935}
936
937///
938/// LifecycleUpgradeModeV1
939///
940#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
941pub enum LifecycleUpgradeModeV1 {
942    DirectByDeploymentAuthority,
943    ExternalProposal,
944    ExternalExecution,
945    VerifyExternalCompletion,
946    ObserveOnly,
947    Blocked,
948}
949
950///
951/// LifecycleVerificationRequirementV1
952///
953#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
954pub enum LifecycleVerificationRequirementV1 {
955    LiveInventory,
956    ControllerObservation,
957    ModuleHash,
958    CanonicalEmbeddedConfig,
959    ProtectedCallReadiness,
960}
961
962///
963/// ConsentRequirementV1
964///
965#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
966pub struct ConsentRequirementV1 {
967    pub consent_subject_kind: ConsentSubjectKindV1,
968    pub required_principals: Vec<String>,
969    pub required_controller_set_digest: Option<String>,
970    pub consent_channel_kind: ConsentChannelKindV1,
971    pub required_action: ExternalUpgradeAuthorizationModeV1,
972}
973
974///
975/// ConsentSubjectKindV1
976///
977#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
978pub enum ConsentSubjectKindV1 {
979    UserPrincipal,
980    ProjectHub,
981    GovernanceCanister,
982    CustomerController,
983    DelegatedInstallCanister,
984    MultisigAuthority,
985    UnknownExternalController,
986}
987
988///
989/// ConsentChannelKindV1
990///
991#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
992pub enum ConsentChannelKindV1 {
993    OutOfBand,
994    GeneratedCommand,
995    DelegatedInstall,
996    GovernanceProposal,
997    ApplicationSpecific,
998}
999
1000///
1001/// ExternalLifecyclePlanV1
1002///
1003#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1004pub struct ExternalLifecyclePlanV1 {
1005    pub schema_version: u32,
1006    pub lifecycle_plan_id: String,
1007    pub lifecycle_plan_digest: String,
1008    pub lifecycle_authority_report_id: String,
1009    pub deployment_plan_id: String,
1010    pub deployment_plan_digest: String,
1011    pub inventory_id: String,
1012    pub lifecycle_authority_rows: Vec<LifecycleAuthorityV1>,
1013    pub directly_executable_role_upgrades: Vec<ExternalLifecycleRoleUpgradeV1>,
1014    pub proposed_external_role_upgrades: Vec<ExternalLifecycleRoleUpgradeV1>,
1015    pub blocked_role_upgrades: Vec<ExternalLifecycleRoleUpgradeV1>,
1016    pub dependency_blockers: Vec<String>,
1017    pub protected_call_implications: Vec<String>,
1018    pub residual_exposure: Vec<String>,
1019    pub status: ExternalLifecyclePlanStatusV1,
1020}
1021
1022///
1023/// ExternalLifecycleRoleUpgradeV1
1024///
1025#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1026pub struct ExternalLifecycleRoleUpgradeV1 {
1027    pub subject: String,
1028    pub canister_id: Option<String>,
1029    pub role: Option<String>,
1030    pub control_class: CanisterControlClassV1,
1031    pub lifecycle_mode: LifecycleModeV1,
1032    pub required_external_action: Option<String>,
1033    pub blockers: Vec<String>,
1034    pub warnings: Vec<String>,
1035}
1036
1037///
1038/// ExternalLifecyclePlanStatusV1
1039///
1040#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
1041pub enum ExternalLifecyclePlanStatusV1 {
1042    Ready,
1043    PendingExternalAction,
1044    Blocked,
1045}
1046
1047///
1048/// ExternalUpgradeProposalReportV1
1049///
1050#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1051pub struct ExternalUpgradeProposalReportV1 {
1052    pub schema_version: u32,
1053    pub report_id: String,
1054    pub report_digest: String,
1055    pub lifecycle_plan_id: String,
1056    pub lifecycle_plan_digest: String,
1057    pub deployment_plan_id: String,
1058    pub deployment_plan_digest: String,
1059    pub inventory_id: String,
1060    pub proposals: Vec<ExternalUpgradeProposalV1>,
1061    pub blocked_subjects: Vec<String>,
1062}
1063
1064///
1065/// ExternalLifecyclePendingReportV1
1066///
1067#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1068pub struct ExternalLifecyclePendingReportV1 {
1069    pub schema_version: u32,
1070    pub report_id: String,
1071    pub report_digest: String,
1072    pub lifecycle_plan_id: String,
1073    pub lifecycle_plan_digest: String,
1074    pub proposal_report_id: String,
1075    pub proposal_report_digest: String,
1076    pub deployment_plan_id: String,
1077    pub deployment_plan_digest: String,
1078    pub inventory_id: String,
1079    pub direct_upgrade_count: usize,
1080    pub pending_external_count: usize,
1081    pub blocked_count: usize,
1082    pub pending_external_actions: Vec<ExternalLifecyclePendingActionV1>,
1083    pub blocked_subjects: Vec<String>,
1084    pub residual_exposure: Vec<String>,
1085    pub status: ExternalLifecyclePlanStatusV1,
1086}
1087
1088///
1089/// ExternalLifecyclePendingActionV1
1090///
1091#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1092pub struct ExternalLifecyclePendingActionV1 {
1093    pub subject: String,
1094    pub proposal_id: String,
1095    pub proposal_digest: String,
1096    pub canister_id: Option<String>,
1097    pub role: Option<String>,
1098    pub control_class: CanisterControlClassV1,
1099    pub lifecycle_mode: LifecycleModeV1,
1100    pub required_external_action: String,
1101    pub consent_requirements: Vec<ConsentRequirementV1>,
1102    pub verification_requirements: Vec<LifecycleVerificationRequirementV1>,
1103}
1104
1105///
1106/// CriticalExternalFixReportV1
1107///
1108#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1109pub struct CriticalExternalFixReportV1 {
1110    pub schema_version: u32,
1111    pub report_id: String,
1112    pub report_digest: String,
1113    pub fix_id: String,
1114    pub severity: String,
1115    pub lifecycle_plan_id: String,
1116    pub lifecycle_plan_digest: String,
1117    pub pending_report_id: String,
1118    pub pending_report_digest: String,
1119    pub deployment_plan_id: String,
1120    pub deployment_plan_digest: String,
1121    pub inventory_id: String,
1122    pub affected_roles: Vec<String>,
1123    pub affected_canisters: Vec<String>,
1124    pub directly_patchable_roles: Vec<String>,
1125    pub externally_blocked_roles: Vec<String>,
1126    pub dependency_blocked_roles: Vec<String>,
1127    pub required_external_actions: Vec<String>,
1128    pub protected_call_implications: Vec<String>,
1129    pub residual_exposure: Vec<String>,
1130    pub operator_next_steps: Vec<String>,
1131}
1132
1133///
1134/// ExternalUpgradeProposalV1
1135///
1136#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1137pub struct ExternalUpgradeProposalV1 {
1138    pub proposal_id: String,
1139    pub proposal_digest: String,
1140    pub deployment_plan_id: String,
1141    pub deployment_plan_digest: String,
1142    pub lifecycle_plan_id: String,
1143    pub lifecycle_plan_digest: String,
1144    pub promotion_plan_id: Option<String>,
1145    pub promotion_plan_digest: Option<String>,
1146    pub promotion_provenance_id: Option<String>,
1147    pub promotion_provenance_digest: Option<String>,
1148    pub subject: String,
1149    pub canister_id: Option<String>,
1150    pub role: Option<String>,
1151    pub control_class: CanisterControlClassV1,
1152    pub lifecycle_mode: LifecycleModeV1,
1153    pub observed_before_digest: String,
1154    pub current_module_hash: Option<String>,
1155    pub current_canonical_embedded_config_sha256: Option<String>,
1156    pub target_wasm_sha256: Option<String>,
1157    pub target_wasm_gz_sha256: Option<String>,
1158    pub target_installed_module_hash: Option<String>,
1159    pub target_role_artifact_identity: Option<String>,
1160    pub target_canonical_embedded_config_sha256: Option<String>,
1161    pub root_trust_anchor: Option<String>,
1162    pub authority_profile_hash: Option<String>,
1163    pub required_external_action: String,
1164    pub consent_requirements: Vec<ConsentRequirementV1>,
1165    pub allowed_authorization_modes: Vec<ExternalUpgradeAuthorizationModeV1>,
1166    pub verification_requirements: Vec<LifecycleVerificationRequirementV1>,
1167    pub expires_at: Option<String>,
1168    pub supersedes_proposal_id: Option<String>,
1169}
1170
1171///
1172/// ExternalUpgradeAuthorizationModeV1
1173///
1174#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
1175pub enum ExternalUpgradeAuthorizationModeV1 {
1176    ConsentForDirectInstall,
1177    DelegatedInstallAuthority,
1178    ExternalControllerExecution,
1179    ObserveAndVerifyOnly,
1180}
1181
1182///
1183/// ExternalUpgradeReceiptV1
1184///
1185#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1186pub struct ExternalUpgradeReceiptV1 {
1187    pub schema_version: u32,
1188    pub receipt_id: String,
1189    pub proposal_id: String,
1190    pub proposal_digest: String,
1191    pub subject: String,
1192    pub canister_id: Option<String>,
1193    pub role: Option<String>,
1194    pub consent_state: ExternalUpgradeConsentStateV1,
1195    pub reported_by: Option<String>,
1196    pub observed_before_module_hash: Option<String>,
1197    pub observed_after_module_hash: Option<String>,
1198    pub observed_after_canonical_embedded_config_sha256: Option<String>,
1199    pub verification_result: ExternalUpgradeVerificationResultV1,
1200    pub verification_notes: Vec<String>,
1201    pub receipt_digest: String,
1202}
1203
1204///
1205/// ExternalUpgradeConsentEvidenceV1
1206///
1207#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1208pub struct ExternalUpgradeConsentEvidenceV1 {
1209    pub schema_version: u32,
1210    pub evidence_id: String,
1211    pub evidence_digest: String,
1212    pub proposal_id: String,
1213    pub proposal_digest: String,
1214    pub receipt_id: String,
1215    pub receipt_digest: String,
1216    pub subject: String,
1217    pub canister_id: Option<String>,
1218    pub role: Option<String>,
1219    pub consent_state: ExternalUpgradeConsentStateV1,
1220    pub reported_by: Option<String>,
1221    pub consent_requirements: Vec<ConsentRequirementV1>,
1222    pub allowed_authorization_modes: Vec<ExternalUpgradeAuthorizationModeV1>,
1223    pub status_summary: String,
1224}
1225
1226///
1227/// ExternalUpgradeConsentEvidenceRequest
1228///
1229#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1230pub struct ExternalUpgradeConsentEvidenceRequest {
1231    pub evidence_id: String,
1232    pub proposal: ExternalUpgradeProposalV1,
1233    pub receipt: ExternalUpgradeReceiptV1,
1234}
1235
1236///
1237/// ExternalUpgradeVerificationReportV1
1238///
1239#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1240pub struct ExternalUpgradeVerificationReportV1 {
1241    pub schema_version: u32,
1242    pub report_id: String,
1243    pub report_digest: String,
1244    pub proposal_id: String,
1245    pub proposal_digest: String,
1246    pub receipt_id: String,
1247    pub receipt_digest: String,
1248    pub subject: String,
1249    pub canister_id: Option<String>,
1250    pub role: Option<String>,
1251    pub verification_result: ExternalUpgradeVerificationResultV1,
1252    pub verification_notes: Vec<String>,
1253    pub live_inventory_required: bool,
1254    pub status_summary: String,
1255}
1256
1257///
1258/// ExternalUpgradeVerificationReportRequest
1259///
1260#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1261pub struct ExternalUpgradeVerificationReportRequest {
1262    pub report_id: String,
1263    pub proposal: ExternalUpgradeProposalV1,
1264    pub receipt: ExternalUpgradeReceiptV1,
1265}
1266
1267///
1268/// ExternalUpgradeConsentStateV1
1269///
1270#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
1271pub enum ExternalUpgradeConsentStateV1 {
1272    Pending,
1273    Refused,
1274    Delegated,
1275    ExecutedExternally,
1276}
1277
1278///
1279/// ExternalUpgradeVerificationResultV1
1280///
1281#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
1282pub enum ExternalUpgradeVerificationResultV1 {
1283    Pending,
1284    Refused,
1285    Verified,
1286    Mismatch,
1287}
1288
1289///
1290/// AuthorityReconciliationPlanV1
1291///
1292#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1293pub struct AuthorityReconciliationPlanV1 {
1294    pub schema_version: u32,
1295    pub plan_id: String,
1296    pub inventory_id: String,
1297    pub authority_profile_hash: Option<String>,
1298    pub canister_actions: Vec<CanisterAuthorityActionV1>,
1299    pub automatic_actions: Vec<AuthorityAutomaticActionV1>,
1300    pub hard_failures: Vec<SafetyFindingV1>,
1301    pub external_actions_required: Vec<AuthorityExternalActionV1>,
1302}
1303
1304///
1305/// AuthorityAutomaticActionV1
1306///
1307#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1308pub struct AuthorityAutomaticActionV1 {
1309    pub subject: String,
1310    pub canister_id: String,
1311    pub role: Option<String>,
1312    pub action: AuthorityActionV1,
1313    pub observed_controllers: Vec<String>,
1314    pub desired_controllers: Vec<String>,
1315    pub controller_delta: AuthorityControllerDeltaV1,
1316    pub reason: String,
1317}
1318
1319///
1320/// AuthorityControllerDeltaV1
1321///
1322#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
1323pub struct AuthorityControllerDeltaV1 {
1324    pub add_controllers: Vec<String>,
1325    pub remove_controllers: Vec<String>,
1326}
1327
1328///
1329/// AuthorityReportV1
1330///
1331#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1332pub struct AuthorityReportV1 {
1333    pub schema_version: u32,
1334    pub report_id: String,
1335    pub check_id: Option<String>,
1336    pub reconciliation_plan_id: String,
1337    pub inventory_id: String,
1338    pub authority_profile_hash: Option<String>,
1339    pub status: SafetyStatusV1,
1340    pub summary: String,
1341    pub counts: AuthorityReportCountsV1,
1342    pub apply_readiness: AuthorityApplyReadinessV1,
1343    pub action_counts: Vec<AuthorityActionCountV1>,
1344    pub control_class_counts: Vec<AuthorityControlClassCountV1>,
1345    pub observation_gaps: Vec<DeploymentObservationGapV1>,
1346    pub automatic_actions: Vec<AuthorityAutomaticActionV1>,
1347    pub hard_failures: Vec<SafetyFindingV1>,
1348    pub external_actions_required: Vec<AuthorityExternalActionV1>,
1349    pub next_actions: Vec<String>,
1350}
1351
1352///
1353/// AuthorityApplyReadinessV1
1354///
1355#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1356pub struct AuthorityApplyReadinessV1 {
1357    pub can_apply_automatically: bool,
1358    pub automatic_action_count: usize,
1359    pub blockers: Vec<AuthorityApplyBlockerV1>,
1360}
1361
1362///
1363/// AuthorityApplyBlockerV1
1364///
1365#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1366pub enum AuthorityApplyBlockerV1 {
1367    UnsafeBlocked,
1368    HardFailures,
1369    ObservationGaps,
1370    ExternalActions,
1371}
1372
1373///
1374/// AuthorityActionCountV1
1375///
1376#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1377pub struct AuthorityActionCountV1 {
1378    pub action: AuthorityActionV1,
1379    pub count: usize,
1380}
1381
1382///
1383/// AuthorityControlClassCountV1
1384///
1385#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1386pub struct AuthorityControlClassCountV1 {
1387    pub control_class: CanisterControlClassV1,
1388    pub count: usize,
1389}
1390
1391///
1392/// AuthorityReportCountsV1
1393///
1394#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1395pub struct AuthorityReportCountsV1 {
1396    pub already_correct: usize,
1397    pub can_apply_automatically: usize,
1398    pub requires_external_action: usize,
1399    pub unsafe_blocked: usize,
1400    pub unknown: usize,
1401    pub hard_failures: usize,
1402}
1403
1404///
1405/// CanisterAuthorityActionV1
1406///
1407#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1408pub struct CanisterAuthorityActionV1 {
1409    pub canister_id: Option<String>,
1410    pub role: Option<String>,
1411    pub control_classification: CanisterControlClassV1,
1412    pub observed_controllers: Vec<String>,
1413    pub desired_controllers: Vec<String>,
1414    pub controller_delta: AuthorityControllerDeltaV1,
1415    pub action: AuthorityActionV1,
1416    pub state: AuthorityReconciliationStateV1,
1417    pub can_apply: bool,
1418    pub reason: String,
1419}
1420
1421///
1422/// AuthorityExternalActionV1
1423///
1424#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1425pub struct AuthorityExternalActionV1 {
1426    pub subject: String,
1427    pub canister_id: Option<String>,
1428    pub role: Option<String>,
1429    pub control_classification: CanisterControlClassV1,
1430    pub state: AuthorityReconciliationStateV1,
1431    pub action: AuthorityActionV1,
1432    pub observed_controllers: Vec<String>,
1433    pub desired_controllers: Vec<String>,
1434    pub controller_delta: AuthorityControllerDeltaV1,
1435    pub reason: String,
1436}
1437
1438///
1439/// AuthorityActionV1
1440///
1441#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1442pub enum AuthorityActionV1 {
1443    None,
1444    AddControllers,
1445    RemoveControllers,
1446    ReplaceControllerSet,
1447    RequiresExternalController,
1448    RequiresDestructiveImportConfirmation,
1449    ObserveOnly,
1450    AdoptPlanAvailable,
1451    BlockedByPolicy,
1452    UnknownObservation,
1453}
1454
1455///
1456/// AuthorityReconciliationStateV1
1457///
1458#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1459pub enum AuthorityReconciliationStateV1 {
1460    AlreadyCorrect,
1461    CanApplyAutomatically,
1462    RequiresExternalAction,
1463    UnsafeBlocked,
1464    Unknown,
1465}
1466
1467///
1468/// DeploymentIdentityV1
1469///
1470#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1471pub struct DeploymentIdentityV1 {
1472    pub deployment_name: String,
1473    pub network: String,
1474    pub root_principal: Option<String>,
1475    pub authority_profile_hash: Option<String>,
1476    pub role_topology_hash: Option<String>,
1477    pub deployment_manifest_digest: Option<String>,
1478    pub canonical_runtime_config_digest: Option<String>,
1479    pub role_embedded_config_set_digest: Option<String>,
1480    pub artifact_set_digest: Option<String>,
1481    pub pool_identity_set_digest: Option<String>,
1482    pub canic_version: Option<String>,
1483    pub ic_memory_version: Option<String>,
1484}
1485
1486///
1487/// TrustDomainV1
1488///
1489#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1490pub struct TrustDomainV1 {
1491    pub root_trust_anchor: Option<String>,
1492    pub migration_from: Option<String>,
1493}
1494
1495///
1496/// AuthorityProfileV1
1497///
1498#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1499pub struct AuthorityProfileV1 {
1500    pub profile_id: String,
1501    pub expected_controllers: Vec<String>,
1502    pub staging_controllers: Vec<String>,
1503    pub emergency_controllers: Vec<String>,
1504}
1505
1506///
1507/// RoleArtifactV1
1508///
1509#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1510pub struct RoleArtifactV1 {
1511    pub role: String,
1512    pub source: ArtifactSourceV1,
1513    pub build_profile: String,
1514    pub wasm_path: Option<String>,
1515    pub wasm_gz_path: Option<String>,
1516    pub wasm_gz_size_bytes: Option<u64>,
1517    pub wasm_sha256: Option<String>,
1518    pub wasm_gz_sha256: Option<String>,
1519    pub wasm_gz_sha256_source: Option<ArtifactDigestSourceV1>,
1520    pub observed_wasm_gz_file_sha256: Option<String>,
1521    pub observed_wasm_gz_file_sha256_source: Option<ArtifactDigestSourceV1>,
1522    pub installed_module_hash: Option<String>,
1523    pub candid_path: Option<String>,
1524    pub candid_sha256: Option<String>,
1525    pub raw_config_sha256: Option<String>,
1526    pub canonical_embedded_config_sha256: Option<String>,
1527    pub embedded_topology_sha256: Option<String>,
1528    pub builder_version: Option<String>,
1529    pub rust_toolchain: Option<String>,
1530    pub package_version: Option<String>,
1531}
1532
1533///
1534/// ArtifactDigestSourceV1
1535///
1536#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1537pub enum ArtifactDigestSourceV1 {
1538    ReleaseSetManifest,
1539    ObservedFileDigest,
1540    InstalledModuleHash,
1541}
1542
1543///
1544/// ArtifactSourceV1
1545///
1546#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1547pub enum ArtifactSourceV1 {
1548    LocalBuild,
1549    ReleaseSet,
1550    WasmStore,
1551    External,
1552    Unknown,
1553}
1554
1555///
1556/// ExpectedCanisterV1
1557///
1558#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1559pub struct ExpectedCanisterV1 {
1560    pub role: String,
1561    pub canister_id: Option<String>,
1562    pub control_class: CanisterControlClassV1,
1563}
1564
1565///
1566/// ObservedCanisterV1
1567///
1568#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1569pub struct ObservedCanisterV1 {
1570    pub canister_id: String,
1571    pub role: Option<String>,
1572    pub control_class: CanisterControlClassV1,
1573    pub controllers: Vec<String>,
1574    pub module_hash: Option<String>,
1575    pub status: Option<String>,
1576    pub root_trust_anchor: Option<String>,
1577    pub canonical_embedded_config_digest: Option<String>,
1578    pub role_assignment_source: Option<String>,
1579}
1580
1581///
1582/// CanisterControlClassV1
1583///
1584#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1585pub enum CanisterControlClassV1 {
1586    DeploymentControlled,
1587    CanicManagedPool,
1588    ExternallyImported,
1589    JointlyControlled,
1590    UserControlled,
1591    UnknownUnsafe,
1592}
1593
1594///
1595/// ExpectedPoolCanisterV1
1596///
1597#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1598pub struct ExpectedPoolCanisterV1 {
1599    pub pool: String,
1600    pub canister_id: Option<String>,
1601    pub role: Option<String>,
1602}
1603
1604///
1605/// ObservedPoolCanisterV1
1606///
1607#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1608pub struct ObservedPoolCanisterV1 {
1609    pub pool: String,
1610    pub canister_id: String,
1611    pub role: Option<String>,
1612    pub control_class: CanisterControlClassV1,
1613}
1614
1615///
1616/// LocalDeploymentConfigV1
1617///
1618#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1619pub struct LocalDeploymentConfigV1 {
1620    pub config_path: Option<String>,
1621    pub raw_config_sha256: Option<String>,
1622    pub canonical_embedded_config_sha256: Option<String>,
1623}
1624
1625///
1626/// ObservedArtifactV1
1627///
1628#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1629pub struct ObservedArtifactV1 {
1630    pub role: String,
1631    pub artifact_path: String,
1632    pub file_sha256: Option<String>,
1633    pub file_sha256_source: Option<ArtifactDigestSourceV1>,
1634    pub payload_sha256: Option<String>,
1635    pub payload_size_bytes: Option<u64>,
1636    pub source: ArtifactSourceV1,
1637}
1638
1639///
1640/// VerifierReadinessExpectationV1
1641///
1642#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1643pub struct VerifierReadinessExpectationV1 {
1644    pub required: bool,
1645    pub expected_role_epochs: Vec<RoleEpochExpectationV1>,
1646}
1647
1648///
1649/// VerifierReadinessObservationV1
1650///
1651#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1652pub struct VerifierReadinessObservationV1 {
1653    pub status: ObservationStatusV1,
1654    pub role_epochs: Vec<RoleEpochObservationV1>,
1655}
1656
1657///
1658/// RoleEpochExpectationV1
1659///
1660#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1661pub struct RoleEpochExpectationV1 {
1662    pub role: String,
1663    pub minimum_epoch: u64,
1664}
1665
1666///
1667/// RoleEpochObservationV1
1668///
1669#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1670pub struct RoleEpochObservationV1 {
1671    pub role: String,
1672    pub observed_epoch: Option<u64>,
1673    pub status: ObservationStatusV1,
1674}
1675
1676///
1677/// DeploymentAssumptionV1
1678///
1679#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1680pub struct DeploymentAssumptionV1 {
1681    pub key: String,
1682    pub description: String,
1683}
1684
1685///
1686/// DeploymentObservationGapV1
1687///
1688#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1689pub struct DeploymentObservationGapV1 {
1690    pub key: String,
1691    pub description: String,
1692}
1693
1694///
1695/// PhaseReceiptV1
1696///
1697#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1698pub struct PhaseReceiptV1 {
1699    pub phase: String,
1700    pub started_at: String,
1701    pub finished_at: Option<String>,
1702    pub attempted_action: String,
1703    pub verified_postcondition: VerifiedPostconditionV1,
1704}
1705
1706///
1707/// VerifiedPostconditionV1
1708///
1709#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1710pub struct VerifiedPostconditionV1 {
1711    pub status: ObservationStatusV1,
1712    pub evidence: Vec<String>,
1713}
1714
1715///
1716/// DeploymentExecutionStatusV1
1717///
1718#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1719pub enum DeploymentExecutionStatusV1 {
1720    NotStarted,
1721    InProgress,
1722    FailedBeforeMutation,
1723    PartiallyApplied,
1724    FailedAfterMutation,
1725    Complete,
1726}
1727
1728///
1729/// DeploymentCommandResultV1
1730///
1731#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1732pub enum DeploymentCommandResultV1 {
1733    NotFinished,
1734    Succeeded,
1735    Failed { code: String, message: String },
1736}
1737
1738///
1739/// RolePhaseReceiptV1
1740///
1741#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1742pub struct RolePhaseReceiptV1 {
1743    pub role: String,
1744    pub phase: String,
1745    pub result: RolePhaseResultV1,
1746    pub previous_module_hash: Option<String>,
1747    pub target_module_hash: Option<String>,
1748    pub observed_module_hash_after: Option<String>,
1749    pub artifact_digest: Option<String>,
1750    pub canonical_embedded_config_sha256: Option<String>,
1751    pub error: Option<String>,
1752}
1753
1754///
1755/// RolePhaseResultV1
1756///
1757#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1758pub enum RolePhaseResultV1 {
1759    Applied,
1760    Failed,
1761    Skipped,
1762    NotAttempted,
1763    VerifiedAlreadyApplied,
1764}
1765
1766///
1767/// DiffItemV1
1768///
1769#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1770pub struct DiffItemV1 {
1771    pub category: String,
1772    pub subject: String,
1773    pub expected: Option<String>,
1774    pub observed: Option<String>,
1775    pub severity: SafetySeverityV1,
1776}
1777
1778///
1779/// ResumeSafetyV1
1780///
1781#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1782pub struct ResumeSafetyV1 {
1783    pub status: SafetyStatusV1,
1784    pub reasons: Vec<String>,
1785}
1786
1787///
1788/// SafetyFindingV1
1789///
1790#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
1791pub struct SafetyFindingV1 {
1792    pub code: String,
1793    pub message: String,
1794    pub severity: SafetySeverityV1,
1795    pub subject: Option<String>,
1796}
1797
1798///
1799/// SafetyStatusV1
1800///
1801#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1802pub enum SafetyStatusV1 {
1803    NotEvaluated,
1804    Safe,
1805    Warning,
1806    Blocked,
1807}
1808
1809///
1810/// SafetySeverityV1
1811///
1812#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1813pub enum SafetySeverityV1 {
1814    Info,
1815    Warning,
1816    HardFailure,
1817}
1818
1819///
1820/// ObservationStatusV1
1821///
1822#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
1823pub enum ObservationStatusV1 {
1824    NotObserved,
1825    Observed,
1826    Missing,
1827    Inconclusive,
1828}
canic_host/deployment_truth/model.rs

canic_host/deployment_truth/
model.rs
