blob: fe2fb5aa2f2839d66a49875fd08448be144e7e5c [file] [log] [blame]
dtucker@openbsd.orgb0899ee2016-11-29 03:54:50 +00001/* $OpenBSD: sshpty.c,v 1.31 2016/11/29 03:54:50 dtucker Exp $ */
Damien Millerd4a8b7e1999-10-27 13:42:43 +10002/*
Damien Miller95def091999-11-25 00:26:21 +11003 * Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller95def091999-11-25 00:26:21 +11004 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5 * All rights reserved
Damien Miller95def091999-11-25 00:26:21 +11006 * Allocating a pseudo-terminal, and making it the controlling tty.
Damien Miller4af51302000-04-16 11:18:38 +10007 *
Damien Millere4340be2000-09-16 13:29:08 +11008 * As far as I am concerned, the code I have written for this software
9 * can be used freely for any purpose. Any derived versions of this
10 * software must be clearly marked as such, and if the derived work is
11 * incompatible with the protocol description in the RFC file, it must be
12 * called by a name other than "ssh" or "Secure Shell".
Damien Miller95def091999-11-25 00:26:21 +110013 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100014
15#include "includes.h"
Damien Miller17e91c02006-03-15 11:28:34 +110016
Damien Millerf17883e2006-03-15 11:45:54 +110017#include <sys/types.h>
Damien Millerd7834352006-08-05 12:39:39 +100018#include <sys/ioctl.h>
Damien Millerf17883e2006-03-15 11:45:54 +110019#include <sys/stat.h>
Tim Rice4b23f7c2006-03-14 22:09:50 -080020#include <signal.h>
Damien Miller95def091999-11-25 00:26:21 +110021
Darren Tucker39972492006-07-12 22:22:46 +100022#include <errno.h>
Damien Miller57cf6382006-07-10 21:13:46 +100023#include <fcntl.h>
Damien Miller427a1d52006-07-10 20:20:33 +100024#include <grp.h>
Damien Miller03e20032006-03-15 11:16:59 +110025#ifdef HAVE_PATHS_H
Damien Millera9263d02006-03-15 11:18:26 +110026# include <paths.h>
Damien Miller03e20032006-03-15 11:16:59 +110027#endif
Damien Miller9f2abc42006-07-10 20:53:08 +100028#include <pwd.h>
Damien Millerd7834352006-08-05 12:39:39 +100029#include <stdarg.h>
Damien Millere3476ed2006-07-24 14:13:33 +100030#include <string.h>
Damien Miller03e20032006-03-15 11:16:59 +110031#include <termios.h>
Damien Miller36b339a1999-12-14 10:54:47 +110032#ifdef HAVE_UTIL_H
33# include <util.h>
Damien Millerd7834352006-08-05 12:39:39 +100034#endif
Damien Millere6b3b612006-07-24 14:01:23 +100035#include <unistd.h>
Damien Miller36b339a1999-12-14 10:54:47 +110036
Ben Lindstromd95c09c2001-02-18 19:13:33 +000037#include "sshpty.h"
Ben Lindstrom226cfa02001-01-22 05:34:40 +000038#include "log.h"
Kevin Steves974fb9c2001-06-15 00:04:23 +000039#include "misc.h"
Damien Miller356a0b01999-11-08 15:30:59 +110040
Damien Millerfce16481999-12-08 08:53:52 +110041#ifdef HAVE_PTY_H
42# include <pty.h>
43#endif
Damien Millerfce16481999-12-08 08:53:52 +110044
Damien Millerd4a8b7e1999-10-27 13:42:43 +100045#ifndef O_NOCTTY
46#define O_NOCTTY 0
47#endif
48
Damien Miller2de76242009-02-12 12:19:20 +110049#ifdef __APPLE__
50# include <AvailabilityMacros.h>
51# if (MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5)
52# define __APPLE_PRIVPTY__
53# endif
54#endif
55
Damien Miller5428f641999-11-25 11:54:57 +110056/*
57 * Allocates and opens a pty. Returns 0 if no pty could be allocated, or
58 * nonzero if a pty was successfully allocated. On success, open file
59 * descriptors for the pty and tty sides and the name of the tty side are
60 * returned (the buffer must be able to hold at least 64 characters).
61 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100062
Damien Miller4af51302000-04-16 11:18:38 +100063int
Damien Miller71a73672006-03-26 14:04:36 +110064pty_allocate(int *ptyfd, int *ttyfd, char *namebuf, size_t namebuflen)
Damien Millerd4a8b7e1999-10-27 13:42:43 +100065{
Damien Miller95def091999-11-25 00:26:21 +110066 /* openpty(3) exists in OSF/1 and some other os'es */
Damien Miller99e92432001-02-18 12:49:35 +110067 char *name;
Damien Miller95def091999-11-25 00:26:21 +110068 int i;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100069
Damien Miller99e92432001-02-18 12:49:35 +110070 i = openpty(ptyfd, ttyfd, NULL, NULL, NULL);
Damien Miller95def091999-11-25 00:26:21 +110071 if (i < 0) {
72 error("openpty: %.100s", strerror(errno));
73 return 0;
74 }
Damien Miller99e92432001-02-18 12:49:35 +110075 name = ttyname(*ttyfd);
76 if (!name)
77 fatal("openpty returns device for which ttyname fails.");
78
79 strlcpy(namebuf, name, namebuflen); /* possible truncation */
Damien Miller95def091999-11-25 00:26:21 +110080 return 1;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100081}
82
Damien Miller95def091999-11-25 00:26:21 +110083/* Releases the tty. Its ownership is returned to root, and permissions to 0666. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100084
Damien Miller4af51302000-04-16 11:18:38 +100085void
Darren Tucker3f9fdc72004-06-22 12:56:01 +100086pty_release(const char *tty)
Damien Millerd4a8b7e1999-10-27 13:42:43 +100087{
Damien Miller59798642015-04-09 10:14:48 +100088#if !defined(__APPLE_PRIVPTY__) && !defined(HAVE_OPENPTY)
Darren Tucker3f9fdc72004-06-22 12:56:01 +100089 if (chown(tty, (uid_t) 0, (gid_t) 0) < 0)
90 error("chown %.100s 0 0 failed: %.100s", tty, strerror(errno));
91 if (chmod(tty, (mode_t) 0666) < 0)
92 error("chmod %.100s 0666 failed: %.100s", tty, strerror(errno));
Damien Miller59798642015-04-09 10:14:48 +100093#endif /* !__APPLE_PRIVPTY__ && !HAVE_OPENPTY */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100094}
95
Damien Miller469954d2003-06-18 20:25:33 +100096/* Makes the tty the process's controlling tty and sets it to sane modes. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100097
Damien Miller4af51302000-04-16 11:18:38 +100098void
Darren Tucker3f9fdc72004-06-22 12:56:01 +100099pty_make_controlling_tty(int *ttyfd, const char *tty)
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000100{
Ben Lindstrom6db66ff2001-08-06 23:29:16 +0000101 int fd;
102
Tim Rice81ed5182002-09-25 17:38:46 -0700103#ifdef _UNICOS
Kevin Stevesf744b512001-08-14 20:31:49 +0000104 if (setsid() < 0)
105 error("setsid: %.100s", strerror(errno));
Ben Lindstrom6db66ff2001-08-06 23:29:16 +0000106
Darren Tucker3f9fdc72004-06-22 12:56:01 +1000107 fd = open(tty, O_RDWR|O_NOCTTY);
Kevin Stevesf744b512001-08-14 20:31:49 +0000108 if (fd != -1) {
Ben Lindstrom5ade9ab2003-08-25 01:16:21 +0000109 signal(SIGHUP, SIG_IGN);
Kevin Stevesf744b512001-08-14 20:31:49 +0000110 ioctl(fd, TCVHUP, (char *)NULL);
Ben Lindstrom5ade9ab2003-08-25 01:16:21 +0000111 signal(SIGHUP, SIG_DFL);
Kevin Stevesf744b512001-08-14 20:31:49 +0000112 setpgid(0, 0);
113 close(fd);
Ben Lindstrom6db66ff2001-08-06 23:29:16 +0000114 } else {
Kevin Stevesf744b512001-08-14 20:31:49 +0000115 error("Failed to disconnect from controlling tty.");
Ben Lindstrom6db66ff2001-08-06 23:29:16 +0000116 }
Ben Lindstrom6db66ff2001-08-06 23:29:16 +0000117
Kevin Stevesf744b512001-08-14 20:31:49 +0000118 debug("Setting controlling tty using TCSETCTTY.");
119 ioctl(*ttyfd, TCSETCTTY, NULL);
120 fd = open("/dev/tty", O_RDWR);
121 if (fd < 0)
Darren Tucker3f9fdc72004-06-22 12:56:01 +1000122 error("%.100s: %.100s", tty, strerror(errno));
Ben Lindstrom6db66ff2001-08-06 23:29:16 +0000123 close(*ttyfd);
Ben Lindstrom5a6abda2002-06-09 19:41:48 +0000124 *ttyfd = fd;
Tim Rice81ed5182002-09-25 17:38:46 -0700125#else /* _UNICOS */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000126
Damien Miller95def091999-11-25 00:26:21 +1100127 /* First disconnect from the old controlling tty. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000128#ifdef TIOCNOTTY
Ben Lindstrom31ca54a2001-02-09 02:11:24 +0000129 fd = open(_PATH_TTY, O_RDWR | O_NOCTTY);
Damien Miller95def091999-11-25 00:26:21 +1100130 if (fd >= 0) {
131 (void) ioctl(fd, TIOCNOTTY, NULL);
132 close(fd);
133 }
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000134#endif /* TIOCNOTTY */
Damien Miller95def091999-11-25 00:26:21 +1100135 if (setsid() < 0)
136 error("setsid: %.100s", strerror(errno));
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000137
Damien Miller5428f641999-11-25 11:54:57 +1100138 /*
139 * Verify that we are successfully disconnected from the controlling
140 * tty.
141 */
Ben Lindstrom31ca54a2001-02-09 02:11:24 +0000142 fd = open(_PATH_TTY, O_RDWR | O_NOCTTY);
Damien Miller95def091999-11-25 00:26:21 +1100143 if (fd >= 0) {
144 error("Failed to disconnect from controlling tty.");
145 close(fd);
146 }
147 /* Make it our controlling tty. */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000148#ifdef TIOCSCTTY
Damien Miller95def091999-11-25 00:26:21 +1100149 debug("Setting controlling tty using TIOCSCTTY.");
Kevin Steves6c0d6272000-11-12 09:22:29 +0000150 if (ioctl(*ttyfd, TIOCSCTTY, NULL) < 0)
151 error("ioctl(TIOCSCTTY): %.100s", strerror(errno));
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000152#endif /* TIOCSCTTY */
Darren Tucker2be1cbb2005-05-27 21:13:40 +1000153#ifdef NEED_SETPGRP
Ben Lindstromb5628642000-10-18 00:02:25 +0000154 if (setpgrp(0,0) < 0)
155 error("SETPGRP %s",strerror(errno));
Darren Tucker2be1cbb2005-05-27 21:13:40 +1000156#endif /* NEED_SETPGRP */
Darren Tucker3f9fdc72004-06-22 12:56:01 +1000157 fd = open(tty, O_RDWR);
Darren Tucker8f750cc2016-09-12 14:43:58 +1000158 if (fd < 0)
Darren Tucker3f9fdc72004-06-22 12:56:01 +1000159 error("%.100s: %.100s", tty, strerror(errno));
Darren Tucker8f750cc2016-09-12 14:43:58 +1000160 else
Damien Miller95def091999-11-25 00:26:21 +1100161 close(fd);
Darren Tucker8f750cc2016-09-12 14:43:58 +1000162
Damien Miller95def091999-11-25 00:26:21 +1100163 /* Verify that we now have a controlling tty. */
Ben Lindstrom31ca54a2001-02-09 02:11:24 +0000164 fd = open(_PATH_TTY, O_WRONLY);
Damien Miller95def091999-11-25 00:26:21 +1100165 if (fd < 0)
166 error("open /dev/tty failed - could not set controlling tty: %.100s",
Damien Miller9f0f5c62001-12-21 14:45:46 +1100167 strerror(errno));
Damien Millera8e06ce2003-11-21 23:48:55 +1100168 else
Damien Miller95def091999-11-25 00:26:21 +1100169 close(fd);
Tim Rice81ed5182002-09-25 17:38:46 -0700170#endif /* _UNICOS */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000171}
172
173/* Changes the window size associated with the pty. */
174
Damien Miller4af51302000-04-16 11:18:38 +1000175void
Damien Miller71a73672006-03-26 14:04:36 +1100176pty_change_window_size(int ptyfd, u_int row, u_int col,
177 u_int xpixel, u_int ypixel)
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000178{
Damien Miller95def091999-11-25 00:26:21 +1100179 struct winsize w;
Ben Lindstrom8ada5d02002-06-23 21:42:50 +0000180
Damien Miller71a73672006-03-26 14:04:36 +1100181 /* may truncate u_int -> u_short */
Damien Miller95def091999-11-25 00:26:21 +1100182 w.ws_row = row;
183 w.ws_col = col;
184 w.ws_xpixel = xpixel;
185 w.ws_ypixel = ypixel;
186 (void) ioctl(ptyfd, TIOCSWINSZ, &w);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000187}
Damien Millerc7d8dbb2000-03-02 23:30:53 +1100188
189void
Darren Tucker3f9fdc72004-06-22 12:56:01 +1000190pty_setowner(struct passwd *pw, const char *tty)
Damien Millerc7d8dbb2000-03-02 23:30:53 +1100191{
192 struct group *grp;
193 gid_t gid;
194 mode_t mode;
Kevin Stevesfa72dda2000-12-15 18:39:12 +0000195 struct stat st;
Damien Millerc7d8dbb2000-03-02 23:30:53 +1100196
197 /* Determine the group to make the owner of the tty. */
198 grp = getgrnam("tty");
djm@openbsd.orga5883d42014-09-03 18:55:07 +0000199 gid = (grp != NULL) ? grp->gr_gid : pw->pw_gid;
djm@openbsd.org6f941392015-07-30 23:09:15 +0000200 mode = (grp != NULL) ? 0620 : 0600;
Damien Millerc7d8dbb2000-03-02 23:30:53 +1100201
Kevin Stevesfa72dda2000-12-15 18:39:12 +0000202 /*
203 * Change owner and mode of the tty as required.
Ben Lindstromc88785e2001-08-06 20:47:23 +0000204 * Warn but continue if filesystem is read-only and the uids match/
205 * tty is owned by root.
Kevin Stevesfa72dda2000-12-15 18:39:12 +0000206 */
Darren Tucker3f9fdc72004-06-22 12:56:01 +1000207 if (stat(tty, &st))
208 fatal("stat(%.100s) failed: %.100s", tty,
Kevin Stevesfa72dda2000-12-15 18:39:12 +0000209 strerror(errno));
210
Damien Miller73b42d22006-04-22 21:26:08 +1000211#ifdef WITH_SELINUX
212 ssh_selinux_setup_pty(pw->pw_name, tty);
213#endif
214
Kevin Stevesfa72dda2000-12-15 18:39:12 +0000215 if (st.st_uid != pw->pw_uid || st.st_gid != gid) {
Darren Tucker3f9fdc72004-06-22 12:56:01 +1000216 if (chown(tty, pw->pw_uid, gid) < 0) {
Damien Miller9f0f5c62001-12-21 14:45:46 +1100217 if (errno == EROFS &&
Ben Lindstrom8ada5d02002-06-23 21:42:50 +0000218 (st.st_uid == pw->pw_uid || st.st_uid == 0))
Damien Millere8cea9e2003-02-24 11:54:10 +1100219 debug("chown(%.100s, %u, %u) failed: %.100s",
Darren Tucker3f9fdc72004-06-22 12:56:01 +1000220 tty, (u_int)pw->pw_uid, (u_int)gid,
Damien Miller9f0f5c62001-12-21 14:45:46 +1100221 strerror(errno));
Kevin Stevesfa72dda2000-12-15 18:39:12 +0000222 else
Ben Lindstrom5c385522002-06-23 21:23:20 +0000223 fatal("chown(%.100s, %u, %u) failed: %.100s",
Darren Tucker3f9fdc72004-06-22 12:56:01 +1000224 tty, (u_int)pw->pw_uid, (u_int)gid,
Damien Miller9f0f5c62001-12-21 14:45:46 +1100225 strerror(errno));
Kevin Stevesfa72dda2000-12-15 18:39:12 +0000226 }
227 }
228
229 if ((st.st_mode & (S_IRWXU|S_IRWXG|S_IRWXO)) != mode) {
Darren Tucker3f9fdc72004-06-22 12:56:01 +1000230 if (chmod(tty, mode) < 0) {
Kevin Stevesfa72dda2000-12-15 18:39:12 +0000231 if (errno == EROFS &&
232 (st.st_mode & (S_IRGRP | S_IROTH)) == 0)
Damien Millere8cea9e2003-02-24 11:54:10 +1100233 debug("chmod(%.100s, 0%o) failed: %.100s",
Darren Tucker3f9fdc72004-06-22 12:56:01 +1000234 tty, (u_int)mode, strerror(errno));
Kevin Stevesfa72dda2000-12-15 18:39:12 +0000235 else
236 fatal("chmod(%.100s, 0%o) failed: %.100s",
Darren Tucker3f9fdc72004-06-22 12:56:01 +1000237 tty, (u_int)mode, strerror(errno));
Kevin Stevesfa72dda2000-12-15 18:39:12 +0000238 }
239 }
Damien Millerc7d8dbb2000-03-02 23:30:53 +1100240}
dtucker@openbsd.orgb0899ee2016-11-29 03:54:50 +0000241
242/* Disconnect from the controlling tty. */
243void
244disconnect_controlling_tty(void)
245{
246#ifdef TIOCNOTTY
247 int fd;
248
249 if ((fd = open(_PATH_TTY, O_RDWR | O_NOCTTY)) >= 0) {
250 (void) ioctl(fd, TIOCNOTTY, NULL);
251 close(fd);
252 }
253#endif /* TIOCNOTTY */
254}