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
|
use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
use std::path::PathBuf;
use structopt::StructOpt;
use crate::auth;
use crate::themes;
/// Possible characters for random routes
const ROUTE_ALPHABET: [char; 16] = [
'1', '2', '3', '4', '5', '6', '7', '8', '9', '0', 'a', 'b', 'c', 'd', 'e', 'f',
];
#[derive(StructOpt)]
#[structopt(
name = "miniserve",
raw(global_settings = "&[structopt::clap::AppSettings::ColoredHelp]")
)]
struct CLIArgs {
/// Be verbose, includes emitting access logs
#[structopt(short = "v", long = "verbose")]
verbose: bool,
/// Which path to serve
#[structopt(name = "PATH", parse(from_os_str))]
path: Option<PathBuf>,
/// Port to use
#[structopt(short = "p", long = "port", default_value = "8080")]
port: u16,
/// Interface to listen on
#[structopt(
short = "i",
long = "if",
parse(try_from_str = "parse_interface"),
raw(number_of_values = "1")
)]
interfaces: Vec<IpAddr>,
/// Set authentication (username:password, username:sha256:hash, or username:sha512:hash)
#[structopt(short = "a", long = "auth", parse(try_from_str = "parse_auth"))]
auth: Option<auth::RequiredAuth>,
/// Generate a random 6-hexdigit route
#[structopt(long = "random-route")]
random_route: bool,
/// Do not follow symbolic links
#[structopt(short = "P", long = "no-symlinks")]
no_symlinks: bool,
/// Default color scheme
#[structopt(
short = "c",
long = "color-scheme",
default_value = "Squirrel",
raw(
possible_values = "&themes::ColorScheme::variants()",
case_insensitive = "true",
)
)]
color_scheme: themes::ColorScheme,
/// Enable file uploading
#[structopt(short = "u", long = "upload-files")]
file_upload: bool,
/// Enable overriding existing files during file upload
#[structopt(short = "o", long = "overwrite-files")]
overwrite_files: bool,
}
/// Checks wether an interface is valid, i.e. it can be parsed into an IP address
fn parse_interface(src: &str) -> Result<IpAddr, std::net::AddrParseError> {
src.parse::<IpAddr>()
}
/// Checks wether the auth string is valid, i.e. it follows the syntax username:password
fn parse_auth(src: &str) -> Result<auth::RequiredAuth, String> {
let mut split = src.splitn(3, ':');
let errmsg = "Invalid credentials string, expected format is username:password".to_owned();
let username = match split.next() {
Some(username) => username,
None => return Err(errmsg),
};
let second_part = match split.next() {
// This allows empty passwords, as the spec does not forbid it
Some(password) => password,
None => return Err(errmsg),
};
let password = if let Some(hash_hex) = split.next() {
let hash_bin = match hex::decode(hash_hex) {
Ok(hash_bin) => hash_bin,
_ => return Err("Hash string is not a valid hex code".to_owned()),
};
match second_part {
"sha256" => auth::RequiredAuthPassword::Sha256(hash_bin.to_owned()),
"sha512" => auth::RequiredAuthPassword::Sha512(hash_bin.to_owned()),
_ => return Err("Invalid hash method, only accept either sha256 or sha512".to_owned()),
}
} else {
// To make it Windows-compatible, the password needs to be shorter than 255 characters.
// After 255 characters, Windows will truncate the value.
// As for the username, the spec does not mention a limit in length
if second_part.len() > 255 {
return Err("Password length cannot exceed 255 characters".to_owned());
}
auth::RequiredAuthPassword::Plain(second_part.to_owned())
};
Ok(auth::RequiredAuth {
username: username.to_owned(),
password,
})
}
/// Parses the command line arguments
pub fn parse_args() -> crate::MiniserveConfig {
let args = CLIArgs::from_args();
let interfaces = if !args.interfaces.is_empty() {
args.interfaces
} else {
vec![
IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0)),
IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)),
]
};
let random_route = if args.random_route {
Some(nanoid::custom(6, &ROUTE_ALPHABET))
} else {
None
};
let default_color_scheme = args.color_scheme;
let path_explicitly_chosen = args.path.is_some();
crate::MiniserveConfig {
verbose: args.verbose,
path: args.path.unwrap_or_else(|| PathBuf::from(".")),
port: args.port,
interfaces,
auth: args.auth,
path_explicitly_chosen,
no_symlinks: args.no_symlinks,
random_route,
default_color_scheme,
overwrite_files: args.overwrite_files,
file_upload: args.file_upload,
}
}
#[cfg(test)]
mod tests {
use super::*;
use rstest::rstest_parametrize;
fn create_required_auth(username: &str, password: &str, encrypt: &str) -> auth::RequiredAuth {
use auth::*;
use RequiredAuthPassword::*;
RequiredAuth {
username: username.to_owned(),
password: match encrypt {
"plain" => Plain(password.to_owned()),
"sha256" => Sha256(hex::decode(password.to_owned()).unwrap()),
"sha512" => Sha512(hex::decode(password.to_owned()).unwrap()),
_ => panic!("Unknown encryption type"),
},
}
}
#[rstest_parametrize(
auth_string, username, password, encrypt,
case("username:password", "username", "password", "plain"),
case("username:sha256:abcd", "username", "abcd", "sha256"),
case("username:sha512:abcd", "username", "abcd", "sha512")
)]
fn parse_auth_valid(auth_string: &str, username: &str, password: &str, encrypt: &str) {
assert_eq!(
parse_auth(auth_string).unwrap(),
create_required_auth(username, password, encrypt),
);
}
#[rstest_parametrize(
auth_string, err_msg,
case(
"foo",
"Invalid credentials string, expected format is username:password"
),
case(
"username:blahblah:abcd",
"Invalid hash method, only accept either sha256 or sha512"
),
case(
"username:sha256:invalid",
"Hash string is not a valid hex code"
),
)]
fn parse_auth_invalid(auth_string: &str, err_msg: &str) {
assert_eq!(parse_auth(auth_string).unwrap_err(), err_msg.to_owned(),);
}
}
|
