1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
use std::path::PathBuf;
use git_features::threading::OwnShared;
use crate::{config, config::cache::interpolate_context, permission, Permissions, ThreadSafeRepository};
#[derive(Debug, Clone)]
pub enum ReplacementObjects {
UseWithEnvironmentRefPrefixOrDefault {
allow_disable_via_environment: bool,
},
UseWithRefPrefix {
prefix: PathBuf,
allow_disable_via_environment: bool,
},
Disable,
}
impl Default for ReplacementObjects {
fn default() -> Self {
ReplacementObjects::UseWithEnvironmentRefPrefixOrDefault {
allow_disable_via_environment: true,
}
}
}
impl ReplacementObjects {
fn refs_prefix(self) -> Option<PathBuf> {
use ReplacementObjects::*;
let is_disabled = |allow_env: bool| allow_env && std::env::var_os("GIT_NO_REPLACE_OBJECTS").is_some();
match self {
UseWithEnvironmentRefPrefixOrDefault {
allow_disable_via_environment,
} => {
if is_disabled(allow_disable_via_environment) {
return None;
};
PathBuf::from(std::env::var("GIT_REPLACE_REF_BASE").unwrap_or_else(|_| "refs/replace/".into())).into()
}
UseWithRefPrefix {
prefix,
allow_disable_via_environment,
} => {
if is_disabled(allow_disable_via_environment) {
return None;
};
prefix.into()
}
Disable => None,
}
}
}
#[derive(Clone)]
pub struct Options {
pub(crate) object_store_slots: git_odb::store::init::Slots,
pub(crate) replacement_objects: ReplacementObjects,
pub permissions: Permissions,
pub(crate) git_dir_trust: Option<git_sec::Trust>,
pub(crate) filter_config_section: Option<fn(&git_config::file::Metadata) -> bool>,
pub(crate) lossy_config: Option<bool>,
pub(crate) lenient_config: bool,
pub(crate) bail_if_untrusted: bool,
}
impl Default for Options {
fn default() -> Self {
Options {
object_store_slots: Default::default(),
replacement_objects: Default::default(),
permissions: Default::default(),
git_dir_trust: None,
filter_config_section: None,
lossy_config: None,
lenient_config: true,
bail_if_untrusted: false,
}
}
}
#[derive(Default, Clone)]
pub(crate) struct EnvironmentOverrides {
worktree_dir: Option<PathBuf>,
git_dir: Option<PathBuf>,
}
impl EnvironmentOverrides {
fn from_env() -> Result<Self, permission::env_var::resource::Error> {
let mut worktree_dir = None;
if let Some(path) = std::env::var_os("GIT_WORK_TREE") {
worktree_dir = PathBuf::from(path).into();
}
let mut git_dir = None;
if let Some(path) = std::env::var_os("GIT_DIR") {
git_dir = PathBuf::from(path).into();
}
Ok(EnvironmentOverrides { worktree_dir, git_dir })
}
}
impl Options {
pub fn isolated() -> Self {
Options::default().permissions(Permissions::isolated())
}
}
impl Options {
pub fn object_store_slots(mut self, slots: git_odb::store::init::Slots) -> Self {
self.object_store_slots = slots;
self
}
pub fn replacement_objects(mut self, config: ReplacementObjects) -> Self {
self.replacement_objects = config;
self
}
pub fn permissions(mut self, permissions: Permissions) -> Self {
self.permissions = permissions;
self
}
pub fn with(mut self, trust: git_sec::Trust) -> Self {
self.git_dir_trust = trust.into();
self
}
pub fn bail_if_untrusted(mut self, toggle: bool) -> Self {
self.bail_if_untrusted = toggle;
self
}
pub fn filter_config_section(mut self, filter: fn(&git_config::file::Metadata) -> bool) -> Self {
self.filter_config_section = Some(filter);
self
}
pub fn lossy_config(mut self, toggle: bool) -> Self {
self.lossy_config = toggle.into();
self
}
pub fn strict_config(mut self, toggle: bool) -> Self {
self.lenient_config = !toggle;
self
}
pub fn open(self, path: impl Into<PathBuf>) -> Result<ThreadSafeRepository, Error> {
ThreadSafeRepository::open_opts(path, self)
}
}
impl git_sec::trust::DefaultForLevel for Options {
fn default_for_level(level: git_sec::Trust) -> Self {
match level {
git_sec::Trust::Full => Options {
object_store_slots: Default::default(),
replacement_objects: Default::default(),
permissions: Permissions::default_for_level(level),
git_dir_trust: git_sec::Trust::Full.into(),
filter_config_section: Some(config::section::is_trusted),
lossy_config: None,
bail_if_untrusted: false,
lenient_config: true,
},
git_sec::Trust::Reduced => Options {
object_store_slots: git_odb::store::init::Slots::Given(32), replacement_objects: ReplacementObjects::Disable, permissions: Permissions::default_for_level(level),
git_dir_trust: git_sec::Trust::Reduced.into(),
filter_config_section: Some(config::section::is_trusted),
bail_if_untrusted: false,
lenient_config: true,
lossy_config: None,
},
}
}
}
#[derive(Debug, thiserror::Error)]
#[allow(missing_docs)]
pub enum Error {
#[error("Failed to load the git configuration")]
Config(#[from] config::Error),
#[error(transparent)]
NotARepository(#[from] git_discover::is_git::Error),
#[error(transparent)]
Io(#[from] std::io::Error),
#[error("The git directory at '{}' is considered unsafe as it's not owned by the current user.", .path.display())]
UnsafeGitDir { path: PathBuf },
#[error(transparent)]
EnvironmentAccessDenied(#[from] permission::env_var::resource::Error),
}
impl ThreadSafeRepository {
pub fn open(path: impl Into<PathBuf>) -> Result<Self, Error> {
Self::open_opts(path, Options::default())
}
pub fn open_opts(path: impl Into<PathBuf>, mut options: Options) -> Result<Self, Error> {
let (path, kind) = {
let path = path.into();
match git_discover::is_git(&path) {
Ok(kind) => (path, kind),
Err(_err) => {
let git_dir = path.join(git_discover::DOT_GIT_DIR);
git_discover::is_git(&git_dir).map(|kind| (git_dir, kind))?
}
}
};
let (git_dir, worktree_dir) =
git_discover::repository::Path::from_dot_git_dir(path, kind).into_repository_and_work_tree_directories();
if options.git_dir_trust.is_none() {
options.git_dir_trust = git_sec::Trust::from_path_ownership(&git_dir)?.into();
}
ThreadSafeRepository::open_from_paths(git_dir, worktree_dir, options)
}
pub fn open_with_environment_overrides(
fallback_directory: impl Into<PathBuf>,
trust_map: git_sec::trust::Mapping<Options>,
) -> Result<Self, Error> {
let overrides = EnvironmentOverrides::from_env()?;
let (path, path_kind): (PathBuf, _) = match overrides.git_dir {
Some(git_dir) => git_discover::is_git(&git_dir).map(|kind| (git_dir, kind))?,
None => {
let fallback_directory = fallback_directory.into();
git_discover::is_git(&fallback_directory).map(|kind| (fallback_directory, kind))?
}
};
let (git_dir, worktree_dir) = git_discover::repository::Path::from_dot_git_dir(path, path_kind)
.into_repository_and_work_tree_directories();
let worktree_dir = worktree_dir.or(overrides.worktree_dir);
let git_dir_trust = git_sec::Trust::from_path_ownership(&git_dir)?;
let options = trust_map.into_value_by_level(git_dir_trust);
ThreadSafeRepository::open_from_paths(git_dir, worktree_dir, options)
}
pub(crate) fn open_from_paths(
git_dir: PathBuf,
mut worktree_dir: Option<PathBuf>,
options: Options,
) -> Result<Self, Error> {
let Options {
git_dir_trust,
object_store_slots,
filter_config_section,
ref replacement_objects,
lossy_config,
lenient_config,
bail_if_untrusted,
permissions: Permissions { ref env, config },
} = options;
let git_dir_trust = git_dir_trust.expect("trust must be been determined by now");
let common_dir = git_discover::path::from_plain_file(git_dir.join("commondir"))
.transpose()?
.map(|cd| git_dir.join(cd));
let common_dir_ref = common_dir.as_deref().unwrap_or(&git_dir);
let repo_config = config::cache::StageOne::new(common_dir_ref, git_dir_trust, lossy_config, lenient_config)?;
let mut refs = {
let reflog = repo_config.reflog.unwrap_or(git_ref::store::WriteReflog::Disable);
let object_hash = repo_config.object_hash;
match &common_dir {
Some(common_dir) => crate::RefStore::for_linked_worktree(&git_dir, common_dir, reflog, object_hash),
None => crate::RefStore::at(&git_dir, reflog, object_hash),
}
};
let head = refs.find("HEAD").ok();
let git_install_dir = crate::path::install_dir().ok();
let home = std::env::var_os("HOME")
.map(PathBuf::from)
.and_then(|home| env.home.check_opt(home));
let mut filter_config_section = filter_config_section.unwrap_or(config::section::is_trusted);
let config = config::Cache::from_stage_one(
repo_config,
common_dir_ref,
head.as_ref().and_then(|head| head.target.try_name()),
filter_config_section,
git_install_dir.as_deref(),
home.as_deref(),
env.clone(),
config,
lenient_config,
)?;
if bail_if_untrusted && git_dir_trust != git_sec::Trust::Full {
check_safe_directories(&git_dir, git_install_dir.as_deref(), home.as_deref(), &config)?;
}
if !config.is_bare {
if let Some(wt) = config
.resolved
.path_filter("core", None, "worktree", &mut filter_config_section)
{
let wt_path = wt
.interpolate(interpolate_context(git_install_dir.as_deref(), home.as_deref()))
.map_err(config::Error::PathInterpolation)?;
worktree_dir = {
let wt = git_path::absolutize(git_dir.join(wt_path), None::<std::path::PathBuf>).into_owned();
wt.is_dir().then(|| wt)
}
}
}
match worktree_dir {
None if !config.is_bare => {
worktree_dir = Some(git_dir.parent().expect("parent is always available").to_owned());
}
Some(_) => {
}
None => {}
}
refs.write_reflog = config.reflog.unwrap_or_else(|| {
if worktree_dir.is_none() {
git_ref::store::WriteReflog::Disable
} else {
git_ref::store::WriteReflog::Normal
}
});
let replacements = replacement_objects
.clone()
.refs_prefix()
.and_then(|prefix| {
let platform = refs.iter().ok()?;
let iter = platform.prefixed(&prefix).ok()?;
let prefix = prefix.to_str()?;
let replacements = iter
.filter_map(Result::ok)
.filter_map(|r: git_ref::Reference| {
let target = r.target.try_id()?.to_owned();
let source =
git_hash::ObjectId::from_hex(r.name.as_bstr().strip_prefix(prefix.as_bytes())?).ok()?;
Some((source, target))
})
.collect::<Vec<_>>();
Some(replacements)
})
.unwrap_or_default();
Ok(ThreadSafeRepository {
objects: OwnShared::new(git_odb::Store::at_opts(
common_dir_ref.join("objects"),
replacements,
git_odb::store::init::Options {
slots: object_store_slots,
object_hash: config.object_hash,
use_multi_pack_index: config.use_multi_pack_index,
},
)?),
common_dir,
refs,
work_tree: worktree_dir,
config,
linked_worktree_options: options,
index: git_features::fs::MutableSnapshot::new().into(),
})
}
}
fn check_safe_directories(
git_dir: &std::path::Path,
git_install_dir: Option<&std::path::Path>,
home: Option<&std::path::Path>,
config: &config::Cache,
) -> Result<(), Error> {
let mut is_safe = false;
let git_dir = match git_path::realpath(git_dir) {
Ok(p) => p,
Err(_) => git_dir.to_owned(),
};
for safe_dir in config
.resolved
.strings_filter("safe", None, "directory", &mut |meta| {
let kind = meta.source.kind();
kind == git_config::source::Kind::System || kind == git_config::source::Kind::Global
})
.unwrap_or_default()
{
if safe_dir.as_ref() == "*" {
is_safe = true;
continue;
}
if safe_dir.is_empty() {
is_safe = false;
continue;
}
if !is_safe {
let safe_dir = match git_config::Path::from(std::borrow::Cow::Borrowed(safe_dir.as_ref()))
.interpolate(interpolate_context(git_install_dir, home))
{
Ok(path) => path,
Err(_) => git_path::from_bstr(safe_dir),
};
if safe_dir == git_dir {
is_safe = true;
continue;
}
}
}
if is_safe {
Ok(())
} else {
Err(Error::UnsafeGitDir { path: git_dir })
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn size_of_options() {
assert_eq!(
std::mem::size_of::<Options>(),
72,
"size shouldn't change without us knowing"
);
}
}