11 Commits

Author SHA1 Message Date
d1fbc70b40 chore(release): v0.0.4 (#22)
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
chore(release): 0.0.4

Co-authored-by: cuddle-please <bot@cuddle.sh>
Reviewed-on: #22
2025-08-03 14:37:13 +02:00
f060e9d2ca feat: pipe output
All checks were successful
continuous-integration/drone/push Build is passing
2025-08-03 14:32:52 +02:00
05b34fd7ee feat: replace bytes with string to avoid endianness
All checks were successful
continuous-integration/drone/push Build is passing
2025-08-03 13:38:42 +02:00
97f5c3a500 feat: sanitise output
All checks were successful
continuous-integration/drone/push Build is passing
2025-08-03 13:33:31 +02:00
404e393b97 chore: add print to output from paste
All checks were successful
continuous-integration/drone/push Build is passing
2025-08-03 13:29:36 +02:00
838cd9d6b1 feat: replace output spawn with native tokio method
All checks were successful
continuous-integration/drone/push Build is passing
2025-08-03 13:03:57 +02:00
50a929d883 chore(release): v0.0.3 (#21)
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
chore(release): 0.0.3

Co-authored-by: cuddle-please <bot@cuddle.sh>
Reviewed-on: #21
2025-08-03 12:45:21 +02:00
f982f094be feat: don't use front
All checks were successful
continuous-integration/drone/push Build is passing
2025-08-03 12:45:01 +02:00
4408c1839e test commit
Some checks failed
continuous-integration/drone/push Build is failing
2025-08-03 12:39:14 +02:00
bef15cb280 feat: add paste command both local and remote
Some checks failed
continuous-integration/drone/push Build is failing
2025-08-03 12:30:07 +02:00
3e27fb2847 feat: add publish 2025-08-03 12:11:17 +02:00
12 changed files with 323 additions and 29 deletions

View File

@@ -6,6 +6,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased] ## [Unreleased]
## [0.0.4] - 2025-08-03
### Added
- pipe output
- replace bytes with string to avoid endianness
- sanitise output
- replace output spawn with native tokio method
### Other
- add print to output from paste
## [0.0.3] - 2025-08-03
### Added
- don't use front
- add paste command both local and remote
- add publish
### Other
- test commit
## [0.0.2] - 2025-08-02 ## [0.0.2] - 2025-08-02
### Added ### Added

68
Cargo.lock generated
View File

@@ -17,6 +17,15 @@ version = "2.0.1"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "320119579fcad9c21884f5c4861d16174d0e06250625266f50fe6898340abefa" checksum = "320119579fcad9c21884f5c4861d16174d0e06250625266f50fe6898340abefa"
[[package]]
name = "aho-corasick"
version = "1.1.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8e60d3430d3a69478ad0993f19238d2df97c507009a52b3c10addcd7f6bcb916"
dependencies = [
"memchr",
]
[[package]] [[package]]
name = "anstream" name = "anstream"
version = "0.6.19" version = "0.6.19"
@@ -601,6 +610,15 @@ version = "0.4.27"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "13dc2df351e3202783a1fe0d44375f7295ffb4049267b0f3018346dc122a1d94" checksum = "13dc2df351e3202783a1fe0d44375f7295ffb4049267b0f3018346dc122a1d94"
[[package]]
name = "matchers"
version = "0.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8263075bb86c5a1b1427b5ae862e8889656f126e9f77c484496e8b47cf5c5558"
dependencies = [
"regex-automata 0.1.10",
]
[[package]] [[package]]
name = "matchit" name = "matchit"
version = "0.7.3" version = "0.7.3"
@@ -847,6 +865,50 @@ dependencies = [
"bitflags", "bitflags",
] ]
[[package]]
name = "regex"
version = "1.11.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b544ef1b4eac5dc2db33ea63606ae9ffcfac26c1416a2806ae0bf5f56b201191"
dependencies = [
"aho-corasick",
"memchr",
"regex-automata 0.4.9",
"regex-syntax 0.8.5",
]
[[package]]
name = "regex-automata"
version = "0.1.10"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6c230d73fb8d8c1b9c0b3135c5142a8acee3a0558fb8db5cf1cb65f8d7862132"
dependencies = [
"regex-syntax 0.6.29",
]
[[package]]
name = "regex-automata"
version = "0.4.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "809e8dc61f6de73b46c85f4c96486310fe304c434cfa43669d7b40f711150908"
dependencies = [
"aho-corasick",
"memchr",
"regex-syntax 0.8.5",
]
[[package]]
name = "regex-syntax"
version = "0.6.29"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f162c6dd7b008981e4d40210aca20b4bd0f9b60ca9271061b07f78537722f2e1"
[[package]]
name = "regex-syntax"
version = "0.8.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2b15c43186be67a4fd63bee50d0303afffcef381492ebe2c5d87f324e1b8815c"
[[package]] [[package]]
name = "ring" name = "ring"
version = "0.17.14" version = "0.17.14"
@@ -1275,10 +1337,14 @@ version = "0.3.19"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e8189decb5ac0fa7bc8b96b7cb9b2701d60d48805aca84a238004d665fcc4008" checksum = "e8189decb5ac0fa7bc8b96b7cb9b2701d60d48805aca84a238004d665fcc4008"
dependencies = [ dependencies = [
"matchers",
"nu-ansi-term", "nu-ansi-term",
"once_cell",
"regex",
"sharded-slab", "sharded-slab",
"smallvec", "smallvec",
"thread_local", "thread_local",
"tracing",
"tracing-core", "tracing-core",
"tracing-log", "tracing-log",
] ]
@@ -1326,7 +1392,7 @@ checksum = "ba73ea9cf16a25df0c8caa16c51acb937d5712a8429db78a3ee29d5dcacd3a65"
[[package]] [[package]]
name = "voidpin" name = "voidpin"
version = "0.0.1" version = "0.0.3"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"async-trait", "async-trait",

View File

@@ -3,7 +3,7 @@ members = ["crates/*"]
resolver = "2" resolver = "2"
[workspace.package] [workspace.package]
version = "0.0.2" version = "0.0.4"
[workspace.dependencies] [workspace.dependencies]
voidpin = { path = "crates/voidpin" } voidpin = { path = "crates/voidpin" }

View File

@@ -1,6 +1,11 @@
[package] [package]
name = "voidpin" name = "voidpin"
edition = "2024" edition = "2024"
readme = "../../README.md"
license = "MIT"
authors = ["kjuulh <contact@kasperhermansen.com>"]
repository = "https://git.kjuulh.io/kjuulh/voidpin.git"
description = "Voidpin allows sending copy/paste commands across the wire. It is specifically intended for use in ssh tunnels for long running sessions, where you want to share a clipboard. The primary use case is when a remote machine is used for development, but clipboard continues to be an ergonomic hurdle."
version.workspace = true version.workspace = true
@@ -8,7 +13,7 @@ version.workspace = true
anyhow.workspace = true anyhow.workspace = true
tokio.workspace = true tokio.workspace = true
tracing.workspace = true tracing.workspace = true
tracing-subscriber.workspace = true tracing-subscriber = { workspace = true, features = ["env-filter"] }
clap.workspace = true clap.workspace = true
dotenv.workspace = true dotenv.workspace = true

View File

@@ -2,12 +2,20 @@ syntax = "proto3";
package voidpin.v1; package voidpin.v1;
service VoidPin {
rpc Copy(CopyRequest) returns (CopyResponse);
}
message CopyRequest { message CopyRequest {
bytes content = 1; string content = 1;
} }
message CopyResponse {} message CopyResponse {}
message PasteRequest {
}
message PasteResponse {
string content = 1;
}
service VoidPin {
rpc Copy(CopyRequest) returns (CopyResponse);
rpc Paste(PasteRequest) returns (PasteResponse);
}

View File

@@ -1,7 +1,7 @@
use std::process::Stdio; use std::process::Stdio;
use anyhow::Context; use anyhow::Context;
use tokio::io::AsyncWriteExt; use tokio::io::{AsyncReadExt, AsyncWriteExt};
use crate::state::State; use crate::state::State;
@@ -30,10 +30,6 @@ impl LocalCopier {
#[cfg(target_os = "windows")] #[cfg(target_os = "windows")]
let mut copy_process = { let mut copy_process = {
todo!("windows not supported yet"); todo!("windows not supported yet");
tokio::process::Command::new("wl-copy")
.stdin(Stdio::piped())
.spawn()?
}; };
if let Some(mut stdin_handle) = copy_process.stdin.take() { if let Some(mut stdin_handle) = copy_process.stdin.take() {
@@ -52,6 +48,41 @@ impl LocalCopier {
Ok(()) Ok(())
} }
pub async fn paste(&self) -> anyhow::Result<Vec<u8>> {
// FIXME: hardcode for macos
#[cfg(target_os = "macos")]
let paste_process = {
tokio::process::Command::new("pbpaste")
.stdout(Stdio::piped())
.stderr(Stdio::piped())
.spawn()?
};
#[cfg(target_os = "linux")]
let mut paste_process = {
tokio::process::Command::new("wl-paste")
.stdout(Stdio::piped())
.stderr(Stdio::piped())
.spawn()?
};
#[cfg(target_os = "windows")]
let mut paste_process = {
todo!("windows not supported yet");
};
let output = paste_process.wait_with_output().await?;
if !output.status.success() {
anyhow::bail!(
"output failed with: {}, {}, exit_code: {}",
std::str::from_utf8(&output.stdout).unwrap_or_default(),
std::str::from_utf8(&output.stderr).unwrap_or_default(),
output.status.code().unwrap_or_default(),
)
}
Ok(output.stdout)
}
} }
pub trait LocalCopierState { pub trait LocalCopierState {

View File

@@ -3,12 +3,22 @@
#[allow(clippy::derive_partial_eq_without_eq)] #[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)] #[derive(Clone, PartialEq, ::prost::Message)]
pub struct CopyRequest { pub struct CopyRequest {
#[prost(bytes="vec", tag="1")] #[prost(string, tag="1")]
pub content: ::prost::alloc::vec::Vec<u8>, pub content: ::prost::alloc::string::String,
} }
#[allow(clippy::derive_partial_eq_without_eq)] #[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, Copy, PartialEq, ::prost::Message)] #[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct CopyResponse { pub struct CopyResponse {
} }
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct PasteRequest {
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PasteResponse {
#[prost(string, tag="1")]
pub content: ::prost::alloc::string::String,
}
include!("voidpin.v1.tonic.rs"); include!("voidpin.v1.tonic.rs");
// @@protoc_insertion_point(module) // @@protoc_insertion_point(module)

View File

@@ -105,6 +105,26 @@ pub mod void_pin_client {
req.extensions_mut().insert(GrpcMethod::new("voidpin.v1.VoidPin", "Copy")); req.extensions_mut().insert(GrpcMethod::new("voidpin.v1.VoidPin", "Copy"));
self.inner.unary(req, path, codec).await self.inner.unary(req, path, codec).await
} }
///
pub async fn paste(
&mut self,
request: impl tonic::IntoRequest<super::PasteRequest>,
) -> std::result::Result<tonic::Response<super::PasteResponse>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static("/voidpin.v1.VoidPin/Paste");
let mut req = request.into_request();
req.extensions_mut().insert(GrpcMethod::new("voidpin.v1.VoidPin", "Paste"));
self.inner.unary(req, path, codec).await
}
} }
} }
/// Generated server implementations. /// Generated server implementations.
@@ -119,6 +139,11 @@ pub mod void_pin_server {
&self, &self,
request: tonic::Request<super::CopyRequest>, request: tonic::Request<super::CopyRequest>,
) -> std::result::Result<tonic::Response<super::CopyResponse>, tonic::Status>; ) -> std::result::Result<tonic::Response<super::CopyResponse>, tonic::Status>;
///
async fn paste(
&self,
request: tonic::Request<super::PasteRequest>,
) -> std::result::Result<tonic::Response<super::PasteResponse>, tonic::Status>;
} }
/// ///
#[derive(Debug)] #[derive(Debug)]
@@ -244,6 +269,50 @@ pub mod void_pin_server {
}; };
Box::pin(fut) Box::pin(fut)
} }
"/voidpin.v1.VoidPin/Paste" => {
#[allow(non_camel_case_types)]
struct PasteSvc<T: VoidPin>(pub Arc<T>);
impl<T: VoidPin> tonic::server::UnaryService<super::PasteRequest>
for PasteSvc<T> {
type Response = super::PasteResponse;
type Future = BoxFuture<
tonic::Response<Self::Response>,
tonic::Status,
>;
fn call(
&mut self,
request: tonic::Request<super::PasteRequest>,
) -> Self::Future {
let inner = Arc::clone(&self.0);
let fut = async move {
<T as VoidPin>::paste(&inner, request).await
};
Box::pin(fut)
}
}
let accept_compression_encodings = self.accept_compression_encodings;
let send_compression_encodings = self.send_compression_encodings;
let max_decoding_message_size = self.max_decoding_message_size;
let max_encoding_message_size = self.max_encoding_message_size;
let inner = self.inner.clone();
let fut = async move {
let inner = inner.0;
let method = PasteSvc(inner);
let codec = tonic::codec::ProstCodec::default();
let mut grpc = tonic::server::Grpc::new(codec)
.apply_compression_config(
accept_compression_encodings,
send_compression_encodings,
)
.apply_max_message_size_config(
max_decoding_message_size,
max_encoding_message_size,
);
let res = grpc.unary(method, req).await;
Ok(res)
};
Box::pin(fut)
}
_ => { _ => {
Box::pin(async move { Box::pin(async move {
Ok( Ok(

View File

@@ -1,4 +1,8 @@
use crate::{copy::LocalCopierState, state::State}; use crate::{
copy::LocalCopierState,
grpc::{PasteRequest, PasteResponse},
state::State,
};
#[derive(Clone)] #[derive(Clone)]
pub struct GrpcServer { pub struct GrpcServer {
@@ -21,10 +25,26 @@ impl crate::grpc::void_pin_server::VoidPin for GrpcServer {
self.state self.state
.local_copier() .local_copier()
.copy(&req.content) .copy(&req.content.as_bytes())
.await .await
.map_err(|e| tonic::Status::internal(e.to_string()))?; .map_err(|e| tonic::Status::internal(e.to_string()))?;
Ok(tonic::Response::new(crate::grpc::CopyResponse {})) Ok(tonic::Response::new(crate::grpc::CopyResponse {}))
} }
async fn paste(
&self,
_request: tonic::Request<PasteRequest>,
) -> std::result::Result<tonic::Response<PasteResponse>, tonic::Status> {
let output = self
.state
.local_copier()
.paste()
.await
.map_err(|e| tonic::Status::internal(e.to_string()))?;
Ok(tonic::Response::new(crate::grpc::PasteResponse {
content: String::from_utf8_lossy(&output).to_string(),
}))
}
} }

View File

@@ -7,7 +7,9 @@ use grpc::void_pin_server::VoidPinServer;
use grpc_server::GrpcServer; use grpc_server::GrpcServer;
use remote_copy::RemoteCopierState; use remote_copy::RemoteCopierState;
use state::State; use state::State;
use tokio::io::AsyncWriteExt;
use tonic::transport; use tonic::transport;
use tracing_subscriber::EnvFilter;
mod grpc { mod grpc {
include!("gen/voidpin.v1.rs"); include!("gen/voidpin.v1.rs");
@@ -33,6 +35,7 @@ enum Commands {
grpc: SocketAddr, grpc: SocketAddr,
}, },
Copy {}, Copy {},
Paste {},
Remote { Remote {
#[command(subcommand)] #[command(subcommand)]
command: RemoteCommands, command: RemoteCommands,
@@ -49,12 +52,27 @@ enum RemoteCommands {
)] )]
remote_host: String, remote_host: String,
}, },
Paste {
#[arg(
long = "remote-host",
env = "VOIDPIN_REMOTE",
default_value = "http://0.0.0.0:7900"
)]
remote_host: String,
},
} }
#[tokio::main] #[tokio::main]
async fn main() -> anyhow::Result<()> { async fn main() -> anyhow::Result<()> {
dotenv::dotenv().ok(); dotenv::dotenv().ok();
tracing_subscriber::fmt::init(); tracing_subscriber::fmt()
.with_env_filter(
EnvFilter::builder()
//.with_default_directive("error".parse().unwrap())
.from_env_lossy(),
)
.with_writer(std::io::stderr)
.init();
let cli = Command::parse(); let cli = Command::parse();
tracing::debug!("Starting cli"); tracing::debug!("Starting cli");
@@ -82,10 +100,7 @@ async fn main() -> anyhow::Result<()> {
} }
tracing::debug!(content = &input, "found content"); tracing::debug!(content = &input, "found content");
state state.remote_copier(&remote_host).copy(input).await?;
.remote_copier(&remote_host)
.copy(input.as_bytes())
.await?;
return Ok(()); return Ok(());
} }
@@ -103,6 +118,22 @@ async fn main() -> anyhow::Result<()> {
tracing::debug!(content = &input, "found content"); tracing::debug!(content = &input, "found content");
state.local_copier().copy(input.as_bytes()).await?; state.local_copier().copy(input.as_bytes()).await?;
} }
Commands::Paste {} => {
let mut stdout = tokio::io::stdout();
if let Ok(remote_host) = std::env::var("VOIDPIN_REMOTE") {
let output = state.remote_copier(&remote_host).paste().await?;
stdout.write_all(output.as_bytes()).await?;
stdout.flush().await?;
return Ok(());
}
let output = state.local_copier().paste().await?;
stdout.write_all(&output).await?;
stdout.flush().await?;
}
Commands::Remote { command } => match command { Commands::Remote { command } => match command {
RemoteCommands::Copy { remote_host } => { RemoteCommands::Copy { remote_host } => {
let mut input = String::new(); let mut input = String::new();
@@ -116,10 +147,14 @@ async fn main() -> anyhow::Result<()> {
} }
tracing::debug!(content = &input, "found content"); tracing::debug!(content = &input, "found content");
state state.remote_copier(&remote_host).copy(input).await?;
.remote_copier(&remote_host) }
.copy(input.as_bytes()) RemoteCommands::Paste { remote_host } => {
.await?; let output = state.remote_copier(&remote_host).paste().await?;
let mut stdout = tokio::io::stdout();
stdout.write_all(output.as_bytes()).await?;
stdout.flush().await?;
} }
}, },
} }

View File

@@ -1,6 +1,9 @@
use tonic::transport::{Channel, ClientTlsConfig}; use tonic::transport::{Channel, ClientTlsConfig};
use crate::{grpc::CopyRequest, state::State}; use crate::{
grpc::{CopyRequest, PasteRequest},
state::State,
};
#[derive(Default)] #[derive(Default)]
pub struct RemoteCopier { pub struct RemoteCopier {
@@ -14,7 +17,7 @@ impl RemoteCopier {
} }
} }
pub async fn copy(&self, input: &[u8]) -> anyhow::Result<()> { pub async fn copy(&self, input: String) -> anyhow::Result<()> {
let tls = ClientTlsConfig::new(); let tls = ClientTlsConfig::new();
let channel = Channel::from_shared(self.host.clone())? let channel = Channel::from_shared(self.host.clone())?
.tls_config(if self.host.starts_with("https") { .tls_config(if self.host.starts_with("https") {
@@ -37,6 +40,29 @@ impl RemoteCopier {
Ok(()) Ok(())
} }
pub async fn paste(&self) -> anyhow::Result<String> {
let tls = ClientTlsConfig::new();
let channel = Channel::from_shared(self.host.clone())?
.tls_config(if self.host.starts_with("https") {
tls.with_native_roots()
} else {
tls
})?
.connect()
.await?;
tracing::debug!("establishing connection to remote");
let mut client = crate::grpc::void_pin_client::VoidPinClient::new(channel);
tracing::info!("sending paste request");
let resp = client.paste(PasteRequest {}).await?;
let output = resp.into_inner().content;
tracing::info!(content = output, "received paste response");
Ok(output)
}
} }
pub trait RemoteCopierState { pub trait RemoteCopierState {

View File

@@ -5,6 +5,8 @@ base: "git@git.front.kjuulh.io:kjuulh/cuddle-rust-cli-plan.git"
vars: vars:
service: "voidpin" service: "voidpin"
registry: kasperhermansen registry: kasperhermansen
rust:
publish: {}
please: please:
project: project:
@@ -12,6 +14,6 @@ please:
repository: "voidpin" repository: "voidpin"
branch: "main" branch: "main"
settings: settings:
api_url: "https://git.front.kjuulh.io" api_url: "https://git.kjuulh.io"
actions: actions:
rust: rust: