diff --git a/README.md b/README.md index 499941c..38780cb 100644 --- a/README.md +++ b/README.md @@ -488,8 +488,10 @@ This project consists of multiple components, each with its own license: | Component | Type | License | |-----------|------|---------| | [gpapi](./crates/gpapi) | Crate | [MIT](./crates/gpapi/LICENSE) | -| [openconnect](./crates/openconnect) | Crate | [GPL-3.0](./crates/openconnect/LICENSE) | -| [common](./crates/common) | Crate | [GPL-3.0](./crates/common/LICENSE) | +| [openconnect](./crates/openconnect) | Rust wrapper crate | [MIT](./crates/openconnect/LICENSE) | +| [upstream OpenConnect](./crates/openconnect/deps/openconnect) | C library | [LGPL-2.1](./crates/openconnect/deps/openconnect/COPYING.LGPL) | +| [common](./crates/common) | Crate | [MIT](./crates/common/LICENSE) | +| [browser-launcher](./crates/browser-launcher) | Crate | [MIT](./crates/browser-launcher/LICENSE) | | [auth](./crates/auth) | Crate | [GPL-3.0](./crates/auth/LICENSE) | | [gpservice](./apps/gpservice) | Application | [GPL-3.0](./apps/gpservice/LICENSE) | | [gpclient](./apps/gpclient) | Application | [GPL-3.0](./apps/gpclient/LICENSE) | diff --git a/apps/gpservice/src/cli.rs b/apps/gpservice/src/cli.rs index af31360..ad4cb1f 100644 --- a/apps/gpservice/src/cli.rs +++ b/apps/gpservice/src/cli.rs @@ -4,6 +4,8 @@ use std::sync::{ Arc, atomic::{AtomicBool, Ordering}, }; +#[cfg(target_os = "macos")] +use std::time::Duration; use std::{collections::HashMap, io::Write}; use anyhow::{Context, bail}; @@ -49,6 +51,9 @@ struct Cli { #[cfg(debug_assertions)] #[clap(long, requires = "dev_standalone")] dev_bootstrap_socket: Option, + #[cfg(target_os = "macos")] + #[clap(long, conflicts_with = "dev_standalone")] + macos_brokered: bool, #[command(flatten)] verbose: InfoLevelVerbosity, } @@ -71,13 +76,20 @@ impl Cli { let (vpn_state_tx, vpn_state_rx) = watch::channel(VpnState::Disconnected); let gui_restart_requested = Arc::new(AtomicBool::new(false)); let registry = Arc::new(SessionRegistry::new(Uuid::new_v4())); + let externally_brokered = self.externally_brokered(); + let brokered_helpers_dir = externally_brokered + .then(|| std::env::current_exe().ok()?.parent().map(ToOwned::to_owned)) + .flatten(); let dispatcher = Arc::new(RequestDispatcher::new( ws_req_tx.clone(), Arc::clone(&gui_restart_requested), Arc::clone(&redaction), + !externally_brokered, + brokered_helpers_dir, )); - let mut vpn_task = VpnTask::new(ws_req_rx, vpn_state_tx); + let mut vpn_task = VpnTask::new(ws_req_rx, vpn_state_tx, externally_brokered); + let idle_vpn_state_rx = vpn_state_rx.clone(); let ws_server = WsServer::new( env!("CARGO_PKG_VERSION"), Arc::clone(®istry), @@ -91,6 +103,27 @@ impl Cli { let vpn_task_cancel_token = vpn_task.cancel_token(); let server_token = ws_server.cancel_token(); + #[cfg(target_os = "macos")] + if externally_brokered { + let credential_server = crate::macos_broker::CredentialServer::new(Arc::clone(®istry)); + let credential_token = server_token.clone(); + let credential_shutdown = shutdown_tx.clone(); + tokio::spawn(async move { + if let Err(err) = credential_server.start(credential_token).await { + warn!("Broker credential server stopped: {err}"); + let _ = credential_shutdown.send(()).await; + } + }); + + let idle_registry = Arc::clone(®istry); + let idle_shutdown = shutdown_tx.clone(); + let idle_token = server_token.clone(); + tokio::spawn(async move { + wait_for_brokered_idle(idle_vpn_state_rx, idle_registry, idle_token).await; + let _ = idle_shutdown.send(()).await; + }); + } + #[cfg(debug_assertions)] if self.dev_standalone { let Some(dev_bootstrap_socket) = self.dev_bootstrap_socket.clone() else { @@ -123,9 +156,9 @@ impl Cli { let ws_server_handle = tokio::spawn(async move { ws_server.start(shutdown_tx_clone, ws_ready_tx).await }); #[cfg(debug_assertions)] - let launch_managed_gui = !self.dev_standalone; + let launch_managed_gui = !self.dev_standalone && !externally_brokered; #[cfg(not(debug_assertions))] - let launch_managed_gui = true; + let launch_managed_gui = !externally_brokered; if launch_managed_gui { ws_ready_rx.await.context("WebSocket server failed to start")?; @@ -158,6 +191,14 @@ impl Cli { Ok(()) } + fn externally_brokered(&self) -> bool { + #[cfg(target_os = "macos")] + return self.macos_brokered; + + #[cfg(not(target_os = "macos"))] + false + } + fn init_logger(&self) -> Arc { let redaction = Arc::new(Redaction::new()); let redaction_clone = Arc::clone(&redaction); @@ -186,6 +227,38 @@ impl Cli { } } +#[cfg(target_os = "macos")] +async fn wait_for_brokered_idle( + mut vpn_state_rx: watch::Receiver, + registry: Arc, + cancel: tokio_util::sync::CancellationToken, +) { + const IDLE_TIMEOUT: Duration = Duration::from_secs(60); + const CHECK_INTERVAL: Duration = Duration::from_secs(1); + + let mut idle_since = None; + let mut interval = tokio::time::interval(CHECK_INTERVAL); + loop { + tokio::select! { + _ = cancel.cancelled() => return, + _ = vpn_state_rx.changed() => {}, + _ = interval.tick() => {}, + } + + let idle = matches!(*vpn_state_rx.borrow(), VpnState::Disconnected) && registry.is_empty(); + if !idle { + idle_since = None; + continue; + } + + let started = idle_since.get_or_insert_with(tokio::time::Instant::now); + if started.elapsed() >= IDLE_TIMEOUT { + info!("Brokered service idle timeout reached"); + return; + } + } +} + #[cfg(unix)] mod signals { use std::sync::Arc; diff --git a/apps/gpservice/src/credential_lease.rs b/apps/gpservice/src/credential_lease.rs new file mode 100644 index 0000000..4415783 --- /dev/null +++ b/apps/gpservice/src/credential_lease.rs @@ -0,0 +1,29 @@ +use std::sync::Arc; + +use tokio::{ + io::{AsyncReadExt, AsyncWriteExt}, + net::UnixStream, +}; + +use crate::session_registry::SessionRegistry; + +pub(crate) async fn serve(mut stream: UnixStream, registry: Arc) -> anyhow::Result<()> { + let credential = registry.issue(env!("CARGO_PKG_VERSION"))?; + let session_id = credential.session_id(); + let result = async { + stream.write_all(&credential.encode_frame()?).await?; + + let mut buffer = [0_u8; 1]; + loop { + match stream.read(&mut buffer).await { + Ok(0) => break, + Ok(_) => continue, + Err(err) => return Err(err.into()), + } + } + Ok(()) + } + .await; + registry.revoke(session_id); + result +} diff --git a/apps/gpservice/src/dev_bootstrap.rs b/apps/gpservice/src/dev_bootstrap.rs index f421782..dc208e1 100644 --- a/apps/gpservice/src/dev_bootstrap.rs +++ b/apps/gpservice/src/dev_bootstrap.rs @@ -7,13 +7,10 @@ use std::{ use anyhow::{Context, bail}; use log::{info, warn}; use nix::unistd::{Uid, chown}; -use tokio::{ - io::{AsyncReadExt, AsyncWriteExt}, - net::{UnixListener, UnixStream}, -}; +use tokio::net::{UnixListener, UnixStream}; use tokio_util::sync::CancellationToken; -use crate::session_registry::SessionRegistry; +use crate::{credential_lease, session_registry::SessionRegistry}; pub struct DevBootstrap { path: PathBuf, @@ -57,7 +54,7 @@ impl DevBootstrap { } let registry = Arc::clone(&self.registry); tokio::spawn(async move { - if let Err(err) = authorize_gui(stream, registry).await { + if let Err(err) = credential_lease::serve(stream, registry).await { warn!("Debug credential client ended: {err}"); } }); @@ -123,28 +120,6 @@ fn prepare_socket_path(path: &Path, allowed_uid: u32) -> anyhow::Result Ok(path) } -async fn authorize_gui(mut stream: UnixStream, registry: Arc) -> anyhow::Result<()> { - let credential = registry.issue(env!("CARGO_PKG_VERSION"))?; - let session_id = credential.session_id(); - let result = async { - let frame = credential.encode_frame()?; - stream.write_all(&frame).await?; - - let mut buffer = [0_u8; 1]; - loop { - match stream.read(&mut buffer).await { - Ok(0) => break, - Ok(_) => continue, - Err(err) => return Err(err.into()), - } - } - Ok(()) - } - .await; - registry.revoke(session_id); - result -} - #[cfg(target_os = "linux")] fn peer_uid(stream: &UnixStream) -> anyhow::Result { use nix::sys::socket::{getsockopt, sockopt}; @@ -213,7 +188,7 @@ mod tests { async fn anchor_eof_revokes_issued_credential() { let registry = Arc::new(SessionRegistry::new(Uuid::new_v4())); let (service, mut client) = UnixStream::pair().unwrap(); - let task = tokio::spawn(authorize_gui(service, Arc::clone(®istry))); + let task = tokio::spawn(credential_lease::serve(service, Arc::clone(®istry))); let mut header = [0_u8; 2]; client.read_exact(&mut header).await.unwrap(); diff --git a/apps/gpservice/src/macos_broker.rs b/apps/gpservice/src/macos_broker.rs new file mode 100644 index 0000000..b1917ef --- /dev/null +++ b/apps/gpservice/src/macos_broker.rs @@ -0,0 +1,122 @@ +use std::{ + os::unix::fs::{FileTypeExt, MetadataExt, PermissionsExt}, + path::{Path, PathBuf}, + sync::Arc, +}; + +use anyhow::{Context, bail}; +use log::{info, warn}; +use nix::unistd::Uid; +use tokio::net::{UnixListener, UnixStream}; +use tokio_util::sync::CancellationToken; + +use crate::{credential_lease, session_registry::SessionRegistry}; + +pub(crate) const CREDENTIAL_SOCKET: &str = "/var/run/com.yuezk.gpgui/credential.sock"; + +pub(crate) struct CredentialServer { + registry: Arc, +} + +impl CredentialServer { + pub(crate) fn new(registry: Arc) -> Self { + Self { registry } + } + + pub(crate) async fn start(self, cancel: CancellationToken) -> anyhow::Result<()> { + if !Uid::effective().is_root() { + bail!("macOS brokered mode requires root privileges"); + } + + let path = prepare_socket(Path::new(CREDENTIAL_SOCKET), 0)?; + let listener = UnixListener::bind(&path) + .with_context(|| format!("Failed to bind broker credential socket at {}", path.display()))?; + std::fs::set_permissions(&path, std::fs::Permissions::from_mode(0o600))?; + info!("Broker credential socket listening at {}", path.display()); + + loop { + tokio::select! { + _ = cancel.cancelled() => break, + accepted = listener.accept() => { + let (stream, _) = accepted?; + if peer_uid(&stream)? != 0 { + warn!("Rejected non-root broker credential client"); + continue; + } + let registry = Arc::clone(&self.registry); + tokio::spawn(async move { + if let Err(err) = credential_lease::serve(stream, registry).await { + warn!("Broker credential lease ended: {err}"); + } + }); + } + } + } + + drop(listener); + remove_socket(&path, 0)?; + Ok(()) + } +} + +fn prepare_socket(path: &Path, owner_uid: u32) -> anyhow::Result { + let parent = path + .parent() + .context("Broker credential socket has no parent directory")?; + if !parent.exists() { + std::fs::create_dir_all(parent)?; + } + + let metadata = std::fs::symlink_metadata(parent)?; + if metadata.file_type().is_symlink() || !metadata.is_dir() || metadata.uid() != owner_uid { + bail!("Broker credential directory must be a real root-owned directory"); + } + if metadata.permissions().mode() & 0o077 != 0 { + std::fs::set_permissions(parent, std::fs::Permissions::from_mode(0o700))?; + } + + remove_socket(path, owner_uid)?; + Ok(path.to_path_buf()) +} + +fn remove_socket(path: &Path, owner_uid: u32) -> anyhow::Result<()> { + match std::fs::symlink_metadata(path) { + Ok(metadata) if metadata.file_type().is_socket() && metadata.uid() == owner_uid => { + std::fs::remove_file(path)?; + } + Ok(_) => bail!("Refusing to replace an unsafe broker credential path"), + Err(err) if err.kind() == std::io::ErrorKind::NotFound => {} + Err(err) => return Err(err.into()), + } + Ok(()) +} + +fn peer_uid(stream: &UnixStream) -> anyhow::Result { + let (uid, _) = nix::unistd::getpeereid(stream)?; + Ok(uid.as_raw()) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn prepares_private_owner_directory_and_removes_owned_socket_only() { + let temp = tempfile::tempdir().unwrap(); + let owner = Uid::current().as_raw(); + let parent = temp.path().join("runtime"); + let socket = parent.join("credential.sock"); + + assert_eq!(prepare_socket(&socket, owner).unwrap(), socket); + assert_eq!(std::fs::metadata(&parent).unwrap().permissions().mode() & 0o777, 0o700); + + std::fs::write(&socket, "not a socket").unwrap(); + assert!(prepare_socket(&socket, owner).is_err()); + } + + #[tokio::test] + async fn peer_uid_matches_current_process() { + let (stream, _peer) = UnixStream::pair().unwrap(); + assert_eq!(peer_uid(&stream).unwrap(), Uid::current().as_raw()); + } +} diff --git a/apps/gpservice/src/main.rs b/apps/gpservice/src/main.rs index 53ee924..2949cc3 100644 --- a/apps/gpservice/src/main.rs +++ b/apps/gpservice/src/main.rs @@ -1,7 +1,11 @@ mod cli; +#[cfg(unix)] +mod credential_lease; #[cfg(debug_assertions)] mod dev_bootstrap; mod handlers; +#[cfg(target_os = "macos")] +mod macos_broker; mod request_dispatcher; mod routes; mod session_registry; diff --git a/apps/gpservice/src/request_dispatcher.rs b/apps/gpservice/src/request_dispatcher.rs index d32d7bb..834a62c 100644 --- a/apps/gpservice/src/request_dispatcher.rs +++ b/apps/gpservice/src/request_dispatcher.rs @@ -29,6 +29,8 @@ pub struct RequestDispatcher { gui_restart_requested: Arc, redaction: Arc, install_lock: Mutex<()>, + gui_management_enabled: bool, + brokered_helpers_dir: Option, } impl RequestDispatcher { @@ -36,33 +38,49 @@ impl RequestDispatcher { ws_req_tx: mpsc::Sender, gui_restart_requested: Arc, redaction: Arc, + gui_management_enabled: bool, + brokered_helpers_dir: Option, ) -> Self { Self { ws_req_tx, gui_restart_requested, redaction, install_lock: Mutex::new(()), + gui_management_enabled, + brokered_helpers_dir, } } pub async fn dispatch(&self, request: WsRequest) -> ServiceResult { match request { WsRequest::RestartGui => { + if !self.gui_management_enabled { + return ServiceResult::rejected(ServiceErrorCode::InvalidRequest, "GUI restart is unavailable on macOS"); + } info!("GUI restart requested"); self .gui_restart_requested .store(true, std::sync::atomic::Ordering::SeqCst); ServiceResult::Accepted } - WsRequest::UpdateGui(request) => self.update_gui(request).await, + WsRequest::UpdateGui(request) => { + if !self.gui_management_enabled { + return ServiceResult::rejected(ServiceErrorCode::InvalidRequest, "GUI update is unavailable on macOS"); + } + self.update_gui(request).await + } request => { - if let WsRequest::Connect(ref connect) = request - && let Err(err) = self + if let WsRequest::Connect(ref connect) = request { + if let Err(message) = self.validate_connect_paths(connect) { + return ServiceResult::rejected(ServiceErrorCode::InvalidRequest, message); + } + if let Err(err) = self .redaction .add_values(&[connect.gateway().server(), connect.args().cookie()]) - { - warn!("Failed to update log redaction: {err}"); - return ServiceResult::rejected(ServiceErrorCode::Internal, "Request could not be accepted"); + { + warn!("Failed to update log redaction: {err}"); + return ServiceResult::rejected(ServiceErrorCode::Internal, "Request could not be accepted"); + } } match self.ws_req_tx.try_send(request) { @@ -78,6 +96,24 @@ impl RequestDispatcher { } } + fn validate_connect_paths(&self, request: &gpapi::service::request::ConnectRequest) -> Result<(), &'static str> { + let Some(helpers) = &self.brokered_helpers_dir else { + return Ok(()); + }; + let expected_script = helpers.join("vpnc-script").to_string_lossy().into_owned(); + let expected_wrapper = helpers.join("hipreport.sh").to_string_lossy().into_owned(); + if request.args().vpnc_script().as_deref() != Some(expected_script.as_str()) { + return Err("macOS VPN script must be the bundled script"); + } + if request.args().csd_wrapper().as_deref() != Some(expected_wrapper.as_str()) { + return Err("macOS HIP wrapper must be the bundled wrapper"); + } + if request.args().certificate().is_some() || request.args().sslkey().is_some() { + return Err("macOS client identity must be provided as protected data, not root-readable paths"); + } + Ok(()) + } + async fn update_gui(&self, request: UpdateGuiRequest) -> ServiceResult { let _install = self.install_lock.lock().await; let path = request.path; @@ -210,6 +246,13 @@ fn extract_gui_binary(archive: &mut Archive, dir: &Path) -> Result bool { + let Ok(mut sessions) = self.sessions.lock() else { + return false; + }; + let now = Instant::now(); + sessions.retain(|_, record| { + !matches!( + record.status, + SessionStatus::Pending { + activation_deadline, .. + } if now > activation_deadline + ) + }); + sessions.is_empty() + } + pub fn begin_handshake( self: &Arc, service_instance_id: Uuid, diff --git a/apps/gpservice/src/vpn_task.rs b/apps/gpservice/src/vpn_task.rs index cd9fe13..ca14adc 100644 --- a/apps/gpservice/src/vpn_task.rs +++ b/apps/gpservice/src/vpn_task.rs @@ -1,9 +1,9 @@ -use std::{sync::Arc, thread}; +use std::{io::Write, os::unix::fs::PermissionsExt, sync::Arc, thread}; use gpapi::{ logger, service::{ - request::{ConnectRequest, UpdateLogLevelRequest, WsRequest}, + request::{ConnectRequest, MAX_CLIENT_IDENTITY_DATA, UpdateLogLevelRequest, WsRequest}, vpn_state::{ConnectedInfo, VpnState}, }, session::{SessionInfo, SessionWarning}, @@ -12,19 +12,24 @@ use log::{info, warn}; use openconnect::Vpn; use tokio::sync::{RwLock, mpsc, oneshot, watch}; use tokio_util::sync::CancellationToken; +use zeroize::Zeroizing; pub(crate) struct VpnTaskContext { vpn_handle: Arc>>, vpn_state_tx: Arc>, disconnect_rx: RwLock>>, + brokered_macos: bool, + identity_files: Arc>>, } impl VpnTaskContext { - pub fn new(vpn_state_tx: watch::Sender) -> Self { + pub fn new(vpn_state_tx: watch::Sender, brokered_macos: bool) -> Self { Self { vpn_handle: Default::default(), vpn_state_tx: Arc::new(vpn_state_tx), disconnect_rx: Default::default(), + brokered_macos, + identity_files: Default::default(), } } @@ -39,6 +44,14 @@ impl VpnTaskContext { let info = req.info().clone(); let vpn_handle = Arc::clone(&self.vpn_handle); let args = req.args(); + let identity = match prepare_identity(args, self.brokered_macos) { + Ok(identity) => identity, + Err(err) => { + warn!("Failed to prepare client identity: {err}"); + vpn_state_tx.send(VpnState::Disconnected).ok(); + return; + } + }; let allow_extend_session = args.allow_extend_session(); let vpn = match Vpn::builder(req.gateway().server(), args.cookie()) .script(args.vpnc_script()) @@ -47,8 +60,8 @@ impl VpnTaskContext { .os_version(args.os_version()) .client_version(args.client_version()) .host_id(args.host_id()) - .certificate(args.certificate()) - .sslkey(args.sslkey()) + .certificate(identity.certificate.clone()) + .sslkey(identity.sslkey.clone()) .key_password(args.key_password()) .hip(args.hip()) .csd_uid(args.csd_uid()) @@ -72,11 +85,13 @@ impl VpnTaskContext { // Save the VPN handle vpn_handle.write().await.replace(vpn); + *self.identity_files.write().await = identity.files; let connect_info = Box::new(info.clone()); vpn_state_tx.send(VpnState::Connecting(connect_info)).ok(); let (disconnect_tx, disconnect_rx) = oneshot::channel::<()>(); self.disconnect_rx.write().await.replace(disconnect_rx); + let identity_files = Arc::clone(&self.identity_files); // Spawn a new thread to process the VPN connection, cannot use tokio::spawn here. // Otherwise, it will block the tokio runtime and cannot send the VPN state to the channel @@ -104,6 +119,7 @@ impl VpnTaskContext { vpn_state_tx_clone.send(VpnState::Disconnected).ok(); // Remove the VPN handle vpn_handle.blocking_write().take(); + identity_files.blocking_write().clear(); disconnect_tx.send(()).ok(); }); @@ -137,8 +153,12 @@ pub(crate) struct VpnTask { } impl VpnTask { - pub fn new(ws_req_rx: mpsc::Receiver, vpn_state_tx: watch::Sender) -> Self { - let ctx = Arc::new(VpnTaskContext::new(vpn_state_tx)); + pub fn new( + ws_req_rx: mpsc::Receiver, + vpn_state_tx: watch::Sender, + brokered_macos: bool, + ) -> Self { + let ctx = Arc::new(VpnTaskContext::new(vpn_state_tx, brokered_macos)); let cancel_token = CancellationToken::new(); Self { @@ -179,6 +199,55 @@ impl VpnTask { } } +struct PreparedIdentity { + certificate: Option, + sslkey: Option, + files: Vec, +} + +fn prepare_identity( + args: &gpapi::service::request::ConnectArgs, + brokered_macos: bool, +) -> anyhow::Result { + if !brokered_macos { + return Ok(PreparedIdentity { + certificate: args.certificate(), + sslkey: args.sslkey(), + files: vec![], + }); + } + + let certificate = args.certificate_data()?.map(Zeroizing::new); + let sslkey = args.sslkey_data()?.map(Zeroizing::new); + let total_size = certificate.as_ref().map_or(0, |data| data.len()) + sslkey.as_ref().map_or(0, |data| data.len()); + if total_size > MAX_CLIENT_IDENTITY_DATA { + anyhow::bail!("Client certificate and key exceed the macOS size limit"); + } + + let mut files = Vec::new(); + let certificate = write_identity_file(certificate, &mut files)?; + let sslkey = write_identity_file(sslkey, &mut files)?; + Ok(PreparedIdentity { + certificate, + sslkey, + files, + }) +} + +fn write_identity_file( + data: Option>>, + files: &mut Vec, +) -> anyhow::Result> { + let Some(data) = data else { return Ok(None) }; + let mut file = tempfile::NamedTempFile::new_in("/var/run/com.yuezk.gpgui")?; + file.as_file().set_permissions(std::fs::Permissions::from_mode(0o600))?; + file.write_all(&data)?; + file.flush()?; + let path = file.path().to_string_lossy().into_owned(); + files.push(file); + Ok(Some(path)) +} + async fn process_ws_req(req: WsRequest, ctx: Arc) { match req { WsRequest::Connect(req) => { diff --git a/apps/gpservice/src/ws_connection.rs b/apps/gpservice/src/ws_connection.rs index fa6379a..12f8471 100644 --- a/apps/gpservice/src/ws_connection.rs +++ b/apps/gpservice/src/ws_connection.rs @@ -413,6 +413,8 @@ mod tests { request_tx, Arc::new(AtomicBool::new(false)), Arc::new(Redaction::new()), + true, + None, )); let (_state_tx, state_rx) = watch::channel(VpnState::Disconnected); let context = Arc::new(WsServerContext::new( diff --git a/apps/gpservice/src/ws_server.rs b/apps/gpservice/src/ws_server.rs index 7da9b47..666192e 100644 --- a/apps/gpservice/src/ws_server.rs +++ b/apps/gpservice/src/ws_server.rs @@ -295,6 +295,8 @@ mod tests { request_tx, Arc::new(AtomicBool::new(false)), Arc::new(Redaction::new()), + true, + None, )); let (_state_tx, state_rx) = watch::channel(VpnState::Disconnected); let context = Arc::new(WsServerContext::new( @@ -344,6 +346,8 @@ mod tests { request_tx, Arc::new(AtomicBool::new(false)), Arc::new(Redaction::new()), + true, + None, )); let (_state_tx, state_rx) = watch::channel(VpnState::Disconnected); let context = Arc::new(WsServerContext::new( diff --git a/crates/browser-launcher/Cargo.toml b/crates/browser-launcher/Cargo.toml index 099b99b..ee9b036 100644 --- a/crates/browser-launcher/Cargo.toml +++ b/crates/browser-launcher/Cargo.toml @@ -5,7 +5,7 @@ version.workspace = true authors.workspace = true homepage.workspace = true edition.workspace = true -license.workspace = true +license = "MIT" [dependencies] anyhow.workspace = true diff --git a/crates/browser-launcher/LICENSE b/crates/browser-launcher/LICENSE new file mode 100644 index 0000000..018a470 --- /dev/null +++ b/crates/browser-launcher/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Kevin Yue + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/crates/common/Cargo.toml b/crates/common/Cargo.toml index 84a36d1..9d90f8b 100644 --- a/crates/common/Cargo.toml +++ b/crates/common/Cargo.toml @@ -5,4 +5,4 @@ version.workspace = true authors.workspace = true homepage.workspace = true edition.workspace = true -license.workspace = true +license = "MIT" diff --git a/crates/common/LICENSE b/crates/common/LICENSE index f288702..018a470 100644 --- a/crates/common/LICENSE +++ b/crates/common/LICENSE @@ -1,674 +1,21 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. +MIT License + +Copyright (c) 2024 Kevin Yue + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/crates/gpapi/src/service/request.rs b/crates/gpapi/src/service/request.rs index 15ff6e4..12afe2b 100644 --- a/crates/gpapi/src/service/request.rs +++ b/crates/gpapi/src/service/request.rs @@ -1,7 +1,8 @@ -use std::collections::HashMap; +use std::{collections::HashMap, fmt}; use serde::{Deserialize, Serialize}; use specta::Type; +use zeroize::Zeroize; use crate::{ gateway::Gateway, @@ -10,6 +11,8 @@ use crate::{ use super::vpn_state::ConnectInfo; +pub const MAX_CLIENT_IDENTITY_DATA: usize = 32 * 1024; + #[derive(Debug, Deserialize, Serialize)] pub struct LaunchGuiRequest { user: String, @@ -30,7 +33,7 @@ impl LaunchGuiRequest { } } -#[derive(Debug, Deserialize, Serialize, Type, Clone)] +#[derive(Deserialize, Serialize, Type, Clone)] pub struct ConnectArgs { cookie: String, vpnc_script: Option, @@ -43,6 +46,8 @@ pub struct ConnectArgs { certificate: Option, sslkey: Option, + certificate_data: Option, + sslkey_data: Option, key_password: Option, hip: bool, @@ -72,6 +77,8 @@ impl ConnectArgs { host_id: None, certificate: None, sslkey: None, + certificate_data: None, + sslkey_data: None, key_password: None, hip: false, csd_uid: 0, @@ -127,6 +134,22 @@ impl ConnectArgs { self.sslkey.clone() } + pub fn certificate_data(&self) -> anyhow::Result>> { + self + .certificate_data + .as_deref() + .map(crate::utils::base64::decode_to_vec) + .transpose() + } + + pub fn sslkey_data(&self) -> anyhow::Result>> { + self + .sslkey_data + .as_deref() + .map(crate::utils::base64::decode_to_vec) + .transpose() + } + pub fn key_password(&self) -> Option { self.key_password.clone() } @@ -176,6 +199,40 @@ impl ConnectArgs { } } +impl fmt::Debug for ConnectArgs { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.debug_struct("ConnectArgs") + .field("cookie", &"") + .field("vpnc_script", &self.vpnc_script) + .field( + "client_auth_path", + &(self.certificate.is_some() || self.sslkey.is_some()), + ) + .field( + "client_auth_data", + &(self.certificate_data.is_some() || self.sslkey_data.is_some()), + ) + .field("hip", &self.hip) + .field("csd_uid", &self.csd_uid) + .field("csd_wrapper", &self.csd_wrapper) + .field("reconnect_timeout", &self.reconnect_timeout) + .field("mtu", &self.mtu) + .field("disable_ipv6", &self.disable_ipv6) + .field("no_dtls", &self.no_dtls) + .field("allow_extend_session", &self.allow_extend_session) + .finish_non_exhaustive() + } +} + +impl Drop for ConnectArgs { + fn drop(&mut self) { + self.cookie.zeroize(); + self.key_password.zeroize(); + self.certificate_data.zeroize(); + self.sslkey_data.zeroize(); + } +} + #[derive(Debug, Deserialize, Serialize, Type, Clone)] pub struct ConnectRequest { info: ConnectInfo, @@ -229,6 +286,16 @@ impl ConnectRequest { self } + pub fn with_certificate_data(mut self, certificate: Option>) -> Self { + self.args.certificate_data = certificate.map(encode_secret); + self + } + + pub fn with_sslkey_data(mut self, sslkey: Option>) -> Self { + self.args.sslkey_data = sslkey.map(encode_secret); + self + } + pub fn with_key_password>>(mut self, key_password: T) -> Self { self.args.key_password = key_password.into(); self @@ -287,6 +354,12 @@ impl ConnectRequest { } } +fn encode_secret(mut data: Vec) -> String { + let encoded = crate::utils::base64::encode(&data); + data.zeroize(); + encoded +} + #[derive(Debug, Deserialize, Serialize, Type)] pub struct DisconnectRequest; @@ -351,4 +424,19 @@ mod tests { Some(profile.host_identity().host_id().to_string()) ); } + + #[test] + fn client_identity_data_round_trips_without_debug_disclosure() { + let req = ConnectRequest::new(test_connect_info(), "secret-cookie".to_string()) + .with_certificate_data(Some(b"certificate".to_vec())) + .with_sslkey_data(Some(b"private-key".to_vec())); + let encoded = serde_json::to_vec(&req).unwrap(); + let decoded: ConnectRequest = serde_json::from_slice(&encoded).unwrap(); + + assert_eq!(decoded.args().certificate_data().unwrap().unwrap(), b"certificate"); + assert_eq!(decoded.args().sslkey_data().unwrap().unwrap(), b"private-key"); + let debug = format!("{decoded:?}"); + assert!(!debug.contains("secret-cookie")); + assert!(!debug.contains("private-key")); + } } diff --git a/crates/gpapi/src/service/transport/message.rs b/crates/gpapi/src/service/transport/message.rs index 2b8d035..a2896df 100644 --- a/crates/gpapi/src/service/transport/message.rs +++ b/crates/gpapi/src/service/transport/message.rs @@ -115,6 +115,14 @@ pub(crate) fn decode Deserialize<'de>>(encoded: &[u8]) -> Result(&oversized).is_err()); } + + #[test] + fn maximum_client_identity_fits_one_transport_message() { + let gateway = Gateway::new("Gateway".to_string(), "vpn.example.com".to_string()); + let info = ConnectInfo::new("portal.example.com".to_string(), gateway.clone(), vec![gateway]); + let certificate_size = MAX_CLIENT_IDENTITY_DATA / 2; + let request = ConnectRequest::new(info, "cookie".to_string()) + .with_certificate_data(Some(vec![b'c'; certificate_size])) + .with_sslkey_data(Some(vec![b'k'; MAX_CLIENT_IDENTITY_DATA - certificate_size])); + let message = ClientMessage::Request { + id: Uuid::new_v4(), + request: WsRequest::Connect(Box::new(request)), + }; + + let encoded = encode(&message).unwrap(); + assert!(encoded.len() <= MAX_PLAINTEXT); + } } diff --git a/crates/gpapi/src/utils/request.rs b/crates/gpapi/src/utils/request.rs index e992f2a..3dec154 100644 --- a/crates/gpapi/src/utils/request.rs +++ b/crates/gpapi/src/utils/request.rs @@ -88,6 +88,7 @@ mod tests { } #[test] + #[cfg(not(target_os = "macos"))] fn create_identity_from_pem_with_passphrase() { let cert = "tests/files/badssl.com-client.pem"; let passphrase = "badssl.com"; @@ -98,6 +99,7 @@ mod tests { } #[test] + #[cfg(not(target_os = "macos"))] fn create_identity_from_pem_unencrypted_key() { let cert = "tests/files/badssl.com-client-unencrypted.pem"; let identity = create_identity_from_pem(cert, None, None); @@ -107,6 +109,7 @@ mod tests { } #[test] + #[cfg(not(target_os = "macos"))] fn create_identity_from_pem_cert_and_encrypted_key() { let cert = "tests/files/badssl.com-client.pem"; let key = "tests/files/badssl.com-client.pem"; @@ -129,6 +132,7 @@ mod tests { } #[test] + #[cfg(not(target_os = "macos"))] fn create_identity_from_pem_cert_and_unencrypted_key() { let cert = "tests/files/badssl.com-client.pem"; let key = "tests/files/badssl.com-client-unencrypted.pem"; diff --git a/crates/openconnect/Cargo.toml b/crates/openconnect/Cargo.toml index 609cbdc..7dba5e1 100644 --- a/crates/openconnect/Cargo.toml +++ b/crates/openconnect/Cargo.toml @@ -2,7 +2,7 @@ name = "openconnect" version.workspace = true edition.workspace = true -license.workspace = true +license = "MIT" links = "openconnect" [dependencies] diff --git a/crates/openconnect/LICENSE b/crates/openconnect/LICENSE index f288702..018a470 100644 --- a/crates/openconnect/LICENSE +++ b/crates/openconnect/LICENSE @@ -1,674 +1,21 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. +MIT License + +Copyright (c) 2024 Kevin Yue + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/crates/openconnect/build.rs b/crates/openconnect/build.rs index 4a7fef6..53f9631 100644 --- a/crates/openconnect/build.rs +++ b/crates/openconnect/build.rs @@ -2,6 +2,7 @@ use std::{env, path::PathBuf}; fn build_libxml2(deps_dir: &PathBuf, out_dir: &PathBuf) -> PathBuf { let libxml2_dir = deps_dir.join("libxml2"); + let install_dir = out_dir.join("libxml2_install"); // The temporary location where we will build let build_src = out_dir.join("libxml2_build"); @@ -14,6 +15,10 @@ fn build_libxml2(deps_dir: &PathBuf, out_dir: &PathBuf) -> PathBuf { if build_src.exists() { std::fs::remove_dir_all(&build_src).unwrap(); } + if install_dir.exists() { + std::fs::remove_dir_all(&install_dir).unwrap(); + } + std::fs::create_dir_all(&install_dir).unwrap(); std::fs::create_dir_all(&build_src).unwrap(); // Copy the source code to OUT_DIR @@ -25,24 +30,28 @@ fn build_libxml2(deps_dir: &PathBuf, out_dir: &PathBuf) -> PathBuf { fs_extra::dir::copy(&libxml2_dir, &build_src, &options).expect("Failed to copy C source code to OUT_DIR"); // Build the libxml2 library using autotools - let dst = autotools::Config::new(&build_src) - .reconf("-ivf") - .enable_static() - .disable_shared() - // Disable optional features that complicate static builds - .with("python", Some("no")) - .with("icu", Some("no")) - .with("http", Some("no")) - .with("ftp", Some("no")) - .with("catalog", Some("no")) - .with("docbook", Some("no")) - .with("legacy", Some("no")) - .with("threads", Some("no")) - .with("zlib", Some("no")) - .with("lzma", Some("no")) - // Ensure position-independent code (safe for static linking) - .cflag("-fPIC") - .build(); + let dst = { + let mut config = autotools::Config::new(&build_src); + config + .out_dir(&install_dir) + .reconf("-ivf") + .enable_static() + .disable_shared() + // Disable optional features that complicate static builds + .with("python", Some("no")) + .with("icu", Some("no")) + .with("http", Some("no")) + .with("ftp", Some("no")) + .with("catalog", Some("no")) + .with("docbook", Some("no")) + .with("legacy", Some("no")) + .with("threads", Some("no")) + .with("zlib", Some("no")) + .with("lzma", Some("no")) + // Ensure position-independent code (safe for static linking) + .cflag("-fPIC"); + config.build() + }; let lib_dir = dst.join("lib"); let include_dir = dst.join("include/libxml2"); @@ -61,6 +70,7 @@ fn build_libxml2(deps_dir: &PathBuf, out_dir: &PathBuf) -> PathBuf { fn build_openconnect(deps_dir: &PathBuf, out_dir: &PathBuf) -> PathBuf { let openconnect_dir = deps_dir.join("openconnect"); + let install_dir = out_dir.join("openconnect_install"); // The temporary location where we will build let build_src = out_dir.join("openconnect_build"); @@ -73,6 +83,10 @@ fn build_openconnect(deps_dir: &PathBuf, out_dir: &PathBuf) -> PathBuf { if build_src.exists() { std::fs::remove_dir_all(&build_src).unwrap(); } + if install_dir.exists() { + std::fs::remove_dir_all(&install_dir).unwrap(); + } + std::fs::create_dir_all(&install_dir).unwrap(); std::fs::create_dir_all(&build_src).unwrap(); // Copy the source code to OUT_DIR @@ -83,15 +97,13 @@ fn build_openconnect(deps_dir: &PathBuf, out_dir: &PathBuf) -> PathBuf { fs_extra::dir::copy(&openconnect_dir, &build_src, &options).expect("Failed to copy C source code to OUT_DIR"); - // Build the OpenConnect library using autotools - // We explicitly enable static and disable shared to ensure we get a .a file. - // .reconf("-ivf") is CRITICAL for git submodules because 'configure' - // usually doesn't exist yet and needs to be generated. + // Build the OpenConnect library using autotools. Keep the upstream LGPL + // library dynamically linked on macOS so it remains replaceable in the app + // bundle. Other platforms retain the existing static-link behavior. let mut config = autotools::Config::new(&build_src); config + .out_dir(&install_dir) .reconf("-ivf") - .enable_static() - .disable_shared() .disable("nls", None) // disable translations to save space .disable("docs", None) .disable("dsa-tests", None) @@ -105,10 +117,14 @@ fn build_openconnect(deps_dir: &PathBuf, out_dir: &PathBuf) -> PathBuf { #[cfg(target_os = "macos")] { + config.disable_static().enable_shared(); config.ldflag("-liconv"); config.env("LIBS", "-liconv"); } + #[cfg(not(target_os = "macos"))] + config.enable_static().disable_shared(); + #[cfg(any(target_os = "freebsd", target_os = "openbsd"))] { config.ldflag("-L/usr/local/lib"); @@ -121,10 +137,12 @@ fn build_openconnect(deps_dir: &PathBuf, out_dir: &PathBuf) -> PathBuf { let lib_dir = dst.join("lib"); let include_dir = dst.join("include"); - // Tell rustc where to find the static library println!("cargo:rustc-link-search=native={}", lib_dir.display()); - // Static linking of openconnect + #[cfg(target_os = "macos")] + println!("cargo:rustc-link-lib=dylib=openconnect"); + + #[cfg(not(target_os = "macos"))] println!("cargo:rustc-link-lib=static=openconnect"); // Export include path for downstream use (bindgen / cc)