OXYGENHUB
◆ v0.1.0 oxygen / crates / oxy-core / src / repo / sync.rs
68.2 KiB · Rust · last changed Private subrepos clone with the parent's credentials for the same hub 1 month ago source blame history raw
1
//! Serving and talking to remotes (spec §10.2, §16).
2
3
use super::*;
4
5
/// What a push did, for hosts (hub spec §6.12).
6
#[derive(Clone, Debug, Default)]
7
pub struct PushReport {
8
    pub results: Vec<RefResult>,
9
    /// Accepted reference updates, in request order.
10
    pub updated: Vec<RefUpdated>,
11
    /// Changes this push stored that were not already present.
12
    pub imported: Vec<ChangeHash>,
13
}
14
15
#[derive(Clone, Debug)]
16
pub struct RefUpdated {
17
    pub name: String,
18
    pub old_state: ObjectRef,
19
    pub new_state: ObjectRef,
20
    pub heads: Vec<ChangeHash>,
21
}
22
23
/// What a fetch brought in.
24
#[derive(Debug, Clone, PartialEq, Eq, Default)]
25
pub struct FetchReport {
26
    /// Bookmark name, its heads, and how many changes were new.
27
    pub refs: Vec<(String, Vec<ChangeHash>, usize)>,
28
    /// Tags adopted from the remote.
29
    pub new_tags: usize,
30
    /// The remote has never presented a policy, so nothing was verified
31
    /// against one (spec §14.5: warn loudly).
32
    pub unverified: bool,
33
}
34
35
#[derive(Debug, Clone, PartialEq, Eq)]
36
pub struct PullReport {
37
    pub heads: Vec<ChangeHash>,
38
    pub changed: bool,
39
    pub checked_out: bool,
40
}
41
42
impl Repo {
43
    // ------------------------------------------------------------ serving (spec §16)
44
45
    fn ref_attest_path(&self, bookmark: &str) -> PathBuf {
46
        self.oxy.join("attest").join(name_file(bookmark))
47
    }
48
49
    /// The latest reference attestation stored for a bookmark.
50
    pub fn latest_ref_attest(&self, bookmark: &str) -> Result<Option<(ObjectRef, SignedAttest)>> {
51
        match fs::read_to_string(self.ref_attest_path(bookmark)) {
52
            Ok(h) => {
53
                let r = ObjectRef::from_hex(h.trim())
54
                    .ok_or_else(|| RepoError::Msg("corrupt attestation pointer".into()))?;
55
                Ok(Some((
56
                    r,
57
                    SignedAttest {
58
                        attest: self.store.get_attest(&r)?,
59
                        sigs: self.store.signatures(&r)?,
60
                    },
61
                )))
62
            }
63
            Err(e) if e.kind() == std::io::ErrorKind::NotFound => Ok(None),
64
            Err(e) => Err(e.into()),
65
        }
66
    }
67
68
    fn set_ref_attest(&self, bookmark: &str, r: &ObjectRef) -> Result<()> {
69
        fs::create_dir_all(self.oxy.join("attest"))?;
70
        write_atomic(&self.ref_attest_path(bookmark), r.to_hex().as_bytes())
71
    }
72
73
    pub fn remote_refs(&self) -> Result<RefsResponse> {
74
        let view = self.view()?;
75
        let mut out = Vec::new();
76
        for (name, state) in &view.bookmarks {
77
            let latest = self.latest_ref_attest(name)?.map(|(_, a)| a);
78
            let last_serial = latest.as_ref().and_then(|a| match a.attest.body {
79
                AttestBody::Ref { serial, .. } => Some(serial),
80
                _ => None,
81
            });
82
            let attestation = latest.filter(|a| matches!(&a.attest.body, AttestBody::Ref { new_state, .. } if new_state == state));
83
            out.push(RemoteRef {
84
                name: name.clone(),
85
                state: *state,
86
                heads: self.store.get_state(state)?.heads,
87
                attestation,
88
                last_serial,
89
            });
90
        }
91
        let policy = self.current_policy()?.map(|(_, sp)| sp);
92
        let history = self
93
            .policy_history()?
94
            .into_iter()
95
            .filter(|sp| {
96
                policy
97
                    .as_ref()
98
                    .is_some_and(|p| sp.policy.serial < p.policy.serial)
99
            })
100
            .collect();
101
        Ok(RefsResponse {
102
            refs: out,
103
            policy,
104
            tags: self.tag_refs()?,
105
            history,
106
        })
107
    }
108
109
    /// Every change reachable from `heads` that is in the store.
110
    fn closure_in_store(&self, heads: &[ChangeHash]) -> Result<BTreeSet<ChangeHash>> {
111
        let mut seen = BTreeSet::new();
112
        let mut stack: Vec<ChangeHash> = heads.to_vec();
113
        while let Some(h) = stack.pop() {
114
            if seen.contains(&h) || !self.store.has(&h) {
115
                continue;
116
            }
117
            seen.insert(h);
118
            stack.extend(self.store.get_change_meta(&h)?.deps);
119
        }
120
        Ok(seen)
121
    }
122
123
    /// The changes within `depth` dependency steps of `heads` (spec §17),
124
    /// nearest first; depth 1 is the heads themselves.
125
    pub fn shallow_changes(&self, heads: &[ChangeHash], depth: u32) -> Result<Vec<ChangeHash>> {
126
        let mut out = Vec::new();
127
        let mut seen: BTreeSet<ChangeHash> = BTreeSet::new();
128
        let mut layer: Vec<ChangeHash> = heads.to_vec();
129
        for _ in 0..depth.max(1) {
130
            let mut next = Vec::new();
131
            for h in layer {
132
                if !seen.insert(h) || !self.store.has(&h) {
133
                    continue;
134
                }
135
                let c = self.store.get_change(&h)?;
136
                next.extend(c.deps.iter().copied());
137
                out.push(h);
138
            }
139
            if next.is_empty() {
140
                break;
141
            }
142
            layer = next;
143
        }
144
        out.reverse();
145
        Ok(out)
146
    }
147
148
    fn shallow_path(&self) -> PathBuf {
149
        self.oxy.join("shallow")
150
    }
151
152
    /// The shallow boundary: dependencies this repository does not hold (spec §17).
153
    pub fn boundary(&self) -> BTreeSet<ChangeHash> {
154
        fs::read_to_string(self.shallow_path())
155
            .map(|t| t.lines().filter_map(ObjectRef::from_hex).collect())
156
            .unwrap_or_default()
157
    }
158
159
    pub fn is_shallow(&self) -> bool {
160
        !self.boundary().is_empty()
161
    }
162
163
    fn write_boundary(&self, boundary: &BTreeSet<ChangeHash>) -> Result<()> {
164
        if boundary.is_empty() {
165
            let _ = fs::remove_file(self.shallow_path());
166
            return Ok(());
167
        }
168
        let text: String = boundary
169
            .iter()
170
            .map(|h| format!("{}\n", h.to_hex()))
171
            .collect();
172
        write_atomic(&self.shallow_path(), text.as_bytes())
173
    }
174
175
    /// Recompute the boundary from what is stored: every dependency of a
176
    /// stored change that is not itself stored.
177
    fn refresh_boundary(&self, imported: &[ChangeHash]) -> Result<()> {
178
        let mut boundary = self.boundary();
179
        boundary.retain(|h| !self.store.has(h));
180
        for h in imported {
181
            for d in self.store.get_change_meta(h)?.deps {
182
                if !self.store.has(&d) {
183
                    boundary.insert(d);
184
                }
185
            }
186
        }
187
        self.write_boundary(&boundary)
188
    }
189
190
    /// Fetch `depth` more levels of history below the shallow boundary.
191
    pub fn deepen(&self, remote_name: &str, depth: u32) -> Result<usize> {
192
        let boundary = self.boundary();
193
        if boundary.is_empty() {
194
            return Ok(0);
195
        }
196
        let remote = self.open_named_remote(remote_name)?;
197
        let wanted = remote.shallow(&boundary.iter().copied().collect::<Vec<_>>(), depth)?;
198
        let bundle = remote.fetch(&wanted, self.config.max_blob)?;
199
        let imported = self.import_bundle_shallow(&bundle, false)?;
200
        if self.config.max_blob.is_some() {
201
            self.register_missing_blobs(&imported, remote_name)?;
202
        }
203
        self.refresh_boundary(&imported)?;
204
        Ok(imported.len())
205
    }
206
207
    /// `closure(want) \ closure(have)`, dependencies first (spec §16.2).
208
    pub fn negotiate(&self, have: &[ChangeHash], want: &[ChangeHash]) -> Result<Vec<ChangeHash>> {
209
        let have = self.closure_in_store(have)?;
210
        // In a shallow repository the walk stops at the boundary, whose
211
        // changes the remote is assumed to hold.
212
        let boundary = self.boundary();
213
        let mut out = Vec::new();
214
        let mut done: BTreeSet<ChangeHash> = have.clone();
215
        done.extend(boundary.iter().copied());
216
        // Iterative post-order DFS.
217
        let mut stack: Vec<(ChangeHash, bool)> = want.iter().rev().map(|h| (*h, false)).collect();
218
        while let Some((h, expanded)) = stack.pop() {
219
            if done.contains(&h) {
220
                continue;
221
            }
222
            if !self.store.has(&h) {
223
                return fail(format!("change {} is not in this repository", h.short(12)));
224
            }
225
            if expanded {
226
                done.insert(h);
227
                out.push(h);
228
                continue;
229
            }
230
            stack.push((h, true));
231
            for d in self.store.get_change_meta(&h)?.deps {
232
                if !done.contains(&d) {
233
                    stack.push((d, false));
234
                }
235
            }
236
        }
237
        Ok(out)
238
    }
239
240
    /// Bundle changes (in the given dependency order) with their signatures,
241
    /// seals, identities, blobs, chunks.
242
    pub fn bundle_for(&self, changes: &[ChangeHash]) -> Result<Bundle> {
243
        self.bundle_for_filtered(changes, None)
244
    }
245
246
    /// Objects by reference for the `objects` endpoint; a blob brings its chunks.
247
    pub fn objects_for(&self, refs: &[ObjectRef]) -> Result<Vec<(ObjectType, Vec<u8>)>> {
248
        let mut out = Vec::new();
249
        for r in refs {
250
            let (ty, body) = match self.store.get(r) {
251
                Ok(x) => x,
252
                Err(StoreError::NotFound(_)) => continue,
253
                Err(e) => return Err(e.into()),
254
            };
255
            if ty == ObjectType::Blob {
256
                for c in Blob::decode(&body)?.chunks {
257
                    if let Ok((cty, cb)) = self.store.get(&c) {
258
                        out.push((cty, cb));
259
                    }
260
                }
261
            }
262
            out.push((ty, body));
263
        }
264
        Ok(out)
265
    }
266
267
    /// Like `bundle_for`, leaving out blobs larger than `max_blob` bytes
268
    /// (and their chunks) so the receiver fetches them lazily (spec §13.5).
269
    pub fn bundle_for_filtered(
270
        &self,
271
        changes: &[ChangeHash],
272
        max_blob: Option<u64>,
273
    ) -> Result<Bundle> {
274
        self.bundle_of(changes, max_blob, false)
275
    }
276
277
    /// Like [`Repo::bundle_for_filtered`] for a fetch between repositories
278
    /// on one machine: changes as they are stored ([`Bundle::raw_changes`]),
279
    /// with their text blobs and chunks among the objects, so neither side
280
    /// decodes or encodes their text.
281
    pub fn bundle_raw_for(&self, changes: &[ChangeHash], max_blob: Option<u64>) -> Result<Bundle> {
282
        self.bundle_of(changes, max_blob, true)
283
    }
284
285
    fn bundle_of(
286
        &self,
287
        changes: &[ChangeHash],
288
        max_blob: Option<u64>,
289
        raw: bool,
290
    ) -> Result<Bundle> {
291
        let mut bundle = Bundle::default();
292
        let mut objects: BTreeSet<ObjectRef> = BTreeSet::new();
293
        let mut seals: BTreeSet<ObjectRef> = BTreeSet::new();
294
        let add_object = |r: &ObjectRef, objects: &mut BTreeSet<ObjectRef>| {
295
            if !r.is_zero() && self.store.has(r) {
296
                objects.insert(*r);
297
            }
298
        };
299
        for h in changes {
300
            // Raw: the stored bytes, and a skeleton for the rest.
301
            let (c, encoded) = if raw {
302
                let bytes = self.store.get_typed(h, ObjectType::Change)?;
303
                let (skel, texts) = Change::decode_skeleton(&bytes, *h)?;
304
                for t in texts {
305
                    if let crate::objects::TextRef::Blob(r, _, _) = t {
306
                        let blob = Blob::decode(&self.store.get_typed(&r, ObjectType::Blob)?)?;
307
                        objects.insert(r);
308
                        objects.extend(blob.chunks);
309
                    }
310
                }
311
                (skel, Some(bytes))
312
            } else {
313
                (self.store.get_change(h)?, None)
314
            };
315
            let sigs = self.store.signatures(h)?;
316
            add_object(&c.author, &mut objects);
317
            for s in &sigs {
318
                add_object(&s.key, &mut objects);
319
            }
320
            for e in &c.edits {
321
                if let Edit::Replace { old, new, .. } = e {
322
                    for b in [old, new].into_iter().flatten() {
323
                        if self.store.has(b) {
324
                            if let Ok(blob) =
325
                                Blob::decode(&self.store.get_typed(b, ObjectType::Blob)?)
326
                            {
327
                                if max_blob.is_some_and(|m| blob.length > m) {
328
                                    continue;
329
                                }
330
                                objects.insert(*b);
331
                                objects.extend(blob.chunks.iter().copied());
332
                            }
333
                        }
334
                    }
335
                }
336
            }
337
            for s in self.store.seals_for(h)? {
338
                seals.insert(s);
339
            }
340
            match encoded {
341
                Some(bytes) => bundle.raw_changes.push((bytes, sigs)),
342
                None => {
343
                    bundle.changes.push((c, sigs));
344
                    bundle.hashes.push(*h);
345
                }
346
            }
347
        }
348
        for r in seals {
349
            let attest = self.store.get_attest(&r)?;
350
            let sigs = self.store.signatures(&r)?;
351
            for s in &sigs {
352
                add_object(&s.key, &mut objects);
353
            }
354
            bundle.attests.push(SignedAttest { attest, sigs });
355
        }
356
        for r in objects {
357
            let (ty, body) = self.store.get(&r)?;
358
            bundle.objects.push((ty, body));
359
        }
360
        Ok(bundle)
361
    }
362
363
    /// Store a bundle's contents. With `strict`, every change must
364
    /// authenticate (signature or seal by its author or a delegate).
365
    pub fn import_bundle(&self, bundle: &Bundle, strict: bool) -> Result<Vec<ChangeHash>> {
366
        self.import_bundle_inner(bundle, strict, false)
367
    }
368
369
    /// Like `import_bundle`, accepting changes whose dependencies are absent
370
    /// (they join the shallow boundary).
371
    pub fn import_bundle_shallow(&self, bundle: &Bundle, strict: bool) -> Result<Vec<ChangeHash>> {
372
        self.import_bundle_inner(bundle, strict, true)
373
    }
374
375
    fn import_bundle_inner(
376
        &self,
377
        bundle: &Bundle,
378
        strict: bool,
379
        shallow: bool,
380
    ) -> Result<Vec<ChangeHash>> {
381
        let batch = self.store.begin_batch()?;
382
        let result = self.import_bundle_batched(bundle, strict, shallow);
383
        batch.finish()?;
384
        result
385
    }
386
387
    fn import_bundle_batched(
388
        &self,
389
        bundle: &Bundle,
390
        strict: bool,
391
        shallow: bool,
392
    ) -> Result<Vec<ChangeHash>> {
393
        for (ty, _) in &bundle.objects {
394
            if !matches!(
395
                ty,
396
                ObjectType::Chunk
397
                    | ObjectType::Blob
398
                    | ObjectType::Identity
399
                    | ObjectType::State
400
                    | ObjectType::Checkpoint
401
            ) {
402
                return fail(format!("bundle may not carry {} objects", ty.name()));
403
            }
404
        }
405
        // All at once: in a large batch they are compressed on every core.
406
        let objects: Vec<(ObjectType, &[u8])> = bundle
407
            .objects
408
            .iter()
409
            .map(|(ty, body)| (*ty, body.as_slice()))
410
            .collect();
411
        self.store.put_many(&objects)?;
412
        for sa in &bundle.attests {
413
            let r = self.store.put_attest(&sa.attest)?;
414
            for sig in &sa.sigs {
415
                self.store.put_signature(&r, sig)?;
416
            }
417
            if let AttestBody::Seal { hashes } = &sa.attest.body {
418
                for h in hashes {
419
                    self.store.index_seal(h, &r)?;
420
                }
421
            }
422
        }
423
        // Each change's hash: from the bundle when its maker knew it, else
424
        // worked out once (for a change adding a whole tree, hashing is
425
        // chunking all its text).
426
        let hashes: Vec<ChangeHash> = if bundle.hashes.len() == bundle.changes.len() {
427
            bundle.hashes.clone()
428
        } else {
429
            bundle.changes.iter().map(|(c, _)| c.hash()).collect()
430
        };
431
        let raw_hashes: Vec<ChangeHash> = bundle
432
            .raw_changes
433
            .iter()
434
            .map(|(b, _)| hash_object(ObjectType::Change, b))
435
            .collect();
436
        let incoming: BTreeSet<ChangeHash> = hashes.iter().chain(&raw_hashes).copied().collect();
437
        let boundary = self.boundary();
438
        let mut imported = Vec::new();
439
        // Changes as stored: checked, then stored as they are, their text
440
        // blobs having come with the objects.
441
        for ((bytes, sigs), h) in bundle.raw_changes.iter().zip(raw_hashes) {
442
            let (skel, texts) = Change::decode_skeleton(bytes, h)?;
443
            for d in &skel.deps {
444
                if !self.store.has(d) && !incoming.contains(d) && !shallow && !boundary.contains(d)
445
                {
446
                    return fail(format!(
447
                        "change {} depends on {}, which is neither stored nor in the bundle",
448
                        h.short(12),
449
                        d.short(12)
450
                    ));
451
                }
452
            }
453
            for t in texts {
454
                if let crate::objects::TextRef::Blob(r, _, _) = t {
455
                    if !self.store.has(&r) {
456
                        return fail(format!(
457
                            "change {} came without its text blob {}",
458
                            h.short(12),
459
                            r.short(12)
460
                        ));
461
                    }
462
                }
463
            }
464
            self.store.put(ObjectType::Change, bytes)?;
465
            for sig in sigs {
466
                self.store.put_signature(&h, sig)?;
467
            }
468
            imported.push(h);
469
        }
470
        for ((c, sigs), h) in bundle.changes.iter().zip(hashes) {
471
            for d in &c.deps {
472
                if !self.store.has(d) && !incoming.contains(d) && !shallow && !boundary.contains(d)
473
                {
474
                    return fail(format!(
475
                        "change {} depends on {}, which is neither stored nor in the bundle",
476
                        h.short(12),
477
                        d.short(12)
478
                    ));
479
                }
480
            }
481
            let stored = self.store.put_change(c)?;
482
            if stored != h {
483
                return fail(format!(
484
                    "change {} is not the change the bundle names",
485
                    h.short(12)
486
                ));
487
            }
488
            for sig in sigs {
489
                self.store.put_signature(&h, sig)?;
490
            }
491
            imported.push(h);
492
        }
493
        if strict {
494
            for h in &imported {
495
                if !matches!(self.authenticate_change(h)?, SignatureStatus::Valid { .. }) {
496
                    return fail(format!(
497
                        "change {} is not authenticated by its author",
498
                        h.short(12)
499
                    ));
500
                }
501
            }
502
        }
503
        Ok(imported)
504
    }
505
506
    /// Verify a reference attestation against an update it claims to describe.
507
    /// `allow_equal` lets a client re-read the attestation it already has; a
508
    /// server receiving a push requires a strictly greater serial.
509
    /// A reference attestation signed by a delegate of an identity the
510
    /// rule lists is authorized as that identity (spec §14.5): the identity
511
    /// named the delegate, and the policy names the identity. Revoked keys
512
    /// authorize nothing either way.
513
    pub(crate) fn delegate_authorized(
514
        &self,
515
        p: &crate::policy::Policy,
516
        signer: &KeyId,
517
        reference: &str,
518
    ) -> bool {
519
        if p.is_revoked(signer) {
520
            return false;
521
        }
522
        let Some(rule) = p.rule_for(reference) else {
523
            return false;
524
        };
525
        rule.keys.iter().any(|k| {
526
            !p.is_revoked(k)
527
                && p.identity(k)
528
                    .cloned()
529
                    .or_else(|| self.store.get_identity(k).ok())
530
                    .is_some_and(|id| id.delegates.contains(signer))
531
        })
532
    }
533
534
    fn check_ref_attest(
535
        &self,
536
        sa: &SignedAttest,
537
        name: &str,
538
        old_state: &ObjectRef,
539
        new_state: &ObjectRef,
540
        last_serial: Option<u64>,
541
        allow_equal: bool,
542
    ) -> std::result::Result<u64, String> {
543
        let AttestBody::Ref {
544
            name: n,
545
            old_state: o,
546
            new_state: nw,
547
            serial,
548
        } = &sa.attest.body
549
        else {
550
            return Err("attestation is not a ref attestation".into());
551
        };
552
        if n != name || o != old_state || nw != new_state {
553
            return Err("attestation does not describe this update".into());
554
        }
555
        if sa.attest.repo != self.id().map_err(|e| e.to_string())? {
556
            return Err("attestation is for a different repository".into());
557
        }
558
        if let Some(last) = last_serial {
559
            if *serial < last || (*serial == last && !allow_equal) {
560
                return Err(format!(
561
                    "attestation serial {serial} is not greater than the last seen {last}"
562
                ));
563
            }
564
        }
565
        let r = sa.attest.hash();
566
        let sig = sa.sigs.first().ok_or("attestation carries no signature")?;
567
        let id = self
568
            .store
569
            .get_identity(&sig.key)
570
            .map_err(|_| format!("unknown key {}", sig.key.short(12)))?;
571
        verify_signature(&id, sig, Domain::Attest, &r).map_err(|e| e.to_string())?;
572
        Ok(*serial)
573
    }
574
575
    /// Accept a push (spec §16.4). Without a trust policy every repository
576
    /// is unverified, so unsigned changes and unattested updates are accepted;
577
    /// attestations that are present must still be valid. With a policy,
578
    /// every change and update is checked against it. A newer policy in the
579
    /// push is applied first when it is signed by the current roots.
580
    pub fn receive_push(
581
        &self,
582
        bundle: Bundle,
583
        updates: Vec<RefUpdate>,
584
        policy: Option<SignedPolicy>,
585
        tags: Vec<crate::protocol::TagRef>,
586
    ) -> Result<Vec<RefResult>> {
587
        Ok(self
588
            .receive_push_report(bundle, updates, policy, tags)?
589
            .results)
590
    }
591
592
    /// `receive_push` with what a host wants to log: each accepted
593
    /// reference's old and new state and heads, and the changes this push
594
    /// stored (hub spec §6.12).
595
    pub fn receive_push_report(
596
        &self,
597
        bundle: Bundle,
598
        updates: Vec<RefUpdate>,
599
        policy: Option<SignedPolicy>,
600
        tags: Vec<crate::protocol::TagRef>,
601
    ) -> Result<PushReport> {
602
        let mut report = PushReport::default();
603
        let results = &mut report.results;
604
        if let Some(sp) = policy {
605
            match self.adopt_policy_chain(&bundle.policies, &sp, "push received") {
606
                Ok(()) => {
607
                    results.push(RefResult {
608
                        name: "policy".into(),
609
                        ok: true,
610
                        reason: format!("serial {}", sp.policy.serial),
611
                    });
612
                }
613
                Err(e) => {
614
                    results.push(RefResult {
615
                        name: "policy".into(),
616
                        ok: false,
617
                        reason: e,
618
                    });
619
                    for u in updates {
620
                        results.push(RefResult {
621
                            name: u.name,
622
                            ok: false,
623
                            reason: "policy update was rejected".into(),
624
                        });
625
                    }
626
                    return Ok(report);
627
                }
628
            }
629
        }
630
        let policy = self.current_policy()?.map(|(_, sp)| sp.policy);
631
        match self.import_bundle(&bundle, policy.is_some()) {
632
            Ok(imported) => report.imported = imported,
633
            Err(e) => {
634
                for u in updates {
635
                    results.push(RefResult {
636
                        name: u.name,
637
                        ok: false,
638
                        reason: e.to_string(),
639
                    });
640
                }
641
                return Ok(report);
642
            }
643
        }
644
        let (op_ref, op) = self.head_op()?;
645
        let mut view = op.view.clone();
646
        let mut names = Vec::new();
647
        for u in updates {
648
            let outcome = self.apply_update(&mut view, &u, policy.as_ref());
649
            let (ok, reason) = match outcome {
650
                Ok(()) => (true, String::new()),
651
                Err(e) => (false, e),
652
            };
653
            if ok {
654
                names.push(u.name.clone());
655
                let heads = self
656
                    .store
657
                    .get_state(&u.new_state)
658
                    .map(|s| s.heads)
659
                    .unwrap_or_default();
660
                report.updated.push(RefUpdated {
661
                    name: u.name.clone(),
662
                    old_state: u.old_state,
663
                    new_state: u.new_state,
664
                    heads,
665
                });
666
            }
667
            results.push(RefResult {
668
                name: u.name,
669
                ok,
670
                reason,
671
            });
672
        }
673
        for t in &tags {
674
            let name = format!("tags/{}", t.name);
675
            match self.adopt_tag(&mut view, t, policy.as_ref()) {
676
                Ok(()) => {
677
                    names.push(name.clone());
678
                    results.push(RefResult {
679
                        name,
680
                        ok: true,
681
                        reason: String::new(),
682
                    });
683
                }
684
                Err(e) => results.push(RefResult {
685
                    name,
686
                    ok: false,
687
                    reason: e,
688
                }),
689
            }
690
        }
691
        if !names.is_empty() {
692
            self.record_op(
693
                &[op_ref],
694
                &format!("push received: {}", names.join(" ")),
695
                view,
696
            )?;
697
        }
698
        Ok(report)
699
    }
700
701
    /// Check an update's attestation against the latest one for its
702
    /// reference and store it as the new latest. Failures say what was
703
    /// being done, for which reference, so a refused push can be diagnosed
704
    /// from its reason alone.
705
    fn record_update_attest(
706
        &self,
707
        u: &RefUpdate,
708
        sa: &SignedAttest,
709
    ) -> std::result::Result<(), String> {
710
        let name = &u.name;
711
        let last = self
712
            .latest_ref_attest(name)
713
            .map_err(|e| format!("reading the last attestation of {name:?}: {e}"))?
714
            .and_then(|(_, a)| match a.attest.body {
715
                AttestBody::Ref { serial, .. } => Some(serial),
716
                _ => None,
717
            });
718
        self.check_ref_attest(sa, name, &u.old_state, &u.new_state, last, false)?;
719
        let store = |e: &dyn std::fmt::Display| format!("storing the attestation of {name:?}: {e}");
720
        let r = self.store.put_attest(&sa.attest).map_err(|e| store(&e))?;
721
        for sig in &sa.sigs {
722
            self.store.put_signature(&r, sig).map_err(|e| store(&e))?;
723
        }
724
        self.set_ref_attest(name, &r).map_err(|e| store(&e))
725
    }
726
727
    /// A deletion (spec §16.4): `new_state` is zero. The bookmark must exist
728
    /// at `old_state`, is never the bookmark a non-bare repository has
729
    /// checked out (a bare one's default is its host's to protect, see
730
    /// `oxy_server::Backend::default_bookmark`), and under a policy needs
731
    /// an attestation by a key that may update it.
732
    /// The deletion's attestation stays the bookmark's latest, so an older
733
    /// one cannot be replayed to bring it back.
734
    fn apply_deletion(
735
        &self,
736
        view: &mut View,
737
        u: &RefUpdate,
738
        policy: Option<&crate::policy::Policy>,
739
    ) -> std::result::Result<(), String> {
740
        let Some(current) = view.bookmarks.get(&u.name).copied() else {
741
            return Err(format!("no bookmark {:?} to delete", u.name));
742
        };
743
        if current != u.old_state {
744
            return Err("stale: the remote bookmark has moved; pull first".into());
745
        }
746
        if !self.is_bare() && u.name == self.config.bookmark {
747
            return Err(format!(
748
                "{:?} is this repository's default bookmark (checked out there) and cannot be deleted",
749
                u.name
750
            ));
751
        }
752
        if let Some(p) = policy {
753
            let Some(sa) = &u.attestation else {
754
                return Err(format!(
755
                    "deleting {:?} requires a signed reference attestation under this repository's policy",
756
                    u.name
757
                ));
758
            };
759
            let signer = sa
760
                .sigs
761
                .first()
762
                .map(|s| s.key)
763
                .ok_or("attestation carries no signature")?;
764
            if !p.authorizes(&signer, &u.name) && !self.delegate_authorized(p, &signer, &u.name) {
765
                return Err(format!(
766
                    "key {} may not delete {:?} under this repository's policy",
767
                    signer.short(12),
768
                    u.name
769
                ));
770
            }
771
        }
772
        if let Some(sa) = &u.attestation {
773
            self.record_update_attest(u, sa)?;
774
        }
775
        view.bookmarks.remove(&u.name);
776
        Ok(())
777
    }
778
779
    fn apply_update(
780
        &self,
781
        view: &mut View,
782
        u: &RefUpdate,
783
        policy: Option<&crate::policy::Policy>,
784
    ) -> std::result::Result<(), String> {
785
        if u.name == "policy" {
786
            return Err(
787
                "the policy reference is updated by sending a policy, not a bookmark update".into(),
788
            );
789
        }
790
        let empty = self
791
            .store
792
            .put_state(&StateObject::new(vec![]))
793
            .map_err(|e| e.to_string())?;
794
        if u.new_state.is_zero() {
795
            return self.apply_deletion(view, u, policy);
796
        }
797
        let current = view.bookmarks.get(&u.name).copied().unwrap_or(empty);
798
        if current != u.old_state {
799
            return Err("stale: the remote bookmark has moved; pull first".into());
800
        }
801
        let new_state = self
802
            .store
803
            .get_state(&u.new_state)
804
            .map_err(|_| "new state object is missing".to_string())?;
805
        for h in &new_state.heads {
806
            if !self.store.has(h) {
807
                return Err(format!("head {} is missing", h.short(12)));
808
            }
809
        }
810
        if !u.force {
811
            let old_heads = self
812
                .store
813
                .get_state(&current)
814
                .map_err(|e| e.to_string())?
815
                .heads;
816
            let closure = self
817
                .closure_in_store(&new_state.heads)
818
                .map_err(|e| e.to_string())?;
819
            if let Some(h) = old_heads.iter().find(|h| !closure.contains(h)) {
820
                return Err(format!(
821
                    "not a fast-forward: current head {} would be dropped (use --force)",
822
                    h.short(12)
823
                ));
824
            }
825
        }
826
        if let Some(p) = policy {
827
            let Some(sa) = &u.attestation else {
828
                return Err(format!(
829
                    "{:?} requires a signed reference attestation under this repository's policy",
830
                    u.name
831
                ));
832
            };
833
            let signer = sa
834
                .sigs
835
                .first()
836
                .map(|s| s.key)
837
                .ok_or("attestation carries no signature")?;
838
            if !p.authorizes(&signer, &u.name) && !self.delegate_authorized(p, &signer, &u.name) {
839
                return Err(format!(
840
                    "key {} may not update {:?} under this repository's policy",
841
                    signer.short(12),
842
                    u.name
843
                ));
844
            }
845
            let old_heads = self
846
                .store
847
                .get_state(&current)
848
                .map_err(|e| e.to_string())?
849
                .heads;
850
            self.state_allowed(&old_heads, &new_state.heads, p, &u.name)?;
851
        }
852
        if let Some(sa) = &u.attestation {
853
            self.record_update_attest(u, sa)?;
854
        }
855
        view.bookmarks.insert(u.name.clone(), u.new_state);
856
        Ok(())
857
    }
858
859
    // ------------------------------------------------------------ client side
860
861
    fn remote_url(&self, name: &str) -> Result<String> {
862
        self.config.remotes.get(name).cloned().ok_or_else(|| {
863
            RepoError::Msg(format!(
864
                "no remote named {name:?}; add one with `oxy remote add`"
865
            ))
866
        })
867
    }
868
869
    /// Credentials and trust for a remote: `remote.<name>.token` (else
870
    /// `$OXY_TOKEN`) and `remote.<name>.ca` (else `$OXY_CA`).
871
    /// Refuse a remote that is another repository. An **unbound** remote
872
    /// (id all zero: a hosted repository nobody has pushed to) is accepted
873
    /// for pushes, which bind it to this repository's id (spec §16.1).
874
    fn check_remote_id(
875
        &self,
876
        remote: &dyn crate::protocol::Remote,
877
        remote_name: &str,
878
        allow_unbound: bool,
879
    ) -> Result<()> {
880
        let theirs = remote.repo_id()?;
881
        if theirs == self.id()? {
882
            return Ok(());
883
        }
884
        if theirs == crate::protocol::UNBOUND_ID {
885
            if allow_unbound {
886
                return Ok(());
887
            }
888
            return fail(format!(
889
                "remote {remote_name:?} is empty and unbound: push to it first"
890
            ));
891
        }
892
        fail(format!(
893
            "remote {remote_name:?} is a different repository (repository IDs differ); check its URL with `oxy remote list`"
894
        ))
895
    }
896
897
    pub(crate) fn remote_options(&self, name: &str) -> RemoteOptions {
898
        RemoteOptions {
899
            repo_id: self.id().ok(),
900
            token: self
901
                .config
902
                .remote_tokens
903
                .get(name)
904
                .cloned()
905
                .or_else(|| std::env::var("OXY_TOKEN").ok()),
906
            ca: self
907
                .config
908
                .remote_cas
909
                .get(name)
910
                .map(PathBuf::from)
911
                .or_else(|| std::env::var("OXY_CA").ok().map(PathBuf::from)),
912
        }
913
    }
914
915
    /// Push seal attestations on their own (hub spec §7.4): a bundle with
916
    /// no changes and no reference updates, which the receiver stores.
917
    pub fn push_seals(&self, remote_name: &str, seals: &[ObjectRef]) -> Result<()> {
918
        let remote = self.open_named_remote(remote_name)?;
919
        self.check_remote_id(remote.as_ref(), remote_name, false)?;
920
        let mut bundle = Bundle::default();
921
        for r in seals {
922
            let attest = self.store.get_attest(r)?;
923
            let sigs = self.store.signatures(r)?;
924
            bundle
925
                .attests
926
                .push(crate::protocol::SignedAttest { attest, sigs });
927
        }
928
        let results = remote.push(bundle, vec![], None, vec![])?;
929
        if let Some(r) = results.iter().find(|r| !r.ok) {
930
            return fail(format!("{}: {}", r.name, r.reason));
931
        }
932
        Ok(())
933
    }
934
935
    /// The remote whose URL starts with `base` (a hub), if configured.
936
    pub fn remote_for_url(&self, base: &str) -> Option<String> {
937
        let base = base.trim_end_matches('/');
938
        self.config
939
            .remotes
940
            .iter()
941
            .find(|(_, url)| url.trim_end_matches('/') == base)
942
            .map(|(name, _)| name.clone())
943
    }
944
945
    /// Open a remote by name or, failing that, by URL with the default
946
    /// credentials (`OXY_TOKEN`, `OXY_CA`).
947
    pub fn open_remote_at(&self, url: &str) -> Result<(String, Box<dyn crate::protocol::Remote>)> {
948
        if let Some(name) = self.remote_for_url(url) {
949
            return Ok((name.clone(), self.open_named_remote(&name)?));
950
        }
951
        let options = RemoteOptions {
952
            token: std::env::var("OXY_TOKEN").ok(),
953
            ca: std::env::var("OXY_CA").ok().map(PathBuf::from),
954
            repo_id: self.id().ok(),
955
        };
956
        Ok((url.to_string(), open_remote(url, &options)?))
957
    }
958
959
    /// Credentials for a URL: those of the configured remote with that
960
    /// URL, else the environment's.
961
    pub fn options_for_url(&self, url: &str) -> RemoteOptions {
962
        match self.remote_for_url(url) {
963
            Some(name) => self.remote_options(&name),
964
            None => RemoteOptions {
965
                token: std::env::var("OXY_TOKEN").ok(),
966
                ca: std::env::var("OXY_CA").ok().map(PathBuf::from),
967
                repo_id: self.id().ok(),
968
            },
969
        }
970
    }
971
972
    fn open_named_remote(&self, name: &str) -> Result<Box<dyn crate::protocol::Remote>> {
973
        open_remote(&self.remote_url(name)?, &self.remote_options(name))
974
    }
975
976
    fn serial_path(&self, remote: &str, bookmark: &str) -> PathBuf {
977
        self.oxy
978
            .join("remotes")
979
            .join(remote)
980
            .join(format!("{bookmark}.serial"))
981
    }
982
983
    fn last_seen_serial(&self, remote: &str, bookmark: &str) -> Option<u64> {
984
        fs::read_to_string(self.serial_path(remote, bookmark))
985
            .ok()
986
            .and_then(|s| s.trim().parse().ok())
987
    }
988
989
    fn record_serial(&self, remote: &str, bookmark: &str, serial: u64) -> Result<()> {
990
        let p = self.serial_path(remote, bookmark);
991
        fs::create_dir_all(p.parent().unwrap())?;
992
        write_atomic(&p, serial.to_string().as_bytes())
993
    }
994
995
    fn policy_serial_path(&self, remote: &str) -> PathBuf {
996
        self.oxy.join("remotes").join(remote).join("policy.serial")
997
    }
998
999
    /// The highest policy serial `remote` has ever presented.
1000
    fn remote_policy_serial(&self, remote: &str) -> Option<u64> {
1001
        fs::read_to_string(self.policy_serial_path(remote))
1002
            .ok()
1003
            .and_then(|s| s.trim().parse().ok())
1004
    }
1005
1006
    fn record_policy_serial(&self, remote: &str, serial: u64) -> Result<()> {
1007
        let p = self.policy_serial_path(remote);
1008
        fs::create_dir_all(p.parent().unwrap())?;
1009
        write_atomic(&p, serial.to_string().as_bytes())
1010
    }
1011
1012
    fn lazy_dir(&self) -> PathBuf {
1013
        self.oxy.join("lazy")
1014
    }
1015
1016
    /// Remember that `blob` was withheld by `remote` (spec §13.5).
1017
    fn register_lazy(&self, blob: &ObjectRef, remote: &str) -> Result<()> {
1018
        fs::create_dir_all(self.lazy_dir())?;
1019
        write_atomic(&self.lazy_dir().join(blob.to_hex()), remote.as_bytes())
1020
    }
1021
1022
    /// Which remote promised an absent blob, if any.
1023
    pub fn lazy_remote(&self, blob: &ObjectRef) -> Option<String> {
1024
        fs::read_to_string(self.lazy_dir().join(blob.to_hex()))
1025
            .ok()
1026
            .map(|s| s.trim().to_string())
1027
    }
1028
1029
    /// Fetch an absent blob (and its chunks) from the remote that promised it.
1030
    pub(crate) fn fetch_lazy_blob(&self, blob: &ObjectRef) -> Result<()> {
1031
        let Some(remote_name) = self.lazy_remote(blob) else {
1032
            return Err(RepoError::Store(StoreError::NotFound(*blob)));
1033
        };
1034
        let remote = self.open_named_remote(&remote_name)?;
1035
        let objects = remote.objects(&[*blob])?;
1036
        for (ty, body) in objects {
1037
            if matches!(ty, ObjectType::Blob | ObjectType::Chunk) {
1038
                self.store.put(ty, &body)?;
1039
            }
1040
        }
1041
        if !self.store.has(blob) {
1042
            return fail(format!(
1043
                "{remote_name} did not send blob {}",
1044
                blob.short(12)
1045
            ));
1046
        }
1047
        let _ = fs::remove_file(self.lazy_dir().join(blob.to_hex()));
1048
        Ok(())
1049
    }
1050
1051
    /// After importing from `remote`, record every blob the changes reference
1052
    /// that the store lacks as lazily available from that remote.
1053
    fn register_missing_blobs(&self, changes: &[ChangeHash], remote: &str) -> Result<usize> {
1054
        let mut n = 0;
1055
        for h in changes {
1056
            let c = self.store.get_change(h)?;
1057
            for e in &c.edits {
1058
                if let Edit::Replace { old, new, .. } = e {
1059
                    for b in [old, new].into_iter().flatten() {
1060
                        if !self.store.has(b) {
1061
                            self.register_lazy(b, remote)?;
1062
                            n += 1;
1063
                        }
1064
                    }
1065
                }
1066
            }
1067
        }
1068
        Ok(n)
1069
    }
1070
1071
    /// Every head this repository knows: bookmarks, remote tracking, working copy.
1072
    pub fn known_heads(&self, view: &View) -> Result<Vec<ChangeHash>> {
1073
        let mut have: BTreeSet<ChangeHash> = BTreeSet::new();
1074
        for st in view
1075
            .bookmarks
1076
            .values()
1077
            .chain(view.remotes.values().flat_map(|b| b.values()))
1078
        {
1079
            if let Ok(s) = self.store.get_state(st) {
1080
                have.extend(s.heads);
1081
            }
1082
        }
1083
        have.extend(view.workspaces.values().copied());
1084
        Ok(have.into_iter().collect())
1085
    }
1086
1087
    /// Fetch every bookmark of a remote into `remotes/<name>/bookmarks/*` (spec §10.2).
1088
    pub fn fetch(&self, remote_name: &str) -> Result<FetchReport> {
1089
        let remote = self.open_named_remote(remote_name)?;
1090
        self.check_remote_id(remote.as_ref(), remote_name, false)?;
1091
        let resp = remote.refs()?;
1092
        // Trust policy (spec §14.5). Adopt the remote's policy when it is newer
1093
        // and signed by roots we trust, or on first contact. A remote that
1094
        // once presented a policy may never present none or an older one:
1095
        // that is a downgrade. A remote that never presented one is
1096
        // unverified, and this fetch is checked only as far as possible.
1097
        let local_policy = self.current_policy()?.map(|(_, sp)| sp.policy);
1098
        let seen = self.remote_policy_serial(remote_name);
1099
        let mut unverified = false;
1100
        match &resp.policy {
1101
            Some(sp) => {
1102
                if seen.is_some_and(|s| sp.policy.serial < s) {
1103
                    return fail(format!("{remote_name} presents policy serial {} but presented {} before: refusing the downgrade", sp.policy.serial, seen.unwrap()));
1104
                }
1105
                match &local_policy {
1106
                    Some(l) if sp.policy.serial < l.serial => {}
1107
                    Some(l) if sp.policy.serial == l.serial => {
1108
                        if sp.policy.hash() != l.hash() {
1109
                            return fail(format!(
1110
                                "{remote_name} presents a different policy with the same serial {}",
1111
                                l.serial
1112
                            ));
1113
                        }
1114
                    }
1115
                    _ => {
1116
                        self.adopt_policy_chain(
1117
                            &resp.history,
1118
                            sp,
1119
                            &format!("oxy fetch {remote_name}"),
1120
                        )
1121
                        .map_err(|e| RepoError::Msg(format!("policy from {remote_name}: {e}")))?;
1122
                    }
1123
                }
1124
                self.record_policy_serial(remote_name, sp.policy.serial)?;
1125
            }
1126
            None => {
1127
                if seen.is_some() {
1128
                    return fail(format!("{remote_name} presented a policy before but has none now: refusing the downgrade"));
1129
                }
1130
                unverified = true;
1131
            }
1132
        }
1133
        let policy = if unverified {
1134
            None
1135
        } else {
1136
            self.current_policy()?.map(|(_, sp)| sp.policy)
1137
        };
1138
        let (op_ref, op) = self.head_op()?;
1139
        let mut view = op.view.clone();
1140
        let have = self.known_heads(&view)?;
1141
        let mut report = Vec::new();
1142
        let max_blob = self.config.max_blob;
1143
        for r in resp.refs {
1144
            let needed = remote.negotiate(&have, &r.heads)?;
1145
            let bundle = remote.fetch(&needed, max_blob)?;
1146
            // Changes are not individually re-verified here: the bookmark's
1147
            // attestation (checked below) binds its whole state, and the
1148
            // receiver of the push verified the added changes at that time.
1149
            let imported = self.import_bundle(&bundle, false)?;
1150
            if max_blob.is_some() {
1151
                self.register_missing_blobs(&imported, remote_name)?;
1152
            }
1153
            for h in &r.heads {
1154
                if !self.store.has(h) {
1155
                    return fail(format!("remote did not send head {}", h.short(12)));
1156
                }
1157
            }
1158
            let state = self.store.put_state(&StateObject::new(r.heads.clone()))?;
1159
            if state != r.state {
1160
                return fail(format!(
1161
                    "remote state {} does not match its heads",
1162
                    r.state.short(12)
1163
                ));
1164
            }
1165
            if let Some(p) = &policy {
1166
                let Some(sa) = &r.attestation else {
1167
                    return fail(format!(
1168
                        "{remote_name}/{} has no attestation, which its policy requires",
1169
                        r.name
1170
                    ));
1171
                };
1172
                let signer = sa
1173
                    .sigs
1174
                    .first()
1175
                    .map(|s| s.key)
1176
                    .ok_or_else(|| RepoError::Msg("attestation carries no signature".into()))?;
1177
                if !p.authorizes(&signer, &r.name) && !self.delegate_authorized(p, &signer, &r.name)
1178
                {
1179
                    return fail(format!(
1180
                        "{remote_name}/{}: attested by {}, which the policy does not authorize for this bookmark; a policy owner can grant it with `oxy policy grant`",
1181
                        r.name,
1182
                        signer.short(12)
1183
                    ));
1184
                }
1185
            }
1186
            if let Some(sa) = &r.attestation {
1187
                let AttestBody::Ref {
1188
                    old_state,
1189
                    new_state,
1190
                    ..
1191
                } = &sa.attest.body
1192
                else {
1193
                    return fail("remote sent a non-ref attestation for a bookmark");
1194
                };
1195
                let (old_state, new_state) = (*old_state, *new_state);
1196
                let serial = self
1197
                    .check_ref_attest(
1198
                        sa,
1199
                        &r.name,
1200
                        &old_state,
1201
                        &new_state,
1202
                        self.last_seen_serial(remote_name, &r.name),
1203
                        true,
1204
                    )
1205
                    .map_err(|e| {
1206
                        RepoError::Msg(format!("attestation for {}/{}: {e}", remote_name, r.name))
1207
                    })?;
1208
                if new_state != r.state {
1209
                    return fail(format!(
1210
                        "attestation for {}/{} does not cover its current state",
1211
                        remote_name, r.name
1212
                    ));
1213
                }
1214
                let ar = self.store.put_attest(&sa.attest)?;
1215
                for sig in &sa.sigs {
1216
                    self.store.put_signature(&ar, sig)?;
1217
                }
1218
                self.record_serial(remote_name, &r.name, serial)?;
1219
            }
1220
            view.remotes
1221
                .entry(remote_name.to_string())
1222
                .or_default()
1223
                .insert(r.name.clone(), state);
1224
            report.push((r.name, r.heads, imported.len()));
1225
        }
1226
        let mut new_tags = 0;
1227
        for t in &resp.tags {
1228
            if view.tags.contains_key(&t.name) {
1229
                continue;
1230
            }
1231
            // The tag's changes must be here: fetch them if the bookmarks did not bring them.
1232
            let missing: Vec<ChangeHash> = t
1233
                .heads
1234
                .iter()
1235
                .filter(|h| !self.store.has(h))
1236
                .copied()
1237
                .collect();
1238
            if !missing.is_empty() {
1239
                let needed = remote.negotiate(&self.known_heads(&view)?, &missing)?;
1240
                let bundle = remote.fetch(&needed, max_blob)?;
1241
                self.import_bundle(&bundle, false)?;
1242
            }
1243
            self.store.put_state(&StateObject::new(t.heads.clone()))?;
1244
            self.adopt_tag(&mut view, t, policy.as_ref())
1245
                .map_err(|e| RepoError::Msg(format!("{remote_name} {}: {e}", t.name)))?;
1246
            new_tags += 1;
1247
        }
1248
        if view != op.view {
1249
            self.record_op(&[op_ref], &format!("oxy fetch {remote_name}"), view)?;
1250
        }
1251
        let _ = self.run_hook(
1252
            "post-fetch",
1253
            &format!(
1254
                "{{\"event\":\"post-fetch\",\"remote\":{},\"bookmarks\":{}}}",
1255
                json_str(remote_name),
1256
                json_array(report.iter().map(|(n, heads, _)| format!(
1257
                    "{{\"name\":{},\"heads\":{}}}",
1258
                    json_str(n),
1259
                    json_array(heads.iter().map(|h| json_str(&h.to_hex())))
1260
                )))
1261
            ),
1262
        );
1263
        Ok(FetchReport {
1264
            refs: report,
1265
            unverified,
1266
            new_tags,
1267
        })
1268
    }
1269
1270
    /// Shallow fetch of the remote's bookmark: its checkpoint as our base,
1271
    /// the changes within `depth` steps of its heads, and the boundary below.
1272
    pub fn fetch_shallow(&self, remote_name: &str, depth: u32) -> Result<usize> {
1273
        let remote = self.open_named_remote(remote_name)?;
1274
        self.check_remote_id(remote.as_ref(), remote_name, false)?;
1275
        let resp = remote.refs()?;
1276
        let bookmark = self.config.bookmark.clone();
1277
        if let Some(sp) = &resp.policy {
1278
            self.adopt_policy_chain(&resp.history, sp, "oxy clone --depth")
1279
                .map_err(|e| RepoError::Msg(format!("policy from {remote_name}: {e}")))?;
1280
            self.record_policy_serial(remote_name, sp.policy.serial)?;
1281
        }
1282
        let Some(r) = resp.refs.into_iter().find(|r| r.name == bookmark) else {
1283
            return fail(format!("{remote_name} has no bookmark {bookmark:?}"));
1284
        };
1285
        if r.heads.is_empty() {
1286
            return Ok(0);
1287
        }
1288
        // Base: the remote's checkpoint of exactly these heads.
1289
        let cp_bundle = remote.checkpoint(&r.heads)?;
1290
        let mut cp_ref = None;
1291
        for (ty, body) in &cp_bundle.objects {
1292
            let put = self.store.put(*ty, body)?;
1293
            if *ty == ObjectType::Checkpoint {
1294
                cp_ref = Some(put);
1295
            }
1296
        }
1297
        let Some(cp_ref) = cp_ref else {
1298
            return fail(format!("{remote_name} sent no checkpoint"));
1299
        };
1300
        self.install_checkpoint(&bookmark, &cp_ref)?;
1301
        // History window.
1302
        let wanted = remote.shallow(&r.heads, depth)?;
1303
        let bundle = remote.fetch(&wanted, self.config.max_blob)?;
1304
        let imported = self.import_bundle_shallow(&bundle, false)?;
1305
        if self.config.max_blob.is_some() {
1306
            self.register_missing_blobs(&imported, remote_name)?;
1307
        }
1308
        self.refresh_boundary(&imported)?;
1309
        if let Some(sa) = &r.attestation {
1310
            let ar = self.store.put_attest(&sa.attest)?;
1311
            for sig in &sa.sigs {
1312
                self.store.put_signature(&ar, sig)?;
1313
            }
1314
            if let AttestBody::Ref { serial, .. } = sa.attest.body {
1315
                self.record_serial(remote_name, &r.name, serial)?;
1316
            }
1317
        }
1318
        let state = self.store.put_state(&StateObject::new(r.heads.clone()))?;
1319
        let (op_ref, op) = self.head_op()?;
1320
        let mut view = op.view.clone();
1321
        view.remotes
1322
            .entry(remote_name.to_string())
1323
            .or_default()
1324
            .insert(r.name.clone(), state);
1325
        self.record_op(
1326
            &[op_ref],
1327
            &format!("oxy fetch {remote_name} --depth {depth}"),
1328
            view,
1329
        )?;
1330
        Ok(imported.len())
1331
    }
1332
1333
    /// Fetch, then take the union of the local bookmark's state with the
1334
    /// remote's: no merge change, conflicts become reified (spec §9.4).
1335
    pub fn pull(&self, remote_name: &str) -> Result<PullReport> {
1336
        let _wc = self.lock_working_copy()?;
1337
        self.fetch(remote_name)?;
1338
        let (op_ref, op) = self.head_op()?;
1339
        let bookmark = self.config.bookmark.clone();
1340
        let local = self.heads_of(&op.view, &bookmark)?;
1341
        let Some(remote_state) = op
1342
            .view
1343
            .remotes
1344
            .get(remote_name)
1345
            .and_then(|b| b.get(&bookmark))
1346
            .copied()
1347
        else {
1348
            return Ok(PullReport {
1349
                heads: local,
1350
                changed: false,
1351
                checked_out: false,
1352
            });
1353
        };
1354
        let remote_heads = self.store.get_state(&remote_state)?.heads;
1355
        let mut all = local.clone();
1356
        all.extend(remote_heads);
1357
        let st = self.load_state_history(&all)?;
1358
        let mut heads = st.maximal(&all);
1359
        heads.sort();
1360
        let mut sorted_local = local.clone();
1361
        sorted_local.sort();
1362
        if heads == sorted_local {
1363
            return Ok(PullReport {
1364
                heads,
1365
                changed: false,
1366
                checked_out: false,
1367
            });
1368
        }
1369
        let mut view = op.view.clone();
1370
        view.bookmarks.insert(
1371
            bookmark.clone(),
1372
            self.store.put_state(&StateObject::new(heads.clone()))?,
1373
        );
1374
        self.record_op(&[op_ref], &format!("oxy pull {remote_name}"), view)?;
1375
        // Follow along if the working copy was clean and on the old heads.
1376
        let snap = self.snapshot("oxy pull")?;
1377
        let clean = snap.wc.tree_ops.is_empty() && snap.wc.edits.is_empty();
1378
        let mut base = snap.base.maximal(&snap.wc.deps);
1379
        base.sort();
1380
        let mut checked_out = false;
1381
        if clean && base == sorted_local {
1382
            self.checkout(&heads, false, "oxy pull (checkout)")?;
1383
            checked_out = true;
1384
        }
1385
        Ok(PullReport {
1386
            heads,
1387
            changed: true,
1388
            checked_out,
1389
        })
1390
    }
1391
1392
    /// Push the current bookmark (spec §16.3), sealing this author's unsigned
1393
    /// changes and attesting the reference when a key is available.
1394
    /// Delete `bookmark` on a remote (spec §16.4): an update to the zero
1395
    /// state, attested when we have an identity. The local bookmark, if
1396
    /// any, is kept; only the remote-tracking entry goes.
1397
    pub fn push_delete(&self, remote_name: &str, bookmark: &str) -> Result<Vec<RefResult>> {
1398
        let remote = self.open_named_remote(remote_name)?;
1399
        self.check_remote_id(remote.as_ref(), remote_name, true)?;
1400
        let resp = remote.refs()?;
1401
        let Some(r) = resp.refs.iter().find(|r| r.name == bookmark) else {
1402
            return fail(format!("{remote_name} has no bookmark {bookmark}"));
1403
        };
1404
        if resp.policy.is_some() && self.secret_key()?.is_none() {
1405
            return fail(format!("{remote_name} enforces a trust policy; deleting needs an identity (`oxy identity create`)"));
1406
        }
1407
        let attestation = match self.secret_key()? {
1408
            Some(_) => Some(self.sign_attest(&Attest {
1409
                repo: self.id()?,
1410
                hlc: Hlc::now(),
1411
                body: AttestBody::Ref {
1412
                    name: bookmark.to_string(),
1413
                    old_state: r.state,
1414
                    new_state: ObjectRef::ZERO,
1415
                    serial: r.last_serial.unwrap_or(0) + 1,
1416
                },
1417
            })?),
1418
            None => None,
1419
        };
1420
        let results = remote.push(
1421
            Bundle::default(),
1422
            vec![RefUpdate {
1423
                name: bookmark.to_string(),
1424
                old_state: r.state,
1425
                new_state: ObjectRef::ZERO,
1426
                force: true,
1427
                attestation,
1428
            }],
1429
            None,
1430
            vec![],
1431
        )?;
1432
        if results.iter().any(|x| x.ok && x.name == bookmark) {
1433
            let (op_ref, op) = self.head_op()?;
1434
            let mut view = op.view.clone();
1435
            if let Some(m) = view.remotes.get_mut(remote_name) {
1436
                m.remove(bookmark);
1437
            }
1438
            self.record_op(
1439
                &[op_ref],
1440
                &format!("oxy push {remote_name} --delete {bookmark}"),
1441
                view,
1442
            )?;
1443
        }
1444
        Ok(results)
1445
    }
1446
1447
    pub fn push(&self, remote_name: &str, force: bool) -> Result<Vec<RefResult>> {
1448
        let bookmark = self.config.bookmark.clone();
1449
        self.push_bookmark(remote_name, &bookmark, force)
1450
    }
1451
1452
    /// `push` for a named bookmark (`oxy push -b NAME`).
1453
    pub fn push_bookmark(
1454
        &self,
1455
        remote_name: &str,
1456
        bookmark: &str,
1457
        force: bool,
1458
    ) -> Result<Vec<RefResult>> {
1459
        let (op_ref, op) = self.head_op()?;
1460
        if !op.view.bookmarks.contains_key(bookmark) {
1461
            return fail(format!("no bookmark {bookmark}"));
1462
        }
1463
        let bookmark = bookmark.to_string();
1464
        let local_heads = self.heads_of(&op.view, &bookmark)?;
1465
        // pre-push hook: may veto before the remote is contacted.
1466
        self.run_hook(
1467
            "pre-push",
1468
            &format!(
1469
                "{{\"event\":\"pre-push\",\"remote\":{},\"bookmark\":{},\"heads\":{}}}",
1470
                json_str(remote_name),
1471
                json_str(&bookmark),
1472
                json_array(local_heads.iter().map(|h| json_str(&h.to_hex())))
1473
            ),
1474
        )?;
1475
        let remote = self.open_named_remote(remote_name)?;
1476
        self.check_remote_id(remote.as_ref(), remote_name, true)?;
1477
        let resp = remote.refs()?;
1478
        let local_policy = self.current_policy()?.map(|(_, sp)| sp);
1479
        let resp_policy_serial = resp.policy.as_ref().map(|p| p.policy.serial);
1480
        let policy_to_send = match (&local_policy, &resp.policy) {
1481
            (Some(l), Some(r)) if l.policy.serial > r.policy.serial => Some(l.clone()),
1482
            (Some(l), None) => Some(l.clone()),
1483
            (Some(l), Some(r)) if l.policy.serial < r.policy.serial => {
1484
                return fail(format!(
1485
                    "{remote_name} has a newer policy (serial {}); fetch first",
1486
                    r.policy.serial
1487
                ));
1488
            }
1489
            _ => None,
1490
        };
1491
        let remote_has_policy = resp.policy.is_some() || policy_to_send.is_some();
1492
        if remote_has_policy && self.secret_key()?.is_none() {
1493
            return fail(format!("{remote_name} enforces a trust policy; pushing needs an identity (`oxy identity create`)"));
1494
        }
1495
        let remote_tags: BTreeSet<String> = resp.tags.iter().map(|t| t.name.clone()).collect();
1496
        let tags_to_send: Vec<crate::protocol::TagRef> = self
1497
            .tag_refs()?
1498
            .into_iter()
1499
            .filter(|t| !remote_tags.contains(&t.name))
1500
            .collect();
1501
        let refs = resp.refs;
1502
        let empty = self.store.put_state(&StateObject::new(vec![]))?;
1503
        let (remote_state, remote_heads, last_serial) =
1504
            match refs.iter().find(|r| r.name == bookmark) {
1505
                Some(r) => (r.state, r.heads.clone(), r.last_serial),
1506
                None => (empty, vec![], None),
1507
            };
1508
        let new_state = self
1509
            .store
1510
            .put_state(&StateObject::new(local_heads.clone()))?;
1511
        // A push that carries a policy re-attests the bookmark even when its
1512
        // state is unchanged, so the current attestation is always by a key
1513
        // the current policy authorizes (a revoked key's attestation would
1514
        // otherwise be refused by every later fetch).
1515
        if new_state == remote_state && policy_to_send.is_none() && tags_to_send.is_empty() {
1516
            return Ok(vec![RefResult {
1517
                name: bookmark,
1518
                ok: true,
1519
                reason: "already up to date".into(),
1520
            }]);
1521
        }
1522
        for h in &remote_heads {
1523
            if !self.store.has(h) {
1524
                return fail(format!(
1525
                    "the remote has change {} which you do not; pull first (`oxy pull {remote_name}`), then push again",
1526
                    h.short(12)
1527
                ));
1528
            }
1529
        }
1530
        if !force {
1531
            let closure = self.closure_in_store(&local_heads)?;
1532
            if let Some(h) = remote_heads.iter().find(|h| !closure.contains(h)) {
1533
                return fail(format!("not a fast-forward: remote head {} is not in your state; pull first or use --force", h.short(12)));
1534
            }
1535
        }
1536
        let to_send = self.negotiate(&remote_heads, &local_heads)?;
1537
        let mut bundle = self.bundle_for(&to_send)?;
1538
        let key = self.secret_key()?.map(|(k, _)| k);
1539
        if let Some(key) = key {
1540
            // Seal this author's changes that carry no valid authenticator,
1541
            // and adopt anonymous ones (zero author, spec §14.4).
1542
            let mut unsigned = Vec::new();
1543
            for h in &to_send {
1544
                let c = self.store.get_change(h)?;
1545
                if (c.author == key || c.author.is_zero())
1546
                    && !matches!(self.authenticate_change(h)?, SignatureStatus::Valid { .. })
1547
                {
1548
                    unsigned.push(*h);
1549
                }
1550
            }
1551
            for chunk in unsigned.chunks(crate::attest::MAX_SEAL_HASHES) {
1552
                let sa = self.sign_attest(&Attest::seal(self.id()?, chunk.to_vec()))?;
1553
                bundle.attests.push(sa);
1554
            }
1555
            bundle = self.bundle_for(&to_send)?;
1556
        }
1557
        bundle.objects.push((
1558
            ObjectType::State,
1559
            StateObject::new(local_heads.clone()).encode(),
1560
        ));
1561
        let attestation = match key {
1562
            Some(_) => Some(self.sign_attest(&Attest {
1563
                repo: self.id()?,
1564
                hlc: Hlc::now(),
1565
                body: AttestBody::Ref {
1566
                    name: bookmark.clone(),
1567
                    old_state: remote_state,
1568
                    new_state,
1569
                    serial: next_serial(last_serial),
1570
                },
1571
            })?),
1572
            None => None,
1573
        };
1574
        let serial = attestation.as_ref().and_then(|a| match a.attest.body {
1575
            AttestBody::Ref { serial, .. } => Some(serial),
1576
            _ => None,
1577
        });
1578
        let sent_serial = policy_to_send.as_ref().map(|p| p.policy.serial);
1579
        // Tag states must be present on the remote: bundle their changes too.
1580
        for t in &tags_to_send {
1581
            let extra = self.negotiate(&remote_heads, &t.heads)?;
1582
            let extra: Vec<ChangeHash> =
1583
                extra.into_iter().filter(|h| !to_send.contains(h)).collect();
1584
            if !extra.is_empty() {
1585
                let more = self.bundle_for(&extra)?;
1586
                bundle.changes.extend(more.changes);
1587
                bundle.hashes.extend(more.hashes);
1588
                bundle.attests.extend(more.attests);
1589
                bundle.objects.extend(more.objects);
1590
            }
1591
            bundle.objects.push((
1592
                ObjectType::State,
1593
                StateObject::new(t.heads.clone()).encode(),
1594
            ));
1595
        }
1596
        if let Some(l) = &policy_to_send {
1597
            let remote_serial = resp_policy_serial;
1598
            bundle.policies = self
1599
                .policy_history()?
1600
                .into_iter()
1601
                .filter(|sp| {
1602
                    remote_serial.is_none_or(|r| sp.policy.serial > r)
1603
                        && sp.policy.serial < l.policy.serial
1604
                })
1605
                .collect();
1606
        }
1607
        let results = remote.push(
1608
            bundle,
1609
            vec![RefUpdate {
1610
                name: bookmark.clone(),
1611
                old_state: remote_state,
1612
                new_state,
1613
                force,
1614
                attestation,
1615
            }],
1616
            policy_to_send,
1617
            tags_to_send,
1618
        )?;
1619
        if let (Some(serial), true) = (
1620
            sent_serial,
1621
            results.iter().any(|r| r.ok && r.name == "policy"),
1622
        ) {
1623
            self.record_policy_serial(remote_name, serial)?;
1624
        }
1625
        if results.iter().any(|r| r.ok && r.name == bookmark) {
1626
            let mut view = op.view.clone();
1627
            view.remotes
1628
                .entry(remote_name.to_string())
1629
                .or_default()
1630
                .insert(bookmark.clone(), new_state);
1631
            self.record_op(&[op_ref], &format!("oxy push {remote_name}"), view)?;
1632
            if let Some(s) = serial {
1633
                self.record_serial(remote_name, &bookmark, s)?;
1634
            }
1635
        }
1636
        Ok(results)
1637
    }
1638
1639
    /// Clone a remote into `dest`: same repository ID, `origin` remote,
1640
    /// bookmark set to the remote's, working copy checked out.
1641
    pub fn clone(url: &str, dest: &Path) -> Result<Repo> {
1642
        Self::clone_with(url, dest, None, &[])
1643
    }
1644
1645
    /// Clone, leaving blobs above `max_blob` bytes to be fetched on first
1646
    /// read, and materializing only `sparse` paths (which implies lazy blobs
1647
    /// unless a size is given, so out-of-scope binaries are never fetched).
1648
    pub fn clone_with(
1649
        url: &str,
1650
        dest: &Path,
1651
        max_blob: Option<u64>,
1652
        sparse: &[String],
1653
    ) -> Result<Repo> {
1654
        Self::clone_full(url, dest, max_blob, sparse, None)
1655
    }
1656
1657
    /// Shallow clone (spec §17): a checkpoint of the bookmark's heads plus the
1658
    /// changes within `depth` steps of them; the rest is the boundary.
1659
    pub fn clone_shallow(
1660
        url: &str,
1661
        dest: &Path,
1662
        depth: u32,
1663
        max_blob: Option<u64>,
1664
        sparse: &[String],
1665
    ) -> Result<Repo> {
1666
        Self::clone_full(url, dest, max_blob, sparse, Some(depth))
1667
    }
1668
1669
    fn clone_full(
1670
        url: &str,
1671
        dest: &Path,
1672
        max_blob: Option<u64>,
1673
        sparse: &[String],
1674
        depth: Option<u32>,
1675
    ) -> Result<Repo> {
1676
        let options = RemoteOptions {
1677
            token: std::env::var("OXY_TOKEN").ok(),
1678
            ca: std::env::var("OXY_CA").ok().map(PathBuf::from),
1679
            repo_id: None,
1680
        };
1681
        Self::clone_using(url, dest, max_blob, sparse, depth, &options, false)
1682
    }
1683
1684
    /// Clone a subrepo with credentials the parent has for the same hub
1685
    /// (see [`Repo::credentials_for`]), recording them on its `origin` so it
1686
    /// fetches and pushes with them after.
1687
    pub(crate) fn clone_as_subrepo(&self, url: &str, dest: &Path) -> Result<Repo> {
1688
        // Only credentials from a remote are recorded; the environment's
1689
        // stay in the environment.
1690
        let borrowed = self.remote_on_same_hub(url).is_some();
1691
        let options = self.credentials_for(url);
1692
        Self::clone_using(url, dest, None, &[], None, &options, borrowed)
1693
    }
1694
1695
    /// The name of a remote of this repository on the same hub (scheme,
1696
    /// host and port) as `url`.
1697
    fn remote_on_same_hub(&self, url: &str) -> Option<String> {
1698
        let origin = |u: &str| -> Option<String> {
1699
            let (scheme, rest) = u.split_once("://")?;
1700
            let host = rest.split('/').next()?;
1701
            Some(format!(
1702
                "{}://{}",
1703
                scheme.to_ascii_lowercase(),
1704
                host.to_ascii_lowercase()
1705
            ))
1706
        };
1707
        let want = origin(url)?;
1708
        self.config
1709
            .remotes
1710
            .iter()
1711
            .find(|(_, u)| origin(u).as_deref() == Some(want.as_str()))
1712
            .map(|(name, _)| name.clone())
1713
    }
1714
1715
    /// The token and CA to reach `url` with: those of a remote of this
1716
    /// repository on the same hub (scheme, host and port), else the
1717
    /// environment's (`OXY_TOKEN`, `OXY_CA`), as a clone would use them.
1718
    pub(crate) fn credentials_for(&self, url: &str) -> RemoteOptions {
1719
        match self.remote_on_same_hub(url) {
1720
            Some(name) => RemoteOptions {
1721
                repo_id: None,
1722
                ..self.remote_options(&name)
1723
            },
1724
            None => RemoteOptions {
1725
                token: std::env::var("OXY_TOKEN").ok(),
1726
                ca: std::env::var("OXY_CA").ok().map(PathBuf::from),
1727
                repo_id: None,
1728
            },
1729
        }
1730
    }
1731
1732
    fn clone_using(
1733
        url: &str,
1734
        dest: &Path,
1735
        max_blob: Option<u64>,
1736
        sparse: &[String],
1737
        depth: Option<u32>,
1738
        options: &RemoteOptions,
1739
        record: bool,
1740
    ) -> Result<Repo> {
1741
        let remote = open_remote(url, options)?;
1742
        let id = remote.repo_id()?;
1743
        if id == crate::protocol::UNBOUND_ID {
1744
            return fail(format!(
1745
                "{url} is empty and unbound: push a repository to it first"
1746
            ));
1747
        }
1748
        let mut repo = Repo::init_with_id(dest, id)?;
1749
        repo.config.set("remote.origin.url", url)?;
1750
        if record {
1751
            if let Some(t) = &options.token {
1752
                repo.config.set("remote.origin.token", t)?;
1753
            }
1754
            if let Some(ca) = &options.ca {
1755
                repo.config.set("remote.origin.ca", &ca.to_string_lossy())?;
1756
            }
1757
        }
1758
        if let Some(m) = max_blob {
1759
            repo.config.set("filter.max-blob", &m.to_string())?;
1760
        } else if !sparse.is_empty() {
1761
            repo.config.set("filter.max-blob", "0")?;
1762
        }
1763
        if !sparse.is_empty() {
1764
            repo.config.set("filter.paths", &sparse.join(","))?;
1765
        }
1766
        repo.save_config()?;
1767
        if let Some(depth) = depth {
1768
            repo.fetch_shallow("origin", depth)?;
1769
        } else {
1770
            repo.fetch("origin")?;
1771
        }
1772
        let (op_ref, op) = repo.head_op()?;
1773
        let bookmark = repo.config.bookmark.clone();
1774
        if let Some(state) = op
1775
            .view
1776
            .remotes
1777
            .get("origin")
1778
            .and_then(|b| b.get(&bookmark))
1779
            .copied()
1780
        {
1781
            let heads = repo.store.get_state(&state)?.heads;
1782
            let mut view = op.view.clone();
1783
            view.bookmarks.insert(bookmark, state);
1784
            repo.record_op(&[op_ref], &format!("oxy clone {url}"), view)?;
1785
            repo.checkout(&heads, false, "oxy clone (checkout)")?;
1786
        }
1787
        Ok(repo)
1788
    }
1789
}
1790
1791
/// The serial of a reference's next attestation: one more than the last the
1792
/// remote reports, or, for a bookmark the remote does not have, the clock in
1793
/// milliseconds, so a bookmark created again after a deletion goes past the
1794
/// deletion's serial the remote keeps.
1795
fn next_serial(last: Option<u64>) -> u64 {
1796
    match last {
1797
        Some(l) => l + 1,
1798
        None => Hlc::now().wall_ms.max(1),
1799
    }
1800
}