1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
use super::*;
use crate::refescape;
use anyhow::{anyhow, Context};
use containers_image_proxy::{ImageProxy, OpenedImage};
use fn_error_context::context;
use oci_spec::image::{self as oci_image, Descriptor, History, ImageConfiguration, ImageManifest};
use ostree::prelude::{Cast, ToVariant};
use ostree::{gio, glib};
use std::collections::HashMap;
use std::iter::FromIterator;
use std::sync::{Arc, Mutex};
pub use containers_image_proxy::ImageProxyConfig;
const LAYER_PREFIX: &str = "ostree/container/blob";
const IMAGE_PREFIX: &str = "ostree/container/image";
const META_MANIFEST_DIGEST: &str = "ostree.manifest-digest";
const META_MANIFEST: &str = "ostree.manifest";
const META_CONFIG: &str = "ostree.container.image-config";
pub const META_FILTERED: &str = "ostree.tar-filtered";
pub type MetaFilteredData = HashMap<String, HashMap<String, u32>>;
fn ref_for_blob_digest(d: &str) -> Result<String> {
refescape::prefix_escape_for_ref(LAYER_PREFIX, d)
}
fn ref_for_layer(l: &oci_image::Descriptor) -> Result<String> {
ref_for_blob_digest(l.digest().as_str())
}
fn ref_for_image(l: &ImageReference) -> Result<String> {
refescape::prefix_escape_for_ref(IMAGE_PREFIX, &l.to_string())
}
#[derive(Debug, PartialEq, Eq)]
pub struct LayeredImageState {
pub base_commit: String,
pub merge_commit: String,
pub is_layered: bool,
pub manifest_digest: String,
pub manifest: ImageManifest,
pub configuration: Option<ImageConfiguration>,
}
impl LayeredImageState {
pub fn get_commit(&self) -> &str {
if self.is_layered {
self.merge_commit.as_str()
} else {
self.base_commit.as_str()
}
}
}
#[derive(Debug)]
pub struct ImageImporter {
repo: ostree::Repo,
pub(crate) proxy: ImageProxy,
imgref: OstreeImageReference,
target_imgref: Option<OstreeImageReference>,
pub(crate) proxy_img: OpenedImage,
}
#[derive(Debug)]
pub enum PrepareResult {
AlreadyPresent(Box<LayeredImageState>),
Ready(Box<PreparedImport>),
}
#[derive(Debug)]
pub struct ManifestLayerState {
pub(crate) layer: oci_image::Descriptor,
pub ostree_ref: String,
pub commit: Option<String>,
}
impl ManifestLayerState {
pub fn digest(&self) -> &str {
self.layer.digest().as_str()
}
pub fn size(&self) -> u64 {
self.layer.size() as u64
}
}
#[derive(Debug)]
pub struct PreparedImport {
pub manifest_digest: String,
pub manifest: oci_image::ImageManifest,
pub config: oci_image::ImageConfiguration,
pub previous_manifest_digest: Option<String>,
pub previous_imageid: Option<String>,
pub ostree_layers: Vec<ManifestLayerState>,
pub ostree_commit_layer: ManifestLayerState,
pub layers: Vec<ManifestLayerState>,
}
impl PreparedImport {
pub fn all_layers(&self) -> impl Iterator<Item = &ManifestLayerState> {
self.ostree_layers
.iter()
.chain(std::iter::once(&self.ostree_commit_layer))
.chain(self.layers.iter())
}
pub fn layers_with_history(
&self,
) -> impl Iterator<Item = Result<(&ManifestLayerState, &History)>> {
let truncated = std::iter::once(Err(anyhow::anyhow!("Truncated history")));
let history = self.config.history().iter().map(Ok).chain(truncated);
self.all_layers()
.zip(history)
.map(|(s, h)| h.map(|h| (s, h)))
}
pub fn layers_to_fetch(&self) -> impl Iterator<Item = Result<(&ManifestLayerState, &str)>> {
self.layers_with_history().filter_map(|r| {
r.map(|(l, h)| {
l.commit.is_none().then(|| {
let comment = h.created_by().as_deref().unwrap_or("");
(l, comment)
})
})
.transpose()
})
}
}
pub(crate) fn query_layer(
repo: &ostree::Repo,
layer: oci_image::Descriptor,
) -> Result<ManifestLayerState> {
let ostree_ref = ref_for_layer(&layer)?;
let commit = repo.resolve_rev(&ostree_ref, true)?.map(|s| s.to_string());
Ok(ManifestLayerState {
layer,
ostree_ref,
commit,
})
}
fn manifest_data_from_commitmeta(
commit_meta: &glib::VariantDict,
) -> Result<(oci_image::ImageManifest, String)> {
let digest = commit_meta
.lookup(META_MANIFEST_DIGEST)?
.ok_or_else(|| anyhow!("Missing {} metadata on merge commit", META_MANIFEST_DIGEST))?;
let manifest_bytes: String = commit_meta
.lookup::<String>(META_MANIFEST)?
.ok_or_else(|| anyhow!("Failed to find {} metadata key", META_MANIFEST))?;
let r = serde_json::from_str(&manifest_bytes)?;
Ok((r, digest))
}
fn image_config_from_commitmeta(
commit_meta: &glib::VariantDict,
) -> Result<Option<ImageConfiguration>> {
commit_meta
.lookup::<String>(META_CONFIG)?
.filter(|v| v != "null")
.map(|v| serde_json::from_str(&v).map_err(anyhow::Error::msg))
.transpose()
}
pub fn manifest_digest_from_commit(commit: &glib::Variant) -> Result<String> {
let commit_meta = &commit.child_value(0);
let commit_meta = &glib::VariantDict::new(Some(commit_meta));
Ok(manifest_data_from_commitmeta(commit_meta)?.1)
}
fn layer_from_diffid<'a>(
manifest: &'a ImageManifest,
config: &ImageConfiguration,
diffid: &str,
) -> Result<&'a Descriptor> {
let idx = config
.rootfs()
.diff_ids()
.iter()
.position(|x| x.as_str() == diffid)
.ok_or_else(|| anyhow!("Missing {} {}", OSTREE_DIFFID_LABEL, diffid))?;
manifest.layers().get(idx).ok_or_else(|| {
anyhow!(
"diffid position {} exceeds layer count {}",
idx,
manifest.layers().len()
)
})
}
impl ImageImporter {
pub async fn new(
repo: &ostree::Repo,
imgref: &OstreeImageReference,
mut config: ImageProxyConfig,
) -> Result<Self> {
merge_default_container_proxy_opts(&mut config)?;
let proxy = ImageProxy::new_with_config(config).await?;
let proxy_img = proxy.open_image(&imgref.imgref.to_string()).await?;
let repo = repo.clone();
Ok(ImageImporter {
repo,
proxy,
proxy_img,
target_imgref: None,
imgref: imgref.clone(),
})
}
pub fn set_target(&mut self, target: &OstreeImageReference) {
self.target_imgref = Some(target.clone())
}
pub async fn prepare(&mut self) -> Result<PrepareResult> {
self.prepare_internal(false).await
}
#[context("Fetching manifest")]
pub(crate) async fn prepare_internal(&mut self, verify_layers: bool) -> Result<PrepareResult> {
match &self.imgref.sigverify {
SignatureSource::ContainerPolicy if skopeo::container_policy_is_default_insecure()? => {
return Err(anyhow!("containers-policy.json specifies a default of `insecureAcceptAnything`; refusing usage"));
}
SignatureSource::OstreeRemote(_) if verify_layers => {
return Err(anyhow!(
"Cannot currently verify layered containers via ostree remote"
));
}
_ => {}
}
let (manifest_digest, manifest) = self.proxy.fetch_manifest(&self.proxy_img).await?;
let new_imageid = manifest.config().digest().as_str();
let (previous_manifest_digest, previous_imageid) =
if let Some(previous_state) = query_image(&self.repo, &self.imgref)? {
if previous_state.manifest_digest == manifest_digest {
return Ok(PrepareResult::AlreadyPresent(previous_state));
}
let previous_imageid = previous_state.manifest.config().digest().as_str();
if previous_imageid == new_imageid {
return Ok(PrepareResult::AlreadyPresent(previous_state));
}
(
Some(previous_state.manifest_digest),
Some(previous_imageid.to_string()),
)
} else {
(None, None)
};
let config = self.proxy.fetch_config(&self.proxy_img).await?;
let label = crate::container::OSTREE_DIFFID_LABEL;
let config_labels = config.config().as_ref().and_then(|c| c.labels().as_ref());
let commit_layer_digest = if config.rootfs().diff_ids().len() == 1 {
manifest.layers()[0].digest()
} else {
let diffid = config_labels
.and_then(|labels| labels.get(label))
.ok_or_else(|| {
anyhow!(
"Missing annotation {} (not an ostree-exported container?)",
label
)
})?;
let layer = layer_from_diffid(&manifest, &config, diffid.as_str())?;
layer.digest()
};
let mut component_layers = Vec::new();
let mut commit_layer = None;
let mut remaining_layers = Vec::new();
let query = |l: &Descriptor| query_layer(&self.repo, l.clone());
for layer in manifest.layers() {
if layer.digest() == commit_layer_digest {
commit_layer = Some(query(layer)?);
} else if commit_layer.is_none() {
component_layers.push(query(layer)?);
} else {
remaining_layers.push(query(layer)?);
}
}
let commit_layer = commit_layer.ok_or_else(|| {
anyhow!(
"Image does not contain ostree-exported layer {}",
commit_layer_digest
)
})?;
let imp = PreparedImport {
manifest,
manifest_digest,
config,
previous_manifest_digest,
previous_imageid,
ostree_layers: component_layers,
ostree_commit_layer: commit_layer,
layers: remaining_layers,
};
Ok(PrepareResult::Ready(Box::new(imp)))
}
pub(crate) async fn unencapsulate_base(
&mut self,
import: &mut store::PreparedImport,
options: Option<UnencapsulateOptions>,
write_refs: bool,
) -> Result<()> {
tracing::debug!("Fetching base");
if matches!(self.imgref.sigverify, SignatureSource::ContainerPolicy)
&& skopeo::container_policy_is_default_insecure()?
{
return Err(anyhow!("containers-policy.json specifies a default of `insecureAcceptAnything`; refusing usage"));
}
let options = options.unwrap_or_default();
let remote = match &self.imgref.sigverify {
SignatureSource::OstreeRemote(remote) => Some(remote.clone()),
SignatureSource::ContainerPolicy | SignatureSource::ContainerPolicyAllowInsecure => {
None
}
};
let progress = options.progress.map(|v| Arc::new(Mutex::new(v)));
for layer in import.ostree_layers.iter_mut() {
if layer.commit.is_some() {
continue;
}
let (blob, driver) =
fetch_layer_decompress(&mut self.proxy, &self.proxy_img, &layer.layer).await?;
let blob = super::unencapsulate::ProgressReader {
reader: blob,
progress: progress.as_ref().map(Arc::clone),
};
let repo = self.repo.clone();
let target_ref = layer.ostree_ref.clone();
let import_task =
crate::tokio_util::spawn_blocking_cancellable_flatten(move |cancellable| {
let txn = repo.auto_transaction(Some(cancellable))?;
let mut importer = crate::tar::Importer::new_for_object_set(&repo);
let blob = tokio_util::io::SyncIoBridge::new(blob);
let mut archive = tar::Archive::new(blob);
importer.import_objects(&mut archive, Some(cancellable))?;
let commit = if write_refs {
let commit = importer.finish_import_object_set()?;
repo.transaction_set_ref(None, &target_ref, Some(commit.as_str()));
tracing::debug!("Wrote {} => {}", target_ref, commit);
Some(commit)
} else {
None
};
txn.commit(Some(cancellable))?;
Ok::<_, anyhow::Error>(commit)
});
let commit = super::unencapsulate::join_fetch(import_task, driver).await?;
layer.commit = commit;
}
if import.ostree_commit_layer.commit.is_none() {
let (blob, driver) = fetch_layer_decompress(
&mut self.proxy,
&self.proxy_img,
&import.ostree_commit_layer.layer,
)
.await?;
let blob = ProgressReader {
reader: blob,
progress: progress.as_ref().map(Arc::clone),
};
let repo = self.repo.clone();
let target_ref = import.ostree_commit_layer.ostree_ref.clone();
let import_task =
crate::tokio_util::spawn_blocking_cancellable_flatten(move |cancellable| {
let txn = repo.auto_transaction(Some(cancellable))?;
let mut importer = crate::tar::Importer::new_for_commit(&repo, remote);
let blob = tokio_util::io::SyncIoBridge::new(blob);
let mut archive = tar::Archive::new(blob);
importer.import_commit(&mut archive, Some(cancellable))?;
let commit = importer.finish_import_commit();
if write_refs {
repo.transaction_set_ref(None, &target_ref, Some(commit.as_str()));
tracing::debug!("Wrote {} => {}", target_ref, commit);
}
repo.mark_commit_partial(&commit, false)?;
txn.commit(Some(cancellable))?;
Ok::<_, anyhow::Error>(commit)
});
let commit = super::unencapsulate::join_fetch(import_task, driver).await?;
import.ostree_commit_layer.commit = Some(commit);
};
Ok(())
}
pub async fn unencapsulate(
mut self,
mut import: Box<PreparedImport>,
options: Option<UnencapsulateOptions>,
) -> Result<Import> {
if !import.layers.is_empty() {
anyhow::bail!("Image has {} non-ostree layers", import.layers.len());
}
self.unencapsulate_base(&mut import, options, false).await?;
let ostree_commit = import.ostree_commit_layer.commit.unwrap();
let image_digest = import.manifest_digest;
Ok(Import {
ostree_commit,
image_digest,
})
}
pub async fn import(
mut self,
mut import: Box<PreparedImport>,
) -> Result<Box<LayeredImageState>> {
self.unencapsulate_base(&mut import, None, true).await?;
let mut proxy = self.proxy;
let target_imgref = self.target_imgref.as_ref().unwrap_or(&self.imgref);
let base_commit = import.ostree_commit_layer.commit.clone().unwrap();
let ostree_ref = ref_for_image(&target_imgref.imgref)?;
let mut layer_commits = Vec::new();
let mut layer_filtered_content: MetaFilteredData = HashMap::new();
for layer in import.layers {
if let Some(c) = layer.commit {
tracing::debug!("Reusing fetched commit {}", c);
layer_commits.push(c.to_string());
} else {
let (blob, driver) = super::unencapsulate::fetch_layer_decompress(
&mut proxy,
&self.proxy_img,
&layer.layer,
)
.await?;
let opts = crate::tar::WriteTarOptions {
base: Some(base_commit.clone()),
selinux: true,
};
let r =
crate::tar::write_tar(&self.repo, blob, layer.ostree_ref.as_str(), Some(opts));
let r = super::unencapsulate::join_fetch(r, driver)
.await
.with_context(|| format!("Parsing layer blob {}", layer.digest()))?;
layer_commits.push(r.commit);
if !r.filtered.is_empty() {
let filtered = HashMap::from_iter(r.filtered.into_iter());
layer_filtered_content.insert(layer.digest().to_string(), filtered);
}
}
}
proxy.finalize().await?;
tracing::debug!("finalized proxy");
let serialized_manifest = serde_json::to_string(&import.manifest)?;
let serialized_config = serde_json::to_string(&import.config)?;
let mut metadata = HashMap::new();
metadata.insert(META_MANIFEST_DIGEST, import.manifest_digest.to_variant());
metadata.insert(META_MANIFEST, serialized_manifest.to_variant());
metadata.insert(META_CONFIG, serialized_config.to_variant());
metadata.insert(
"ostree.importer.version",
env!("CARGO_PKG_VERSION").to_variant(),
);
let filtered = layer_filtered_content.to_variant();
metadata.insert(META_FILTERED, filtered);
let metadata = metadata.to_variant();
let repo = self.repo;
let imgref = self.target_imgref.unwrap_or(self.imgref);
let state = crate::tokio_util::spawn_blocking_cancellable_flatten(
move |cancellable| -> Result<Box<LayeredImageState>> {
let cancellable = Some(cancellable);
let repo = &repo;
let txn = repo.auto_transaction(cancellable)?;
let (base_commit_tree, _) = repo.read_commit(&base_commit, cancellable)?;
let base_commit_tree = base_commit_tree.downcast::<ostree::RepoFile>().unwrap();
let base_contents_obj = base_commit_tree.tree_get_contents_checksum().unwrap();
let base_metadata_obj = base_commit_tree.tree_get_metadata_checksum().unwrap();
let mt = ostree::MutableTree::from_checksum(
repo,
&base_contents_obj,
&base_metadata_obj,
);
for commit in layer_commits {
let (layer_tree, _) = repo.read_commit(&commit, cancellable)?;
repo.write_directory_to_mtree(&layer_tree, &mt, None, cancellable)?;
}
let merged_root = repo.write_mtree(&mt, cancellable)?;
let merged_root = merged_root.downcast::<ostree::RepoFile>().unwrap();
let merged_commit = repo.write_commit(
None,
None,
None,
Some(&metadata),
&merged_root,
cancellable,
)?;
repo.transaction_set_ref(None, &ostree_ref, Some(merged_commit.as_str()));
txn.commit(cancellable)?;
let state = query_image(repo, &imgref)?.unwrap();
Ok(state)
},
)
.await?;
Ok(state)
}
}
pub fn list_images(repo: &ostree::Repo) -> Result<Vec<String>> {
let cancellable = gio::NONE_CANCELLABLE;
let refs = repo.list_refs_ext(
Some(IMAGE_PREFIX),
ostree::RepoListRefsExtFlags::empty(),
cancellable,
)?;
refs.keys()
.map(|imgname| refescape::unprefix_unescape_ref(IMAGE_PREFIX, imgname))
.collect()
}
pub fn query_image(
repo: &ostree::Repo,
imgref: &OstreeImageReference,
) -> Result<Option<Box<LayeredImageState>>> {
let ostree_ref = &ref_for_image(&imgref.imgref)?;
let merge_rev = repo.resolve_rev(ostree_ref, true)?;
let (merge_commit, merge_commit_obj) = if let Some(r) = merge_rev {
(r.to_string(), repo.load_commit(r.as_str())?.0)
} else {
return Ok(None);
};
let commit_meta = &merge_commit_obj.child_value(0);
let commit_meta = &ostree::glib::VariantDict::new(Some(commit_meta));
let (manifest, manifest_digest) = manifest_data_from_commitmeta(commit_meta)?;
let configuration = image_config_from_commitmeta(commit_meta)?;
let mut layers = manifest.layers().iter().cloned();
let base_layer = layers.next().ok_or_else(|| anyhow!("No layers found"))?;
let base_layer = query_layer(repo, base_layer)?;
let base_commit = base_layer
.commit
.ok_or_else(|| anyhow!("Missing base image ref"))?;
let is_layered = layers.count() > 0;
let state = Box::new(LayeredImageState {
base_commit,
merge_commit,
is_layered,
manifest_digest,
manifest,
configuration,
});
tracing::debug!(state = ?state);
Ok(Some(state))
}
pub async fn copy(
src_repo: &ostree::Repo,
dest_repo: &ostree::Repo,
imgref: &OstreeImageReference,
) -> Result<()> {
let ostree_ref = ref_for_image(&imgref.imgref)?;
let rev = src_repo.require_rev(&ostree_ref)?;
let (commit_obj, _) = src_repo.load_commit(rev.as_str())?;
let commit_meta = &glib::VariantDict::new(Some(&commit_obj.child_value(0)));
let (manifest, _) = manifest_data_from_commitmeta(commit_meta)?;
let layer_refs = manifest
.layers()
.iter()
.map(ref_for_layer)
.chain(std::iter::once(Ok(ostree_ref)));
for ostree_ref in layer_refs {
let ostree_ref = ostree_ref?;
let src_repo = src_repo.clone();
let dest_repo = dest_repo.clone();
crate::tokio_util::spawn_blocking_cancellable_flatten(move |cancellable| -> Result<_> {
let cancellable = Some(cancellable);
let srcfd = &format!("file:///proc/self/fd/{}", src_repo.dfd());
let flags = ostree::RepoPullFlags::MIRROR;
let opts = glib::VariantDict::new(None);
let refs = [ostree_ref.as_str()];
opts.insert("disable-verify-bindings", &true);
opts.insert("refs", &&refs[..]);
opts.insert("flags", &(flags.bits() as i32));
let options = opts.to_variant();
dest_repo.pull_with_options(srcfd, &options, None, cancellable)?;
Ok(())
})
.await?;
}
Ok(())
}
pub fn prune_images(_repo: &ostree::Repo, _imgs: &[&str]) -> Result<()> {
unimplemented!()
}