Miroirs/rkvm
1
0
Fork 0
mirror of https://github.com/htrefil/rkvm.git synced 2024-12-26 09:58:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Make timeouts configurable

Browse source
This commit is contained in:
Jan Trefil 2024-07-13 19:30:58 +02:00
parent 347dafeae7
commit 16f4a72b30
15 changed files with 255 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

90
Cargo.lock generated
View file

@ -299,6 +299,12 @@ dependencies = [
"termcolor",
]
[[package]]
name = "equivalent"
version = "1.0.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5443807d6dff69373d433ab9ef5378ad8df50ca6298caf15de6e52e24aaf54d5"
[[package]]
name = "errno"
version = "0.3.9"
@ -437,6 +443,12 @@ version = "0.3.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d2fabcfbdc87f4758337ca535fb41a6d701b65693ce38287d856d1674551ec9b"
[[package]]
name = "hashbrown"
version = "0.14.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e5274423e17b7c9fc20b6e7e208532f9b19825d82dfd615708b70edd83df41f1"
[[package]]
name = "heck"
version = "0.5.0"
@ -482,6 +494,16 @@ version = "2.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9a3a5bfb195931eeb336b2a7b4d761daec841b97f947d34394601737a7bba5e4"
[[package]]
name = "indexmap"
version = "2.2.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "168fb715dda47215e360912c096649d23d58bf392ac62f73919e831745e40f26"
dependencies = [
"equivalent",
"hashbrown",
]
[[package]]
name = "inotify"
version = "0.10.2"
@ -804,6 +826,7 @@ version = "0.6.0"
dependencies = [
"clap",
"env_logger",
"rkvm-config",
"rkvm-input",
"rkvm-net",
"rustls-pemfile",
@ -811,11 +834,20 @@ dependencies = [
"thiserror",
"tokio",
"tokio-rustls",
"toml",
"toml 0.5.11",
"tracing",
"tracing-subscriber",
]
[[package]]
name = "rkvm-config"
version = "0.1.0"
dependencies = [
"humantime",
"serde",
"toml 0.8.14",
]
[[package]]
name = "rkvm-input"
version = "0.1.0"
@ -854,7 +886,9 @@ version = "0.6.0"
dependencies = [
"clap",
"env_logger",
"humantime",
"rand",
"rkvm-config",
"rkvm-input",
"rkvm-net",
"rustls-pemfile",
@ -863,7 +897,7 @@ dependencies = [
"thiserror",
"tokio",
"tokio-rustls",
"toml",
"toml 0.5.11",
"tracing",
"tracing-subscriber",
]
@ -954,6 +988,15 @@ dependencies = [
"syn",
]
[[package]]
name = "serde_spanned"
version = "0.6.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "79e674e01f999af37c49f70a6ede167a8a60b2503e56c5599532a65baa5969a0"
dependencies = [
"serde",
]
[[package]]
name = "sha2"
version = "0.10.8"
@ -1145,6 +1188,40 @@ dependencies = [
"serde",
]
[[package]]
name = "toml"
version = "0.8.14"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6f49eb2ab21d2f26bd6db7bf383edc527a7ebaee412d17af4d40fdccd442f335"
dependencies = [
"serde",
"serde_spanned",
"toml_datetime",
"toml_edit",
]
[[package]]
name = "toml_datetime"
version = "0.6.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "4badfd56924ae69bcc9039335b2e017639ce3f9b001c393c1b2d1ef846ce2cbf"
dependencies = [
"serde",
]
[[package]]
name = "toml_edit"
version = "0.22.15"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d59a3a72298453f564e2b111fa896f8d07fabb36f51f06d7e875fc5e0b5a3ef1"
dependencies = [
"indexmap",
"serde",
"serde_spanned",
"toml_datetime",
"winnow",
]
[[package]]
name = "tracing"
version = "0.1.40"
@ -1429,3 +1506,12 @@ name = "windows_x86_64_msvc"
version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec"
[[package]]
name = "winnow"
version = "0.6.13"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "59b5e5f6c299a3c7890b876a2a587f3115162487e704907d9b6cd29473052ba1"
dependencies = [
"memchr",
]

2
Cargo.toml
View file

@ -1,3 +1,3 @@
[workspace]
resolver = "2"
members = ["rkvm-client", "rkvm-server", "rkvm-input", "rkvm-net", "rkvm-certificate-gen"]
members = ["rkvm-client", "rkvm-server", "rkvm-input", "rkvm-net", "rkvm-certificate-gen", "rkvm-config"]

10
example/client.toml
View file

@ -6,3 +6,13 @@ certificate = "/etc/rkvm/certificate.pem"
#
# Change this to your own value before deploying rkvm.
password = "123456789"
# Optional values.
# Make sure these match what you have in your server's config.
# Message read timeout.
# read-timeout = "500ms"
# Message write timeout.
# write-timeout = "500ms"
# TLS handshake timeout.
# tls-timeout = "500ms"

10
example/server.toml
View file

@ -12,3 +12,13 @@ key = "/etc/rkvm/key.pem"
#
# Change this to your own value before deploying rkvm.
password = "123456789"
# Optional values.
# Make sure these match what you have in your client's config.
# Message write timeout. Increase this if you are getting timeout errors.
# read-timeout = "500ms"
# Message write timeout. Increase this if you are getting timeout errors.
# write-timeout = "500ms"
# TLS handshake timeout.
# tls-timeout = "500ms"

3
rkvm-client/Cargo.toml
View file

@ -10,7 +10,6 @@ edition = "2021"
[dependencies]
tokio = { version = "1.0.1", features = ["macros", "time", "fs", "net", "signal", "rt-multi-thread", "sync"] }
rkvm-input = { path = "../rkvm-input" }
rkvm-net = { path = "../rkvm-net" }
serde = { version = "1.0.117", features = ["derive"] }
toml = "0.5.7"
env_logger = "0.8.1"
@ -20,6 +19,8 @@ tokio-rustls = "0.24.0"
rustls-pemfile = "1.0.2"
tracing = "0.1.37"
tracing-subscriber = { version = "0.3.17", features = ["env-filter"] }
rkvm-net = { path = "../rkvm-net" }
rkvm-config = { path = "../rkvm-config" }
[package.metadata.rpm]
package = "rkvm-client"

21
rkvm-client/src/client.rs
View file

@ -1,3 +1,4 @@
use rkvm_config::Timeout;
use rkvm_input::writer::Writer;
use rkvm_net::auth::{AuthChallenge, AuthStatus};
use rkvm_net::message::Message;
@ -31,6 +32,7 @@ pub async fn run(
port: u16,
connector: TlsConnector,
password: &str,
timeout: Timeout,
) -> Result<(), Error> {
// Intentionally don't impose any timeout for TCP connect.
let stream = match hostname {
@ -42,10 +44,7 @@ pub async fn run(
tracing::info!("Connected to server");
let stream = rkvm_net::timeout(
rkvm_net::TLS_TIMEOUT,
connector.connect(hostname.clone(), stream),
)
let stream = rkvm_net::timeout(timeout.tls, connector.connect(hostname.clone(), stream))
.await
.map_err(Error::Network)?;
@ -53,7 +52,7 @@ pub async fn run(
let mut stream = BufStream::with_capacity(1024, 1024, stream);
rkvm_net::timeout(rkvm_net::WRITE_TIMEOUT, async {
rkvm_net::timeout(timeout.write, async {
Version::CURRENT.encode(&mut stream).await?;
stream.flush().await?;
@ -62,7 +61,7 @@ pub async fn run(
.await
.map_err(Error::Network)?;
let version = rkvm_net::timeout(rkvm_net::READ_TIMEOUT, Version::decode(&mut stream))
let version = rkvm_net::timeout(timeout.read, Version::decode(&mut stream))
.await
.map_err(Error::Network)?;
@ -73,13 +72,13 @@ pub async fn run(
});
}
let challenge = rkvm_net::timeout(rkvm_net::READ_TIMEOUT, AuthChallenge::decode(&mut stream))
let challenge = rkvm_net::timeout(timeout.read, AuthChallenge::decode(&mut stream))
.await
.map_err(Error::Network)?;
let response = challenge.respond(password);
rkvm_net::timeout(rkvm_net::WRITE_TIMEOUT, async {
rkvm_net::timeout(timeout.write, async {
response.encode(&mut stream).await?;
stream.flush().await?;
@ -88,7 +87,7 @@ pub async fn run(
.await
.map_err(Error::Network)?;
let status = rkvm_net::timeout(rkvm_net::READ_TIMEOUT, AuthStatus::decode(&mut stream))
let status = rkvm_net::timeout(timeout.read, AuthStatus::decode(&mut stream))
.await
.map_err(Error::Network)?;
@ -101,7 +100,7 @@ pub async fn run(
let mut start = Instant::now();
let mut interval = time::interval(rkvm_net::PING_INTERVAL + rkvm_net::READ_TIMEOUT);
let mut interval = time::interval(rkvm_net::PING_INTERVAL + timeout.read);
let mut writers = HashMap::new();
// Interval ticks immediately after creation.
@ -191,7 +190,7 @@ pub async fn run(
start = Instant::now();
interval.reset();
rkvm_net::timeout(rkvm_net::WRITE_TIMEOUT, async {
rkvm_net::timeout(timeout.write, async {
Pong.encode(&mut stream).await?;
stream.flush().await?;

3
rkvm-client/src/config.rs
View file

@ -1,3 +1,4 @@
use rkvm_config::Timeout;
use serde::de::{self, Visitor};
use serde::{Deserialize, Deserializer};
use std::fmt::{self, Formatter};
@ -12,6 +13,8 @@ pub struct Config {
pub server: Server,
pub certificate: PathBuf,
pub password: String,
#[serde(flatten)]
pub timeout: Timeout,
}
pub struct Server {

2
rkvm-client/src/main.rs
View file

@ -57,7 +57,7 @@ async fn main() -> ExitCode {
};
tokio::select! {
result = client::run(&config.server.hostname, config.server.port, connector, &config.password) => {
result = client::run(&config.server.hostname, config.server.port, connector, &config.password, config.timeout) => {
if let Err(err) = result {
tracing::error!("Error: {}", err);
return ExitCode::FAILURE;

13
rkvm-config/Cargo.toml Normal file
View file

@ -0,0 +1,13 @@
[package]
name = "rkvm-config"
version = "0.1.0"
edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
humantime = "2.1.0"
serde = { version = "1.0.204", features = ["derive"] }
[dev-dependencies]
toml = "0.8.14"

97
rkvm-config/src/lib.rs Normal file
View file

@ -0,0 +1,97 @@
use serde::de::{Deserializer, Error, Visitor};
use serde::Deserialize;
use std::fmt::{self, Formatter};
use std::str::FromStr;
use std::time::Duration;
#[derive(Deserialize, Clone, Copy, PartialEq, Eq, Debug)]
pub struct Timeout {
#[serde(
rename = "read-timeout",
default = "default_timeout",
deserialize_with = "deserialize_duration"
)]
pub read: Duration,
#[serde(
rename = "write-timeout",
default = "default_timeout",
deserialize_with = "deserialize_duration"
)]
pub write: Duration,
#[serde(
rename = "tls-timeout",
default = "default_timeout",
deserialize_with = "deserialize_duration"
)]
pub tls: Duration,
}
fn default_timeout() -> Duration {
Duration::from_millis(500)
}
fn deserialize_duration<'de, D>(deserializer: D) -> Result<Duration, D::Error>
where
D: Deserializer<'de>,
{
struct DurationVisitor;
impl Visitor<'_> for DurationVisitor {
type Value = Duration;
fn expecting(&self, formatter: &mut Formatter) -> fmt::Result {
write!(formatter, "a duration of time (for example \"500ms\")")
}
fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
where
E: Error,
{
humantime::Duration::from_str(v)
.map_err(E::custom)
.map(Into::into)
}
}
deserializer.deserialize_str(DurationVisitor)
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn timeout_deserialize() {
let parsed = toml::from_str::<Timeout>(
r#"
read-timeout = "1s"
write-timeout = "200ms"
tls-timeout = "500ms"
"#,
)
.unwrap();
assert_eq!(
parsed,
Timeout {
read: Duration::from_secs(1),
write: Duration::from_millis(200),
tls: Duration::from_millis(500),
}
);
}
#[test]
fn timeout_missing_values() {
let parsed = toml::from_str::<Timeout>("").unwrap();
assert_eq!(
parsed,
Timeout {
read: default_timeout(),
write: default_timeout(),
tls: default_timeout(),
}
);
}
}

9
rkvm-net/src/lib.rs
View file

@ -19,15 +19,6 @@ use tokio::time;
pub const PING_INTERVAL: Duration = Duration::from_secs(1);
// Message read timeout (does not apply to updates, only auth negotiation and replies).
pub const READ_TIMEOUT: Duration = Duration::from_millis(500);
// Message write timeout (applies to all messages).
pub const WRITE_TIMEOUT: Duration = Duration::from_millis(500);
// TLS negotiation timeout.
pub const TLS_TIMEOUT: Duration = Duration::from_millis(500);
#[derive(Deserialize, Serialize, Debug)]
pub enum Update {
CreateDevice {

2
rkvm-server/Cargo.toml
View file

@ -20,8 +20,10 @@ slab = "0.4.8"
rand = "0.8.5"
tracing-subscriber = { version = "0.3.17", features = ["env-filter"] }
tracing = "0.1.37"
humantime = "2.1.0"
rkvm-net = { path = "../rkvm-net" }
rkvm-input = { path = "../rkvm-input" }
rkvm-config = { path = "../rkvm-config" }
[package.metadata.rpm]
package = "rkvm-server"

3
rkvm-server/src/config.rs
View file

@ -1,3 +1,4 @@
use rkvm_config::Timeout;
use rkvm_input::key::{Button, Key, Keyboard};
use serde::Deserialize;
use std::collections::HashSet;
@ -13,6 +14,8 @@ pub struct Config {
pub password: String,
pub switch_keys: HashSet<SwitchKey>,
pub propagate_switch_keys: Option<bool>,
#[serde(flatten)]
pub timeout: Timeout,
}
#[derive(Deserialize, Clone, Copy, PartialEq, Eq, Hash)]

2
rkvm-server/src/main.rs
View file

@ -71,7 +71,7 @@ async fn main() -> ExitCode {
let propagate_switch_keys = config.propagate_switch_keys.unwrap_or(true);
tokio::select! {
result = server::run(config.listen, acceptor, &config.password, &switch_keys, propagate_switch_keys) => {
result = server::run(config.listen, acceptor, &config.password, &switch_keys, propagate_switch_keys, config.timeout) => {
if let Err(err) = result {
tracing::error!("Error: {}", err);
return ExitCode::FAILURE;

22
rkvm-server/src/server.rs
View file

@ -1,3 +1,4 @@
use rkvm_config::Timeout;
use rkvm_input::abs::{AbsAxis, AbsInfo};
use rkvm_input::event::Event;
use rkvm_input::key::{Key, KeyEvent};
@ -39,6 +40,7 @@ pub async fn run(
password: &str,
switch_keys: &HashSet<Key>,
propagate_switch_keys: bool,
timeout: Timeout,
) -> Result<(), Error> {
let listener = TcpListener::bind(&listen).await.map_err(Error::Network)?;
tracing::info!("Listening on {}", listen);
@ -92,7 +94,7 @@ pub async fn run(
async move {
tracing::info!("Connected");
match client(init_updates, receiver, stream, acceptor, &password).await {
match client(init_updates, receiver, stream, acceptor, &password, timeout).await {
Ok(()) => tracing::info!("Disconnected"),
Err(err) => tracing::error!("Disconnected: {}", err),
}
@ -308,13 +310,14 @@ async fn client(
stream: TcpStream,
acceptor: TlsAcceptor,
password: &str,
timeout: Timeout,
) -> Result<(), ClientError> {
let stream = rkvm_net::timeout(rkvm_net::TLS_TIMEOUT, acceptor.accept(stream)).await?;
let stream = rkvm_net::timeout(timeout.tls, acceptor.accept(stream)).await?;
tracing::info!("TLS connected");
let mut stream = BufStream::with_capacity(1024, 1024, stream);
rkvm_net::timeout(rkvm_net::WRITE_TIMEOUT, async {
rkvm_net::timeout(timeout.write, async {
Version::CURRENT.encode(&mut stream).await?;
stream.flush().await?;
@ -322,7 +325,7 @@ async fn client(
})
.await?;
let version = rkvm_net::timeout(rkvm_net::READ_TIMEOUT, Version::decode(&mut stream)).await?;
let version = rkvm_net::timeout(timeout.read, Version::decode(&mut stream)).await?;
if version != Version::CURRENT {
return Err(ClientError::Version {
server: Version::CURRENT,
@ -332,7 +335,7 @@ async fn client(
let challenge = AuthChallenge::generate().await?;
rkvm_net::timeout(rkvm_net::WRITE_TIMEOUT, async {
rkvm_net::timeout(timeout.write, async {
challenge.encode(&mut stream).await?;
stream.flush().await?;
@ -340,14 +343,13 @@ async fn client(
})
.await?;
let response =
rkvm_net::timeout(rkvm_net::READ_TIMEOUT, AuthResponse::decode(&mut stream)).await?;
let response = rkvm_net::timeout(timeout.read, AuthResponse::decode(&mut stream)).await?;
let status = match response.verify(&challenge, password) {
true => AuthStatus::Passed,
false => AuthStatus::Failed,
};
rkvm_net::timeout(rkvm_net::WRITE_TIMEOUT, async {
rkvm_net::timeout(timeout.write, async {
status.encode(&mut stream).await?;
stream.flush().await?;
@ -386,7 +388,7 @@ async fn client(
};
let start = Instant::now();
rkvm_net::timeout(rkvm_net::WRITE_TIMEOUT, async {
rkvm_net::timeout(timeout.write, async {
update.encode(&mut stream).await?;
stream.flush().await?;
@ -400,7 +402,7 @@ async fn client(
tracing::debug!(duration = ?duration, "Sent ping");
let start = Instant::now();
rkvm_net::timeout(rkvm_net::READ_TIMEOUT, Pong::decode(&mut stream)).await?;
rkvm_net::timeout(timeout.read, Pong::decode(&mut stream)).await?;
let duration = start.elapsed();
tracing::debug!(duration = ?duration, "Received pong");