src/ptytty.C

   1 /*--------------------------------*-C-*---------------------------------*
   2  * File:        ptytty.C
   3  *----------------------------------------------------------------------*
   4  *
   5  * All portions of code are copyright by their respective author/s.
   6  * Copyright (c) 1999-2001 Geoff Wing <gcw@pobox.com>
   7  * Copyright (c) 2004      Marc Lehmann <pcg@goof.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22  *---------------------------------------------------------------------*/
  23
  24 #include "../config.h"          /* NECESSARY */
  25 #include "rxvt.h"
  26
  27 #ifdef HAVE_STDLIB_H
  28 # include <cstdlib>
  29 #endif
  30 #ifdef HAVE_SYS_TYPES_H
  31 # include <sys/types.h>
  32 #endif
  33 #ifdef HAVE_UNISTD_H
  34 # include <unistd.h>
  35 #endif
  36 #if defined(HAVE_STRING_H)
  37 # include <cstring>
  38 #endif
  39 #ifdef HAVE_FCNTL_H
  40 # include <fcntl.h>
  41 #endif
  42 #ifdef HAVE_SYS_IOCTL_H
  43 # include <sys/ioctl.h>
  44 #endif
  45 #if defined(PTYS_ARE_PTMX) && defined(HAVE_SYS_STROPTS_H)
  46 # include <sys/stropts.h>      /* for I_PUSH */
  47 #endif
  48 #ifdef HAVE_ISASTREAM
  49 # include <stropts.h>
  50 #endif
  51
  52 // better do this via configure, but....
  53 #if defined(__FreeBSD__)
  54 # include <libutil.h>
  55 #elif defined(__DARWIN__)
  56 # include <util.h>
  57 #endif
  58
  59 #include <cstdio>
  60 #include <grp.h>
  61
  62 /* ------------------------------------------------------------------------- *
  63  *                  GET PSEUDO TELETYPE - MASTER AND SLAVE                   *
  64  * ------------------------------------------------------------------------- */
  65 /*
  66  * Returns pty file descriptor, or -1 on failure
  67  * If successful, ttydev is set to the name of the slave device.
  68  * fd_tty _may_ also be set to an open fd to the slave device
  69  */
  70 static int
  71 get_pty (int *fd_tty, char **ttydev)
  72 {
  73   int pfd;
  74
  75 #ifdef PTYS_ARE_OPENPTY
  76   char tty_name[sizeof "/dev/pts/????\0"];
  77
  78   if (openpty (&pfd, fd_tty, tty_name, NULL, NULL) != -1)
  79     {
  80       *ttydev = strdup (tty_name);
  81       return pfd;
  82     }
  83 #endif
  84
  85 #ifdef PTYS_ARE__GETPTY
  86   *ttydev = _getpty (&pfd, O_RDWR | O_NONBLOCK | O_NOCTTY, 0622, 0);
  87   if (*ttydev != NULL)
  88     return pfd;
  89 #endif
  90
  91 #ifdef PTYS_ARE_GETPTY
  92
  93   char           *ptydev;
  94
  95   while ((ptydev = getpty ()) != NULL)
  96     if ((pfd = open (ptydev, O_RDWR | O_NOCTTY, 0)) >= 0)
  97       {
  98         *ttydev = ptydev;
  99         return pfd;
 100       }
 101 #endif
 102
 103 #if defined(HAVE_GRANTPT) && defined(HAVE_UNLOCKPT)
 104 # if defined(PTYS_ARE_GETPT) || defined(PTYS_ARE_PTMX)
 105
 106   {
 107 #  ifdef PTYS_ARE_GETPT
 108     pfd = getpt ();
 109 #  else
 110     pfd = open ("/dev/ptmx", O_RDWR | O_NOCTTY, 0);
 111 #  endif
 112
 113     if (pfd >= 0)
 114       {
 115         if (grantpt (pfd) == 0  /* change slave permissions */
 116             && unlockpt (pfd) == 0)
 117           {     /* slave now unlocked */
 118             *ttydev = strdup (ptsname (pfd));   /* get slave's name */
 119             return pfd;
 120           }
 121         close (pfd);
 122       }
 123   }
 124 # endif
 125 #endif
 126
 127 #ifdef PTYS_ARE_PTC
 128   if ((pfd = open ("/dev/ptc", O_RDWR | O_NOCTTY, 0)) >= 0)
 129     {
 130       *ttydev = strdup (ttyname (pfd));
 131       return pfd;
 132     }
 133 #endif
 134
 135 #ifdef PTYS_ARE_CLONE
 136   if ((pfd = open ("/dev/ptym/clone", O_RDWR | O_NOCTTY, 0)) >= 0)
 137     {
 138       *ttydev = strdup (ptsname (pfd));
 139       return pfd;
 140     }
 141 #endif
 142
 143 #ifdef PTYS_ARE_NUMERIC
 144   {
 145     int idx;
 146     char *c1, *c2;
 147     char pty_name[] = "/dev/ptyp???";
 148     char tty_name[] = "/dev/ttyp???";
 149
 150     c1 = &(pty_name[sizeof (pty_name) - 4]);
 151     c2 = &(tty_name[sizeof (tty_name) - 4]);
 152     for (idx = 0; idx < 256; idx++)
 153       {
 154         sprintf (c1, "%d", idx);
 155         sprintf (c2, "%d", idx);
 156         if (access (tty_name, F_OK) < 0)
 157           {
 158             idx = 256;
 159             break;
 160           }
 161
 162         if ((pfd = open (pty_name, O_RDWR | O_NOCTTY, 0)) >= 0)
 163           {
 164             if (access (tty_name, R_OK | W_OK) == 0)
 165               {
 166                 *ttydev = strdup (tty_name);
 167                 return pfd;
 168               }
 169
 170             close (pfd);
 171           }
 172       }
 173   }
 174 #endif
 175
 176 #ifdef PTYS_ARE_SEARCHED
 177   {
 178     const char *c1, *c2;
 179     char pty_name[] = "/dev/pty??";
 180     char tty_name[] = "/dev/tty??";
 181
 182 # ifndef PTYCHAR1
 183 #  define PTYCHAR1      "pqrstuvwxyz"
 184 # endif
 185 # ifndef PTYCHAR2
 186 #  define PTYCHAR2      "0123456789abcdef"
 187 # endif
 188
 189     for (c1 = PTYCHAR1; *c1; c1++)
 190       {
 191         pty_name[ (sizeof (pty_name) - 3)] =
 192           tty_name[ (sizeof (pty_name) - 3)] = *c1;
 193         for (c2 = PTYCHAR2; *c2; c2++)
 194           {
 195             pty_name[ (sizeof (pty_name) - 2)] =
 196               tty_name[ (sizeof (pty_name) - 2)] = *c2;
 197             if ((pfd = open (pty_name, O_RDWR | O_NOCTTY, 0)) >= 0)
 198               {
 199                 if (access (tty_name, R_OK | W_OK) == 0)
 200                   {
 201                     *ttydev = strdup (tty_name);
 202                     return pfd;
 203                   }
 204
 205                 close (pfd);
 206               }
 207           }
 208       }
 209   }
 210 #endif
 211
 212   return -1;
 213 }
 214
 215 /*----------------------------------------------------------------------*/
 216 /*
 217  * Returns tty file descriptor, or -1 on failure
 218  */
 219 static int
 220 get_tty (char *ttydev)
 221 {
 222   return open (ttydev, O_RDWR | O_NOCTTY, 0);
 223 }
 224
 225 /*----------------------------------------------------------------------*/
 226 /*
 227  * Make our tty a controlling tty so that /dev/tty points to us
 228  */
 229 static int
 230 control_tty (int fd_tty, const char *ttydev)
 231 {
 232 #ifndef __QNX__
 233   int fd;
 234
 235   /* ---------------------------------------- */
 236 # ifdef HAVE_SETSID
 237   setsid ();
 238 # endif
 239 # if defined(HAVE_SETPGID)
 240   setpgid (0, 0);
 241 # elif defined(HAVE_SETPGRP)
 242   setpgrp (0, 0);
 243 # endif
 244
 245   /* ---------------------------------------- */
 246 # ifdef TIOCNOTTY
 247   fd = open ("/dev/tty", O_RDWR | O_NOCTTY);
 248   if (fd >= 0)
 249     {
 250       ioctl (fd, TIOCNOTTY, NULL);      /* void tty associations */
 251       close (fd);
 252     }
 253 # endif
 254
 255   /* ---------------------------------------- */
 256   fd = open ("/dev/tty", O_RDWR | O_NOCTTY);
 257   if (fd >= 0)
 258     close (fd);         /* ouch: still have controlling tty */
 259
 260   /* ---------------------------------------- */
 261 #if defined(PTYS_ARE_PTMX) && defined(I_PUSH)
 262   /*
 263    * Push STREAMS modules:
 264    *    ptem: pseudo-terminal hardware emulation module.
 265    *    ldterm: standard terminal line discipline.
 266    *    ttcompat: V7, 4BSD and XENIX STREAMS compatibility module.
 267    *
 268    * After we push the STREAMS modules, the first open () on the slave side
 269    * (i.e. the next section between the dashes giving us "tty opened OK")
 270    * should make the "ptem" (or "ldterm" depending upon either which OS
 271    * version or which set of manual pages you have) module give us a
 272    * controlling terminal.  We must already have close ()d the master side
 273    * fd in this child process before we push STREAMS modules on because the
 274    * documentation is really unclear about whether it is any close () on
 275    * the master side or the last close () - i.e. a proper STREAMS dismantling
 276    * close () - on the master side which causes a hang up to be sent
 277    * through - Geoff Wing
 278    */
 279 # ifdef HAVE_ISASTREAM
 280   if (isastream (fd_tty) == 1)
 281 # endif
 282     {
 283       ioctl (fd_tty, I_PUSH, "ptem");
 284       ioctl (fd_tty, I_PUSH, "ldterm");
 285       ioctl (fd_tty, I_PUSH, "ttcompat");
 286     }
 287 #endif
 288   /* ---------------------------------------- */
 289 # if defined(TIOCSCTTY)
 290   fd = ioctl (fd_tty, TIOCSCTTY, NULL);
 291 # elif defined(TIOCSETCTTY)
 292   fd = ioctl (fd_tty, TIOCSETCTTY, NULL);
 293 # else
 294   fd = open (ttydev, O_RDWR);
 295   if (fd >= 0)
 296     close (fd);
 297 # endif
 298   /* ---------------------------------------- */
 299   fd = open ("/dev/tty", O_WRONLY);
 300   if (fd < 0)
 301     return -1;          /* fatal */
 302   close (fd);
 303   /* ---------------------------------------- */
 304 #endif                          /* ! __QNX__ */
 305
 306   return 0;
 307 }
 308
 309 #ifndef NO_SETOWNER_TTYDEV
 310 static struct ttyconf {
 311   gid_t gid;
 312   mode_t mode;
 313
 314   ttyconf ()
 315     {
 316 #ifdef TTY_GID_SUPPORT
 317       struct group *gr = getgrnam ("tty");
 318
 319       if (gr)
 320         {           /* change group ownership of tty to "tty" */
 321           mode = S_IRUSR | S_IWUSR | S_IWGRP;
 322           gid = gr->gr_gid;
 323         }
 324       else
 325 #endif                          /* TTY_GID_SUPPORT */
 326         {
 327           mode = S_IRUSR | S_IWUSR | S_IWGRP | S_IWOTH;
 328           gid = getgid ();
 329         }
 330     }
 331 } ttyconf;
 332
 333 void
 334 rxvt_ptytty::privileges (rxvt_privaction action)
 335 {
 336   rxvt_privileges (RESTORE);
 337
 338   if (action == SAVE)
 339     {
 340       //next_tty_action = RESTORE;
 341 # ifndef RESET_TTY_TO_COMMON_DEFAULTS
 342       /* store original tty status for restoration rxvt_clean_exit () -- rgg 04/12/95 */
 343       if (lstat (name, &savestat) < 0)       /* you lose out */
 344         ;//next_tty_action = IGNORE;
 345       else
 346 # endif
 347
 348         {
 349           chown (name, getuid (), ttyconf.gid);      /* fail silently */
 350           chmod (name, ttyconf.mode);
 351 # ifdef HAVE_REVOKE
 352           revoke (name);
 353 # endif
 354
 355         }
 356     }
 357   else
 358     {                    /* action == RESTORE */
 359       //next_tty_action = IGNORE;
 360 # ifndef RESET_TTY_TO_COMMON_DEFAULTS
 361       chmod (name, savestat.st_mode);
 362       chown (name, savestat.st_uid, savestat.st_gid);
 363 # else
 364       chmod (name, (S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH));
 365       chown (name, 0, 0);
 366 # endif
 367
 368     }
 369
 370   rxvt_privileges (IGNORE);
 371 }
 372 #endif
 373
 374 rxvt_ptytty::rxvt_ptytty ()
 375 {
 376   pty = tty = -1;
 377   name = 0;
 378 }
 379
 380 rxvt_ptytty::~rxvt_ptytty ()
 381 {
 382   put ();
 383 }
 384
 385 void
 386
 387 rxvt_ptytty::close_tty ()
 388 {
 389   if (tty >= 0) close (tty);
 390   tty = -1;
 391 }
 392
 393 void
 394 rxvt_ptytty::put ()
 395 {
 396 #ifndef NO_SETOWNER_TTYDEV
 397   if (tty >= 0)
 398     privileges (RESTORE);
 399 #endif
 400
 401   if (pty >= 0) close (pty);
 402   close_tty ();
 403   free (name);
 404
 405   pty = tty = -1;
 406   name = 0;
 407 }
 408
 409 bool
 410 rxvt_ptytty::make_controlling_tty ()
 411 {
 412   return control_tty (tty, name) >= 0;
 413 }
 414
 415 bool
 416 rxvt_ptytty::get ()
 417 {
 418   /* get master (pty) */
 419   if ((pty = get_pty (&tty, &name)) < 0)
 420     return false;
 421
 422   fcntl (pty, F_SETFL, O_NONBLOCK);
 423
 424   /* get slave (tty) */
 425   if (tty < 0)
 426     {
 427 #ifndef NO_SETOWNER_TTYDEV
 428       privileges (SAVE);
 429 #endif
 430
 431       if ((tty = get_tty (name)) < 0)
 432         {
 433           put ();
 434           return false;
 435         }
 436     }
 437
 438   return true;
 439 }
 440
 441 /*----------------------- end-of-file (C source) -----------------------*/
 442