source: ogBrowser-Git/qtermwidget/lib/kpty.cpp @ c0cec9d

jenkinsmain
Last change on this file since c0cec9d was fedf2a2, checked in by Vadim Troshchinskiy Shmelev <vtroshchinskiy@…>, 18 months ago

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