sshpty.c

   1 /*
   2  * Author: Tatu Ylonen <ylo@cs.hut.fi>
   3  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   4  *                    All rights reserved
   5  * Allocating a pseudo-terminal, and making it the controlling tty.
   6  *
   7  * As far as I am concerned, the code I have written for this software
   8  * can be used freely for any purpose.  Any derived versions of this
   9  * software must be clearly marked as such, and if the derived work is
  10  * incompatible with the protocol description in the RFC file, it must be
  11  * called by a name other than "ssh" or "Secure Shell".
  12  */
  13
  14 #include "includes.h"
  15 RCSID("$OpenBSD: sshpty.c,v 1.1 2001/03/04 01:46:30 djm Exp $");
  16
  17 #ifdef HAVE_UTIL_H
  18 # include <util.h>
  19 #endif /* HAVE_UTIL_H */
  20
  21 #include "sshpty.h"
  22 #include "log.h"
  23 #include "misc.h"
  24
  25 /* Pty allocated with _getpty gets broken if we do I_PUSH:es to it. */
  26 #if defined(HAVE__GETPTY) || defined(HAVE_OPENPTY)
  27 #undef HAVE_DEV_PTMX
  28 #endif
  29
  30 #ifdef HAVE_PTY_H
  31 # include <pty.h>
  32 #endif
  33 #if defined(HAVE_DEV_PTMX) && defined(HAVE_SYS_STROPTS_H)
  34 # include <sys/stropts.h>
  35 #endif
  36
  37 #ifndef O_NOCTTY
  38 #define O_NOCTTY 0
  39 #endif
  40
  41 /*
  42  * Allocates and opens a pty.  Returns 0 if no pty could be allocated, or
  43  * nonzero if a pty was successfully allocated.  On success, open file
  44  * descriptors for the pty and tty sides and the name of the tty side are
  45  * returned (the buffer must be able to hold at least 64 characters).
  46  */
  47
  48 int
  49 pty_allocate(int *ptyfd, int *ttyfd, char *namebuf, int namebuflen)
  50 {
  51 #if defined(HAVE_OPENPTY) || defined(BSD4_4)
  52         /* openpty(3) exists in OSF/1 and some other os'es */
  53         char *name;
  54         int i;
  55
  56         i = openpty(ptyfd, ttyfd, NULL, NULL, NULL);
  57         if (i < 0) {
  58                 error("openpty: %.100s", strerror(errno));
  59                 return 0;
  60         }
  61         name = ttyname(*ttyfd);
  62         if (!name)
  63                 fatal("openpty returns device for which ttyname fails.");
  64
  65         strlcpy(namebuf, name, namebuflen);     /* possible truncation */
  66         return 1;
  67 #else /* HAVE_OPENPTY */
  68 #ifdef HAVE__GETPTY
  69         /*
  70          * _getpty(3) exists in SGI Irix 4.x, 5.x & 6.x -- it generates more
  71          * pty's automagically when needed
  72          */
  73         char *slave;
  74
  75         slave = _getpty(ptyfd, O_RDWR, 0622, 0);
  76         if (slave == NULL) {
  77                 error("_getpty: %.100s", strerror(errno));
  78                 return 0;
  79         }
  80         strlcpy(namebuf, slave, namebuflen);
  81         /* Open the slave side. */
  82         *ttyfd = open(namebuf, O_RDWR | O_NOCTTY);
  83         if (*ttyfd < 0) {
  84                 error("%.200s: %.100s", namebuf, strerror(errno));
  85                 close(*ptyfd);
  86                 return 0;
  87         }
  88         return 1;
  89 #else /* HAVE__GETPTY */
  90 #if defined(HAVE_DEV_PTMX)
  91         /*
  92          * This code is used e.g. on Solaris 2.x.  (Note that Solaris 2.3
  93          * also has bsd-style ptys, but they simply do not work.)
  94          */
  95         int ptm;
  96         char *pts;
  97         mysig_t old_signal;
  98
  99         ptm = open("/dev/ptmx", O_RDWR | O_NOCTTY);
 100         if (ptm < 0) {
 101                 error("/dev/ptmx: %.100s", strerror(errno));
 102                 return 0;
 103         }
 104         old_signal = mysignal(SIGCHLD, SIG_DFL);
 105         if (grantpt(ptm) < 0) {
 106                 error("grantpt: %.100s", strerror(errno));
 107                 return 0;
 108         }
 109         mysignal(SIGCHLD, old_signal);
 110         if (unlockpt(ptm) < 0) {
 111                 error("unlockpt: %.100s", strerror(errno));
 112                 return 0;
 113         }
 114         pts = ptsname(ptm);
 115         if (pts == NULL)
 116                 error("Slave pty side name could not be obtained.");
 117         strlcpy(namebuf, pts, namebuflen);
 118         *ptyfd = ptm;
 119
 120         /* Open the slave side. */
 121         *ttyfd = open(namebuf, O_RDWR | O_NOCTTY);
 122         if (*ttyfd < 0) {
 123                 error("%.100s: %.100s", namebuf, strerror(errno));
 124                 close(*ptyfd);
 125                 return 0;
 126         }
 127 #ifndef HAVE_CYGWIN
 128         /*
 129          * Push the appropriate streams modules, as described in Solaris pts(7).
 130          * HP-UX pts(7) doesn't have ttcompat module.
 131          */
 132         if (ioctl(*ttyfd, I_PUSH, "ptem") < 0)
 133                 error("ioctl I_PUSH ptem: %.100s", strerror(errno));
 134         if (ioctl(*ttyfd, I_PUSH, "ldterm") < 0)
 135                 error("ioctl I_PUSH ldterm: %.100s", strerror(errno));
 136 #ifndef __hpux
 137         if (ioctl(*ttyfd, I_PUSH, "ttcompat") < 0)
 138                 error("ioctl I_PUSH ttcompat: %.100s", strerror(errno));
 139 #endif
 140 #endif
 141         return 1;
 142 #else /* HAVE_DEV_PTMX */
 143 #ifdef HAVE_DEV_PTS_AND_PTC
 144         /* AIX-style pty code. */
 145         const char *name;
 146
 147         *ptyfd = open("/dev/ptc", O_RDWR | O_NOCTTY);
 148         if (*ptyfd < 0) {
 149                 error("Could not open /dev/ptc: %.100s", strerror(errno));
 150                 return 0;
 151         }
 152         name = ttyname(*ptyfd);
 153         if (!name)
 154                 fatal("Open of /dev/ptc returns device for which ttyname fails.");
 155         strlcpy(namebuf, name, namebuflen);
 156         *ttyfd = open(name, O_RDWR | O_NOCTTY);
 157         if (*ttyfd < 0) {
 158                 error("Could not open pty slave side %.100s: %.100s",
 159                       name, strerror(errno));
 160                 close(*ptyfd);
 161                 return 0;
 162         }
 163         return 1;
 164 #else /* HAVE_DEV_PTS_AND_PTC */
 165         /* BSD-style pty code. */
 166         char buf[64];
 167         int i;
 168         const char *ptymajors = "pqrstuvwxyzabcdefghijklmnoABCDEFGHIJKLMNOPQRSTUVWXYZ";
 169         const char *ptyminors = "0123456789abcdef";
 170         int num_minors = strlen(ptyminors);
 171         int num_ptys = strlen(ptymajors) * num_minors;
 172
 173         for (i = 0; i < num_ptys; i++) {
 174                 snprintf(buf, sizeof buf, "/dev/pty%c%c", ptymajors[i / num_minors],
 175                          ptyminors[i % num_minors]);
 176                 snprintf(namebuf, namebuflen, "/dev/tty%c%c",
 177                     ptymajors[i / num_minors], ptyminors[i % num_minors]);
 178
 179                 *ptyfd = open(buf, O_RDWR | O_NOCTTY);
 180                 if (*ptyfd < 0) {
 181                         /* Try SCO style naming */
 182                         snprintf(buf, sizeof buf, "/dev/ptyp%d", i);
 183                         snprintf(namebuf, namebuflen, "/dev/ttyp%d", i);
 184                         *ptyfd = open(buf, O_RDWR | O_NOCTTY);
 185                         if (*ptyfd < 0)
 186                                 continue;
 187                 }
 188
 189                 /* Open the slave side. */
 190                 *ttyfd = open(namebuf, O_RDWR | O_NOCTTY);
 191                 if (*ttyfd < 0) {
 192                         error("%.100s: %.100s", namebuf, strerror(errno));
 193                         close(*ptyfd);
 194                         return 0;
 195                 }
 196                 return 1;
 197         }
 198         return 0;
 199 #endif /* HAVE_DEV_PTS_AND_PTC */
 200 #endif /* HAVE_DEV_PTMX */
 201 #endif /* HAVE__GETPTY */
 202 #endif /* HAVE_OPENPTY */
 203 }
 204
 205 /* Releases the tty.  Its ownership is returned to root, and permissions to 0666. */
 206
 207 void
 208 pty_release(const char *ttyname)
 209 {
 210         if (chown(ttyname, (uid_t) 0, (gid_t) 0) < 0)
 211                 error("chown %.100s 0 0 failed: %.100s", ttyname, strerror(errno));
 212         if (chmod(ttyname, (mode_t) 0666) < 0)
 213                 error("chmod %.100s 0666 failed: %.100s", ttyname, strerror(errno));
 214 }
 215
 216 /* Makes the tty the processes controlling tty and sets it to sane modes. */
 217
 218 void
 219 pty_make_controlling_tty(int *ttyfd, const char *ttyname)
 220 {
 221         int fd;
 222 #ifdef USE_VHANGUP
 223         void *old;
 224 #endif /* USE_VHANGUP */
 225
 226         /* First disconnect from the old controlling tty. */
 227 #ifdef TIOCNOTTY
 228         fd = open(_PATH_TTY, O_RDWR | O_NOCTTY);
 229         if (fd >= 0) {
 230                 (void) ioctl(fd, TIOCNOTTY, NULL);
 231                 close(fd);
 232         }
 233 #endif /* TIOCNOTTY */
 234         if (setsid() < 0)
 235                 error("setsid: %.100s", strerror(errno));
 236
 237         /*
 238          * Verify that we are successfully disconnected from the controlling
 239          * tty.
 240          */
 241         fd = open(_PATH_TTY, O_RDWR | O_NOCTTY);
 242         if (fd >= 0) {
 243                 error("Failed to disconnect from controlling tty.");
 244                 close(fd);
 245         }
 246         /* Make it our controlling tty. */
 247 #ifdef TIOCSCTTY
 248         debug("Setting controlling tty using TIOCSCTTY.");
 249         if (ioctl(*ttyfd, TIOCSCTTY, NULL) < 0)
 250                 error("ioctl(TIOCSCTTY): %.100s", strerror(errno));
 251 #endif /* TIOCSCTTY */
 252 #ifdef HAVE_NEWS4
 253         if (setpgrp(0,0) < 0)
 254                 error("SETPGRP %s",strerror(errno));
 255 #endif /* HAVE_NEWS4 */
 256 #ifdef USE_VHANGUP
 257         old = signal(SIGHUP, SIG_IGN);
 258         vhangup();
 259         signal(SIGHUP, old);
 260 #endif /* USE_VHANGUP */
 261         fd = open(ttyname, O_RDWR);
 262         if (fd < 0) {
 263                 error("%.100s: %.100s", ttyname, strerror(errno));
 264         } else {
 265 #ifdef USE_VHANGUP
 266                 close(*ttyfd);
 267                 *ttyfd = fd;
 268 #else /* USE_VHANGUP */
 269                 close(fd);
 270 #endif /* USE_VHANGUP */
 271         }
 272         /* Verify that we now have a controlling tty. */
 273         fd = open(_PATH_TTY, O_WRONLY);
 274         if (fd < 0)
 275                 error("open /dev/tty failed - could not set controlling tty: %.100s",
 276                       strerror(errno));
 277         else {
 278                 close(fd);
 279         }
 280 }
 281
 282 /* Changes the window size associated with the pty. */
 283
 284 void
 285 pty_change_window_size(int ptyfd, int row, int col,
 286                        int xpixel, int ypixel)
 287 {
 288         struct winsize w;
 289         w.ws_row = row;
 290         w.ws_col = col;
 291         w.ws_xpixel = xpixel;
 292         w.ws_ypixel = ypixel;
 293         (void) ioctl(ptyfd, TIOCSWINSZ, &w);
 294 }
 295
 296 void
 297 pty_setowner(struct passwd *pw, const char *ttyname)
 298 {
 299         struct group *grp;
 300         gid_t gid;
 301         mode_t mode;
 302         struct stat st;
 303
 304         /* Determine the group to make the owner of the tty. */
 305         grp = getgrnam("tty");
 306         if (grp) {
 307                 gid = grp->gr_gid;
 308                 mode = S_IRUSR | S_IWUSR | S_IWGRP;
 309         } else {
 310                 gid = pw->pw_gid;
 311                 mode = S_IRUSR | S_IWUSR | S_IWGRP | S_IWOTH;
 312         }
 313
 314         /*
 315          * Change owner and mode of the tty as required.
 316          * Warn but continue if filesystem is read-only and the uids match.
 317          */
 318         if (stat(ttyname, &st))
 319                 fatal("stat(%.100s) failed: %.100s", ttyname,
 320                     strerror(errno));
 321
 322         if (st.st_uid != pw->pw_uid || st.st_gid != gid) {
 323                 if (chown(ttyname, pw->pw_uid, gid) < 0) {
 324                         if (errno == EROFS && st.st_uid == pw->pw_uid)
 325                                 error("chown(%.100s, %d, %d) failed: %.100s",
 326                                       ttyname, pw->pw_uid, gid,
 327                                       strerror(errno));
 328                         else
 329                                 fatal("chown(%.100s, %d, %d) failed: %.100s",
 330                                       ttyname, pw->pw_uid, gid,
 331                                       strerror(errno));
 332                 }
 333         }
 334
 335         if ((st.st_mode & (S_IRWXU|S_IRWXG|S_IRWXO)) != mode) {
 336                 if (chmod(ttyname, mode) < 0) {
 337                         if (errno == EROFS &&
 338                             (st.st_mode & (S_IRGRP | S_IROTH)) == 0)
 339                                 error("chmod(%.100s, 0%o) failed: %.100s",
 340                                       ttyname, mode, strerror(errno));
 341                         else
 342                                 fatal("chmod(%.100s, 0%o) failed: %.100s",
 343                                       ttyname, mode, strerror(errno));
 344                 }
 345         }
 346 }