1 /*
2
3 This file is part of the KDE libraries
4 Copyright (C) 2002 Waldo Bastian <bastian@kde.org>
5 Copyright (C) 2002-2003,2007 Oswald Buddenhagen <ossi@kde.org>
6
7 Rewritten for QT4 by e_k <e_k at users.sourceforge.net>, Copyright (C)2008
8
9 This library is free software; you can redistribute it and/or
10 modify it under the terms of the GNU Library General Public
11 License as published by the Free Software Foundation; either
12 version 2 of the License, or (at your option) any later version.
13
14 This library 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 GNU
17 Library General Public License for more details.
18
19 You should have received a copy of the GNU Library General Public License
20 along with this library; see the file COPYING.LIB. If not, write to
21 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22 Boston, MA 02110-1301, USA.
23 */
24
25 #include "kpty_p.h"
26
27 #include <QtDebug>
28
29
30 #if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__DragonFly__)
31 //#define HAVE_LOGIN
32 #define HAVE_LIBUTIL_H
33 #endif
34
35 #if defined(__OpenBSD__)
36 #define HAVE_LOGIN
37 #define HAVE_UTIL_H
38 #endif
39
40 #if defined(__APPLE__)
41 #define HAVE_OPENPTY
42 #define HAVE_UTIL_H
43 #endif
44
45 #ifdef __sgi
46 #define __svr4__
47 #endif
48
49 #ifdef __osf__
50 #define _OSF_SOURCE
51 #include <float.h>
52 #endif
53
54 #ifdef _AIX
55 #define _ALL_SOURCE
56 #endif
57
58 // __USE_XOPEN isn't defined by default in ICC
59 // (needed for ptsname(), grantpt() and unlockpt())
60 #ifdef __INTEL_COMPILER
61 # ifndef __USE_XOPEN
62 # define __USE_XOPEN
63 # endif
64 #endif
65
66 #include <sys/types.h>
67 #include <sys/ioctl.h>
68 #include <sys/time.h>
69 #include <sys/resource.h>
70 #include <sys/stat.h>
71 #include <sys/param.h>
72
73 #include <errno.h>
74 #include <fcntl.h>
75 #include <time.h>
76 #include <stdlib.h>
77 #include <stdio.h>
78 #include <string.h>
79 #include <unistd.h>
80 #include <grp.h>
81
82 #if defined(HAVE_PTY_H)
83 # include <pty.h>
84 #endif
85
86 #ifdef HAVE_LIBUTIL_H
87 # include <libutil.h>
88 #elif defined(HAVE_UTIL_H)
89 # include <util.h>
90 #endif
91
92 #ifdef HAVE_UTEMPTER
93 extern "C" {
94 # include <utempter.h>
95 }
96 #else
97 # ifdef HAVE_UTMPX
98 # include <utmpx.h>
99 # else
100 # include <utmp.h>
101 # endif
102 # if !defined(_PATH_UTMPX) && defined(_UTMPX_FILE)
103 # define _PATH_UTMPX _UTMPX_FILE
104 # endif
105 # ifdef HAVE_UPDWTMPX
106 # if !defined(_PATH_WTMPX) && defined(_WTMPX_FILE)
107 # define _PATH_WTMPX _WTMPX_FILE
108 # endif
109 # endif
110 #endif
111
112 /* for HP-UX (some versions) the extern C is needed, and for other
113 platforms it doesn't hurt */
114 extern "C" {
115 #include <termios.h>
116 #if defined(HAVE_TERMIO_H)
117 # include <termio.h> // struct winsize on some systems
118 #endif
119 }
120
121 #if defined (_HPUX_SOURCE)
122 # define _TERMIOS_INCLUDED
123 # include <bsdtty.h>
124 #endif
125
126 #ifdef HAVE_SYS_STROPTS_H
127 # include <sys/stropts.h> // Defines I_PUSH
128 # define _NEW_TTY_CTRL
129 #endif
130
131 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__) || defined (__NetBSD__) || defined (__OpenBSD__) || defined (__bsdi__) || defined(__APPLE__) || defined (__DragonFly__)
132 # define _tcgetattr(fd, ttmode) ioctl(fd, TIOCGETA, (char *)ttmode)
133 #else
134 # if defined(_HPUX_SOURCE) || defined(__Lynx__) || defined (__CYGWIN__) || defined(__GNU__)
135 # define _tcgetattr(fd, ttmode) tcgetattr(fd, ttmode)
136 # else
137 # define _tcgetattr(fd, ttmode) ioctl(fd, TCGETS, (char *)ttmode)
138 # endif
139 #endif
140
141 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__) || defined (__NetBSD__) || defined (__OpenBSD__) || defined (__bsdi__) || defined(__APPLE__) || defined (__DragonFly__)
142 # define _tcsetattr(fd, ttmode) ioctl(fd, TIOCSETA, (char *)ttmode)
143 #else
144 # if defined(_HPUX_SOURCE) || defined(__CYGWIN__) || defined(__GNU__)
145 # define _tcsetattr(fd, ttmode) tcsetattr(fd, TCSANOW, ttmode)
146 # else
147 # define _tcsetattr(fd, ttmode) ioctl(fd, TCSETS, (char *)ttmode)
148 # endif
149 #endif
150
151 //#include <kdebug.h>
152 //#include <kstandarddirs.h> // findExe
153
154 // not defined on HP-UX for example
155 #ifndef CTRL
156 # define CTRL(x) ((x) & 037)
157 #endif
158
159 #define TTY_GROUP "tty"
160
161 ///////////////////////
162 // private functions //
163 ///////////////////////
164
165 //////////////////
166 // private data //
167 //////////////////
168
KPtyPrivate(KPty * parent)169 KPtyPrivate::KPtyPrivate(KPty* parent) :
170 masterFd(-1), slaveFd(-1), ownMaster(true), q_ptr(parent)
171 {
172 }
173
~KPtyPrivate()174 KPtyPrivate::~KPtyPrivate()
175 {
176 }
177
chownpty(bool)178 bool KPtyPrivate::chownpty(bool)
179 {
180 // return !QProcess::execute(KStandardDirs::findExe("kgrantpty"),
181 // QStringList() << (grant?"--grant":"--revoke") << QString::number(masterFd));
182 return true;
183 }
184
185 /////////////////////////////
186 // public member functions //
187 /////////////////////////////
188
KPty()189 KPty::KPty() :
190 d_ptr(new KPtyPrivate(this))
191 {
192 }
193
KPty(KPtyPrivate * d)194 KPty::KPty(KPtyPrivate *d) :
195 d_ptr(d)
196 {
197 d_ptr->q_ptr = this;
198 }
199
~KPty()200 KPty::~KPty()
201 {
202 close();
203 delete d_ptr;
204 }
205
open()206 bool KPty::open()
207 {
208 Q_D(KPty);
209
210 if (d->masterFd >= 0)
211 return true;
212
213 d->ownMaster = true;
214
215 QByteArray ptyName;
216
217 // Find a master pty that we can open ////////////////////////////////
218
219 // Because not all the pty animals are created equal, they want to
220 // be opened by several different methods.
221
222 // We try, as we know them, one by one.
223
224 #ifdef HAVE_OPENPTY
225
226 char ptsn[PATH_MAX];
227 if (::openpty( &d->masterFd, &d->slaveFd, ptsn, 0, 0)) {
228 d->masterFd = -1;
229 d->slaveFd = -1;
230 qWarning() << "Can't open a pseudo teletype";
231 return false;
232 }
233 d->ttyName = ptsn;
234
235 #else
236
237 #ifdef HAVE__GETPTY // irix
238
239 char *ptsn = _getpty(&d->masterFd, O_RDWR|O_NOCTTY, S_IRUSR|S_IWUSR, 0);
240 if (ptsn) {
241 d->ttyName = ptsn;
242 goto grantedpt;
243 }
244
245 #elif defined(HAVE_PTSNAME) || defined(TIOCGPTN)
246
247 #ifdef HAVE_POSIX_OPENPT
248 d->masterFd = ::posix_openpt(O_RDWR|O_NOCTTY);
249 #elif defined(HAVE_GETPT)
250 d->masterFd = ::getpt();
251 #elif defined(PTM_DEVICE)
252 d->masterFd = ::open(PTM_DEVICE, O_RDWR|O_NOCTTY);
253 #else
254 # error No method to open a PTY master detected.
255 #endif
256 if (d->masterFd >= 0) {
257 #ifdef HAVE_PTSNAME
258 char *ptsn = ptsname(d->masterFd);
259 if (ptsn) {
260 d->ttyName = ptsn;
261 #else
262 int ptyno;
263 if (!ioctl(d->masterFd, TIOCGPTN, &ptyno)) {
264 d->ttyName = QByteArray("/dev/pts/") + QByteArray::number(ptyno);
265 #endif
266 #ifdef HAVE_GRANTPT
267 if (!grantpt(d->masterFd)) {
268 goto grantedpt;
269 }
270 #else
271
272 goto gotpty;
273 #endif
274 }
275 ::close(d->masterFd);
276 d->masterFd = -1;
277 }
278 #endif // HAVE_PTSNAME || TIOCGPTN
279
280 // Linux device names, FIXME: Trouble on other systems?
281 for (const char * s3 = "pqrstuvwxyzabcde"; *s3; s3++) {
282 for (const char * s4 = "0123456789abcdef"; *s4; s4++) {
283 ptyName = QString().sprintf("/dev/pty%c%c", *s3, *s4).toUtf8();
284 d->ttyName = QString().sprintf("/dev/tty%c%c", *s3, *s4).toUtf8();
285
286 d->masterFd = ::open(ptyName.data(), O_RDWR);
287 if (d->masterFd >= 0) {
288 #ifdef Q_OS_SOLARIS
289 /* Need to check the process group of the pty.
290 * If it exists, then the slave pty is in use,
291 * and we need to get another one.
292 */
293 int pgrp_rtn;
294 if (ioctl(d->masterFd, TIOCGPGRP, &pgrp_rtn) == 0 || errno != EIO) {
295 ::close(d->masterFd);
296 d->masterFd = -1;
297 continue;
298 }
299 #endif /* Q_OS_SOLARIS */
300 if (!access(d->ttyName.data(),R_OK|W_OK)) { // checks availability based on permission bits
301 if (!geteuid()) {
302 struct group * p = getgrnam(TTY_GROUP);
303 if (!p) {
304 p = getgrnam("wheel");
305 }
306 gid_t gid = p ? p->gr_gid : getgid ();
307
308 if (!chown(d->ttyName.data(), getuid(), gid)) {
309 chmod(d->ttyName.data(), S_IRUSR|S_IWUSR|S_IWGRP);
310 }
311 }
312 goto gotpty;
313 }
314 ::close(d->masterFd);
315 d->masterFd = -1;
316 }
317 }
318 }
319
320 qWarning() << "Can't open a pseudo teletype";
321 return false;
322
323 gotpty:
324 struct stat st;
325 if (stat(d->ttyName.data(), &st)) {
326 return false; // this just cannot happen ... *cough* Yeah right, I just
327 // had it happen when pty #349 was allocated. I guess
328 // there was some sort of leak? I only had a few open.
329 }
330 if (((st.st_uid != getuid()) ||
331 (st.st_mode & (S_IRGRP|S_IXGRP|S_IROTH|S_IWOTH|S_IXOTH))) &&
332 !d->chownpty(true)) {
333 qWarning()
334 << "chownpty failed for device " << ptyName << "::" << d->ttyName
335 << "\nThis means the communication can be eavesdropped." << endl;
336 }
337
338 #if defined (HAVE__GETPTY) || defined (HAVE_GRANTPT)
339 grantedpt:
340 #endif
341
342 #ifdef HAVE_REVOKE
343 revoke(d->ttyName.data());
344 #endif
345
346 #ifdef HAVE_UNLOCKPT
347 unlockpt(d->masterFd);
348 #elif defined(TIOCSPTLCK)
349 int flag = 0;
350 ioctl(d->masterFd, TIOCSPTLCK, &flag);
351 #endif
352
353 d->slaveFd = ::open(d->ttyName.data(), O_RDWR | O_NOCTTY);
354 if (d->slaveFd < 0) {
355 qWarning() << "Can't open slave pseudo teletype";
356 ::close(d->masterFd);
357 d->masterFd = -1;
358 return false;
359 }
360
361 #if (defined(__svr4__) || defined(__sgi__))
362 // Solaris
363 ioctl(d->slaveFd, I_PUSH, "ptem");
364 ioctl(d->slaveFd, I_PUSH, "ldterm");
365 #endif
366
367 #endif /* HAVE_OPENPTY */
368
369 fcntl(d->masterFd, F_SETFD, FD_CLOEXEC);
370 fcntl(d->slaveFd, F_SETFD, FD_CLOEXEC);
371
372 return true;
373 }
374
375 bool KPty::open(int fd)
376 {
377 #if !defined(HAVE_PTSNAME) && !defined(TIOCGPTN)
378 qWarning() << "Unsupported attempt to open pty with fd" << fd;
379 return false;
380 #else
381 Q_D(KPty);
382
383 if (d->masterFd >= 0) {
384 qWarning() << "Attempting to open an already open pty";
385 return false;
386 }
387
388 d->ownMaster = false;
389
390 # ifdef HAVE_PTSNAME
391 char *ptsn = ptsname(fd);
392 if (ptsn) {
393 d->ttyName = ptsn;
394 # else
395 int ptyno;
396 if (!ioctl(fd, TIOCGPTN, &ptyno)) {
397 char buf[32];
398 sprintf(buf, "/dev/pts/%d", ptyno);
399 d->ttyName = buf;
400 # endif
401 } else {
402 qWarning() << "Failed to determine pty slave device for fd" << fd;
403 return false;
404 }
405
406 d->masterFd = fd;
407 if (!openSlave()) {
408
409 d->masterFd = -1;
410 return false;
411 }
412
413 return true;
414 #endif
415 }
416
417 void KPty::closeSlave()
418 {
419 Q_D(KPty);
420
421 if (d->slaveFd < 0) {
422 return;
423 }
424 ::close(d->slaveFd);
425 d->slaveFd = -1;
426 }
427
428 bool KPty::openSlave()
429 {
430 Q_D(KPty);
431
432 if (d->slaveFd >= 0)
433 return true;
434 if (d->masterFd < 0) {
435 qDebug() << "Attempting to open pty slave while master is closed";
436 return false;
437 }
438 //d->slaveFd = KDE_open(d->ttyName.data(), O_RDWR | O_NOCTTY);
439 d->slaveFd = ::open(d->ttyName.data(), O_RDWR | O_NOCTTY);
440 if (d->slaveFd < 0) {
441 qDebug() << "Can't open slave pseudo teletype";
442 return false;
443 }
444 fcntl(d->slaveFd, F_SETFD, FD_CLOEXEC);
445 return true;
446 }
447
448 void KPty::close()
449 {
450 Q_D(KPty);
451
452 if (d->masterFd < 0) {
453 return;
454 }
455 closeSlave();
456 // don't bother resetting unix98 pty, it will go away after closing master anyway.
457 if (memcmp(d->ttyName.data(), "/dev/pts/", 9)) {
458 if (!geteuid()) {
459 struct stat st;
460 if (!stat(d->ttyName.data(), &st)) {
461 chown(d->ttyName.data(), 0, st.st_gid == getgid() ? 0 : -1);
462 chmod(d->ttyName.data(), S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH);
463 }
464 } else {
465 fcntl(d->masterFd, F_SETFD, 0);
466 d->chownpty(false);
467 }
468 }
469 ::close(d->masterFd);
470 d->masterFd = -1;
471 }
472
473 void KPty::setCTty()
474 {
475 Q_D(KPty);
476
477 // Setup job control //////////////////////////////////
478
479 // Become session leader, process group leader,
480 // and get rid of the old controlling terminal.
481 setsid();
482
483 // make our slave pty the new controlling terminal.
484 #ifdef TIOCSCTTY
485 ioctl(d->slaveFd, TIOCSCTTY, 0);
486 #else
487 // __svr4__ hack: the first tty opened after setsid() becomes controlling tty
488 ::close(::open(d->ttyName, O_WRONLY, 0));
489 #endif
490
491 // make our new process group the foreground group on the pty
492 int pgrp = getpid();
493 #if defined(_POSIX_VERSION) || defined(__svr4__)
494 tcsetpgrp(d->slaveFd, pgrp);
495 #elif defined(TIOCSPGRP)
496 ioctl(d->slaveFd, TIOCSPGRP, (char *)&pgrp);
497 #endif
498 }
499
500 void KPty::login(const char * user, const char * remotehost)
501 {
502 #ifdef HAVE_UTEMPTER
503 Q_D(KPty);
504
505 addToUtmp(d->ttyName.constData(), remotehost, d->masterFd);
506 Q_UNUSED(user);
507 #else
508 # ifdef HAVE_UTMPX
509 struct utmpx l_struct;
510 # else
511 struct utmp l_struct;
512 # endif
513 memset(&l_struct, 0, sizeof(l_struct));
514 // note: strncpy without terminators _is_ correct here. man 4 utmp
515
516 if (user) {
517 # ifdef HAVE_UTMPX
518 strncpy(l_struct.ut_user, user, sizeof(l_struct.ut_user));
519 # else
520 strncpy(l_struct.ut_name, user, sizeof(l_struct.ut_name));
521 # endif
522 }
523
524 if (remotehost) {
525 strncpy(l_struct.ut_host, remotehost, sizeof(l_struct.ut_host));
526 # ifdef HAVE_STRUCT_UTMP_UT_SYSLEN
527 l_struct.ut_syslen = qMin(strlen(remotehost), sizeof(l_struct.ut_host));
528 # endif
529 }
530
531 # ifndef __GLIBC__
532 Q_D(KPty);
533 const char * str_ptr = d->ttyName.data();
534 if (!memcmp(str_ptr, "/dev/", 5)) {
535 str_ptr += 5;
536 }
537 strncpy(l_struct.ut_line, str_ptr, sizeof(l_struct.ut_line));
538 # ifdef HAVE_STRUCT_UTMP_UT_ID
539 strncpy(l_struct.ut_id,
540 str_ptr + strlen(str_ptr) - sizeof(l_struct.ut_id),
541 sizeof(l_struct.ut_id));
542 # endif
543 # endif
544
545 # ifdef HAVE_UTMPX
546 gettimeofday(&l_struct.ut_tv, 0);
547 # else
548 l_struct.ut_time = time(0);
549 # endif
550
551 # ifdef HAVE_LOGIN
552 # ifdef HAVE_LOGINX
553 ::loginx(&l_struct);
554 # else
555 ::login(&l_struct);
556 # endif
557 # else
558 # ifdef HAVE_STRUCT_UTMP_UT_TYPE
559 l_struct.ut_type = USER_PROCESS;
560 # endif
561 # ifdef HAVE_STRUCT_UTMP_UT_PID
562 l_struct.ut_pid = getpid();
563 # ifdef HAVE_STRUCT_UTMP_UT_SESSION
564 l_struct.ut_session = getsid(0);
565 # endif
566 # endif
567 # ifdef HAVE_UTMPX
568 //utmpxname(_PATH_UTMPX);
569 setutxent();
570 pututxline(&l_struct);
571 endutxent();
572 # ifdef HAVE_UPDWTMPX
573 updwtmpx(_PATH_WTMPX, &l_struct);
574 # endif
575 # else
576 utmpname(_PATH_UTMP);
577 setutent();
578 pututline(&l_struct);
579 endutent();
580 updwtmp(_PATH_WTMP, &l_struct);
581 # endif
582 # endif
583 #endif
584 }
585
586 void KPty::logout()
587 {
588 #ifdef HAVE_UTEMPTER
589 Q_D(KPty);
590
591 removeLineFromUtmp(d->ttyName.constData(), d->masterFd);
592 #else
593 Q_D(KPty);
594
595 const char *str_ptr = d->ttyName.data();
596 if (!memcmp(str_ptr, "/dev/", 5)) {
597 str_ptr += 5;
598 }
599 # ifdef __GLIBC__
600 else {
601 const char * sl_ptr = strrchr(str_ptr, '/');
602 if (sl_ptr) {
603 str_ptr = sl_ptr + 1;
604 }
605 }
606 # endif
607 # ifdef HAVE_LOGIN
608 # ifdef HAVE_LOGINX
609 ::logoutx(str_ptr, 0, DEAD_PROCESS);
610 # else
611 ::logout(str_ptr);
612 # endif
613 # else
614 # ifdef HAVE_UTMPX
615 struct utmpx l_struct, *ut;
616 # else
617 struct utmp l_struct, *ut;
618 # endif
619 memset(&l_struct, 0, sizeof(l_struct));
620
621 strncpy(l_struct.ut_line, str_ptr, sizeof(l_struct.ut_line));
622
623 # ifdef HAVE_UTMPX
624 //utmpxname(_PATH_UTMPX);
625 setutxent();
626 if ((ut = getutxline(&l_struct))) {
627 # else
628 utmpname(_PATH_UTMP);
629 setutent();
630 if ((ut = getutline(&l_struct))) {
631 # endif
632 # ifdef HAVE_UTMPX
633 memset(ut->ut_user, 0, sizeof(*ut->ut_user));
634 # else
635 memset(ut->ut_name, 0, sizeof(*ut->ut_name));
636 # endif
637 memset(ut->ut_host, 0, sizeof(*ut->ut_host));
638 # ifdef HAVE_STRUCT_UTMP_UT_SYSLEN
639 ut->ut_syslen = 0;
640 # endif
641 # ifdef HAVE_STRUCT_UTMP_UT_TYPE
642 ut->ut_type = DEAD_PROCESS;
643 # endif
644 # ifdef HAVE_UTMPX
645 gettimeofday(&ut->ut_tv, 0);
646 pututxline(ut);
647 }
648 endutxent();
649 # else
650 ut->ut_time = time(0);
651 pututline(ut);
652 }
653 endutent();
654 # endif
655 # endif
656 #endif
657 }
658
659 // XXX Supposedly, tc[gs]etattr do not work with the master on Solaris.
660 // Please verify.
661
662 bool KPty::tcGetAttr(struct ::termios * ttmode) const
663 {
664 Q_D(const KPty);
665
666 return _tcgetattr(d->masterFd, ttmode) == 0;
667 }
668
669 bool KPty::tcSetAttr(struct ::termios * ttmode)
670 {
671 Q_D(KPty);
672
673 return _tcsetattr(d->masterFd, ttmode) == 0;
674 }
675
676 bool KPty::setWinSize(int lines, int columns)
677 {
678 Q_D(KPty);
679
680 struct winsize winSize;
681 memset(&winSize, 0, sizeof(winSize));
682 winSize.ws_row = (unsigned short)lines;
683 winSize.ws_col = (unsigned short)columns;
684 return ioctl(d->masterFd, TIOCSWINSZ, (char *)&winSize) == 0;
685 }
686
687 bool KPty::setEcho(bool echo)
688 {
689 struct ::termios ttmode;
690 if (!tcGetAttr(&ttmode)) {
691 return false;
692 }
693 if (!echo) {
694 ttmode.c_lflag &= ~ECHO;
695 } else {
696 ttmode.c_lflag |= ECHO;
697 }
698 return tcSetAttr(&ttmode);
699 }
700
701 const char * KPty::ttyName() const
702 {
703 Q_D(const KPty);
704
705 return d->ttyName.data();
706 }
707
708 int KPty::masterFd() const
709 {
710 Q_D(const KPty);
711
712 return d->masterFd;
713 }
714
715 int KPty::slaveFd() const
716 {
717 Q_D(const KPty);
718
719 return d->slaveFd;
720 }
721