feat: persist VPN script installation metadata

This commit is contained in:
Kevin Yue committed 2026-07-30 22:06:18 +08:00
1 parent 6999b2725e
commit 40b35804e7
10 files changed
+276 -39

No files matched your search

+1
View File
@@ -3,3 +3,4 @@ pub mod request;
pub mod transport;
pub mod vpn_env;
pub mod vpn_state;
pub mod vpnc_script;
+1
View File
@@ -374,6 +374,7 @@ pub enum WsRequest {
UpdateLogLevel(UpdateLogLevelRequest),
RestartGui,
UpdateGui(UpdateGuiRequest),
GetVpncScriptMetadata,
}
#[derive(Debug, Clone, Deserialize, Serialize)]
@@ -1,7 +1,7 @@
use serde::{Deserialize, Serialize};
use uuid::Uuid;
use crate::service::{event::WsEvent, request::WsRequest, vpn_env::VpnEnv};
use crate::service::{event::WsEvent, request::WsRequest, vpn_env::VpnEnv, vpnc_script::VpncScriptMetadata};
use super::{MAX_PLAINTEXT, MAX_SERVICE_MESSAGE, ServiceErrorCode, TransportError};
@@ -39,6 +39,7 @@ pub enum ServerMessage {
#[serde(tag = "type", content = "data", rename_all = "camelCase", deny_unknown_fields)]
pub enum ServiceResult {
Accepted,
VpncScriptMetadata(Option<VpncScriptMetadata>),
Rejected(ServiceRejection),
}
+84
View File
@@ -0,0 +1,84 @@
use anyhow::bail;
use serde::{Deserialize, Serialize};
use specta::Type;
use crate::utils::base64;
pub const MAX_VPNC_SCRIPT_SOURCE_VALUE: usize = 32 * 1024;
#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, Type)]
#[serde(rename_all = "camelCase")]
pub enum VpncScriptSource {
File,
Command,
}
#[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct VpncScriptMetadata {
pub source: VpncScriptSource,
pub value: String,
}
impl VpncScriptMetadata {
pub fn new(source: VpncScriptSource, value: String) -> anyhow::Result<Self> {
if value.trim().is_empty() {
bail!("VPNC script source is empty");
}
if value.contains('\0') {
bail!("VPNC script source contains a null character");
}
if value.len() > MAX_VPNC_SCRIPT_SOURCE_VALUE {
bail!(
"VPNC script source exceeds the {} byte limit",
MAX_VPNC_SCRIPT_SOURCE_VALUE
);
}
Ok(Self { source, value })
}
pub fn validate(&self) -> anyhow::Result<()> {
Self::new(self.source, self.value.clone()).map(|_| ())
}
}
#[derive(Debug, Deserialize, Serialize)]
pub struct InstallVpncScriptRequest {
pub metadata: VpncScriptMetadata,
contents: String,
}
impl InstallVpncScriptRequest {
pub fn new(metadata: VpncScriptMetadata, contents: &[u8]) -> Self {
Self {
metadata,
contents: base64::encode(contents),
}
}
pub fn contents(&self) -> anyhow::Result<Vec<u8>> {
base64::decode_to_vec(&self.contents)
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn install_request_round_trips_binary_contents() {
let metadata = VpncScriptMetadata::new(VpncScriptSource::File, "/tmp/vpnc-script".to_owned()).unwrap();
let request = InstallVpncScriptRequest::new(metadata, b"#!/bin/sh\n");
let encoded = serde_json::to_vec(&request).unwrap();
let decoded: InstallVpncScriptRequest = serde_json::from_slice(&encoded).unwrap();
assert_eq!(decoded.contents().unwrap(), b"#!/bin/sh\n");
}
#[test]
fn metadata_rejects_invalid_source_value() {
assert!(VpncScriptMetadata::new(VpncScriptSource::Command, String::new()).is_err());
assert!(VpncScriptMetadata::new(VpncScriptSource::Command, "echo\0value".to_owned()).is_err());
assert!(VpncScriptMetadata::new(VpncScriptSource::Command, "x".repeat(MAX_VPNC_SCRIPT_SOURCE_VALUE + 1)).is_err());
}
}