-
Notifications
You must be signed in to change notification settings - Fork 123
Expand file tree
/
Copy pathlocator.rs
More file actions
692 lines (598 loc) · 22 KB
/
locator.rs
File metadata and controls
692 lines (598 loc) · 22 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
use directories::UserDirs;
use itertools::Itertools;
use serde::de::DeserializeOwned;
use std::{
ffi::OsStr,
fmt::Display,
fs::{self, create_dir_all, OpenOptions},
io::{self, Write},
path::{Path, PathBuf},
str::FromStr,
};
use stellar_strkey::{Contract, DecodeError};
use crate::{
commands::{global, HEADING_GLOBAL},
print::Print,
signer::secure_store,
utils::find_config_dir,
xdr, Pwd,
};
use super::{
alias,
key::{self, Key},
network::{self, Network},
secret::Secret,
Config,
};
#[derive(thiserror::Error, Debug)]
pub enum Error {
#[error(transparent)]
TomlSerialize(#[from] toml::ser::Error),
#[error("Failed to find home directory")]
HomeDirNotFound,
#[error("Failed read current directory")]
CurrentDirNotFound,
#[error("Failed read current directory and no SOROBAN_CONFIG_HOME is set")]
NoConfigEnvVar,
#[error("Failed to create directory: {path:?}")]
DirCreationFailed { path: PathBuf },
#[error("Failed to read secret's file: {path}.\nProbably need to use `stellar keys add`")]
SecretFileRead { path: PathBuf },
#[error("Failed to read network file: {path};\nProbably need to use `stellar network add`")]
NetworkFileRead { path: PathBuf },
#[error("Failed to read file: {path}")]
FileRead { path: PathBuf },
#[error(transparent)]
Toml(#[from] toml::de::Error),
#[error("Secret file failed to deserialize")]
Deserialization,
#[error("Failed to write identity file:{filepath}: {error}")]
IdCreationFailed { filepath: PathBuf, error: io::Error },
#[error("Secret file failed to deserialize")]
NetworkDeserialization,
#[error("Failed to write network file: {0}")]
NetworkCreationFailed(std::io::Error),
#[error("Error Identity directory is invalid: {name}")]
IdentityList { name: String },
// #[error("Config file failed to deserialize")]
// CannotReadConfigFile,
#[error("Config file failed to serialize")]
ConfigSerialization,
// #[error("Config file failed write")]
// CannotWriteConfigFile,
#[error("STELLAR_CONFIG_HOME env variable is not a valid path. Got {0}")]
StellarConfigDir(String),
#[error("XDG_CONFIG_HOME env variable is not a valid path. Got {0}")]
XdgConfigHome(String),
#[error(transparent)]
Io(#[from] std::io::Error),
#[error("Failed to remove {0}: {1}")]
ConfigRemoval(String, String),
#[error("Failed to find config {0} for {1}")]
ConfigMissing(String, String),
#[error(transparent)]
String(#[from] std::string::FromUtf8Error),
#[error(transparent)]
Secret(#[from] crate::config::secret::Error),
#[error(transparent)]
Json(#[from] serde_json::Error),
#[error("cannot access config dir for alias file")]
CannotAccessConfigDir,
#[error("cannot access alias config file (no permission or doesn't exist)")]
CannotAccessAliasConfigFile,
#[error("cannot parse contract ID {0}: {1}")]
CannotParseContractId(String, DecodeError),
#[error("contract not found: {0}")]
ContractNotFound(String),
#[error("Failed to read upgrade check file: {path}: {error}")]
UpgradeCheckReadFailed { path: PathBuf, error: io::Error },
#[error("Failed to write upgrade check file: {path}: {error}")]
UpgradeCheckWriteFailed { path: PathBuf, error: io::Error },
#[error("Contract alias {0}, cannot overlap with key")]
ContractAliasCannotOverlapWithKey(String),
#[error("Key cannot {0} cannot overlap with contract alias")]
KeyCannotOverlapWithContractAlias(String),
#[error(transparent)]
SecureStore(#[from] secure_store::Error),
#[error("Only private keys and seed phrases are supported for getting private keys {0}")]
SecretKeyOnly(String),
#[error(transparent)]
Key(#[from] key::Error),
#[error("Unable to get project directory")]
ProjectDirsError(),
}
#[derive(Debug, clap::Args, Default, Clone)]
#[group(skip)]
pub struct Args {
/// ⚠️ Deprecated: global config is always on
#[arg(long, global = true, help_heading = HEADING_GLOBAL)]
pub global: bool,
/// Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise.
/// Contains configuration files, aliases, and other persistent settings.
#[arg(long, global = true, help_heading = HEADING_GLOBAL)]
pub config_dir: Option<PathBuf>,
}
pub enum Location {
Local(PathBuf),
Global(PathBuf),
}
impl Display for Location {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"{} {:?}",
match self {
Location::Local(_) => "Local",
Location::Global(_) => "Global",
},
self.as_ref()
)
}
}
impl AsRef<Path> for Location {
fn as_ref(&self) -> &Path {
match self {
Location::Local(p) | Location::Global(p) => p.as_path(),
}
}
}
impl Location {
#[must_use]
pub fn wrap(&self, p: PathBuf) -> Self {
match self {
Location::Local(_) => Location::Local(p),
Location::Global(_) => Location::Global(p),
}
}
}
impl Args {
pub fn config_dir(&self) -> Result<PathBuf, Error> {
if self.global {
let print = Print::new(false);
print.warnln("Flag --global is deprecated: global config is always used");
}
self.global_config_path()
}
pub fn local_and_global(&self) -> Result<[Location; 2], Error> {
Ok([
Location::Local(self.local_config()?),
Location::Global(self.global_config_path()?),
])
}
pub fn local_config(&self) -> Result<PathBuf, Error> {
let pwd = self.current_dir()?;
Ok(find_config_dir(pwd.clone()).unwrap_or_else(|_| pwd.join(".stellar")))
}
pub fn current_dir(&self) -> Result<PathBuf, Error> {
self.config_dir.as_ref().map_or_else(
|| std::env::current_dir().map_err(|_| Error::CurrentDirNotFound),
|pwd| Ok(pwd.clone()),
)
}
pub fn write_identity(&self, name: &str, secret: &Secret) -> Result<PathBuf, Error> {
if let Ok(Some(_)) = self.load_contract_from_alias(name) {
return Err(Error::KeyCannotOverlapWithContractAlias(name.to_owned()));
}
KeyType::Identity.write(name, secret, &self.config_dir()?)
}
pub fn write_public_key(
&self,
name: &str,
public_key: &stellar_strkey::ed25519::PublicKey,
) -> Result<PathBuf, Error> {
self.write_key(name, &public_key.into())
}
pub fn write_key(&self, name: &str, key: &Key) -> Result<PathBuf, Error> {
KeyType::Identity.write(name, key, &self.config_dir()?)
}
pub fn write_network(&self, name: &str, network: &Network) -> Result<PathBuf, Error> {
KeyType::Network.write(name, network, &self.config_dir()?)
}
pub fn write_default_network(&self, name: &str) -> Result<(), Error> {
Config::new()?.set_network(name).save()
}
pub fn write_default_identity(&self, name: &str) -> Result<(), Error> {
Config::new()?.set_identity(name).save()
}
pub fn unset_default_identity(&self) -> Result<(), Error> {
Config::new()?.unset_identity().save()
}
pub fn unset_default_network(&self) -> Result<(), Error> {
Config::new()?.unset_network().save()
}
pub fn list_identities(&self) -> Result<Vec<String>, Error> {
Ok(KeyType::Identity
.list_paths(&self.local_and_global()?)?
.into_iter()
.map(|(name, _)| name)
.collect())
}
pub fn list_identities_long(&self) -> Result<Vec<(String, String)>, Error> {
Ok(KeyType::Identity
.list_paths(&self.local_and_global()?)
.into_iter()
.flatten()
.map(|(name, location)| {
let path = match location {
Location::Local(path) | Location::Global(path) => path,
};
(name, format!("{}", path.display()))
})
.collect())
}
pub fn list_networks(&self) -> Result<Vec<String>, Error> {
let saved_networks = KeyType::Network
.list_paths(&self.local_and_global()?)
.into_iter()
.flatten()
.map(|x| x.0);
let default_networks = network::DEFAULTS.keys().map(ToString::to_string);
Ok(saved_networks.chain(default_networks).unique().collect())
}
pub fn list_networks_long(&self) -> Result<Vec<(String, Network, String)>, Error> {
let saved_networks = KeyType::Network
.list_paths(&self.local_and_global()?)
.into_iter()
.flatten()
.filter_map(|(name, location)| {
Some((
name,
KeyType::read_from_path::<Network>(location.as_ref()).ok()?,
location.to_string(),
))
});
let default_networks = network::DEFAULTS
.into_iter()
.map(|(name, network)| ((*name).to_string(), network.into(), "Default".to_owned()));
Ok(saved_networks.chain(default_networks).collect())
}
pub fn read_identity(&self, name: &str) -> Result<Key, Error> {
KeyType::Identity.read_with_global(name, self)
}
pub fn read_key(&self, key_or_name: &str) -> Result<Key, Error> {
key_or_name
.parse()
.or_else(|_| self.read_identity(key_or_name))
}
pub fn get_secret_key(&self, key_or_name: &str) -> Result<Secret, Error> {
match self.read_key(key_or_name)? {
Key::Secret(s) => Ok(s),
_ => Err(Error::SecretKeyOnly(key_or_name.to_string())),
}
}
pub fn get_public_key(
&self,
key_or_name: &str,
hd_path: Option<usize>,
) -> Result<xdr::MuxedAccount, Error> {
Ok(self.read_key(key_or_name)?.muxed_account(hd_path)?)
}
pub fn read_network(&self, name: &str) -> Result<Network, Error> {
let res = KeyType::Network.read_with_global(name, self);
if let Err(Error::ConfigMissing(_, _)) = &res {
let Some(network) = network::DEFAULTS.get(name) else {
return res;
};
return Ok(network.into());
}
res
}
pub fn remove_identity(&self, name: &str, global_args: &global::Args) -> Result<(), Error> {
let print = Print::new(global_args.quiet);
let identity = self.read_identity(name)?;
if let Key::Secret(Secret::SecureStore { entry_name }) = identity {
secure_store::delete_secret(&print, &entry_name)?;
}
print.infoln("Removing the key's cli config file");
KeyType::Identity.remove(name, &self.config_dir()?)
}
pub fn remove_network(&self, name: &str) -> Result<(), Error> {
KeyType::Network.remove(name, &self.config_dir()?)
}
fn load_contract_from_alias(&self, alias: &str) -> Result<Option<alias::Data>, Error> {
let file_name = format!("{alias}.json");
let config_dirs = self.local_and_global()?;
let local = &config_dirs[0];
let global = &config_dirs[1];
match local {
Location::Local(config_dir) => {
let path = config_dir.join("contract-ids").join(&file_name);
if path.exists() {
print_deprecation_warning(config_dir);
let content = fs::read_to_string(path)?;
let data: alias::Data = serde_json::from_str(&content).unwrap_or_default();
return Ok(Some(data));
}
}
Location::Global(_) => unreachable!(),
}
match global {
Location::Global(config_dir) => {
let path = config_dir.join("contract-ids").join(&file_name);
if !path.exists() {
return Ok(None);
}
let content = fs::read_to_string(path)?;
let data: alias::Data = serde_json::from_str(&content).unwrap_or_default();
Ok(Some(data))
}
Location::Local(_) => unreachable!(),
}
}
fn alias_path(&self, alias: &str) -> Result<PathBuf, Error> {
let file_name = format!("{alias}.json");
let config_dir = self.config_dir()?;
Ok(config_dir.join("contract-ids").join(file_name))
}
pub fn save_contract_id(
&self,
network_passphrase: &str,
contract_id: &stellar_strkey::Contract,
alias: &str,
) -> Result<(), Error> {
if self.read_identity(alias).is_ok() {
return Err(Error::ContractAliasCannotOverlapWithKey(alias.to_owned()));
}
let path = self.alias_path(alias)?;
let dir = path.parent().ok_or(Error::CannotAccessConfigDir)?;
create_dir_all(dir).map_err(|_| Error::CannotAccessConfigDir)?;
let content = fs::read_to_string(&path).unwrap_or_default();
let mut data: alias::Data = serde_json::from_str(&content).unwrap_or_default();
let mut to_file = OpenOptions::new()
.create(true)
.truncate(true)
.write(true)
.open(path)?;
data.ids
.insert(network_passphrase.into(), contract_id.to_string());
let content = serde_json::to_string(&data)?;
Ok(to_file.write_all(content.as_bytes())?)
}
pub fn remove_contract_id(&self, network_passphrase: &str, alias: &str) -> Result<(), Error> {
let path = self.alias_path(alias)?;
if !path.is_file() {
return Err(Error::CannotAccessAliasConfigFile);
}
let content = fs::read_to_string(&path).unwrap_or_default();
let mut data: alias::Data = serde_json::from_str(&content).unwrap_or_default();
let mut to_file = OpenOptions::new()
.create(true)
.truncate(true)
.write(true)
.open(path)?;
data.ids.remove::<str>(network_passphrase);
let content = serde_json::to_string(&data)?;
Ok(to_file.write_all(content.as_bytes())?)
}
pub fn get_contract_id(
&self,
alias: &str,
network_passphrase: &str,
) -> Result<Option<Contract>, Error> {
let Some(alias_data) = self.load_contract_from_alias(alias)? else {
return Ok(None);
};
alias_data
.ids
.get(network_passphrase)
.map(|id| id.parse())
.transpose()
.map_err(|e| Error::CannotParseContractId(alias.to_owned(), e))
}
pub fn resolve_contract_id(
&self,
alias_or_contract_id: &str,
network_passphrase: &str,
) -> Result<Contract, Error> {
let Some(contract) = self.get_contract_id(alias_or_contract_id, network_passphrase)? else {
return alias_or_contract_id
.parse()
.map_err(|e| Error::CannotParseContractId(alias_or_contract_id.to_owned(), e));
};
Ok(contract)
}
pub fn global_config_path(&self) -> Result<PathBuf, Error> {
if let Some(config_dir) = &self.config_dir {
return Ok(config_dir.clone());
}
global_config_path()
}
}
pub fn print_deprecation_warning(dir: &Path) {
let print = Print::new(false);
let global_dir = global_config_path().expect("Couldn't retrieve global directory.");
let global_dir = fs::canonicalize(&global_dir).expect("Couldn't expand global directory.");
// No warning if local and global dirs are the same (e.g., both set to STELLAR_CONFIG_HOME)
if dir == global_dir {
return;
}
print.warnln(format!("A local config was found at {dir:?}."));
print.blankln(" Local config is deprecated and will be removed in the future.".to_string());
print.blankln(format!(
" Run `stellar config migrate` to move the local config into the global config ({global_dir:?})."
));
}
impl Pwd for Args {
fn set_pwd(&mut self, pwd: &Path) {
self.config_dir = Some(pwd.to_path_buf());
}
}
pub fn ensure_directory(dir: PathBuf) -> Result<PathBuf, Error> {
let parent = dir.parent().ok_or(Error::HomeDirNotFound)?;
std::fs::create_dir_all(parent).map_err(|_| dir_creation_failed(parent))?;
Ok(dir)
}
fn dir_creation_failed(p: &Path) -> Error {
Error::DirCreationFailed {
path: p.to_path_buf(),
}
}
pub enum KeyType {
Identity,
Network,
ContractIds,
}
impl Display for KeyType {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"{}",
match self {
KeyType::Identity => "identity",
KeyType::Network => "network",
KeyType::ContractIds => "contract-ids",
}
)
}
}
impl KeyType {
pub fn read_from_path<T: DeserializeOwned>(path: &Path) -> Result<T, Error> {
let data = fs::read_to_string(path).map_err(|_| Error::NetworkFileRead {
path: path.to_path_buf(),
})?;
Ok(toml::from_str(&data)?)
}
pub fn read_with_global<T: DeserializeOwned>(
&self,
key: &str,
locator: &Args,
) -> Result<T, Error> {
for location in locator.local_and_global()? {
let path = self.path(location.as_ref(), key);
if let Ok(t) = Self::read_from_path(&path) {
if let Location::Local(config_dir) = location {
print_deprecation_warning(&config_dir);
}
return Ok(t);
}
}
Err(Error::ConfigMissing(self.to_string(), key.to_string()))
}
pub fn write<T: serde::Serialize>(
&self,
key: &str,
value: &T,
pwd: &Path,
) -> Result<PathBuf, Error> {
let filepath = ensure_directory(self.path(pwd, key))?;
let data = toml::to_string(value).map_err(|_| Error::ConfigSerialization)?;
std::fs::write(&filepath, data).map_err(|error| Error::IdCreationFailed {
filepath: filepath.clone(),
error,
})?;
Ok(filepath)
}
fn root(&self, pwd: &Path) -> PathBuf {
pwd.join(self.to_string())
}
fn path(&self, pwd: &Path, key: &str) -> PathBuf {
let mut path = self.root(pwd).join(key);
path.set_extension("toml");
path
}
pub fn list_paths(&self, paths: &[Location]) -> Result<Vec<(String, Location)>, Error> {
Ok(paths
.iter()
.unique_by(|p| location_to_string(p))
.flat_map(|p| self.list(p, true).unwrap_or_default())
.collect())
}
pub fn list_paths_silent(&self, paths: &[Location]) -> Result<Vec<(String, Location)>, Error> {
Ok(paths
.iter()
.flat_map(|p| self.list(p, false).unwrap_or_default())
.collect())
}
#[allow(unused_variables)]
pub fn list(
&self,
pwd: &Location,
print_warning: bool,
) -> Result<Vec<(String, Location)>, Error> {
let path = self.root(pwd.as_ref());
if path.exists() {
let mut files = self.read_dir(&path)?;
files.sort();
if let Location::Local(config_dir) = pwd {
if files.len() > 1 && print_warning {
print_deprecation_warning(config_dir);
}
}
Ok(files
.into_iter()
.map(|(name, p)| (name, pwd.wrap(p)))
.collect())
} else {
Ok(vec![])
}
}
fn read_dir(&self, dir: &Path) -> Result<Vec<(String, PathBuf)>, Error> {
let contents = std::fs::read_dir(dir)?;
let mut res = vec![];
for entry in contents.filter_map(Result::ok) {
let path = entry.path();
let extension = match self {
KeyType::Identity | KeyType::Network => "toml",
KeyType::ContractIds => "json",
};
if let Some(ext) = path.extension().and_then(OsStr::to_str) {
if ext == extension {
if let Some(os_str) = path.file_stem() {
res.push((os_str.to_string_lossy().trim().to_string(), path));
}
}
}
}
res.sort();
Ok(res)
}
pub fn remove(&self, key: &str, pwd: &Path) -> Result<(), Error> {
let path = self.path(pwd, key);
if path.exists() {
std::fs::remove_file(&path)
.map_err(|_| Error::ConfigRemoval(self.to_string(), key.to_string()))
} else {
Ok(())
}
}
}
fn global_config_path() -> Result<PathBuf, Error> {
if let Ok(config_home) = std::env::var("STELLAR_CONFIG_HOME") {
return PathBuf::from_str(&config_home).map_err(|_| Error::StellarConfigDir(config_home));
}
let config_dir = if let Ok(config_home) = std::env::var("XDG_CONFIG_HOME") {
PathBuf::from_str(&config_home).map_err(|_| Error::XdgConfigHome(config_home))?
} else {
UserDirs::new()
.ok_or(Error::HomeDirNotFound)?
.home_dir()
.join(".config")
};
let soroban_dir = config_dir.join("soroban");
let stellar_dir = config_dir.join("stellar");
let soroban_exists = soroban_dir.exists();
let stellar_exists = stellar_dir.exists();
if stellar_exists && soroban_exists {
tracing::warn!("the .stellar and .soroban config directories exist at path {config_dir:?}, using the .stellar");
}
if stellar_exists {
return Ok(stellar_dir);
}
if soroban_exists {
return Ok(soroban_dir);
}
Ok(stellar_dir)
}
fn location_to_string(location: &Location) -> String {
match location {
Location::Local(p) | Location::Global(p) => fs::canonicalize(AsRef::<Path>::as_ref(p))
.unwrap_or(p.clone())
.display()
.to_string(),
}
}
// Use locator.global_config_path() to save configurations.
// This is only to be used to fetch global Stellar config (e.g. to use for defaults)
pub fn cli_config_file() -> Result<PathBuf, Error> {
Ok(global_config_path()?.join("config.toml"))
}