node-pty 1.2.0-beta.1 → 1.2.0-beta.11

package/src/unix/pty.cc

@@ -37,6 +37,8 @@
 /* http://www.gnu.org/software/gnulib/manual/html_node/forkpty.html */
 #if defined(__linux__)
 #include <pty.h>
+#include <dirent.h>
+#include <sys/syscall.h>
 #elif defined(__APPLE__)
 #include <util.h>
 #elif defined(__FreeBSD__)
@@ -110,6 +112,40 @@ struct ExitEvent {
   int exit_code = 0, signal_code = 0;
 };
 
+#if defined(__linux__)
+
+static int
+SetCloseOnExec(int fd) {
+  int flags = fcntl(fd, F_GETFD, 0);
+  if (flags == -1)
+    return flags;
+  if (flags & FD_CLOEXEC)
+    return 0;
+  return fcntl(fd, F_SETFD, flags | FD_CLOEXEC);
+}
+
+/**
+ * Close all file descriptors >= 3 to prevent FD leakage to child processes.
+ * Uses close_range() syscall on Linux 5.9+, falls back to /proc/self/fd iteration.
+ */
+static void
+pty_close_inherited_fds() {
+  // Try close_range() first (Linux 5.9+, glibc 2.34+)
+  #if defined(SYS_close_range) && defined(CLOSE_RANGE_CLOEXEC)
+  if (syscall(SYS_close_range, 3, ~0U, CLOSE_RANGE_CLOEXEC) == 0) {
+    return;
+  }
+  #endif
+
+  int fd;
+  // Set the CLOEXEC flag on all open descriptors. Unconditionally try the first
+  // 16 file descriptors. After that, bail out after the first error.
+  for (fd = 3; ; fd++)
+    if (SetCloseOnExec(fd) && fd > 15)
+      break;
+}
+#endif
+
 void SetupExitCallback(Napi::Env env, Napi::Function cb, pid_t pid) {
   std::thread *th = new std::thread;
   // Don't use Napi::AsyncWorker which is limited by UV_THREADPOOL_SIZE.
@@ -243,7 +279,7 @@ pty_posix_spawn(char** argv, char** env,
                 const struct winsize *winp,
                 int* master,
                 pid_t* pid,
-                int* err);
+                std::string* err);
 #endif
 
 struct DelBuf {
@@ -352,7 +388,7 @@ Napi::Value PtyFork(const Napi::CallbackInfo& info) {
   std::string helper_path = info[9].As<Napi::String>();
 
   pid_t pid;
-  int master;
+  int master = -1;
 #if defined(__APPLE__)
   int argc = argv_.Length();
   int argl = argc + 4;
@@ -367,10 +403,13 @@ Napi::Value PtyFork(const Napi::CallbackInfo& info) {
     argv[i + 3] = strdup(arg.c_str());
   }
 
-  int err = -1;
+  std::string err;
   pty_posix_spawn(argv, env, term, &winp, &master, &pid, &err);
-  if (err != 0) {
-    throw Napi::Error::New(napiEnv, std::string("pty_posix_spawn failed with error: ") + std::to_string(err) + " (" + strerror(err) + ")");
+  if (!err.empty()) {
+    if (master != -1) {
+      close(master);
+    }
+    throw Napi::Error::New(napiEnv, err);
   }
   if (pty_nonblock(master) == -1) {
     throw Napi::Error::New(napiEnv, "Could not set master fd to nonblocking.");
@@ -433,6 +472,9 @@ Napi::Value PtyFork(const Napi::CallbackInfo& info) {
         }
       }
 
+      // Close inherited FDs to prevent leaking pty master FDs to child
+      pty_close_inherited_fds();
+
       {
         char **old = environ;
         environ = env;
@@ -504,11 +546,13 @@ Napi::Value PtyResize(const Napi::CallbackInfo& info) {
   Napi::Env env(info.Env());
   Napi::HandleScope scope(env);
 
-  if (info.Length() != 3 ||
+  if (info.Length() != 5 ||
       !info[0].IsNumber() ||
       !info[1].IsNumber() ||
-      !info[2].IsNumber()) {
-    throw Napi::Error::New(env, "Usage: pty.resize(fd, cols, rows)");
+      !info[2].IsNumber() ||
+      !info[3].IsNumber() ||
+      !info[4].IsNumber()) {
+    throw Napi::Error::New(env, "Usage: pty.resize(fd, cols, rows, xPixel, yPixel)");
   }
 
   int fd = info[0].As<Napi::Number>().Int32Value();
@@ -516,8 +560,8 @@ Napi::Value PtyResize(const Napi::CallbackInfo& info) {
   struct winsize winp;
   winp.ws_col = info[1].As<Napi::Number>().Int32Value();
   winp.ws_row = info[2].As<Napi::Number>().Int32Value();
-  winp.ws_xpixel = 0;
-  winp.ws_ypixel = 0;
+  winp.ws_xpixel = info[3].As<Napi::Number>().Int32Value();
+  winp.ws_ypixel = info[4].As<Napi::Number>().Int32Value();
 
   if (ioctl(fd, TIOCSWINSZ, &winp) == -1) {
     switch (errno) {
@@ -684,15 +728,26 @@ pty_getproc(int fd, char *tty) {
 #endif
 
 #if defined(__APPLE__)
+static std::string format_error(const char* func, int err_code) {
+  char buf[256];
+  snprintf(buf, sizeof(buf), "%s: %s", func, strerror(err_code));
+  return buf;
+}
+
 static void
 pty_posix_spawn(char** argv, char** env,
                 const struct termios *termp,
                 const struct winsize *winp,
                 int* master,
                 pid_t* pid,
-                int* err) {
+                std::string* err) {
   int low_fds[3];
   size_t count = 0;
+  int res = 0;
+  int slave = -1;
+  char slave_pty_name[128];
+  int spawn_err;
+  sigset_t signal_set;
 
   for (; count < 3; count++) {
     low_fds[count] = posix_openpt(O_RDWR);
@@ -704,82 +759,103 @@ pty_posix_spawn(char** argv, char** env,
               POSIX_SPAWN_SETSIGDEF |
               POSIX_SPAWN_SETSIGMASK |
               POSIX_SPAWN_SETSID;
+
+  posix_spawn_file_actions_t acts;
+  posix_spawn_file_actions_init(&acts);
+
+  posix_spawnattr_t attrs;
+  posix_spawnattr_init(&attrs);
+
   *master = posix_openpt(O_RDWR);
   if (*master == -1) {
-    return;
+    *err = format_error("posix_openpt failed", errno);
+    goto done;
   }
 
-  int res = grantpt(*master) || unlockpt(*master);
+  res = grantpt(*master);
   if (res == -1) {
-    return;
+    *err = format_error("grantpt failed", errno);
+    goto done;
+  }
+
+  res = unlockpt(*master);
+  if (res == -1) {
+    *err = format_error("unlockpt failed", errno);
+    goto done;
   }
 
   // Use TIOCPTYGNAME instead of ptsname() to avoid threading problems.
-  int slave;
-  char slave_pty_name[128];
   res = ioctl(*master, TIOCPTYGNAME, slave_pty_name);
   if (res == -1) {
-    return;
+    *err = format_error("ioctl(TIOCPTYGNAME) failed", errno);
+    goto done;
   }
 
   slave = open(slave_pty_name, O_RDWR | O_NOCTTY);
   if (slave == -1) {
-    return;
+    *err = format_error("open slave pty failed", errno);
+    goto done;
   }
 
   if (termp) {
     res = tcsetattr(slave, TCSANOW, termp);
     if (res == -1) {
-      return;
+      *err = format_error("tcsetattr failed", errno);
+      goto done;
     };
   }
 
   if (winp) {
     res = ioctl(slave, TIOCSWINSZ, winp);
     if (res == -1) {
-      return;
+      *err = format_error("ioctl(TIOCSWINSZ) failed", errno);
+      goto done;
     }
   }
 
-  posix_spawn_file_actions_t acts;
-  posix_spawn_file_actions_init(&acts);
   posix_spawn_file_actions_adddup2(&acts, slave, STDIN_FILENO);
   posix_spawn_file_actions_adddup2(&acts, slave, STDOUT_FILENO);
   posix_spawn_file_actions_adddup2(&acts, slave, STDERR_FILENO);
   posix_spawn_file_actions_addclose(&acts, slave);
   posix_spawn_file_actions_addclose(&acts, *master);
 
-  posix_spawnattr_t attrs;
-  posix_spawnattr_init(&attrs);
-  *err = posix_spawnattr_setflags(&attrs, flags);
-  if (*err != 0) {
+  spawn_err = posix_spawnattr_setflags(&attrs, flags);
+  if (spawn_err != 0) {
+    *err = format_error("posix_spawnattr_setflags failed", spawn_err);
     goto done;
   }
 
-  sigset_t signal_set;
   /* Reset all signal the child to their default behavior */
   sigfillset(&signal_set);
-  *err = posix_spawnattr_setsigdefault(&attrs, &signal_set);
-  if (*err != 0) {
+  spawn_err = posix_spawnattr_setsigdefault(&attrs, &signal_set);
+  if (spawn_err != 0) {
+    *err = format_error("posix_spawnattr_setsigdefault failed", spawn_err);
     goto done;
   }
 
   /* Reset the signal mask for all signals */
   sigemptyset(&signal_set);
-  *err = posix_spawnattr_setsigmask(&attrs, &signal_set);
-  if (*err != 0) {
+  spawn_err = posix_spawnattr_setsigmask(&attrs, &signal_set);
+  if (spawn_err != 0) {
+    *err = format_error("posix_spawnattr_setsigmask failed", spawn_err);
     goto done;
   }
 
   do
-    *err = posix_spawn(pid, argv[0], &acts, &attrs, argv, env);
-  while (*err == EINTR);
+    spawn_err = posix_spawn(pid, argv[0], &acts, &attrs, argv, env);
+  while (spawn_err == EINTR);
+  if (spawn_err != 0) {
+    *err = format_error("posix_spawn failed", spawn_err);
+  }
 done:
   posix_spawn_file_actions_destroy(&acts);
   posix_spawnattr_destroy(&attrs);
+  if (slave != -1) {
+    close(slave);
+  }
 
-  for (; count > 0; count--) {
-    close(low_fds[count]);
+  for (size_t i = 0; i <= count; i++) {
+    close(low_fds[i]);
   }
 }
 #endif

package/src/win/conpty.cc

@@ -230,7 +230,6 @@ HRESULT CreateNamedPipesAndPseudoConsole(const Napi::CallbackInfo& info,
     {
       // Failed to find CreatePseudoConsole in kernel32. This is likely because
       //    the user is not running a build of Windows that supports that API.
-      //    We should fall back to winpty in this case.
       return HRESULT_FROM_WIN32(GetLastError());
     }
   } else {
@@ -238,7 +237,7 @@ HRESULT CreateNamedPipesAndPseudoConsole(const Napi::CallbackInfo& info,
   }
 
   // Failed to find  kernel32. This is realy unlikely - honestly no idea how
-  //    this is even possible to hit. But if it does happen, fall back to winpty.
+  //    this is even possible to hit.
   return HRESULT_FROM_WIN32(GetLastError());
 }
 

package/typings/node-pty.d.ts

@@ -86,13 +86,14 @@ declare module 'node-pty' {
   }
 
   export interface IWindowsPtyForkOptions extends IBasePtyForkOptions {
-    /**
-     * Whether to use the ConPTY system on Windows. When this is not set, ConPTY will be used when
-     * the Windows build number is >= 18309 (instead of winpty). Note that ConPTY is available from
-     * build 17134 but is too unstable to enable by default.
-     *
-     * This setting does nothing on non-Windows.
-     */
+  /**
+   * Whether to use the ConPTY system on Windows. When this is not set, ConPTY will be used when
+   * the Windows build number is >= 18309 (instead of winpty). Note that ConPTY is available from
+   * build 17134 but is too unstable to enable by default.
+   *
+   * @deprecated This option is ignored and will be removed in a future version.
+   * https://github.com/microsoft/node-pty/issues/871
+   */
     useConpty?: boolean;
 
     /**
@@ -111,7 +112,7 @@ declare module 'node-pty' {
   }
 
   /**
-   * An interface representing a pseudoterminal, on Windows this is emulated via the winpty library.
+   * An interface representing a pseudoterminal.
    */
   export interface IPty {
     /**
@@ -158,8 +159,11 @@ declare module 'node-pty' {
      * Resizes the dimensions of the pty.
      * @param columns The number of columns to use.
      * @param rows The number of rows to use.
+     * @param pixelSize Optional pixel dimensions of the pty. On Unix, this sets the `ws_xpixel`
+     * and `ws_ypixel` fields of the `winsize` struct. Applications running in the pty can read
+     * these values via the `TIOCGWINSZ` ioctl. This parameter is ignored on Windows.
      */
-    resize(columns: number, rows: number): void;
+    resize(columns: number, rows: number, pixelSize?: { width: number, height: number }): void;
 
     /**
      * Clears the pty's internal representation of its buffer. This is a no-op

package/deps/.editorconfig

@@ -1,2 +0,0 @@
-# Have editor config ignore this directory
-root = true

package/deps/winpty/.drone.yml

@@ -1,17 +0,0 @@
-# Build configure for https://www.tea-ci.org (fork of Drone CI with Msys2 support)
-build:
-  image: teaci/msys$$arch
-  pull: true
-  shell: msys$$arch
-  commands:
-    - pacman -S --needed --noconfirm --noprogressbar mingw-w64-cross-gcc mingw-w64-cross-crt-git
-    - ./configure
-    - make
-    - make tests
-    - build/trivial_test.exe
-    - mintty --log - --exec build/winpty.exe cmd /c ver | grep Windows
-
-matrix:
-  arch:
-    - 64
-    - 32

package/deps/winpty/.gitattributes

@@ -1,19 +0,0 @@
-*               text=auto
-*.bat           text eol=crlf
-*.c             text
-*.cc            text
-*.gyp           text
-*.gypi          text
-*.h             text
-*.ps1           text eol=crlf
-*.rst           text
-*.sh            text
-*.txt           text
-.gitignore      text
-.gitattributes  text
-Makefile        text
-configure       text
-
-*.sh            eol=lf
-configure       eol=lf
-VERSION.txt     eol=lf

package/deps/winpty/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2011-2016 Ryan Prichard
-
-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.

package/deps/winpty/Makefile

@@ -1,166 +0,0 @@
-# Copyright (c) 2011-2015 Ryan Prichard
-#
-# 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.
-
-# Use make -n to see the actual command-lines make would run.
-
-# The default "make install" prefix is /usr/local.  Pass PREFIX=<path> on the
-# command-line to override the default.
-
-.SECONDEXPANSION :
-
-.PHONY : default
-default : all
-
-PREFIX := /usr/local
-UNIX_ADAPTER_EXE := winpty.exe
-MINGW_ENABLE_CXX11_FLAG := -std=c++11
-USE_PCH := 1
-
-COMMON_CXXFLAGS :=
-UNIX_CXXFLAGS :=
-MINGW_CXXFLAGS :=
-MINGW_LDFLAGS :=
-UNIX_LDFLAGS :=
-
-# Include config.mk but complain if it hasn't been created yet.
-ifeq "$(wildcard config.mk)" ""
-    $(error config.mk does not exist.  Please run ./configure)
-endif
-include config.mk
-
-COMMON_CXXFLAGS += \
-	-MMD -Wall \
-	-DUNICODE \
-	-D_UNICODE \
-	-D_WIN32_WINNT=0x0501 \
-	-Ibuild/gen
-
-UNIX_CXXFLAGS += \
-	$(COMMON_CXXFLAGS)
-
-MINGW_CXXFLAGS += \
-	$(COMMON_CXXFLAGS) \
-	-O2 \
-	$(MINGW_ENABLE_CXX11_FLAG)
-
-MINGW_LDFLAGS += -static -static-libgcc -static-libstdc++
-UNIX_LDFLAGS += $(UNIX_LDFLAGS_STATIC)
-
-ifeq "$(USE_PCH)" "1"
-MINGW_CXXFLAGS += -include build/mingw/PrecompiledHeader.h
-PCH_DEP := build/mingw/PrecompiledHeader.h.gch
-else
-PCH_DEP :=
-endif
-
-build/gen/GenVersion.h : VERSION.txt $(COMMIT_HASH_DEP) | $$(@D)/.mkdir
-	$(info Updating build/gen/GenVersion.h)
-	@echo "const char GenVersion_Version[] = \"$(shell cat VERSION.txt | tr -d '\r\n')\";" > build/gen/GenVersion.h
-	@echo "const char GenVersion_Commit[] = \"$(COMMIT_HASH)\";" >> build/gen/GenVersion.h
-
-build/mingw/PrecompiledHeader.h : src/shared/PrecompiledHeader.h | $$(@D)/.mkdir
-	$(info Copying $< to $@)
-	@cp $< $@
-
-build/mingw/PrecompiledHeader.h.gch : build/mingw/PrecompiledHeader.h | $$(@D)/.mkdir
-	$(info Compiling $<)
-	@$(MINGW_CXX) $(MINGW_CXXFLAGS) -c -o $@ $<
-
--include build/mingw/PrecompiledHeader.h.d
-
-define def_unix_target
-build/$1/%.o : src/%.cc | $$$$(@D)/.mkdir
-	$$(info Compiling $$<)
-	@$$(UNIX_CXX) $$(UNIX_CXXFLAGS) $2 -I src/include -c -o $$@ $$<
-endef
-
-define def_mingw_target
-build/$1/%.o : src/%.cc $$(PCH_DEP) | $$$$(@D)/.mkdir
-	$$(info Compiling $$<)
-	@$$(MINGW_CXX) $$(MINGW_CXXFLAGS) $2 -I src/include -c -o $$@ $$<
-endef
-
-include src/subdir.mk
-
-.PHONY : all
-all : $(ALL_TARGETS)
-
-.PHONY : tests
-tests : $(TEST_PROGRAMS)
-
-.PHONY : install-bin
-install-bin : all
-	mkdir -p $(PREFIX)/bin
-	install -m 755 -p -s build/$(UNIX_ADAPTER_EXE) $(PREFIX)/bin
-	install -m 755 -p -s build/winpty.dll $(PREFIX)/bin
-	install -m 755 -p -s build/winpty-agent.exe $(PREFIX)/bin
-
-.PHONY : install-debugserver
-install-debugserver : all
-	mkdir -p $(PREFIX)/bin
-	install -m 755 -p -s build/winpty-debugserver.exe $(PREFIX)/bin
-
-.PHONY : install-lib
-install-lib : all
-	mkdir -p $(PREFIX)/lib
-	install -m 644 -p build/winpty.lib $(PREFIX)/lib
-
-.PHONY : install-doc
-install-doc :
-	mkdir -p $(PREFIX)/share/doc/winpty
-	install -m 644 -p LICENSE $(PREFIX)/share/doc/winpty
-	install -m 644 -p README.md $(PREFIX)/share/doc/winpty
-	install -m 644 -p RELEASES.md $(PREFIX)/share/doc/winpty
-
-.PHONY : install-include
-install-include :
-	mkdir -p $(PREFIX)/include/winpty
-	install -m 644 -p src/include/winpty.h $(PREFIX)/include/winpty
-	install -m 644 -p src/include/winpty_constants.h $(PREFIX)/include/winpty
-
-.PHONY : install
-install : \
-	install-bin \
-	install-debugserver \
-	install-lib \
-	install-doc \
-	install-include
-
-.PHONY : clean
-clean :
-	rm -fr build
-
-.PHONY : clean-msvc
-clean-msvc :
-	rm -fr src/Default src/Release src/.vs src/gen
-	rm -f src/*.vcxproj src/*.vcxproj.filters src/*.sln src/*.sdf
-
-.PHONY : distclean
-distclean : clean
-	rm -f config.mk
-
-.PRECIOUS : %.mkdir
-%.mkdir :
-	$(info Creating directory $(dir $@))
-	@mkdir -p $(dir $@)
-	@touch $@
-
-src/%.h :
-	@echo "Missing header file $@ (stale dependency file?)"