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
|
//! The `hss` subcommand.
use anyhow::anyhow;
use arti_client::TorClientConfig;
use clap::{ArgMatches, Args, FromArgMatches, Parser, Subcommand, ValueEnum};
use tor_hsservice::{HsId, HsNickname, OnionService};
use crate::{ArtiConfig, Result, TorClient};
/// The hss subcommands the arti CLI will be augmented with.
#[derive(Parser, Debug)]
pub(crate) enum HssSubcommands {
/// Run state management commands for an Arti hidden service.
Hss(Hss),
}
#[derive(Debug, Parser)]
pub(crate) struct Hss {
/// Arguments shared by all hss subcommands.
#[command(flatten)]
common: CommonArgs,
/// Return the identity key for the specified service.
#[command(subcommand)]
command: HssSubcommand,
}
#[derive(Subcommand, Debug, Clone)]
pub(crate) enum HssSubcommand {
/// Print the .onion address of a hidden service
OnionAddress(OnionAddressArgs),
/// (Deprecated) Print the .onion address of a hidden service
#[command(hide = true)] // This hides the command from the help message
OnionName(OnionAddressArgs),
}
/// The arguments of the [`OnionAddress`](HssSubcommand::OnionAddress) subcommand.
#[derive(Debug, Clone, Args)]
pub(crate) struct OnionAddressArgs {
/// Whether to generate the key if it is missing
#[arg(
long,
default_value_t = GenerateKey::No,
value_enum
)]
generate: GenerateKey,
}
/// Whether to generate the key if missing.
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq, ValueEnum)]
enum GenerateKey {
/// Do not generate the key.
#[default]
No,
/// Generate the key if it's missing.
IfNeeded,
}
/// A type of key
#[derive(Copy, Clone, Debug, PartialEq, Eq, ValueEnum)]
enum KeyType {
/// The identity key of the service
OnionAddress,
}
/// The arguments shared by all [`HssSubcommand`]s.
#[derive(Debug, Clone, Args)]
pub(crate) struct CommonArgs {
/// The nickname of the service
#[arg(short, long)]
nickname: HsNickname,
}
/// Run the `hss` subcommand.
pub(crate) fn run(
hss_matches: &ArgMatches,
config: &ArtiConfig,
client_config: &TorClientConfig,
) -> Result<()> {
let hss = Hss::from_arg_matches(hss_matches).expect("Could not parse hss subcommand");
match hss.command {
HssSubcommand::OnionAddress(args) => {
run_onion_address(&hss.common, &args, config, client_config)
}
HssSubcommand::OnionName(args) => {
eprintln!(
"warning: using deprecated command 'onion-name', (hint: use 'onion-address' instead)"
);
run_onion_address(&hss.common, &args, config, client_config)
}
}
}
/// Create the OnionService configured with `nickname`.
fn create_svc(
nickname: &HsNickname,
config: &ArtiConfig,
client_config: &TorClientConfig,
) -> Result<OnionService> {
let Some(svc_config) = config
.onion_services
.iter()
.find(|(n, _)| *n == nickname)
.map(|(_, cfg)| cfg.svc_cfg.clone())
else {
return Err(anyhow!("Service {nickname} is not configured"));
};
// TODO: PreferredRuntime was arbitrarily chosen and is entirely unused
// (we have to specify a concrete type for the runtime when calling
// TorClient::create_onion_service).
//
// Maybe this suggests TorClient is not the right place for
// create_onion_service()
Ok(
TorClient::<tor_rtcompat::PreferredRuntime>::create_onion_service(
client_config,
svc_config,
)?,
)
}
/// Display the onion address, if any, of the specified service.
fn display_onion_address(nickname: &HsNickname, hsid: Option<HsId>) -> Result<()> {
// TODO: instead of the printlns here, we should have a formatter type that
// decides how to display the output
if let Some(onion) = hsid {
println!("{onion}");
} else {
return Err(anyhow!(
"Service {nickname} does not exist, or does not have an K_hsid yet"
));
}
Ok(())
}
/// Run the `hss onion-address` subcommand.
fn onion_address(
args: &CommonArgs,
config: &ArtiConfig,
client_config: &TorClientConfig,
) -> Result<()> {
let onion_svc = create_svc(&args.nickname, config, client_config)?;
let hsid = onion_svc.onion_address();
display_onion_address(&args.nickname, hsid)?;
Ok(())
}
/// Run the `hss onion-address` subcommand.
fn get_or_generate_onion_address(
args: &CommonArgs,
config: &ArtiConfig,
client_config: &TorClientConfig,
) -> Result<()> {
let svc = create_svc(&args.nickname, config, client_config)?;
let hsid = svc.onion_address();
match hsid {
Some(hsid) => display_onion_address(&args.nickname, Some(hsid)),
None => {
let selector = Default::default();
let hsid = svc.generate_identity_key(selector)?;
display_onion_address(&args.nickname, Some(hsid))
}
}
}
/// Run the `hss onion-address` subcommand.
fn run_onion_address(
args: &CommonArgs,
get_key_args: &OnionAddressArgs,
config: &ArtiConfig,
client_config: &TorClientConfig,
) -> Result<()> {
match get_key_args.generate {
GenerateKey::No => onion_address(args, config, client_config),
GenerateKey::IfNeeded => get_or_generate_onion_address(args, config, client_config),
}
}
|
