Don't leak fds, and don't unset cloexec except/until needed (#3)

This may still leak fds in some error cases. That can be solved by using
`OwnedFd` when the next Rust stable releases.
This commit is contained in:
Ian Douglas Scott 2022-07-20 08:05:01 -07:00 committed by GitHub
parent b614753cff
commit cefd13692b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 52 additions and 32 deletions

View file

@ -1,13 +1,10 @@
// SPDX-License-Identifier: GPL-3.0-only // SPDX-License-Identifier: GPL-3.0-only
use crate::process::{ProcessEvent, ProcessHandler}; use crate::process::{ProcessEvent, ProcessHandler};
use color_eyre::eyre::{ContextCompat, Result, WrapErr}; use color_eyre::eyre::{Result, WrapErr};
use nix::fcntl; use nix::unistd;
use sendfd::SendWithFd; use sendfd::SendWithFd;
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
use std::{ use std::{collections::HashMap, os::unix::prelude::*};
collections::HashMap,
os::unix::prelude::{AsRawFd, IntoRawFd},
};
use tokio::{ use tokio::{
io::{AsyncReadExt, AsyncWriteExt}, io::{AsyncReadExt, AsyncWriteExt},
net::{ net::{
@ -30,30 +27,14 @@ pub enum Message {
NewPrivilegedClient { count: usize }, NewPrivilegedClient { count: usize },
} }
fn mark_as_not_cloexec(stream: &UnixStream) -> Result<()> {
let raw_fd = stream.as_raw_fd();
let fd_flags = fcntl::FdFlag::from_bits(
fcntl::fcntl(raw_fd, fcntl::FcntlArg::F_GETFD)
.wrap_err("failed to get GETFD value of stream")?,
)
.wrap_err("failed to get fd flags from file")?;
fcntl::fcntl(
raw_fd,
fcntl::FcntlArg::F_SETFD(fd_flags.difference(fcntl::FdFlag::FD_CLOEXEC)),
)
.wrap_err("failed to set CLOEXEC on file")?;
Ok(())
}
pub fn create_privileged_socket( pub fn create_privileged_socket(
sockets: &mut Vec<UnixStream>, sockets: &mut Vec<UnixStream>,
env_vars: &[(String, String)], env_vars: &[(String, String)],
) -> Result<Vec<(String, String)>> { ) -> Result<(Vec<(String, String)>, RawFd)> {
let (comp_socket, client_socket) = let (comp_socket, client_socket) =
UnixStream::pair().wrap_err("failed to create socket pair")?; UnixStream::pair().wrap_err("failed to create socket pair")?;
sockets.push(comp_socket); sockets.push(comp_socket);
let client_fd = { let client_fd = {
mark_as_not_cloexec(&client_socket).wrap_err("failed to mark client stream as CLOEXEC")?;
let std_stream = client_socket let std_stream = client_socket
.into_std() .into_std()
.wrap_err("failed to convert client socket to std socket")?; .wrap_err("failed to convert client socket to std socket")?;
@ -64,7 +45,7 @@ pub fn create_privileged_socket(
}; };
let mut env_vars = env_vars.to_vec(); let mut env_vars = env_vars.to_vec();
env_vars.push(("WAYLAND_SOCKET".into(), client_fd.to_string())); env_vars.push(("WAYLAND_SOCKET".into(), client_fd.to_string()));
Ok(env_vars) Ok((env_vars, client_fd))
} }
async fn receive_event(rx: &mut mpsc::UnboundedReceiver<ProcessEvent>) -> Option<()> { async fn receive_event(rx: &mut mpsc::UnboundedReceiver<ProcessEvent>) -> Option<()> {
@ -159,7 +140,6 @@ async fn send_fd(session_tx: &mut OwnedWriteHalf, stream: Vec<UnixStream>) -> Re
let fds = stream let fds = stream
.into_iter() .into_iter()
.map(|stream| { .map(|stream| {
mark_as_not_cloexec(&stream).wrap_err("failed to mark stream as CLOEXEC")?;
let std_stream = stream let std_stream = stream
.into_std() .into_std()
.wrap_err("failed to convert stream to std stream")?; .wrap_err("failed to convert stream to std stream")?;
@ -183,6 +163,9 @@ async fn send_fd(session_tx: &mut OwnedWriteHalf, stream: Vec<UnixStream>) -> Re
tokio::time::sleep(std::time::Duration::from_micros(100)).await; tokio::time::sleep(std::time::Duration::from_micros(100)).await;
let fd: &UnixStream = session_tx.as_ref(); let fd: &UnixStream = session_tx.as_ref();
fd.send_with_fd(&[0], &fds).wrap_err("failed to send fd")?; fd.send_with_fd(&[0], &fds).wrap_err("failed to send fd")?;
for fd in &fds {
let _ = unistd::close(*fd);
}
info!("sent {} fds", fds.len()); info!("sent {} fds", fds.len());
Ok(()) Ok(())
} }
@ -196,7 +179,6 @@ pub fn run_compositor(
let (session, comp) = UnixStream::pair().wrap_err("failed to create pair of unix sockets")?; let (session, comp) = UnixStream::pair().wrap_err("failed to create pair of unix sockets")?;
let (mut session_rx, mut session_tx) = session.into_split(); let (mut session_rx, mut session_tx) = session.into_split();
let comp = { let comp = {
mark_as_not_cloexec(&comp).wrap_err("failed to mark compositor stream as CLOEXEC")?;
let std_stream = comp let std_stream = comp
.into_std() .into_std()
.wrap_err("failed to convert compositor unix stream to a standard unix stream")?; .wrap_err("failed to convert compositor unix stream to a standard unix stream")?;
@ -213,6 +195,7 @@ pub fn run_compositor(
"cosmic-comp", "cosmic-comp",
vec![], vec![],
vec![("COSMIC_SESSION_SOCK".into(), comp.to_string())], vec![("COSMIC_SESSION_SOCK".into(), comp.to_string())],
vec![comp],
&span, &span,
); );
let mut ipc_state = IpcState { let mut ipc_state = IpcState {

View file

@ -1,5 +1,6 @@
// SPDX-License-Identifier: GPL-3.0-only // SPDX-License-Identifier: GPL-3.0-only
use crate::process::{ProcessEvent, ProcessHandler}; use crate::process::{ProcessEvent, ProcessHandler};
use std::os::unix::io::RawFd;
use tokio::sync::mpsc::unbounded_channel; use tokio::sync::mpsc::unbounded_channel;
use tokio_util::sync::CancellationToken; use tokio_util::sync::CancellationToken;
use tracing::{Instrument, Span}; use tracing::{Instrument, Span};
@ -10,12 +11,13 @@ pub fn run_executable(
executable: &'static str, executable: &'static str,
args: Vec<String>, args: Vec<String>,
env_vars: Vec<(String, String)>, env_vars: Vec<(String, String)>,
fds: Vec<RawFd>,
) { ) {
let span_2 = span.clone(); let span_2 = span.clone();
let (tx, mut rx) = unbounded_channel::<ProcessEvent>(); let (tx, mut rx) = unbounded_channel::<ProcessEvent>();
tokio::spawn( tokio::spawn(
async move { async move {
ProcessHandler::new(tx, &token).run(executable, args, env_vars, &span); ProcessHandler::new(tx, &token).run(executable, args, env_vars, fds, &span);
while let Some(event) = rx.recv().await { while let Some(event) = rx.recv().await {
match event { match event {
ProcessEvent::Started => { ProcessEvent::Started => {

View file

@ -55,21 +55,25 @@ async fn main() -> Result<()> {
let mut sockets = Vec::with_capacity(2); let mut sockets = Vec::with_capacity(2);
let (env, fd) = comp::create_privileged_socket(&mut sockets, &env_vars)
.wrap_err("failed to create panel socket")?;
generic::run_executable( generic::run_executable(
token.child_token(), token.child_token(),
info_span!(parent: None, "cosmic-panel"), info_span!(parent: None, "cosmic-panel"),
"cosmic-panel", "cosmic-panel",
vec!["testing-panel".into()], vec!["testing-panel".into()],
comp::create_privileged_socket(&mut sockets, &env_vars) env,
.wrap_err("failed to create panel socket")?, vec![fd],
); );
let (env, fd) = comp::create_privileged_socket(&mut sockets, &env_vars)
.wrap_err("failed to create dock socket")?;
generic::run_executable( generic::run_executable(
token.child_token(), token.child_token(),
info_span!(parent: None, "cosmic-panel dock"), info_span!(parent: None, "cosmic-panel dock"),
"cosmic-panel", "cosmic-panel",
vec!["testing-dock".into()], vec!["testing-dock".into()],
comp::create_privileged_socket(&mut sockets, &env_vars) env,
.wrap_err("failed to create dock socket")?, vec![fd],
); );
socket_tx.send(sockets).unwrap(); socket_tx.send(sockets).unwrap();

View file

@ -1,5 +1,10 @@
// SPDX-License-Identifier: GPL-3.0-only // SPDX-License-Identifier: GPL-3.0-only
use std::process::{ExitStatus, Stdio}; use color_eyre::eyre::{ContextCompat, Result, WrapErr};
use nix::{fcntl, unistd};
use std::{
os::unix::prelude::*,
process::{ExitStatus, Stdio},
};
use tokio::{ use tokio::{
io::{AsyncBufReadExt, BufReader}, io::{AsyncBufReadExt, BufReader},
process::Command, process::Command,
@ -28,16 +33,24 @@ impl ProcessHandler {
} }
} }
// TODO: Use `OwnedFd` when stable
pub fn run( pub fn run(
self, self,
executable: impl ToString, executable: impl ToString,
args: Vec<String>, args: Vec<String>,
vars: Vec<(String, String)>, vars: Vec<(String, String)>,
fds: Vec<RawFd>,
span: &Span, span: &Span,
) { ) {
let executable = executable.to_string(); let executable = executable.to_string();
tokio::spawn( tokio::spawn(
async move { async move {
for fd in &fds {
if let Err(err) = mark_as_not_cloexec(fd) {
error!("failed to launch '{}': {}", executable, err);
return;
}
}
let mut child = match Command::new(&executable) let mut child = match Command::new(&executable)
.args(&args) .args(&args)
.stdin(Stdio::null()) .stdin(Stdio::null())
@ -58,6 +71,9 @@ impl ProcessHandler {
return; return;
} }
}; };
for fd in &fds {
let _ = unistd::close(*fd);
}
let mut stdout = BufReader::new(child.stdout.take().unwrap()).lines(); let mut stdout = BufReader::new(child.stdout.take().unwrap()).lines();
let mut stderr = BufReader::new(child.stderr.take().unwrap()).lines(); let mut stderr = BufReader::new(child.stderr.take().unwrap()).lines();
std::mem::drop(self.tx.send(ProcessEvent::Started)); std::mem::drop(self.tx.send(ProcessEvent::Started));
@ -116,3 +132,18 @@ impl ProcessHandler {
); );
} }
} }
fn mark_as_not_cloexec(file: &impl AsRawFd) -> Result<()> {
let raw_fd = file.as_raw_fd();
let fd_flags = fcntl::FdFlag::from_bits(
fcntl::fcntl(raw_fd, fcntl::FcntlArg::F_GETFD)
.wrap_err("failed to get GETFD value of stream")?,
)
.wrap_err("failed to get fd flags from file")?;
fcntl::fcntl(
raw_fd,
fcntl::FcntlArg::F_SETFD(fd_flags.difference(fcntl::FdFlag::FD_CLOEXEC)),
)
.wrap_err("failed to set CLOEXEC on file")?;
Ok(())
}