proxmox/pve-xtermjs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-xtermjs.git synced 2026-01-27 06:40:37 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
168 commits 1 branch 0 tags 3 MiB
Find a file
Exact
Yuki Sireneva 41051f5a5e Avoid allocating in pre_exec closure 
`Error::new` allocates memory (see [148971]). This is bad in
multi-threaded programs, which pve-xtermjs AFAIK is. If the fork occurs
while the allocator lock is held by another thread, deadlocks can occur,
since there's no one left in the new process to unlock the mutex.
I do not believe this is UB, and modern libc offer protections against
this issue, but this isn't POSIX-compliant and should preferably be
avoided.

`nix` provides a non-allocating `impl From<Errno> for std::io::Error`,
which can be used instead. This ensures that the correct error code is
forwarded to the parent process, instead of the default `-EINVAL`.

[rust#148971]: https://github.com/rust-lang/rust/pull/148971

Signed-off-by: Yuki Sireneva <yuki.utk8g@gmail.com>
Link: https://lore.proxmox.com/20251205124802.334198-1-yuki.utk8g@gmail.com
2025-12-09 17:23:27 +01:00
.cargo move .cargo/config to .cargo/config.toml 2024-06-20 12:38:14 +02:00
termproxy Avoid allocating in pre_exec closure 2025-12-09 17:23:27 +01:00
xterm.js xtermjs: bump version to 5.5.0-3 2025-11-14 10:39:12 +01:00
.gitignore split upstream and our native into different source packages 2023-10-17 10:49:54 +02:00
README readme: update and reword slightly 2023-10-04 15:40:01 +02:00

README 

xterm.js webclient and helper utility
=====================================

This repository contains the client and helper utility to use xterm.js [0] in
the web UI of Proxmox projects like Proxmox VE, Proxmox Mail Gateway or Proxmox
Backup Server.

[0]: https://xtermjs.org

To be able to relay between the frontend and a shell program/console running in
the backend, we provide a tool called termproxy to open a port (where our
websocketproxy connects to) and to open a PTY and execute a program.

For communication originating from the client towards the server, it implements
a simple packet-based protocol where everything is a string. The protocol
consists of the following messages:

* Normal Message
    0:LENGTH:MSG
    where LENGTH is the bytelength of the msg

* Resize Message
    1:COLS:ROWS:
	where COLS is the number of columns the client wants to resize to, and ROWS
	the number of rows, respectively

* Ping Message
    2
    used to keep the connection between client and server alive
    (we have a timeout of 5 minutes)

Every other input from the client will be ignored.

Communication from server to the client uses no protocol, the raw data coming
from the terminal/program will be forwarded 1:1, without any wrapping format.