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